Reference documentation and code samples for the Cloud Spanner V1 Client class BackupSchedule.
BackupSchedule expresses the automated backup creation specification for a Spanner database.
Next ID: 10
Generated from protobuf message google.spanner.admin.database.v1.BackupSchedule
Namespace
Google \ Cloud \ Spanner \ Admin \ Database \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. Output only for the CreateBackupSchedule operation. Required for the UpdateBackupSchedule operation. A globally unique identifier for the backup schedule which cannot be changed. Values are of the form |
↳ spec |
Google\Cloud\Spanner\Admin\Database\V1\BackupScheduleSpec
Optional. The schedule specification based on which the backup creations are triggered. |
↳ retention_duration |
Google\Protobuf\Duration
Optional. The retention duration of a backup that must be at least 6 hours and at most 366 days. The backup is eligible to be automatically deleted once the retention period has elapsed. |
↳ encryption_config |
Google\Cloud\Spanner\Admin\Database\V1\CreateBackupEncryptionConfig
Optional. The encryption configuration that will be used to encrypt the backup. If this field is not specified, the backup will use the same encryption configuration as the database. |
↳ full_backup_spec |
Google\Cloud\Spanner\Admin\Database\V1\FullBackupSpec
The schedule creates only full backups. |
↳ update_time |
Google\Protobuf\Timestamp
Output only. The timestamp at which the schedule was last updated. If the schedule has never been updated, this field contains the timestamp when the schedule was first created. |
getName
Identifier. Output only for the CreateBackupSchedule operation.
Required for the
UpdateBackupSchedule
operation. A globally unique identifier for the backup schedule which
cannot be changed. Values are of the form
projects/<project>/instances/<instance>/databases/<database>/backupSchedules/[a-z][a-z0-9_\-]*[a-z0-9]
The final segment of the name must be between 2 and 60 characters in
length.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Identifier. Output only for the CreateBackupSchedule operation.
Required for the
UpdateBackupSchedule
operation. A globally unique identifier for the backup schedule which
cannot be changed. Values are of the form
projects/<project>/instances/<instance>/databases/<database>/backupSchedules/[a-z][a-z0-9_\-]*[a-z0-9]
The final segment of the name must be between 2 and 60 characters in
length.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSpec
Optional. The schedule specification based on which the backup creations are triggered.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Spanner\Admin\Database\V1\BackupScheduleSpec|null |
|
hasSpec
clearSpec
setSpec
Optional. The schedule specification based on which the backup creations are triggered.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Spanner\Admin\Database\V1\BackupScheduleSpec
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRetentionDuration
Optional. The retention duration of a backup that must be at least 6 hours and at most 366 days. The backup is eligible to be automatically deleted once the retention period has elapsed.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Duration|null |
|
hasRetentionDuration
clearRetentionDuration
setRetentionDuration
Optional. The retention duration of a backup that must be at least 6 hours and at most 366 days. The backup is eligible to be automatically deleted once the retention period has elapsed.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Duration
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEncryptionConfig
Optional. The encryption configuration that will be used to encrypt the backup. If this field is not specified, the backup will use the same encryption configuration as the database.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Spanner\Admin\Database\V1\CreateBackupEncryptionConfig|null |
|
hasEncryptionConfig
clearEncryptionConfig
setEncryptionConfig
Optional. The encryption configuration that will be used to encrypt the backup. If this field is not specified, the backup will use the same encryption configuration as the database.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Spanner\Admin\Database\V1\CreateBackupEncryptionConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFullBackupSpec
The schedule creates only full backups.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Spanner\Admin\Database\V1\FullBackupSpec|null |
|
hasFullBackupSpec
setFullBackupSpec
The schedule creates only full backups.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Spanner\Admin\Database\V1\FullBackupSpec
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUpdateTime
Output only. The timestamp at which the schedule was last updated.
If the schedule has never been updated, this field contains the timestamp when the schedule was first created.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The timestamp at which the schedule was last updated.
If the schedule has never been updated, this field contains the timestamp when the schedule was first created.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBackupTypeSpec
| Returns | |
|---|---|
| Type | Description |
string |
|