Class FinalizeBackupRequest (0.10.0)

public final class FinalizeBackupRequest extends GeneratedMessageV3 implements FinalizeBackupRequestOrBuilder

Message for finalizing a Backup.

Protobuf type google.cloud.backupdr.v1.FinalizeBackupRequest

Static Fields

BACKUP_ID_FIELD_NUMBER

public static final int BACKUP_ID_FIELD_NUMBER
Field Value
Type Description
int

CONSISTENCY_TIME_FIELD_NUMBER

public static final int CONSISTENCY_TIME_FIELD_NUMBER
Field Value
Type Description
int

DATA_SOURCE_FIELD_NUMBER

public static final int DATA_SOURCE_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

RECOVERY_RANGE_END_TIME_FIELD_NUMBER

public static final int RECOVERY_RANGE_END_TIME_FIELD_NUMBER
Field Value
Type Description
int

RECOVERY_RANGE_START_TIME_FIELD_NUMBER

public static final int RECOVERY_RANGE_START_TIME_FIELD_NUMBER
Field Value
Type Description
int

REQUEST_ID_FIELD_NUMBER

public static final int REQUEST_ID_FIELD_NUMBER
Field Value
Type Description
int

RETENTION_DURATION_FIELD_NUMBER

public static final int RETENTION_DURATION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static FinalizeBackupRequest getDefaultInstance()
Returns
Type Description
FinalizeBackupRequest

getDescriptor()

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

newBuilder()

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

newBuilder(FinalizeBackupRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getBackupId()

public String getBackupId()

Required. Resource ID of the Backup resource to be finalized. This must be the same backup_id that was used in the InitiateBackupRequest.

string backup_id = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The backupId.

getBackupIdBytes()

public ByteString getBackupIdBytes()

Required. Resource ID of the Backup resource to be finalized. This must be the same backup_id that was used in the InitiateBackupRequest.

string backup_id = 5 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for backupId.

getConsistencyTime()

public Timestamp getConsistencyTime()

The point in time when this backup was captured from the source. This will be assigned to the consistency_time field of the newly created Backup.

optional .google.protobuf.Timestamp consistency_time = 3;

Returns
Type Description
Timestamp

The consistencyTime.

getConsistencyTimeOrBuilder()

public TimestampOrBuilder getConsistencyTimeOrBuilder()

The point in time when this backup was captured from the source. This will be assigned to the consistency_time field of the newly created Backup.

optional .google.protobuf.Timestamp consistency_time = 3;

Returns
Type Description
TimestampOrBuilder

getDataSource()

public String getDataSource()

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

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

Returns
Type Description
String

The dataSource.

getDataSourceBytes()

public ByteString getDataSourceBytes()

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

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

Returns
Type Description
ByteString

The bytes for dataSource.

getDefaultInstanceForType()

public FinalizeBackupRequest getDefaultInstanceForType()
Returns
Type Description
FinalizeBackupRequest

getDescription()

public String getDescription()

This will be assigned to the description field of the newly created Backup.

optional string description = 2;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

This will be assigned to the description field of the newly created Backup.

optional string description = 2;

Returns
Type Description
ByteString

The bytes for description.

getParserForType()

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

getRecoveryRangeEndTime()

public Timestamp getRecoveryRangeEndTime()

The latest timestamp of data available in this Backup. This will be set on the newly created Backup.

optional .google.protobuf.Timestamp recovery_range_end_time = 7;

Returns
Type Description
Timestamp

The recoveryRangeEndTime.

getRecoveryRangeEndTimeOrBuilder()

public TimestampOrBuilder getRecoveryRangeEndTimeOrBuilder()

The latest timestamp of data available in this Backup. This will be set on the newly created Backup.

optional .google.protobuf.Timestamp recovery_range_end_time = 7;

Returns
Type Description
TimestampOrBuilder

getRecoveryRangeStartTime()

public Timestamp getRecoveryRangeStartTime()

The earliest timestamp of data available in this Backup. This will set on the newly created Backup.

optional .google.protobuf.Timestamp recovery_range_start_time = 6;

Returns
Type Description
Timestamp

The recoveryRangeStartTime.

getRecoveryRangeStartTimeOrBuilder()

public TimestampOrBuilder getRecoveryRangeStartTimeOrBuilder()

The earliest timestamp of data available in this Backup. This will set on the newly created Backup.

optional .google.protobuf.Timestamp recovery_range_start_time = 6;

Returns
Type Description
TimestampOrBuilder

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

Returns
Type Description
ByteString

The bytes for requestId.

getRetentionDuration()

public Duration getRetentionDuration()

The ExpireTime on the backup will be set to FinalizeTime plus this duration. If the resulting ExpireTime is less than EnforcedRetentionEndTime, then ExpireTime is set to EnforcedRetentionEndTime.

optional .google.protobuf.Duration retention_duration = 9;

Returns
Type Description
Duration

The retentionDuration.

getRetentionDurationOrBuilder()

public DurationOrBuilder getRetentionDurationOrBuilder()

The ExpireTime on the backup will be set to FinalizeTime plus this duration. If the resulting ExpireTime is less than EnforcedRetentionEndTime, then ExpireTime is set to EnforcedRetentionEndTime.

optional .google.protobuf.Duration retention_duration = 9;

Returns
Type Description
DurationOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasConsistencyTime()

public boolean hasConsistencyTime()

The point in time when this backup was captured from the source. This will be assigned to the consistency_time field of the newly created Backup.

optional .google.protobuf.Timestamp consistency_time = 3;

Returns
Type Description
boolean

Whether the consistencyTime field is set.

hasDescription()

public boolean hasDescription()

This will be assigned to the description field of the newly created Backup.

optional string description = 2;

Returns
Type Description
boolean

Whether the description field is set.

hasRecoveryRangeEndTime()

public boolean hasRecoveryRangeEndTime()

The latest timestamp of data available in this Backup. This will be set on the newly created Backup.

optional .google.protobuf.Timestamp recovery_range_end_time = 7;

Returns
Type Description
boolean

Whether the recoveryRangeEndTime field is set.

hasRecoveryRangeStartTime()

public boolean hasRecoveryRangeStartTime()

The earliest timestamp of data available in this Backup. This will set on the newly created Backup.

optional .google.protobuf.Timestamp recovery_range_start_time = 6;

Returns
Type Description
boolean

Whether the recoveryRangeStartTime field is set.

hasRetentionDuration()

public boolean hasRetentionDuration()

The ExpireTime on the backup will be set to FinalizeTime plus this duration. If the resulting ExpireTime is less than EnforcedRetentionEndTime, then ExpireTime is set to EnforcedRetentionEndTime.

optional .google.protobuf.Duration retention_duration = 9;

Returns
Type Description
boolean

Whether the retentionDuration 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 FinalizeBackupRequest.Builder newBuilderForType()
Returns
Type Description
FinalizeBackupRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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