Skip to main content

Class: GetUserGroupRequest

cloudservice.v1.GetUserGroupRequest

Represents a GetUserGroupRequest.

Properties

groupId

groupId: string

The id of the group to get.

Methods

toJSON

toJSON(): Object

Converts this GetUserGroupRequest to JSON.

Returns

Object

JSON object


create

create(properties?): GetUserGroupRequest & $Properties

Creates a new GetUserGroupRequest instance using the specified properties.

Parameters

NameTypeDescription
properties?$PropertiesProperties to set

Returns

GetUserGroupRequest & $Properties

GetUserGroupRequest instance

create(properties?): GetUserGroupRequest

Parameters

NameType
properties?$Properties

Returns

GetUserGroupRequest


decode

decode(reader, length?): GetUserGroupRequest & $Properties

Decodes a GetUserGroupRequest message from the specified reader or buffer.

Parameters

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

Returns

GetUserGroupRequest & $Properties

GetUserGroupRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): GetUserGroupRequest & $Properties

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

GetUserGroupRequest & $Properties

GetUserGroupRequest

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): GetUserGroupRequest

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

GetUserGroupRequest

GetUserGroupRequest


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageGetUserGroupRequestGetUserGroupRequest
options?IConversionOptionsConversion options

Returns

Object

Plain object