public final class RestorePlan extends GeneratedMessageV3 implements RestorePlanOrBuilder
The configuration of a potential series of Restore operations to be performed
against Backups belong to a particular BackupPlan.
Protobuf type google.cloud.gkebackup.v1.RestorePlan
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
BACKUP_PLAN_FIELD_NUMBER
public static final int BACKUP_PLAN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CLUSTER_FIELD_NUMBER
public static final int CLUSTER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RESTORE_CONFIG_FIELD_NUMBER
public static final int RESTORE_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STATE_REASON_FIELD_NUMBER
public static final int STATE_REASON_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static RestorePlan getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static RestorePlan.Builder newBuilder()
newBuilder(RestorePlan prototype)
public static RestorePlan.Builder newBuilder(RestorePlan prototype)
public static RestorePlan parseDelimitedFrom(InputStream input)
public static RestorePlan parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static RestorePlan parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RestorePlan parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static RestorePlan parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RestorePlan parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RestorePlan parseFrom(CodedInputStream input)
public static RestorePlan parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static RestorePlan parseFrom(InputStream input)
public static RestorePlan parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static RestorePlan parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RestorePlan parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<RestorePlan> parser()
Methods
containsLabels(String key)
public boolean containsLabels(String key)
Optional. A set of custom labels supplied by user.
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getBackupPlan()
public String getBackupPlan()
Required. Immutable. A reference to the
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) = { ... }
| Returns |
| Type |
Description |
String |
The backupPlan.
|
getBackupPlanBytes()
public ByteString getBackupPlanBytes()
Required. Immutable. A reference to the
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) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for backupPlan.
|
getCluster()
public 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) = { ... }
| Returns |
| Type |
Description |
String |
The cluster.
|
getClusterBytes()
public 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) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for cluster.
|
getCreateTime()
public Timestamp getCreateTime()
Output only. The timestamp when this RestorePlan resource was
created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The timestamp when this RestorePlan resource was
created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public RestorePlan getDefaultInstanceForType()
getDescription()
public String getDescription()
Optional. User specified descriptive string for this RestorePlan.
string description = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
Optional. User specified descriptive string for this RestorePlan.
string description = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for description.
|
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];
| Returns |
| Type |
Description |
String |
The etag.
|
getEtagBytes()
public 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];
| Returns |
| Type |
Description |
ByteString |
The bytes for etag.
|
getLabels() (deprecated)
public Map<String,String> getLabels()
getLabelsCount()
public int getLabelsCount()
Optional. A set of custom labels supplied by user.
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
|
getLabelsMap()
public Map<String,String> getLabelsMap()
Optional. A set of custom labels supplied by user.
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Optional. A set of custom labels supplied by user.
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
|
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
Optional. A set of custom labels supplied by user.
map<string, string> labels = 9 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
|
getName()
Output only. The full name of the RestorePlan resource.
Format: projects/*/locations/*/restorePlans/*.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
Output only. The full name of the RestorePlan resource.
Format: projects/*/locations/*/restorePlans/*.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<RestorePlan> getParserForType()
Overrides
getRestoreConfig()
public RestoreConfig getRestoreConfig()
Required. Configuration of Restores created via this RestorePlan.
.google.cloud.gkebackup.v1.RestoreConfig restore_config = 8 [(.google.api.field_behavior) = REQUIRED];
getRestoreConfigOrBuilder()
public RestoreConfigOrBuilder getRestoreConfigOrBuilder()
Required. Configuration of Restores created via this RestorePlan.
.google.cloud.gkebackup.v1.RestoreConfig restore_config = 8 [(.google.api.field_behavior) = REQUIRED];
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
getState()
public 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];
getStateReason()
public 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];
| Returns |
| Type |
Description |
String |
The stateReason.
|
getStateReasonBytes()
public 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];
| Returns |
| Type |
Description |
ByteString |
The bytes for stateReason.
|
getStateValue()
public 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];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for state.
|
getUid()
Output only. Server generated global unique identifier of
UUID format.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
String |
The uid.
|
getUidBytes()
public ByteString getUidBytes()
Output only. Server generated global unique identifier of
UUID format.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
ByteString |
The bytes for uid.
|
getUpdateTime()
public 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];
| Returns |
| Type |
Description |
Timestamp |
The updateTime.
|
getUpdateTimeOrBuilder()
public 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];
hasCreateTime()
public boolean hasCreateTime()
Output only. The timestamp when this RestorePlan resource was
created.
.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the createTime field is set.
|
hasRestoreConfig()
public boolean hasRestoreConfig()
Required. Configuration of Restores created via this RestorePlan.
.google.cloud.gkebackup.v1.RestoreConfig restore_config = 8 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
boolean |
Whether the restoreConfig field is set.
|
hasUpdateTime()
public 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];
| Returns |
| Type |
Description |
boolean |
Whether the updateTime field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public RestorePlan.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RestorePlan.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public RestorePlan.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
