Class: Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaTaskConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/integrations_v1alpha/classes.rb,
lib/google/apis/integrations_v1alpha/representations.rb,
lib/google/apis/integrations_v1alpha/representations.rb

Overview

The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudIntegrationsV1alphaTaskConfig

Returns a new instance of GoogleCloudIntegrationsV1alphaTaskConfig.



8865
8866
8867
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8865

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#description ⇒ String

Optional. User-provided description intended to give additional business context about the task. Corresponds to the JSON property description

Returns:

  • (String) 


8775
8776
8777
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8775

def description
  @description
end

#display_name ⇒ String

Optional. User-provided label that is attached to this TaskConfig in the UI. Corresponds to the JSON property displayName

Returns:

  • (String) 


8780
8781
8782
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8780

def display_name
  @display_name
end

#error_catcher_id ⇒ String

Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task Corresponds to the JSON property errorCatcherId

Returns:

  • (String) 


8786
8787
8788
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8786

def error_catcher_id
  @error_catcher_id
end

#external_task_type ⇒ String

Optional. External task type of the task Corresponds to the JSON property externalTaskType

Returns:

  • (String) 


8791
8792
8793
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8791

def external_task_type
  @external_task_type
end

#failure_policy ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaFailurePolicy

Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a retry_strategy of NONE will be applied). Corresponds to the JSON property failurePolicy

Returns:



8798
8799
8800
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8798

def failure_policy
  @failure_policy
end

#json_validation_option ⇒ String

Optional. If set, overrides the option configured in the Task implementation class. Corresponds to the JSON property jsonValidationOption

Returns:

  • (String) 


8804
8805
8806
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8804

def json_validation_option
  @json_validation_option
end

#next_tasks ⇒ Array<Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaNextTask>

Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by event_config_id. Each of these next tasks are executed only if the condition associated with them evaluates to true. Corresponds to the JSON property nextTasks

Returns:



8812
8813
8814
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8812

def next_tasks
  @next_tasks
end

#next_tasks_execution_policy ⇒ String

Optional. The policy dictating the execution of the next set of tasks for the current task. Corresponds to the JSON property nextTasksExecutionPolicy

Returns:

  • (String) 


8818
8819
8820
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8818

def next_tasks_execution_policy
  @next_tasks_execution_policy
end

#parameters ⇒ Hash<String,Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaEventParameter>

Optional. The customized parameters the user can pass to this task. Corresponds to the JSON property parameters

Returns:



8823
8824
8825
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8823

def parameters
  @parameters
end

#position ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaCoordinate

Configuration detail of coordinate, it used for UI Corresponds to the JSON property position

Returns:



8828
8829
8830
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8828

def position
  @position
end

#success_policy ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaSuccessPolicy

Policy that dictates the behavior for the task after it completes successfully. Corresponds to the JSON property successPolicy

Returns:



8833
8834
8835
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8833

def success_policy
  @success_policy
end

#synchronous_call_failure_policy ⇒ Google::Apis::IntegrationsV1alpha::GoogleCloudIntegrationsV1alphaFailurePolicy

Policy that defines the task retry logic and failure type. If no FailurePolicy is defined for a task, all its dependent tasks will not be executed (i.e, a retry_strategy of NONE will be applied). Corresponds to the JSON property synchronousCallFailurePolicy

Returns:



8840
8841
8842
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8840

def synchronous_call_failure_policy
  @synchronous_call_failure_policy
end

#task ⇒ String

Optional. The name for the task. Corresponds to the JSON property task

Returns:

  • (String) 


8845
8846
8847
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8845

def task
  @task
end

#task_execution_strategy ⇒ String

Optional. The policy dictating the execution strategy of this task. Corresponds to the JSON property taskExecutionStrategy

Returns:

  • (String) 


8850
8851
8852
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8850

def task_execution_strategy
  @task_execution_strategy
end

#task_id ⇒ String

Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks ( via field next_tasks.task_id). Corresponds to the JSON property taskId

Returns:

  • (String) 


8858
8859
8860
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8858

def task_id
  @task_id
end

#task_template ⇒ String

Optional. Used to define task-template name if task is of type task-template Corresponds to the JSON property taskTemplate

Returns:

  • (String) 


8863
8864
8865
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8863

def task_template
  @task_template
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8870

def update!(**args)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @error_catcher_id = args[:error_catcher_id] if args.key?(:error_catcher_id)
  @external_task_type = args[:external_task_type] if args.key?(:external_task_type)
  @failure_policy = args[:failure_policy] if args.key?(:failure_policy)
  @json_validation_option = args[:json_validation_option] if args.key?(:json_validation_option)
  @next_tasks = args[:next_tasks] if args.key?(:next_tasks)
  @next_tasks_execution_policy = args[:next_tasks_execution_policy] if args.key?(:next_tasks_execution_policy)
  @parameters = args[:parameters] if args.key?(:parameters)
  @position = args[:position] if args.key?(:position)
  @success_policy = args[:success_policy] if args.key?(:success_policy)
  @synchronous_call_failure_policy = args[:synchronous_call_failure_policy] if args.key?(:synchronous_call_failure_policy)
  @task = args[:task] if args.key?(:task)
  @task_execution_strategy = args[:task_execution_strategy] if args.key?(:task_execution_strategy)
  @task_id = args[:task_id] if args.key?(:task_id)
  @task_template = args[:task_template] if args.key?(:task_template)
end