public final class BackupPlan extends GeneratedMessageV3 implements BackupPlanOrBuilder
Defines the configuration and scheduling for a "line" of Backups.
Protobuf type google.cloud.gkebackup.v1.BackupPlan
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
BACKUP_CONFIG_FIELD_NUMBER
public static final int BACKUP_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
BACKUP_SCHEDULE_FIELD_NUMBER
public static final int BACKUP_SCHEDULE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CLUSTER_FIELD_NUMBER
public static final int CLUSTER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DEACTIVATED_FIELD_NUMBER
public static final int DEACTIVATED_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PROTECTED_POD_COUNT_FIELD_NUMBER
public static final int PROTECTED_POD_COUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RETENTION_POLICY_FIELD_NUMBER
public static final int RETENTION_POLICY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RPO_RISK_LEVEL_FIELD_NUMBER
public static final int RPO_RISK_LEVEL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RPO_RISK_REASON_FIELD_NUMBER
public static final int RPO_RISK_REASON_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STATE_REASON_FIELD_NUMBER
public static final int STATE_REASON_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static BackupPlan getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static BackupPlan.Builder newBuilder()
newBuilder(BackupPlan prototype)
public static BackupPlan.Builder newBuilder(BackupPlan prototype)
public static BackupPlan parseDelimitedFrom(InputStream input)
public static BackupPlan parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static BackupPlan parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static BackupPlan parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static BackupPlan parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BackupPlan parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BackupPlan parseFrom(CodedInputStream input)
public static BackupPlan parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static BackupPlan parseFrom(InputStream input)
public static BackupPlan parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static BackupPlan parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static BackupPlan parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<BackupPlan> parser()
Methods
containsLabels(String key)
public 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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getBackupConfig()
public 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];
getBackupConfigOrBuilder()
public 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];
getBackupSchedule()
public 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];
getBackupScheduleOrBuilder()
public 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];
getCluster()
public 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 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 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 TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The timestamp when this BackupPlan resource was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDeactivated()
public 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.
|
getDefaultInstanceForType()
public BackupPlan getDefaultInstanceForType()
getDescription()
public 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 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()
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 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 Map<String,String> getLabels()
getLabelsCount()
public 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 Map<String,String> getLabelsMap()
Optional. A set of custom labels supplied by user.
map<string, string> labels = 8 [(.google.api.field_behavior) = OPTIONAL];
getLabelsOrDefault(String key, String defaultValue)
public 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];
| Returns |
| Type |
Description |
String |
|
getLabelsOrThrow(String key)
public 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()
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 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.
|
getParserForType()
public Parser<BackupPlan> getParserForType()
Overrides
getProtectedPodCount()
public 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 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];
getRetentionPolicyOrBuilder()
public 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];
getRpoRiskLevel()
public 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 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 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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getState()
public 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];
getStateReason()
public 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 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 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()
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 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 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 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];
hasBackupConfig()
public 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 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 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 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 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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public BackupPlan.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected BackupPlan.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public BackupPlan.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
