Google Cloud AlloyDB for PostgreSQL V1 Client - Class RestoreClusterRequest (1.1.0)

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

Message for restoring a Cluster from a backup or another cluster at a given point in time.

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

Namespace

Google \ Cloud \ AlloyDb \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ backup_source Google\Cloud\AlloyDb\V1\BackupSource

Backup source.
↳ continuous_backup_source Google\Cloud\AlloyDb\V1\ContinuousBackupSource

ContinuousBackup source. Continuous backup needs to be enabled in the source cluster for this operation to succeed.
↳ parent string

Required. The name of the parent resource. For the required format, see the comment on the Cluster.name field.
↳ cluster_id string

Required. ID of the requesting object.
↳ cluster Google\Cloud\AlloyDb\V1\Cluster

Required. The resource being created
↳ 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 ignores the request if it has already been completed. The server guarantees 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 the original operation with the same request ID was received, and if so, ignores 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, for example, permission checks and any other type of validation, but does not actually execute the create request.

getBackupSource

Backup source.

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

hasBackupSource

setBackupSource

Backup source.

Parameter
Name Description
var Google\Cloud\AlloyDb\V1\BackupSource
Returns
Type Description
$this

getContinuousBackupSource

ContinuousBackup source. Continuous backup needs to be enabled in the source cluster for this operation to succeed.

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

hasContinuousBackupSource

setContinuousBackupSource

ContinuousBackup source. Continuous backup needs to be enabled in the source cluster for this operation to succeed.

Parameter
Name Description
var Google\Cloud\AlloyDb\V1\ContinuousBackupSource
Returns
Type Description
$this

getParent

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

Returns
Type Description
string

setParent

Required. The name of the parent resource. 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.

Returns
Type Description
string

setClusterId

Required. ID of the requesting object.

Parameter
Name Description
var string
Returns
Type Description
$this

getCluster

Required. The resource being created

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

hasCluster

clearCluster

setCluster

Required. The resource being created

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 ignores the request if it has already been completed. The server guarantees 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 the original operation with the same request ID was received, and if so, ignores 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 ignores the request if it has already been completed. The server guarantees 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 the original operation with the same request ID was received, and if so, ignores 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, for example, permission checks and any other type of validation, but does not actually execute the create request.

Returns
Type Description
bool

setValidateOnly

Optional. If set, performs request validation, for example, permission checks and any other type of validation, but does not actually execute the create request.

Parameter
Name Description
var bool
Returns
Type Description
$this

getSource

Returns
Type Description
string