Skip to main content

Class: WorkflowInteractionDefinition

sdk.v1.WorkflowInteractionDefinition

(-- api-linter: core::0123::resource-annotation=disabled aip.dev/not-precedent: The name field is optional. --) (-- api-linter: core::0203::optional=disabled --)

Implements

Constructors

constructor

new WorkflowInteractionDefinition(properties?): WorkflowInteractionDefinition

Constructs a new WorkflowInteractionDefinition.

Parameters

NameTypeDescription
properties?IWorkflowInteractionDefinitionProperties to set

Returns

WorkflowInteractionDefinition

Properties

description

description: string

An optional interaction description provided by the application. By convention, external tools may interpret its first part, i.e., ending with a line break, as a summary of the description.

Implementation of

IWorkflowInteractionDefinition.description


name

name: string

An optional name for the handler. If missing, it represents a dynamic handler that processes any interactions not handled by others. There is at most one dynamic handler per workflow and interaction kind.

Implementation of

IWorkflowInteractionDefinition.name

Methods

toJSON

toJSON(): Object

Converts this WorkflowInteractionDefinition to JSON.

Returns

Object

JSON object


create

create(properties?): WorkflowInteractionDefinition

Creates a new WorkflowInteractionDefinition instance using the specified properties.

Parameters

NameTypeDescription
properties?IWorkflowInteractionDefinitionProperties to set

Returns

WorkflowInteractionDefinition

WorkflowInteractionDefinition instance


decode

decode(reader, length?): WorkflowInteractionDefinition

Decodes a WorkflowInteractionDefinition message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

WorkflowInteractionDefinition

WorkflowInteractionDefinition

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): WorkflowInteractionDefinition

Decodes a WorkflowInteractionDefinition message from the specified reader or buffer, length delimited.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

WorkflowInteractionDefinition

WorkflowInteractionDefinition

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


encode

encode(message, writer?): Writer

Encodes the specified WorkflowInteractionDefinition message. Does not implicitly temporal.api.sdk.v1.WorkflowInteractionDefinition.verify|verify messages.

Parameters

NameTypeDescription
messageIWorkflowInteractionDefinitionWorkflowInteractionDefinition message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

Encodes the specified WorkflowInteractionDefinition message, length delimited. Does not implicitly temporal.api.sdk.v1.WorkflowInteractionDefinition.verify|verify messages.

Parameters

NameTypeDescription
messageIWorkflowInteractionDefinitionWorkflowInteractionDefinition message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): WorkflowInteractionDefinition

Creates a WorkflowInteractionDefinition message from a plain object. Also converts values to their respective internal types.

Parameters

NameTypeDescription
objectObjectPlain object

Returns

WorkflowInteractionDefinition

WorkflowInteractionDefinition


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for WorkflowInteractionDefinition

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

Creates a plain object from a WorkflowInteractionDefinition message. Also converts values to other types if specified.

Parameters

NameTypeDescription
messageWorkflowInteractionDefinitionWorkflowInteractionDefinition
options?IConversionOptionsConversion options

Returns

Object

Plain object