Class: UpdateUserRequest
cloudservice.v1.UpdateUserRequest
Represents an UpdateUserRequest.
Implements
Constructors
constructor
• new UpdateUserRequest(properties?): UpdateUserRequest
Constructs a new UpdateUserRequest.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IUpdateUserRequest | Properties to set |
Returns
Properties
asyncOperationId
• asyncOperationId: string
The id to use for this async operation - optional
Implementation of
IUpdateUserRequest.asyncOperationId
resourceVersion
• resourceVersion: string
The version of the user for which this update is intended for The latest version can be found in the GetUser operation response
Implementation of
IUpdateUserRequest.resourceVersion
spec
• Optional spec: null | IUserSpec
The new user specification
Implementation of
userId
• userId: string
The id of the user to update
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this UpdateUserRequest to JSON.
Returns
Object
JSON object
create
▸ create(properties?): UpdateUserRequest
Creates a new UpdateUserRequest instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IUpdateUserRequest | Properties to set |
Returns
UpdateUserRequest instance
decode
▸ decode(reader, length?): UpdateUserRequest
Decodes an UpdateUserRequest 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
UpdateUserRequest
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): UpdateUserRequest
Decodes an UpdateUserRequest message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
UpdateUserRequest
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 UpdateUserRequest message. Does not implicitly temporal.api.cloud.cloudservice.v1.UpdateUserRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IUpdateUserRequest | UpdateUserRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified UpdateUserRequest message, length delimited. Does not implicitly temporal.api.cloud.cloudservice.v1.UpdateUserRequest.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IUpdateUserRequest | UpdateUserRequest message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): UpdateUserRequest
Creates an UpdateUserRequest message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
UpdateUserRequest
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for UpdateUserRequest
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 UpdateUserRequest message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | UpdateUserRequest | UpdateUserRequest |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object