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