public interface BackupPlanOrBuilder
extends com.google.protobuf.MessageOrBuilder
| Modifier and Type | Method and Description |
|---|---|
boolean |
containsLabels(String key)
A set of custom labels supplied by user.
|
BackupPlan.BackupConfig |
getBackupConfig()
Defines the configuration of Backups created via this BackupPlan.
|
BackupPlan.BackupConfigOrBuilder |
getBackupConfigOrBuilder()
Defines the configuration of Backups created via this BackupPlan.
|
BackupPlan.Schedule |
getBackupSchedule()
Defines a schedule for automatic Backup creation via this BackupPlan.
|
BackupPlan.ScheduleOrBuilder |
getBackupScheduleOrBuilder()
Defines a schedule for automatic Backup creation via this BackupPlan.
|
String |
getCluster()
Required.
|
com.google.protobuf.ByteString |
getClusterBytes()
Required.
|
com.google.protobuf.Timestamp |
getCreateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getCreateTimeOrBuilder()
Output only.
|
boolean |
getDeactivated()
This flag indicates whether this BackupPlan has been deactivated.
|
String |
getDescription()
User specified descriptive string for this BackupPlan.
|
com.google.protobuf.ByteString |
getDescriptionBytes()
User specified descriptive string for this BackupPlan.
|
String |
getEtag()
Output only.
|
com.google.protobuf.ByteString |
getEtagBytes()
Output only.
|
Map<String,String> |
getLabels()
Deprecated.
|
int |
getLabelsCount()
A set of custom labels supplied by user.
|
Map<String,String> |
getLabelsMap()
A set of custom labels supplied by user.
|
String |
getLabelsOrDefault(String key,
String defaultValue)
A set of custom labels supplied by user.
|
String |
getLabelsOrThrow(String key)
A set of custom labels supplied by user.
|
String |
getName()
Output only.
|
com.google.protobuf.ByteString |
getNameBytes()
Output only.
|
int |
getProtectedPodCount()
Output only.
|
BackupPlan.RetentionPolicy |
getRetentionPolicy()
RetentionPolicy governs lifecycle of Backups created under this plan.
|
BackupPlan.RetentionPolicyOrBuilder |
getRetentionPolicyOrBuilder()
RetentionPolicy governs lifecycle of Backups created under this plan.
|
BackupPlan.State |
getState()
Output only.
|
String |
getStateReason()
Output only.
|
com.google.protobuf.ByteString |
getStateReasonBytes()
Output only.
|
int |
getStateValue()
Output only.
|
String |
getUid()
Output only.
|
com.google.protobuf.ByteString |
getUidBytes()
Output only.
|
com.google.protobuf.Timestamp |
getUpdateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getUpdateTimeOrBuilder()
Output only.
|
boolean |
hasBackupConfig()
Defines the configuration of Backups created via this BackupPlan.
|
boolean |
hasBackupSchedule()
Defines a schedule for automatic Backup creation via this BackupPlan.
|
boolean |
hasCreateTime()
Output only.
|
boolean |
hasRetentionPolicy()
RetentionPolicy governs lifecycle of Backups created under this plan.
|
boolean |
hasUpdateTime()
Output only.
|
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofString getName()
Output only. The full name of the BackupPlan resource. Format: `projects/*/locations/*/backupPlans/*`
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];com.google.protobuf.ByteString getNameBytes()
Output only. The full name of the BackupPlan resource. Format: `projects/*/locations/*/backupPlans/*`
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];String getUid()
Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];com.google.protobuf.ByteString getUidBytes()
Output only. Server generated global unique identifier of [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];boolean hasCreateTime()
Output only. The timestamp when this BackupPlan resource was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
com.google.protobuf.Timestamp getCreateTime()
Output only. The timestamp when this BackupPlan resource was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The timestamp when this BackupPlan resource was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
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];
com.google.protobuf.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];
com.google.protobuf.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];
String getDescription()
User specified descriptive string for this BackupPlan.
string description = 5;com.google.protobuf.ByteString getDescriptionBytes()
User specified descriptive string for this BackupPlan.
string description = 5;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) = { ... }
com.google.protobuf.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) = { ... }
boolean hasRetentionPolicy()
RetentionPolicy governs lifecycle of Backups created under this plan.
.google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy retention_policy = 7;BackupPlan.RetentionPolicy getRetentionPolicy()
RetentionPolicy governs lifecycle of Backups created under this plan.
.google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy retention_policy = 7;BackupPlan.RetentionPolicyOrBuilder getRetentionPolicyOrBuilder()
RetentionPolicy governs lifecycle of Backups created under this plan.
.google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy retention_policy = 7;int getLabelsCount()
A set of custom labels supplied by user.
map<string, string> labels = 8;boolean containsLabels(String key)
A set of custom labels supplied by user.
map<string, string> labels = 8;@Deprecated Map<String,String> getLabels()
getLabelsMap() instead.Map<String,String> getLabelsMap()
A set of custom labels supplied by user.
map<string, string> labels = 8;String getLabelsOrDefault(String key, String defaultValue)
A set of custom labels supplied by user.
map<string, string> labels = 8;String getLabelsOrThrow(String key)
A set of custom labels supplied by user.
map<string, string> labels = 8;boolean hasBackupSchedule()
Defines a schedule for automatic Backup creation via this BackupPlan.
.google.cloud.gkebackup.v1.BackupPlan.Schedule backup_schedule = 9;BackupPlan.Schedule getBackupSchedule()
Defines a schedule for automatic Backup creation via this BackupPlan.
.google.cloud.gkebackup.v1.BackupPlan.Schedule backup_schedule = 9;BackupPlan.ScheduleOrBuilder getBackupScheduleOrBuilder()
Defines a schedule for automatic Backup creation via this BackupPlan.
.google.cloud.gkebackup.v1.BackupPlan.Schedule backup_schedule = 9;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];com.google.protobuf.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];boolean getDeactivated()
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;boolean hasBackupConfig()
Defines the configuration of Backups created via this BackupPlan.
.google.cloud.gkebackup.v1.BackupPlan.BackupConfig backup_config = 12;BackupPlan.BackupConfig getBackupConfig()
Defines the configuration of Backups created via this BackupPlan.
.google.cloud.gkebackup.v1.BackupPlan.BackupConfig backup_config = 12;BackupPlan.BackupConfigOrBuilder getBackupConfigOrBuilder()
Defines the configuration of Backups created via this BackupPlan.
.google.cloud.gkebackup.v1.BackupPlan.BackupConfig backup_config = 12;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];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];
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];
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];com.google.protobuf.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];Copyright © 2023 Google LLC. All rights reserved.