Skip to main content

Class: Permission

v1.CustomRoleSpec.Permission

Represents a Permission.

Properties​

actions​

• actions: string[]

The actions allowed by the permission.


resources​

• Optional resources: null | $Properties

The resources the permission applies to.

Methods​

toJSON​

▸ toJSON(): Object

Converts this Permission to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): Permission & $Properties

Creates a new Permission instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

Permission & $Properties

Permission instance

▸ create(properties?): Permission

Parameters​

NameType
properties?$Properties

Returns​

Permission


decode​

▸ decode(reader, length?): Permission & $Properties

Decodes a Permission message from the specified reader or buffer.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns​

Permission & $Properties

Permission

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): Permission & $Properties

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

Permission & $Properties

Permission

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

Parameters​

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

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

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

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): Permission

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

Permission

Permission


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messagePermissionPermission
options?IConversionOptionsConversion options

Returns​

Object

Plain object