Workflows V1 API - Class Google::Cloud::Workflows::V1::Workflows::Rest::ServiceStub (v0.3.0)

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

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

Inherits

Object

Methods

#create_workflow

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

Baseline implementation for the create_workflow REST call

Parameters

request_pb (::Google::Cloud::Workflows::V1::CreateWorkflowRequest) — 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::Longrunning::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#delete_workflow

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

Baseline implementation for the delete_workflow REST call

Parameters

request_pb (::Google::Cloud::Workflows::V1::DeleteWorkflowRequest) — 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::Longrunning::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

(::ArgumentError)

#get_workflow

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

Baseline implementation for the get_workflow REST call

Parameters

request_pb (::Google::Cloud::Workflows::V1::GetWorkflowRequest) — 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::V1::Workflow)
operation (::Gapic::Rest::TransportOperation)

Returns

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

Raises

(::ArgumentError)

#initialize

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

Returns

(ServiceStub) — a new instance of ServiceStub

#list_workflows

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

Baseline implementation for the list_workflows REST call

Parameters

request_pb (::Google::Cloud::Workflows::V1::ListWorkflowsRequest) — 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::V1::ListWorkflowsResponse)
operation (::Gapic::Rest::TransportOperation)

Returns

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

Raises

(::ArgumentError)

#update_workflow

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

Baseline implementation for the update_workflow REST call

Parameters

request_pb (::Google::Cloud::Workflows::V1::UpdateWorkflowRequest) — 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::Longrunning::Operation)
operation (::Gapic::Rest::TransportOperation)

Returns

(::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

(::ArgumentError)