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 \ V1
Methods
__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 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.
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.
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.
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.
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.
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.
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Spanner V1 Client - Class BackupSchedule (1.104.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.104.0 (latest)](/php/docs/reference/cloud-spanner/latest/Admin.Database.V1.BackupSchedule)\n- [1.103.0](/php/docs/reference/cloud-spanner/1.103.0/Admin.Database.V1.BackupSchedule)\n- [1.102.0](/php/docs/reference/cloud-spanner/1.102.0/Admin.Database.V1.BackupSchedule)\n- [1.101.0](/php/docs/reference/cloud-spanner/1.101.0/Admin.Database.V1.BackupSchedule)\n- [1.100.0](/php/docs/reference/cloud-spanner/1.100.0/Admin.Database.V1.BackupSchedule)\n- [1.98.0](/php/docs/reference/cloud-spanner/1.98.0/Admin.Database.V1.BackupSchedule)\n- [1.97.0](/php/docs/reference/cloud-spanner/1.97.0/Admin.Database.V1.BackupSchedule)\n- [1.96.0](/php/docs/reference/cloud-spanner/1.96.0/Admin.Database.V1.BackupSchedule)\n- [1.95.0](/php/docs/reference/cloud-spanner/1.95.0/Admin.Database.V1.BackupSchedule)\n- [1.94.0](/php/docs/reference/cloud-spanner/1.94.0/Admin.Database.V1.BackupSchedule)\n- [1.93.1](/php/docs/reference/cloud-spanner/1.93.1/Admin.Database.V1.BackupSchedule)\n- [1.92.1](/php/docs/reference/cloud-spanner/1.92.1/Admin.Database.V1.BackupSchedule)\n- [1.91.0](/php/docs/reference/cloud-spanner/1.91.0/Admin.Database.V1.BackupSchedule)\n- [1.90.0](/php/docs/reference/cloud-spanner/1.90.0/Admin.Database.V1.BackupSchedule)\n- [1.89.0](/php/docs/reference/cloud-spanner/1.89.0/Admin.Database.V1.BackupSchedule)\n- [1.88.0](/php/docs/reference/cloud-spanner/1.88.0/Admin.Database.V1.BackupSchedule)\n- [1.87.0](/php/docs/reference/cloud-spanner/1.87.0/Admin.Database.V1.BackupSchedule)\n- [1.86.0](/php/docs/reference/cloud-spanner/1.86.0/Admin.Database.V1.BackupSchedule)\n- [1.85.0](/php/docs/reference/cloud-spanner/1.85.0/Admin.Database.V1.BackupSchedule)\n- [1.84.0](/php/docs/reference/cloud-spanner/1.84.0/Admin.Database.V1.BackupSchedule)\n- [1.83.0](/php/docs/reference/cloud-spanner/1.83.0/Admin.Database.V1.BackupSchedule)\n- [1.82.0](/php/docs/reference/cloud-spanner/1.82.0/Admin.Database.V1.BackupSchedule)\n- [1.81.0](/php/docs/reference/cloud-spanner/1.81.0/Admin.Database.V1.BackupSchedule)\n- [1.80.0](/php/docs/reference/cloud-spanner/1.80.0/Admin.Database.V1.BackupSchedule)\n- [1.79.0](/php/docs/reference/cloud-spanner/1.79.0/Admin.Database.V1.BackupSchedule)\n- [1.78.0](/php/docs/reference/cloud-spanner/1.78.0/Admin.Database.V1.BackupSchedule)\n- [1.77.0](/php/docs/reference/cloud-spanner/1.77.0/Admin.Database.V1.BackupSchedule)\n- [1.76.1](/php/docs/reference/cloud-spanner/1.76.1/Admin.Database.V1.BackupSchedule)\n- [1.68.0](/php/docs/reference/cloud-spanner/1.68.0/Admin.Database.V1.BackupSchedule)\n- [1.67.0](/php/docs/reference/cloud-spanner/1.67.0/Admin.Database.V1.BackupSchedule)\n- [1.66.0](/php/docs/reference/cloud-spanner/1.66.0/Admin.Database.V1.BackupSchedule)\n- [1.65.0](/php/docs/reference/cloud-spanner/1.65.0/Admin.Database.V1.BackupSchedule)\n- [1.64.0](/php/docs/reference/cloud-spanner/1.64.0/Admin.Database.V1.BackupSchedule)\n- [1.63.2](/php/docs/reference/cloud-spanner/1.63.2/Admin.Database.V1.BackupSchedule)\n- [1.62.1](/php/docs/reference/cloud-spanner/1.62.1/Admin.Database.V1.BackupSchedule)\n- [1.61.0](/php/docs/reference/cloud-spanner/1.61.0/Admin.Database.V1.BackupSchedule)\n- [1.60.0](/php/docs/reference/cloud-spanner/1.60.0/Admin.Database.V1.BackupSchedule)\n- [1.59.0](/php/docs/reference/cloud-spanner/1.59.0/Admin.Database.V1.BackupSchedule)\n- [1.58.4](/php/docs/reference/cloud-spanner/1.58.4/Admin.Database.V1.BackupSchedule)\n- [1.57.0](/php/docs/reference/cloud-spanner/1.57.0/Admin.Database.V1.BackupSchedule)\n- [1.56.0](/php/docs/reference/cloud-spanner/1.56.0/Admin.Database.V1.BackupSchedule)\n- [1.55.0](/php/docs/reference/cloud-spanner/1.55.0/Admin.Database.V1.BackupSchedule)\n- [1.54.2](/php/docs/reference/cloud-spanner/1.54.2/Admin.Database.V1.BackupSchedule) \nReference documentation and code samples for the Cloud Spanner V1 Client class BackupSchedule.\n\nBackupSchedule expresses the automated backup creation specification for a\nSpanner database.\n\nNext ID: 10\n\nGenerated from protobuf message `google.spanner.admin.database.v1.BackupSchedule`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Spanner \\\\ Admin \\\\ Database \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nIdentifier. Output only for the\nCreateBackupSchedule operation.\n\nRequired for the\nUpdateBackupSchedule\noperation. A globally unique identifier for the backup schedule which\ncannot be changed. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/databases/\u003cdatabase\u003e/backupSchedules/[a-z][a-z0-9_\\-]*[a-z0-9]`\nThe final segment of the name must be between 2 and 60 characters in\nlength.\n\n### setName\n\nIdentifier. Output only for the\nCreateBackupSchedule operation.\n\nRequired for the\nUpdateBackupSchedule\noperation. A globally unique identifier for the backup schedule which\ncannot be changed. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/databases/\u003cdatabase\u003e/backupSchedules/[a-z][a-z0-9_\\-]*[a-z0-9]`\nThe final segment of the name must be between 2 and 60 characters in\nlength.\n\n### getSpec\n\nOptional. The schedule specification based on which the backup creations\nare triggered.\n\n### hasSpec\n\n### clearSpec\n\n### setSpec\n\nOptional. The schedule specification based on which the backup creations\nare triggered.\n\n### getRetentionDuration\n\nOptional. The retention duration of a backup that must be at least 6 hours\nand at most 366 days. The backup is eligible to be automatically deleted\nonce the retention period has elapsed.\n\n### hasRetentionDuration\n\n### clearRetentionDuration\n\n### setRetentionDuration\n\nOptional. The retention duration of a backup that must be at least 6 hours\nand at most 366 days. The backup is eligible to be automatically deleted\nonce the retention period has elapsed.\n\n### getEncryptionConfig\n\nOptional. The encryption configuration that will be used to encrypt the\nbackup. If this field is not specified, the backup will use the same\nencryption configuration as the database.\n\n### hasEncryptionConfig\n\n### clearEncryptionConfig\n\n### setEncryptionConfig\n\nOptional. The encryption configuration that will be used to encrypt the\nbackup. If this field is not specified, the backup will use the same\nencryption configuration as the database.\n\n### getFullBackupSpec\n\nThe schedule creates only full backups.\n\n### hasFullBackupSpec\n\n### setFullBackupSpec\n\nThe schedule creates only full backups.\n\n### getIncrementalBackupSpec\n\nThe schedule creates incremental backup chains.\n\n### hasIncrementalBackupSpec\n\n### setIncrementalBackupSpec\n\nThe schedule creates incremental backup chains.\n\n### getUpdateTime\n\nOutput only. The timestamp at which the schedule was last updated.\n\nIf the schedule has never been updated, this field contains the timestamp\nwhen the schedule was first created.\n\n### hasUpdateTime\n\n### clearUpdateTime\n\n### setUpdateTime\n\nOutput only. The timestamp at which the schedule was last updated.\n\nIf the schedule has never been updated, this field contains the timestamp\nwhen the schedule was first created.\n\n### getBackupTypeSpec"]]
