Skip to main content

Class: UpdateCustomRoleRequest

Represents an UpdateCustomRoleRequest.

Properties​

asyncOperationId​

asyncOperationId: string

The ID to use for this async operation. Optional, if not provided a random ID will be generated.

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.

roleId​

roleId: string

The ID of the custom role to update.

spec?​

optional spec?: $Properties | null

The new custom role specification.

Methods​

toJSON()​

toJSON(): object

Converts this UpdateCustomRoleRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): UpdateCustomRoleRequest & $Properties

Creates a new UpdateCustomRoleRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

UpdateCustomRoleRequest & $Properties

UpdateCustomRoleRequest instance

Call Signature​

static create(properties?): UpdateCustomRoleRequest

Creates a new UpdateCustomRoleRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

UpdateCustomRoleRequest

UpdateCustomRoleRequest instance

decode()​

static decode(reader, length?): UpdateCustomRoleRequest & $Properties

Decodes an UpdateCustomRoleRequest message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

UpdateCustomRoleRequest & $Properties

UpdateCustomRoleRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): UpdateCustomRoleRequest & $Properties

Decodes an UpdateCustomRoleRequest message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

UpdateCustomRoleRequest & $Properties

UpdateCustomRoleRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified UpdateCustomRoleRequest message. Does not implicitly temporal.api.cloud.cloudservice.v1.UpdateCustomRoleRequest.verify|verify messages.

Parameters​

message​

$Properties

UpdateCustomRoleRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified UpdateCustomRoleRequest message, length delimited. Does not implicitly temporal.api.cloud.cloudservice.v1.UpdateCustomRoleRequest.verify|verify messages.

Parameters​

message​

$Properties

UpdateCustomRoleRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): UpdateCustomRoleRequest

Creates an UpdateCustomRoleRequest message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

UpdateCustomRoleRequest

UpdateCustomRoleRequest

toObject()​

static toObject(message, options?): object

Creates a plain object from an UpdateCustomRoleRequest message. Also converts values to other types if specified.

Parameters​

message​

UpdateCustomRoleRequest

UpdateCustomRoleRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object