Class RunRestoreTemplateRequest.Builder (0.62.0)

public static final class RunRestoreTemplateRequest.Builder extends GeneratedMessage.Builder<RunRestoreTemplateRequest.Builder> implements RunRestoreTemplateRequestOrBuilder

Request message for running a RestoreTemplate.

Protobuf type google.cloud.backupdr.v1.RunRestoreTemplateRequest

Static Methods

getDescriptor()

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

Methods

build()

public RunRestoreTemplateRequest build()
Returns
Type Description
RunRestoreTemplateRequest

buildPartial()

public RunRestoreTemplateRequest buildPartial()
Returns
Type Description
RunRestoreTemplateRequest

clear()

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

clearBackup()

public RunRestoreTemplateRequest.Builder clearBackup()

Optional. The resource name of the Backup to restore from. If not specified, the latest backup matching the backup selection configuration in the RestoreTemplate will be used. Format: 'projects/{project}/locations/{location}/backupVaults/{backup_vault}/dataSources/{data_source}/backups/{backup}'

string backup = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
RunRestoreTemplateRequest.Builder

This builder for chaining.

clearName()

public RunRestoreTemplateRequest.Builder clearName()

Required. The name of the restore template to run. Format: 'projects/{project_id}/locations/{location}/restoreTemplates/{restore_template_id}'

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
RunRestoreTemplateRequest.Builder

This builder for chaining.

clearRequestId()

public RunRestoreTemplateRequest.Builder clearRequestId()

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }

Returns
Type Description
RunRestoreTemplateRequest.Builder

This builder for chaining.

getBackup()

public String getBackup()

Optional. The resource name of the Backup to restore from. If not specified, the latest backup matching the backup selection configuration in the RestoreTemplate will be used. Format: 'projects/{project}/locations/{location}/backupVaults/{backup_vault}/dataSources/{data_source}/backups/{backup}'

string backup = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The backup.

getBackupBytes()

public ByteString getBackupBytes()

Optional. The resource name of the Backup to restore from. If not specified, the latest backup matching the backup selection configuration in the RestoreTemplate will be used. Format: 'projects/{project}/locations/{location}/backupVaults/{backup_vault}/dataSources/{data_source}/backups/{backup}'

string backup = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for backup.

getDefaultInstanceForType()

public RunRestoreTemplateRequest getDefaultInstanceForType()
Returns
Type Description
RunRestoreTemplateRequest

getDescriptorForType()

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

getName()

public String getName()

Required. The name of the restore template to run. Format: 'projects/{project_id}/locations/{location}/restoreTemplates/{restore_template_id}'

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The name of the restore template to run. Format: 'projects/{project_id}/locations/{location}/restoreTemplates/{restore_template_id}'

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getRequestId()

public String getRequestId()

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }

Returns
Type Description
String

The requestId.

getRequestIdBytes()

public ByteString getRequestIdBytes()

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }

Returns
Type Description
ByteString

The bytes for requestId.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(RunRestoreTemplateRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setBackup(String value)

public RunRestoreTemplateRequest.Builder setBackup(String value)

Optional. The resource name of the Backup to restore from. If not specified, the latest backup matching the backup selection configuration in the RestoreTemplate will be used. Format: 'projects/{project}/locations/{location}/backupVaults/{backup_vault}/dataSources/{data_source}/backups/{backup}'

string backup = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The backup to set.

Returns
Type Description
RunRestoreTemplateRequest.Builder

This builder for chaining.

setBackupBytes(ByteString value)

public RunRestoreTemplateRequest.Builder setBackupBytes(ByteString value)

Optional. The resource name of the Backup to restore from. If not specified, the latest backup matching the backup selection configuration in the RestoreTemplate will be used. Format: 'projects/{project}/locations/{location}/backupVaults/{backup_vault}/dataSources/{data_source}/backups/{backup}'

string backup = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for backup to set.

Returns
Type Description
RunRestoreTemplateRequest.Builder

This builder for chaining.

setName(String value)

public RunRestoreTemplateRequest.Builder setName(String value)

Required. The name of the restore template to run. Format: 'projects/{project_id}/locations/{location}/restoreTemplates/{restore_template_id}'

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The name to set.

Returns
Type Description
RunRestoreTemplateRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public RunRestoreTemplateRequest.Builder setNameBytes(ByteString value)

Required. The name of the restore template to run. Format: 'projects/{project_id}/locations/{location}/restoreTemplates/{restore_template_id}'

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
RunRestoreTemplateRequest.Builder

This builder for chaining.

setRequestId(String value)

public RunRestoreTemplateRequest.Builder setRequestId(String value)

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }

Parameter
Name Description
value String

The requestId to set.

Returns
Type Description
RunRestoreTemplateRequest.Builder

This builder for chaining.

setRequestIdBytes(ByteString value)

public RunRestoreTemplateRequest.Builder setRequestIdBytes(ByteString value)

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }

Parameter
Name Description
value ByteString

The bytes for requestId to set.

Returns
Type Description
RunRestoreTemplateRequest.Builder

This builder for chaining.