Google Cloud AlloyDB for PostgreSQL V1alpha Client - Class RestoreClusterRequest (0.2.1)

Version 0.2.1

• 1.1.1 (latest)
• 1.1.0
• 1.0.0
• 0.10.3
• 0.9.0
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.1
• 0.1.3

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1alpha 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.v1alpha.RestoreClusterRequest

Namespace

Google \ Cloud \ AlloyDb \ V1alpha

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ backup_source	Google\Cloud\AlloyDb\V1alpha\BackupSource Backup source.
↳ continuous_backup_source	Google\Cloud\AlloyDb\V1alpha\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\V1alpha\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 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 import request.

getBackupSource

Backup source.

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

hasBackupSource

setBackupSource

Backup source.

Parameter
Name	Description
var	Google\Cloud\AlloyDb\V1alpha\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\V1alpha\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\V1alpha\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\V1alpha\Cluster|null

hasCluster

clearCluster

setCluster

Required. The resource being created

Parameter
Name	Description
var	Google\Cloud\AlloyDb\V1alpha\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 import 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 import request.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getSource

Returns
Type	Description
string