Class AutonomousDatabaseBackupProperties (0.3.0)

public final class AutonomousDatabaseBackupProperties extends GeneratedMessageV3 implements AutonomousDatabaseBackupPropertiesOrBuilder

Properties of the Autonomous Database Backup resource.

Protobuf type google.cloud.oracledatabase.v1.AutonomousDatabaseBackupProperties

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > AutonomousDatabaseBackupProperties

Static Fields

AVAILABLE_TILL_TIME_FIELD_NUMBER

public static final int AVAILABLE_TILL_TIME_FIELD_NUMBER
Field Value
Type Description
int

COMPARTMENT_ID_FIELD_NUMBER

public static final int COMPARTMENT_ID_FIELD_NUMBER
Field Value
Type Description
int

DATABASE_SIZE_TB_FIELD_NUMBER

public static final int DATABASE_SIZE_TB_FIELD_NUMBER
Field Value
Type Description
int

DB_VERSION_FIELD_NUMBER

public static final int DB_VERSION_FIELD_NUMBER
Field Value
Type Description
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
Type Description
int

IS_AUTOMATIC_BACKUP_FIELD_NUMBER

public static final int IS_AUTOMATIC_BACKUP_FIELD_NUMBER
Field Value
Type Description
int

IS_LONG_TERM_BACKUP_FIELD_NUMBER

public static final int IS_LONG_TERM_BACKUP_FIELD_NUMBER
Field Value
Type Description
int

IS_RESTORABLE_FIELD_NUMBER

public static final int IS_RESTORABLE_FIELD_NUMBER
Field Value
Type Description
int

KEY_STORE_ID_FIELD_NUMBER

public static final int KEY_STORE_ID_FIELD_NUMBER
Field Value
Type Description
int

KEY_STORE_WALLET_FIELD_NUMBER

public static final int KEY_STORE_WALLET_FIELD_NUMBER
Field Value
Type Description
int

KMS_KEY_ID_FIELD_NUMBER

public static final int KMS_KEY_ID_FIELD_NUMBER
Field Value
Type Description
int

KMS_KEY_VERSION_ID_FIELD_NUMBER

public static final int KMS_KEY_VERSION_ID_FIELD_NUMBER
Field Value
Type Description
int

LIFECYCLE_DETAILS_FIELD_NUMBER

public static final int LIFECYCLE_DETAILS_FIELD_NUMBER
Field Value
Type Description
int

LIFECYCLE_STATE_FIELD_NUMBER

public static final int LIFECYCLE_STATE_FIELD_NUMBER
Field Value
Type Description
int

OCID_FIELD_NUMBER

public static final int OCID_FIELD_NUMBER
Field Value
Type Description
int

RETENTION_PERIOD_DAYS_FIELD_NUMBER

public static final int RETENTION_PERIOD_DAYS_FIELD_NUMBER
Field Value
Type Description
int

SIZE_TB_FIELD_NUMBER

public static final int SIZE_TB_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

VAULT_ID_FIELD_NUMBER

public static final int VAULT_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AutonomousDatabaseBackupProperties getDefaultInstance()
Returns
Type Description
AutonomousDatabaseBackupProperties

getDescriptor()

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

newBuilder()

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

newBuilder(AutonomousDatabaseBackupProperties prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAvailableTillTime()

public Timestamp getAvailableTillTime()

Output only. Timestamp until when the backup will be available.

.google.protobuf.Timestamp available_till_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The availableTillTime.

getAvailableTillTimeOrBuilder()

public TimestampOrBuilder getAvailableTillTimeOrBuilder()

Output only. Timestamp until when the backup will be available.

.google.protobuf.Timestamp available_till_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getCompartmentId()

public String getCompartmentId()

Output only. The OCID of the compartment.

string compartment_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The compartmentId.

getCompartmentIdBytes()

public ByteString getCompartmentIdBytes()

Output only. The OCID of the compartment.

string compartment_id = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for compartmentId.

getDatabaseSizeTb()

public float getDatabaseSizeTb()

Output only. The quantity of data in the database, in terabytes.

float database_size_tb = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
float

The databaseSizeTb.

getDbVersion()

public String getDbVersion()

Output only. A valid Oracle Database version for Autonomous Database.

string db_version = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The dbVersion.

getDbVersionBytes()

public ByteString getDbVersionBytes()

Output only. A valid Oracle Database version for Autonomous Database.

string db_version = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for dbVersion.

getDefaultInstanceForType()

public AutonomousDatabaseBackupProperties getDefaultInstanceForType()
Returns
Type Description
AutonomousDatabaseBackupProperties

getEndTime()

public Timestamp getEndTime()

Output only. The date and time the backup completed.

.google.protobuf.Timestamp end_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The endTime.

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

Output only. The date and time the backup completed.

.google.protobuf.Timestamp end_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getIsAutomaticBackup()

public boolean getIsAutomaticBackup()

Output only. Indicates if the backup is automatic or user initiated.

bool is_automatic_backup = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The isAutomaticBackup.

getIsLongTermBackup()

public boolean getIsLongTermBackup()

Output only. Indicates if the backup is long term backup.

bool is_long_term_backup = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The isLongTermBackup.

getIsRestorable()

public boolean getIsRestorable()

Output only. Indicates if the backup can be used to restore the Autonomous Database.

bool is_restorable = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The isRestorable.

getKeyStoreId()

public String getKeyStoreId()

Optional. The OCID of the key store of Oracle Vault.

string key_store_id = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The keyStoreId.

getKeyStoreIdBytes()

public ByteString getKeyStoreIdBytes()

Optional. The OCID of the key store of Oracle Vault.

string key_store_id = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for keyStoreId.

getKeyStoreWallet()

public String getKeyStoreWallet()

Optional. The wallet name for Oracle Key Vault.

string key_store_wallet = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The keyStoreWallet.

getKeyStoreWalletBytes()

public ByteString getKeyStoreWalletBytes()

Optional. The wallet name for Oracle Key Vault.

string key_store_wallet = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for keyStoreWallet.

getKmsKeyId()

public String getKmsKeyId()

Optional. The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

string kms_key_id = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The kmsKeyId.

getKmsKeyIdBytes()

public ByteString getKmsKeyIdBytes()

Optional. The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations.

string kms_key_id = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for kmsKeyId.

getKmsKeyVersionId()

public String getKmsKeyVersionId()

Optional. The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.

string kms_key_version_id = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The kmsKeyVersionId.

getKmsKeyVersionIdBytes()

public ByteString getKmsKeyVersionIdBytes()

Optional. The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. Autonomous Database Serverless does not use key versions, hence is not applicable for Autonomous Database Serverless instances.

string kms_key_version_id = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for kmsKeyVersionId.

getLifecycleDetails()

public String getLifecycleDetails()

Output only. Additional information about the current lifecycle state.

string lifecycle_details = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The lifecycleDetails.

getLifecycleDetailsBytes()

public ByteString getLifecycleDetailsBytes()

Output only. Additional information about the current lifecycle state.

string lifecycle_details = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for lifecycleDetails.

getLifecycleState()

public AutonomousDatabaseBackupProperties.State getLifecycleState()

Output only. The lifecycle state of the backup.

.google.cloud.oracledatabase.v1.AutonomousDatabaseBackupProperties.State lifecycle_state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
AutonomousDatabaseBackupProperties.State

The lifecycleState.

getLifecycleStateValue()

public int getLifecycleStateValue()

Output only. The lifecycle state of the backup.

.google.cloud.oracledatabase.v1.AutonomousDatabaseBackupProperties.State lifecycle_state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for lifecycleState.

getOcid()

public String getOcid()

Output only. OCID of the Autonomous Database backup. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle

string ocid = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The ocid.

getOcidBytes()

public ByteString getOcidBytes()

Output only. OCID of the Autonomous Database backup. https://docs.oracle.com/en-us/iaas/Content/General/Concepts/identifiers.htm#Oracle

string ocid = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for ocid.

getParserForType()

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

getRetentionPeriodDays()

public int getRetentionPeriodDays()

Optional. Retention period in days for the backup.

int32 retention_period_days = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The retentionPeriodDays.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSizeTb()

public float getSizeTb()

Output only. The backup size in terabytes.

float size_tb = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
float

The sizeTb.

getStartTime()

public Timestamp getStartTime()

Output only. The date and time the backup started.

.google.protobuf.Timestamp start_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Output only. The date and time the backup started.

.google.protobuf.Timestamp start_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getType()

public AutonomousDatabaseBackupProperties.Type getType()

Output only. The type of the backup.

.google.cloud.oracledatabase.v1.AutonomousDatabaseBackupProperties.Type type = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
AutonomousDatabaseBackupProperties.Type

The type.

getTypeValue()

public int getTypeValue()

Output only. The type of the backup.

.google.cloud.oracledatabase.v1.AutonomousDatabaseBackupProperties.Type type = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for type.

getVaultId()

public String getVaultId()

Optional. The OCID of the vault.

string vault_id = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The vaultId.

getVaultIdBytes()

public ByteString getVaultIdBytes()

Optional. The OCID of the vault.

string vault_id = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for vaultId.

hasAvailableTillTime()

public boolean hasAvailableTillTime()

Output only. Timestamp until when the backup will be available.

.google.protobuf.Timestamp available_till_time = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the availableTillTime field is set.

hasEndTime()

public boolean hasEndTime()

Output only. The date and time the backup completed.

.google.protobuf.Timestamp end_time = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the endTime field is set.

hasStartTime()

public boolean hasStartTime()

Output only. The date and time the backup started.

.google.protobuf.Timestamp start_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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