com.google.cloud.backupdr.v1.BackupPlanOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-backupdr-v1 Show documentation
Show all versions of proto-google-cloud-backupdr-v1 Show documentation
Proto library for google-cloud-backupdr
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/backupdr/v1/backupplan.proto
// Protobuf Java Version: 3.25.5
package com.google.cloud.backupdr.v1;
public interface BackupPlanOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.backupdr.v1.BackupPlan)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* 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];
*
*
* @return The name.
*/
java.lang.String 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];
*
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* 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];
*
* @return The description.
*/
java.lang.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];
*
* @return The bytes for description.
*/
com.google.protobuf.ByteString getDescriptionBytes();
/**
*
*
*
* 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];
*/
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];
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* 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];
*/
java.util.Map 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];
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.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];
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
/**
*
*
*
* Output only. When the `BackupPlan` was created.
*
*
* .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. When the `BackupPlan` was created.
*
*
* .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The createTime.
*/
com.google.protobuf.Timestamp getCreateTime();
/**
*
*
*
* Output only. When the `BackupPlan` was created.
*
*
* .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Output only. When the `BackupPlan` was last updated.
*
*
* .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the updateTime field is set.
*/
boolean hasUpdateTime();
/**
*
*
*
* Output only. When the `BackupPlan` was last updated.
*
*
* .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The updateTime.
*/
com.google.protobuf.Timestamp getUpdateTime();
/**
*
*
*
* Output only. When the `BackupPlan` was last updated.
*
*
* .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();
/**
*
*
*
* 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];
*
*/
java.util.List 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];
*
*/
com.google.cloud.backupdr.v1.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];
*
*/
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];
*
*/
java.util.List
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];
*
*/
com.google.cloud.backupdr.v1.BackupRuleOrBuilder getBackupRulesOrBuilder(int index);
/**
*
*
*
* Output only. The `State` for the `BackupPlan`.
*
*
*
* .google.cloud.backupdr.v1.BackupPlan.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The enum numeric value on the wire for state.
*/
int getStateValue();
/**
*
*
*
* Output only. The `State` for the `BackupPlan`.
*
*
*
* .google.cloud.backupdr.v1.BackupPlan.State state = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The state.
*/
com.google.cloud.backupdr.v1.BackupPlan.State getState();
/**
*
*
*
* Required. The resource type to which the `BackupPlan` will be applied.
* Examples include, "compute.googleapis.com/Instance" and
* "storage.googleapis.com/Bucket".
*
*
* string resource_type = 8 [(.google.api.field_behavior) = REQUIRED];
*
* @return The resourceType.
*/
java.lang.String getResourceType();
/**
*
*
*
* Required. The resource type to which the `BackupPlan` will be applied.
* Examples include, "compute.googleapis.com/Instance" and
* "storage.googleapis.com/Bucket".
*
*
* string resource_type = 8 [(.google.api.field_behavior) = REQUIRED];
*
* @return The bytes for resourceType.
*/
com.google.protobuf.ByteString getResourceTypeBytes();
/**
*
*
*
* 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];
*
* @return The etag.
*/
java.lang.String 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];
*
* @return The bytes for etag.
*/
com.google.protobuf.ByteString getEtagBytes();
/**
*
*
*
* 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) = { ... }
*
*
* @return The backupVault.
*/
java.lang.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) = { ... }
*
*
* @return The bytes for backupVault.
*/
com.google.protobuf.ByteString getBackupVaultBytes();
/**
*
*
*
* 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];
*
*
* @return The backupVaultServiceAccount.
*/
java.lang.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];
*
*
* @return The bytes for backupVaultServiceAccount.
*/
com.google.protobuf.ByteString getBackupVaultServiceAccountBytes();
}