Class: DescribeWorkerDeploymentResponse
workflowservice.v1.DescribeWorkerDeploymentResponse
Represents a DescribeWorkerDeploymentResponse.
Implements
Constructors
constructor
• new DescribeWorkerDeploymentResponse(properties?): DescribeWorkerDeploymentResponse
Constructs a new DescribeWorkerDeploymentResponse.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IDescribeWorkerDeploymentResponse | Properties to set |
Returns
DescribeWorkerDeploymentResponse
Properties
conflictToken
• conflictToken: Uint8Array
This value is returned so that it can be optionally passed to APIs that write to the Worker Deployment state to ensure that the state did not change between this read and a future write.
Implementation of
IDescribeWorkerDeploymentResponse.conflictToken
workerDeploymentInfo
• Optional workerDeploymentInfo: null | IWorkerDeploymentInfo
DescribeWorkerDeploymentResponse workerDeploymentInfo.
Implementation of
IDescribeWorkerDeploymentResponse.workerDeploymentInfo
Methods
toJSON
▸ toJSON(): Object
Converts this DescribeWorkerDeploymentResponse to JSON.
Returns
Object
JSON object
create
▸ create(properties?): DescribeWorkerDeploymentResponse
Creates a new DescribeWorkerDeploymentResponse instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IDescribeWorkerDeploymentResponse | Properties to set |
Returns
DescribeWorkerDeploymentResponse
DescribeWorkerDeploymentResponse instance
decode
▸ decode(reader, length?): DescribeWorkerDeploymentResponse
Decodes a DescribeWorkerDeploymentResponse message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
DescribeWorkerDeploymentResponse
DescribeWorkerDeploymentResponse
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): DescribeWorkerDeploymentResponse
Decodes a DescribeWorkerDeploymentResponse message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
DescribeWorkerDeploymentResponse
DescribeWorkerDeploymentResponse
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 DescribeWorkerDeploymentResponse message. Does not implicitly temporal.api.workflowservice.v1.DescribeWorkerDeploymentResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IDescribeWorkerDeploymentResponse | DescribeWorkerDeploymentResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified DescribeWorkerDeploymentResponse message, length delimited. Does not implicitly temporal.api.workflowservice.v1.DescribeWorkerDeploymentResponse.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IDescribeWorkerDeploymentResponse | DescribeWorkerDeploymentResponse message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): DescribeWorkerDeploymentResponse
Creates a DescribeWorkerDeploymentResponse message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
DescribeWorkerDeploymentResponse
DescribeWorkerDeploymentResponse
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for DescribeWorkerDeploymentResponse
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from a DescribeWorkerDeploymentResponse message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | DescribeWorkerDeploymentResponse | DescribeWorkerDeploymentResponse |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object