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.



8359
8360
8361
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8359

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) 


8285
8286
8287
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8285

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) 


8290
8291
8292
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8290

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:



8297
8298
8299
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8297

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) 


8303
8304
8305
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8303

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:



8311
8312
8313
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8311

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) 


8317
8318
8319
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8317

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:



8322
8323
8324
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8322

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:



8327
8328
8329
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8327

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:



8334
8335
8336
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8334

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) 


8339
8340
8341
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8339

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) 


8344
8345
8346
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8344

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) 


8352
8353
8354
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8352

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) 


8357
8358
8359
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8357

def task_template
  @task_template
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 8364

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