public final class RestorePlan extends com.google.protobuf.GeneratedMessageV3 implements RestorePlanOrBuilder
The configuration of a potential series of Restore operations to be performed against Backups belong to a particular BackupPlan. Next id: 13Protobuf type
google.cloud.gkebackup.v1.RestorePlan| Modifier and Type | Class and Description |
|---|---|
static class |
RestorePlan.Builder
The configuration of a potential series of Restore operations to be performed
against Backups belong to a particular BackupPlan.
|
static class |
RestorePlan.State
State
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
BACKUP_PLAN_FIELD_NUMBER |
static int |
CLUSTER_FIELD_NUMBER |
static int |
CREATE_TIME_FIELD_NUMBER |
static int |
DESCRIPTION_FIELD_NUMBER |
static int |
ETAG_FIELD_NUMBER |
static int |
LABELS_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
RESTORE_CONFIG_FIELD_NUMBER |
static int |
STATE_FIELD_NUMBER |
static int |
STATE_REASON_FIELD_NUMBER |
static int |
UID_FIELD_NUMBER |
static int |
UPDATE_TIME_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
containsLabels(String key)
A set of custom labels supplied by user.
|
boolean |
equals(Object obj) |
String |
getBackupPlan()
Required.
|
com.google.protobuf.ByteString |
getBackupPlanBytes()
Required.
|
String |
getCluster()
Required.
|
com.google.protobuf.ByteString |
getClusterBytes()
Required.
|
com.google.protobuf.Timestamp |
getCreateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getCreateTimeOrBuilder()
Output only.
|
static RestorePlan |
getDefaultInstance() |
RestorePlan |
getDefaultInstanceForType() |
String |
getDescription()
User specified descriptive string for this RestorePlan.
|
com.google.protobuf.ByteString |
getDescriptionBytes()
User specified descriptive string for this RestorePlan.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getEtag()
Output only.
|
com.google.protobuf.ByteString |
getEtagBytes()
Output only.
|
Map<String,String> |
getLabels()
Deprecated.
|
int |
getLabelsCount()
A set of custom labels supplied by user.
|
Map<String,String> |
getLabelsMap()
A set of custom labels supplied by user.
|
String |
getLabelsOrDefault(String key,
String defaultValue)
A set of custom labels supplied by user.
|
String |
getLabelsOrThrow(String key)
A set of custom labels supplied by user.
|
String |
getName()
Output only.
|
com.google.protobuf.ByteString |
getNameBytes()
Output only.
|
com.google.protobuf.Parser<RestorePlan> |
getParserForType() |
RestoreConfig |
getRestoreConfig()
Required.
|
RestoreConfigOrBuilder |
getRestoreConfigOrBuilder()
Required.
|
int |
getSerializedSize() |
RestorePlan.State |
getState()
Output only.
|
String |
getStateReason()
Output only.
|
com.google.protobuf.ByteString |
getStateReasonBytes()
Output only.
|
int |
getStateValue()
Output only.
|
String |
getUid()
Output only.
|
com.google.protobuf.ByteString |
getUidBytes()
Output only.
|
com.google.protobuf.Timestamp |
getUpdateTime()
Output only.
|
com.google.protobuf.TimestampOrBuilder |
getUpdateTimeOrBuilder()
Output only.
|
boolean |
hasCreateTime()
Output only.
|
int |
hashCode() |
boolean |
hasRestoreConfig()
Required.
|
boolean |
hasUpdateTime()
Output only.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapField |
internalGetMapField(int number) |
boolean |
isInitialized() |
static RestorePlan.Builder |
newBuilder() |
static RestorePlan.Builder |
newBuilder(RestorePlan prototype) |
RestorePlan.Builder |
newBuilderForType() |
protected RestorePlan.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static RestorePlan |
parseDelimitedFrom(InputStream input) |
static RestorePlan |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static RestorePlan |
parseFrom(byte[] data) |
static RestorePlan |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static RestorePlan |
parseFrom(ByteBuffer data) |
static RestorePlan |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static RestorePlan |
parseFrom(com.google.protobuf.ByteString data) |
static RestorePlan |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static RestorePlan |
parseFrom(com.google.protobuf.CodedInputStream input) |
static RestorePlan |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static RestorePlan |
parseFrom(InputStream input) |
static RestorePlan |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<RestorePlan> |
parser() |
RestorePlan.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NAME_FIELD_NUMBER
public static final int UID_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
public static final int BACKUP_PLAN_FIELD_NUMBER
public static final int CLUSTER_FIELD_NUMBER
public static final int RESTORE_CONFIG_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
public static final int STATE_REASON_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapField internalGetMapField(int number)
internalGetMapField in class com.google.protobuf.GeneratedMessageV3protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public String getName()
Output only. The full name of the RestorePlan resource. Format: `projects/*/locations/*/restorePlans/*`.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];getName in interface RestorePlanOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
Output only. The full name of the RestorePlan resource. Format: `projects/*/locations/*/restorePlans/*`.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];getNameBytes in interface RestorePlanOrBuilderpublic 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];getUid in interface RestorePlanOrBuilderpublic com.google.protobuf.ByteString getUidBytes()
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];getUidBytes in interface RestorePlanOrBuilderpublic boolean hasCreateTime()
Output only. The timestamp when this RestorePlan resource was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime in interface RestorePlanOrBuilderpublic com.google.protobuf.Timestamp getCreateTime()
Output only. The timestamp when this RestorePlan resource was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTime in interface RestorePlanOrBuilderpublic com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The timestamp when this RestorePlan resource was created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getCreateTimeOrBuilder in interface RestorePlanOrBuilderpublic boolean hasUpdateTime()
Output only. The timestamp when this RestorePlan resource was last updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasUpdateTime in interface RestorePlanOrBuilderpublic com.google.protobuf.Timestamp getUpdateTime()
Output only. The timestamp when this RestorePlan resource was last updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTime in interface RestorePlanOrBuilderpublic com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The timestamp when this RestorePlan resource was last updated.
.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUpdateTimeOrBuilder in interface RestorePlanOrBuilderpublic String getDescription()
User specified descriptive string for this RestorePlan.
string description = 5;getDescription in interface RestorePlanOrBuilderpublic com.google.protobuf.ByteString getDescriptionBytes()
User specified descriptive string for this RestorePlan.
string description = 5;getDescriptionBytes in interface RestorePlanOrBuilderpublic String getBackupPlan()
Required. Immutable. A reference to the [BackupPlan][google.cloud.gkebackup.v1.BackupPlan] from which Backups may be used as the source for Restores created via this RestorePlan. Format: `projects/*/locations/*/backupPlans/*`.
string backup_plan = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getBackupPlan in interface RestorePlanOrBuilderpublic com.google.protobuf.ByteString getBackupPlanBytes()
Required. Immutable. A reference to the [BackupPlan][google.cloud.gkebackup.v1.BackupPlan] from which Backups may be used as the source for Restores created via this RestorePlan. Format: `projects/*/locations/*/backupPlans/*`.
string backup_plan = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getBackupPlanBytes in interface RestorePlanOrBuilderpublic String getCluster()
Required. Immutable. The target cluster into which Restores created via this RestorePlan will restore data. NOTE: the cluster's region must be the same as the RestorePlan. Valid formats: - `projects/*/locations/*/clusters/*` - `projects/*/zones/*/clusters/*`
string cluster = 7 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getCluster in interface RestorePlanOrBuilderpublic com.google.protobuf.ByteString getClusterBytes()
Required. Immutable. The target cluster into which Restores created via this RestorePlan will restore data. NOTE: the cluster's region must be the same as the RestorePlan. Valid formats: - `projects/*/locations/*/clusters/*` - `projects/*/zones/*/clusters/*`
string cluster = 7 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getClusterBytes in interface RestorePlanOrBuilderpublic boolean hasRestoreConfig()
Required. Configuration of Restores created via this RestorePlan.
.google.cloud.gkebackup.v1.RestoreConfig restore_config = 8 [(.google.api.field_behavior) = REQUIRED];
hasRestoreConfig in interface RestorePlanOrBuilderpublic RestoreConfig getRestoreConfig()
Required. Configuration of Restores created via this RestorePlan.
.google.cloud.gkebackup.v1.RestoreConfig restore_config = 8 [(.google.api.field_behavior) = REQUIRED];
getRestoreConfig in interface RestorePlanOrBuilderpublic RestoreConfigOrBuilder getRestoreConfigOrBuilder()
Required. Configuration of Restores created via this RestorePlan.
.google.cloud.gkebackup.v1.RestoreConfig restore_config = 8 [(.google.api.field_behavior) = REQUIRED];
getRestoreConfigOrBuilder in interface RestorePlanOrBuilderpublic int getLabelsCount()
RestorePlanOrBuilderA set of custom labels supplied by user.
map<string, string> labels = 9;getLabelsCount in interface RestorePlanOrBuilderpublic boolean containsLabels(String key)
A set of custom labels supplied by user.
map<string, string> labels = 9;containsLabels in interface RestorePlanOrBuilder@Deprecated public Map<String,String> getLabels()
getLabelsMap() instead.getLabels in interface RestorePlanOrBuilderpublic Map<String,String> getLabelsMap()
A set of custom labels supplied by user.
map<string, string> labels = 9;getLabelsMap in interface RestorePlanOrBuilderpublic String getLabelsOrDefault(String key, String defaultValue)
A set of custom labels supplied by user.
map<string, string> labels = 9;getLabelsOrDefault in interface RestorePlanOrBuilderpublic String getLabelsOrThrow(String key)
A set of custom labels supplied by user.
map<string, string> labels = 9;getLabelsOrThrow in interface RestorePlanOrBuilderpublic String getEtag()
Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a restore from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform restore updates in order to avoid race conditions: An `etag` is returned in the response to `GetRestorePlan`, and systems are expected to put that etag in the request to `UpdateRestorePlan` or `DeleteRestorePlan` to ensure that their change will be applied to the same version of the resource.
string etag = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];getEtag in interface RestorePlanOrBuilderpublic com.google.protobuf.ByteString getEtagBytes()
Output only. `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a restore from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform restore updates in order to avoid race conditions: An `etag` is returned in the response to `GetRestorePlan`, and systems are expected to put that etag in the request to `UpdateRestorePlan` or `DeleteRestorePlan` to ensure that their change will be applied to the same version of the resource.
string etag = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];getEtagBytes in interface RestorePlanOrBuilderpublic int getStateValue()
Output only. State of the RestorePlan. This State field reflects the various stages a RestorePlan can be in during the Create operation.
.google.cloud.gkebackup.v1.RestorePlan.State state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStateValue in interface RestorePlanOrBuilderpublic RestorePlan.State getState()
Output only. State of the RestorePlan. This State field reflects the various stages a RestorePlan can be in during the Create operation.
.google.cloud.gkebackup.v1.RestorePlan.State state = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
getState in interface RestorePlanOrBuilderpublic String getStateReason()
Output only. Human-readable description of why RestorePlan is in the current `state`
string state_reason = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];getStateReason in interface RestorePlanOrBuilderpublic com.google.protobuf.ByteString getStateReasonBytes()
Output only. Human-readable description of why RestorePlan is in the current `state`
string state_reason = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];getStateReasonBytes in interface RestorePlanOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static RestorePlan parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RestorePlan parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RestorePlan parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RestorePlan parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RestorePlan parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RestorePlan parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static RestorePlan parseFrom(InputStream input) throws IOException
IOExceptionpublic static RestorePlan parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static RestorePlan parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static RestorePlan parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static RestorePlan parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static RestorePlan parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic RestorePlan.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static RestorePlan.Builder newBuilder()
public static RestorePlan.Builder newBuilder(RestorePlan prototype)
public RestorePlan.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected RestorePlan.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static RestorePlan getDefaultInstance()
public static com.google.protobuf.Parser<RestorePlan> parser()
public com.google.protobuf.Parser<RestorePlan> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public RestorePlan getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2023 Google LLC. All rights reserved.