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.
Next id: 11
Protobuf type google.cloud.gkebackup.v1.RestorePlan
Static Fields
BACKUP_PLAN_FIELD_NUMBER
public static final int BACKUP_PLAN_FIELD_NUMBER
Field Value
CLUSTER_FIELD_NUMBER
public static final int CLUSTER_FIELD_NUMBER
Field Value
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
RESTORE_CONFIG_FIELD_NUMBER
public static final int RESTORE_CONFIG_FIELD_NUMBER
Field Value
UID_FIELD_NUMBER
public static final int UID_FIELD_NUMBER
Field Value
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static RestorePlan getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static RestorePlan.Builder newBuilder()
Returns
newBuilder(RestorePlan prototype)
public static RestorePlan.Builder newBuilder(RestorePlan prototype)
Parameter
Returns
public static RestorePlan parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static RestorePlan parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static RestorePlan parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RestorePlan parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static RestorePlan parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RestorePlan parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static RestorePlan parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static RestorePlan parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static RestorePlan parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static RestorePlan parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static RestorePlan parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RestorePlan parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<RestorePlan> parser()
Returns
Methods
containsLabels(String key)
public boolean containsLabels(String key)
A set of custom labels supplied by user.
map<string, string> labels = 9;
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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) = { ... }
| 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) = { ... }
| 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) = { ... }
| 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) = { ... }
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];
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()
Returns
getDescription()
public String getDescription()
User specified descriptive string for this RestorePlan.
string description = 5;
| Type | Description |
| String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
User specified descriptive string for this RestorePlan.
string description = 5;
| 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];
| 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];
getLabels()
public Map<String,String> getLabels()
Returns
getLabelsCount()
public int getLabelsCount()
A set of custom labels supplied by user.
map<string, string> labels = 9;
getLabelsMap()
public Map<String,String> getLabelsMap()
A set of custom labels supplied by user.
map<string, string> labels = 9;
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
A set of custom labels supplied by user.
map<string, string> labels = 9;
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
A set of custom labels supplied by user.
map<string, string> labels = 9;
getName()
Output only. The full name of the RestorePlan resource.
Format: projects/*/locations/*/restorePlans/*.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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];
getParserForType()
public Parser<RestorePlan> getParserForType()
Returns
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
Overrides
getUid()
Output only. Server generated global unique identifier of
UUID format.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUidBytes()
public ByteString getUidBytes()
Output only. Server generated global unique identifier of
UUID format.
string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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];
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];
| 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];
| 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];
| Type | Description |
| boolean | Whether the updateTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public RestorePlan.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RestorePlan.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public RestorePlan.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
