Skip to main content

Class: DeleteUserGroupRequest

Represents a DeleteUserGroupRequest.

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 delete.

resourceVersion​

resourceVersion: string

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

Methods​

toJSON()​

toJSON(): object

Converts this DeleteUserGroupRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): DeleteUserGroupRequest & $Properties

Creates a new DeleteUserGroupRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DeleteUserGroupRequest & $Properties

DeleteUserGroupRequest instance

Call Signature​

static create(properties?): DeleteUserGroupRequest

Creates a new DeleteUserGroupRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DeleteUserGroupRequest

DeleteUserGroupRequest instance

decode()​

static decode(reader, length?): DeleteUserGroupRequest & $Properties

Decodes a DeleteUserGroupRequest 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​

DeleteUserGroupRequest & $Properties

DeleteUserGroupRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): DeleteUserGroupRequest & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

DeleteUserGroupRequest & $Properties

DeleteUserGroupRequest

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

Parameters​

message​

$Properties

DeleteUserGroupRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

DeleteUserGroupRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): DeleteUserGroupRequest

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

DeleteUserGroupRequest

DeleteUserGroupRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

DeleteUserGroupRequest

DeleteUserGroupRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object