EnterpriseCrmEventbusProtoTaskMetadataArgs

data class EnterpriseCrmEventbusProtoTaskMetadataArgs(val activeTaskName: Output<String>? = null, val admins: Output<List<EnterpriseCrmEventbusProtoTaskMetadataAdminArgs>>? = null, val category: Output<EnterpriseCrmEventbusProtoTaskMetadataCategory>? = null, val codeSearchLink: Output<String>? = null, val defaultJsonValidationOption: Output<EnterpriseCrmEventbusProtoTaskMetadataDefaultJsonValidationOption>? = null, val defaultSpec: Output<String>? = null, val description: Output<String>? = null, val descriptiveName: Output<String>? = null, val docMarkdown: Output<String>? = null, val externalCategory: Output<EnterpriseCrmEventbusProtoTaskMetadataExternalCategory>? = null, val externalCategorySequence: Output<Int>? = null, val externalDocHtml: Output<String>? = null, val externalDocLink: Output<String>? = null, val externalDocMarkdown: Output<String>? = null, val g3DocLink: Output<String>? = null, val iconLink: Output<String>? = null, val isDeprecated: Output<Boolean>? = null, val name: Output<String>? = null, val standaloneExternalDocHtml: Output<String>? = null, val status: Output<EnterpriseCrmEventbusProtoTaskMetadataStatus>? = null, val system: Output<EnterpriseCrmEventbusProtoTaskMetadataSystem>? = null, val tags: Output<List<String>>? = null) : ConvertibleToJava<EnterpriseCrmEventbusProtoTaskMetadataArgs>

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

Constructors

fun EnterpriseCrmEventbusProtoTaskMetadataArgs(activeTaskName: Output<String>? = null, admins: Output<List<EnterpriseCrmEventbusProtoTaskMetadataAdminArgs>>? = null, category: Output<EnterpriseCrmEventbusProtoTaskMetadataCategory>? = null, codeSearchLink: Output<String>? = null, defaultJsonValidationOption: Output<EnterpriseCrmEventbusProtoTaskMetadataDefaultJsonValidationOption>? = null, defaultSpec: Output<String>? = null, description: Output<String>? = null, descriptiveName: Output<String>? = null, docMarkdown: Output<String>? = null, externalCategory: Output<EnterpriseCrmEventbusProtoTaskMetadataExternalCategory>? = null, externalCategorySequence: Output<Int>? = null, externalDocHtml: Output<String>? = null, externalDocLink: Output<String>? = null, externalDocMarkdown: Output<String>? = null, g3DocLink: Output<String>? = null, iconLink: Output<String>? = null, isDeprecated: Output<Boolean>? = null, name: Output<String>? = null, standaloneExternalDocHtml: Output<String>? = null, status: Output<EnterpriseCrmEventbusProtoTaskMetadataStatus>? = null, system: Output<EnterpriseCrmEventbusProtoTaskMetadataSystem>? = null, tags: Output<List<String>>? = null)

Functions

Link copied to clipboard
open override fun toJava(): EnterpriseCrmEventbusProtoTaskMetadataArgs

Properties

Link copied to clipboard
val activeTaskName: Output<String>? = null

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
val codeSearchLink: Output<String>? = null

The Code Search link to the Task Java file.

Link copied to clipboard

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

Link copied to clipboard
val defaultSpec: Output<String>? = null

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

Link copied to clipboard
val description: Output<String>? = null

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

Link copied to clipboard
val descriptiveName: Output<String>? = null

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

Link copied to clipboard
val docMarkdown: Output<String>? = null

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

Link copied to clipboard
val externalCategorySequence: Output<Int>? = null

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

Link copied to clipboard
val externalDocHtml: Output<String>? = null

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

Link copied to clipboard
val externalDocLink: Output<String>? = null

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

Link copied to clipboard
val externalDocMarkdown: Output<String>? = null

DEPRECATED: Use external_doc_html.

Link copied to clipboard
val g3DocLink: Output<String>? = null

URL to the associated G3 Doc for the task if available

Link copied to clipboard
val iconLink: Output<String>? = null

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.

Link copied to clipboard
val isDeprecated: Output<Boolean>? = null

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

Link copied to clipboard
val name: Output<String>? = null

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.

Link copied to clipboard
val standaloneExternalDocHtml: Output<String>? = null

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

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
val tags: Output<List<String>>? = null

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.