Class: Google::Apis::IntegrationsV1alpha::EnterpriseCrmFrontendsEventbusProtoTaskConfig

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) ⇒ EnterpriseCrmFrontendsEventbusProtoTaskConfig

Returns a new instance of EnterpriseCrmFrontendsEventbusProtoTaskConfig.



4431
4432
4433
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4431

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

Instance Attribute Details

#alert_configs ⇒ Array<Google::Apis::IntegrationsV1alpha::EnterpriseCrmEventbusProtoTaskAlertConfig>

Alert configurations on error rate, warning rate, number of runs, durations, etc. Corresponds to the JSON property alertConfigs

Returns:



4271
4272
4273
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4271

def alert_configs
  @alert_configs
end

#create_time ⇒ String

Auto-generated. Corresponds to the JSON property createTime

Returns:

  • (String) 


4276
4277
4278
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4276

def create_time
  @create_time
end

#creator_email ⇒ String

The creator's email address. Auto-generated from the user's email. Corresponds to the JSON property creatorEmail

Returns:

  • (String) 


4281
4282
4283
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4281

def creator_email
  @creator_email
end

#description ⇒ String

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

Returns:

  • (String) 


4287
4288
4289
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4287

def description
  @description
end

#disable_strict_type_validation ⇒ Boolean Also known as: disable_strict_type_validation?

If this config contains a TypedTask, allow validation to succeed if an input is read from the output of another TypedTask whose output type is declared as a superclass of the requested input type. For instance, if the previous task declares an output of type Message, any task with this flag enabled will pass validation when attempting to read any proto Message type from the resultant Event parameter. Corresponds to the JSON property disableStrictTypeValidation

Returns:

  • (Boolean) 


4297
4298
4299
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4297

def disable_strict_type_validation
  @disable_strict_type_validation
end

#error_catcher_id ⇒ String

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) 


4304
4305
4306
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4304

def error_catcher_id
  @error_catcher_id
end

#external_task_type ⇒ String

Corresponds to the JSON property externalTaskType

Returns:

  • (String) 


4309
4310
4311
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4309

def external_task_type
  @external_task_type
end

#failure_policy ⇒ Google::Apis::IntegrationsV1alpha::EnterpriseCrmEventbusProtoFailurePolicy

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:



4316
4317
4318
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4316

def failure_policy
  @failure_policy
end

#incoming_edge_count ⇒ Fixnum

The number of edges leading into this TaskConfig. Corresponds to the JSON property incomingEdgeCount

Returns:

  • (Fixnum) 


4321
4322
4323
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4321

def incoming_edge_count
  @incoming_edge_count
end

#json_validation_option ⇒ String

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

Returns:

  • (String) 


4326
4327
4328
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4326

def json_validation_option
  @json_validation_option
end

#label ⇒ String

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

Returns:

  • (String) 


4331
4332
4333
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4331

def label
  @label
end

#last_modified_time ⇒ String

Auto-generated. Corresponds to the JSON property lastModifiedTime

Returns:

  • (String) 


4336
4337
4338
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4336

def last_modified_time
  @last_modified_time
end

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

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:



4344
4345
4346
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4344

def next_tasks
  @next_tasks
end

#next_tasks_execution_policy ⇒ String

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

Returns:

  • (String) 


4350
4351
4352
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4350

def next_tasks_execution_policy
  @next_tasks_execution_policy
end

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

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

Returns:



4355
4356
4357
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4355

def parameters
  @parameters
end

#position ⇒ Google::Apis::IntegrationsV1alpha::EnterpriseCrmEventbusProtoCoordinate

Represents two-dimensional positions. Corresponds to the JSON property position

Returns:



4360
4361
4362
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4360

def position
  @position
end

#precondition ⇒ String

Optional. Standard filter expression evaluated before execution. Independent of other conditions and tasks. Can be used to enable rollout. e.g. "rollout(5)" will only allow 5% of incoming traffic to task. Corresponds to the JSON property precondition

Returns:

  • (String) 


4367
4368
4369
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4367

def precondition
  @precondition
end

#precondition_label ⇒ String

Optional. User-provided label that is attached to precondition in the UI. Corresponds to the JSON property preconditionLabel

Returns:

  • (String) 


4372
4373
4374
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4372

def precondition_label
  @precondition_label
end

#rollback_strategy ⇒ Google::Apis::IntegrationsV1alpha::EnterpriseCrmFrontendsEventbusProtoRollbackStrategy

Next available id: 4 Corresponds to the JSON property rollbackStrategy

Returns:



4377
4378
4379
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4377

def rollback_strategy
  @rollback_strategy
end

#success_policy ⇒ Google::Apis::IntegrationsV1alpha::EnterpriseCrmEventbusProtoSuccessPolicy

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

Returns:



4382
4383
4384
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4382

def success_policy
  @success_policy
end

#synchronous_call_failure_policy ⇒ Google::Apis::IntegrationsV1alpha::EnterpriseCrmEventbusProtoFailurePolicy

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:



4389
4390
4391
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4389

def synchronous_call_failure_policy
  @synchronous_call_failure_policy
end

#task_entity ⇒ Google::Apis::IntegrationsV1alpha::EnterpriseCrmFrontendsEventbusProtoTaskEntity

Contains a task's metadata and associated information. Next available id: 7 Corresponds to the JSON property taskEntity

Returns:



4394
4395
4396
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4394

def task_entity
  @task_entity
end

#task_execution_strategy ⇒ String

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

Returns:

  • (String) 


4399
4400
4401
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4399

def task_execution_strategy
  @task_execution_strategy
end

#task_name ⇒ String

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

Returns:

  • (String) 


4404
4405
4406
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4404

def task_name
  @task_name
end

#task_number ⇒ 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_number). Corresponds to the JSON property taskNumber

Returns:

  • (String) 


4412
4413
4414
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4412

def task_number
  @task_number
end

#task_spec ⇒ String

A string template that allows user to configure task parameters (with either literal default values or tokens which will be resolved at execution time) for the task. It will eventually replace the old "parameters" field. Corresponds to the JSON property taskSpec

Returns:

  • (String) 


4419
4420
4421
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4419

def task_spec
  @task_spec
end

#task_template_name ⇒ String

Used to define task-template name if task is of type task-template Corresponds to the JSON property taskTemplateName

Returns:

  • (String) 


4424
4425
4426
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4424

def task_template_name
  @task_template_name
end

#task_type ⇒ String

Defines the type of the task Corresponds to the JSON property taskType

Returns:

  • (String) 


4429
4430
4431
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4429

def task_type
  @task_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4436

def update!(**args)
  @alert_configs = args[:alert_configs] if args.key?(:alert_configs)
  @create_time = args[:create_time] if args.key?(:create_time)
  @creator_email = args[:creator_email] if args.key?(:creator_email)
  @description = args[:description] if args.key?(:description)
  @disable_strict_type_validation = args[:disable_strict_type_validation] if args.key?(:disable_strict_type_validation)
  @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)
  @incoming_edge_count = args[:incoming_edge_count] if args.key?(:incoming_edge_count)
  @json_validation_option = args[:json_validation_option] if args.key?(:json_validation_option)
  @label = args[:label] if args.key?(:label)
  @last_modified_time = args[:last_modified_time] if args.key?(:last_modified_time)
  @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)
  @precondition = args[:precondition] if args.key?(:precondition)
  @precondition_label = args[:precondition_label] if args.key?(:precondition_label)
  @rollback_strategy = args[:rollback_strategy] if args.key?(:rollback_strategy)
  @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_entity = args[:task_entity] if args.key?(:task_entity)
  @task_execution_strategy = args[:task_execution_strategy] if args.key?(:task_execution_strategy)
  @task_name = args[:task_name] if args.key?(:task_name)
  @task_number = args[:task_number] if args.key?(:task_number)
  @task_spec = args[:task_spec] if args.key?(:task_spec)
  @task_template_name = args[:task_template_name] if args.key?(:task_template_name)
  @task_type = args[:task_type] if args.key?(:task_type)
end