EnterpriseCrmEventbusProtoTaskMetadata

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

TaskMetadata are attributes that are associated to every common Task we have.

interface EnterpriseCrmEventbusProtoTaskMetadata {

activeTaskName?: string;

admins?: EnterpriseCrmEventbusProtoTaskMetadataAdmin[];

category?:

| "UNSPECIFIED_CATEGORY"

| "CUSTOM"

| "FLOW_CONTROL"

| "DATA_MANIPULATION"

| "SCRIPTING"

| "CONNECTOR"

| "HIDDEN"

| "CLOUD_SYSTEMS"

| "CUSTOM_TASK_TEMPLATE"

| "TASK_RECOMMENDATIONS";

codeSearchLink?: string;

defaultJsonValidationOption?:

| "UNSPECIFIED_JSON_VALIDATION_OPTION"

| "SKIP"

| "PRE_EXECUTION"

| "POST_EXECUTION"

| "PRE_POST_EXECUTION";

defaultSpec?: string;

description?: string;

descriptiveName?: string;

docMarkdown?: string;

externalCategory?:

| "UNSPECIFIED_EXTERNAL_CATEGORY"

| "CORE"

| "CONNECTORS"

| "EXTERNAL_HTTP"

| "EXTERNAL_INTEGRATION_SERVICES"

| "EXTERNAL_CUSTOMER_ACTIONS"

| "EXTERNAL_FLOW_CONTROL"

| "EXTERNAL_WORKSPACE"

| "EXTERNAL_SECURITY"

| "EXTERNAL_DATABASES"

| "EXTERNAL_ANALYTICS"

| "EXTERNAL_BYOC"

| "EXTERNAL_BYOT"

| "EXTERNAL_ARTIFICIAL_INTELIGENCE"

| "EXTERNAL_DATA_MANIPULATION";

externalCategorySequence?: number;

externalDocHtml?: string;

externalDocLink?: string;

externalDocMarkdown?: string;

g3DocLink?: string;

iconLink?: string;

isDeprecated?: boolean;

name?: string;

standaloneExternalDocHtml?: string;

status?: "UNSPECIFIED_STATUS" | "DEFAULT_INACTIVE" | "ACTIVE";

system?:

| "UNSPECIFIED_SYSTEM"

| "GENERIC"

| "BUGANIZER"

| "SALESFORCE"

| "CLOUD_SQL"

| "PLX"

| "SHEETS"

| "GOOGLE_GROUPS"

| "EMAIL"

| "SPANNER"

| "DATA_BRIDGE";

tags?: string[];

}

§Properties

activeTaskName?: string

[src]

The new task name to replace the current task if it is deprecated. Otherwise, it is the same as the current task name.

admins?: EnterpriseCrmEventbusProtoTaskMetadataAdmin[]

[src]

[src]

codeSearchLink?: string

[src]

The Code Search link to the Task Java file.

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

[src]

Controls whether JSON workflow parameters are validated against provided schemas before and/or after this task's execution.

defaultSpec?: string

[src]

Contains the initial configuration of the task with default values set. For now, The string should be compatible to an ASCII-proto format.

description?: string

[src]

In a few sentences, describe the purpose and usage of the task.

descriptiveName?: string

[src]

The string name to show on the task list on the Workflow editor screen. This should be a very short, one to two words name for the task. (e.g. "Send Mail")

docMarkdown?: string

[src]

Snippet of markdown documentation to embed in the RHP for this task.

[src]

externalCategorySequence?: number

[src]

Sequence with which the task in specific category to be displayed in task discovery panel for external users.

externalDocHtml?: string

[src]

External-facing documention embedded in the RHP for this task.

externalDocLink?: string

[src]

Doc link for external-facing documentation (separate from g3doc).

externalDocMarkdown?: string

[src]

DEPRECATED: Use external_doc_html.

g3DocLink?: string

[src]

URL to the associated G3 Doc for the task if available

iconLink?: string

[src]

URL to gstatic image icon for this task. This icon shows up on the task list panel along with the task name in the Workflow Editor screen. Use the 24p, 2x, gray color icon image format.

isDeprecated?: boolean

[src]

The deprecation status of the current task. Default value is false;

name?: string

[src]

The actual class name or the annotated name of the task. Task Author should initialize this field with value from the getName() method of the Task class.

standaloneExternalDocHtml?: string

[src]

External-facing documention for standalone IP in pantheon embedded in the RHP for this task. Non null only if different from external_doc_html

status?: "UNSPECIFIED_STATUS" | "DEFAULT_INACTIVE" | "ACTIVE"

[src]

Allows author to indicate if the task is ready to use or not. If not set, then it will default to INACTIVE.

[src]

tags?: string[]

[src]

A set of tags that pertain to a particular task. This can be used to improve the searchability of tasks with several names ("REST Caller" vs. "Call REST Endpoint") or to help users find tasks based on related words.