Skip to main content

Class: CreateCustomRoleRequest

cloudservice.v1.CreateCustomRoleRequest

Represents a CreateCustomRoleRequest.

Properties​

asyncOperationId​

• asyncOperationId: string

The ID to use for this async operation. Optional, if not provided a random ID will be generated.


spec​

• Optional spec: null | $Properties

The specification for the custom role to create.

Methods​

toJSON​

▸ toJSON(): Object

Converts this CreateCustomRoleRequest to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): CreateCustomRoleRequest & $Properties

Creates a new CreateCustomRoleRequest instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

CreateCustomRoleRequest & $Properties

CreateCustomRoleRequest instance

▸ create(properties?): CreateCustomRoleRequest

Parameters​

NameType
properties?$Properties

Returns​

CreateCustomRoleRequest


decode​

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

Decodes a CreateCustomRoleRequest message from the specified reader or buffer.

Parameters​

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

Returns​

CreateCustomRoleRequest & $Properties

CreateCustomRoleRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): CreateCustomRoleRequest & $Properties

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

CreateCustomRoleRequest & $Properties

CreateCustomRoleRequest

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

Parameters​

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

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

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

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): CreateCustomRoleRequest

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

CreateCustomRoleRequest

CreateCustomRoleRequest


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageCreateCustomRoleRequestCreateCustomRoleRequest
options?IConversionOptionsConversion options

Returns​

Object

Plain object