Class: DeleteUserGroupRequest
cloudservice.v1.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
▸ create(properties?): DeleteUserGroupRequest & $Properties
Creates a new DeleteUserGroupRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
DeleteUserGroupRequest & $Properties
DeleteUserGroupRequest instance
▸ create(properties?): DeleteUserGroupRequest
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): DeleteUserGroupRequest & $Properties
Decodes a DeleteUserGroupRequest 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
DeleteUserGroupRequest & $Properties
DeleteUserGroupRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): DeleteUserGroupRequest & $Properties
Decodes a DeleteUserGroupRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | 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
▸ encode(message, writer?): Writer
Encodes the specified DeleteUserGroupRequest message. Does not implicitly temporal.api.cloud.cloudservice.v1.DeleteUserGroupRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | DeleteUserGroupRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified DeleteUserGroupRequest message, length delimited. Does not implicitly temporal.api.cloud.cloudservice.v1.DeleteUserGroupRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | DeleteUserGroupRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): DeleteUserGroupRequest
Creates a DeleteUserGroupRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
DeleteUserGroupRequest
toObject
▸ toObject(message, options?): Object
Creates a plain object from a DeleteUserGroupRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | DeleteUserGroupRequest | DeleteUserGroupRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object