Skip to main content

Class: CreateUserRequest

cloudservice.v1.CreateUserRequest

Represents a CreateUserRequest.

Properties​

asyncOperationId​

• asyncOperationId: string

The id to use for this async operation - optional


spec​

• Optional spec: null | $Properties

The spec for the user to invite

Methods​

toJSON​

▸ toJSON(): Object

Converts this CreateUserRequest to JSON.

Returns​

Object

JSON object


create​

▸ create(properties?): CreateUserRequest & $Properties

Creates a new CreateUserRequest instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

CreateUserRequest & $Properties

CreateUserRequest instance

▸ create(properties?): CreateUserRequest

Parameters​

NameType
properties?$Properties

Returns​

CreateUserRequest


decode​

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

Decodes a CreateUserRequest message from the specified reader or buffer.

Parameters​

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

Returns​

CreateUserRequest & $Properties

CreateUserRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

▸ decodeDelimited(reader): CreateUserRequest & $Properties

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

CreateUserRequest & $Properties

CreateUserRequest

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

Parameters​

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

Returns​

Writer

Writer


encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

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

Parameters​

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

Returns​

Writer

Writer


fromObject​

▸ fromObject(object): CreateUserRequest

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

CreateUserRequest

CreateUserRequest


toObject​

▸ toObject(message, options?): Object

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

Parameters​

NameTypeDescription
messageCreateUserRequestCreateUserRequest
options?IConversionOptionsConversion options

Returns​

Object

Plain object