pulumi-google-native-kotlin/com.pulumi.googlenative.integrations.v1alpha.kotlin.outputs/EnterpriseCrmEventbusProtoTaskMetadataResponse

EnterpriseCrmEventbusProtoTaskMetadataResponse

data class EnterpriseCrmEventbusProtoTaskMetadataResponse(val activeTaskName: String, val admins: List<EnterpriseCrmEventbusProtoTaskMetadataAdminResponse>, val category: String, val codeSearchLink: String, val defaultJsonValidationOption: String, val defaultSpec: String, val description: String, val descriptiveName: String, val docMarkdown: String, val externalCategory: String, val externalCategorySequence: Int, val externalDocHtml: String, val externalDocLink: String, val externalDocMarkdown: String, val g3DocLink: String, val iconLink: String, val isDeprecated: Boolean, val name: String, val standaloneExternalDocHtml: String, val status: String, val system: String, val tags: List<String>)

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

Constructors

EnterpriseCrmEventbusProtoTaskMetadataResponse

fun EnterpriseCrmEventbusProtoTaskMetadataResponse(activeTaskName: String, admins: List<EnterpriseCrmEventbusProtoTaskMetadataAdminResponse>, category: String, codeSearchLink: String, defaultJsonValidationOption: String, defaultSpec: String, description: String, descriptiveName: String, docMarkdown: String, externalCategory: String, externalCategorySequence: Int, externalDocHtml: String, externalDocLink: String, externalDocMarkdown: String, g3DocLink: String, iconLink: String, isDeprecated: Boolean, name: String, standaloneExternalDocHtml: String, status: String, system: String, tags: List<String>)

Types

object Companion

Properties

val 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.

val admins: List<EnterpriseCrmEventbusProtoTaskMetadataAdminResponse>

val category: String

val codeSearchLink: String

The Code Search link to the Task Java file.

defaultJsonValidationOption

val defaultJsonValidationOption: String

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

val 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.

val description: String

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

descriptiveName

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

val docMarkdown: String

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

externalCategory

val externalCategory: String

externalCategorySequence

val externalCategorySequence: Int

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

externalDocHtml

val externalDocHtml: String

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

externalDocLink

val externalDocLink: String

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

externalDocMarkdown

val ~~externalDocMarkdown~~: String

DEPRECATED: Use external_doc_html.

val g3DocLink: String

URL to the associated G3 Doc for the task if available

val iconLink: String

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.

val isDeprecated: Boolean

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

val 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.

standaloneExternalDocHtml

val standaloneExternalDocHtml: String

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

val status: String

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

val system: String

val tags: List<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.