Class: Google::Apis::IntegrationsV1::EnterpriseCrmFrontendsEventbusProtoTaskConfig

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

Returns a new instance of EnterpriseCrmFrontendsEventbusProtoTaskConfig.



4652
4653
4654
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4652

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

Instance Attribute Details

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

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

Returns:



4485
4486
4487
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4485

def alert_configs
  @alert_configs
end

#conditional_failure_policies ⇒ Google::Apis::IntegrationsV1::EnterpriseCrmEventbusProtoConditionalFailurePolicies

Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for synchronous calls to Eventbus alone (Post). Corresponds to the JSON property conditionalFailurePolicies

Returns:



4492
4493
4494
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4492

def conditional_failure_policies
  @conditional_failure_policies
end

#create_time ⇒ String

Auto-generated. Corresponds to the JSON property createTime

Returns:

  • (String) 


4497
4498
4499
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4497

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) 


4502
4503
4504
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4502

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) 


4508
4509
4510
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4508

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) 


4518
4519
4520
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4518

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) 


4525
4526
4527
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4525

def error_catcher_id
  @error_catcher_id
end

#external_task_type ⇒ String

Corresponds to the JSON property externalTaskType

Returns:

  • (String) 


4530
4531
4532
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4530

def external_task_type
  @external_task_type
end

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



4537
4538
4539
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4537

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) 


4542
4543
4544
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4542

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) 


4547
4548
4549
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4547

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) 


4552
4553
4554
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4552

def label
  @label
end

#last_modified_time ⇒ String

Auto-generated. Corresponds to the JSON property lastModifiedTime

Returns:

  • (String) 


4557
4558
4559
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4557

def last_modified_time
  @last_modified_time
end

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



4565
4566
4567
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4565

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) 


4571
4572
4573
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4571

def next_tasks_execution_policy
  @next_tasks_execution_policy
end

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

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

Returns:



4576
4577
4578
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4576

def parameters
  @parameters
end

#position ⇒ Google::Apis::IntegrationsV1::EnterpriseCrmEventbusProtoCoordinate

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

Returns:



4581
4582
4583
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4581

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) 


4588
4589
4590
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4588

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) 


4593
4594
4595
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4593

def precondition_label
  @precondition_label
end

#rollback_strategy ⇒ Google::Apis::IntegrationsV1::EnterpriseCrmFrontendsEventbusProtoRollbackStrategy

Next available id: 4 Corresponds to the JSON property rollbackStrategy

Returns:



4598
4599
4600
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4598

def rollback_strategy
  @rollback_strategy
end

#success_policy ⇒ Google::Apis::IntegrationsV1::EnterpriseCrmEventbusProtoSuccessPolicy

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

Returns:



4603
4604
4605
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4603

def success_policy
  @success_policy
end

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



4610
4611
4612
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4610

def synchronous_call_failure_policy
  @synchronous_call_failure_policy
end

#task_entity ⇒ Google::Apis::IntegrationsV1::EnterpriseCrmFrontendsEventbusProtoTaskEntity

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

Returns:



4615
4616
4617
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4615

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) 


4620
4621
4622
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4620

def task_execution_strategy
  @task_execution_strategy
end

#task_name ⇒ String

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

Returns:

  • (String) 


4625
4626
4627
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4625

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) 


4633
4634
4635
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4633

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) 


4640
4641
4642
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4640

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) 


4645
4646
4647
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4645

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) 


4650
4651
4652
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4650

def task_type
  @task_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
 
# File 'lib/google/apis/integrations_v1/classes.rb', line 4657

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