Class: Google::Apis::ClouddeployV1::CloudDeployService

Inherits:

Google::Apis::Core::BaseService

Object
Google::Apis::Core::BaseService
Google::Apis::ClouddeployV1::CloudDeployService

show all

Defined in:: lib/google/apis/clouddeploy_v1/service.rb

Overview

Google Cloud Deploy API

Examples:

require 'google/apis/clouddeploy_v1'

Clouddeploy = Google::Apis::ClouddeployV1 # Alias the module
service = Clouddeploy::CloudDeployService.new

Instance Attribute Summary collapse

#key ⇒ String
API key.
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.

Instance Method Summary collapse

#abandon_release(name, abandon_release_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::AbandonReleaseResponse
Abandons a Release in the Delivery Pipeline.
#advance_rollout(name, advance_rollout_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::AdvanceRolloutResponse
Advances a Rollout in a given project and location.
#approve_rollout(name, approve_rollout_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::ApproveRolloutResponse
Approves a Rollout.
#cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Empty
Starts asynchronous cancellation on a long-running operation.
#cancel_rollout(name, cancel_rollout_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::CancelRolloutResponse
Cancels a Rollout in a given project and location.
#create_project_location_delivery_pipeline(parent, delivery_pipeline_object = nil, delivery_pipeline_id: nil, request_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Operation
Creates a new DeliveryPipeline in a given project and location.
#create_project_location_delivery_pipeline_release(parent, release_object = nil, release_id: nil, request_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Operation
Creates a new Release in a given project and location.
#create_project_location_delivery_pipeline_release_rollout(parent, rollout_object = nil, request_id: nil, rollout_id: nil, starting_phase_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Operation
Creates a new Rollout in a given project and location.
#create_project_location_target(parent, target_object = nil, request_id: nil, target_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Operation
Creates a new Target in a given project and location.
#delete_project_location_delivery_pipeline(name, allow_missing: nil, etag: nil, force: nil, request_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Operation
Deletes a single DeliveryPipeline.
#delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Empty
Deletes a long-running operation.
#delete_project_location_target(name, allow_missing: nil, etag: nil, request_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Operation
Deletes a single Target.
#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Location
Gets information about a location.
#get_project_location_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Config
Gets the configuration for a location.
#get_project_location_delivery_pipeline(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::DeliveryPipeline
Gets details of a single DeliveryPipeline.
#get_project_location_delivery_pipeline_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Policy
Gets the access control policy for a resource.
#get_project_location_delivery_pipeline_release(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Release
Gets details of a single Release.
#get_project_location_delivery_pipeline_release_rollout(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Rollout
Gets details of a single Rollout.
#get_project_location_delivery_pipeline_release_rollout_job_run(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::JobRun
Gets details of a single JobRun.
#get_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Operation
Gets the latest state of a long-running operation.
#get_project_location_target(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Target
Gets details of a single Target.
#get_project_location_target_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Policy
Gets the access control policy for a resource.
#ignore_rollout_job(rollout, ignore_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::IgnoreJobResponse
Ignores the specified Job in a Rollout.
#initialize ⇒ CloudDeployService constructor
A new instance of CloudDeployService.
#list_project_location_delivery_pipeline_release_rollout_job_runs(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::ListJobRunsResponse
Lists JobRuns in a given project and location.
#list_project_location_delivery_pipeline_release_rollouts(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::ListRolloutsResponse
Lists Rollouts in a given project and location.
#list_project_location_delivery_pipeline_releases(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::ListReleasesResponse
Lists Releases in a given project and location.
#list_project_location_delivery_pipelines(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::ListDeliveryPipelinesResponse
Lists DeliveryPipelines in a given project and location.
#list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::ListOperationsResponse
Lists operations that match the specified filter in the request.
#list_project_location_targets(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::ListTargetsResponse
Lists Targets in a given project and location.
#list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::ListLocationsResponse
Lists information about the supported locations for this service.
#patch_project_location_delivery_pipeline(name, delivery_pipeline_object = nil, allow_missing: nil, request_id: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Operation
Updates the parameters of a single DeliveryPipeline.
#patch_project_location_target(name, target_object = nil, allow_missing: nil, request_id: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Operation
Updates the parameters of a single Target.
#retry_rollout_job(rollout, retry_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::RetryJobResponse
Retries the specified Job in a Rollout.
#set_delivery_pipeline_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Policy
Sets the access control policy on the specified resource.
#set_target_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Policy
Sets the access control policy on the specified resource.
#terminate_job_run(name, terminate_job_run_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::TerminateJobRunResponse
Terminates a Job Run in a given project and location.
#test_delivery_pipeline_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::TestIamPermissionsResponse
Returns permissions that a caller has on the specified resource.
#test_target_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::TestIamPermissionsResponse
Returns permissions that a caller has on the specified resource.

Constructor Details

#initialize ⇒ `CloudDeployService`

Returns a new instance of CloudDeployService.

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 45

def initialize
  super('https://clouddeploy.googleapis.com/', '',
        client_name: 'google-apis-clouddeploy_v1',
        client_version: Google::Apis::ClouddeployV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ `String`

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

(String) —
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



38
39
40

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 38

def key
  @key
end

#quota_user ⇒ `String`

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

(String) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



43
44
45

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 43

def quota_user
  @quota_user
end

Instance Method Details

#abandon_release(name, abandon_release_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::AbandonReleaseResponse`

Abandons a Release in the Delivery Pipeline.

Parameters:

name (String) —
Required. Name of the Release. Format is projects/project/locations/location/deliveryPipelines/deliveryPipeline/ releases/release.
abandon_release_request_object (Google::Apis::ClouddeployV1::AbandonReleaseRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::AbandonReleaseResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::AbandonReleaseResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 553

def abandon_release(name, abandon_release_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:abandon', options)
  command.request_representation = Google::Apis::ClouddeployV1::AbandonReleaseRequest::Representation
  command.request_object = abandon_release_request_object
  command.response_representation = Google::Apis::ClouddeployV1::AbandonReleaseResponse::Representation
  command.response_class = Google::Apis::ClouddeployV1::AbandonReleaseResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#advance_rollout(name, advance_rollout_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::AdvanceRolloutResponse`

Advances a Rollout in a given project and location.

Parameters:

name (String) —
Required. Name of the Rollout. Format is projects/project/locations/location/deliveryPipelines/deliveryPipeline/ releases/release/rollouts/rollout.
advance_rollout_request_object (Google::Apis::ClouddeployV1::AdvanceRolloutRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::AdvanceRolloutResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::AdvanceRolloutResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 724

def advance_rollout(name, advance_rollout_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:advance', options)
  command.request_representation = Google::Apis::ClouddeployV1::AdvanceRolloutRequest::Representation
  command.request_object = advance_rollout_request_object
  command.response_representation = Google::Apis::ClouddeployV1::AdvanceRolloutResponse::Representation
  command.response_class = Google::Apis::ClouddeployV1::AdvanceRolloutResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#approve_rollout(name, approve_rollout_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::ApproveRolloutResponse`

Approves a Rollout.

Parameters:

name (String) —
Required. Name of the Rollout. Format is projects/project/locations/location/deliveryPipelines/deliveryPipeline/ releases/release/rollouts/rollout.
approve_rollout_request_object (Google::Apis::ClouddeployV1::ApproveRolloutRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::ApproveRolloutResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::ApproveRolloutResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 759

def approve_rollout(name, approve_rollout_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:approve', options)
  command.request_representation = Google::Apis::ClouddeployV1::ApproveRolloutRequest::Representation
  command.request_object = approve_rollout_request_object
  command.response_representation = Google::Apis::ClouddeployV1::ApproveRolloutResponse::Representation
  command.response_class = Google::Apis::ClouddeployV1::ApproveRolloutResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Empty`

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Parameters:

name (String) —
The name of the operation resource to be cancelled.
cancel_operation_request_object (Google::Apis::ClouddeployV1::CancelOperationRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::Empty) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::Empty)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 1158

def cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.request_representation = Google::Apis::ClouddeployV1::CancelOperationRequest::Representation
  command.request_object = cancel_operation_request_object
  command.response_representation = Google::Apis::ClouddeployV1::Empty::Representation
  command.response_class = Google::Apis::ClouddeployV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_rollout(name, cancel_rollout_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::CancelRolloutResponse`

Cancels a Rollout in a given project and location.

Parameters:

name (String) —
Required. Name of the Rollout. Format is projects/project/locations/location/deliveryPipelines/deliveryPipeline/ releases/release/rollouts/rollout.
cancel_rollout_request_object (Google::Apis::ClouddeployV1::CancelRolloutRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::CancelRolloutResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::CancelRolloutResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 794

def cancel_rollout(name, cancel_rollout_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.request_representation = Google::Apis::ClouddeployV1::CancelRolloutRequest::Representation
  command.request_object = cancel_rollout_request_object
  command.response_representation = Google::Apis::ClouddeployV1::CancelRolloutResponse::Representation
  command.response_class = Google::Apis::ClouddeployV1::CancelRolloutResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_delivery_pipeline(parent, delivery_pipeline_object = nil, delivery_pipeline_id: nil, request_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Operation`

Creates a new DeliveryPipeline in a given project and location.

Parameters:

parent (String) —
Required. The parent collection in which the DeliveryPipeline should be created. Format should be projects/project_id/locations/location_name.
delivery_pipeline_object (Google::Apis::ClouddeployV1::DeliveryPipeline) (defaults to: nil)
delivery_pipeline_id (String) (defaults to: nil) —
Required. ID of the DeliveryPipeline.
request_id (String) (defaults to: nil) —
Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
validate_only (Boolean) (defaults to: nil) —
Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::Operation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::Operation)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 193

def create_project_location_delivery_pipeline(parent, delivery_pipeline_object = nil, delivery_pipeline_id: nil, request_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/deliveryPipelines', options)
  command.request_representation = Google::Apis::ClouddeployV1::DeliveryPipeline::Representation
  command.request_object = delivery_pipeline_object
  command.response_representation = Google::Apis::ClouddeployV1::Operation::Representation
  command.response_class = Google::Apis::ClouddeployV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['deliveryPipelineId'] = delivery_pipeline_id unless delivery_pipeline_id.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_delivery_pipeline_release(parent, release_object = nil, release_id: nil, request_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Operation`

Creates a new Release in a given project and location.

Parameters:

parent (String) —
Required. The parent collection in which the Release should be created. Format should be projects/project_id/locations/location_name/ deliveryPipelines/pipeline_name.
release_object (Google::Apis::ClouddeployV1::Release) (defaults to: nil)
release_id (String) (defaults to: nil) —
Required. ID of the Release.
request_id (String) (defaults to: nil) —
Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
validate_only (Boolean) (defaults to: nil) —
Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::Operation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::Operation)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 604

def create_project_location_delivery_pipeline_release(parent, release_object = nil, release_id: nil, request_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/releases', options)
  command.request_representation = Google::Apis::ClouddeployV1::Release::Representation
  command.request_object = release_object
  command.response_representation = Google::Apis::ClouddeployV1::Operation::Representation
  command.response_class = Google::Apis::ClouddeployV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['releaseId'] = release_id unless release_id.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_delivery_pipeline_release_rollout(parent, rollout_object = nil, request_id: nil, rollout_id: nil, starting_phase_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Operation`

Creates a new Rollout in a given project and location.

Parameters:

parent (String) —
Required. The parent collection in which the Rollout should be created. Format should be projects/project_id/locations/location_name/ deliveryPipelines/pipeline_name/releases/release_name.
rollout_object (Google::Apis::ClouddeployV1::Rollout) (defaults to: nil)
request_id (String) (defaults to: nil) —
Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
rollout_id (String) (defaults to: nil) —
Required. ID of the Rollout.
starting_phase_id (String) (defaults to: nil) —
Optional. The starting phase ID for the Rollout. If empty the Rollout will start at the first phase.
validate_only (Boolean) (defaults to: nil) —
Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::Operation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::Operation)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 848

def create_project_location_delivery_pipeline_release_rollout(parent, rollout_object = nil, request_id: nil, rollout_id: nil, starting_phase_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/rollouts', options)
  command.request_representation = Google::Apis::ClouddeployV1::Rollout::Representation
  command.request_object = rollout_object
  command.response_representation = Google::Apis::ClouddeployV1::Operation::Representation
  command.response_class = Google::Apis::ClouddeployV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['rolloutId'] = rollout_id unless rollout_id.nil?
  command.query['startingPhaseId'] = starting_phase_id unless starting_phase_id.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_target(parent, target_object = nil, request_id: nil, target_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Operation`

Creates a new Target in a given project and location.

Parameters:

parent (String) —
Required. The parent collection in which the Target should be created. Format should be projects/project_id/locations/location_name.
target_object (Google::Apis::ClouddeployV1::Target) (defaults to: nil)
request_id (String) (defaults to: nil) —
Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
target_id (String) (defaults to: nil) —
Required. ID of the Target.
validate_only (Boolean) (defaults to: nil) —
Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::Operation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::Operation)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 1312

def create_project_location_target(parent, target_object = nil, request_id: nil, target_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/targets', options)
  command.request_representation = Google::Apis::ClouddeployV1::Target::Representation
  command.request_object = target_object
  command.response_representation = Google::Apis::ClouddeployV1::Operation::Representation
  command.response_class = Google::Apis::ClouddeployV1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['targetId'] = target_id unless target_id.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_delivery_pipeline(name, allow_missing: nil, etag: nil, force: nil, request_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Operation`

Deletes a single DeliveryPipeline.

Parameters:

name (String) —
Required. The name of the DeliveryPipeline to delete. Format should be projects/project_id/locations/location_name/deliveryPipelines/pipeline_name.
allow_missing (Boolean) (defaults to: nil) —
Optional. If set to true, then deleting an already deleted or non-existing DeliveryPipeline will succeed.
etag (String) (defaults to: nil) —
Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
force (Boolean) (defaults to: nil) —
Optional. If set to true, all child resources under this pipeline will also be deleted. Otherwise, the request will only work if the pipeline has no child resources.
request_id (String) (defaults to: nil) —
Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
validate_only (Boolean) (defaults to: nil) —
Optional. If set, validate the request and preview the review, but do not actually post it.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::Operation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::Operation)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 255

def delete_project_location_delivery_pipeline(name, allow_missing: nil, etag: nil, force: nil, request_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ClouddeployV1::Operation::Representation
  command.response_class = Google::Apis::ClouddeployV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['etag'] = etag unless etag.nil?
  command.query['force'] = force unless force.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Empty`

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code. UNIMPLEMENTED.

Parameters:

name (String) —
The name of the operation resource to be deleted.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::Empty) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::Empty)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 1193

def delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ClouddeployV1::Empty::Representation
  command.response_class = Google::Apis::ClouddeployV1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_location_target(name, allow_missing: nil, etag: nil, request_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Operation`

Deletes a single Target.

Parameters:

name (String) —
Required. The name of the Target to delete. Format should be projects/project_id/locations/location_name/targets/target_name.
allow_missing (Boolean) (defaults to: nil) —
Optional. If set to true, then deleting an already deleted or non-existing DeliveryPipeline will succeed.
etag (String) (defaults to: nil) —
Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
request_id (String) (defaults to: nil) —
Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
validate_only (Boolean) (defaults to: nil) —
Optional. If set, validate the request and preview the review, but do not actually post it.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::Operation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::Operation)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 1369

def delete_project_location_target(name, allow_missing: nil, etag: nil, request_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ClouddeployV1::Operation::Representation
  command.response_class = Google::Apis::ClouddeployV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['etag'] = etag unless etag.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Location`

Gets information about a location.

Parameters:

name (String) —
Resource name for the location.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::Location) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::Location)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 72

def get_project_location(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ClouddeployV1::Location::Representation
  command.response_class = Google::Apis::ClouddeployV1::Location
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Config`

Gets the configuration for a location.

Parameters:

name (String) —
Required. Name of requested configuration.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::Config) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::Config)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 102

def get_project_location_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ClouddeployV1::Config::Representation
  command.response_class = Google::Apis::ClouddeployV1::Config
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_delivery_pipeline(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::DeliveryPipeline`

Gets details of a single DeliveryPipeline.

Parameters:

name (String) —
Required. Name of the DeliveryPipeline. Format must be projects/project_id/ locations/location_name/deliveryPipelines/pipeline_name.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::DeliveryPipeline) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::DeliveryPipeline)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 291

def get_project_location_delivery_pipeline(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ClouddeployV1::DeliveryPipeline::Representation
  command.response_class = Google::Apis::ClouddeployV1::DeliveryPipeline
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_delivery_pipeline_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Policy`

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

resource (String) —
REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.
options_requested_policy_version (Fixnum) (defaults to: nil) —
Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::Policy) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::Policy)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 335

def get_project_location_delivery_pipeline_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::ClouddeployV1::Policy::Representation
  command.response_class = Google::Apis::ClouddeployV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_delivery_pipeline_release(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Release`

Gets details of a single Release.

Parameters:

name (String) —
Required. Name of the Release. Format must be projects/project_id/ locations/location_name/deliveryPipelines/pipeline_name/releases/release_name.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::Release) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::Release)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 641

def get_project_location_delivery_pipeline_release(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ClouddeployV1::Release::Representation
  command.response_class = Google::Apis::ClouddeployV1::Release
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_delivery_pipeline_release_rollout(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Rollout`

Gets details of a single Rollout.

Parameters:

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.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::Rollout) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::Rollout)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 886

def get_project_location_delivery_pipeline_release_rollout(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ClouddeployV1::Rollout::Representation
  command.response_class = Google::Apis::ClouddeployV1::Rollout
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_delivery_pipeline_release_rollout_job_run(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::JobRun`

Gets details of a single JobRun.

Parameters:

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.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::JobRun) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::JobRun)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 1037

def get_project_location_delivery_pipeline_release_rollout_job_run(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ClouddeployV1::JobRun::Representation
  command.response_class = Google::Apis::ClouddeployV1::JobRun
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Operation`

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

name (String) —
The name of the operation resource.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::Operation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::Operation)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 1224

def get_project_location_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ClouddeployV1::Operation::Representation
  command.response_class = Google::Apis::ClouddeployV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_target(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Target`

Gets details of a single Target.

Parameters:

name (String) —
Required. Name of the Target. Format must be projects/project_id/locations/ location_name/targets/target_name.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::Target) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::Target)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 1404

def get_project_location_target(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::ClouddeployV1::Target::Representation
  command.response_class = Google::Apis::ClouddeployV1::Target
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_target_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Policy`

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Parameters:

resource (String) —
REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.
options_requested_policy_version (Fixnum) (defaults to: nil) —
Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::Policy) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::Policy)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 1448

def get_project_location_target_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+resource}:getIamPolicy', options)
  command.response_representation = Google::Apis::ClouddeployV1::Policy::Representation
  command.response_class = Google::Apis::ClouddeployV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#ignore_rollout_job(rollout, ignore_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::IgnoreJobResponse`

Ignores the specified Job in a Rollout.

Parameters:

rollout (String) —
Required. Name of the Rollout. Format is projects/project/locations/location/deliveryPipelines/deliveryPipeline/ releases/release/rollouts/rollout.
ignore_job_request_object (Google::Apis::ClouddeployV1::IgnoreJobRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::IgnoreJobResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::IgnoreJobResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 919

def ignore_rollout_job(rollout, ignore_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+rollout}:ignoreJob', options)
  command.request_representation = Google::Apis::ClouddeployV1::IgnoreJobRequest::Representation
  command.request_object = ignore_job_request_object
  command.response_representation = Google::Apis::ClouddeployV1::IgnoreJobResponse::Representation
  command.response_class = Google::Apis::ClouddeployV1::IgnoreJobResponse
  command.params['rollout'] = rollout unless rollout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_delivery_pipeline_release_rollout_job_runs(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::ListJobRunsResponse`

Lists JobRuns in a given project and location.

Parameters:

parent (String) —
Required. The Rollout which owns this collection of JobRun objects.
filter (String) (defaults to: nil) —
Optional. Filter results to be returned. See https://google.aip.dev/160 for more details.
order_by (String) (defaults to: nil) —
Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.
page_size (Fixnum) (defaults to: nil) —
Optional. The maximum number of JobRun objects to return. The service may return fewer than this value. If unspecified, at most 50 JobRun objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000.
page_token (String) (defaults to: nil) —
Optional. A page token, received from a previous ListJobRuns call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters match the call that provided the page token.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::ListJobRunsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::ListJobRunsResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 1081

def list_project_location_delivery_pipeline_release_rollout_job_runs(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/jobRuns', options)
  command.response_representation = Google::Apis::ClouddeployV1::ListJobRunsResponse::Representation
  command.response_class = Google::Apis::ClouddeployV1::ListJobRunsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_delivery_pipeline_release_rollouts(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::ListRolloutsResponse`

Lists Rollouts in a given project and location.

Parameters:

parent (String) —
Required. The Release which owns this collection of Rollout objects.
filter (String) (defaults to: nil) —
Optional. Filter rollouts to be returned. See https://google.aip.dev/160 for more details.
order_by (String) (defaults to: nil) —
Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.
page_size (Fixnum) (defaults to: nil) —
Optional. The maximum number of Rollout objects to return. The service may return fewer than this value. If unspecified, at most 50 Rollout objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000.
page_token (String) (defaults to: nil) —
Optional. A page token, received from a previous ListRollouts call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters match the call that provided the page token.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::ListRolloutsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::ListRolloutsResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 966

def list_project_location_delivery_pipeline_release_rollouts(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/rollouts', options)
  command.response_representation = Google::Apis::ClouddeployV1::ListRolloutsResponse::Representation
  command.response_class = Google::Apis::ClouddeployV1::ListRolloutsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_delivery_pipeline_releases(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::ListReleasesResponse`

Lists Releases in a given project and location.

Parameters:

parent (String) —
Required. The DeliveryPipeline which owns this collection of Release objects.
filter (String) (defaults to: nil) —
Optional. Filter releases to be returned. See https://google.aip.dev/160 for more details.
order_by (String) (defaults to: nil) —
Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.
page_size (Fixnum) (defaults to: nil) —
Optional. The maximum number of Release objects to return. The service may return fewer than this value. If unspecified, at most 50 Release objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000.
page_token (String) (defaults to: nil) —
Optional. A page token, received from a previous ListReleases call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters match the call that provided the page token.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::ListReleasesResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::ListReleasesResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 687

def list_project_location_delivery_pipeline_releases(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/releases', options)
  command.response_representation = Google::Apis::ClouddeployV1::ListReleasesResponse::Representation
  command.response_class = Google::Apis::ClouddeployV1::ListReleasesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_delivery_pipelines(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::ListDeliveryPipelinesResponse`

Lists DeliveryPipelines in a given project and location.

Parameters:

parent (String) —
Required. The parent, which owns this collection of pipelines. Format must be projects/project_id/locations/location_name.
filter (String) (defaults to: nil) —
Filter pipelines to be returned. See https://google.aip.dev/160 for more details.
order_by (String) (defaults to: nil) —
Field to sort by. See https://google.aip.dev/132#ordering for more details.
page_size (Fixnum) (defaults to: nil) —
The maximum number of pipelines to return. The service may return fewer than this value. If unspecified, at most 50 pipelines will be returned. The maximum value is 1000; values above 1000 will be set to 1000.
page_token (String) (defaults to: nil) —
A page token, received from a previous ListDeliveryPipelines call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters match the call that provided the page token.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::ListDeliveryPipelinesResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::ListDeliveryPipelinesResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 380

def list_project_location_delivery_pipelines(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/deliveryPipelines', options)
  command.response_representation = Google::Apis::ClouddeployV1::ListDeliveryPipelinesResponse::Representation
  command.response_class = Google::Apis::ClouddeployV1::ListDeliveryPipelinesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::ListOperationsResponse`

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

Parameters:

name (String) —
The name of the operation's parent resource.
filter (String) (defaults to: nil) —
The standard list filter.
page_size (Fixnum) (defaults to: nil) —
The standard list page size.
page_token (String) (defaults to: nil) —
The standard list page token.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::ListOperationsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::ListOperationsResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 1261

def list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/operations', options)
  command.response_representation = Google::Apis::ClouddeployV1::ListOperationsResponse::Representation
  command.response_class = Google::Apis::ClouddeployV1::ListOperationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_targets(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::ListTargetsResponse`

Lists Targets in a given project and location.

Parameters:

parent (String) —
Required. The parent, which owns this collection of targets. Format must be projects/project_id/locations/location_name.
filter (String) (defaults to: nil) —
Optional. Filter targets to be returned. See https://google.aip.dev/160 for more details.
order_by (String) (defaults to: nil) —
Optional. Field to sort by. See https://google.aip.dev/132#ordering for more details.
page_size (Fixnum) (defaults to: nil) —
Optional. The maximum number of Target objects to return. The service may return fewer than this value. If unspecified, at most 50 Target objects will be returned. The maximum value is 1000; values above 1000 will be set to 1000.
page_token (String) (defaults to: nil) —
Optional. A page token, received from a previous ListTargets call. Provide this to retrieve the subsequent page. When paginating, all other provided parameters match the call that provided the page token.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::ListTargetsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::ListTargetsResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 1494

def list_project_location_targets(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/targets', options)
  command.response_representation = Google::Apis::ClouddeployV1::ListTargetsResponse::Representation
  command.response_class = Google::Apis::ClouddeployV1::ListTargetsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::ListLocationsResponse`

Lists information about the supported locations for this service.

Parameters:

name (String) —
The resource that owns the locations collection, if applicable.
filter (String) (defaults to: nil) —
A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160.
page_size (Fixnum) (defaults to: nil) —
The maximum number of results to return. If not set, the service selects a default.
page_token (String) (defaults to: nil) —
A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::ListLocationsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::ListLocationsResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 142

def list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}/locations', options)
  command.response_representation = Google::Apis::ClouddeployV1::ListLocationsResponse::Representation
  command.response_class = Google::Apis::ClouddeployV1::ListLocationsResponse
  command.params['name'] = name unless name.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_delivery_pipeline(name, delivery_pipeline_object = nil, allow_missing: nil, request_id: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Operation`

Updates the parameters of a single DeliveryPipeline.

Parameters:

name (String) —
Optional. Name of the DeliveryPipeline. Format is projects/project/ locations/location/deliveryPipelines/a-z0,62.
delivery_pipeline_object (Google::Apis::ClouddeployV1::DeliveryPipeline) (defaults to: nil)
allow_missing (Boolean) (defaults to: nil) —
Optional. If set to true, updating a DeliveryPipeline that does not exist will result in the creation of a new DeliveryPipeline.
request_id (String) (defaults to: nil) —
Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
update_mask (String) (defaults to: nil) —
Required. Field mask is used to specify the fields to be overwritten in the DeliveryPipeline resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
validate_only (Boolean) (defaults to: nil) —
Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::Operation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::Operation)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 439

def patch_project_location_delivery_pipeline(name, delivery_pipeline_object = nil, allow_missing: nil, request_id: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ClouddeployV1::DeliveryPipeline::Representation
  command.request_object = delivery_pipeline_object
  command.response_representation = Google::Apis::ClouddeployV1::Operation::Representation
  command.response_class = Google::Apis::ClouddeployV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_location_target(name, target_object = nil, allow_missing: nil, request_id: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Operation`

Updates the parameters of a single Target.

Parameters:

name (String) —
Optional. Name of the Target. Format is projects/project/locations/location/targets/a-z0,62.
target_object (Google::Apis::ClouddeployV1::Target) (defaults to: nil)
allow_missing (Boolean) (defaults to: nil) —
Optional. If set to true, updating a Target that does not exist will result in the creation of a new Target.
request_id (String) (defaults to: nil) —
Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
update_mask (String) (defaults to: nil) —
Required. Field mask is used to specify the fields to be overwritten in the Target resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.
validate_only (Boolean) (defaults to: nil) —
Optional. If set to true, the request is validated and the user is provided with an expected result, but no actual change is made.
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::Operation) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::Operation)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 1553

def patch_project_location_target(name, target_object = nil, allow_missing: nil, request_id: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1/{+name}', options)
  command.request_representation = Google::Apis::ClouddeployV1::Target::Representation
  command.request_object = target_object
  command.response_representation = Google::Apis::ClouddeployV1::Operation::Representation
  command.response_class = Google::Apis::ClouddeployV1::Operation
  command.params['name'] = name unless name.nil?
  command.query['allowMissing'] = allow_missing unless allow_missing.nil?
  command.query['requestId'] = request_id unless request_id.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['validateOnly'] = validate_only unless validate_only.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#retry_rollout_job(rollout, retry_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::RetryJobResponse`

Retries the specified Job in a Rollout.

Parameters:

rollout (String) —
Required. Name of the Rollout. Format is projects/project/locations/location/deliveryPipelines/deliveryPipeline/ releases/release/rollouts/rollout.
retry_job_request_object (Google::Apis::ClouddeployV1::RetryJobRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::RetryJobResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::RetryJobResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 1003

def retry_rollout_job(rollout, retry_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+rollout}:retryJob', options)
  command.request_representation = Google::Apis::ClouddeployV1::RetryJobRequest::Representation
  command.request_object = retry_job_request_object
  command.response_representation = Google::Apis::ClouddeployV1::RetryJobResponse::Representation
  command.response_class = Google::Apis::ClouddeployV1::RetryJobResponse
  command.params['rollout'] = rollout unless rollout.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_delivery_pipeline_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Policy`

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters:

resource (String) —
REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.
set_iam_policy_request_object (Google::Apis::ClouddeployV1::SetIamPolicyRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::Policy) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::Policy)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 480

def set_delivery_pipeline_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::ClouddeployV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::ClouddeployV1::Policy::Representation
  command.response_class = Google::Apis::ClouddeployV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#set_target_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Policy`

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

Parameters:

resource (String) —
REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.
set_iam_policy_request_object (Google::Apis::ClouddeployV1::SetIamPolicyRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::Policy) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::Policy)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 1594

def set_target_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:setIamPolicy', options)
  command.request_representation = Google::Apis::ClouddeployV1::SetIamPolicyRequest::Representation
  command.request_object = set_iam_policy_request_object
  command.response_representation = Google::Apis::ClouddeployV1::Policy::Representation
  command.response_class = Google::Apis::ClouddeployV1::Policy
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#terminate_job_run(name, terminate_job_run_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::TerminateJobRunResponse`

Terminates a Job Run in a given project and location.

Parameters:

name (String) —
Required. Name of the JobRun. Format must be projects/project/locations/location/deliveryPipelines/deliveryPipeline/ releases/release/rollouts/rollout/jobRuns/jobRun.
terminate_job_run_request_object (Google::Apis::ClouddeployV1::TerminateJobRunRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::TerminateJobRunResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::TerminateJobRunResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 1118

def terminate_job_run(name, terminate_job_run_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:terminate', options)
  command.request_representation = Google::Apis::ClouddeployV1::TerminateJobRunRequest::Representation
  command.request_object = terminate_job_run_request_object
  command.response_representation = Google::Apis::ClouddeployV1::TerminateJobRunResponse::Representation
  command.response_class = Google::Apis::ClouddeployV1::TerminateJobRunResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_delivery_pipeline_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::TestIamPermissionsResponse`

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Parameters:

resource (String) —
REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.
test_iam_permissions_request_object (Google::Apis::ClouddeployV1::TestIamPermissionsRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::TestIamPermissionsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::TestIamPermissionsResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 519

def test_delivery_pipeline_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::ClouddeployV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::ClouddeployV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::ClouddeployV1::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#test_target_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::TestIamPermissionsResponse`

Parameters:

resource (String) —
REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.
test_iam_permissions_request_object (Google::Apis::ClouddeployV1::TestIamPermissionsRequest) (defaults to: nil)
fields (String) (defaults to: nil) —
Selector specifying which fields to include in a partial response.
quota_user (String) (defaults to: nil) —
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
options (Google::Apis::RequestOptions) (defaults to: nil) —
Request-specific options

Yields:

(result, err) —
Result & error if block supplied

Yield Parameters:

result (Google::Apis::ClouddeployV1::TestIamPermissionsResponse) —
parsed result object
err (StandardError) —
error object if request failed

Returns:

(Google::Apis::ClouddeployV1::TestIamPermissionsResponse)

Raises:

(Google::Apis::ServerError) —
An error occurred on the server and the request can be retried
(Google::Apis::ClientError) —
The request is invalid and should not be retried without modification
(Google::Apis::AuthorizationError) —
Authorization is required

# File 'lib/google/apis/clouddeploy_v1/service.rb', line 1633

def test_target_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+resource}:testIamPermissions', options)
  command.request_representation = Google::Apis::ClouddeployV1::TestIamPermissionsRequest::Representation
  command.request_object = test_iam_permissions_request_object
  command.response_representation = Google::Apis::ClouddeployV1::TestIamPermissionsResponse::Representation
  command.response_class = Google::Apis::ClouddeployV1::TestIamPermissionsResponse
  command.params['resource'] = resource unless resource.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

Class: Google::Apis::ClouddeployV1::CloudDeployService

Overview

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ CloudDeployService

Instance Attribute Details

#key ⇒ String

#quota_user ⇒ String

Instance Method Details

#abandon_release(name, abandon_release_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::AbandonReleaseResponse

#advance_rollout(name, advance_rollout_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::AdvanceRolloutResponse

#approve_rollout(name, approve_rollout_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::ApproveRolloutResponse

#cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Empty

#cancel_rollout(name, cancel_rollout_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::CancelRolloutResponse

#create_project_location_delivery_pipeline(parent, delivery_pipeline_object = nil, delivery_pipeline_id: nil, request_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Operation

#create_project_location_delivery_pipeline_release(parent, release_object = nil, release_id: nil, request_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Operation

#create_project_location_delivery_pipeline_release_rollout(parent, rollout_object = nil, request_id: nil, rollout_id: nil, starting_phase_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Operation

#create_project_location_target(parent, target_object = nil, request_id: nil, target_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Operation

#delete_project_location_delivery_pipeline(name, allow_missing: nil, etag: nil, force: nil, request_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Operation

#delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Empty

#delete_project_location_target(name, allow_missing: nil, etag: nil, request_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Operation

#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Location

#get_project_location_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Config

#get_project_location_delivery_pipeline(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::DeliveryPipeline

#get_project_location_delivery_pipeline_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Policy

#get_project_location_delivery_pipeline_release(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Release

#get_project_location_delivery_pipeline_release_rollout(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Rollout

#get_project_location_delivery_pipeline_release_rollout_job_run(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::JobRun

#get_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Operation

#get_project_location_target(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Target

#get_project_location_target_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Policy

#ignore_rollout_job(rollout, ignore_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::IgnoreJobResponse

#list_project_location_delivery_pipeline_release_rollout_job_runs(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::ListJobRunsResponse

#list_project_location_delivery_pipeline_release_rollouts(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::ListRolloutsResponse

#list_project_location_delivery_pipeline_releases(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::ListReleasesResponse

#list_project_location_delivery_pipelines(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::ListDeliveryPipelinesResponse

#list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::ListOperationsResponse

#list_project_location_targets(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::ListTargetsResponse

#list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::ListLocationsResponse

#patch_project_location_delivery_pipeline(name, delivery_pipeline_object = nil, allow_missing: nil, request_id: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Operation

#patch_project_location_target(name, target_object = nil, allow_missing: nil, request_id: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Operation

#retry_rollout_job(rollout, retry_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::RetryJobResponse

#set_delivery_pipeline_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Policy

#set_target_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::Policy

#terminate_job_run(name, terminate_job_run_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::TerminateJobRunResponse

#test_delivery_pipeline_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::TestIamPermissionsResponse

#test_target_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ClouddeployV1::TestIamPermissionsResponse

#initialize ⇒ `CloudDeployService`

#key ⇒ `String`

#quota_user ⇒ `String`

#abandon_release(name, abandon_release_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::AbandonReleaseResponse`

#advance_rollout(name, advance_rollout_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::AdvanceRolloutResponse`

#approve_rollout(name, approve_rollout_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::ApproveRolloutResponse`

#cancel_operation(name, cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Empty`

#cancel_rollout(name, cancel_rollout_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::CancelRolloutResponse`

#create_project_location_delivery_pipeline(parent, delivery_pipeline_object = nil, delivery_pipeline_id: nil, request_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Operation`

#create_project_location_delivery_pipeline_release(parent, release_object = nil, release_id: nil, request_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Operation`

#create_project_location_delivery_pipeline_release_rollout(parent, rollout_object = nil, request_id: nil, rollout_id: nil, starting_phase_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Operation`

#create_project_location_target(parent, target_object = nil, request_id: nil, target_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Operation`

#delete_project_location_delivery_pipeline(name, allow_missing: nil, etag: nil, force: nil, request_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Operation`

#delete_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Empty`

#delete_project_location_target(name, allow_missing: nil, etag: nil, request_id: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Operation`

#get_project_location(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Location`

#get_project_location_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Config`

#get_project_location_delivery_pipeline(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::DeliveryPipeline`

#get_project_location_delivery_pipeline_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Policy`

#get_project_location_delivery_pipeline_release(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Release`

#get_project_location_delivery_pipeline_release_rollout(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Rollout`

#get_project_location_delivery_pipeline_release_rollout_job_run(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::JobRun`

#get_project_location_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Operation`

#get_project_location_target(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Target`

#get_project_location_target_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Policy`

#ignore_rollout_job(rollout, ignore_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::IgnoreJobResponse`

#list_project_location_delivery_pipeline_release_rollout_job_runs(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::ListJobRunsResponse`

#list_project_location_delivery_pipeline_release_rollouts(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::ListRolloutsResponse`

#list_project_location_delivery_pipeline_releases(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::ListReleasesResponse`

#list_project_location_delivery_pipelines(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::ListDeliveryPipelinesResponse`

#list_project_location_operations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::ListOperationsResponse`

#list_project_location_targets(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::ListTargetsResponse`

#list_project_locations(name, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::ListLocationsResponse`

#patch_project_location_delivery_pipeline(name, delivery_pipeline_object = nil, allow_missing: nil, request_id: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Operation`

#patch_project_location_target(name, target_object = nil, allow_missing: nil, request_id: nil, update_mask: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Operation`

#retry_rollout_job(rollout, retry_job_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::RetryJobResponse`

#set_delivery_pipeline_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Policy`

#set_target_iam_policy(resource, set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::Policy`

#terminate_job_run(name, terminate_job_run_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::TerminateJobRunResponse`

#test_delivery_pipeline_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::TestIamPermissionsResponse`

#test_target_iam_permissions(resource, test_iam_permissions_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ `Google::Apis::ClouddeployV1::TestIamPermissionsResponse`