Skip to main content

Class: CreateWorkerDeploymentResponse

workflowservice.v1.CreateWorkerDeploymentResponse

Represents a CreateWorkerDeploymentResponse.

Properties​

conflictToken​

• conflictToken: Uint8Array

This value is returned so that it can be optionally passed to APIs that write to the WorkerDeployment state to ensure that the state did not change between this API call and a future write.

Methods​

toJSON​

▸ toJSON(): Object

Converts this CreateWorkerDeploymentResponse to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): CreateWorkerDeploymentResponse & $Properties

Creates a new CreateWorkerDeploymentResponse instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

CreateWorkerDeploymentResponse & $Properties

CreateWorkerDeploymentResponse instance

▸ create(properties?): CreateWorkerDeploymentResponse

Parameters​

NameType
properties?$Properties

Returns​

CreateWorkerDeploymentResponse


decode​

▸ decode(reader, length?): CreateWorkerDeploymentResponse & $Properties

Decodes a CreateWorkerDeploymentResponse message from the specified reader or buffer.

Parameters​

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

Returns​

CreateWorkerDeploymentResponse & $Properties

CreateWorkerDeploymentResponse

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): CreateWorkerDeploymentResponse & $Properties

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

CreateWorkerDeploymentResponse & $Properties

CreateWorkerDeploymentResponse

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

Parameters​

NameTypeDescription
message$PropertiesCreateWorkerDeploymentResponse message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

NameTypeDescription
message$PropertiesCreateWorkerDeploymentResponse message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): CreateWorkerDeploymentResponse

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

CreateWorkerDeploymentResponse

CreateWorkerDeploymentResponse


toObject​

▸ toObject(message, options?): Object

Creates a plain object from a CreateWorkerDeploymentResponse message. Also converts values to other types if specified.

Parameters​

NameTypeDescription
messageCreateWorkerDeploymentResponseCreateWorkerDeploymentResponse
options?IConversionOptionsConversion options

Returns​

Object

Plain object