Class: Google::Apis::WorkflowexecutionsV1::WorkflowExecutionsService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/workflowexecutions_v1/service.rb

Overview

Workflow Executions API

Execute workflows created with Workflows API.

Examples:

require 'google/apis/workflowexecutions_v1'

Workflowexecutions = Google::Apis::WorkflowexecutionsV1 # Alias the module
service = Workflowexecutions::WorkflowExecutionsService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://workflowexecutions.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ WorkflowExecutionsService

Returns a new instance of WorkflowExecutionsService.



47
48
49
50
51
52
 
# File 'lib/google/apis/workflowexecutions_v1/service.rb', line 47

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-workflowexecutions_v1',
        client_version: Google::Apis::WorkflowexecutionsV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



40
41
42
 
# File 'lib/google/apis/workflowexecutions_v1/service.rb', line 40

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



45
46
47
 
# File 'lib/google/apis/workflowexecutions_v1/service.rb', line 45

def quota_user
  @quota_user
end

Instance Method Details

#cancel_execution(name, cancel_execution_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WorkflowexecutionsV1::Execution

Cancels an execution of the given name.

Parameters:

  • name (String) —

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

  • cancel_execution_request_object (Google::Apis::WorkflowexecutionsV1::CancelExecutionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/google/apis/workflowexecutions_v1/service.rb', line 111

def cancel_execution(name, cancel_execution_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+name}:cancel', options)
  command.request_representation = Google::Apis::WorkflowexecutionsV1::CancelExecutionRequest::Representation
  command.request_object = cancel_execution_request_object
  command.response_representation = Google::Apis::WorkflowexecutionsV1::Execution::Representation
  command.response_class = Google::Apis::WorkflowexecutionsV1::Execution
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_location_workflow_execution(parent, execution_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WorkflowexecutionsV1::Execution

Creates a new execution using the latest revision of the given workflow. For more information, see Execute a workflow.

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_object (Google::Apis::WorkflowexecutionsV1::Execution) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/google/apis/workflowexecutions_v1/service.rb', line 147

def create_project_location_workflow_execution(parent, execution_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+parent}/executions', options)
  command.request_representation = Google::Apis::WorkflowexecutionsV1::Execution::Representation
  command.request_object = execution_object
  command.response_representation = Google::Apis::WorkflowexecutionsV1::Execution::Representation
  command.response_class = Google::Apis::WorkflowexecutionsV1::Execution
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#export_project_location_workflow_execution_data(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WorkflowexecutionsV1::ExportDataResponse

Returns all metadata stored about an execution, excluding most data that is already accessible using other API methods.

Parameters:

  • name (String) —

    Required. Name of the execution for which data is to be exported. Format: projects/project/locations/location/workflows/workflow/executions/ execution

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



182
183
184
185
186
187
188
189
190
 
# File 'lib/google/apis/workflowexecutions_v1/service.rb', line 182

def export_project_location_workflow_execution_data(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}:exportData', options)
  command.response_representation = Google::Apis::WorkflowexecutionsV1::ExportDataResponse::Representation
  command.response_class = Google::Apis::WorkflowexecutionsV1::ExportDataResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_workflow_execution(name, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WorkflowexecutionsV1::Execution

Returns an execution of the given name.

Parameters:

  • name (String) —

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

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

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

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



216
217
218
219
220
221
222
223
224
225
 
# File 'lib/google/apis/workflowexecutions_v1/service.rb', line 216

def get_project_location_workflow_execution(name, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::WorkflowexecutionsV1::Execution::Representation
  command.response_class = Google::Apis::WorkflowexecutionsV1::Execution
  command.params['name'] = name unless name.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_location_workflow_execution_step_entry(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WorkflowexecutionsV1::StepEntry

Gets a step entry.

Parameters:

  • name (String) —

    Required. The name of the step entry to retrieve. Format: projects/project/ locations/location/workflows/workflow/executions/execution/stepEntries/ step_entry

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



357
358
359
360
361
362
363
364
365
 
# File 'lib/google/apis/workflowexecutions_v1/service.rb', line 357

def get_project_location_workflow_execution_step_entry(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::WorkflowexecutionsV1::StepEntry::Representation
  command.response_class = Google::Apis::WorkflowexecutionsV1::StepEntry
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_workflow_execution_callbacks(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WorkflowexecutionsV1::ListCallbacksResponse

Returns a list of active callbacks that belong to the execution with the given name. The returned callbacks are ordered by callback ID.

Parameters:

  • parent (String) —

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

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

    Maximum number of callbacks to return per call. The default value is 100 and is also the maximum value.

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

    A page token, received from a previous ListCallbacks call. Provide this to retrieve the subsequent page. Note that pagination is applied to dynamic data. The list of callbacks returned can change between page requests if callbacks are created or deleted.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/google/apis/workflowexecutions_v1/service.rb', line 323

def list_project_location_workflow_execution_callbacks(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/callbacks', options)
  command.response_representation = Google::Apis::WorkflowexecutionsV1::ListCallbacksResponse::Representation
  command.response_class = Google::Apis::WorkflowexecutionsV1::ListCallbacksResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_workflow_execution_step_entries(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, skip: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WorkflowexecutionsV1::ListStepEntriesResponse

Lists step entries for the corresponding workflow execution. Returned entries are ordered by their create_time.

Parameters:

  • parent (String) —

    Required. Name of the workflow execution to list entries for. Format: projects/ project/locations/location/workflows/workflow/executions/execution/ stepEntries/

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

    Optional. Filters applied to the [StepEntries.ListStepEntries] results. The following fields are supported for filtering: entryId, createTime, updateTime, routine, step, stepType, state. For details, see AIP-160. For example, if you are using the Google APIs Explorer: state="SUCCEEDED" or createTime>"2023-08-01" AND state="FAILED"

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

    Optional. Comma-separated list of fields that specify the ordering applied to the [StepEntries.ListStepEntries] results. By default the ordering is based on ascending entryId. The following fields are supported for ordering: entryId, createTime, updateTime, routine, step, stepType, state. For details, see AIP-132.

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

    Optional. Number of step entries to return per call. The default max is 1000.

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

    Optional. A page token, received from a previous ListStepEntries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListStepEntries must match the call that provided the page token.

  • skip (Fixnum) (defaults to: nil) —

    Optional. The number of step entries to skip. It can be used with or without a pageToken. If used with a pageToken, then it indicates the number of step entries to skip starting from the requested page.

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



413
414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/google/apis/workflowexecutions_v1/service.rb', line 413

def list_project_location_workflow_execution_step_entries(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, skip: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/stepEntries', options)
  command.response_representation = Google::Apis::WorkflowexecutionsV1::ListStepEntriesResponse::Representation
  command.response_class = Google::Apis::WorkflowexecutionsV1::ListStepEntriesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['skip'] = skip unless skip.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_location_workflow_executions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WorkflowexecutionsV1::ListExecutionsResponse

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

Parameters:

  • parent (String) —

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

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

    Optional. Filters applied to the [Executions.ListExecutions] results. The following fields are supported for filtering: executionId, state, createTime, startTime, endTime, duration, workflowRevisionId, stepName, and label. For details, see AIP-160. For more information, see Filter executions. For example, if you are using the Google APIs Explorer: state="SUCCEEDED" or startTime>"2023-08-01" AND state="FAILED"

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

    Optional. Comma-separated list of fields that specify the ordering applied to the [Executions.ListExecutions] results. By default the ordering is based on descending createTime. The following fields are supported for ordering: executionId, state, createTime, startTime, endTime, duration, and workflowRevisionId. For details, see AIP-132.

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

    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) (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. Note that pagination is applied to dynamic data. The list of executions returned can change between page requests.

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

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

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

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



277
278
279
280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/google/apis/workflowexecutions_v1/service.rb', line 277

def list_project_location_workflow_executions(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+parent}/executions', options)
  command.response_representation = Google::Apis::WorkflowexecutionsV1::ListExecutionsResponse::Representation
  command.response_class = Google::Apis::WorkflowexecutionsV1::ListExecutionsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['filter'] = filter unless filter.nil?
  command.query['orderBy'] = order_by unless order_by.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['view'] = view unless view.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#trigger_workflow_pubsub_execution(workflow, trigger_pubsub_execution_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::WorkflowexecutionsV1::Execution

Triggers a new execution using the latest revision of the given workflow by a Pub/Sub push notification.

Parameters:

  • workflow (String) —

    Required. Name of the workflow for which an execution should be created. Format: projects/project/locations/location/workflows/workflow

  • trigger_pubsub_execution_request_object (Google::Apis::WorkflowexecutionsV1::TriggerPubsubExecutionRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

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

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/google/apis/workflowexecutions_v1/service.rb', line 77

def trigger_workflow_pubsub_execution(workflow, trigger_pubsub_execution_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/{+workflow}:triggerPubsubExecution', options)
  command.request_representation = Google::Apis::WorkflowexecutionsV1::TriggerPubsubExecutionRequest::Representation
  command.request_object = trigger_pubsub_execution_request_object
  command.response_representation = Google::Apis::WorkflowexecutionsV1::Execution::Representation
  command.response_class = Google::Apis::WorkflowexecutionsV1::Execution
  command.params['workflow'] = workflow unless workflow.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end