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.



8645
8646
8647
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8645

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) 


8555
8556
8557
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8555

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) 


8560
8561
8562
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8560

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) 


8566
8567
8568
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8566

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) 


8571
8572
8573
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8571

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:



8578
8579
8580
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8578

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) 


8584
8585
8586
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8584

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:



8592
8593
8594
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8592

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) 


8598
8599
8600
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8598

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:



8603
8604
8605
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8603

def parameters
  @parameters
end

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

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

Returns:



8608
8609
8610
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8608

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:



8613
8614
8615
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8613

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:



8620
8621
8622
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8620

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) 


8625
8626
8627
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8625

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) 


8630
8631
8632
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8630

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) 


8638
8639
8640
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8638

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) 


8643
8644
8645
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8643

def task_template
  @task_template
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8650

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