Skip to main content

Class: Acceptance

update.v1.Acceptance

An Update protocol message indicating that a Workflow Update has been accepted (i.e. passed the worker-side validation phase).

Implements

Constructors

constructor

new Acceptance(properties?): Acceptance

Constructs a new Acceptance.

Parameters

NameTypeDescription
properties?IAcceptanceProperties to set

Returns

Acceptance

Properties

acceptedRequest

Optional acceptedRequest: null | IRequest

Acceptance acceptedRequest.

Implementation of

IAcceptance.acceptedRequest


acceptedRequestMessageId

acceptedRequestMessageId: string

Acceptance acceptedRequestMessageId.

Implementation of

IAcceptance.acceptedRequestMessageId


acceptedRequestSequencingEventId

acceptedRequestSequencingEventId: Long

Acceptance acceptedRequestSequencingEventId.

Implementation of

IAcceptance.acceptedRequestSequencingEventId

Methods

toJSON

toJSON(): Object

Converts this Acceptance to JSON.

Returns

Object

JSON object


create

create(properties?): Acceptance

Creates a new Acceptance instance using the specified properties.

Parameters

NameTypeDescription
properties?IAcceptanceProperties to set

Returns

Acceptance

Acceptance instance


decode

decode(reader, length?): Acceptance

Decodes an Acceptance message from the specified reader or buffer.

Parameters

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

Returns

Acceptance

Acceptance

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): Acceptance

Decodes an Acceptance message from the specified reader or buffer, length delimited.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

Acceptance

Acceptance

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): Acceptance

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

Acceptance

Acceptance


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for Acceptance

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

Parameters

NameTypeDescription
messageAcceptanceAcceptance
options?IConversionOptionsConversion options

Returns

Object

Plain object