Skip to main content

Class: WorkflowExecutionUpdateAdmittedEventAttributes

history.v1.WorkflowExecutionUpdateAdmittedEventAttributes

Represents a WorkflowExecutionUpdateAdmittedEventAttributes.

Implements

Constructors

constructor

new WorkflowExecutionUpdateAdmittedEventAttributes(properties?): WorkflowExecutionUpdateAdmittedEventAttributes

Constructs a new WorkflowExecutionUpdateAdmittedEventAttributes.

Parameters

NameTypeDescription
properties?IWorkflowExecutionUpdateAdmittedEventAttributesProperties to set

Returns

WorkflowExecutionUpdateAdmittedEventAttributes

Properties

origin

origin: UpdateAdmittedEventOrigin

An explanation of why this event was written to history.

Implementation of

IWorkflowExecutionUpdateAdmittedEventAttributes.origin


request

Optional request: null | IRequest

The update request associated with this event.

Implementation of

IWorkflowExecutionUpdateAdmittedEventAttributes.request

Methods

toJSON

toJSON(): Object

Converts this WorkflowExecutionUpdateAdmittedEventAttributes to JSON.

Returns

Object

JSON object


create

create(properties?): WorkflowExecutionUpdateAdmittedEventAttributes

Creates a new WorkflowExecutionUpdateAdmittedEventAttributes instance using the specified properties.

Parameters

NameTypeDescription
properties?IWorkflowExecutionUpdateAdmittedEventAttributesProperties to set

Returns

WorkflowExecutionUpdateAdmittedEventAttributes

WorkflowExecutionUpdateAdmittedEventAttributes instance


decode

decode(reader, length?): WorkflowExecutionUpdateAdmittedEventAttributes

Decodes a WorkflowExecutionUpdateAdmittedEventAttributes message from the specified reader or buffer.

Parameters

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

Returns

WorkflowExecutionUpdateAdmittedEventAttributes

WorkflowExecutionUpdateAdmittedEventAttributes

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): WorkflowExecutionUpdateAdmittedEventAttributes

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

WorkflowExecutionUpdateAdmittedEventAttributes

WorkflowExecutionUpdateAdmittedEventAttributes

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 WorkflowExecutionUpdateAdmittedEventAttributes message. Does not implicitly temporal.api.history.v1.WorkflowExecutionUpdateAdmittedEventAttributes.verify|verify messages.

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): WorkflowExecutionUpdateAdmittedEventAttributes

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

WorkflowExecutionUpdateAdmittedEventAttributes

WorkflowExecutionUpdateAdmittedEventAttributes


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for WorkflowExecutionUpdateAdmittedEventAttributes

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 WorkflowExecutionUpdateAdmittedEventAttributes message. Also converts values to other types if specified.

Parameters

NameTypeDescription
messageWorkflowExecutionUpdateAdmittedEventAttributesWorkflowExecutionUpdateAdmittedEventAttributes
options?IConversionOptionsConversion options

Returns

Object

Plain object