Skip to main content

Class: StartOperationResponse

nexus.v1.StartOperationResponse

Response variant for StartOperationRequest.

Implements

Constructors

constructor

new StartOperationResponse(properties?): StartOperationResponse

Constructs a new StartOperationResponse.

Parameters

NameTypeDescription
properties?IStartOperationResponseProperties to set

Returns

StartOperationResponse

Properties

asyncSuccess

Optional asyncSuccess: null | IAsync

StartOperationResponse asyncSuccess.

Implementation of

IStartOperationResponse.asyncSuccess


operationError

Optional operationError: null | IUnsuccessfulOperationError

The operation completed unsuccessfully (failed or canceled).

Implementation of

IStartOperationResponse.operationError


syncSuccess

Optional syncSuccess: null | ISync

StartOperationResponse syncSuccess.

Implementation of

IStartOperationResponse.syncSuccess


variant

Optional variant: "syncSuccess" | "asyncSuccess" | "operationError"

StartOperationResponse variant.

Methods

toJSON

toJSON(): Object

Converts this StartOperationResponse to JSON.

Returns

Object

JSON object


create

create(properties?): StartOperationResponse

Creates a new StartOperationResponse instance using the specified properties.

Parameters

NameTypeDescription
properties?IStartOperationResponseProperties to set

Returns

StartOperationResponse

StartOperationResponse instance


decode

decode(reader, length?): StartOperationResponse

Decodes a StartOperationResponse message from the specified reader or buffer.

Parameters

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

Returns

StartOperationResponse

StartOperationResponse

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): StartOperationResponse

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

StartOperationResponse

StartOperationResponse

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): StartOperationResponse

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

StartOperationResponse

StartOperationResponse


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for StartOperationResponse

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

Parameters

NameTypeDescription
messageStartOperationResponseStartOperationResponse
options?IConversionOptionsConversion options

Returns

Object

Plain object