public final class BackupPlan extends GeneratedMessageV3 implements BackupPlanOrBuilder
A BackupPlan specifies some common fields, such as description as well
as one or more BackupRule messages. Each BackupRule has a retention
policy and defines a schedule by which the system is to perform backup
workloads.
Protobuf type google.cloud.backupdr.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_RULES_FIELD_NUMBER
public static final int BACKUP_RULES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
BACKUP_VAULT_FIELD_NUMBER
public static final int BACKUP_VAULT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
BACKUP_VAULT_SERVICE_ACCOUNT_FIELD_NUMBER
public static final int BACKUP_VAULT_SERVICE_ACCOUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_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 |
|
LOG_RETENTION_DAYS_FIELD_NUMBER
public static final int LOG_RETENTION_DAYS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RESOURCE_TYPE_FIELD_NUMBER
public static final int RESOURCE_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
REVISION_ID_FIELD_NUMBER
public static final int REVISION_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
REVISION_NAME_FIELD_NUMBER
public static final int REVISION_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SUPPORTED_RESOURCE_TYPES_FIELD_NUMBER
public static final int SUPPORTED_RESOURCE_TYPES_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. This collection of key/value pairs allows for custom labels to be
supplied by the user. Example, {"tag": "Weekly"}.
map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getBackupRules(int index)
public BackupRule getBackupRules(int index)
Required. The backup rules for this BackupPlan. There must be at least
one BackupRule message.
repeated .google.cloud.backupdr.v1.BackupRule backup_rules = 6 [(.google.api.field_behavior) = REQUIRED];
| Parameter |
| Name |
Description |
index |
int
|
getBackupRulesCount()
public int getBackupRulesCount()
Required. The backup rules for this BackupPlan. There must be at least
one BackupRule message.
repeated .google.cloud.backupdr.v1.BackupRule backup_rules = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
int |
|
getBackupRulesList()
public List<BackupRule> getBackupRulesList()
Required. The backup rules for this BackupPlan. There must be at least
one BackupRule message.
repeated .google.cloud.backupdr.v1.BackupRule backup_rules = 6 [(.google.api.field_behavior) = REQUIRED];
getBackupRulesOrBuilder(int index)
public BackupRuleOrBuilder getBackupRulesOrBuilder(int index)
Required. The backup rules for this BackupPlan. There must be at least
one BackupRule message.
repeated .google.cloud.backupdr.v1.BackupRule backup_rules = 6 [(.google.api.field_behavior) = REQUIRED];
| Parameter |
| Name |
Description |
index |
int
|
getBackupRulesOrBuilderList()
public List<? extends BackupRuleOrBuilder> getBackupRulesOrBuilderList()
Required. The backup rules for this BackupPlan. There must be at least
one BackupRule message.
repeated .google.cloud.backupdr.v1.BackupRule backup_rules = 6 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
List<? extends com.google.cloud.backupdr.v1.BackupRuleOrBuilder> |
|
getBackupVault()
public String getBackupVault()
Required. Resource name of backup vault which will be used as storage
location for backups. Format:
projects/{project}/locations/{location}/backupVaults/{backupvault}
string backup_vault = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The backupVault.
|
getBackupVaultBytes()
public ByteString getBackupVaultBytes()
Required. Resource name of backup vault which will be used as storage
location for backups. Format:
projects/{project}/locations/{location}/backupVaults/{backupvault}
string backup_vault = 10 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for backupVault.
|
getBackupVaultServiceAccount()
public String getBackupVaultServiceAccount()
Output only. The Google Cloud Platform Service Account to be used by the
BackupVault for taking backups. Specify the email address of the Backup
Vault Service Account.
string backup_vault_service_account = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
String |
The backupVaultServiceAccount.
|
getBackupVaultServiceAccountBytes()
public ByteString getBackupVaultServiceAccountBytes()
Output only. The Google Cloud Platform Service Account to be used by the
BackupVault for taking backups. Specify the email address of the Backup
Vault Service Account.
string backup_vault_service_account = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
ByteString |
The bytes for backupVaultServiceAccount.
|
getCreateTime()
public Timestamp getCreateTime()
Output only. When the BackupPlan was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. When the BackupPlan was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public BackupPlan getDefaultInstanceForType()
getDescription()
public String getDescription()
Optional. The description of the BackupPlan resource.
The description allows for additional details about BackupPlan and its
use cases to be provided. An example description is the following: "This
is a backup plan that performs a daily backup at 6pm and retains data for 3
months". The description must be at most 2048 characters.
string description = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Optional. The description of the BackupPlan resource.
The description allows for additional details about BackupPlan and its
use cases to be provided. An example description is the following: "This
is a backup plan that performs a daily backup at 6pm and retains data for 3
months". The description must be at most 2048 characters.
string description = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for description.
|
getEtag()
Optional. etag is returned from the service in the response. As a user of
the service, you may provide an etag value in this field to prevent stale
resources.
string etag = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The etag.
|
getEtagBytes()
public ByteString getEtagBytes()
Optional. etag is returned from the service in the response. As a user of
the service, you may provide an etag value in this field to prevent stale
resources.
string etag = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for etag.
|
getLabels() (deprecated)
public Map<String,String> getLabels()
getLabelsCount()
public int getLabelsCount()
Optional. This collection of key/value pairs allows for custom labels to be
supplied by the user. Example, {"tag": "Weekly"}.
map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
|
getLabelsMap()
public Map<String,String> getLabelsMap()
Optional. This collection of key/value pairs allows for custom labels to be
supplied by the user. Example, {"tag": "Weekly"}.
map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Optional. This collection of key/value pairs allows for custom labels to be
supplied by the user. Example, {"tag": "Weekly"}.
map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
|
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
Optional. This collection of key/value pairs allows for custom labels to be
supplied by the user. Example, {"tag": "Weekly"}.
map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
|
getLogRetentionDays()
public long getLogRetentionDays()
Optional. Applicable only for CloudSQL resource_type.
Configures how long logs will be stored. It is defined in “days”. This
value should be greater than or equal to minimum enforced log retention
duration of the backup vault.
int64 log_retention_days = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
long |
The logRetentionDays.
|
getName()
Output only. Identifier. The resource name of the BackupPlan.
Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
Output only. Identifier. The resource name of the BackupPlan.
Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<BackupPlan> getParserForType()
Overrides
getResourceType()
public String getResourceType()
Required. The resource type to which the BackupPlan will be applied.
Examples include, "compute.googleapis.com/Instance",
"sqladmin.googleapis.com/Instance", "alloydb.googleapis.com/Cluster",
"compute.googleapis.com/Disk".
string resource_type = 8 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
String |
The resourceType.
|
getResourceTypeBytes()
public ByteString getResourceTypeBytes()
Required. The resource type to which the BackupPlan will be applied.
Examples include, "compute.googleapis.com/Instance",
"sqladmin.googleapis.com/Instance", "alloydb.googleapis.com/Cluster",
"compute.googleapis.com/Disk".
string resource_type = 8 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
ByteString |
The bytes for resourceType.
|
getRevisionId()
public String getRevisionId()
Output only. The user friendly revision ID of the BackupPlanRevision.
Example: v0, v1, v2, etc.
string revision_id = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
String |
The revisionId.
|
getRevisionIdBytes()
public ByteString getRevisionIdBytes()
Output only. The user friendly revision ID of the BackupPlanRevision.
Example: v0, v1, v2, etc.
string revision_id = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
ByteString |
The bytes for revisionId.
|
getRevisionName()
public String getRevisionName()
Output only. The resource id of the BackupPlanRevision.
Format:
projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}
string revision_name = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
String |
The revisionName.
|
getRevisionNameBytes()
public ByteString getRevisionNameBytes()
Output only. The resource id of the BackupPlanRevision.
Format:
projects/{project}/locations/{location}/backupPlans/{backup_plan}/revisions/{revision_id}
string revision_name = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
ByteString |
The bytes for revisionName.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getState()
public BackupPlan.State getState()
Output only. The State for the BackupPlan.
.google.cloud.backupdr.v1.BackupPlan.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue()
public int getStateValue()
Output only. The State for the BackupPlan.
.google.cloud.backupdr.v1.BackupPlan.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for state.
|
getSupportedResourceTypes(int index)
public String getSupportedResourceTypes(int index)
Output only. All resource types to which backupPlan can be applied.
repeated string supported_resource_types = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
| Name |
Description |
index |
int
The index of the element to return.
|
| Returns |
| Type |
Description |
String |
The supportedResourceTypes at the given index.
|
getSupportedResourceTypesBytes(int index)
public ByteString getSupportedResourceTypesBytes(int index)
Output only. All resource types to which backupPlan can be applied.
repeated string supported_resource_types = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
| Name |
Description |
index |
int
The index of the value to return.
|
| Returns |
| Type |
Description |
ByteString |
The bytes of the supportedResourceTypes at the given index.
|
getSupportedResourceTypesCount()
public int getSupportedResourceTypesCount()
Output only. All resource types to which backupPlan can be applied.
repeated string supported_resource_types = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
int |
The count of supportedResourceTypes.
|
getSupportedResourceTypesList()
public ProtocolStringList getSupportedResourceTypesList()
Output only. All resource types to which backupPlan can be applied.
repeated string supported_resource_types = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTime()
public Timestamp getUpdateTime()
Output only. When the BackupPlan was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The updateTime.
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. When the BackupPlan was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime()
public boolean hasCreateTime()
Output only. When the BackupPlan was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the createTime field is set.
|
hasUpdateTime()
public boolean hasUpdateTime()
Output only. When the BackupPlan was last updated.
.google.protobuf.Timestamp update_time = 5 [(.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
