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