Google Cloud AlloyDB for PostgreSQL V1 Client - Class CreateSecondaryClusterRequest (1.0.0)

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

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

Namespace

Google \ Cloud \ AlloyDb \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field.

↳ cluster_id string

Required. ID of the requesting object (the secondary cluster).

↳ cluster Google\Cloud\AlloyDb\V1\Cluster

Required. Configuration of the requesting object (the secondary cluster).

↳ 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, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.

getParent

Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field.

Returns
Type Description
string

setParent

Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field.

Parameter
Name Description
var string
Returns
Type Description
$this

getClusterId

Required. ID of the requesting object (the secondary cluster).

Returns
Type Description
string

setClusterId

Required. ID of the requesting object (the secondary cluster).

Parameter
Name Description
var string
Returns
Type Description
$this

getCluster

Required. Configuration of the requesting object (the secondary cluster).

Returns
Type Description
Google\Cloud\AlloyDb\V1\Cluster|null

hasCluster

clearCluster

setCluster

Required. Configuration of the requesting object (the secondary cluster).

Parameter
Name Description
var Google\Cloud\AlloyDb\V1\Cluster
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, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.

Returns
Type Description
bool

setValidateOnly

Optional. If set, performs request validation (e.g. permission checks and any other type of validation), but do not actually execute the create request.

Parameter
Name Description
var bool
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. The location of the new cluster. For the required format, see the comment on the Cluster.name field. Please see Google\Cloud\AlloyDb\V1\AlloyDBAdminClient::locationName() for help formatting this field.

cluster Google\Cloud\AlloyDb\V1\Cluster

Required. Configuration of the requesting object (the secondary cluster).

clusterId string

Required. ID of the requesting object (the secondary cluster).

Returns
Type Description
Google\Cloud\AlloyDb\V1\CreateSecondaryClusterRequest