Class: Permission
v1.CustomRoleSpec.Permission
Represents a Permission.
Implements
Constructors
constructor
• new Permission(properties?): Permission
Constructs a new Permission.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IPermission | Properties to set |
Returns
Properties
actions
• actions: string[]
The actions allowed by the permission.
Implementation of
resources
• Optional resources: null | IResources
The resources the permission applies to.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this Permission to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Permission
Creates a new Permission instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IPermission | Properties to set |
Returns
Permission instance
decode
▸ decode(reader, length?): Permission
Decodes a Permission message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
Permission
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Permission
Decodes a Permission message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
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
| Name | Type | Description |
|---|---|---|
message | IPermission | Permission message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
message | IPermission | Permission message or plain object to encode |
writer? | Writer | Writer 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
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Permission
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for Permission
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from a Permission message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Permission | Permission |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object