Interface BackupPlanOrBuilder (0.29.0)
Stay organized with collections
Save and categorize content based on your preferences.
publicinterface BackupPlanOrBuilderextendsMessageOrBuilderImplements
MessageOrBuilderMethods
containsLabels(String key)
publicabstractbooleancontainsLabels(Stringkey)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 |
boolean |
|
getBackupRules(int index)
publicabstractBackupRulegetBackupRules(intindex) 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 |
| Returns | |
|---|---|
| Type | Description |
BackupRule |
|
getBackupRulesCount()
publicabstractintgetBackupRulesCount() 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()
publicabstractList<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];
| Returns | |
|---|---|
| Type | Description |
List<BackupRule> |
|
getBackupRulesOrBuilder(int index)
publicabstractBackupRuleOrBuildergetBackupRulesOrBuilder(intindex) 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 |
| Returns | |
|---|---|
| Type | Description |
BackupRuleOrBuilder |
|
getBackupRulesOrBuilderList()
publicabstractList<?extendsBackupRuleOrBuilder>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()
publicabstractStringgetBackupVault()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()
publicabstractByteStringgetBackupVaultBytes()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()
publicabstractStringgetBackupVaultServiceAccount()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()
publicabstractByteStringgetBackupVaultServiceAccountBytes()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()
publicabstractTimestampgetCreateTime() 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()
publicabstractTimestampOrBuildergetCreateTimeOrBuilder() Output only. When the BackupPlan was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDescription()
publicabstractStringgetDescription() 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()
publicabstractByteStringgetDescriptionBytes() 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()
publicabstractStringgetEtag() 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()
publicabstractByteStringgetEtagBytes() 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)
publicabstractMap<String,String>getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsCount()
publicabstractintgetLabelsCount()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()
publicabstractMap<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];
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getLabelsOrDefault(String key, String defaultValue)
publicabstractStringgetLabelsOrDefault(Stringkey,StringdefaultValue)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];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getLabelsOrThrow(String key)
publicabstractStringgetLabelsOrThrow(Stringkey)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()
publicabstractlonggetLogRetentionDays()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()
publicabstractStringgetName() 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()
publicabstractByteStringgetNameBytes() 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. |
getResourceType()
publicabstractStringgetResourceType() 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()
publicabstractByteStringgetResourceTypeBytes() 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()
publicabstractStringgetRevisionId() 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()
publicabstractByteStringgetRevisionIdBytes() 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()
publicabstractStringgetRevisionName() 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()
publicabstractByteStringgetRevisionNameBytes() 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. |
getState()
publicabstractBackupPlan.StategetState() Output only. The State for the BackupPlan.
.google.cloud.backupdr.v1.BackupPlan.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
BackupPlan.State |
The state. |
getStateValue()
publicabstractintgetStateValue() 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)
publicabstractStringgetSupportedResourceTypes(intindex)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)
publicabstractByteStringgetSupportedResourceTypesBytes(intindex)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()
publicabstractintgetSupportedResourceTypesCount()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()
publicabstractList<String>getSupportedResourceTypesList()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 |
List<String> |
A list containing the supportedResourceTypes. |
getUpdateTime()
publicabstractTimestampgetUpdateTime() 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()
publicabstractTimestampOrBuildergetUpdateTimeOrBuilder() Output only. When the BackupPlan was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
hasCreateTime()
publicabstractbooleanhasCreateTime() 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()
publicabstractbooleanhasUpdateTime() 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. |