Class: RenameCustomSearchAttributeRequest
cloudservice.v1.RenameCustomSearchAttributeRequest
Represents a RenameCustomSearchAttributeRequest.
Properties
asyncOperationId
• asyncOperationId: string
The id to use for this async operation. Optional, if not provided a random id will be generated.
existingCustomSearchAttributeName
• existingCustomSearchAttributeName: string
The existing name of the custom search attribute to be renamed.
namespace
• namespace: string
The namespace to rename the custom search attribute for.
newCustomSearchAttributeName
• newCustomSearchAttributeName: string
The new name of the custom search attribute.
resourceVersion
• resourceVersion: string
The version of the namespace for which this update is intended for. The latest version can be found in the namespace status.
Methods
toJSON
▸ toJSON(): Object
Converts this RenameCustomSearchAttributeRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): RenameCustomSearchAttributeRequest & $Properties
Creates a new RenameCustomSearchAttributeRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
RenameCustomSearchAttributeRequest & $Properties
RenameCustomSearchAttributeRequest instance
▸ create(properties?): RenameCustomSearchAttributeRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
RenameCustomSearchAttributeRequest
decode
▸ decode(reader, length?): RenameCustomSearchAttributeRequest & $Properties
Decodes a RenameCustomSearchAttributeRequest 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
RenameCustomSearchAttributeRequest & $Properties
RenameCustomSearchAttributeRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): RenameCustomSearchAttributeRequest & $Properties
Decodes a RenameCustomSearchAttributeRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
RenameCustomSearchAttributeRequest & $Properties
RenameCustomSearchAttributeRequest
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 RenameCustomSearchAttributeRequest message. Does not implicitly temporal.api.cloud.cloudservice.v1.RenameCustomSearchAttributeRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | RenameCustomSearchAttributeRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified RenameCustomSearchAttributeRequest message, length delimited. Does not implicitly temporal.api.cloud.cloudservice.v1.RenameCustomSearchAttributeRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | RenameCustomSearchAttributeRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): RenameCustomSearchAttributeRequest
Creates a RenameCustomSearchAttributeRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
RenameCustomSearchAttributeRequest
RenameCustomSearchAttributeRequest
toObject
▸ toObject(message, options?): Object
Creates a plain object from a RenameCustomSearchAttributeRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | RenameCustomSearchAttributeRequest | RenameCustomSearchAttributeRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object