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: null | $Properties
The date and time when the custom role was created.
id
• id: string
The id of the custom role.
lastModifiedTime
• Optional lastModifiedTime: null | $Properties
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: null | $Properties
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
▸ create(properties?): CustomRole & $Properties
Creates a new CustomRole instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
CustomRole instance
▸ create(properties?): CustomRole
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): CustomRole & $Properties
Decodes a CustomRole 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
CustomRole
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): CustomRole & $Properties
Decodes a CustomRole message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
CustomRole
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 CustomRole message. Does not implicitly temporal.api.cloud.identity.v1.CustomRole.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | CustomRole message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified CustomRole message, length delimited. Does not implicitly temporal.api.cloud.identity.v1.CustomRole.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | CustomRole message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): CustomRole
Creates a CustomRole message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
CustomRole
toObject
▸ toObject(message, options?): Object
Creates a plain object from a CustomRole message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | CustomRole | CustomRole |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object