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

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

REST service stub for the CloudDeploy service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.

Inherits

  • Object

Methods

#abandon_release

def abandon_release(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Deploy::V1::AbandonReleaseResponse

Baseline implementation for the abandon_release REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#advance_rollout

def advance_rollout(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Deploy::V1::AdvanceRolloutResponse

Baseline implementation for the advance_rollout REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#approve_rollout

def approve_rollout(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Deploy::V1::ApproveRolloutResponse

Baseline implementation for the approve_rollout REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#cancel_rollout

def cancel_rollout(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Deploy::V1::CancelRolloutResponse

Baseline implementation for the cancel_rollout REST call

Parameters
  • request_pb (::Google::Cloud::Deploy::V1::CancelRolloutRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#create_delivery_pipeline

def create_delivery_pipeline(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the create_delivery_pipeline REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#create_release

def create_release(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the create_release REST call

Parameters
  • request_pb (::Google::Cloud::Deploy::V1::CreateReleaseRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#create_rollout

def create_rollout(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the create_rollout REST call

Parameters
  • request_pb (::Google::Cloud::Deploy::V1::CreateRolloutRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#create_target

def create_target(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the create_target REST call

Parameters
  • request_pb (::Google::Cloud::Deploy::V1::CreateTargetRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_delivery_pipeline

def delete_delivery_pipeline(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the delete_delivery_pipeline REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_target

def delete_target(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the delete_target REST call

Parameters
  • request_pb (::Google::Cloud::Deploy::V1::DeleteTargetRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_config

def get_config(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Deploy::V1::Config

Baseline implementation for the get_config REST call

Parameters
  • request_pb (::Google::Cloud::Deploy::V1::GetConfigRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_delivery_pipeline

def get_delivery_pipeline(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Deploy::V1::DeliveryPipeline

Baseline implementation for the get_delivery_pipeline REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_job_run

def get_job_run(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Deploy::V1::JobRun

Baseline implementation for the get_job_run REST call

Parameters
  • request_pb (::Google::Cloud::Deploy::V1::GetJobRunRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_release

def get_release(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Deploy::V1::Release

Baseline implementation for the get_release REST call

Parameters
  • request_pb (::Google::Cloud::Deploy::V1::GetReleaseRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_rollout

def get_rollout(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Deploy::V1::Rollout

Baseline implementation for the get_rollout REST call

Parameters
  • request_pb (::Google::Cloud::Deploy::V1::GetRolloutRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#get_target

def get_target(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Deploy::V1::Target

Baseline implementation for the get_target REST call

Parameters
  • request_pb (::Google::Cloud::Deploy::V1::GetTargetRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#ignore_job

def ignore_job(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Deploy::V1::IgnoreJobResponse

Baseline implementation for the ignore_job REST call

Parameters
  • request_pb (::Google::Cloud::Deploy::V1::IgnoreJobRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#initialize

def initialize(endpoint:, credentials:) -> ServiceStub
Returns

#list_delivery_pipelines

def list_delivery_pipelines(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Deploy::V1::ListDeliveryPipelinesResponse

Baseline implementation for the list_delivery_pipelines REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_job_runs

def list_job_runs(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Deploy::V1::ListJobRunsResponse

Baseline implementation for the list_job_runs REST call

Parameters
  • request_pb (::Google::Cloud::Deploy::V1::ListJobRunsRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_releases

def list_releases(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Deploy::V1::ListReleasesResponse

Baseline implementation for the list_releases REST call

Parameters
  • request_pb (::Google::Cloud::Deploy::V1::ListReleasesRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_rollouts

def list_rollouts(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Deploy::V1::ListRolloutsResponse

Baseline implementation for the list_rollouts REST call

Parameters
  • request_pb (::Google::Cloud::Deploy::V1::ListRolloutsRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_targets

def list_targets(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Deploy::V1::ListTargetsResponse

Baseline implementation for the list_targets REST call

Parameters
  • request_pb (::Google::Cloud::Deploy::V1::ListTargetsRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#retry_job

def retry_job(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Deploy::V1::RetryJobResponse

Baseline implementation for the retry_job REST call

Parameters
  • request_pb (::Google::Cloud::Deploy::V1::RetryJobRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#terminate_job_run

def terminate_job_run(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Deploy::V1::TerminateJobRunResponse

Baseline implementation for the terminate_job_run REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#update_delivery_pipeline

def update_delivery_pipeline(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the update_delivery_pipeline REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#update_target

def update_target(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the update_target REST call

Parameters
  • request_pb (::Google::Cloud::Deploy::V1::UpdateTargetRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)