Skip to main content

Class: UpdateUserGroupRequest

Represents an UpdateUserGroupRequest.

Properties​

asyncOperationId​

asyncOperationId: string

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

groupId​

groupId: string

The id of the group to update.

resourceVersion​

resourceVersion: string

The version of the group for which this update is intended for. The latest version can be found in the GetGroup operation response.

spec?​

optional spec?: $Properties | null

The new group specification.

Methods​

toJSON()​

toJSON(): object

Converts this UpdateUserGroupRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): UpdateUserGroupRequest & $Shape

Creates a new UpdateUserGroupRequest instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

UpdateUserGroupRequest & $Shape

UpdateUserGroupRequest instance

Call Signature​

static create(properties?): UpdateUserGroupRequest

Creates a new UpdateUserGroupRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

UpdateUserGroupRequest

UpdateUserGroupRequest instance

decode()​

static decode(reader, length?): UpdateUserGroupRequest & $Shape

Decodes an UpdateUserGroupRequest message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

UpdateUserGroupRequest & $Shape

UpdateUserGroupRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): UpdateUserGroupRequest & $Shape

Decodes an UpdateUserGroupRequest message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

UpdateUserGroupRequest & $Shape

UpdateUserGroupRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified UpdateUserGroupRequest message. Does not implicitly temporal.api.cloud.cloudservice.v1.UpdateUserGroupRequest.verify|verify messages.

Parameters​

message​

$Properties

UpdateUserGroupRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

UpdateUserGroupRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): UpdateUserGroupRequest

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

UpdateUserGroupRequest

UpdateUserGroupRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

UpdateUserGroupRequest

UpdateUserGroupRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object