Google Cloud Backup Dr V1beta Client - Class InitializeServiceRequest (0.15.1)

Reference documentation and code samples for the Google Cloud Backup Dr V1beta Client class InitializeServiceRequest.

Request message for initializing the service.

Generated from protobuf message google.cloud.backupdr.v1beta.InitializeServiceRequest

Namespace

Google \ Cloud \ BackupDR \ V1beta

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ cloud_sql_instance_initialization_config CloudSqlInstanceInitializationConfig

Optional. The configuration for initializing a Cloud SQL instance.

↳ name string

Required. The resource name of the serviceConfig used to initialize the service. The location must be the location of the BackupVault. Format: projects/{project_id}/locations/{location}/serviceConfig.

↳ resource_type string

Required. The resource type to which the default service config will be applied. Examples include, "compute.googleapis.com/Instance" and "storage.googleapis.com/Bucket".

↳ 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 t he 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).

↳ backup_plan_location string

Optional. The location where the BackupPlan will be created. This field is required for multi-region BackupVaults and is optional for regional BackupVaults. It is useful when creating a Backup Vault in a multi-region, allowing the BackupPlan to reside in a specific region within that multi-region. If this field is not provided, the BackupPlan will be created in the same location as specified in the name field.

↳ validate_only bool

Optional. If set, validates the request and returns the result, but does not actually run it.

getCloudSqlInstanceInitializationConfig

Optional. The configuration for initializing a Cloud SQL instance.

Returns
Type Description
CloudSqlInstanceInitializationConfig|null

hasCloudSqlInstanceInitializationConfig

setCloudSqlInstanceInitializationConfig

Optional. The configuration for initializing a Cloud SQL instance.

Parameter
Name Description
var CloudSqlInstanceInitializationConfig
Returns
Type Description
$this

getName

Required. The resource name of the serviceConfig used to initialize the service. The location must be the location of the BackupVault.

Format: projects/{project_id}/locations/{location}/serviceConfig.

Returns
Type Description
string

setName

Required. The resource name of the serviceConfig used to initialize the service. The location must be the location of the BackupVault.

Format: projects/{project_id}/locations/{location}/serviceConfig.

Parameter
Name Description
var string
Returns
Type Description
$this

getResourceType

Required. The resource type to which the default service config will be applied. Examples include, "compute.googleapis.com/Instance" and "storage.googleapis.com/Bucket".

Returns
Type Description
string

setResourceType

Required. The resource type to which the default service config will be applied. Examples include, "compute.googleapis.com/Instance" and "storage.googleapis.com/Bucket".

Parameter
Name Description
var string
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 t he 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 t he 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

getBackupPlanLocation

Optional. The location where the BackupPlan will be created. This field is required for multi-region BackupVaults and is optional for regional BackupVaults. It is useful when creating a Backup Vault in a multi-region, allowing the BackupPlan to reside in a specific region within that multi-region. If this field is not provided, the BackupPlan will be created in the same location as specified in the name field.

Returns
Type Description
string

setBackupPlanLocation

Optional. The location where the BackupPlan will be created. This field is required for multi-region BackupVaults and is optional for regional BackupVaults. It is useful when creating a Backup Vault in a multi-region, allowing the BackupPlan to reside in a specific region within that multi-region. If this field is not provided, the BackupPlan will be created in the same location as specified in the name field.

Parameter
Name Description
var string
Returns
Type Description
$this

getValidateOnly

Optional. If set, validates the request and returns the result, but does not actually run it.

Returns
Type Description
bool

setValidateOnly

Optional. If set, validates the request and returns the result, but does not actually run it.

Parameter
Name Description
var bool
Returns
Type Description
$this

getInitializationConfig

Returns
Type Description
string