EnterpriseCrmFrontendsEventbusProtoTaskConfig

import type { EnterpriseCrmFrontendsEventbusProtoTaskConfig } from "https://googleapis.deno.dev/v1/integrations:v1.ts";

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

interface EnterpriseCrmFrontendsEventbusProtoTaskConfig {

alertConfigs?: EnterpriseCrmEventbusProtoTaskAlertConfig[];

createTime?: Date;

creatorEmail?: string;

description?: string;

disableStrictTypeValidation?: boolean;

errorCatcherId?: string;

externalTaskType?: "EXTERNAL_TASK_TYPE_UNSPECIFIED" | "NORMAL_TASK" | "ERROR_TASK";

failurePolicy?: EnterpriseCrmEventbusProtoFailurePolicy;

incomingEdgeCount?: number;

jsonValidationOption?:

| "UNSPECIFIED_JSON_VALIDATION_OPTION"

| "SKIP"

| "PRE_EXECUTION"

| "POST_EXECUTION"

| "PRE_POST_EXECUTION";

label?: string;

lastModifiedTime?: Date;

nextTasks?: EnterpriseCrmEventbusProtoNextTask[];

nextTasksExecutionPolicy?: "UNSPECIFIED" | "RUN_ALL_MATCH" | "RUN_FIRST_MATCH";

parameters?: {

[key: string]: EnterpriseCrmFrontendsEventbusProtoParameterEntry;

};

position?: EnterpriseCrmEventbusProtoCoordinate;

precondition?: string;

preconditionLabel?: string;

rollbackStrategy?: EnterpriseCrmFrontendsEventbusProtoRollbackStrategy;

successPolicy?: EnterpriseCrmEventbusProtoSuccessPolicy;

synchronousCallFailurePolicy?: EnterpriseCrmEventbusProtoFailurePolicy;

taskEntity?: EnterpriseCrmFrontendsEventbusProtoTaskEntity;

taskExecutionStrategy?: "WHEN_ALL_SUCCEED" | "WHEN_ANY_SUCCEED" | "WHEN_ALL_TASKS_AND_CONDITIONS_SUCCEED";

taskName?: string;

taskNumber?: string;

taskSpec?: string;

taskTemplateName?: string;

taskType?: "TASK" | "ASIS_TEMPLATE" | "IO_TEMPLATE";

}

§Properties

alertConfigs?: EnterpriseCrmEventbusProtoTaskAlertConfig[]

[src]

Alert configurations on error rate, warning rate, number of runs, durations, etc.

createTime?: Date

[src]

Auto-generated.

creatorEmail?: string

[src]

The creator's email address. Auto-generated from the user's email.

description?: string

[src]

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

disableStrictTypeValidation?: boolean

[src]

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?: string

[src]

Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task

externalTaskType?: "EXTERNAL_TASK_TYPE_UNSPECIFIED" | "NORMAL_TASK" | "ERROR_TASK"

[src]

failurePolicy?: EnterpriseCrmEventbusProtoFailurePolicy

[src]

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?: number

[src]

The number of edges leading into this TaskConfig.

jsonValidationOption?: "UNSPECIFIED_JSON_VALIDATION_OPTION" | "SKIP" | "PRE_EXECUTION" | "POST_EXECUTION" | "PRE_POST_EXECUTION"

[src]

If set, overrides the option configured in the Task implementation class.

label?: string

[src]

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

lastModifiedTime?: Date

[src]

Auto-generated.

nextTasks?: EnterpriseCrmEventbusProtoNextTask[]

[src]

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?: "UNSPECIFIED" | "RUN_ALL_MATCH" | "RUN_FIRST_MATCH"

[src]

The policy dictating the execution of the next set of tasks for the current task.

parameters?: {

[key: string]: EnterpriseCrmFrontendsEventbusProtoParameterEntry;

}

[src]

The customized parameters the user can pass to this task.

position?: EnterpriseCrmEventbusProtoCoordinate

[src]

Optional. Informs the front-end application where to draw this task config on the UI.

precondition?: string

[src]

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?: string

[src]

Optional. User-provided label that is attached to precondition in the UI.

rollbackStrategy?: EnterpriseCrmFrontendsEventbusProtoRollbackStrategy

[src]

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?: EnterpriseCrmEventbusProtoSuccessPolicy

[src]

Determines what action to take upon successful task completion.

synchronousCallFailurePolicy?: EnterpriseCrmEventbusProtoFailurePolicy

[src]

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?: EnterpriseCrmFrontendsEventbusProtoTaskEntity

[src]

Copy of the task entity that this task config is an instance of.

taskExecutionStrategy?: "WHEN_ALL_SUCCEED" | "WHEN_ANY_SUCCEED" | "WHEN_ALL_TASKS_AND_CONDITIONS_SUCCEED"

[src]

The policy dictating the execution strategy of this task.

taskName?: string

[src]

The name for the task.

taskNumber?: string

[src]

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?: string

[src]

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?: string

[src]

Used to define task-template name if task is of type task-template

taskType?: "TASK" | "ASIS_TEMPLATE" | "IO_TEMPLATE"

[src]

Defines the type of the task