Google Cloud AlloyDB for PostgreSQL V1 Client - Class DeleteUserRequest (0.6.0)

Reference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1 Client class DeleteUserRequest.

Message for deleting a User

Generated from protobuf message google.cloud.alloydb.v1.DeleteUserRequest

Namespace

Google \ Cloud \ AlloyDb \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Required. The name of the resource. For the required format, see the comment on the User.name field.

↳ 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 after 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.

getName

Required. The name of the resource. For the required format, see the comment on the User.name field.

Returns
TypeDescription
string

setName

Required. The name of the resource. For the required format, see the comment on the User.name field.

Parameter
NameDescription
var string
Returns
TypeDescription
$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 after 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
TypeDescription
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 after 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
NameDescription
var string
Returns
TypeDescription
$this

getValidateOnly

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

Returns
TypeDescription
bool

setValidateOnly

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

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
name string

Required. The name of the resource. For the required format, see the comment on the User.name field. Please see Google\Cloud\AlloyDb\V1\AlloyDBAdminClient::userName() for help formatting this field.

Returns
TypeDescription
Google\Cloud\AlloyDb\V1\DeleteUserRequest