Skip to main content

Class: CustomRole

Represents a CustomRole.

Properties​

asyncOperationId​

asyncOperationId: string

The id of the async operation that is creating/updating/deleting the custom role, if any.

createdTime?​

optional createdTime?: $Properties | null

The date and time when the custom role was created.

id​

id: string

The id of the custom role.

lastModifiedTime?​

optional lastModifiedTime?: $Properties | null

The date and time when the custom role was last modified. Will not be set if the custom role has never been modified.

resourceVersion​

resourceVersion: string

The current version of the custom role specification. The next update operation will have to include this version.

spec?​

optional spec?: $Properties | null

The custom role specification.

state​

state: ResourceState

The current state of the custom role. For any failed state, reach out to Temporal Cloud support for remediation.

Methods​

toJSON()​

toJSON(): object

Converts this CustomRole to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): CustomRole & $Properties

Creates a new CustomRole instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CustomRole & $Properties

CustomRole instance

Call Signature​

static create(properties?): CustomRole

Creates a new CustomRole instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CustomRole

CustomRole instance

decode()​

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

Decodes a CustomRole 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​

CustomRole & $Properties

CustomRole

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): CustomRole & $Properties

Decodes a CustomRole message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

CustomRole & $Properties

CustomRole

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 CustomRole message. Does not implicitly temporal.api.cloud.identity.v1.CustomRole.verify|verify messages.

Parameters​

message​

$Properties

CustomRole message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

CustomRole message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): CustomRole

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

CustomRole

CustomRole

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

CustomRole

CustomRole

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object