Package com.oracle.bmc.redis.model

Class OciCacheBackup

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.redis.model.OciCacheBackup

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20220315")
public final class OciCacheBackup
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

OCI Cache cluster backup information
Note: Objects should always be created or deserialized using the OciCacheBackup.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 OciCacheBackup.Builder, which maintain a set of all explicitly set fields called OciCacheBackup.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	Description
static class	OciCacheBackup.BackupSource	Specifies whether the backup was created from a replica or primary node
static class	OciCacheBackup.BackupType	Backup Type.
static class	OciCacheBackup.Builder
static class	OciCacheBackup.LifecycleState	The current state of the 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

Description

OciCacheBackup(String id, String displayName, String description, String compartmentId, OciCacheBackup.BackupSource backupSource, OciCacheBackup.LifecycleState lifecycleState, Integer retentionPeriodInDays, Float backupSizeInGBs, String sourceClusterId, RedisCluster.ClusterMode clusterMode, Float clusterMemoryInGBs, Integer shardCount, RedisCluster.SoftwareVersion softwareVersion, Date timeCreated, Date timeUpdated, OciCacheBackup.BackupType backupType, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)

Deprecated.

Method Summary

Modifier and Type	Method	Description
static OciCacheBackup.Builder	builder()	Create a new builder.
boolean	equals(Object o)
Float	getBackupSizeInGBs()	Backup size in GB.
OciCacheBackup.BackupSource	getBackupSource()	Specifies whether the backup was created from a replica or primary node
OciCacheBackup.BackupType	getBackupType()	Backup Type.
Float	getClusterMemoryInGBs()	The amount of memory allocated to the cluster, in gigabytes.
RedisCluster.ClusterMode	getClusterMode()	Specifies whether the cluster is sharded or non-sharded.
String	getCompartmentId()	Backup compartment identifier
Map<String,Map<String,Object>>	getDefinedTags()	Defined tags for this resource.
String	getDescription()	Backup description
String	getDisplayName()	Backup display name
Map<String,String>	getFreeformTags()	Simple key-value pair that is applied without any predefined name, type or scope.
String	getId()	Unique identifier that is immutable on creation
OciCacheBackup.LifecycleState	getLifecycleState()	The current state of the backup.
Integer	getRetentionPeriodInDays()	Backup retention period in days.
Integer	getShardCount()	The number of shards in a sharded cluster.
RedisCluster.SoftwareVersion	getSoftwareVersion()	The OCI Cache engine version that the cluster is running.
String	getSourceClusterId()	The source OCI Cache Cluster OCID.
Map<String,Map<String,Object>>	getSystemTags()	Usage of system tag keys.
Date	getTimeCreated()	The date and time the backup was created.
Date	getTimeUpdated()	The date and time the backup was updated.
int	hashCode()
OciCacheBackup.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

OciCacheBackup

@Deprecated
@ConstructorProperties({"id","displayName","description","compartmentId","backupSource","lifecycleState","retentionPeriodInDays","backupSizeInGBs","sourceClusterId","clusterMode","clusterMemoryInGBs","shardCount","softwareVersion","timeCreated","timeUpdated","backupType","freeformTags","definedTags","systemTags"})
public OciCacheBackup(String id,
                      String displayName,
                      String description,
                      String compartmentId,
                      OciCacheBackup.BackupSource backupSource,
                      OciCacheBackup.LifecycleState lifecycleState,
                      Integer retentionPeriodInDays,
                      Float backupSizeInGBs,
                      String sourceClusterId,
                      RedisCluster.ClusterMode clusterMode,
                      Float clusterMemoryInGBs,
                      Integer shardCount,
                      RedisCluster.SoftwareVersion softwareVersion,
                      Date timeCreated,
                      Date timeUpdated,
                      OciCacheBackup.BackupType backupType,
                      Map<String,String> freeformTags,
                      Map<String,Map<String,Object>> definedTags,
                      Map<String,Map<String,Object>> systemTags)

Deprecated.

Method Detail

builder

public static OciCacheBackup.Builder builder()

Create a new builder.

toBuilder

public OciCacheBackup.Builder toBuilder()

getId

public String getId()

Unique identifier that is immutable on creation

Returns:

the value

getDisplayName

public String getDisplayName()

Backup display name

Returns:

the value

getDescription

public String getDescription()

Backup description

Returns:

the value

getCompartmentId

public String getCompartmentId()

Backup compartment identifier

Returns:

the value

getBackupSource

public OciCacheBackup.BackupSource getBackupSource()

Specifies whether the backup was created from a replica or primary node

Returns:

the value

getLifecycleState

public OciCacheBackup.LifecycleState getLifecycleState()

The current state of the backup.

Returns:

the value

getRetentionPeriodInDays

public Integer getRetentionPeriodInDays()

Backup retention period in days.

Returns:

the value

getBackupSizeInGBs

public Float getBackupSizeInGBs()

Backup size in GB.

Returns:

the value

getSourceClusterId

public String getSourceClusterId()

The source OCI Cache Cluster OCID.

Returns:

the value

getClusterMode

public RedisCluster.ClusterMode getClusterMode()

Specifies whether the cluster is sharded or non-sharded.

Returns:

the value

getClusterMemoryInGBs

public Float getClusterMemoryInGBs()

The amount of memory allocated to the cluster, in gigabytes.

Returns:

the value

getShardCount

public Integer getShardCount()

The number of shards in a sharded cluster.

Only applicable when clusterMode is SHARDED.

Returns:

the value

getSoftwareVersion

public RedisCluster.SoftwareVersion getSoftwareVersion()

The OCI Cache engine version that the cluster is running.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

The date and time the backup was created.

An RFC3339 formatted datetime string.

Returns:

the value

getTimeUpdated

public Date getTimeUpdated()

The date and time the backup was updated.

An RFC3339 formatted datetime string.

Returns:

the value

getBackupType

public OciCacheBackup.BackupType getBackupType()

Backup Type.

Returns:

the value

getFreeformTags

public Map<String,String> getFreeformTags()

Simple key-value pair that is applied without any predefined name, type or scope.

Exists for cross-compatibility only. Example: {“bar-key”: “value”}

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. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:

the value

getSystemTags

public Map<String,Map<String,Object>> getSystemTags()

Usage of system tag keys.

These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

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