Class RestoreBackupRequest (0.12.0)

public final class RestoreBackupRequest extends GeneratedMessageV3 implements RestoreBackupRequestOrBuilder

Request message for restoring from a Backup.

Protobuf type google.cloud.backupdr.v1.RestoreBackupRequest

Static Fields

COMPUTE_INSTANCE_RESTORE_PROPERTIES_FIELD_NUMBER

public static final int COMPUTE_INSTANCE_RESTORE_PROPERTIES_FIELD_NUMBER
Field Value
Type Description
int

COMPUTE_INSTANCE_TARGET_ENVIRONMENT_FIELD_NUMBER

public static final int COMPUTE_INSTANCE_TARGET_ENVIRONMENT_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

REQUEST_ID_FIELD_NUMBER

public static final int REQUEST_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RestoreBackupRequest getDefaultInstance()
Returns
Type Description
RestoreBackupRequest

getDescriptor()

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

newBuilder()

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

newBuilder(RestoreBackupRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getComputeInstanceRestoreProperties()

public ComputeInstanceRestoreProperties getComputeInstanceRestoreProperties()

Compute Engine instance properties to be overridden during restore.

.google.cloud.backupdr.v1.ComputeInstanceRestoreProperties compute_instance_restore_properties = 4;

Returns
Type Description
ComputeInstanceRestoreProperties

The computeInstanceRestoreProperties.

getComputeInstanceRestorePropertiesOrBuilder()

public ComputeInstanceRestorePropertiesOrBuilder getComputeInstanceRestorePropertiesOrBuilder()

Compute Engine instance properties to be overridden during restore.

.google.cloud.backupdr.v1.ComputeInstanceRestoreProperties compute_instance_restore_properties = 4;

Returns
Type Description
ComputeInstanceRestorePropertiesOrBuilder

getComputeInstanceTargetEnvironment()

public ComputeInstanceTargetEnvironment getComputeInstanceTargetEnvironment()

Compute Engine target environment to be used during restore.

.google.cloud.backupdr.v1.ComputeInstanceTargetEnvironment compute_instance_target_environment = 3;

Returns
Type Description
ComputeInstanceTargetEnvironment

The computeInstanceTargetEnvironment.

getComputeInstanceTargetEnvironmentOrBuilder()

public ComputeInstanceTargetEnvironmentOrBuilder getComputeInstanceTargetEnvironmentOrBuilder()

Compute Engine target environment to be used during restore.

.google.cloud.backupdr.v1.ComputeInstanceTargetEnvironment compute_instance_target_environment = 3;

Returns
Type Description
ComputeInstanceTargetEnvironmentOrBuilder

getDefaultInstanceForType()

public RestoreBackupRequest getDefaultInstanceForType()
Returns
Type Description
RestoreBackupRequest

getInstancePropertiesCase()

public RestoreBackupRequest.InstancePropertiesCase getInstancePropertiesCase()
Returns
Type Description
RestoreBackupRequest.InstancePropertiesCase

getName()

public String getName()

Required. The resource name of the Backup instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/*/backups/'.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The resource name of the Backup instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/*/backups/'.

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

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 server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

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 = 2 [(.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 server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

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 = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }

Returns
Type Description
ByteString

The bytes for requestId.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTargetEnvironmentCase()

public RestoreBackupRequest.TargetEnvironmentCase getTargetEnvironmentCase()
Returns
Type Description
RestoreBackupRequest.TargetEnvironmentCase

hasComputeInstanceRestoreProperties()

public boolean hasComputeInstanceRestoreProperties()

Compute Engine instance properties to be overridden during restore.

.google.cloud.backupdr.v1.ComputeInstanceRestoreProperties compute_instance_restore_properties = 4;

Returns
Type Description
boolean

Whether the computeInstanceRestoreProperties field is set.

hasComputeInstanceTargetEnvironment()

public boolean hasComputeInstanceTargetEnvironment()

Compute Engine target environment to be used during restore.

.google.cloud.backupdr.v1.ComputeInstanceTargetEnvironment compute_instance_target_environment = 3;

Returns
Type Description
boolean

Whether the computeInstanceTargetEnvironment field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RestoreBackupRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RestoreBackupRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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