Google Cloud AlloyDB for PostgreSQL V1alpha Client - Class UpdateUserRequest (0.6.0)

Reference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1alpha Client class UpdateUserRequest.

Message for updating a User

Generated from protobuf message google.cloud.alloydb.v1alpha.UpdateUserRequest

Namespace

Google \ Cloud \ AlloyDb \ V1alpha

Methods

__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 will be overwritten.

↳ user
Google\Cloud\AlloyDb\V1alpha\User

Required. The resource being updated

↳ request_id
string

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

↳ validate_only
bool

Optional. If set, the backend validates the request, but doesn't actually execute it.

↳ allow_missing
bool

Optional. Allow missing fields in the update mask.

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 will be overwritten.

Returns
Type
Description

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 will be overwritten.

Parameter
Name
Description
Returns
Type
Description
$this

getUser

Required. The resource being updated

Returns
Type
Description

hasUser

clearUser

setUser

Required. The resource being updated

Parameter
Name
Description
Returns
Type
Description
$this

getRequestId

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Returns
Type
Description
string

setRequestId

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getValidateOnly

Optional. If set, the backend validates the request, but doesn't actually execute it.

Returns
Type
Description
bool

setValidateOnly

Optional. If set, the backend validates the request, but doesn't actually execute it.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getAllowMissing

Optional. Allow missing fields in the update mask.

Returns
Type
Description
bool

setAllowMissing

Optional. Allow missing fields in the update mask.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: