Class RestoreTemplate.Builder (0.62.0)

public static final class RestoreTemplate.Builder extends GeneratedMessage.Builder<RestoreTemplate.Builder> implements RestoreTemplateOrBuilder

A RestoreTemplate encapsulates DR readiness configurations for validating backups.

Protobuf type google.cloud.backupdr.v1.RestoreTemplate

Static Methods

getDescriptor()

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

Methods

build()

public RestoreTemplate build()
Returns
Type Description
RestoreTemplate

buildPartial()

public RestoreTemplate buildPartial()
Returns
Type Description
RestoreTemplate

clear()

public RestoreTemplate.Builder clear()
Returns
Type Description
RestoreTemplate.Builder
Overrides

clearBackupSelectionConfig()

public RestoreTemplate.Builder clearBackupSelectionConfig()

Required. Backup selection configuration.

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

Returns
Type Description
RestoreTemplate.Builder

clearCreateTime()

public RestoreTemplate.Builder clearCreateTime()

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
RestoreTemplate.Builder

clearDescription()

public RestoreTemplate.Builder clearDescription()

Optional. User-provided description of the restore template.

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

Returns
Type Description
RestoreTemplate.Builder

This builder for chaining.

clearEtag()

public RestoreTemplate.Builder clearEtag()

Optional. Etag for concurrency control.

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

Returns
Type Description
RestoreTemplate.Builder

This builder for chaining.

clearExecutionSummary()

public RestoreTemplate.Builder clearExecutionSummary()

Output only. Summary of the last execution.

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

Returns
Type Description
RestoreTemplate.Builder

clearLabels()

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

clearName()

public RestoreTemplate.Builder clearName()

Identifier. The resource name of the RestoreTemplate.

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

Returns
Type Description
RestoreTemplate.Builder

This builder for chaining.

clearPostRestoreConfig()

public RestoreTemplate.Builder clearPostRestoreConfig()

Optional. Post-restore configuration.

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

Returns
Type Description
RestoreTemplate.Builder

clearPreRestoreConfig()

public RestoreTemplate.Builder clearPreRestoreConfig()

Optional. Pre-restore configuration.

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

Returns
Type Description
RestoreTemplate.Builder

clearResourceType()

public RestoreTemplate.Builder clearResourceType()

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
RestoreTemplate.Builder

This builder for chaining.

clearRestoreProperties()

public RestoreTemplate.Builder clearRestoreProperties()

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
RestoreTemplate.Builder

clearState()

public RestoreTemplate.Builder clearState()

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.Builder

This builder for chaining.

clearUpdateTime()

public RestoreTemplate.Builder clearUpdateTime()

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
RestoreTemplate.Builder

clearVerificationConfig()

public RestoreTemplate.Builder clearVerificationConfig()

Optional. Verification configuration.

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

Returns
Type Description
RestoreTemplate.Builder

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

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.

getBackupSelectionConfigBuilder()

public BackupSelectionConfig.Builder getBackupSelectionConfigBuilder()

Required. Backup selection configuration.

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

Returns
Type Description
BackupSelectionConfig.Builder

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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

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
Builder

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getExecutionSummaryBuilder()

public ExecutionSummary.Builder getExecutionSummaryBuilder()

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.Builder

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

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,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.

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.

getPostRestoreConfigBuilder()

public PostRestoreConfig.Builder getPostRestoreConfigBuilder()

Optional. Post-restore configuration.

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

Returns
Type Description
PostRestoreConfig.Builder

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.

getPreRestoreConfigBuilder()

public PreRestoreConfig.Builder getPreRestoreConfigBuilder()

Optional. Pre-restore configuration.

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

Returns
Type Description
PreRestoreConfig.Builder

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.

getRestorePropertiesBuilder()

public Struct.Builder getRestorePropertiesBuilder()

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
Builder

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

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.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

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
Builder

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.

getVerificationConfigBuilder()

public VerificationConfig.Builder getVerificationConfigBuilder()

Optional. Verification configuration.

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

Returns
Type Description
VerificationConfig.Builder

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.

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.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBackupSelectionConfig(BackupSelectionConfig value)

public RestoreTemplate.Builder mergeBackupSelectionConfig(BackupSelectionConfig value)

Required. Backup selection configuration.

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

Parameter
Name Description
value BackupSelectionConfig
Returns
Type Description
RestoreTemplate.Builder

mergeCreateTime(Timestamp value)

public RestoreTemplate.Builder mergeCreateTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
RestoreTemplate.Builder

mergeExecutionSummary(ExecutionSummary value)

public RestoreTemplate.Builder mergeExecutionSummary(ExecutionSummary value)

Output only. Summary of the last execution.

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

Parameter
Name Description
value ExecutionSummary
Returns
Type Description
RestoreTemplate.Builder

mergeFrom(RestoreTemplate other)

public RestoreTemplate.Builder mergeFrom(RestoreTemplate other)
Parameter
Name Description
other RestoreTemplate
Returns
Type Description
RestoreTemplate.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RestoreTemplate.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RestoreTemplate.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RestoreTemplate.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RestoreTemplate.Builder
Overrides

mergePostRestoreConfig(PostRestoreConfig value)

public RestoreTemplate.Builder mergePostRestoreConfig(PostRestoreConfig value)

Optional. Post-restore configuration.

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

Parameter
Name Description
value PostRestoreConfig
Returns
Type Description
RestoreTemplate.Builder

mergePreRestoreConfig(PreRestoreConfig value)

public RestoreTemplate.Builder mergePreRestoreConfig(PreRestoreConfig value)

Optional. Pre-restore configuration.

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

Parameter
Name Description
value PreRestoreConfig
Returns
Type Description
RestoreTemplate.Builder

mergeRestoreProperties(Struct value)

public RestoreTemplate.Builder mergeRestoreProperties(Struct value)

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];

Parameter
Name Description
value Struct
Returns
Type Description
RestoreTemplate.Builder

mergeUpdateTime(Timestamp value)

public RestoreTemplate.Builder mergeUpdateTime(Timestamp value)

Output only. The time when the restore template was last updated.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
RestoreTemplate.Builder

mergeVerificationConfig(VerificationConfig value)

public RestoreTemplate.Builder mergeVerificationConfig(VerificationConfig value)

Optional. Verification configuration.

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

Parameter
Name Description
value VerificationConfig
Returns
Type Description
RestoreTemplate.Builder

putAllLabels(Map<String,String> values)

public RestoreTemplate.Builder putAllLabels(Map<String,String> values)

Optional. User-defined labels.

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

Parameter
Name Description
values Map<String,String>
Returns
Type Description
RestoreTemplate.Builder

putLabels(String key, String value)

public RestoreTemplate.Builder putLabels(String key, String value)

Optional. User-defined labels.

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

Parameters
Name Description
key String
value String
Returns
Type Description
RestoreTemplate.Builder

removeLabels(String key)

public RestoreTemplate.Builder removeLabels(String key)

Optional. User-defined labels.

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

Parameter
Name Description
key String
Returns
Type Description
RestoreTemplate.Builder

setBackupSelectionConfig(BackupSelectionConfig value)

public RestoreTemplate.Builder setBackupSelectionConfig(BackupSelectionConfig value)

Required. Backup selection configuration.

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

Parameter
Name Description
value BackupSelectionConfig
Returns
Type Description
RestoreTemplate.Builder

setBackupSelectionConfig(BackupSelectionConfig.Builder builderForValue)

public RestoreTemplate.Builder setBackupSelectionConfig(BackupSelectionConfig.Builder builderForValue)

Required. Backup selection configuration.

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

Parameter
Name Description
builderForValue BackupSelectionConfig.Builder
Returns
Type Description
RestoreTemplate.Builder

setCreateTime(Timestamp value)

public RestoreTemplate.Builder setCreateTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
RestoreTemplate.Builder

setCreateTime(Timestamp.Builder builderForValue)

public RestoreTemplate.Builder setCreateTime(Timestamp.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
RestoreTemplate.Builder

setDescription(String value)

public RestoreTemplate.Builder setDescription(String value)

Optional. User-provided description of the restore template.

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

Parameter
Name Description
value String

The description to set.

Returns
Type Description
RestoreTemplate.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public RestoreTemplate.Builder setDescriptionBytes(ByteString value)

Optional. User-provided description of the restore template.

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

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
RestoreTemplate.Builder

This builder for chaining.

setEtag(String value)

public RestoreTemplate.Builder setEtag(String value)

Optional. Etag for concurrency control.

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

Parameter
Name Description
value String

The etag to set.

Returns
Type Description
RestoreTemplate.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public RestoreTemplate.Builder setEtagBytes(ByteString value)

Optional. Etag for concurrency control.

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

Parameter
Name Description
value ByteString

The bytes for etag to set.

Returns
Type Description
RestoreTemplate.Builder

This builder for chaining.

setExecutionSummary(ExecutionSummary value)

public RestoreTemplate.Builder setExecutionSummary(ExecutionSummary value)

Output only. Summary of the last execution.

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

Parameter
Name Description
value ExecutionSummary
Returns
Type Description
RestoreTemplate.Builder

setExecutionSummary(ExecutionSummary.Builder builderForValue)

public RestoreTemplate.Builder setExecutionSummary(ExecutionSummary.Builder builderForValue)

Output only. Summary of the last execution.

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

Parameter
Name Description
builderForValue ExecutionSummary.Builder
Returns
Type Description
RestoreTemplate.Builder

setName(String value)

public RestoreTemplate.Builder setName(String value)

Identifier. The resource name of the RestoreTemplate.

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

Parameter
Name Description
value String

The name to set.

Returns
Type Description
RestoreTemplate.Builder

This builder for chaining.

setNameBytes(ByteString value)

public RestoreTemplate.Builder setNameBytes(ByteString value)

Identifier. The resource name of the RestoreTemplate.

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

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
RestoreTemplate.Builder

This builder for chaining.

setPostRestoreConfig(PostRestoreConfig value)

public RestoreTemplate.Builder setPostRestoreConfig(PostRestoreConfig value)

Optional. Post-restore configuration.

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

Parameter
Name Description
value PostRestoreConfig
Returns
Type Description
RestoreTemplate.Builder

setPostRestoreConfig(PostRestoreConfig.Builder builderForValue)

public RestoreTemplate.Builder setPostRestoreConfig(PostRestoreConfig.Builder builderForValue)

Optional. Post-restore configuration.

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

Parameter
Name Description
builderForValue PostRestoreConfig.Builder
Returns
Type Description
RestoreTemplate.Builder

setPreRestoreConfig(PreRestoreConfig value)

public RestoreTemplate.Builder setPreRestoreConfig(PreRestoreConfig value)

Optional. Pre-restore configuration.

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

Parameter
Name Description
value PreRestoreConfig
Returns
Type Description
RestoreTemplate.Builder

setPreRestoreConfig(PreRestoreConfig.Builder builderForValue)

public RestoreTemplate.Builder setPreRestoreConfig(PreRestoreConfig.Builder builderForValue)

Optional. Pre-restore configuration.

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

Parameter
Name Description
builderForValue PreRestoreConfig.Builder
Returns
Type Description
RestoreTemplate.Builder

setResourceType(String value)

public RestoreTemplate.Builder setResourceType(String value)

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];

Parameter
Name Description
value String

The resourceType to set.

Returns
Type Description
RestoreTemplate.Builder

This builder for chaining.

setResourceTypeBytes(ByteString value)

public RestoreTemplate.Builder setResourceTypeBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for resourceType to set.

Returns
Type Description
RestoreTemplate.Builder

This builder for chaining.

setRestoreProperties(Struct value)

public RestoreTemplate.Builder setRestoreProperties(Struct value)

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];

Parameter
Name Description
value Struct
Returns
Type Description
RestoreTemplate.Builder

setRestoreProperties(Struct.Builder builderForValue)

public RestoreTemplate.Builder setRestoreProperties(Struct.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
RestoreTemplate.Builder

setState(RestoreTemplate.State value)

public RestoreTemplate.Builder setState(RestoreTemplate.State value)

Output only. The state of the restore template.

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

Parameter
Name Description
value RestoreTemplate.State

The state to set.

Returns
Type Description
RestoreTemplate.Builder

This builder for chaining.

setStateValue(int value)

public RestoreTemplate.Builder setStateValue(int value)

Output only. The state of the restore template.

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

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.

Returns
Type Description
RestoreTemplate.Builder

This builder for chaining.

setUpdateTime(Timestamp value)

public RestoreTemplate.Builder setUpdateTime(Timestamp value)

Output only. The time when the restore template was last updated.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
RestoreTemplate.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public RestoreTemplate.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. The time when the restore template was last updated.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
RestoreTemplate.Builder

setVerificationConfig(VerificationConfig value)

public RestoreTemplate.Builder setVerificationConfig(VerificationConfig value)

Optional. Verification configuration.

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

Parameter
Name Description
value VerificationConfig
Returns
Type Description
RestoreTemplate.Builder

setVerificationConfig(VerificationConfig.Builder builderForValue)

public RestoreTemplate.Builder setVerificationConfig(VerificationConfig.Builder builderForValue)

Optional. Verification configuration.

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

Parameter
Name Description
builderForValue VerificationConfig.Builder
Returns
Type Description
RestoreTemplate.Builder