Reference documentation and code samples for the Google Cloud Ftp V1 Client class UpdateUserRequest.
Message for updating a User
Generated from protobuf message google.cloud.ftp.v1.UpdateUserRequest
Namespace
Google \ Cloud \ Ftp \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ update_mask |
Google\Protobuf\FieldMask
Optional. Field mask is used to specify the fields to be overwritten in the User resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten. |
↳ user |
User
Required. The resource being updated |
getUpdateMask
Optional. Field mask is used to specify the fields to be overwritten in the User resource by the update.
The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\FieldMask|null |
|
hasUpdateMask
clearUpdateMask
setUpdateMask
Optional. Field mask is used to specify the fields to be overwritten in the User resource by the update.
The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\FieldMask
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUser
Required. The resource being updated
| Returns | |
|---|---|
| Type | Description |
User|null |
|
hasUser
clearUser
setUser
Required. The resource being updated
| Parameter | |
|---|---|
| Name | Description |
var |
User
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameters | |
|---|---|
| Name | Description |
user |
User
Required. The resource being updated |
updateMask |
Google\Protobuf\FieldMask
Optional. Field mask is used to specify the fields to be overwritten in the User resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields present in the request will be overwritten. |
| Returns | |
|---|---|
| Type | Description |
UpdateUserRequest |
|