Skip to main content

Class: CustomRoleSpec

identity.v1.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

create(properties?): CustomRoleSpec & $Properties

Creates a new CustomRoleSpec instance using the specified properties.

Parameters

NameTypeDescription
properties?$PropertiesProperties to set

Returns

CustomRoleSpec & $Properties

CustomRoleSpec instance

create(properties?): CustomRoleSpec

Parameters

NameType
properties?$Properties

Returns

CustomRoleSpec


decode

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

Decodes a CustomRoleSpec message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage 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

decodeDelimited(reader): CustomRoleSpec & $Properties

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader 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

encode(message, writer?): Writer

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

Parameters

NameTypeDescription
message$PropertiesCustomRoleSpec message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
message$PropertiesCustomRoleSpec message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): CustomRoleSpec

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

CustomRoleSpec

CustomRoleSpec


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageCustomRoleSpecCustomRoleSpec
options?IConversionOptionsConversion options

Returns

Object

Plain object