Class: DeleteWorkerDeploymentRequest
workflowservice.v1.DeleteWorkerDeploymentRequest
Deletes records of (an old) Deployment. A deployment can only be deleted if it has no Version in it.
Implements
Constructors
constructor
• new DeleteWorkerDeploymentRequest(properties?): DeleteWorkerDeploymentRequest
Constructs a new DeleteWorkerDeploymentRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IDeleteWorkerDeploymentRequest | Properties to set |
Returns
Properties
deploymentName
• deploymentName: string
DeleteWorkerDeploymentRequest deploymentName.
Implementation of
IDeleteWorkerDeploymentRequest.deploymentName
identity
• identity: string
Optional. The identity of the client who initiated this request.
Implementation of
IDeleteWorkerDeploymentRequest.identity
namespace
• namespace: string
DeleteWorkerDeploymentRequest namespace.
Implementation of
IDeleteWorkerDeploymentRequest.namespace
Methods
toJSON
▸ toJSON(): Object
Converts this DeleteWorkerDeploymentRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): DeleteWorkerDeploymentRequest
Creates a new DeleteWorkerDeploymentRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IDeleteWorkerDeploymentRequest | Properties to set |
Returns
DeleteWorkerDeploymentRequest instance
decode
▸ decode(reader, length?): DeleteWorkerDeploymentRequest
Decodes a DeleteWorkerDeploymentRequest 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
DeleteWorkerDeploymentRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): DeleteWorkerDeploymentRequest
Decodes a DeleteWorkerDeploymentRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
DeleteWorkerDeploymentRequest
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 DeleteWorkerDeploymentRequest message. Does not implicitly temporal.api.workflowservice.v1.DeleteWorkerDeploymentRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IDeleteWorkerDeploymentRequest | DeleteWorkerDeploymentRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified DeleteWorkerDeploymentRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.DeleteWorkerDeploymentRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IDeleteWorkerDeploymentRequest | DeleteWorkerDeploymentRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): DeleteWorkerDeploymentRequest
Creates a DeleteWorkerDeploymentRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
DeleteWorkerDeploymentRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for DeleteWorkerDeploymentRequest
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 DeleteWorkerDeploymentRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | DeleteWorkerDeploymentRequest | DeleteWorkerDeploymentRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object