Class: UpdateNamespaceTagsRequest
cloudservice.v1.UpdateNamespaceTagsRequest
Represents an UpdateNamespaceTagsRequest.
Implements
Constructors
constructor
• new UpdateNamespaceTagsRequest(properties?
): UpdateNamespaceTagsRequest
Constructs a new UpdateNamespaceTagsRequest.
Parameters
Name | Type | Description |
---|---|---|
properties? | IUpdateNamespaceTagsRequest | Properties to set |
Returns
Properties
asyncOperationId
• asyncOperationId: string
The id to use for this async operation - optional.
Implementation of
IUpdateNamespaceTagsRequest.asyncOperationId
namespace
• namespace: string
The namespace to set tags for.
Implementation of
IUpdateNamespaceTagsRequest.namespace
tagsToRemove
• tagsToRemove: string
[]
A list of tag keys to remove. If a tag key doesn't exist, it is silently ignored. At least one of tags_to_upsert or tags_to_remove must be specified.
Implementation of
IUpdateNamespaceTagsRequest.tagsToRemove
tagsToUpsert
• tagsToUpsert: Object
A list of tags to add or update. If a key of an existing tag is added, the tag's value is updated. At least one of tags_to_upsert or tags_to_remove must be specified.
Index signature
▪ [k: string
]: string
Implementation of
IUpdateNamespaceTagsRequest.tagsToUpsert
Methods
toJSON
▸ toJSON(): Object
Converts this UpdateNamespaceTagsRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?
): UpdateNamespaceTagsRequest
Creates a new UpdateNamespaceTagsRequest instance using the specified properties.
Parameters
Name | Type | Description |
---|---|---|
properties? | IUpdateNamespaceTagsRequest | Properties to set |
Returns
UpdateNamespaceTagsRequest instance
decode
▸ decode(reader
, length?
): UpdateNamespaceTagsRequest
Decodes an UpdateNamespaceTagsRequest 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
UpdateNamespaceTagsRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader
): UpdateNamespaceTagsRequest
Decodes an UpdateNamespaceTagsRequest message from the specified reader or buffer, length delimited.
Parameters
Name | Type | Description |
---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
UpdateNamespaceTagsRequest
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 UpdateNamespaceTagsRequest message. Does not implicitly temporal.api.cloud.cloudservice.v1.UpdateNamespaceTagsRequest.verify|verify messages.
Parameters
Name | Type | Description |
---|---|---|
message | IUpdateNamespaceTagsRequest | UpdateNamespaceTagsRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message
, writer?
): Writer
Encodes the specified UpdateNamespaceTagsRequest message, length delimited. Does not implicitly temporal.api.cloud.cloudservice.v1.UpdateNamespaceTagsRequest.verify|verify messages.
Parameters
Name | Type | Description |
---|---|---|
message | IUpdateNamespaceTagsRequest | UpdateNamespaceTagsRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object
): UpdateNamespaceTagsRequest
Creates an UpdateNamespaceTagsRequest message from a plain object. Also converts values to their respective internal types.
Parameters
Name | Type | Description |
---|---|---|
object | Object | Plain object |
Returns
UpdateNamespaceTagsRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?
): string
Gets the default type url for UpdateNamespaceTagsRequest
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 UpdateNamespaceTagsRequest message. Also converts values to other types if specified.
Parameters
Name | Type | Description |
---|---|---|
message | UpdateNamespaceTagsRequest | UpdateNamespaceTagsRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object