Skip to main content

Class: CreateUserGroupRequest

cloudservice.v1.CreateUserGroupRequest

Represents a CreateUserGroupRequest.

Implements

Constructors

constructor

new CreateUserGroupRequest(properties?): CreateUserGroupRequest

Constructs a new CreateUserGroupRequest.

Parameters

NameTypeDescription
properties?ICreateUserGroupRequestProperties to set

Returns

CreateUserGroupRequest

Properties

asyncOperationId

asyncOperationId: string

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

Implementation of

ICreateUserGroupRequest.asyncOperationId


spec

Optional spec: null | IUserGroupSpec

The spec for the group to create.

Implementation of

ICreateUserGroupRequest.spec

Methods

toJSON

toJSON(): Object

Converts this CreateUserGroupRequest to JSON.

Returns

Object

JSON object


create

create(properties?): CreateUserGroupRequest

Creates a new CreateUserGroupRequest instance using the specified properties.

Parameters

NameTypeDescription
properties?ICreateUserGroupRequestProperties to set

Returns

CreateUserGroupRequest

CreateUserGroupRequest instance


decode

decode(reader, length?): CreateUserGroupRequest

Decodes a CreateUserGroupRequest message from the specified reader or buffer.

Parameters

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

Returns

CreateUserGroupRequest

CreateUserGroupRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): CreateUserGroupRequest

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

CreateUserGroupRequest

CreateUserGroupRequest

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

Parameters

NameTypeDescription
messageICreateUserGroupRequestCreateUserGroupRequest message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageICreateUserGroupRequestCreateUserGroupRequest message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): CreateUserGroupRequest

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

CreateUserGroupRequest

CreateUserGroupRequest


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for CreateUserGroupRequest

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageCreateUserGroupRequestCreateUserGroupRequest
options?IConversionOptionsConversion options

Returns

Object

Plain object