Class: SetCurrentDeploymentRequest
workflowservice.v1.SetCurrentDeploymentRequest
[cleanup-wv-pre-release] Pre-release deployment APIs, clean up later
Properties
deployment
• Optional deployment: null | $Properties
SetCurrentDeploymentRequest deployment.
identity
• identity: string
Optional. The identity of the client who initiated this request.
namespace
• namespace: string
SetCurrentDeploymentRequest namespace.
updateMetadata
• Optional updateMetadata: null | $Properties
Optional. Use to add or remove user-defined metadata entries. Metadata entries are exposed when describing a deployment. It is a good place for information such as operator name, links to internal deployment pipelines, etc.
Methods
toJSON
▸ toJSON(): Object
Converts this SetCurrentDeploymentRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): SetCurrentDeploymentRequest & $Properties
Creates a new SetCurrentDeploymentRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
SetCurrentDeploymentRequest & $Properties
SetCurrentDeploymentRequest instance
▸ create(properties?): SetCurrentDeploymentRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): SetCurrentDeploymentRequest & $Properties
Decodes a SetCurrentDeploymentRequest 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
SetCurrentDeploymentRequest & $Properties
SetCurrentDeploymentRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): SetCurrentDeploymentRequest & $Properties
Decodes a SetCurrentDeploymentRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
SetCurrentDeploymentRequest & $Properties
SetCurrentDeploymentRequest
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 SetCurrentDeploymentRequest message. Does not implicitly temporal.api.workflowservice.v1.SetCurrentDeploymentRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | SetCurrentDeploymentRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified SetCurrentDeploymentRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.SetCurrentDeploymentRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | SetCurrentDeploymentRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): SetCurrentDeploymentRequest
Creates a SetCurrentDeploymentRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
SetCurrentDeploymentRequest
toObject
▸ toObject(message, options?): Object
Creates a plain object from a SetCurrentDeploymentRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | SetCurrentDeploymentRequest | SetCurrentDeploymentRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object