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.



9023
9024
9025
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 9023

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) 


8949
8950
8951
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8949

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) 


8954
8955
8956
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8954

def display_name
  @display_name
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:



8961
8962
8963
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8961

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) 


8967
8968
8969
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8967

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:



8975
8976
8977
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8975

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) 


8981
8982
8983
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8981

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:



8986
8987
8988
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8986

def parameters
  @parameters
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:



8991
8992
8993
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8991

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:



8998
8999
9000
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8998

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) 


9003
9004
9005
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 9003

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) 


9008
9009
9010
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 9008

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) 


9016
9017
9018
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 9016

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) 


9021
9022
9023
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 9021

def task_template
  @task_template
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 9028

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