Skip to main content

Class: Response

v1.ExecuteMultiOperationResponse.Response

Represents a Response.

Implements

Constructors

constructor

new Response(properties?): Response

Constructs a new Response.

Parameters

NameTypeDescription
properties?IResponseProperties to set

Returns

Response

Properties

response

Optional response: "startWorkflow" | "updateWorkflow"

Response response.


startWorkflow

Optional startWorkflow: null | IStartWorkflowExecutionResponse

Response startWorkflow.

Implementation of

IResponse.startWorkflow


updateWorkflow

Optional updateWorkflow: null | IUpdateWorkflowExecutionResponse

Response updateWorkflow.

Implementation of

IResponse.updateWorkflow

Methods

toJSON

toJSON(): Object

Converts this Response to JSON.

Returns

Object

JSON object


create

create(properties?): Response

Creates a new Response instance using the specified properties.

Parameters

NameTypeDescription
properties?IResponseProperties to set

Returns

Response

Response instance


decode

decode(reader, length?): Response

Decodes a Response message from the specified reader or buffer.

Parameters

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

Returns

Response

Response

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): Response

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

Response

Response

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 Response message. Does not implicitly temporal.api.workflowservice.v1.ExecuteMultiOperationResponse.Response.verify|verify messages.

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

Encodes the specified Response message, length delimited. Does not implicitly temporal.api.workflowservice.v1.ExecuteMultiOperationResponse.Response.verify|verify messages.

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): Response

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

Response

Response


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for Response

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

Parameters

NameTypeDescription
messageResponseResponse
options?IConversionOptionsConversion options

Returns

Object

Plain object