TaskMetadata

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

Next available: 25

JSON representation
{
  "admins": [
    {
      object (Admin)
    }
  ],
  "name": string,
  "descriptiveName": string,
  "description": string,
  "defaultSpec": string,
  "g3DocLink": string,
  "iconLink": string,
  "status": enum (Status),
  "codeSearchLink": string,
  "isDeprecated": boolean,
  "activeTaskName": string,
  "docMarkdown": string,
  "category": enum (Category),
  "system": enum (System),
  "defaultJsonValidationOption": enum (JsonValidationOption),
  "tags": [
    string
  ],
  "externalCategory": enum (ExternalCategory),
  "externalCategorySequence": integer,
  "externalDocMarkdown": string,
  "externalDocHtml": string,
  "externalDocLink": string
}
Fields
admins[]

object (Admin)

name

string

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.

descriptiveName

string

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")

description

string

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

defaultSpec

string

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

status

enum (Status)

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

isDeprecated

boolean

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

activeTaskName

string

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

docMarkdown

string

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

category

enum (Category)

system

enum (System)

defaultJsonValidationOption

enum (JsonValidationOption)

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

tags[]

string

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.

externalCategory

enum (ExternalCategory)

externalCategorySequence

integer

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

externalDocMarkdown

string

DEPRECATED: Use externalDocHtml.

externalDocHtml

string

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

Admin

Admins are owners of a Task, and have all permissions on a particular task identified by the task name. By default, Eventbus periodically scans all task metadata and syncs (adds) any new admins defined here to Zanzibar.

JSON representation
{

  // Union field admin_user can be only one of the following:
  "userEmail": string,
  "googleGroupEmail": string
  // End of list of possible types for union field admin_user.
}
Fields
Union field admin_user. This can be the username of an individual user or a Google group that owns the Task implementation class. Use the full email with @domain. admin_user can be only one of the following:
userEmail

string

googleGroupEmail

string