class Google::Cloud::Workflows::Executions::V1beta::Executions::Client

Client for the Executions service.

Executions is used to start and manage running instances of

Workflows][google.cloud.workflows.v1beta.Workflow

called executions.

Attributes

executions_stub[R]

@private

Public Class Methods

configure() { |configure| ... } click to toggle source

Configure the Executions Client class.

See {::Google::Cloud::Workflows::Executions::V1beta::Executions::Client::Configuration} for a description of the configuration fields.

@example

# Modify the configuration for all Executions clients
::Google::Cloud::Workflows::Executions::V1beta::Executions::Client.configure do |config|
  config.timeout = 10.0
end

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/workflows/executions/v1beta/executions/client.rb, line 58
def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "Workflows", "Executions", "V1beta"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config
  end
  yield @configure if block_given?
  @configure
end
new() { |config| ... } click to toggle source

Create a new Executions client object.

@example

# Create a client using the default configuration
client = ::Google::Cloud::Workflows::Executions::V1beta::Executions::Client.new

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

@yield [config] Configure the Executions client. @yieldparam config [Client::Configuration]

# File lib/google/cloud/workflows/executions/v1beta/executions/client.rb, line 111
def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/workflows/executions/v1beta/executions_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                           !@config.endpoint.split(".").first.include?("-")
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @executions_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::Workflows::Executions::V1beta::Executions::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Public Instance Methods

cancel_execution(request, options = nil) { |response, operation| ... } click to toggle source

Cancels an execution of the given name.

@overload cancel_execution(request, options = nil)

Pass arguments to `cancel_execution` via a request object, either of type
{::Google::Cloud::Workflows::Executions::V1beta::CancelExecutionRequest} or an equivalent Hash.

@param request [::Google::Cloud::Workflows::Executions::V1beta::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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload cancel_execution(name: nil)

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).

@param name [::String]
  Required. Name of the execution to be cancelled.
  Format:
  projects/\\{project}/locations/\\{location}/workflows/\\{workflow}/executions/\\{execution}

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Workflows::Executions::V1beta::Execution] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Workflows::Executions::V1beta::Execution]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/workflows/executions/v1beta/executions/client.rb, line 413
def cancel_execution request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Workflows::Executions::V1beta::CancelExecutionRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.cancel_execution.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Workflows::Executions::V1beta::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.cancel_execution.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.cancel_execution.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @executions_stub.call_rpc :cancel_execution, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
configure() { |config| ... } click to toggle source

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 {::Google::Cloud::Workflows::Executions::V1beta::Executions::Client::Configuration} for a description of the configuration fields.

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/workflows/executions/v1beta/executions/client.rb, line 90
def configure
  yield @config if block_given?
  @config
end
create_execution(request, options = nil) { |response, operation| ... } click to toggle source

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

@overload create_execution(request, options = nil)

Pass arguments to `create_execution` via a request object, either of type
{::Google::Cloud::Workflows::Executions::V1beta::CreateExecutionRequest} or an equivalent Hash.

@param request [::Google::Cloud::Workflows::Executions::V1beta::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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload create_execution(parent: nil, execution: nil)

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).

@param 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.
@param execution [::Google::Cloud::Workflows::Executions::V1beta::Execution, ::Hash]
  Required. Execution to be created.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Workflows::Executions::V1beta::Execution] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Workflows::Executions::V1beta::Execution]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/workflows/executions/v1beta/executions/client.rb, line 270
def create_execution request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Workflows::Executions::V1beta::CreateExecutionRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_execution.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Workflows::Executions::V1beta::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_execution.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_execution.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @executions_stub.call_rpc :create_execution, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
get_execution(request, options = nil) { |response, operation| ... } click to toggle source

Returns an execution of the given name.

@overload get_execution(request, options = nil)

Pass arguments to `get_execution` via a request object, either of type
{::Google::Cloud::Workflows::Executions::V1beta::GetExecutionRequest} or an equivalent Hash.

@param request [::Google::Cloud::Workflows::Executions::V1beta::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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload get_execution(name: nil, view: nil)

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).

@param name [::String]
  Required. Name of the execution to be retrieved.
  Format:
  projects/\\{project}/locations/\\{location}/workflows/\\{workflow}/executions/\\{execution}
@param view [::Google::Cloud::Workflows::Executions::V1beta::ExecutionView]
  Optional. A view defining which fields should be filled in the returned execution.
  The API will default to the FULL view.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::Workflows::Executions::V1beta::Execution] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::Workflows::Executions::V1beta::Execution]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/workflows/executions/v1beta/executions/client.rb, line 343
def get_execution request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Workflows::Executions::V1beta::GetExecutionRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_execution.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Workflows::Executions::V1beta::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "name" => request.name
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_execution.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_execution.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @executions_stub.call_rpc :get_execution, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
list_executions(request, options = nil) { |response, operation| ... } click to toggle source

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).

@overload list_executions(request, options = nil)

Pass arguments to `list_executions` via a request object, either of type
{::Google::Cloud::Workflows::Executions::V1beta::ListExecutionsRequest} or an equivalent Hash.

@param request [::Google::Cloud::Workflows::Executions::V1beta::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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload list_executions(parent: nil, page_size: nil, page_token: nil, view: nil)

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).

@param parent [::String]
  Required. Name of the workflow for which the executions should be listed.
  Format: projects/\\{project}/locations/\\{location}/workflows/\\{workflow}
@param page_size [::Integer]
  Maximum number of executions to return per call.
  Max supported value depends on the selected Execution view: it's 10000 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.
@param 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.
@param view [::Google::Cloud::Workflows::Executions::V1beta::ExecutionView]
  Optional. A view defining which fields should be filled in the returned executions.
  The API will default to the BASIC view.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::PagedEnumerable<::Google::Cloud::Workflows::Executions::V1beta::Execution>] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::PagedEnumerable<::Google::Cloud::Workflows::Executions::V1beta::Execution>]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/workflows/executions/v1beta/executions/client.rb, line 197
def list_executions request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Workflows::Executions::V1beta::ListExecutionsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_executions.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Workflows::Executions::V1beta::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {
    "parent" => request.parent
  }
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.list_executions.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_executions.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @executions_stub.call_rpc :list_executions, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @executions_stub, :list_executions, request, response, operation, options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end