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