Workflows Executions V1 API - Class Google::Cloud::Workflows::Executions::V1::Executions::Rest::ServiceStub (v1.0.1)

Version latest

• 1.0.1 (latest)
• 1.0.0
• 0.7.0
• 0.6.2
• 0.5.0
• 0.4.0
• 0.3.1
• 0.2.0
• 0.1.2

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

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

Inherits

• Object

Methods

#cancel_execution

def cancel_execution(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Workflows::Executions::V1::Execution

Baseline implementation for the cancel_execution REST call

Parameters

• request_pb (::Google::Cloud::Workflows::Executions::V1::CancelExecutionRequest) — 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

• result (::Google::Cloud::Workflows::Executions::V1::Execution)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Workflows::Executions::V1::Execution) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#create_execution

def create_execution(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Workflows::Executions::V1::Execution

Baseline implementation for the create_execution REST call

Parameters

• request_pb (::Google::Cloud::Workflows::Executions::V1::CreateExecutionRequest) — 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

• result (::Google::Cloud::Workflows::Executions::V1::Execution)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Workflows::Executions::V1::Execution) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#endpoint

def endpoint() -> String

The effective endpoint

Returns

• (String)

#get_execution

def get_execution(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Workflows::Executions::V1::Execution

Baseline implementation for the get_execution REST call

Parameters

• request_pb (::Google::Cloud::Workflows::Executions::V1::GetExecutionRequest) — 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

• result (::Google::Cloud::Workflows::Executions::V1::Execution)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Workflows::Executions::V1::Execution) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#initialize

def initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) -> ServiceStub

Returns

• (ServiceStub) — a new instance of ServiceStub

#list_executions

def list_executions(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::Workflows::Executions::V1::ListExecutionsResponse

Baseline implementation for the list_executions REST call

Parameters

• request_pb (::Google::Cloud::Workflows::Executions::V1::ListExecutionsRequest) — 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

• result (::Google::Cloud::Workflows::Executions::V1::ListExecutionsResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Cloud::Workflows::Executions::V1::ListExecutionsResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

• (String)