Skip to main content

Class: WorkflowType

common.v1.WorkflowType

Represents a WorkflowType.

Implements

Constructors

constructor

new WorkflowType(properties?)

Constructs a new WorkflowType.

Parameters

NameTypeDescription
properties?IWorkflowTypeProperties to set

Properties

name

name: string

WorkflowType name.

Implementation of

IWorkflowType.name

Methods

toJSON

toJSON(): Object

Converts this WorkflowType to JSON.

Returns

Object

JSON object


create

Static create(properties?): WorkflowType

Creates a new WorkflowType instance using the specified properties.

Parameters

NameTypeDescription
properties?IWorkflowTypeProperties to set

Returns

WorkflowType

WorkflowType instance


decode

Static decode(reader, length?): WorkflowType

Decodes a WorkflowType message from the specified reader or buffer.

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

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

Returns

WorkflowType

WorkflowType


decodeDelimited

Static decodeDelimited(reader): WorkflowType

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

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

WorkflowType

WorkflowType


encode

Static encode(message, writer?): Writer

Encodes the specified WorkflowType message. Does not implicitly temporal.api.common.v1.WorkflowType.verify|verify messages.

Parameters

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

Returns

Writer

Writer


encodeDelimited

Static encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

Static fromObject(object): WorkflowType

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

WorkflowType

WorkflowType


getTypeUrl

Static getTypeUrl(typeUrlPrefix?): string

Gets the default type url for WorkflowType

Parameters

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

Returns

string

The default type url


toObject

Static toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageWorkflowTypeWorkflowType
options?IConversionOptionsConversion options

Returns

Object

Plain object