Workflows Executions V1 API - Class Google::Cloud::Workflows::Executions::V1::Executions::Client (v0.4.0)

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

Client for the Executions service.

Executions is used to start and manage running instances of [Workflows][google.cloud.workflows.v1.Workflow] called executions.

Inherits

  • Object

Includes

Methods

.configure

def self.configure() { |config| ... } -> Client::Configuration

Configure the Executions Client class.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns
Example 
# Modify the configuration for all Executions clients
::Google::Cloud::Workflows::Executions::V1::Executions::Client.configure do |config|
  config.timeout = 10.0
end

#cancel_execution

def cancel_execution(request, options = nil) -> ::Google::Cloud::Workflows::Executions::V1::Execution
def cancel_execution(name: nil) -> ::Google::Cloud::Workflows::Executions::V1::Execution

Cancels an execution of the given name.

Overloads 
def cancel_execution(request, options = nil) -> ::Google::Cloud::Workflows::Executions::V1::Execution
Pass arguments to cancel_execution via a request object, either of type CancelExecutionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Workflows::Executions::V1::CancelExecutionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def cancel_execution(name: nil) -> ::Google::Cloud::Workflows::Executions::V1::Execution
Pass arguments to cancel_execution via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameter
  • name (::String) — Required. Name of the execution to be cancelled. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/workflows/executions/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Workflows::Executions::V1::Executions::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Workflows::Executions::V1::CancelExecutionRequest.new

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

# The returned object is of type Google::Cloud::Workflows::Executions::V1::Execution.
p result

#configure

def configure() { |config| ... } -> Client::Configuration

Configure the Executions Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on Client.configure.

See Configuration for a description of the configuration fields.

Yields
  • (config) — Configure the Client client.
Yield Parameter
Returns

#create_execution

def create_execution(request, options = nil) -> ::Google::Cloud::Workflows::Executions::V1::Execution
def create_execution(parent: nil, execution: nil) -> ::Google::Cloud::Workflows::Executions::V1::Execution

Creates a new execution using the latest revision of the given workflow.

Overloads 
def create_execution(request, options = nil) -> ::Google::Cloud::Workflows::Executions::V1::Execution
Pass arguments to create_execution via a request object, either of type CreateExecutionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Workflows::Executions::V1::CreateExecutionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def create_execution(parent: nil, execution: nil) -> ::Google::Cloud::Workflows::Executions::V1::Execution
Pass arguments to create_execution via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. Name of the workflow for which an execution should be created. Format: projects/{project}/locations/{location}/workflows/{workflow} The latest revision of the workflow will be used.
  • execution (::Google::Cloud::Workflows::Executions::V1::Execution, ::Hash) — Required. Execution to be created.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/workflows/executions/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Workflows::Executions::V1::Executions::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Workflows::Executions::V1::CreateExecutionRequest.new

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

# The returned object is of type Google::Cloud::Workflows::Executions::V1::Execution.
p result

#get_execution

def get_execution(request, options = nil) -> ::Google::Cloud::Workflows::Executions::V1::Execution
def get_execution(name: nil, view: nil) -> ::Google::Cloud::Workflows::Executions::V1::Execution

Returns an execution of the given name.

Overloads 
def get_execution(request, options = nil) -> ::Google::Cloud::Workflows::Executions::V1::Execution
Pass arguments to get_execution via a request object, either of type GetExecutionRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Workflows::Executions::V1::GetExecutionRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def get_execution(name: nil, view: nil) -> ::Google::Cloud::Workflows::Executions::V1::Execution
Pass arguments to get_execution via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • name (::String) — Required. Name of the execution to be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}
  • view (::Google::Cloud::Workflows::Executions::V1::ExecutionView) — Optional. A view defining which fields should be filled in the returned execution. The API will default to the FULL view.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/workflows/executions/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Workflows::Executions::V1::Executions::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Workflows::Executions::V1::GetExecutionRequest.new

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

# The returned object is of type Google::Cloud::Workflows::Executions::V1::Execution.
p result

#initialize

def initialize() { |config| ... } -> Client

Create a new Executions client object.

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

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

#list_executions

def list_executions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Workflows::Executions::V1::Execution>
def list_executions(parent: nil, page_size: nil, page_token: nil, view: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Workflows::Executions::V1::Execution>

Returns a list of executions which belong to the workflow with the given name. The method returns executions of all workflow revisions. Returned executions are ordered by their start time (newest first).

Overloads 
def list_executions(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Workflows::Executions::V1::Execution>
Pass arguments to list_executions via a request object, either of type ListExecutionsRequest or an equivalent Hash.
Parameters
  • request (::Google::Cloud::Workflows::Executions::V1::ListExecutionsRequest, ::Hash) — A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
  • options (::Gapic::CallOptions, ::Hash) — Overrides the default settings for this call, e.g, timeout, retries, etc. Optional. 
def list_executions(parent: nil, page_size: nil, page_token: nil, view: nil, filter: nil, order_by: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Workflows::Executions::V1::Execution>
Pass arguments to list_executions via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).
Parameters
  • parent (::String) — Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}
  • page_size (::Integer) — Maximum number of executions to return per call. Max supported value depends on the selected Execution view: it's 1000 for BASIC and 100 for FULL. The default value used if the field is not specified is 100, regardless of the selected view. Values greater than the max value will be coerced down to it.
  • page_token (::String) — A page token, received from a previous ListExecutions call. Provide this to retrieve the subsequent page.

    When paginating, all other parameters provided to ListExecutions must match the call that provided the page token.

    Note that pagination is applied to dynamic data. The list of executions returned can change between page requests.

  • view (::Google::Cloud::Workflows::Executions::V1::ExecutionView) — Optional. A view defining which fields should be filled in the returned executions. The API will default to the BASIC view.
  • filter (::String) — Optional. Filters applied to the [Executions.ListExecutions] results. The following fields are supported for filtering: executionID, state, startTime, endTime, duration, workflowRevisionID, stepName, and label.
  • order_by (::String) — Optional. The ordering applied to the [Executions.ListExecutions] results. By default the ordering is based on descending start time. The following fields are supported for order by: executionID, startTime, endTime, duration, state, and workflowRevisionID.
Yields
  • (response, operation) — Access the result along with the RPC operation
Yield Parameters
Returns
Raises
  • (::Google::Cloud::Error) — if the RPC is aborted.
Example

Basic example

require "google/cloud/workflows/executions/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Workflows::Executions::V1::Executions::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Workflows::Executions::V1::ListExecutionsRequest.new

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

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Cloud::Workflows::Executions::V1::Execution.
  p item
end