Google Cloud Deploy V1 API - Class Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client (v0.13.0)

Reference documentation and code samples for the Google Cloud Deploy V1 API class Google::Cloud::Deploy::V1::CloudDeploy::Rest::Client.

REST client for the CloudDeploy service.

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

Inherits

Object

Includes

Google::Cloud::Deploy::V1::CloudDeploy::Paths

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the CloudDeploy Client class.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

Example

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

#abandon_release

def abandon_release(request, options = nil) -> ::Google::Cloud::Deploy::V1::AbandonReleaseResponse
def abandon_release(name: nil) -> ::Google::Cloud::Deploy::V1::AbandonReleaseResponse

Abandons a Release in the Delivery Pipeline.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def 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).

Parameter

name (::String) — 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

result (::Google::Cloud::Deploy::V1::AbandonReleaseResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Deploy::V1::AbandonReleaseResponse)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

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

#advance_rollout

def advance_rollout(request, options = nil) -> ::Google::Cloud::Deploy::V1::AdvanceRolloutResponse
def advance_rollout(name: nil, phase_id: nil) -> ::Google::Cloud::Deploy::V1::AdvanceRolloutResponse

Advances a Rollout in a given project and location.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def 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) — Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}.
phase_id (::String) — Required. The phase ID to advance the Rollout to.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::Deploy::V1::AdvanceRolloutResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Deploy::V1::AdvanceRolloutResponse)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

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

#approve_rollout

def approve_rollout(request, options = nil) -> ::Google::Cloud::Deploy::V1::ApproveRolloutResponse
def approve_rollout(name: nil, approved: nil) -> ::Google::Cloud::Deploy::V1::ApproveRolloutResponse

Approves a Rollout.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def 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) — Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}.
approved (::Boolean) — Required. True = approve; false = reject

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::Deploy::V1::ApproveRolloutResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Deploy::V1::ApproveRolloutResponse)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

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

#cancel_rollout

def cancel_rollout(request, options = nil) -> ::Google::Cloud::Deploy::V1::CancelRolloutResponse
def cancel_rollout(name: nil) -> ::Google::Cloud::Deploy::V1::CancelRolloutResponse

Cancels a Rollout in a given project and location.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def 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).

Parameter

name (::String) — 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

result (::Google::Cloud::Deploy::V1::CancelRolloutResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Deploy::V1::CancelRolloutResponse)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

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

#configure

def 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 Client.configure.

See Configuration for a description of the configuration fields.

Yields

(config) — Configure the Client client.

Yield Parameter

config (Client::Configuration)

Returns

(Client::Configuration)

#create_delivery_pipeline

def create_delivery_pipeline(request, options = nil) -> ::Gapic::Operation
def 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.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def 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) — Required. The parent collection in which the DeliveryPipeline should be created. Format should be projects/{project_id}/locations/{location_name}.
delivery_pipeline_id (::String) — Required. ID of the DeliveryPipeline.
delivery_pipeline (::Google::Cloud::Deploy::V1::DeliveryPipeline, ::Hash) — Required. The DeliveryPipeline to create.
request_id (::String) — Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since 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) — 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.

Example

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

#create_release

def create_release(request, options = nil) -> ::Gapic::Operation
def 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.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def 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) — 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) — Required. ID of the Release.
release (::Google::Cloud::Deploy::V1::Release, ::Hash) — Required. The Release to create.
request_id (::String) — Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since 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) — 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.

Example

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

#create_rollout

def create_rollout(request, options = nil) -> ::Gapic::Operation
def 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.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def 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) — 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) — Required. ID of the Rollout.
rollout (::Google::Cloud::Deploy::V1::Rollout, ::Hash) — Required. The Rollout to create.
request_id (::String) — Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since 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) — 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) — 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.

Example

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

#create_target

def create_target(request, options = nil) -> ::Gapic::Operation
def 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.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def 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) — Required. The parent collection in which the Target should be created. Format should be projects/{project_id}/locations/{location_name}.
target_id (::String) — Required. ID of the Target.
target (::Google::Cloud::Deploy::V1::Target, ::Hash) — Required. The Target to create.
request_id (::String) — Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since 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) — 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.

Example

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

#delete_delivery_pipeline

def delete_delivery_pipeline(request, options = nil) -> ::Gapic::Operation
def delete_delivery_pipeline(name: nil, request_id: nil, allow_missing: nil, validate_only: nil, force: nil, etag: nil) -> ::Gapic::Operation

Deletes a single DeliveryPipeline.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def 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) — Required. The name of the DeliveryPipeline to delete. Format should be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.
request_id (::String) — Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee 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) — Optional. If set to true, then deleting an already deleted or non-existing DeliveryPipeline will succeed.
validate_only (::Boolean) — Optional. If set, validate the request and preview the review, but do not actually post it.
force (::Boolean) — 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) — 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.

Example

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

#delete_target

def delete_target(request, options = nil) -> ::Gapic::Operation
def delete_target(name: nil, request_id: nil, allow_missing: nil, validate_only: nil, etag: nil) -> ::Gapic::Operation

Deletes a single Target.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def 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) — Required. The name of the Target to delete. Format should be projects/{project_id}/locations/{location_name}/targets/{target_name}.
request_id (::String) — Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee 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) — Optional. If set to true, then deleting an already deleted or non-existing Target will succeed.
validate_only (::Boolean) — Optional. If set, validate the request and preview the review, but do not actually post it.
etag (::String) — 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.

Example

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

#get_config

def get_config(request, options = nil) -> ::Google::Cloud::Deploy::V1::Config
def get_config(name: nil) -> ::Google::Cloud::Deploy::V1::Config

Gets the configuration for a location.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def 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).

Parameter

name (::String) — Required. Name of requested configuration.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::Deploy::V1::Config)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Deploy::V1::Config)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

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

#get_delivery_pipeline

def get_delivery_pipeline(request, options = nil) -> ::Google::Cloud::Deploy::V1::DeliveryPipeline
def get_delivery_pipeline(name: nil) -> ::Google::Cloud::Deploy::V1::DeliveryPipeline

Gets details of a single DeliveryPipeline.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def 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).

Parameter

name (::String) — 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

result (::Google::Cloud::Deploy::V1::DeliveryPipeline)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Deploy::V1::DeliveryPipeline)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

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

#get_job_run

def get_job_run(request, options = nil) -> ::Google::Cloud::Deploy::V1::JobRun
def get_job_run(name: nil) -> ::Google::Cloud::Deploy::V1::JobRun

Gets details of a single JobRun.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def 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).

Parameter

name (::String) — 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

result (::Google::Cloud::Deploy::V1::JobRun)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Deploy::V1::JobRun)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

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

#get_release

def get_release(request, options = nil) -> ::Google::Cloud::Deploy::V1::Release
def get_release(name: nil) -> ::Google::Cloud::Deploy::V1::Release

Gets details of a single Release.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def 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).

Parameter

name (::String) — 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

result (::Google::Cloud::Deploy::V1::Release)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Deploy::V1::Release)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

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

#get_rollout

def get_rollout(request, options = nil) -> ::Google::Cloud::Deploy::V1::Rollout
def get_rollout(name: nil) -> ::Google::Cloud::Deploy::V1::Rollout

Gets details of a single Rollout.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def 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).

Parameter

name (::String) — 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

result (::Google::Cloud::Deploy::V1::Rollout)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Deploy::V1::Rollout)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

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

#get_target

def get_target(request, options = nil) -> ::Google::Cloud::Deploy::V1::Target
def get_target(name: nil) -> ::Google::Cloud::Deploy::V1::Target

Gets details of a single Target.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def 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).

Parameter

name (::String) — 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

result (::Google::Cloud::Deploy::V1::Target)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Deploy::V1::Target)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

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

#iam_policy_client

def iam_policy_client() -> Google::Iam::V1::IAMPolicy::Rest::Client

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

Returns

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

#ignore_job

def ignore_job(request, options = nil) -> ::Google::Cloud::Deploy::V1::IgnoreJobResponse
def ignore_job(rollout: nil, phase_id: nil, job_id: nil) -> ::Google::Cloud::Deploy::V1::IgnoreJobResponse

Ignores the specified Job in a Rollout.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def 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) — Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}.
phase_id (::String) — Required. The phase ID the Job to ignore belongs to.
job_id (::String) — Required. The job ID for the Job to ignore.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::Deploy::V1::IgnoreJobResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Deploy::V1::IgnoreJobResponse)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

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

#initialize

def initialize() { |config| ... } -> Client

Create a new CloudDeploy REST client object.

Yields

(config) — Configure the CloudDeploy client.

Yield Parameter

config (Client::Configuration)

Returns

(Client) — a new instance of Client

Example

# 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

#list_delivery_pipelines

def list_delivery_pipelines(request, options = nil) -> ::Google::Cloud::Deploy::V1::ListDeliveryPipelinesResponse
def 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.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def 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) — Required. The parent, which owns this collection of pipelines. Format must be projects/{project_id}/locations/{location_name}.
page_size (::Integer) — 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) — 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) — Filter pipelines to be returned. See https://google.aip.dev/160 for more details.
order_by (::String) — 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

result (::Google::Cloud::Deploy::V1::ListDeliveryPipelinesResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Deploy::V1::ListDeliveryPipelinesResponse)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

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

#list_job_runs

def list_job_runs(request, options = nil) -> ::Google::Cloud::Deploy::V1::ListJobRunsResponse
def 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.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def 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) — Required. The Rollout which owns this collection of JobRun objects.
page_size (::Integer) — 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) — 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) — Optional. Filter results to be returned. See https://google.aip.dev/160 for more details.
order_by (::String) — 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

result (::Google::Cloud::Deploy::V1::ListJobRunsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Deploy::V1::ListJobRunsResponse)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

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

#list_releases

def list_releases(request, options = nil) -> ::Google::Cloud::Deploy::V1::ListReleasesResponse
def 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.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def 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) — Required. The DeliveryPipeline which owns this collection of Release objects.
page_size (::Integer) — 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) — 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) — Optional. Filter releases to be returned. See https://google.aip.dev/160 for more details.
order_by (::String) — 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

result (::Google::Cloud::Deploy::V1::ListReleasesResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Deploy::V1::ListReleasesResponse)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

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

#list_rollouts

def list_rollouts(request, options = nil) -> ::Google::Cloud::Deploy::V1::ListRolloutsResponse
def 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.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def 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) — Required. The Release which owns this collection of Rollout objects.
page_size (::Integer) — 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) — 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) — Optional. Filter rollouts to be returned. See https://google.aip.dev/160 for more details.
order_by (::String) — 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

result (::Google::Cloud::Deploy::V1::ListRolloutsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Deploy::V1::ListRolloutsResponse)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

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

#list_targets

def list_targets(request, options = nil) -> ::Google::Cloud::Deploy::V1::ListTargetsResponse
def 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.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def 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) — Required. The parent, which owns this collection of targets. Format must be projects/{project_id}/locations/{location_name}.
page_size (::Integer) — 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) — 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) — Optional. Filter targets to be returned. See https://google.aip.dev/160 for more details.
order_by (::String) — 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

result (::Google::Cloud::Deploy::V1::ListTargetsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Deploy::V1::ListTargetsResponse)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

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

#location_client

def location_client() -> Google::Cloud::Location::Locations::Rest::Client

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

Returns

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

#operations_client

def operations_client() -> ::Google::Cloud::Deploy::V1::CloudDeploy::Rest::Operations

Get the associated client for long-running operations.

Returns

(::Google::Cloud::Deploy::V1::CloudDeploy::Rest::Operations)

#retry_job

def retry_job(request, options = nil) -> ::Google::Cloud::Deploy::V1::RetryJobResponse
def retry_job(rollout: nil, phase_id: nil, job_id: nil) -> ::Google::Cloud::Deploy::V1::RetryJobResponse

Retries the specified Job in a Rollout.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def 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) — Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/ releases/{release}/rollouts/{rollout}.
phase_id (::String) — Required. The phase ID the Job to retry belongs to.
job_id (::String) — Required. The job ID for the Job to retry.

Yields

(result, operation) — Access the result along with the TransportOperation object

Yield Parameters

result (::Google::Cloud::Deploy::V1::RetryJobResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Deploy::V1::RetryJobResponse)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

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

#terminate_job_run

def terminate_job_run(request, options = nil) -> ::Google::Cloud::Deploy::V1::TerminateJobRunResponse
def terminate_job_run(name: nil) -> ::Google::Cloud::Deploy::V1::TerminateJobRunResponse

Terminates a Job Run in a given project and location.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def 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).

Parameter

name (::String) — 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

result (::Google::Cloud::Deploy::V1::TerminateJobRunResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Cloud::Deploy::V1::TerminateJobRunResponse)

Raises

(::Google::Cloud::Error) — if the REST call is aborted.

Example

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

#update_delivery_pipeline

def update_delivery_pipeline(request, options = nil) -> ::Gapic::Operation
def 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.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def 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) — 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 is in the mask. If the user does not provide a mask then all fields will be overwritten.
delivery_pipeline (::Google::Cloud::Deploy::V1::DeliveryPipeline, ::Hash) — Required. The DeliveryPipeline to update.
request_id (::String) — Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since 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) — Optional. If set to true, updating a DeliveryPipeline that does not exist will result in the creation of a new DeliveryPipeline.
validate_only (::Boolean) — 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.

Example

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

#update_target

def update_target(request, options = nil) -> ::Gapic::Operation
def 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.

Overloads

def 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) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

def 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) — 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 is in the mask. If the user does not provide a mask then all fields will be overwritten.
target (::Google::Cloud::Deploy::V1::Target, ::Hash) — Required. The Target to update.
request_id (::String) — Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since 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) — Optional. If set to true, updating a Target that does not exist will result in the creation of a new Target.
validate_only (::Boolean) — 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.

Example

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