Skip to main content

Class: DeleteUserRequest

Represents a DeleteUserRequest.

Properties​

asyncOperationId​

asyncOperationId: string

The id to use for this async operation - optional

resourceVersion​

resourceVersion: string

The version of the user for which this delete is intended for The latest version can be found in the GetUser operation response

userId​

userId: string

The id of the user to delete

Methods​

toJSON()​

toJSON(): object

Converts this DeleteUserRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): DeleteUserRequest & $Properties

Creates a new DeleteUserRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DeleteUserRequest & $Properties

DeleteUserRequest instance

Call Signature​

static create(properties?): DeleteUserRequest

Creates a new DeleteUserRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DeleteUserRequest

DeleteUserRequest instance

decode()​

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

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

DeleteUserRequest & $Properties

DeleteUserRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): DeleteUserRequest & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

DeleteUserRequest & $Properties

DeleteUserRequest

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

Parameters​

message​

$Properties

DeleteUserRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

DeleteUserRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): DeleteUserRequest

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

DeleteUserRequest

DeleteUserRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

DeleteUserRequest

DeleteUserRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object