Class: UpdateDeploymentMetadata
deployment.v1.UpdateDeploymentMetadata
Used as part of Deployment write APIs to update metadata attached to a deployment.
Implements
Constructors
constructor
• new UpdateDeploymentMetadata(properties?): UpdateDeploymentMetadata
Constructs a new UpdateDeploymentMetadata.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IUpdateDeploymentMetadata | Properties to set |
Returns
Properties
removeEntries
• removeEntries: string[]
List of keys to remove from the metadata.
Implementation of
IUpdateDeploymentMetadata.removeEntries
upsertEntries
• upsertEntries: Object
UpdateDeploymentMetadata upsertEntries.
Index signature
▪ [k: string]: IPayload
Implementation of
IUpdateDeploymentMetadata.upsertEntries
Methods
toJSON
▸ toJSON(): Object
Converts this UpdateDeploymentMetadata to JSON.
Returns
Object
JSON object
create
▸ create(properties?): UpdateDeploymentMetadata
Creates a new UpdateDeploymentMetadata instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IUpdateDeploymentMetadata | Properties to set |
Returns
UpdateDeploymentMetadata instance
decode
▸ decode(reader, length?): UpdateDeploymentMetadata
Decodes an UpdateDeploymentMetadata 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
UpdateDeploymentMetadata
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): UpdateDeploymentMetadata
Decodes an UpdateDeploymentMetadata message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
UpdateDeploymentMetadata
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 UpdateDeploymentMetadata message. Does not implicitly temporal.api.deployment.v1.UpdateDeploymentMetadata.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IUpdateDeploymentMetadata | UpdateDeploymentMetadata message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified UpdateDeploymentMetadata message, length delimited. Does not implicitly temporal.api.deployment.v1.UpdateDeploymentMetadata.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IUpdateDeploymentMetadata | UpdateDeploymentMetadata message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): UpdateDeploymentMetadata
Creates an UpdateDeploymentMetadata message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
UpdateDeploymentMetadata
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for UpdateDeploymentMetadata
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 an UpdateDeploymentMetadata message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | UpdateDeploymentMetadata | UpdateDeploymentMetadata |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object