Class RestoreTemplate (0.62.0)

public final class RestoreTemplate extends GeneratedMessage implements RestoreTemplateOrBuilder

A RestoreTemplate encapsulates DR readiness configurations for validating backups.

Protobuf type google.cloud.backupdr.v1.RestoreTemplate

Static Fields

BACKUP_SELECTION_CONFIG_FIELD_NUMBER

public static final int BACKUP_SELECTION_CONFIG_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

EXECUTION_SUMMARY_FIELD_NUMBER

public static final int EXECUTION_SUMMARY_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

POST_RESTORE_CONFIG_FIELD_NUMBER

public static final int POST_RESTORE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

PRE_RESTORE_CONFIG_FIELD_NUMBER

public static final int PRE_RESTORE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

RESOURCE_TYPE_FIELD_NUMBER

public static final int RESOURCE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

RESTORE_PROPERTIES_FIELD_NUMBER

public static final int RESTORE_PROPERTIES_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

VERIFICATION_CONFIG_FIELD_NUMBER

public static final int VERIFICATION_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RestoreTemplate getDefaultInstance()
Returns
Type Description
RestoreTemplate

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static RestoreTemplate.Builder newBuilder()
Returns
Type Description
RestoreTemplate.Builder

newBuilder(RestoreTemplate prototype)

public static RestoreTemplate.Builder newBuilder(RestoreTemplate prototype)
Parameter
Name Description
prototype RestoreTemplate
Returns
Type Description
RestoreTemplate.Builder

parseDelimitedFrom(InputStream input)

public static RestoreTemplate parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RestoreTemplate
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RestoreTemplate parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RestoreTemplate
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RestoreTemplate parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RestoreTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RestoreTemplate parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RestoreTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RestoreTemplate parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RestoreTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RestoreTemplate parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RestoreTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RestoreTemplate parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RestoreTemplate
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RestoreTemplate parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RestoreTemplate
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RestoreTemplate parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RestoreTemplate
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RestoreTemplate parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RestoreTemplate
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RestoreTemplate parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RestoreTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RestoreTemplate parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RestoreTemplate
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RestoreTemplate> parser()
Returns
Type Description
Parser<RestoreTemplate>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Optional. User-defined labels.

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBackupSelectionConfig()

public BackupSelectionConfig getBackupSelectionConfig()

Required. Backup selection configuration.

.google.cloud.backupdr.v1.BackupSelectionConfig backup_selection_config = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
BackupSelectionConfig

The backupSelectionConfig.

getBackupSelectionConfigOrBuilder()

public BackupSelectionConfigOrBuilder getBackupSelectionConfigOrBuilder()

Required. Backup selection configuration.

.google.cloud.backupdr.v1.BackupSelectionConfig backup_selection_config = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
BackupSelectionConfigOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. The time when the restore template 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 time when the restore template was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public RestoreTemplate getDefaultInstanceForType()
Returns
Type Description
RestoreTemplate

getDescription()

public String getDescription()

Optional. User-provided description of the restore template.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. User-provided description of the restore template.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getEtag()

public String getEtag()

Optional. Etag for concurrency control.

string etag = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

Optional. Etag for concurrency control.

string etag = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for etag.

getExecutionSummary()

public ExecutionSummary getExecutionSummary()

Output only. Summary of the last execution.

.google.cloud.backupdr.v1.ExecutionSummary execution_summary = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ExecutionSummary

The executionSummary.

getExecutionSummaryOrBuilder()

public ExecutionSummaryOrBuilder getExecutionSummaryOrBuilder()

Output only. Summary of the last execution.

.google.cloud.backupdr.v1.ExecutionSummary execution_summary = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ExecutionSummaryOrBuilder

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. User-defined labels.

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional. User-defined labels.

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional. User-defined labels.

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional. User-defined labels.

map<string, string> labels = 6 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getName()

public String getName()

Identifier. The resource name of the RestoreTemplate.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name of the RestoreTemplate.

string name = 1 [(.google.api.field_behavior) = IDENTIFIER];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<RestoreTemplate> getParserForType()
Returns
Type Description
Parser<RestoreTemplate>
Overrides

getPostRestoreConfig()

public PostRestoreConfig getPostRestoreConfig()

Optional. Post-restore configuration.

.google.cloud.backupdr.v1.PostRestoreConfig post_restore_config = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PostRestoreConfig

The postRestoreConfig.

getPostRestoreConfigOrBuilder()

public PostRestoreConfigOrBuilder getPostRestoreConfigOrBuilder()

Optional. Post-restore configuration.

.google.cloud.backupdr.v1.PostRestoreConfig post_restore_config = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PostRestoreConfigOrBuilder

getPreRestoreConfig()

public PreRestoreConfig getPreRestoreConfig()

Optional. Pre-restore configuration.

.google.cloud.backupdr.v1.PreRestoreConfig pre_restore_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PreRestoreConfig

The preRestoreConfig.

getPreRestoreConfigOrBuilder()

public PreRestoreConfigOrBuilder getPreRestoreConfigOrBuilder()

Optional. Pre-restore configuration.

.google.cloud.backupdr.v1.PreRestoreConfig pre_restore_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PreRestoreConfigOrBuilder

getResourceType()

public String getResourceType()

Required. Immutable. The specific type of the workload being restored. The format is "{service_name}/{resource_kind}", for example, "compute.googleapis.com/Instance".

string resource_type = 5 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The resourceType.

getResourceTypeBytes()

public ByteString getResourceTypeBytes()

Required. Immutable. The specific type of the workload being restored. The format is "{service_name}/{resource_kind}", for example, "compute.googleapis.com/Instance".

string resource_type = 5 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for resourceType.

getRestoreProperties()

public Struct getRestoreProperties()

Required. Defines target environments where the resource will be restored.

The target resource name in restore_properties supports the {EXECUTION_ID} token to dynamically generate unique resource names for each execution. During restore execution, every occurrence of {EXECUTION_ID} in the target resource name is replaced with the 8-character RestoreTemplateExecution ID (for example, "restored-resource-{EXECUTION_ID}" or "restored-{EXECUTION_ID}-resource" resolves to "restored-resource-5d437b06" or "restored-5d437b06-resource").

.google.protobuf.Struct restore_properties = 11 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Struct

The restoreProperties.

getRestorePropertiesOrBuilder()

public StructOrBuilder getRestorePropertiesOrBuilder()

Required. Defines target environments where the resource will be restored.

The target resource name in restore_properties supports the {EXECUTION_ID} token to dynamically generate unique resource names for each execution. During restore execution, every occurrence of {EXECUTION_ID} in the target resource name is replaced with the 8-character RestoreTemplateExecution ID (for example, "restored-resource-{EXECUTION_ID}" or "restored-{EXECUTION_ID}-resource" resolves to "restored-resource-5d437b06" or "restored-5d437b06-resource").

.google.protobuf.Struct restore_properties = 11 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
StructOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public RestoreTemplate.State getState()

Output only. The state of the restore template.

.google.cloud.backupdr.v1.RestoreTemplate.State state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
RestoreTemplate.State

The state.

getStateValue()

public int getStateValue()

Output only. The state of the restore template.

.google.cloud.backupdr.v1.RestoreTemplate.State state = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The time when the restore template 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 time when the restore template was last updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getVerificationConfig()

public VerificationConfig getVerificationConfig()

Optional. Verification configuration.

.google.cloud.backupdr.v1.VerificationConfig verification_config = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
VerificationConfig

The verificationConfig.

getVerificationConfigOrBuilder()

public VerificationConfigOrBuilder getVerificationConfigOrBuilder()

Optional. Verification configuration.

.google.cloud.backupdr.v1.VerificationConfig verification_config = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
VerificationConfigOrBuilder

hasBackupSelectionConfig()

public boolean hasBackupSelectionConfig()

Required. Backup selection configuration.

.google.cloud.backupdr.v1.BackupSelectionConfig backup_selection_config = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the backupSelectionConfig field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. The time when the restore template was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasExecutionSummary()

public boolean hasExecutionSummary()

Output only. Summary of the last execution.

.google.cloud.backupdr.v1.ExecutionSummary execution_summary = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the executionSummary field is set.

hasPostRestoreConfig()

public boolean hasPostRestoreConfig()

Optional. Post-restore configuration.

.google.cloud.backupdr.v1.PostRestoreConfig post_restore_config = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the postRestoreConfig field is set.

hasPreRestoreConfig()

public boolean hasPreRestoreConfig()

Optional. Pre-restore configuration.

.google.cloud.backupdr.v1.PreRestoreConfig pre_restore_config = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the preRestoreConfig field is set.

hasRestoreProperties()

public boolean hasRestoreProperties()

Required. Defines target environments where the resource will be restored.

The target resource name in restore_properties supports the {EXECUTION_ID} token to dynamically generate unique resource names for each execution. During restore execution, every occurrence of {EXECUTION_ID} in the target resource name is replaced with the 8-character RestoreTemplateExecution ID (for example, "restored-resource-{EXECUTION_ID}" or "restored-{EXECUTION_ID}-resource" resolves to "restored-resource-5d437b06" or "restored-5d437b06-resource").

.google.protobuf.Struct restore_properties = 11 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the restoreProperties field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The time when the restore template 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.

hasVerificationConfig()

public boolean hasVerificationConfig()

Optional. Verification configuration.

.google.cloud.backupdr.v1.VerificationConfig verification_config = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the verificationConfig field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
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.GeneratedMessage.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RestoreTemplate.Builder newBuilderForType()
Returns
Type Description
RestoreTemplate.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected RestoreTemplate.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RestoreTemplate.Builder
Overrides

toBuilder()

public RestoreTemplate.Builder toBuilder()
Returns
Type Description
RestoreTemplate.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException