Class: Google::Cloud::Workflows::Executions::V1beta::Executions::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/workflows/executions/v1beta/executions/client.rb

Overview

Client for the Executions service.

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

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#execution_path, #workflow_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new Executions client object.

Examples:


# 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

Yields:

  • (config) —

    Configure the Executions client.

Yield Parameters:



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/google/cloud/workflows/executions/v1beta/executions/client.rb', line 126

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.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_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,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool
  )
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the Executions Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/google/cloud/workflows/executions/v1beta/executions/client.rb', line 64

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

Instance Method Details

#cancel_execution(request, options = nil) ⇒ ::Google::Cloud::Workflows::Executions::V1beta::Execution #cancel_execution(name: nil) ⇒ ::Google::Cloud::Workflows::Executions::V1beta::Execution

Cancels an execution of the given name.

Examples:

Basic example

require "google/cloud/workflows/executions/v1beta"

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

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

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

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

Overloads:

  • #cancel_execution(request, options = nil) ⇒ ::Google::Cloud::Workflows::Executions::V1beta::Execution

    Pass arguments to cancel_execution via a request object, either of type CancelExecutionRequest or an equivalent Hash.

    Parameters:

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

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #cancel_execution(name: nil) ⇒ ::Google::Cloud::Workflows::Executions::V1beta::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).

    Parameters:

    • name (::String) (defaults to: nil) —

      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.



505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
 
# File 'lib/google/cloud/workflows/executions/v1beta/executions/client.rb', line 505

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, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  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| ... } ⇒ 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 configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



96
97
98
99
 
# File 'lib/google/cloud/workflows/executions/v1beta/executions/client.rb', line 96

def configure
  yield @config if block_given?
  @config
end

#create_execution(request, options = nil) ⇒ ::Google::Cloud::Workflows::Executions::V1beta::Execution #create_execution(parent: nil, execution: nil) ⇒ ::Google::Cloud::Workflows::Executions::V1beta::Execution

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

Examples:

Basic example

require "google/cloud/workflows/executions/v1beta"

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

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

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

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

Overloads:

  • #create_execution(request, options = nil) ⇒ ::Google::Cloud::Workflows::Executions::V1beta::Execution

    Pass arguments to create_execution via a request object, either of type CreateExecutionRequest or an equivalent Hash.

    Parameters:

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

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_execution(parent: nil, execution: nil) ⇒ ::Google::Cloud::Workflows::Executions::V1beta::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) (defaults to: nil) —

      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::V1beta::Execution, ::Hash) (defaults to: nil) —

      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.



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/google/cloud/workflows/executions/v1beta/executions/client.rb', line 326

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, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  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) ⇒ ::Google::Cloud::Workflows::Executions::V1beta::Execution #get_execution(name: nil, view: nil) ⇒ ::Google::Cloud::Workflows::Executions::V1beta::Execution

Returns an execution of the given name.

Examples:

Basic example

require "google/cloud/workflows/executions/v1beta"

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

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

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

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

Overloads:

  • #get_execution(request, options = nil) ⇒ ::Google::Cloud::Workflows::Executions::V1beta::Execution

    Pass arguments to get_execution via a request object, either of type GetExecutionRequest or an equivalent Hash.

    Parameters:

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

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_execution(name: nil, view: nil) ⇒ ::Google::Cloud::Workflows::Executions::V1beta::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) (defaults to: nil) —

      Required. Name of the execution to be retrieved. Format: projects/{project}/locations/{location}/workflows/{workflow}/executions/{execution}

    • view (::Google::Cloud::Workflows::Executions::V1beta::ExecutionView) (defaults to: nil) —

      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.



417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
 
# File 'lib/google/cloud/workflows/executions/v1beta/executions/client.rb', line 417

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, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  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) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Workflows::Executions::V1beta::Execution> #list_executions(parent: nil, page_size: nil, page_token: nil, view: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Workflows::Executions::V1beta::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).

Examples:

Basic example

require "google/cloud/workflows/executions/v1beta"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Workflows::Executions::V1beta::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::V1beta::Execution.
  p item
end

Overloads:

  • #list_executions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Workflows::Executions::V1beta::Execution>

    Pass arguments to list_executions via a request object, either of type ListExecutionsRequest or an equivalent Hash.

    Parameters:

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

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_executions(parent: nil, page_size: nil, page_token: nil, view: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::Workflows::Executions::V1beta::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) (defaults to: nil) —

      Required. Name of the workflow for which the executions should be listed. Format: projects/{project}/locations/{location}/workflows/{workflow}

    • page_size (::Integer) (defaults to: nil) —

      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.

    • page_token (::String) (defaults to: nil) —

      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.

    • view (::Google::Cloud::Workflows::Executions::V1beta::ExecutionView) (defaults to: nil) —

      Optional. A view defining which fields should be filled in the returned executions. The API will default to the BASIC view.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/google/cloud/workflows/executions/v1beta/executions/client.rb', line 235

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, x-goog-user-project and x-goog-api-version 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-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  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

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


106
107
108
 
# File 'lib/google/cloud/workflows/executions/v1beta/executions/client.rb', line 106

def universe_domain
  @executions_stub.universe_domain
end