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.



4340
4341
4342
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4340

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:



4180
4181
4182
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4180

def alert_configs
  @alert_configs
end

#create_time ⇒ String

Auto-generated. Corresponds to the JSON property createTime

Returns:

  • (String) 


4185
4186
4187
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4185

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) 


4190
4191
4192
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4190

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) 


4196
4197
4198
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4196

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) 


4206
4207
4208
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4206

def disable_strict_type_validation
  @disable_strict_type_validation
end

#error_catcher_config_id ⇒ String

Optional Error catcher config id of the error catch flow which will be executed when execution error happens in the task Corresponds to the JSON property errorCatcherConfigId

Returns:

  • (String) 


4213
4214
4215
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4213

def error_catcher_config_id
  @error_catcher_config_id
end

#external_task_type ⇒ String

Corresponds to the JSON property externalTaskType

Returns:

  • (String) 


4218
4219
4220
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4218

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:



4225
4226
4227
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4225

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) 


4230
4231
4232
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4230

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) 


4235
4236
4237
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4235

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) 


4240
4241
4242
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4240

def label
  @label
end

#last_modified_time ⇒ String

Auto-generated. Corresponds to the JSON property lastModifiedTime

Returns:

  • (String) 


4245
4246
4247
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4245

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:



4253
4254
4255
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4253

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) 


4259
4260
4261
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4259

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:



4264
4265
4266
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4264

def parameters
  @parameters
end

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

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

Returns:



4269
4270
4271
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4269

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) 


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

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) 


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

def precondition_label
  @precondition_label
end

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

Next available id: 4 Corresponds to the JSON property rollbackStrategy

Returns:



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

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:



4291
4292
4293
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4291

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:



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

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:



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

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) 


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

def task_execution_strategy
  @task_execution_strategy
end

#task_name ⇒ String

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

Returns:

  • (String) 


4313
4314
4315
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4313

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) 


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

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) 


4328
4329
4330
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4328

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) 


4333
4334
4335
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4333

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) 


4338
4339
4340
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4338

def task_type
  @task_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
 
# File 'lib/google/apis/integrations_v1alpha/classes.rb', line 4345

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_config_id = args[:error_catcher_config_id] if args.key?(:error_catcher_config_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