EnterpriseCrmFrontendsEventbusProtoTaskConfig class

The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.

Constructors

EnterpriseCrmFrontendsEventbusProtoTaskConfig({Input<List<EnterpriseCrmEventbusProtoTaskAlertConfig>>? alertConfigs, Input<String>? createTime, Input<String>? creatorEmail, Input<String>? description, Input<bool>? disableStrictTypeValidation, Input<String>? errorCatcherId, Input<EnterpriseCrmFrontendsEventbusProtoTaskConfigExternalTaskType>? externalTaskType, Input<EnterpriseCrmEventbusProtoFailurePolicy>? failurePolicy, Input<int>? incomingEdgeCount, Input<EnterpriseCrmFrontendsEventbusProtoTaskConfigJsonValidationOption>? jsonValidationOption, Input<String>? label, Input<String>? lastModifiedTime, Input<List<EnterpriseCrmEventbusProtoNextTask>>? nextTasks, Input<EnterpriseCrmFrontendsEventbusProtoTaskConfigNextTasksExecutionPolicy>? nextTasksExecutionPolicy, Input<Map<String, String>>? parameters, Input<EnterpriseCrmEventbusProtoCoordinate>? position, Input<String>? precondition, Input<String>? preconditionLabel, Input<EnterpriseCrmFrontendsEventbusProtoRollbackStrategy>? rollbackStrategy, Input<EnterpriseCrmEventbusProtoSuccessPolicy>? successPolicy, Input<EnterpriseCrmEventbusProtoFailurePolicy>? synchronousCallFailurePolicy, Input<EnterpriseCrmFrontendsEventbusProtoTaskEntity>? taskEntity, Input<EnterpriseCrmFrontendsEventbusProtoTaskConfigTaskExecutionStrategy>? taskExecutionStrategy, Input<String>? taskName, Input<String>? taskNumber, Input<String>? taskSpec, Input<String>? taskTemplateName, Input<EnterpriseCrmFrontendsEventbusProtoTaskConfigTaskType>? taskType})
Creates a new EnterpriseCrmFrontendsEventbusProtoTaskConfig. alertConfigs Alert configurations on error rate, warning rate, number of runs, durations, etc. createTime Auto-generated. creatorEmail The creator's email address. Auto-generated from the user's email. description User-provided description intended to give more business context about the task. disableStrictTypeValidation 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. errorCatcherId Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task externalTaskType Optional. failurePolicy Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.). incomingEdgeCount The number of edges leading into this TaskConfig. jsonValidationOption If set, overrides the option configured in the Task implementation class. label User-provided label that is attached to this TaskConfig in the UI. lastModifiedTime Auto-generated. nextTasks 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. nextTasksExecutionPolicy The policy dictating the execution of the next set of tasks for the current task. parameters The customized parameters the user can pass to this task. position Optional. Informs the front-end application where to draw this task config on the UI. precondition 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. preconditionLabel Optional. User-provided label that is attached to precondition in the UI. rollbackStrategy Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times). successPolicy Determines what action to take upon successful task completion. synchronousCallFailurePolicy 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). taskEntity Copy of the task entity that this task config is an instance of. taskExecutionStrategy The policy dictating the execution strategy of this task. taskName The name for the task. taskNumber 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). taskSpec 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. taskTemplateName Used to define task-template name if task is of type task-template taskType Defines the type of the task
const
EnterpriseCrmFrontendsEventbusProtoTaskConfig.fromMap(Map<String, dynamic> map)
factory

Properties

alertConfigs → Input<List<EnterpriseCrmEventbusProtoTaskAlertConfig>>?
Alert configurations on error rate, warning rate, number of runs, durations, etc.
final
createTime → Input<String>?
Auto-generated.
final
creatorEmail → Input<String>?
The creator's email address. Auto-generated from the user's email.
final
description → Input<String>?
User-provided description intended to give more business context about the task.
final
disableStrictTypeValidation → Input<bool>?
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.
final
errorCatcherId → Input<String>?
Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
final
externalTaskType → Input<EnterpriseCrmFrontendsEventbusProtoTaskConfigExternalTaskType>?
final
failurePolicy → Input<EnterpriseCrmEventbusProtoFailurePolicy>?
Optional. Determines the number of times the task will be retried on failure and with what retry strategy. This is applicable for asynchronous calls to Eventbus alone (Post To Queue, Schedule etc.).
final
hashCode → int
The hash code for this object.
no setterinherited
incomingEdgeCount → Input<int>?
The number of edges leading into this TaskConfig.
final
jsonValidationOption → Input<EnterpriseCrmFrontendsEventbusProtoTaskConfigJsonValidationOption>?
If set, overrides the option configured in the Task implementation class.
final
label → Input<String>?
User-provided label that is attached to this TaskConfig in the UI.
final
lastModifiedTime → Input<String>?
Auto-generated.
final
nextTasks → Input<List<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.
final
nextTasksExecutionPolicy → Input<EnterpriseCrmFrontendsEventbusProtoTaskConfigNextTasksExecutionPolicy>?
The policy dictating the execution of the next set of tasks for the current task.
final
parameters → Input<Map<String, String>>?
The customized parameters the user can pass to this task.
final
position → Input<EnterpriseCrmEventbusProtoCoordinate>?
Optional. Informs the front-end application where to draw this task config on the UI.
final
precondition → Input<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.
final
preconditionLabel → Input<String>?
Optional. User-provided label that is attached to precondition in the UI.
final
rollbackStrategy → Input<EnterpriseCrmFrontendsEventbusProtoRollbackStrategy>?
Optional. Contains information about what needs to be done upon failure (either a permanent error or after it has been retried too many times).
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
successPolicy → Input<EnterpriseCrmEventbusProtoSuccessPolicy>?
Determines what action to take upon successful task completion.
final
synchronousCallFailurePolicy → Input<EnterpriseCrmEventbusProtoFailurePolicy>?
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).
final
taskEntity → Input<EnterpriseCrmFrontendsEventbusProtoTaskEntity>?
Copy of the task entity that this task config is an instance of.
final
taskExecutionStrategy → Input<EnterpriseCrmFrontendsEventbusProtoTaskConfigTaskExecutionStrategy>?
The policy dictating the execution strategy of this task.
final
taskName → Input<String>?
The name for the task.
final
taskNumber → Input<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).
final
taskSpec → Input<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.
final
taskTemplateName → Input<String>?
Used to define task-template name if task is of type task-template
final
taskType → Input<EnterpriseCrmFrontendsEventbusProtoTaskConfigTaskType>?
Defines the type of the task
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited