Class: Google::Apis::IntegrationsV1::GoogleCloudIntegrationsV1alphaTaskConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/integrations_v1/classes.rb,
lib/google/apis/integrations_v1/representations.rb,
lib/google/apis/integrations_v1/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.



10755
10756
10757
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 10755

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

Instance Attribute Details

#conditional_failure_policies ⇒ Google::Apis::IntegrationsV1::GoogleCloudIntegrationsV1alphaConditionalFailurePolicies

Conditional task failur retry strategies Corresponds to the JSON property conditionalFailurePolicies

Returns:



10659
10660
10661
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 10659

def conditional_failure_policies
  @conditional_failure_policies
end

#description ⇒ String

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

Returns:

  • (String) 


10665
10666
10667
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 10665

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) 


10670
10671
10672
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 10670

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) 


10676
10677
10678
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 10676

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) 


10681
10682
10683
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 10681

def external_task_type
  @external_task_type
end

#failure_policy ⇒ Google::Apis::IntegrationsV1::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:



10688
10689
10690
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 10688

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) 


10694
10695
10696
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 10694

def json_validation_option
  @json_validation_option
end

#next_tasks ⇒ Array<Google::Apis::IntegrationsV1::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:



10702
10703
10704
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 10702

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) 


10708
10709
10710
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 10708

def next_tasks_execution_policy
  @next_tasks_execution_policy
end

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

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

Returns:



10713
10714
10715
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 10713

def parameters
  @parameters
end

#position ⇒ Google::Apis::IntegrationsV1::GoogleCloudIntegrationsV1alphaCoordinate

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

Returns:



10718
10719
10720
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 10718

def position
  @position
end

#success_policy ⇒ Google::Apis::IntegrationsV1::GoogleCloudIntegrationsV1alphaSuccessPolicy

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

Returns:



10723
10724
10725
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 10723

def success_policy
  @success_policy
end

#synchronous_call_failure_policy ⇒ Google::Apis::IntegrationsV1::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:



10730
10731
10732
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 10730

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) 


10735
10736
10737
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 10735

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) 


10740
10741
10742
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 10740

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) 


10748
10749
10750
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 10748

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) 


10753
10754
10755
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 10753

def task_template
  @task_template
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10760
10761
10762
10763
10764
10765
10766
10767
10768
10769
10770
10771
10772
10773
10774
10775
10776
10777
10778
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 10760

def update!(**args)
  @conditional_failure_policies = args[:conditional_failure_policies] if args.key?(:conditional_failure_policies)
  @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