/*
* Copyright 2020 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/gkebackup/v1/backup_plan.proto
package com.google.cloud.gkebackup.v1;
public interface BackupPlanOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.gkebackup.v1.BackupPlan)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* Output only. The full name of the BackupPlan resource.
* Format: projects/*/locations/*/backupPlans/*
*
*
* string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* Output only. The full name of the BackupPlan resource.
* Format: projects/*/locations/*/backupPlans/*
*
*
* string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* Output only. Server generated global unique identifier of
* [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
*
*
* string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The uid.
*/
java.lang.String getUid();
/**
*
*
*
* Output only. Server generated global unique identifier of
* [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
*
*
* string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
* @return The bytes for uid.
*/
com.google.protobuf.ByteString getUidBytes();
/**
*
*
*
* Output only. The timestamp when this BackupPlan resource was created.
*
*
* .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the createTime field is set.
*/
boolean hasCreateTime();
/**
*
*
*
* Output only. The timestamp when this BackupPlan resource was created.
*
*
* .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return The createTime.
*/
com.google.protobuf.Timestamp getCreateTime();
/**
*
*
*
* Output only. The timestamp when this BackupPlan resource was created.
*
*
* .google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* Output only. The timestamp when this BackupPlan resource was last
* updated.
*
*
* .google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
*
*
* @return Whether the updateTime field is set.
*/
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];
*
*
* @return The updateTime.
*/
com.google.protobuf.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];
*
*/
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();
/**
*
*
*
* User specified descriptive string for this BackupPlan.
*
*
* string description = 5;
*
* @return The description.
*/
java.lang.String getDescription();
/**
*
*
*
* User specified descriptive string for this BackupPlan.
*
*
* string description = 5;
*
* @return The bytes for description.
*/
com.google.protobuf.ByteString getDescriptionBytes();
/**
*
*
*
* 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) = { ... }
*
*
* @return The cluster.
*/
java.lang.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) = { ... }
*
*
* @return The bytes for cluster.
*/
com.google.protobuf.ByteString getClusterBytes();
/**
*
*
*
* RetentionPolicy governs lifecycle of Backups created under this plan.
*
*
* .google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy retention_policy = 7;
*
* @return Whether the retentionPolicy field is set.
*/
boolean hasRetentionPolicy();
/**
*
*
*
* RetentionPolicy governs lifecycle of Backups created under this plan.
*
*
* .google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy retention_policy = 7;
*
* @return The retentionPolicy.
*/
com.google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy getRetentionPolicy();
/**
*
*
*
* RetentionPolicy governs lifecycle of Backups created under this plan.
*
*
* .google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy retention_policy = 7;
*/
com.google.cloud.gkebackup.v1.BackupPlan.RetentionPolicyOrBuilder getRetentionPolicyOrBuilder();
/**
*
*
*
* A set of custom labels supplied by user.
*
*
* map<string, string> labels = 8;
*/
int getLabelsCount();
/**
*
*
*
* A set of custom labels supplied by user.
*
*
* map<string, string> labels = 8;
*/
boolean containsLabels(java.lang.String key);
/** Use {@link #getLabelsMap()} instead. */
@java.lang.Deprecated
java.util.Map getLabels();
/**
*
*
*
* A set of custom labels supplied by user.
*
*
* map<string, string> labels = 8;
*/
java.util.Map getLabelsMap();
/**
*
*
*
* A set of custom labels supplied by user.
*
*
* map<string, string> labels = 8;
*/
/* nullable */
java.lang.String getLabelsOrDefault(
java.lang.String key,
/* nullable */
java.lang.String defaultValue);
/**
*
*
*
* A set of custom labels supplied by user.
*
*
* map<string, string> labels = 8;
*/
java.lang.String getLabelsOrThrow(java.lang.String key);
/**
*
*
*
* Defines a schedule for automatic Backup creation via this BackupPlan.
*
*
* .google.cloud.gkebackup.v1.BackupPlan.Schedule backup_schedule = 9;
*
* @return Whether the backupSchedule field is set.
*/
boolean hasBackupSchedule();
/**
*
*
*
* Defines a schedule for automatic Backup creation via this BackupPlan.
*
*
* .google.cloud.gkebackup.v1.BackupPlan.Schedule backup_schedule = 9;
*
* @return The backupSchedule.
*/
com.google.cloud.gkebackup.v1.BackupPlan.Schedule getBackupSchedule();
/**
*
*
*
* Defines a schedule for automatic Backup creation via this BackupPlan.
*
*
* .google.cloud.gkebackup.v1.BackupPlan.Schedule backup_schedule = 9;
*/
com.google.cloud.gkebackup.v1.BackupPlan.ScheduleOrBuilder getBackupScheduleOrBuilder();
/**
*
*
*
* 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];
*
* @return The etag.
*/
java.lang.String 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];
*
* @return The bytes for etag.
*/
com.google.protobuf.ByteString getEtagBytes();
/**
*
*
*
* 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;
*
* @return The deactivated.
*/
boolean getDeactivated();
/**
*
*
*
* Defines the configuration of Backups created via this BackupPlan.
*
*
* .google.cloud.gkebackup.v1.BackupPlan.BackupConfig backup_config = 12;
*
* @return Whether the backupConfig field is set.
*/
boolean hasBackupConfig();
/**
*
*
*
* Defines the configuration of Backups created via this BackupPlan.
*
*
* .google.cloud.gkebackup.v1.BackupPlan.BackupConfig backup_config = 12;
*
* @return The backupConfig.
*/
com.google.cloud.gkebackup.v1.BackupPlan.BackupConfig getBackupConfig();
/**
*
*
*
* Defines the configuration of Backups created via this BackupPlan.
*
*
* .google.cloud.gkebackup.v1.BackupPlan.BackupConfig backup_config = 12;
*/
com.google.cloud.gkebackup.v1.BackupPlan.BackupConfigOrBuilder getBackupConfigOrBuilder();
/**
*
*
*
* 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];
*
* @return The protectedPodCount.
*/
int getProtectedPodCount();
}