Class: Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb

Overview

REST client for the CloudDeploy service.

CloudDeploy service creates and manages Continuous Delivery operations on Google Cloud Platform via Skaffold (https://skaffold.dev).

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#automation_path, #automation_run_path, #build_path, #cluster_path, #config_path, #custom_target_type_path, #delivery_pipeline_path, #job_path, #job_run_path, #location_path, #membership_path, #release_path, #rollout_path, #service_path, #target_path, #worker_pool_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new CloudDeploy REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the CloudDeploy client.

Yield Parameters:



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 243

def initialize
  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-")
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end

  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @operations_client = ::Google::Cloud::Deploy::V1::CloudDeploy::Rest::Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
  end

  @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
    config.bindings_override = @config.bindings_override
  end

  @iam_policy_client = Google::Iam::V1::IAMPolicy::Rest::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
    config.bindings_override = @config.bindings_override
  end

  @cloud_deploy_stub = ::Google::Cloud::Deploy::V1::CloudDeploy::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials
end

Instance Attribute Details

#iam_policy_client ⇒ Google::Iam::V1::IAMPolicy::Rest::Client (readonly)

Get the associated client for mix-in of the IAMPolicy.

Returns:

  • (Google::Iam::V1::IAMPolicy::Rest::Client) 


307
308
309
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 307

def iam_policy_client
  @iam_policy_client
end

#location_client ⇒ Google::Cloud::Location::Locations::Rest::Client (readonly)

Get the associated client for mix-in of the Locations.

Returns:

  • (Google::Cloud::Location::Locations::Rest::Client) 


300
301
302
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 300

def location_client
  @location_client
end

#operations_client ⇒ ::Google::Cloud::Deploy::V1::CloudDeploy::Rest::Operations (readonly)

Get the associated client for long-running operations.

Returns:



293
294
295
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 293

def operations_client
  @operations_client
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the CloudDeploy Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all CloudDeploy clients
::Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 61

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Deploy", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.rpcs.list_delivery_pipelines.timeout = 60.0
    default_config.rpcs.list_delivery_pipelines.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_delivery_pipeline.timeout = 60.0
    default_config.rpcs.get_delivery_pipeline.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.create_delivery_pipeline.timeout = 60.0

    default_config.rpcs.update_delivery_pipeline.timeout = 60.0

    default_config.rpcs.delete_delivery_pipeline.timeout = 60.0

    default_config.rpcs.list_targets.timeout = 60.0
    default_config.rpcs.list_targets.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_target.timeout = 60.0
    default_config.rpcs.get_target.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.create_target.timeout = 60.0

    default_config.rpcs.update_target.timeout = 60.0

    default_config.rpcs.delete_target.timeout = 60.0

    default_config.rpcs.list_custom_target_types.timeout = 60.0
    default_config.rpcs.list_custom_target_types.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_custom_target_type.timeout = 60.0
    default_config.rpcs.get_custom_target_type.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.create_custom_target_type.timeout = 60.0

    default_config.rpcs.update_custom_target_type.timeout = 60.0

    default_config.rpcs.delete_custom_target_type.timeout = 60.0

    default_config.rpcs.list_releases.timeout = 60.0
    default_config.rpcs.list_releases.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_release.timeout = 60.0
    default_config.rpcs.get_release.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.create_release.timeout = 60.0

    default_config.rpcs.abandon_release.timeout = 60.0

    default_config.rpcs.approve_rollout.timeout = 60.0

    default_config.rpcs.advance_rollout.timeout = 60.0

    default_config.rpcs.cancel_rollout.timeout = 60.0

    default_config.rpcs.list_rollouts.timeout = 60.0
    default_config.rpcs.list_rollouts.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_rollout.timeout = 60.0
    default_config.rpcs.get_rollout.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.create_rollout.timeout = 60.0

    default_config.rpcs.ignore_job.timeout = 60.0

    default_config.rpcs.retry_job.timeout = 60.0

    default_config.rpcs.list_job_runs.timeout = 60.0
    default_config.rpcs.list_job_runs.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_job_run.timeout = 60.0
    default_config.rpcs.get_job_run.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.terminate_job_run.timeout = 60.0

    default_config.rpcs.get_config.timeout = 60.0
    default_config.rpcs.get_config.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.create_automation.timeout = 60.0

    default_config.rpcs.update_automation.timeout = 60.0

    default_config.rpcs.delete_automation.timeout = 60.0

    default_config.rpcs.get_automation.timeout = 60.0
    default_config.rpcs.get_automation.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.list_automations.timeout = 60.0
    default_config.rpcs.list_automations.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.get_automation_run.timeout = 60.0
    default_config.rpcs.get_automation_run.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.list_automation_runs.timeout = 60.0
    default_config.rpcs.list_automation_runs.retry_policy = {
      initial_delay: 1.0, max_delay: 60.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.cancel_automation_run.timeout = 60.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#abandon_release(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::AbandonReleaseResponse #abandon_release(name: nil) ⇒ ::Google::Cloud::Deploy::V1::AbandonReleaseResponse

Abandons a Release in the Delivery Pipeline.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::AbandonReleaseRequest.new

# Call the abandon_release method.
result = client.abandon_release request

# The returned object is of type Google::Cloud::Deploy::V1::AbandonReleaseResponse.
p result

Overloads:

  • #abandon_release(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::AbandonReleaseResponse

    Pass arguments to abandon_release via a request object, either of type AbandonReleaseRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::AbandonReleaseRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #abandon_release(name: nil) ⇒ ::Google::Cloud::Deploy::V1::AbandonReleaseResponse

    Pass arguments to abandon_release via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Name of the Release. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 2275

def abandon_release request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::AbandonReleaseRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.abandon_release.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.abandon_release.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.abandon_release.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.abandon_release request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#advance_rollout(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::AdvanceRolloutResponse #advance_rollout(name: nil, phase_id: nil) ⇒ ::Google::Cloud::Deploy::V1::AdvanceRolloutResponse

Advances a Rollout in a given project and location.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::AdvanceRolloutRequest.new

# Call the advance_rollout method.
result = client.advance_rollout request

# The returned object is of type Google::Cloud::Deploy::V1::AdvanceRolloutResponse.
p result

Overloads:

  • #advance_rollout(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::AdvanceRolloutResponse

    Pass arguments to advance_rollout via a request object, either of type AdvanceRolloutRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::AdvanceRolloutRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #advance_rollout(name: nil, phase_id: nil) ⇒ ::Google::Cloud::Deploy::V1::AdvanceRolloutResponse

    Pass arguments to advance_rollout via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.

    • phase_id (::String) (defaults to: nil) —

      Required. The phase ID to advance the Rollout to.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 2437

def advance_rollout request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::AdvanceRolloutRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.advance_rollout.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.advance_rollout.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.advance_rollout.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.advance_rollout request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#approve_rollout(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::ApproveRolloutResponse #approve_rollout(name: nil, approved: nil) ⇒ ::Google::Cloud::Deploy::V1::ApproveRolloutResponse

Approves a Rollout.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::ApproveRolloutRequest.new

# Call the approve_rollout method.
result = client.approve_rollout request

# The returned object is of type Google::Cloud::Deploy::V1::ApproveRolloutResponse.
p result

Overloads:

  • #approve_rollout(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::ApproveRolloutResponse

    Pass arguments to approve_rollout via a request object, either of type ApproveRolloutRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::ApproveRolloutRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #approve_rollout(name: nil, approved: nil) ⇒ ::Google::Cloud::Deploy::V1::ApproveRolloutResponse

    Pass arguments to approve_rollout via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.

    • approved (::Boolean) (defaults to: nil) —

      Required. True = approve; false = reject

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 2356

def approve_rollout request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::ApproveRolloutRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.approve_rollout.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.approve_rollout.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.approve_rollout.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.approve_rollout request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#cancel_automation_run(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::CancelAutomationRunResponse #cancel_automation_run(name: nil) ⇒ ::Google::Cloud::Deploy::V1::CancelAutomationRunResponse

Cancels an AutomationRun. The state of the AutomationRun after cancelling is CANCELLED. CancelAutomationRun can be called on AutomationRun in the state IN_PROGRESS and PENDING; AutomationRun in a different state returns an FAILED_PRECONDITION error.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::CancelAutomationRunRequest.new

# Call the cancel_automation_run method.
result = client.cancel_automation_run request

# The returned object is of type Google::Cloud::Deploy::V1::CancelAutomationRunResponse.
p result

Overloads:

  • #cancel_automation_run(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::CancelAutomationRunResponse

    Pass arguments to cancel_automation_run via a request object, either of type Google::Cloud::Deploy::V1::CancelAutomationRunRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::CancelAutomationRunRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #cancel_automation_run(name: nil) ⇒ ::Google::Cloud::Deploy::V1::CancelAutomationRunResponse

    Pass arguments to cancel_automation_run via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Name of the AutomationRun. Format is projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 4080

def cancel_automation_run request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::CancelAutomationRunRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.cancel_automation_run.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.cancel_automation_run.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.cancel_automation_run.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.cancel_automation_run request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#cancel_rollout(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::CancelRolloutResponse #cancel_rollout(name: nil) ⇒ ::Google::Cloud::Deploy::V1::CancelRolloutResponse

Cancels a Rollout in a given project and location.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::CancelRolloutRequest.new

# Call the cancel_rollout method.
result = client.cancel_rollout request

# The returned object is of type Google::Cloud::Deploy::V1::CancelRolloutResponse.
p result

Overloads:

  • #cancel_rollout(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::CancelRolloutResponse

    Pass arguments to cancel_rollout via a request object, either of type Google::Cloud::Deploy::V1::CancelRolloutRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::CancelRolloutRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #cancel_rollout(name: nil) ⇒ ::Google::Cloud::Deploy::V1::CancelRolloutResponse

    Pass arguments to cancel_rollout via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 2516

def cancel_rollout request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::CancelRolloutRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.cancel_rollout.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.cancel_rollout.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.cancel_rollout.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.cancel_rollout request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#configure {|config| ... } ⇒ Client::Configuration

Configure the CloudDeploy Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



222
223
224
225
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 222

def configure
  yield @config if block_given?
  @config
end

#create_automation(request, options = nil) ⇒ ::Gapic::Operation #create_automation(parent: nil, automation_id: nil, automation: nil, request_id: nil, validate_only: nil) ⇒ ::Gapic::Operation

Creates a new Automation in a given project and location.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::CreateAutomationRequest.new

# Call the create_automation method.
result = client.create_automation request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #create_automation(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to create_automation via a request object, either of type Google::Cloud::Deploy::V1::CreateAutomationRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::CreateAutomationRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #create_automation(parent: nil, automation_id: nil, automation: nil, request_id: nil, validate_only: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_automation via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent collection in which the Automation should be created. Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

    • automation_id (::String) (defaults to: nil) —

      Required. ID of the Automation.

    • automation (::Google::Cloud::Deploy::V1::Automation, ::Hash) (defaults to: nil) —

      Required. The Automation to create.

    • request_id (::String) (defaults to: nil) —

      Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

    • validate_only (::Boolean) (defaults to: nil) —

      Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 3415

def create_automation request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::CreateAutomationRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.create_automation.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_automation.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_automation.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.create_automation request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_custom_target_type(request, options = nil) ⇒ ::Gapic::Operation #create_custom_target_type(parent: nil, custom_target_type_id: nil, custom_target_type: nil, request_id: nil, validate_only: nil) ⇒ ::Gapic::Operation

Creates a new CustomTargetType in a given project and location.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::CreateCustomTargetTypeRequest.new

# Call the create_custom_target_type method.
result = client.create_custom_target_type request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #create_custom_target_type(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to create_custom_target_type via a request object, either of type Google::Cloud::Deploy::V1::CreateCustomTargetTypeRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::CreateCustomTargetTypeRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #create_custom_target_type(parent: nil, custom_target_type_id: nil, custom_target_type: nil, request_id: nil, validate_only: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_custom_target_type via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent collection in which the CustomTargetType should be created. Format should be projects/{project_id}/locations/{location_name}.

    • custom_target_type_id (::String) (defaults to: nil) —

      Required. ID of the CustomTargetType.

    • custom_target_type (::Google::Cloud::Deploy::V1::CustomTargetType, ::Hash) (defaults to: nil) —

      Required. The CustomTargetType to create.

    • request_id (::String) (defaults to: nil) —

      Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

    • validate_only (::Boolean) (defaults to: nil) —

      Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 1684

def create_custom_target_type request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::CreateCustomTargetTypeRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.create_custom_target_type.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_custom_target_type.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_custom_target_type.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.create_custom_target_type request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_delivery_pipeline(request, options = nil) ⇒ ::Gapic::Operation #create_delivery_pipeline(parent: nil, delivery_pipeline_id: nil, delivery_pipeline: nil, request_id: nil, validate_only: nil) ⇒ ::Gapic::Operation

Creates a new DeliveryPipeline in a given project and location.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::CreateDeliveryPipelineRequest.new

# Call the create_delivery_pipeline method.
result = client.create_delivery_pipeline request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #create_delivery_pipeline(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to create_delivery_pipeline via a request object, either of type Google::Cloud::Deploy::V1::CreateDeliveryPipelineRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::CreateDeliveryPipelineRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #create_delivery_pipeline(parent: nil, delivery_pipeline_id: nil, delivery_pipeline: nil, request_id: nil, validate_only: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_delivery_pipeline via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent collection in which the DeliveryPipeline should be created. Format should be projects/{project_id}/locations/{location_name}.

    • delivery_pipeline_id (::String) (defaults to: nil) —

      Required. ID of the DeliveryPipeline.

    • delivery_pipeline (::Google::Cloud::Deploy::V1::DeliveryPipeline, ::Hash) (defaults to: nil) —

      Required. The DeliveryPipeline to create.

    • request_id (::String) (defaults to: nil) —

      Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

    • validate_only (::Boolean) (defaults to: nil) —

      Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 562

def create_delivery_pipeline request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::CreateDeliveryPipelineRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.create_delivery_pipeline.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_delivery_pipeline.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_delivery_pipeline.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.create_delivery_pipeline request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_release(request, options = nil) ⇒ ::Gapic::Operation #create_release(parent: nil, release_id: nil, release: nil, request_id: nil, validate_only: nil) ⇒ ::Gapic::Operation

Creates a new Release in a given project and location.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::CreateReleaseRequest.new

# Call the create_release method.
result = client.create_release request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #create_release(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to create_release via a request object, either of type Google::Cloud::Deploy::V1::CreateReleaseRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::CreateReleaseRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #create_release(parent: nil, release_id: nil, release: nil, request_id: nil, validate_only: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_release via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent collection in which the Release should be created. Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

    • release_id (::String) (defaults to: nil) —

      Required. ID of the Release.

    • release (::Google::Cloud::Deploy::V1::Release, ::Hash) (defaults to: nil) —

      Required. The Release to create.

    • request_id (::String) (defaults to: nil) —

      Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

    • validate_only (::Boolean) (defaults to: nil) —

      Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 2195

def create_release request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::CreateReleaseRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.create_release.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_release.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_release.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.create_release request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_rollout(request, options = nil) ⇒ ::Gapic::Operation #create_rollout(parent: nil, rollout_id: nil, rollout: nil, request_id: nil, validate_only: nil, starting_phase_id: nil) ⇒ ::Gapic::Operation

Creates a new Rollout in a given project and location.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::CreateRolloutRequest.new

# Call the create_rollout method.
result = client.create_rollout request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #create_rollout(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to create_rollout via a request object, either of type Google::Cloud::Deploy::V1::CreateRolloutRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::CreateRolloutRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #create_rollout(parent: nil, rollout_id: nil, rollout: nil, request_id: nil, validate_only: nil, starting_phase_id: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_rollout via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent collection in which the Rollout should be created. Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}.

    • rollout_id (::String) (defaults to: nil) —

      Required. ID of the Rollout.

    • rollout (::Google::Cloud::Deploy::V1::Rollout, ::Hash) (defaults to: nil) —

      Required. The Rollout to create.

    • request_id (::String) (defaults to: nil) —

      Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

    • validate_only (::Boolean) (defaults to: nil) —

      Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

    • starting_phase_id (::String) (defaults to: nil) —

      Optional. The starting phase ID for the Rollout. If empty the Rollout will start at the first phase.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 2805

def create_rollout request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::CreateRolloutRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.create_rollout.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_rollout.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_rollout.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.create_rollout request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#create_target(request, options = nil) ⇒ ::Gapic::Operation #create_target(parent: nil, target_id: nil, target: nil, request_id: nil, validate_only: nil) ⇒ ::Gapic::Operation

Creates a new Target in a given project and location.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::CreateTargetRequest.new

# Call the create_target method.
result = client.create_target request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #create_target(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to create_target via a request object, either of type Google::Cloud::Deploy::V1::CreateTargetRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::CreateTargetRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #create_target(parent: nil, target_id: nil, target: nil, request_id: nil, validate_only: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_target via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent collection in which the Target should be created. Format should be projects/{project_id}/locations/{location_name}.

    • target_id (::String) (defaults to: nil) —

      Required. ID of the Target.

    • target (::Google::Cloud::Deploy::V1::Target, ::Hash) (defaults to: nil) —

      Required. The Target to create.

    • request_id (::String) (defaults to: nil) —

      Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

    • validate_only (::Boolean) (defaults to: nil) —

      Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 1173

def create_target request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::CreateTargetRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.create_target.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_target.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_target.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.create_target request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_automation(request, options = nil) ⇒ ::Gapic::Operation #delete_automation(name: nil, request_id: nil, allow_missing: nil, validate_only: nil, etag: nil) ⇒ ::Gapic::Operation

Deletes a single Automation resource.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::DeleteAutomationRequest.new

# Call the delete_automation method.
result = client.delete_automation request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #delete_automation(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_automation via a request object, either of type DeleteAutomationRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::DeleteAutomationRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #delete_automation(name: nil, request_id: nil, allow_missing: nil, validate_only: nil, etag: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_automation via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the Automation to delete. Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automations/{automation_name}.

    • request_id (::String) (defaults to: nil) —

      Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

    • allow_missing (::Boolean) (defaults to: nil) —

      Optional. If set to true, then deleting an already deleted or non-existing Automation will succeed.

    • validate_only (::Boolean) (defaults to: nil) —

      Optional. If set, validate the request and verify whether the resource exists, but do not actually post it.

    • etag (::String) (defaults to: nil) —

      Optional. The weak etag of the request. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 3639

def delete_automation request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::DeleteAutomationRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.delete_automation.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_automation.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_automation.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.delete_automation request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_custom_target_type(request, options = nil) ⇒ ::Gapic::Operation #delete_custom_target_type(name: nil, request_id: nil, allow_missing: nil, validate_only: nil, etag: nil) ⇒ ::Gapic::Operation

Deletes a single CustomTargetType.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::DeleteCustomTargetTypeRequest.new

# Call the delete_custom_target_type method.
result = client.delete_custom_target_type request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #delete_custom_target_type(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_custom_target_type via a request object, either of type DeleteCustomTargetTypeRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::DeleteCustomTargetTypeRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #delete_custom_target_type(name: nil, request_id: nil, allow_missing: nil, validate_only: nil, etag: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_custom_target_type via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the CustomTargetType to delete. Format must be projects/{project_id}/locations/{location_name}/customTargetTypes/{custom_target_type}.

    • request_id (::String) (defaults to: nil) —

      Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

    • allow_missing (::Boolean) (defaults to: nil) —

      Optional. If set to true, then deleting an already deleted or non-existing CustomTargetType will succeed.

    • validate_only (::Boolean) (defaults to: nil) —

      Optional. If set to true, the request is validated but no actual change is made.

    • etag (::String) (defaults to: nil) —

      Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 1907

def delete_custom_target_type request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::DeleteCustomTargetTypeRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.delete_custom_target_type.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_custom_target_type.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_custom_target_type.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.delete_custom_target_type request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_delivery_pipeline(request, options = nil) ⇒ ::Gapic::Operation #delete_delivery_pipeline(name: nil, request_id: nil, allow_missing: nil, validate_only: nil, force: nil, etag: nil) ⇒ ::Gapic::Operation

Deletes a single DeliveryPipeline.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::DeleteDeliveryPipelineRequest.new

# Call the delete_delivery_pipeline method.
result = client.delete_delivery_pipeline request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #delete_delivery_pipeline(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_delivery_pipeline via a request object, either of type DeleteDeliveryPipelineRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::DeleteDeliveryPipelineRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #delete_delivery_pipeline(name: nil, request_id: nil, allow_missing: nil, validate_only: nil, force: nil, etag: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_delivery_pipeline via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the DeliveryPipeline to delete. Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

    • request_id (::String) (defaults to: nil) —

      Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

    • allow_missing (::Boolean) (defaults to: nil) —

      Optional. If set to true, then deleting an already deleted or non-existing DeliveryPipeline will succeed.

    • validate_only (::Boolean) (defaults to: nil) —

      Optional. If set, validate the request and preview the review, but do not actually post it.

    • force (::Boolean) (defaults to: nil) —

      Optional. If set to true, all child resources under this pipeline will also be deleted. Otherwise, the request will only work if the pipeline has no child resources.

    • etag (::String) (defaults to: nil) —

      Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 789

def delete_delivery_pipeline request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::DeleteDeliveryPipelineRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.delete_delivery_pipeline.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_delivery_pipeline.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_delivery_pipeline.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.delete_delivery_pipeline request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_target(request, options = nil) ⇒ ::Gapic::Operation #delete_target(name: nil, request_id: nil, allow_missing: nil, validate_only: nil, etag: nil) ⇒ ::Gapic::Operation

Deletes a single Target.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::DeleteTargetRequest.new

# Call the delete_target method.
result = client.delete_target request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #delete_target(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_target via a request object, either of type DeleteTargetRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::DeleteTargetRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #delete_target(name: nil, request_id: nil, allow_missing: nil, validate_only: nil, etag: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_target via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The name of the Target to delete. Format should be projects/{project_id}/locations/{location_name}/targets/{target_name}.

    • request_id (::String) (defaults to: nil) —

      Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

    • allow_missing (::Boolean) (defaults to: nil) —

      Optional. If set to true, then deleting an already deleted or non-existing Target will succeed.

    • validate_only (::Boolean) (defaults to: nil) —

      Optional. If set, validate the request and preview the review, but do not actually post it.

    • etag (::String) (defaults to: nil) —

      Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 1396

def delete_target request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::DeleteTargetRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.delete_target.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_target.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_target.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.delete_target request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_automation(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::Automation #get_automation(name: nil) ⇒ ::Google::Cloud::Deploy::V1::Automation

Gets details of a single Automation.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::GetAutomationRequest.new

# Call the get_automation method.
result = client.get_automation request

# The returned object is of type Google::Cloud::Deploy::V1::Automation.
p result

Overloads:

  • #get_automation(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::Automation

    Pass arguments to get_automation via a request object, either of type GetAutomationRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::GetAutomationRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #get_automation(name: nil) ⇒ ::Google::Cloud::Deploy::V1::Automation

    Pass arguments to get_automation via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Name of the Automation. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automations/{automation_name}.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 3719

def get_automation request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::GetAutomationRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_automation.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_automation.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_automation.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.get_automation request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_automation_run(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::AutomationRun #get_automation_run(name: nil) ⇒ ::Google::Cloud::Deploy::V1::AutomationRun

Gets details of a single AutomationRun.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::GetAutomationRunRequest.new

# Call the get_automation_run method.
result = client.get_automation_run request

# The returned object is of type Google::Cloud::Deploy::V1::AutomationRun.
p result

Overloads:

  • #get_automation_run(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::AutomationRun

    Pass arguments to get_automation_run via a request object, either of type GetAutomationRunRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::GetAutomationRunRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #get_automation_run(name: nil) ⇒ ::Google::Cloud::Deploy::V1::AutomationRun

    Pass arguments to get_automation_run via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Name of the AutomationRun. Format must be projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 3898

def get_automation_run request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::GetAutomationRunRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_automation_run.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_automation_run.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_automation_run.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.get_automation_run request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_config(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::Config #get_config(name: nil) ⇒ ::Google::Cloud::Deploy::V1::Config

Gets the configuration for a location.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::GetConfigRequest.new

# Call the get_config method.
result = client.get_config request

# The returned object is of type Google::Cloud::Deploy::V1::Config.
p result

Overloads:

  • #get_config(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::Config

    Pass arguments to get_config via a request object, either of type GetConfigRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::GetConfigRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #get_config(name: nil) ⇒ ::Google::Cloud::Deploy::V1::Config

    Pass arguments to get_config via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Name of requested configuration.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 3307

def get_config request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::GetConfigRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_config.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_config.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_config.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.get_config request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_custom_target_type(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::CustomTargetType #get_custom_target_type(name: nil) ⇒ ::Google::Cloud::Deploy::V1::CustomTargetType

Gets details of a single CustomTargetType.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::GetCustomTargetTypeRequest.new

# Call the get_custom_target_type method.
result = client.get_custom_target_type request

# The returned object is of type Google::Cloud::Deploy::V1::CustomTargetType.
p result

Overloads:

  • #get_custom_target_type(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::CustomTargetType

    Pass arguments to get_custom_target_type via a request object, either of type GetCustomTargetTypeRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::GetCustomTargetTypeRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #get_custom_target_type(name: nil) ⇒ ::Google::Cloud::Deploy::V1::CustomTargetType

    Pass arguments to get_custom_target_type via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Name of the CustomTargetType. Format must be projects/{project_id}/locations/{location_name}/customTargetTypes/{custom_target_type}.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 1576

def get_custom_target_type request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::GetCustomTargetTypeRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_custom_target_type.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_custom_target_type.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_custom_target_type.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.get_custom_target_type request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_delivery_pipeline(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::DeliveryPipeline #get_delivery_pipeline(name: nil) ⇒ ::Google::Cloud::Deploy::V1::DeliveryPipeline

Gets details of a single DeliveryPipeline.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::GetDeliveryPipelineRequest.new

# Call the get_delivery_pipeline method.
result = client.get_delivery_pipeline request

# The returned object is of type Google::Cloud::Deploy::V1::DeliveryPipeline.
p result

Overloads:

  • #get_delivery_pipeline(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::DeliveryPipeline

    Pass arguments to get_delivery_pipeline via a request object, either of type GetDeliveryPipelineRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::GetDeliveryPipelineRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #get_delivery_pipeline(name: nil) ⇒ ::Google::Cloud::Deploy::V1::DeliveryPipeline

    Pass arguments to get_delivery_pipeline via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Name of the DeliveryPipeline. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 454

def get_delivery_pipeline request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::GetDeliveryPipelineRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_delivery_pipeline.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_delivery_pipeline.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_delivery_pipeline.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.get_delivery_pipeline request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_job_run(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::JobRun #get_job_run(name: nil) ⇒ ::Google::Cloud::Deploy::V1::JobRun

Gets details of a single JobRun.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::GetJobRunRequest.new

# Call the get_job_run method.
result = client.get_job_run request

# The returned object is of type Google::Cloud::Deploy::V1::JobRun.
p result

Overloads:

  • #get_job_run(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::JobRun

    Pass arguments to get_job_run via a request object, either of type GetJobRunRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::GetJobRunRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #get_job_run(name: nil) ⇒ ::Google::Cloud::Deploy::V1::JobRun

    Pass arguments to get_job_run via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Name of the JobRun. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}/rollouts/{rollout_name}/jobRuns/{job_run_name}.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 3150

def get_job_run request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::GetJobRunRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_job_run.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_job_run.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_job_run.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.get_job_run request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_release(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::Release #get_release(name: nil) ⇒ ::Google::Cloud::Deploy::V1::Release

Gets details of a single Release.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::GetReleaseRequest.new

# Call the get_release method.
result = client.get_release request

# The returned object is of type Google::Cloud::Deploy::V1::Release.
p result

Overloads:

  • #get_release(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::Release

    Pass arguments to get_release via a request object, either of type GetReleaseRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::GetReleaseRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #get_release(name: nil) ⇒ ::Google::Cloud::Deploy::V1::Release

    Pass arguments to get_release via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Name of the Release. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 2087

def get_release request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::GetReleaseRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_release.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_release.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_release.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.get_release request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_rollout(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::Rollout #get_rollout(name: nil) ⇒ ::Google::Cloud::Deploy::V1::Rollout

Gets details of a single Rollout.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::GetRolloutRequest.new

# Call the get_rollout method.
result = client.get_rollout request

# The returned object is of type Google::Cloud::Deploy::V1::Rollout.
p result

Overloads:

  • #get_rollout(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::Rollout

    Pass arguments to get_rollout via a request object, either of type GetRolloutRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::GetRolloutRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #get_rollout(name: nil) ⇒ ::Google::Cloud::Deploy::V1::Rollout

    Pass arguments to get_rollout via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Name of the Rollout. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/releases/{release_name}/rollouts/{rollout_name}.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 2694

def get_rollout request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::GetRolloutRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_rollout.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_rollout.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_rollout.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.get_rollout request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_target(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::Target #get_target(name: nil) ⇒ ::Google::Cloud::Deploy::V1::Target

Gets details of a single Target.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::GetTargetRequest.new

# Call the get_target method.
result = client.get_target request

# The returned object is of type Google::Cloud::Deploy::V1::Target.
p result

Overloads:

  • #get_target(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::Target

    Pass arguments to get_target via a request object, either of type GetTargetRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::GetTargetRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #get_target(name: nil) ⇒ ::Google::Cloud::Deploy::V1::Target

    Pass arguments to get_target via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Name of the Target. Format must be projects/{project_id}/locations/{location_name}/targets/{target_name}.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 1065

def get_target request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::GetTargetRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_target.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_target.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_target.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.get_target request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#ignore_job(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::IgnoreJobResponse #ignore_job(rollout: nil, phase_id: nil, job_id: nil) ⇒ ::Google::Cloud::Deploy::V1::IgnoreJobResponse

Ignores the specified Job in a Rollout.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::IgnoreJobRequest.new

# Call the ignore_job method.
result = client.ignore_job request

# The returned object is of type Google::Cloud::Deploy::V1::IgnoreJobResponse.
p result

Overloads:

  • #ignore_job(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::IgnoreJobResponse

    Pass arguments to ignore_job via a request object, either of type IgnoreJobRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::IgnoreJobRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #ignore_job(rollout: nil, phase_id: nil, job_id: nil) ⇒ ::Google::Cloud::Deploy::V1::IgnoreJobResponse

    Pass arguments to ignore_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • rollout (::String) (defaults to: nil) —

      Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.

    • phase_id (::String) (defaults to: nil) —

      Required. The phase ID the Job to ignore belongs to.

    • job_id (::String) (defaults to: nil) —

      Required. The job ID for the Job to ignore.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 2889

def ignore_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::IgnoreJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.ignore_job.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.ignore_job.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.ignore_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.ignore_job request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_automation_runs(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::ListAutomationRunsResponse #list_automation_runs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::Deploy::V1::ListAutomationRunsResponse

Lists AutomationRuns in a given project and location.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::ListAutomationRunsRequest.new

# Call the list_automation_runs method.
result = client.list_automation_runs request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Deploy::V1::AutomationRun.
  p item
end

Overloads:

  • #list_automation_runs(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::ListAutomationRunsResponse

    Pass arguments to list_automation_runs via a request object, either of type ListAutomationRunsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::ListAutomationRunsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #list_automation_runs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::Deploy::V1::ListAutomationRunsResponse

    Pass arguments to list_automation_runs via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent Delivery Pipeline, which owns this collection of automationRuns. Format must be projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}.

    • page_size (::Integer) (defaults to: nil) —

      The maximum number of automationRuns to return. The service may return fewer than this value. If unspecified, at most 50 automationRuns will be returned. The maximum value is 1000; values above 1000 will be set to 1000.

    • page_token (::String) (defaults to: nil) —

      A page token, received from a previous ListAutomationRuns call. Provide this to retrieve the subsequent page.

      When paginating, all other provided parameters match the call that provided the page token.

    • filter (::String) (defaults to: nil) —

      Filter automationRuns to be returned. All fields can be used in the filter.

    • order_by (::String) (defaults to: nil) —

      Field to sort by.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 3998

def list_automation_runs request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::ListAutomationRunsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.list_automation_runs.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_automation_runs.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_automation_runs.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.list_automation_runs request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_automations(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::ListAutomationsResponse #list_automations(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::Deploy::V1::ListAutomationsResponse

Lists Automations in a given project and location.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::ListAutomationsRequest.new

# Call the list_automations method.
result = client.list_automations request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Deploy::V1::Automation.
  p item
end

Overloads:

  • #list_automations(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::ListAutomationsResponse

    Pass arguments to list_automations via a request object, either of type ListAutomationsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::ListAutomationsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #list_automations(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::Deploy::V1::ListAutomationsResponse

    Pass arguments to list_automations via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent Delivery Pipeline, which owns this collection of automations. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

    • page_size (::Integer) (defaults to: nil) —

      The maximum number of automations to return. The service may return fewer than this value. If unspecified, at most 50 automations will be returned. The maximum value is 1000; values above 1000 will be set to 1000.

    • page_token (::String) (defaults to: nil) —

      A page token, received from a previous ListAutomations call. Provide this to retrieve the subsequent page.

      When paginating, all other provided parameters match the call that provided the page token.

    • filter (::String) (defaults to: nil) —

      Filter automations to be returned. All fields can be used in the filter.

    • order_by (::String) (defaults to: nil) —

      Field to sort by.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 3819

def list_automations request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::ListAutomationsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.list_automations.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_automations.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_automations.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.list_automations request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_custom_target_types(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::ListCustomTargetTypesResponse #list_custom_target_types(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::Deploy::V1::ListCustomTargetTypesResponse

Lists CustomTargetTypes in a given project and location.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::ListCustomTargetTypesRequest.new

# Call the list_custom_target_types method.
result = client.list_custom_target_types request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Deploy::V1::CustomTargetType.
  p item
end

Overloads:

  • #list_custom_target_types(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::ListCustomTargetTypesResponse

    Pass arguments to list_custom_target_types via a request object, either of type ListCustomTargetTypesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::ListCustomTargetTypesRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #list_custom_target_types(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::Deploy::V1::ListCustomTargetTypesResponse

    Pass arguments to list_custom_target_types via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent that owns this collection of custom target types. Format must be projects/{project_id}/locations/{location_name}.

    • page_size (::Integer) (defaults to: nil) —

      Optional. The maximum number of CustomTargetType objects to return. The service may return fewer than this value. If unspecified, at most 50 CustomTargetType objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000.

    • page_token (::String) (defaults to: nil) —

      Optional. A page token, received from a previous ListCustomTargetTypes call. Provide this to retrieve the subsequent page.

      When paginating, all other provided parameters match the call that provided the page token.

    • filter (::String) (defaults to: nil) —

      Optional. Filter custom target types to be returned. See https://google.aip.dev/160 for more details.

    • order_by (::String) (defaults to: nil) —

      Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 1497

def list_custom_target_types request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::ListCustomTargetTypesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.list_custom_target_types.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_custom_target_types.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_custom_target_types.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.list_custom_target_types request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_delivery_pipelines(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::ListDeliveryPipelinesResponse #list_delivery_pipelines(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::Deploy::V1::ListDeliveryPipelinesResponse

Lists DeliveryPipelines in a given project and location.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::ListDeliveryPipelinesRequest.new

# Call the list_delivery_pipelines method.
result = client.list_delivery_pipelines request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Deploy::V1::DeliveryPipeline.
  p item
end

Overloads:

  • #list_delivery_pipelines(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::ListDeliveryPipelinesResponse

    Pass arguments to list_delivery_pipelines via a request object, either of type ListDeliveryPipelinesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::ListDeliveryPipelinesRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #list_delivery_pipelines(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::Deploy::V1::ListDeliveryPipelinesResponse

    Pass arguments to list_delivery_pipelines via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent, which owns this collection of pipelines. Format must be projects/{project_id}/locations/{location_name}.

    • page_size (::Integer) (defaults to: nil) —

      The maximum number of pipelines to return. The service may return fewer than this value. If unspecified, at most 50 pipelines will be returned. The maximum value is 1000; values above 1000 will be set to 1000.

    • page_token (::String) (defaults to: nil) —

      A page token, received from a previous ListDeliveryPipelines call. Provide this to retrieve the subsequent page.

      When paginating, all other provided parameters match the call that provided the page token.

    • filter (::String) (defaults to: nil) —

      Filter pipelines to be returned. See https://google.aip.dev/160 for more details.

    • order_by (::String) (defaults to: nil) —

      Field to sort by. See https://google.aip.dev/132#ordering for more details.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 375

def list_delivery_pipelines request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::ListDeliveryPipelinesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.list_delivery_pipelines.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_delivery_pipelines.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_delivery_pipelines.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.list_delivery_pipelines request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_job_runs(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::ListJobRunsResponse #list_job_runs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::Deploy::V1::ListJobRunsResponse

Lists JobRuns in a given project and location.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::ListJobRunsRequest.new

# Call the list_job_runs method.
result = client.list_job_runs request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Deploy::V1::JobRun.
  p item
end

Overloads:

  • #list_job_runs(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::ListJobRunsResponse

    Pass arguments to list_job_runs via a request object, either of type ListJobRunsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::ListJobRunsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #list_job_runs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::Deploy::V1::ListJobRunsResponse

    Pass arguments to list_job_runs via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The Rollout which owns this collection of JobRun objects.

    • page_size (::Integer) (defaults to: nil) —

      Optional. The maximum number of JobRun objects to return. The service may return fewer than this value. If unspecified, at most 50 JobRun objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000.

    • page_token (::String) (defaults to: nil) —

      Optional. A page token, received from a previous ListJobRuns call. Provide this to retrieve the subsequent page.

      When paginating, all other provided parameters match the call that provided the page token.

    • filter (::String) (defaults to: nil) —

      Optional. Filter results to be returned. See https://google.aip.dev/160 for more details.

    • order_by (::String) (defaults to: nil) —

      Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 3071

def list_job_runs request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::ListJobRunsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.list_job_runs.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_job_runs.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_job_runs.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.list_job_runs request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_releases(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::ListReleasesResponse #list_releases(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::Deploy::V1::ListReleasesResponse

Lists Releases in a given project and location.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::ListReleasesRequest.new

# Call the list_releases method.
result = client.list_releases request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Deploy::V1::Release.
  p item
end

Overloads:

  • #list_releases(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::ListReleasesResponse

    Pass arguments to list_releases via a request object, either of type ListReleasesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::ListReleasesRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #list_releases(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::Deploy::V1::ListReleasesResponse

    Pass arguments to list_releases via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The DeliveryPipeline which owns this collection of Release objects.

    • page_size (::Integer) (defaults to: nil) —

      Optional. The maximum number of Release objects to return. The service may return fewer than this value. If unspecified, at most 50 Release objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000.

    • page_token (::String) (defaults to: nil) —

      Optional. A page token, received from a previous ListReleases call. Provide this to retrieve the subsequent page.

      When paginating, all other provided parameters match the call that provided the page token.

    • filter (::String) (defaults to: nil) —

      Optional. Filter releases to be returned. See https://google.aip.dev/160 for more details.

    • order_by (::String) (defaults to: nil) —

      Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 2008

def list_releases request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::ListReleasesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.list_releases.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_releases.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_releases.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.list_releases request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_rollouts(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::ListRolloutsResponse #list_rollouts(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::Deploy::V1::ListRolloutsResponse

Lists Rollouts in a given project and location.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::ListRolloutsRequest.new

# Call the list_rollouts method.
result = client.list_rollouts request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Deploy::V1::Rollout.
  p item
end

Overloads:

  • #list_rollouts(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::ListRolloutsResponse

    Pass arguments to list_rollouts via a request object, either of type ListRolloutsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::ListRolloutsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #list_rollouts(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::Deploy::V1::ListRolloutsResponse

    Pass arguments to list_rollouts via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The Release which owns this collection of Rollout objects.

    • page_size (::Integer) (defaults to: nil) —

      Optional. The maximum number of Rollout objects to return. The service may return fewer than this value. If unspecified, at most 50 Rollout objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000.

    • page_token (::String) (defaults to: nil) —

      Optional. A page token, received from a previous ListRollouts call. Provide this to retrieve the subsequent page.

      When paginating, all other provided parameters match the call that provided the page token.

    • filter (::String) (defaults to: nil) —

      Optional. Filter rollouts to be returned. See https://google.aip.dev/160 for more details.

    • order_by (::String) (defaults to: nil) —

      Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 2615

def list_rollouts request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::ListRolloutsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.list_rollouts.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_rollouts.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_rollouts.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.list_rollouts request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_targets(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::ListTargetsResponse #list_targets(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::Deploy::V1::ListTargetsResponse

Lists Targets in a given project and location.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::ListTargetsRequest.new

# Call the list_targets method.
result = client.list_targets request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Deploy::V1::Target.
  p item
end

Overloads:

  • #list_targets(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::ListTargetsResponse

    Pass arguments to list_targets via a request object, either of type ListTargetsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::ListTargetsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #list_targets(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) ⇒ ::Google::Cloud::Deploy::V1::ListTargetsResponse

    Pass arguments to list_targets via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • parent (::String) (defaults to: nil) —

      Required. The parent, which owns this collection of targets. Format must be projects/{project_id}/locations/{location_name}.

    • page_size (::Integer) (defaults to: nil) —

      Optional. The maximum number of Target objects to return. The service may return fewer than this value. If unspecified, at most 50 Target objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000.

    • page_token (::String) (defaults to: nil) —

      Optional. A page token, received from a previous ListTargets call. Provide this to retrieve the subsequent page.

      When paginating, all other provided parameters match the call that provided the page token.

    • filter (::String) (defaults to: nil) —

      Optional. Filter targets to be returned. See https://google.aip.dev/160 for more details.

    • order_by (::String) (defaults to: nil) —

      Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 890

def list_targets request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::ListTargetsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.list_targets.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_targets.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_targets.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.list_targets request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#retry_job(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::RetryJobResponse #retry_job(rollout: nil, phase_id: nil, job_id: nil) ⇒ ::Google::Cloud::Deploy::V1::RetryJobResponse

Retries the specified Job in a Rollout.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::RetryJobRequest.new

# Call the retry_job method.
result = client.retry_job request

# The returned object is of type Google::Cloud::Deploy::V1::RetryJobResponse.
p result

Overloads:

  • #retry_job(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::RetryJobResponse

    Pass arguments to retry_job via a request object, either of type RetryJobRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::RetryJobRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #retry_job(rollout: nil, phase_id: nil, job_id: nil) ⇒ ::Google::Cloud::Deploy::V1::RetryJobResponse

    Pass arguments to retry_job via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • rollout (::String) (defaults to: nil) —

      Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.

    • phase_id (::String) (defaults to: nil) —

      Required. The phase ID the Job to retry belongs to.

    • job_id (::String) (defaults to: nil) —

      Required. The job ID for the Job to retry.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 2972

def retry_job request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::RetryJobRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.retry_job.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.retry_job.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.retry_job.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.retry_job request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#rollback_target(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::RollbackTargetResponse #rollback_target(name: nil, target_id: nil, rollout_id: nil, release_id: nil, rollout_to_roll_back: nil, rollback_config: nil, validate_only: nil) ⇒ ::Google::Cloud::Deploy::V1::RollbackTargetResponse

Creates a Rollout to roll back the specified target.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::RollbackTargetRequest.new

# Call the rollback_target method.
result = client.rollback_target request

# The returned object is of type Google::Cloud::Deploy::V1::RollbackTargetResponse.
p result

Overloads:

  • #rollback_target(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::RollbackTargetResponse

    Pass arguments to rollback_target via a request object, either of type RollbackTargetRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::RollbackTargetRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #rollback_target(name: nil, target_id: nil, rollout_id: nil, release_id: nil, rollout_to_roll_back: nil, rollback_config: nil, validate_only: nil) ⇒ ::Google::Cloud::Deploy::V1::RollbackTargetResponse

    Pass arguments to rollback_target via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The DeliveryPipeline for which the rollback Rollout should be created. Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.

    • target_id (::String) (defaults to: nil) —

      Required. ID of the Target that is being rolled back.

    • rollout_id (::String) (defaults to: nil) —

      Required. ID of the rollback Rollout to create.

    • release_id (::String) (defaults to: nil) —

      Optional. ID of the Release to roll back to. If this isn't specified, the previous successful Rollout to the specified target will be used to determine the Release.

    • rollout_to_roll_back (::String) (defaults to: nil) —

      Optional. If provided, this must be the latest Rollout that is on the Target.

    • rollback_config (::Google::Cloud::Deploy::V1::RollbackTargetConfig, ::Hash) (defaults to: nil) —

      Optional. Configs for the rollback Rollout.

    • validate_only (::Boolean) (defaults to: nil) —

      Optional. If set to true, the request is validated and the user is provided with a RollbackTargetResponse.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 986

def rollback_target request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::RollbackTargetRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.rollback_target.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.rollback_target.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.rollback_target.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.rollback_target request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#terminate_job_run(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::TerminateJobRunResponse #terminate_job_run(name: nil) ⇒ ::Google::Cloud::Deploy::V1::TerminateJobRunResponse

Terminates a Job Run in a given project and location.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::TerminateJobRunRequest.new

# Call the terminate_job_run method.
result = client.terminate_job_run request

# The returned object is of type Google::Cloud::Deploy::V1::TerminateJobRunResponse.
p result

Overloads:

  • #terminate_job_run(request, options = nil) ⇒ ::Google::Cloud::Deploy::V1::TerminateJobRunResponse

    Pass arguments to terminate_job_run via a request object, either of type TerminateJobRunRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::TerminateJobRunRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #terminate_job_run(name: nil) ⇒ ::Google::Cloud::Deploy::V1::TerminateJobRunResponse

    Pass arguments to terminate_job_run via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Name of the JobRun. Format must be projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}/jobRuns/{jobRun}.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 3229

def terminate_job_run request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::TerminateJobRunRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.terminate_job_run.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.terminate_job_run.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.terminate_job_run.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.terminate_job_run request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_automation(request, options = nil) ⇒ ::Gapic::Operation #update_automation(update_mask: nil, automation: nil, request_id: nil, allow_missing: nil, validate_only: nil) ⇒ ::Gapic::Operation

Updates the parameters of a single Automation resource.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::UpdateAutomationRequest.new

# Call the update_automation method.
result = client.update_automation request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #update_automation(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to update_automation via a request object, either of type UpdateAutomationRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::UpdateAutomationRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #update_automation(update_mask: nil, automation: nil, request_id: nil, allow_missing: nil, validate_only: nil) ⇒ ::Gapic::Operation

    Pass arguments to update_automation via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Required. Field mask is used to specify the fields to be overwritten in the Automation resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it's in the mask. If the user doesn't provide a mask then all fields are overwritten.

    • automation (::Google::Cloud::Deploy::V1::Automation, ::Hash) (defaults to: nil) —

      Required. The Automation to update.

    • request_id (::String) (defaults to: nil) —

      Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

    • allow_missing (::Boolean) (defaults to: nil) —

      Optional. If set to true, updating a Automation that does not exist will result in the creation of a new Automation.

    • validate_only (::Boolean) (defaults to: nil) —

      Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 3527

def update_automation request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::UpdateAutomationRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.update_automation.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_automation.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_automation.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.update_automation request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_custom_target_type(request, options = nil) ⇒ ::Gapic::Operation #update_custom_target_type(update_mask: nil, custom_target_type: nil, request_id: nil, allow_missing: nil, validate_only: nil) ⇒ ::Gapic::Operation

Updates a single CustomTargetType.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::UpdateCustomTargetTypeRequest.new

# Call the update_custom_target_type method.
result = client.update_custom_target_type request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #update_custom_target_type(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to update_custom_target_type via a request object, either of type UpdateCustomTargetTypeRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::UpdateCustomTargetTypeRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #update_custom_target_type(update_mask: nil, custom_target_type: nil, request_id: nil, allow_missing: nil, validate_only: nil) ⇒ ::Gapic::Operation

    Pass arguments to update_custom_target_type via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Required. Field mask is used to specify the fields to be overwritten in the CustomTargetType resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it's in the mask. If the user doesn't provide a mask then all fields are overwritten.

    • custom_target_type (::Google::Cloud::Deploy::V1::CustomTargetType, ::Hash) (defaults to: nil) —

      Required. The CustomTargetType to update.

    • request_id (::String) (defaults to: nil) —

      Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

    • allow_missing (::Boolean) (defaults to: nil) —

      Optional. If set to true, updating a CustomTargetType that does not exist will result in the creation of a new CustomTargetType.

    • validate_only (::Boolean) (defaults to: nil) —

      Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 1796

def update_custom_target_type request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::UpdateCustomTargetTypeRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.update_custom_target_type.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_custom_target_type.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_custom_target_type.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.update_custom_target_type request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_delivery_pipeline(request, options = nil) ⇒ ::Gapic::Operation #update_delivery_pipeline(update_mask: nil, delivery_pipeline: nil, request_id: nil, allow_missing: nil, validate_only: nil) ⇒ ::Gapic::Operation

Updates the parameters of a single DeliveryPipeline.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::UpdateDeliveryPipelineRequest.new

# Call the update_delivery_pipeline method.
result = client.update_delivery_pipeline request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #update_delivery_pipeline(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to update_delivery_pipeline via a request object, either of type UpdateDeliveryPipelineRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::UpdateDeliveryPipelineRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #update_delivery_pipeline(update_mask: nil, delivery_pipeline: nil, request_id: nil, allow_missing: nil, validate_only: nil) ⇒ ::Gapic::Operation

    Pass arguments to update_delivery_pipeline via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Required. Field mask is used to specify the fields to be overwritten in the DeliveryPipeline resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it's in the mask. If the user doesn't provide a mask then all fields are overwritten.

    • delivery_pipeline (::Google::Cloud::Deploy::V1::DeliveryPipeline, ::Hash) (defaults to: nil) —

      Required. The DeliveryPipeline to update.

    • request_id (::String) (defaults to: nil) —

      Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

    • allow_missing (::Boolean) (defaults to: nil) —

      Optional. If set to true, updating a DeliveryPipeline that does not exist will result in the creation of a new DeliveryPipeline.

    • validate_only (::Boolean) (defaults to: nil) —

      Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 674

def update_delivery_pipeline request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::UpdateDeliveryPipelineRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.update_delivery_pipeline.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_delivery_pipeline.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_delivery_pipeline.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.update_delivery_pipeline request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_target(request, options = nil) ⇒ ::Gapic::Operation #update_target(update_mask: nil, target: nil, request_id: nil, allow_missing: nil, validate_only: nil) ⇒ ::Gapic::Operation

Updates the parameters of a single Target.

Examples:

Basic example

require "google/cloud/deploy/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Deploy::V1::UpdateTargetRequest.new

# Call the update_target method.
result = client.update_target request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #update_target(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to update_target via a request object, either of type UpdateTargetRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::Deploy::V1::UpdateTargetRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #update_target(update_mask: nil, target: nil, request_id: nil, allow_missing: nil, validate_only: nil) ⇒ ::Gapic::Operation

    Pass arguments to update_target via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Required. Field mask is used to specify the fields to be overwritten in the Target resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it's in the mask. If the user doesn't provide a mask then all fields are overwritten.

    • target (::Google::Cloud::Deploy::V1::Target, ::Hash) (defaults to: nil) —

      Required. The Target to update.

    • request_id (::String) (defaults to: nil) —

      Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request.

      For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

      The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

    • allow_missing (::Boolean) (defaults to: nil) —

      Optional. If set to true, updating a Target that does not exist will result in the creation of a new Target.

    • validate_only (::Boolean) (defaults to: nil) —

      Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
 
# File 'lib/google/cloud/deploy/v1/cloud_deploy/rest/client.rb', line 1285

def update_target request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Deploy::V1::UpdateTargetRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.update_target.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Deploy::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_target.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_target.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @cloud_deploy_stub.update_target request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end