com.google.cloud.backupdr.v1.BackupVaultOrBuilder 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/backupvault.proto
// Protobuf Java Version: 3.25.5
package com.google.cloud.backupdr.v1;
public interface BackupVaultOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.backupdr.v1.BackupVault)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Output only. Identifier. Name of the backup vault to create. It must have
* the
* format`"projects/{project}/locations/{location}/backupVaults/{backupvault}"`.
* `{backupvault}` cannot be changed after creation. It must be between 3-63
* characters long and must be unique within the project and location.
*
*
*
* string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_behavior) = IDENTIFIER];
*
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* Output only. Identifier. Name of the backup vault to create. It must have
* the
* format`"projects/{project}/locations/{location}/backupVaults/{backupvault}"`.
* `{backupvault}` cannot be changed after creation. It must be between 3-63
* characters long and must be unique within the project and location.
*
*
*
* 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 BackupVault instance (2048 characters or
* less).
*
*
* optional string description = 2 [(.google.api.field_behavior) = OPTIONAL];
*
* @return Whether the description field is set.
*/
boolean hasDescription();
/**
*
*
*
* Optional. The description of the BackupVault instance (2048 characters or
* less).
*
*
* optional string description = 2 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The description.
*/
java.lang.String getDescription();
/**
*
*
*
* Optional. The description of the BackupVault instance (2048 characters or
* less).
*
*
* optional string description = 2 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for description.
*/
com.google.protobuf.ByteString getDescriptionBytes();
/**
*
*
*
* Optional. Resource labels to represent user provided metadata.
* No labels currently defined:
*
*
* map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];
*/
int getLabelsCount();
/**
*
*
*
* Optional. Resource labels to represent user provided metadata.
* No labels currently defined:
*
*
* 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. Resource labels to represent user provided metadata.
* No labels currently defined:
*
*
* map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];
*/
java.util.Map getLabelsMap();
/**
*
*
*
* Optional. Resource labels to represent user provided metadata.
* No labels currently defined:
*
*
* 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. Resource labels to represent user provided metadata.
* No labels currently defined:
*
*
* map<string, string> labels = 3 [(.google.api.field_behavior) = OPTIONAL];
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
/**
*
*
*
* Output only. The time when the instance was created.
*
*
*
* optional .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. The time when the instance was created.
*
*
*
* optional .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The createTime.
*/
com.google.protobuf.Timestamp getCreateTime();
/**
*
*
*
* Output only. The time when the instance was created.
*
*
*
* optional .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Output only. The time when the instance was updated.
*
*
*
* optional .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the updateTime field is set.
*/
boolean hasUpdateTime();
/**
*
*
*
* Output only. The time when the instance was updated.
*
*
*
* optional .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The updateTime.
*/
com.google.protobuf.Timestamp getUpdateTime();
/**
*
*
*
* Output only. The time when the instance was updated.
*
*
*
* optional .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();
/**
*
*
*
* Required. The default and minimum enforced retention for each backup within
* the backup vault. The enforced retention for each backup can be extended.
*
*
*
* optional .google.protobuf.Duration backup_minimum_enforced_retention_duration = 20 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return Whether the backupMinimumEnforcedRetentionDuration field is set.
*/
boolean hasBackupMinimumEnforcedRetentionDuration();
/**
*
*
*
* Required. The default and minimum enforced retention for each backup within
* the backup vault. The enforced retention for each backup can be extended.
*
*
*
* optional .google.protobuf.Duration backup_minimum_enforced_retention_duration = 20 [(.google.api.field_behavior) = REQUIRED];
*
*
* @return The backupMinimumEnforcedRetentionDuration.
*/
com.google.protobuf.Duration getBackupMinimumEnforcedRetentionDuration();
/**
*
*
*
* Required. The default and minimum enforced retention for each backup within
* the backup vault. The enforced retention for each backup can be extended.
*
*
*
* optional .google.protobuf.Duration backup_minimum_enforced_retention_duration = 20 [(.google.api.field_behavior) = REQUIRED];
*
*/
com.google.protobuf.DurationOrBuilder getBackupMinimumEnforcedRetentionDurationOrBuilder();
/**
*
*
*
* Output only. Set to true when there are no backups nested under this
* resource.
*
*
* optional bool deletable = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return Whether the deletable field is set.
*/
boolean hasDeletable();
/**
*
*
*
* Output only. Set to true when there are no backups nested under this
* resource.
*
*
* optional bool deletable = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The deletable.
*/
boolean getDeletable();
/**
*
*
*
* Optional. Server specified ETag for the backup vault resource to
* prevent simultaneous updates from overwiting each other.
*
*
* optional string etag = 9 [(.google.api.field_behavior) = OPTIONAL];
*
* @return Whether the etag field is set.
*/
boolean hasEtag();
/**
*
*
*
* Optional. Server specified ETag for the backup vault resource to
* prevent simultaneous updates from overwiting each other.
*
*
* optional string etag = 9 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The etag.
*/
java.lang.String getEtag();
/**
*
*
*
* Optional. Server specified ETag for the backup vault resource to
* prevent simultaneous updates from overwiting each other.
*
*
* optional string etag = 9 [(.google.api.field_behavior) = OPTIONAL];
*
* @return The bytes for etag.
*/
com.google.protobuf.ByteString getEtagBytes();
/**
*
*
*
* Output only. The BackupVault resource instance state.
*
*
*
* .google.cloud.backupdr.v1.BackupVault.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The enum numeric value on the wire for state.
*/
int getStateValue();
/**
*
*
*
* Output only. The BackupVault resource instance state.
*
*
*
* .google.cloud.backupdr.v1.BackupVault.State state = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The state.
*/
com.google.cloud.backupdr.v1.BackupVault.State getState();
/**
*
*
*
* Optional. Time after which the BackupVault resource is locked.
*
*
*
* optional .google.protobuf.Timestamp effective_time = 12 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return Whether the effectiveTime field is set.
*/
boolean hasEffectiveTime();
/**
*
*
*
* Optional. Time after which the BackupVault resource is locked.
*
*
*
* optional .google.protobuf.Timestamp effective_time = 12 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The effectiveTime.
*/
com.google.protobuf.Timestamp getEffectiveTime();
/**
*
*
*
* Optional. Time after which the BackupVault resource is locked.
*
*
*
* optional .google.protobuf.Timestamp effective_time = 12 [(.google.api.field_behavior) = OPTIONAL];
*
*/
com.google.protobuf.TimestampOrBuilder getEffectiveTimeOrBuilder();
/**
*
*
*
* Output only. The number of backups in this backup vault.
*
*
* int64 backup_count = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The backupCount.
*/
long getBackupCount();
/**
*
*
*
* Output only. Service account used by the BackupVault Service for this
* BackupVault. The user should grant this account permissions in their
* workload project to enable the service to run backups and restores there.
*
*
* string service_account = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The serviceAccount.
*/
java.lang.String getServiceAccount();
/**
*
*
*
* Output only. Service account used by the BackupVault Service for this
* BackupVault. The user should grant this account permissions in their
* workload project to enable the service to run backups and restores there.
*
*
* string service_account = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for serviceAccount.
*/
com.google.protobuf.ByteString getServiceAccountBytes();
/**
*
*
*
* Output only. Total size of the storage used by all backup resources.
*
*
* int64 total_stored_bytes = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The totalStoredBytes.
*/
long getTotalStoredBytes();
/**
*
*
*
* Output only. Output only
* Immutable after resource creation until resource deletion.
*
*
*
* string uid = 21 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }
*
*
* @return The uid.
*/
java.lang.String getUid();
/**
*
*
*
* Output only. Output only
* Immutable after resource creation until resource deletion.
*
*
*
* string uid = 21 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.field_info) = { ... }
*
*
* @return The bytes for uid.
*/
com.google.protobuf.ByteString getUidBytes();
/**
*
*
*
* Optional. User annotations. See https://google.aip.dev/128#annotations
* Stores small amounts of arbitrary data.
*
*
* map<string, string> annotations = 22 [(.google.api.field_behavior) = OPTIONAL];
*
*/
int getAnnotationsCount();
/**
*
*
*
* Optional. User annotations. See https://google.aip.dev/128#annotations
* Stores small amounts of arbitrary data.
*
*
* map<string, string> annotations = 22 [(.google.api.field_behavior) = OPTIONAL];
*
*/
boolean containsAnnotations(java.lang.String key);
/** Use {@link #getAnnotationsMap()} instead. */
@java.lang.Deprecated
java.util.Map getAnnotations();
/**
*
*
*
* Optional. User annotations. See https://google.aip.dev/128#annotations
* Stores small amounts of arbitrary data.
*
*
* map<string, string> annotations = 22 [(.google.api.field_behavior) = OPTIONAL];
*
*/
java.util.Map getAnnotationsMap();
/**
*
*
*
* Optional. User annotations. See https://google.aip.dev/128#annotations
* Stores small amounts of arbitrary data.
*
*
* map<string, string> annotations = 22 [(.google.api.field_behavior) = OPTIONAL];
*
*/
/* nullable */
java.lang.String getAnnotationsOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* Optional. User annotations. See https://google.aip.dev/128#annotations
* Stores small amounts of arbitrary data.
*
*
* map<string, string> annotations = 22 [(.google.api.field_behavior) = OPTIONAL];
*
*/
java.lang.String getAnnotationsOrThrow(java.lang.String key);
/**
*
*
*
* Optional. Note: This field is added for future use case and will not be
* supported in the current release.
*
* Optional.
*
* Access restriction for the backup vault.
* Default value is WITHIN_ORGANIZATION if not provided during creation.
*
*
*
* .google.cloud.backupdr.v1.BackupVault.AccessRestriction access_restriction = 24 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The enum numeric value on the wire for accessRestriction.
*/
int getAccessRestrictionValue();
/**
*
*
*
* Optional. Note: This field is added for future use case and will not be
* supported in the current release.
*
* Optional.
*
* Access restriction for the backup vault.
* Default value is WITHIN_ORGANIZATION if not provided during creation.
*
*
*
* .google.cloud.backupdr.v1.BackupVault.AccessRestriction access_restriction = 24 [(.google.api.field_behavior) = OPTIONAL];
*
*
* @return The accessRestriction.
*/
com.google.cloud.backupdr.v1.BackupVault.AccessRestriction getAccessRestriction();
}