VolumeBackup (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- - com.oracle.bmc.core.model.VolumeBackup

```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20160918")
public final class VolumeBackup
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
```
A point-in-time copy of a volume that can then be used to create a new block volume or recover a block volume. For more information, see Overview of Cloud Volume Storage.

To use any of the API operations, you must be authorized in an IAM policy. If you're not authorized, talk to an administrator. If you're an administrator who needs to write policies to give users access, see [Getting Started with Policies](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/policygetstarted.htm).
*Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API.
Note: Objects should always be created or deserialized using the VolumeBackup.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the VolumeBackup.Builder, which maintain a set of all explicitly set fields called VolumeBackup.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`VolumeBackup.Builder`
`static class`	`VolumeBackup.LifecycleState` The current state of a volume backup.
`static class`	`VolumeBackup.SourceType` Specifies whether the backup was created manually, or via scheduled backup policy.
`static class`	`VolumeBackup.Type` The type of a volume backup.

Field Summary
- Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
  EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors
Constructor and Description
VolumeBackup(String compartmentId, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags, String displayName, Date expirationTime, Map<String,String> freeformTags, String id, String kmsKeyId, VolumeBackup.LifecycleState lifecycleState, Long sizeInGBs, Long sizeInMBs, VolumeBackup.SourceType sourceType, String sourceVolumeBackupId, Date timeCreated, Date timeRequestReceived, VolumeBackup.Type type, Long uniqueSizeInGBs, Long uniqueSizeInMbs, String volumeId) Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static VolumeBackup.Builder`	`builder()` Create a new builder.
`boolean`	`equals(Object o)`
`String`	`getCompartmentId()` The OCID of the compartment that contains the volume backup.
`Map<String,Map<String,Object>>`	`getDefinedTags()` Defined tags for this resource.
`String`	`getDisplayName()` A user-friendly name.
`Date`	`getExpirationTime()` The date and time the volume backup will expire and be automatically deleted.
`Map<String,String>`	`getFreeformTags()` Free-form tags for this resource.
`String`	`getId()` The OCID of the volume backup.
`String`	`getKmsKeyId()` The OCID of the Vault service key which is the master encryption key for the volume backup.
`VolumeBackup.LifecycleState`	`getLifecycleState()` The current state of a volume backup.
`Long`	`getSizeInGBs()` The size of the volume, in GBs.
`Long`	`getSizeInMBs()` The size of the volume in MBs.
`VolumeBackup.SourceType`	`getSourceType()` Specifies whether the backup was created manually, or via scheduled backup policy.
`String`	`getSourceVolumeBackupId()` The OCID of the source volume backup.
`Map<String,Map<String,Object>>`	`getSystemTags()` System tags for this resource.
`Date`	`getTimeCreated()` The date and time the volume backup was created.
`Date`	`getTimeRequestReceived()` The date and time the request to create the volume backup was received.
`VolumeBackup.Type`	`getType()` The type of a volume backup.
`Long`	`getUniqueSizeInGBs()` The size used by the backup, in GBs.
`Long`	`getUniqueSizeInMbs()` The size used by the backup, in MBs.
`String`	`getVolumeId()` The OCID of the volume.
`int`	`hashCode()`
`VolumeBackup.Builder`	`toBuilder()`
`String`	`toString()`
`String`	`toString(boolean includeByteArrayContents)` Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VolumeBackup

@Deprecated
 @ConstructorProperties(value={"compartmentId","definedTags","systemTags","displayName","expirationTime","freeformTags","id","kmsKeyId","lifecycleState","sizeInGBs","sizeInMBs","sourceType","sourceVolumeBackupId","timeCreated","timeRequestReceived","type","uniqueSizeInGBs","uniqueSizeInMbs","volumeId"})
public VolumeBackup(String compartmentId,
                                                                                                                                                                                                                                                                                                                                                 Map<String,Map<String,Object>> definedTags,
                                                                                                                                                                                                                                                                                                                                                 Map<String,Map<String,Object>> systemTags,
                                                                                                                                                                                                                                                                                                                                                 String displayName,
                                                                                                                                                                                                                                                                                                                                                 Date expirationTime,
                                                                                                                                                                                                                                                                                                                                                 Map<String,String> freeformTags,
                                                                                                                                                                                                                                                                                                                                                 String id,
                                                                                                                                                                                                                                                                                                                                                 String kmsKeyId,
                                                                                                                                                                                                                                                                                                                                                 VolumeBackup.LifecycleState lifecycleState,
                                                                                                                                                                                                                                                                                                                                                 Long sizeInGBs,
                                                                                                                                                                                                                                                                                                                                                 Long sizeInMBs,
                                                                                                                                                                                                                                                                                                                                                 VolumeBackup.SourceType sourceType,
                                                                                                                                                                                                                                                                                                                                                 String sourceVolumeBackupId,
                                                                                                                                                                                                                                                                                                                                                 Date timeCreated,
                                                                                                                                                                                                                                                                                                                                                 Date timeRequestReceived,
                                                                                                                                                                                                                                                                                                                                                 VolumeBackup.Type type,
                                                                                                                                                                                                                                                                                                                                                 Long uniqueSizeInGBs,
                                                                                                                                                                                                                                                                                                                                                 Long uniqueSizeInMbs,
                                                                                                                                                                                                                                                                                                                                                 String volumeId)

Deprecated.

Method Detail
- builder
```
public static VolumeBackup.Builder builder()
```
  Create a new builder.
- toBuilder
```
public VolumeBackup.Builder toBuilder()
```
- getCompartmentId
```
public String getCompartmentId()
```
  The OCID of the compartment that contains the volume backup.
  
  Returns:
  
  the value
- getDefinedTags
```
public Map<String,Map<String,Object>> getDefinedTags()
```
  Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
  
  Example: {"Operations": {"CostCenter": "42"}}
  
  Returns:
  
  the value
- getSystemTags
```
public Map<String,Map<String,Object>> getSystemTags()
```
  System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace": {"bar-key": "value"}}
  
  Returns:
  
  the value
- getDisplayName
```
public String getDisplayName()
```
  A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
  
  Returns:
  
  the value
- getExpirationTime
```
public Date getExpirationTime()
```
  The date and time the volume backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
  
  Returns:
  
  the value
- getFreeformTags
```
public Map<String,String> getFreeformTags()
```
  Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
  
  Example: {"Department": "Finance"}
  
  Returns:
  
  the value
- getId
```
public String getId()
```
  The OCID of the volume backup.
  
  Returns:
  
  the value
- getKmsKeyId
```
public String getKmsKeyId()
```
  The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
  
  Returns:
  
  the value
- getLifecycleState
```
public VolumeBackup.LifecycleState getLifecycleState()
```
  The current state of a volume backup.
  
  Returns:
  
  the value
- getSizeInGBs
```
public Long getSizeInGBs()
```
  The size of the volume, in GBs.
  
  Returns:
  
  the value
- getSizeInMBs
```
public Long getSizeInMBs()
```
  The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use sizeInGBs.
  
  Returns:
  
  the value
- getSourceType
```
public VolumeBackup.SourceType getSourceType()
```
  Specifies whether the backup was created manually, or via scheduled backup policy.
  
  Returns:
  
  the value
- getSourceVolumeBackupId
```
public String getSourceVolumeBackupId()
```
  The OCID of the source volume backup.
  
  Returns:
  
  the value
- getTimeCreated
```
public Date getTimeCreated()
```
  The date and time the volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
  
  Returns:
  
  the value
- getTimeRequestReceived
```
public Date getTimeRequestReceived()
```
  The date and time the request to create the volume backup was received. Format defined by [RFC3339]https://tools.ietf.org/html/rfc3339.
  
  Returns:
  
  the value
- getType
```
public VolumeBackup.Type getType()
```
  The type of a volume backup.
  
  Returns:
  
  the value
- getUniqueSizeInGBs
```
public Long getUniqueSizeInGBs()
```
  The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the volume and whether the backup is full or incremental.
  
  Returns:
  
  the value
- getUniqueSizeInMbs
```
public Long getUniqueSizeInMbs()
```
  The size used by the backup, in MBs. It is typically smaller than sizeInMBs, depending on the space consumed on the volume and whether the backup is full or incremental. This field is deprecated. Please use uniqueSizeInGBs.
  
  Returns:
  
  the value
- getVolumeId
```
public String getVolumeId()
```
  The OCID of the volume.
  
  Returns:
  
  the value
- toString
```
public String toString()
```
  Overrides:
  
  toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- toString
```
public String toString(boolean includeByteArrayContents)
```
  Return a string representation of the object.
  
  Parameters:
  
  includeByteArrayContents - true to include the full contents of byte arrays
  
  Returns:
  
  string representation
- equals
```
public boolean equals(Object o)
```
  Overrides:
  
  equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Class VolumeBackup

Nested Class Summary

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Constructor Summary

Method Summary

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Methods inherited from class java.lang.Object

Constructor Detail

VolumeBackup

Method Detail

builder

toBuilder

getCompartmentId

getDefinedTags

getSystemTags

getDisplayName

getExpirationTime

getFreeformTags

getId

getKmsKeyId

getLifecycleState

getSizeInGBs

getSizeInMBs

getSourceType

getSourceVolumeBackupId

getTimeCreated

getTimeRequestReceived

getType

getUniqueSizeInGBs

getUniqueSizeInMbs

getVolumeId

toString

toString

equals

hashCode