Skip to main content

Class: CustomRoleSpec

Represents a CustomRoleSpec.

Properties​

description​

description: string

The description of the custom role.

name​

name: string

The name of the custom role.

permissions​

permissions: $Properties[]

The permissions assigned to the custom role.

Methods​

toJSON()​

toJSON(): object

Converts this CustomRoleSpec to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): CustomRoleSpec & $Properties

Creates a new CustomRoleSpec instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CustomRoleSpec & $Properties

CustomRoleSpec instance

Call Signature​

static create(properties?): CustomRoleSpec

Creates a new CustomRoleSpec instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

CustomRoleSpec

CustomRoleSpec instance

decode()​

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

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

CustomRoleSpec & $Properties

CustomRoleSpec

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): CustomRoleSpec & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

CustomRoleSpec & $Properties

CustomRoleSpec

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

Parameters​

message​

$Properties

CustomRoleSpec message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

CustomRoleSpec message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): CustomRoleSpec

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

CustomRoleSpec

CustomRoleSpec

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

CustomRoleSpec

CustomRoleSpec

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object