# Cloud Spanner V1 Client - Class BackupSchedule (2.9.0)

2.9.0 (latest) 2.8.1 2.7.0 2.6.1 2.5.1 2.4.1 2.3.0 2.2.0 2.1.0 2.0.1-RC1 1.106.0 1.105.1 1.104.1 1.103.0 1.102.0 1.101.0 1.100.0 1.98.0 1.97.0 1.96.0 1.95.0 1.94.0 1.93.1 1.92.1 1.91.0 1.90.0 1.89.0 1.88.0 1.87.0 1.86.0 1.85.0 1.84.0 1.83.0 1.82.0 1.81.0 1.80.0 1.79.0 1.78.0 1.77.0 1.76.1 1.68.0 1.67.0 1.66.0 1.65.0 1.64.0 1.63.2 1.62.1 1.61.0 1.60.0 1.59.0 1.58.4 1.57.0 1.56.0 1.55.0 1.54.2 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](https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/Admin.Database.V1.Client.DatabaseAdminClient#_Google_Cloud_Spanner_Admin_Database_V1_Client_DatabaseAdminClient__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. |
| `↳ spec` | `https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/Admin.Database.V1.BackupScheduleSpec` Optional. The schedule specification based on which the backup creations are triggered. |
| `↳ retention_duration` | `https://protobuf.dev/reference/php/api-docs/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` | `https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/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` | `https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/Admin.Database.V1.FullBackupSpec` The schedule creates only full backups. |
| `↳ incremental_backup_spec` | `https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/Admin.Database.V1.IncrementalBackupSpec` The schedule creates incremental backup chains. |
| `↳ update_time` | `https://protobuf.dev/reference/php/api-docs/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](https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/Admin.Database.V1.Client.DatabaseAdminClient#_Google_Cloud_Spanner_Admin_Database_V1_Client_DatabaseAdminClient__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](https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/Admin.Database.V1.Client.DatabaseAdminClient#_Google_Cloud_Spanner_Admin_Database_V1_Client_DatabaseAdminClient__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** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/Admin.Database.V1.BackupScheduleSpec|null` |   |

### hasSpec

### clearSpec

### setSpec

Optional. The schedule specification based on which the backup creations
are triggered.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/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** |
| `https://protobuf.dev/reference/php/api-docs/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` | `https://protobuf.dev/reference/php/api-docs/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** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/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` | `https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/Admin.Database.V1.CreateBackupEncryptionConfig` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getFullBackupSpec

The schedule creates only full backups.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/Admin.Database.V1.FullBackupSpec|null` |   |

### hasFullBackupSpec

### setFullBackupSpec

The schedule creates only full backups.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/Admin.Database.V1.FullBackupSpec` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getIncrementalBackupSpec

The schedule creates incremental backup chains.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/Admin.Database.V1.IncrementalBackupSpec|null` |   |

### hasIncrementalBackupSpec

### setIncrementalBackupSpec

The schedule creates incremental backup chains.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/cloud-spanner/latest/Admin.Database.V1.IncrementalBackupSpec` |

| **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** |
| `https://protobuf.dev/reference/php/api-docs/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` | `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/Timestamp` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getBackupTypeSpec

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |