Class: UpdateCustomRoleRequest
cloudservice.v1.UpdateCustomRoleRequest
Represents an UpdateCustomRoleRequest.
Implements
Constructors
constructor
• new UpdateCustomRoleRequest(properties?): UpdateCustomRoleRequest
Constructs a new UpdateCustomRoleRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IUpdateCustomRoleRequest | Properties to set |
Returns
Properties
asyncOperationId
• asyncOperationId: string
The ID to use for this async operation. Optional, if not provided a random ID will be generated.
Implementation of
IUpdateCustomRoleRequest.asyncOperationId
resourceVersion
• resourceVersion: string
The version of the custom role for which this update is intended. The latest version can be found in the GetCustomRole operation response.
Implementation of
IUpdateCustomRoleRequest.resourceVersion
roleId
• roleId: string
The ID of the custom role to update.
Implementation of
IUpdateCustomRoleRequest.roleId
spec
• Optional spec: null | ICustomRoleSpec
The new custom role specification.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this UpdateCustomRoleRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): UpdateCustomRoleRequest
Creates a new UpdateCustomRoleRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IUpdateCustomRoleRequest | Properties to set |
Returns
UpdateCustomRoleRequest instance
decode
▸ decode(reader, length?): UpdateCustomRoleRequest
Decodes an UpdateCustomRoleRequest 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
UpdateCustomRoleRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): UpdateCustomRoleRequest
Decodes an UpdateCustomRoleRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
UpdateCustomRoleRequest
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 UpdateCustomRoleRequest message. Does not implicitly temporal.api.cloud.cloudservice.v1.UpdateCustomRoleRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IUpdateCustomRoleRequest | UpdateCustomRoleRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified UpdateCustomRoleRequest message, length delimited. Does not implicitly temporal.api.cloud.cloudservice.v1.UpdateCustomRoleRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IUpdateCustomRoleRequest | UpdateCustomRoleRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): UpdateCustomRoleRequest
Creates an UpdateCustomRoleRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
UpdateCustomRoleRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for UpdateCustomRoleRequest
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 UpdateCustomRoleRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | UpdateCustomRoleRequest | UpdateCustomRoleRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object