Google Cloud Deploy V1 API - Class Google::Cloud::Deploy::V1::CloudDeploy::Client (v1.4.0)

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

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

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
Returns
Example 
# Modify the configuration for all CloudDeploy clients
::Google::Cloud::Deploy::V1::CloudDeploy::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
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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, override_deploy_policy: 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, override_deploy_policy: 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.
  • override_deploy_policy (::Array<::String>) — Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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, override_deploy_policy: 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, override_deploy_policy: 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
  • override_deploy_policy (::Array<::String>) — Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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_automation_run

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

Overloads 
def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def 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).
Parameter
  • name (::String) — Required. Name of the AutomationRun. Format is projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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

#cancel_rollout

def cancel_rollout(request, options = nil) -> ::Google::Cloud::Deploy::V1::CancelRolloutResponse
def cancel_rollout(name: nil, override_deploy_policy: 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, override_deploy_policy: 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) — Required. Name of the Rollout. Format is projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.
  • override_deploy_policy (::Array<::String>) — Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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
Returns

#create_automation

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

Overloads 
def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def 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) — Required. The parent collection in which the Automation must be created. The format is projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.
  • automation_id (::String) — Required. ID of the Automation.
  • automation (::Google::Cloud::Deploy::V1::Automation, ::Hash) — Required. The Automation 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 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) — 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
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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

#create_custom_target_type

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

Overloads 
def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def 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) — Required. The parent collection in which the CustomTargetType must be created. The format is projects/{project_id}/locations/{location_name}.
  • custom_target_type_id (::String) — Required. ID of the CustomTargetType.
  • custom_target_type (::Google::Cloud::Deploy::V1::CustomTargetType, ::Hash) — Required. The CustomTargetType 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 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) — 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
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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

#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 must be created. The format is 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 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) — 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
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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_deploy_policy

def create_deploy_policy(request, options = nil) -> ::Gapic::Operation
def create_deploy_policy(parent: nil, deploy_policy_id: nil, deploy_policy: nil, request_id: nil, validate_only: nil) -> ::Gapic::Operation

Creates a new DeployPolicy in a given project and location.

Overloads 
def create_deploy_policy(request, options = nil) -> ::Gapic::Operation
Pass arguments to create_deploy_policy via a request object, either of type Google::Cloud::Deploy::V1::CreateDeployPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Deploy::V1::CreateDeployPolicyRequest, ::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_deploy_policy(parent: nil, deploy_policy_id: nil, deploy_policy: nil, request_id: nil, validate_only: nil) -> ::Gapic::Operation
Pass arguments to create_deploy_policy 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 DeployPolicy must be created. The format is projects/{project_id}/locations/{location_name}.
  • deploy_policy_id (::String) — Required. ID of the DeployPolicy.
  • deploy_policy (::Google::Cloud::Deploy::V1::DeployPolicy, ::Hash) — Required. The DeployPolicy 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 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) — 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
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC 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::Client.new

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

# Call the create_deploy_policy method.
result = client.create_deploy_policy 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, override_deploy_policy: 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, override_deploy_policy: 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 is created. The format is 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 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) — Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.
  • override_deploy_policy (::Array<::String>) — Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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, override_deploy_policy: 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, override_deploy_policy: 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 must be created. The format is 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 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) — Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.
  • override_deploy_policy (::Array<::String>) — Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.
  • starting_phase_id (::String) — Optional. The starting phase ID for the Rollout. If empty the Rollout will start at the first phase.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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 must be created. The format is 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 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) — 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
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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_automation

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

Deletes a single Automation resource.

Overloads 
def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def 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) — Required. The name of the Automation to delete. The format is projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automations/{automation_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 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) — Optional. If set to true, then deleting an already deleted or non-existing Automation will succeed.
  • validate_only (::Boolean) — Optional. If set, validate the request and verify whether the resource exists, but do not actually post it.
  • etag (::String) — 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
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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

#delete_custom_target_type

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

Deletes a single CustomTargetType.

Overloads 
def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def 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) — Required. The name of the CustomTargetType to delete. Format must be projects/{project_id}/locations/{location_name}/customTargetTypes/{custom_target_type}.
  • 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 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) — Optional. If set to true, then deleting an already deleted or non-existing CustomTargetType will succeed.
  • validate_only (::Boolean) — Optional. If set to true, the request is validated but no actual change is made.
  • 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
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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

#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. The format is 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 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) — 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
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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_deploy_policy

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

Deletes a single DeployPolicy.

Overloads 
def delete_deploy_policy(request, options = nil) -> ::Gapic::Operation
Pass arguments to delete_deploy_policy via a request object, either of type DeleteDeployPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Deploy::V1::DeleteDeployPolicyRequest, ::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_deploy_policy(name: nil, request_id: nil, allow_missing: nil, validate_only: nil, etag: nil) -> ::Gapic::Operation
Pass arguments to delete_deploy_policy 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 DeployPolicy to delete. The format is projects/{project_id}/locations/{location_name}/deployPolicies/{deploy_policy_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 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) — Optional. If set to true, then deleting an already deleted or non-existing DeployPolicy 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
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC 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::Client.new

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

# Call the delete_deploy_policy method.
result = client.delete_deploy_policy 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. The format is 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 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) — 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
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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_automation

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

Gets details of a single Automation.

Overloads 
def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def 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).
Parameter
  • name (::String) — Required. Name of the Automation. Format must be projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}/automations/{automation_name}.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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

#get_automation_run

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

Gets details of a single AutomationRun.

Overloads 
def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def 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).
Parameter
  • name (::String) — Required. Name of the AutomationRun. Format must be projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}/automationRuns/{automation_run}.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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

#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
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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_custom_target_type

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

Gets details of a single CustomTargetType.

Overloads 
def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def 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).
Parameter
  • name (::String) — Required. Name of the CustomTargetType. Format must be projects/{project_id}/locations/{location_name}/customTargetTypes/{custom_target_type}.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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

#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
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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_deploy_policy

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

Gets details of a single DeployPolicy.

Overloads 
def get_deploy_policy(request, options = nil) -> ::Google::Cloud::Deploy::V1::DeployPolicy
Pass arguments to get_deploy_policy via a request object, either of type GetDeployPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Deploy::V1::GetDeployPolicyRequest, ::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_deploy_policy(name: nil) -> ::Google::Cloud::Deploy::V1::DeployPolicy
Pass arguments to get_deploy_policy 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 DeployPolicy. Format must be projects/{project_id}/locations/{location_name}/deployPolicies/{deploy_policy_name}.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC 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::Client.new

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

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

# The returned object is of type Google::Cloud::Deploy::V1::DeployPolicy.
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
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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::Client

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

Returns
  • (Google::Iam::V1::IAMPolicy::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, override_deploy_policy: 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, override_deploy_policy: 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.
  • override_deploy_policy (::Array<::String>) — Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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 client object.

Yields
  • (config) — Configure the CloudDeploy client.
Yield Parameter
Returns
  • (Client) — a new instance of Client
Example 
# Create a client using the default configuration
client = ::Google::Cloud::Deploy::V1::CloudDeploy::Client.new

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

#list_automation_runs

def list_automation_runs(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::AutomationRun>
def list_automation_runs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::AutomationRun>

Lists AutomationRuns in a given project and location.

Overloads 
def list_automation_runs(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::AutomationRun>
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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_automation_runs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::AutomationRun>
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) — Required. The parent Delivery Pipeline, which owns this collection of automationRuns. Format must be projects/{project}/locations/{location}/deliveryPipelines/{delivery_pipeline}.
  • page_size (::Integer) — 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) — 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) — Filter automationRuns to be returned. All fields can be used in the filter.
  • order_by (::String) — Field to sort by.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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

#list_automations

def list_automations(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::Automation>
def list_automations(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::Automation>

Lists Automations in a given project and location.

Overloads 
def list_automations(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::Automation>
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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_automations(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::Automation>
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) — 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) — 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) — 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) — Filter automations to be returned. All fields can be used in the filter.
  • order_by (::String) — Field to sort by.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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

#list_custom_target_types

def list_custom_target_types(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::CustomTargetType>
def list_custom_target_types(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::CustomTargetType>

Lists CustomTargetTypes in a given project and location.

Overloads 
def list_custom_target_types(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::CustomTargetType>
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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_custom_target_types(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::CustomTargetType>
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) — Required. The parent that owns this collection of custom target types. Format must be projects/{project_id}/locations/{location_name}.
  • page_size (::Integer) — 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) — 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) — Optional. Filter custom target types 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
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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

#list_delivery_pipelines

def list_delivery_pipelines(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::DeliveryPipeline>
def list_delivery_pipelines(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::DeliveryPipeline>

Lists DeliveryPipelines in a given project and location.

Overloads 
def list_delivery_pipelines(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::DeliveryPipeline>
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) -> ::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::DeliveryPipeline>
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
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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_deploy_policies

def list_deploy_policies(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::DeployPolicy>
def list_deploy_policies(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::DeployPolicy>

Lists DeployPolicies in a given project and location.

Overloads 
def list_deploy_policies(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::DeployPolicy>
Pass arguments to list_deploy_policies via a request object, either of type ListDeployPoliciesRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Deploy::V1::ListDeployPoliciesRequest, ::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_deploy_policies(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::DeployPolicy>
Pass arguments to list_deploy_policies 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 deploy policies. Format must be projects/{project_id}/locations/{location_name}.
  • page_size (::Integer) — The maximum number of deploy policies to return. The service may return fewer than this value. If unspecified, at most 50 deploy policies 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 ListDeployPolicies 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 deploy policies to be returned. See https://google.aip.dev/160 for more details. All fields can be used in the filter.
  • order_by (::String) — Field to sort by. See https://google.aip.dev/132#ordering for more details.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC 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::Client.new

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

# Call the list_deploy_policies method.
result = client.list_deploy_policies 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::DeployPolicy.
  p item
end

#list_job_runs

def list_job_runs(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::JobRun>
def list_job_runs(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::JobRun>

Lists JobRuns in a given project and location.

Overloads 
def list_job_runs(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::JobRun>
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) -> ::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::JobRun>
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
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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) -> ::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::Release>
def list_releases(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::Release>

Lists Releases in a given project and location.

Overloads 
def list_releases(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::Release>
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) -> ::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::Release>
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
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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) -> ::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::Rollout>
def list_rollouts(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::Rollout>

Lists Rollouts in a given project and location.

Overloads 
def list_rollouts(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::Rollout>
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) -> ::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::Rollout>
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
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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) -> ::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::Target>
def list_targets(parent: nil, page_size: nil, page_token: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::Target>

Lists Targets in a given project and location.

Overloads 
def list_targets(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::Target>
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) -> ::Gapic::PagedEnumerable<::Google::Cloud::Deploy::V1::Target>
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
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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::Client

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

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

#operations_client

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

Get the associated client for long-running operations.

Returns

#retry_job

def retry_job(request, options = nil) -> ::Google::Cloud::Deploy::V1::RetryJobResponse
def retry_job(rollout: nil, phase_id: nil, job_id: nil, override_deploy_policy: 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, override_deploy_policy: 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.
  • override_deploy_policy (::Array<::String>) — Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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

#rollback_target

def rollback_target(request, options = nil) -> ::Google::Cloud::Deploy::V1::RollbackTargetResponse
def rollback_target(name: nil, target_id: nil, rollout_id: nil, release_id: nil, rollout_to_roll_back: nil, rollback_config: nil, validate_only: nil, override_deploy_policy: nil) -> ::Google::Cloud::Deploy::V1::RollbackTargetResponse

Creates a Rollout to roll back the specified target.

Overloads 
def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def rollback_target(name: nil, target_id: nil, rollout_id: nil, release_id: nil, rollout_to_roll_back: nil, rollback_config: nil, validate_only: nil, override_deploy_policy: 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) — Required. The DeliveryPipeline for which the rollback Rollout must be created. The format is projects/{project_id}/locations/{location_name}/deliveryPipelines/{pipeline_name}.
  • target_id (::String) — Required. ID of the Target that is being rolled back.
  • rollout_id (::String) — Required. ID of the rollback Rollout to create.
  • release_id (::String) — 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) — Optional. If provided, this must be the latest Rollout that is on the Target.
  • rollback_config (::Google::Cloud::Deploy::V1::RollbackTargetConfig, ::Hash) — Optional. Configs for the rollback Rollout.
  • validate_only (::Boolean) — Optional. If set to true, the request is validated and the user is provided with a RollbackTargetResponse.
  • override_deploy_policy (::Array<::String>) — Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deploy_policy}.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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

#terminate_job_run

def terminate_job_run(request, options = nil) -> ::Google::Cloud::Deploy::V1::TerminateJobRunResponse
def terminate_job_run(name: nil, override_deploy_policy: 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, override_deploy_policy: 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) — Required. Name of the JobRun. Format must be projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}/jobRuns/{jobRun}.
  • override_deploy_policy (::Array<::String>) — Optional. Deploy policies to override. Format is projects/{project}/locations/{location}/deployPolicies/{deployPolicy}.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_automation

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

Overloads 
def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def 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) — Required. Field mask is used to specify the fields to be overwritten by the update in the Automation resource. 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) — Required. The Automation 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 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) — Optional. If set to true, updating a Automation that does not exist will result in the creation of a new Automation.
  • 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
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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

#update_custom_target_type

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

Overloads 
def 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) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def 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) — Required. Field mask is used to specify the fields to be overwritten by the update in the CustomTargetType resource. 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) — Required. The CustomTargetType 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 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) — Optional. If set to true, updating a CustomTargetType that does not exist will result in the creation of a new CustomTargetType.
  • 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
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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

#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 by the update in the DeliveryPipeline resource. 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) — 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 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) — 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
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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_deploy_policy

def update_deploy_policy(request, options = nil) -> ::Gapic::Operation
def update_deploy_policy(update_mask: nil, deploy_policy: nil, request_id: nil, allow_missing: nil, validate_only: nil) -> ::Gapic::Operation

Updates the parameters of a single DeployPolicy.

Overloads 
def update_deploy_policy(request, options = nil) -> ::Gapic::Operation
Pass arguments to update_deploy_policy via a request object, either of type UpdateDeployPolicyRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Deploy::V1::UpdateDeployPolicyRequest, ::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_deploy_policy(update_mask: nil, deploy_policy: nil, request_id: nil, allow_missing: nil, validate_only: nil) -> ::Gapic::Operation
Pass arguments to update_deploy_policy 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 by the update in the DeployPolicy resource. 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.
  • deploy_policy (::Google::Cloud::Deploy::V1::DeployPolicy, ::Hash) — Required. The DeployPolicy 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 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) — Optional. If set to true, updating a DeployPolicy that does not exist will result in the creation of a new DeployPolicy.
  • 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
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC 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::Client.new

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

# Call the update_deploy_policy method.
result = client.update_deploy_policy 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 by the update in the Target resource. 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) — 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 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) — 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
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)
Returns
  • (::Gapic::Operation)
Raises
  • (::Google::Cloud::Error) — if the RPC 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::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