Class: DeleteUserRequest
cloudservice.v1.DeleteUserRequest
Represents a DeleteUserRequest.
Implements
Constructors
constructor
• new DeleteUserRequest(properties?): DeleteUserRequest
Constructs a new DeleteUserRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IDeleteUserRequest | Properties to set |
Returns
Properties
asyncOperationId
• asyncOperationId: string
The id to use for this async operation - optional
Implementation of
IDeleteUserRequest.asyncOperationId
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
Implementation of
IDeleteUserRequest.resourceVersion
userId
• userId: string
The id of the user to delete
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this DeleteUserRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): DeleteUserRequest
Creates a new DeleteUserRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IDeleteUserRequest | Properties to set |
Returns
DeleteUserRequest instance
decode
▸ decode(reader, length?): DeleteUserRequest
Decodes a DeleteUserRequest message from the specified reader or buffer.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
length? | number | Message length if known beforehand |
Returns
DeleteUserRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): DeleteUserRequest
Decodes a DeleteUserRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
DeleteUserRequest
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 DeleteUserRequest message. Does not implicitly temporal.api.cloud.cloudservice.v1.DeleteUserRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IDeleteUserRequest | DeleteUserRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified DeleteUserRequest message, length delimited. Does not implicitly temporal.api.cloud.cloudservice.v1.DeleteUserRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IDeleteUserRequest | DeleteUserRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): DeleteUserRequest
Creates a DeleteUserRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
DeleteUserRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for DeleteUserRequest
Parameters
| Name | Type | Description |
|---|---|---|
typeUrlPrefix? | string | your custom typeUrlPrefix(default "type.googleapis.com") |
Returns
string
The default type url
toObject
▸ toObject(message, options?): Object
Creates a plain object from a DeleteUserRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | DeleteUserRequest | DeleteUserRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object