# Interface BackupRuleOrBuilder (0.50.0)

0.50.0 (latest) 0.47.0 0.46.0 0.44.0 0.42.0 0.41.0 0.40.0 0.39.0 0.37.0 0.35.0 0.34.0 0.33.0 0.32.0 0.31.0 0.29.0 0.27.0 0.26.0 0.23.0 0.22.0 0.21.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.14.0 0.13.0 0.12.0 0.11.0 0.10.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

    public interface BackupRuleOrBuilder extends MessageOrBuilder

## Implements

[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)

## Methods

### getBackupRetentionDays()

    public abstract int getBackupRetentionDays()

Required. Configures the duration for which backup data will be kept. It is
defined in "days". The value should be greater than or equal to minimum
enforced retention of the backup vault.

Minimum value is 1 and maximum value is 36159 for custom retention
on-demand backup.
Minimum and maximum values are workload specific for all other rules.

`int32 backup_retention_days = 4 [(.google.api.field_behavior) = REQUIRED];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The backupRetentionDays. |

### getBackupScheduleOneofCase()

    public abstract BackupRule.BackupScheduleOneofCase getBackupScheduleOneofCase()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-backupdr/latest/com.google.cloud.backupdr.v1.BackupRule.BackupScheduleOneofCase` |   |

### getRuleId()

    public abstract String getRuleId()

Required. Immutable. The unique id of this `BackupRule`. The `rule_id` is
unique per `BackupPlan`.The `rule_id` must start with a lowercase letter
followed by up to 62 lowercase letters, numbers, or hyphens. Pattern,
/a-z{,62}/.

`
string rule_id = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The ruleId. |

### getRuleIdBytes()

    public abstract ByteString getRuleIdBytes()

Required. Immutable. The unique id of this `BackupRule`. The `rule_id` is
unique per `BackupPlan`.The `rule_id` must start with a lowercase letter
followed by up to 62 lowercase letters, numbers, or hyphens. Pattern,
/a-z{,62}/.

`
string rule_id = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for ruleId. |

### getStandardSchedule()

    public abstract StandardSchedule getStandardSchedule()

Optional. Defines a schedule that runs within the confines of a defined
window of time.

`
.google.cloud.backupdr.v1.StandardSchedule standard_schedule = 5 [(.google.api.field_behavior) = OPTIONAL];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-backupdr/latest/com.google.cloud.backupdr.v1.StandardSchedule` | The standardSchedule. |

### getStandardScheduleOrBuilder()

    public abstract StandardScheduleOrBuilder getStandardScheduleOrBuilder()

Optional. Defines a schedule that runs within the confines of a defined
window of time.

`
.google.cloud.backupdr.v1.StandardSchedule standard_schedule = 5 [(.google.api.field_behavior) = OPTIONAL];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-backupdr/latest/com.google.cloud.backupdr.v1.StandardScheduleOrBuilder` |   |

### hasStandardSchedule()

    public abstract boolean hasStandardSchedule()

Optional. Defines a schedule that runs within the confines of a defined
window of time.

`
.google.cloud.backupdr.v1.StandardSchedule standard_schedule = 5 [(.google.api.field_behavior) = OPTIONAL];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the standardSchedule field is set. |