Skip to main content

Class: NexusOperationCompletedEventAttributes

history.v1.NexusOperationCompletedEventAttributes

Nexus operation completed successfully.

Implements

Constructors

constructor

new NexusOperationCompletedEventAttributes(properties?): NexusOperationCompletedEventAttributes

Constructs a new NexusOperationCompletedEventAttributes.

Parameters

NameTypeDescription
properties?INexusOperationCompletedEventAttributesProperties to set

Returns

NexusOperationCompletedEventAttributes

Properties

requestId

requestId: string

The request ID allocated at schedule time.

Implementation of

INexusOperationCompletedEventAttributes.requestId


result

Optional result: null | IPayload

Serialized result of the Nexus operation. The response of the Nexus handler. Delivered either via a completion callback or as a response to a synchronous operation.

Implementation of

INexusOperationCompletedEventAttributes.result


scheduledEventId

scheduledEventId: Long

The ID of the NEXUS_OPERATION_SCHEDULED event. Uniquely identifies this operation.

Implementation of

INexusOperationCompletedEventAttributes.scheduledEventId

Methods

toJSON

toJSON(): Object

Converts this NexusOperationCompletedEventAttributes to JSON.

Returns

Object

JSON object


create

create(properties?): NexusOperationCompletedEventAttributes

Creates a new NexusOperationCompletedEventAttributes instance using the specified properties.

Parameters

NameTypeDescription
properties?INexusOperationCompletedEventAttributesProperties to set

Returns

NexusOperationCompletedEventAttributes

NexusOperationCompletedEventAttributes instance


decode

decode(reader, length?): NexusOperationCompletedEventAttributes

Decodes a NexusOperationCompletedEventAttributes message from the specified reader or buffer.

Parameters

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

Returns

NexusOperationCompletedEventAttributes

NexusOperationCompletedEventAttributes

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): NexusOperationCompletedEventAttributes

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

NexusOperationCompletedEventAttributes

NexusOperationCompletedEventAttributes

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): NexusOperationCompletedEventAttributes

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

NexusOperationCompletedEventAttributes

NexusOperationCompletedEventAttributes


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for NexusOperationCompletedEventAttributes

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

Parameters

NameTypeDescription
messageNexusOperationCompletedEventAttributesNexusOperationCompletedEventAttributes
options?IConversionOptionsConversion options

Returns

Object

Plain object