Class: SetWorkerDeploymentManagerRequest
workflowservice.v1.SetWorkerDeploymentManagerRequest
Update the ManagerIdentity of a Worker Deployment.
Implements
Constructors
constructor
• new SetWorkerDeploymentManagerRequest(properties?): SetWorkerDeploymentManagerRequest
Constructs a new SetWorkerDeploymentManagerRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ISetWorkerDeploymentManagerRequest | Properties to set |
Returns
SetWorkerDeploymentManagerRequest
Properties
conflictToken
• conflictToken: Uint8Array
Optional. This can be the value of conflict_token from a Describe, or another Worker Deployment API. Passing a non-nil conflict token will cause this request to fail if the Deployment's configuration has been modified between the API call that generated the token and this one.
Implementation of
ISetWorkerDeploymentManagerRequest.conflictToken
deploymentName
• deploymentName: string
SetWorkerDeploymentManagerRequest deploymentName.
Implementation of
ISetWorkerDeploymentManagerRequest.deploymentName
identity
• identity: string
Required. The identity of the client who initiated this request.
Implementation of
ISetWorkerDeploymentManagerRequest.identity
managerIdentity
• Optional managerIdentity: null | string
Arbitrary value for manager_identity.
Empty will unset the field.
Implementation of
ISetWorkerDeploymentManagerRequest.managerIdentity
namespace
• namespace: string
SetWorkerDeploymentManagerRequest namespace.
Implementation of
ISetWorkerDeploymentManagerRequest.namespace
newManagerIdentity
• Optional newManagerIdentity: "managerIdentity" | "self"
SetWorkerDeploymentManagerRequest newManagerIdentity.
self
• Optional self: null | boolean
True will set manager_identity to identity.
Implementation of
ISetWorkerDeploymentManagerRequest.self
Methods
toJSON
▸ toJSON(): Object
Converts this SetWorkerDeploymentManagerRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): SetWorkerDeploymentManagerRequest
Creates a new SetWorkerDeploymentManagerRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | ISetWorkerDeploymentManagerRequest | Properties to set |
Returns
SetWorkerDeploymentManagerRequest
SetWorkerDeploymentManagerRequest instance
decode
▸ decode(reader, length?): SetWorkerDeploymentManagerRequest
Decodes a SetWorkerDeploymentManagerRequest 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
SetWorkerDeploymentManagerRequest
SetWorkerDeploymentManagerRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): SetWorkerDeploymentManagerRequest
Decodes a SetWorkerDeploymentManagerRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
SetWorkerDeploymentManagerRequest
SetWorkerDeploymentManagerRequest
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 SetWorkerDeploymentManagerRequest message. Does not implicitly temporal.api.workflowservice.v1.SetWorkerDeploymentManagerRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ISetWorkerDeploymentManagerRequest | SetWorkerDeploymentManagerRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified SetWorkerDeploymentManagerRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.SetWorkerDeploymentManagerRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | ISetWorkerDeploymentManagerRequest | SetWorkerDeploymentManagerRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): SetWorkerDeploymentManagerRequest
Creates a SetWorkerDeploymentManagerRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
SetWorkerDeploymentManagerRequest
SetWorkerDeploymentManagerRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for SetWorkerDeploymentManagerRequest
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 SetWorkerDeploymentManagerRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | SetWorkerDeploymentManagerRequest | SetWorkerDeploymentManagerRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object