- 0.54.0 (latest)
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.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.6
- 0.1.0
public interface BackupPlanOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsLabels(String key)
public abstract boolean containsLabels(String key)Optional. A set of custom labels supplied by user.
map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getBackupConfig()
public abstract BackupPlan.BackupConfig getBackupConfig()Optional. Defines the configuration of Backups created via this BackupPlan.
.google.cloud.gkebackup.v1.BackupPlan.BackupConfig backup_config = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
BackupPlan.BackupConfig |
The backupConfig. |
getBackupConfigOrBuilder()
public abstract BackupPlan.BackupConfigOrBuilder getBackupConfigOrBuilder()Optional. Defines the configuration of Backups created via this BackupPlan.
.google.cloud.gkebackup.v1.BackupPlan.BackupConfig backup_config = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
BackupPlan.BackupConfigOrBuilder |
|
getBackupSchedule()
public abstract BackupPlan.Schedule getBackupSchedule()Optional. Defines a schedule for automatic Backup creation via this BackupPlan.
.google.cloud.gkebackup.v1.BackupPlan.Schedule backup_schedule = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
BackupPlan.Schedule |
The backupSchedule. |
getBackupScheduleOrBuilder()
public abstract BackupPlan.ScheduleOrBuilder getBackupScheduleOrBuilder()Optional. Defines a schedule for automatic Backup creation via this BackupPlan.
.google.cloud.gkebackup.v1.BackupPlan.Schedule backup_schedule = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
BackupPlan.ScheduleOrBuilder |
|
getCluster()
public abstract String getCluster()Required. Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats:
projects/*/locations/*/clusters/*projects/*/zones/*/clusters/*
string cluster = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The cluster. |
getClusterBytes()
public abstract ByteString getClusterBytes()Required. Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats:
projects/*/locations/*/clusters/*projects/*/zones/*/clusters/*
string cluster = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for cluster. |
getCreateTime()
public abstract Timestamp getCreateTime()Output only. The timestamp when this BackupPlan resource was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The createTime. |
getCreateTimeOrBuilder()
public abstract TimestampOrBuilder getCreateTimeOrBuilder()Output only. The timestamp when this BackupPlan resource was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDeactivated()
public abstract boolean getDeactivated()Optional. This flag indicates whether this BackupPlan has been deactivated. Setting this field to True locks the BackupPlan such that no further updates will be allowed (except deletes), including the deactivated field itself. It also prevents any new Backups from being created via this BackupPlan (including scheduled Backups).
Default: False
bool deactivated = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The deactivated. |
getDescription()
public abstract String getDescription()Optional. User specified descriptive string for this BackupPlan.
string description = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The description. |
getDescriptionBytes()
public abstract ByteString getDescriptionBytes()Optional. User specified descriptive string for this BackupPlan.
string description = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for description. |
getEtag()
public abstract String getEtag() Output only. etag is used for optimistic concurrency control as a way to
help prevent simultaneous updates of a backup plan from overwriting each
other. It is strongly suggested that systems make use of the 'etag' in the
read-modify-write cycle to perform BackupPlan updates in order to avoid
race conditions: An etag is returned in the response to GetBackupPlan,
and systems are expected to put that etag in the request to
UpdateBackupPlan or DeleteBackupPlan to ensure that their change
will be applied to the same version of the resource.
string etag = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The etag. |
getEtagBytes()
public abstract ByteString getEtagBytes() Output only. etag is used for optimistic concurrency control as a way to
help prevent simultaneous updates of a backup plan from overwriting each
other. It is strongly suggested that systems make use of the 'etag' in the
read-modify-write cycle to perform BackupPlan updates in order to avoid
race conditions: An etag is returned in the response to GetBackupPlan,
and systems are expected to put that etag in the request to
UpdateBackupPlan or DeleteBackupPlan to ensure that their change
will be applied to the same version of the resource.
string etag = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for etag. |
getLabels() (deprecated)
public abstract Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsCount()
public abstract int getLabelsCount()Optional. A set of custom labels supplied by user.
map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
|
getLabelsMap()
public abstract Map<String,String> getLabelsMap()Optional. A set of custom labels supplied by user.
map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsOrDefault(String key, String defaultValue)
public abstract String getLabelsOrDefault(String key, String defaultValue)Optional. A set of custom labels supplied by user.
map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getLabelsOrThrow(String key)
public abstract String getLabelsOrThrow(String key)Optional. A set of custom labels supplied by user.
map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getName()
public abstract String getName() Output only. The full name of the BackupPlan resource.
Format: projects/*/locations/*/backupPlans/*
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract ByteString getNameBytes() Output only. The full name of the BackupPlan resource.
Format: projects/*/locations/*/backupPlans/*
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getProtectedPodCount()
public abstract int getProtectedPodCount()Output only. The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.
int32 protected_pod_count = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The protectedPodCount. |
getRetentionPolicy()
public abstract BackupPlan.RetentionPolicy getRetentionPolicy()Optional. RetentionPolicy governs lifecycle of Backups created under this plan.
.google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy retention_policy = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
BackupPlan.RetentionPolicy |
The retentionPolicy. |
getRetentionPolicyOrBuilder()
public abstract BackupPlan.RetentionPolicyOrBuilder getRetentionPolicyOrBuilder()Optional. RetentionPolicy governs lifecycle of Backups created under this plan.
.google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy retention_policy = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
BackupPlan.RetentionPolicyOrBuilder |
|
getRpoRiskLevel()
public abstract int getRpoRiskLevel()Output only. A number that represents the current risk level of this BackupPlan from RPO perspective with 1 being no risk and 5 being highest risk.
int32 rpo_risk_level = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The rpoRiskLevel. |
getRpoRiskReason()
public abstract String getRpoRiskReason()Output only. Human-readable description of why the BackupPlan is in the current rpo_risk_level and action items if any.
string rpo_risk_reason = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The rpoRiskReason. |
getRpoRiskReasonBytes()
public abstract ByteString getRpoRiskReasonBytes()Output only. Human-readable description of why the BackupPlan is in the current rpo_risk_level and action items if any.
string rpo_risk_reason = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for rpoRiskReason. |
getState()
public abstract BackupPlan.State getState()Output only. State of the BackupPlan. This State field reflects the various stages a BackupPlan can be in during the Create operation. It will be set to "DEACTIVATED" if the BackupPlan is deactivated on an Update
.google.cloud.gkebackup.v1.BackupPlan.State state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
BackupPlan.State |
The state. |
getStateReason()
public abstract String getStateReason() Output only. Human-readable description of why BackupPlan is in the current
state
string state_reason = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The stateReason. |
getStateReasonBytes()
public abstract ByteString getStateReasonBytes() Output only. Human-readable description of why BackupPlan is in the current
state
string state_reason = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for stateReason. |
getStateValue()
public abstract int getStateValue()Output only. State of the BackupPlan. This State field reflects the various stages a BackupPlan can be in during the Create operation. It will be set to "DEACTIVATED" if the BackupPlan is deactivated on an Update
.google.cloud.gkebackup.v1.BackupPlan.State state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for state. |
getUid()
public abstract String getUid()Output only. Server generated global unique identifier of UUID format.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The uid. |
getUidBytes()
public abstract ByteString getUidBytes()Output only. Server generated global unique identifier of UUID format.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for uid. |
getUpdateTime()
public abstract Timestamp getUpdateTime()Output only. The timestamp when this BackupPlan resource was last updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The updateTime. |
getUpdateTimeOrBuilder()
public abstract TimestampOrBuilder getUpdateTimeOrBuilder()Output only. The timestamp when this BackupPlan resource was last updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
hasBackupConfig()
public abstract boolean hasBackupConfig()Optional. Defines the configuration of Backups created via this BackupPlan.
.google.cloud.gkebackup.v1.BackupPlan.BackupConfig backup_config = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the backupConfig field is set. |
hasBackupSchedule()
public abstract boolean hasBackupSchedule()Optional. Defines a schedule for automatic Backup creation via this BackupPlan.
.google.cloud.gkebackup.v1.BackupPlan.Schedule backup_schedule = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the backupSchedule field is set. |
hasCreateTime()
public abstract boolean hasCreateTime()Output only. The timestamp when this BackupPlan resource was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the createTime field is set. |
hasRetentionPolicy()
public abstract boolean hasRetentionPolicy()Optional. RetentionPolicy governs lifecycle of Backups created under this plan.
.google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy retention_policy = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the retentionPolicy field is set. |
hasUpdateTime()
public abstract boolean hasUpdateTime()Output only. The timestamp when this BackupPlan resource was last updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the updateTime field is set. |