Package com.oracle.bmc.opensearch.model

Class OpensearchClusterBackup

java.lang.Object

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

com.oracle.bmc.opensearch.model.OpensearchClusterBackup

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

An OpenSearch cluster backup resource.

An cluster is set of instances that provide OpenSearch functionality in OCI Search Service with OpenSearch. For more information, see Cluster Backups.
Note: Objects should always be created or deserialized using the OpensearchClusterBackup.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 OpensearchClusterBackup.Builder, which maintain a set of all explicitly set fields called OpensearchClusterBackup.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	OpensearchClusterBackup.BackupType	Specifies whether the cluster backup was created manually, or automatically as a scheduled backup.
static class	OpensearchClusterBackup.Builder
static class	OpensearchClusterBackup.LifecycleState	The current state of the cluster 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

OpensearchClusterBackup(String id, String displayName, String compartmentId, OpensearchClusterBackup.BackupType backupType, Date timeCreated, Date timeUpdated, OpensearchClusterBackup.LifecycleState lifecycleState, String lifecyleDetails, String sourceClusterId, String namespace, String bucketName, String prefix, Date timeExpired, Double backupSize, String sourceClusterDisplayName, 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 OpensearchClusterBackup.Builder	builder()	Create a new builder.
boolean	equals(Object o)
Double	getBackupSize()	The size in GB of the cluster backup.
OpensearchClusterBackup.BackupType	getBackupType()	Specifies whether the cluster backup was created manually, or automatically as a scheduled backup.
String	getBucketName()	The name of the Object Storage bucket for the cluster backup.
String	getCompartmentId()	The OCID of the compartment where the cluster backup is located.
Map<String,Map<String,Object>>	getDefinedTags()	Defined tags for this resource.
String	getDisplayName()	The name of the cluster backup.
Map<String,String>	getFreeformTags()	Simple key-value pair that is applied without any predefined name, type or scope.
String	getId()	The OCID of the cluster backup.
OpensearchClusterBackup.LifecycleState	getLifecycleState()	The current state of the cluster backup.
String	getLifecyleDetails()	Additional information about the current lifecycle state of the cluster backup.
String	getNamespace()	The Object Storage namespace for the cluster backup.
String	getPrefix()	The prefix within the Object Storage bucket for the cluster backup.
String	getSourceClusterDisplayName()	The name of the source OpenSearch cluster for the cluster backup.
String	getSourceClusterId()	The OCID of the source OpenSearch cluster for the cluster backup.
Map<String,Map<String,Object>>	getSystemTags()	Usage of system tag keys.
Date	getTimeCreated()	The date and time the cluster backup was created.
Date	getTimeExpired()	The date and time the cluster backup expires.
Date	getTimeUpdated()	The date and time the cluster backup was updated.
int	hashCode()
OpensearchClusterBackup.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

OpensearchClusterBackup

@Deprecated
@ConstructorProperties({"id","displayName","compartmentId","backupType","timeCreated","timeUpdated","lifecycleState","lifecyleDetails","sourceClusterId","namespace","bucketName","prefix","timeExpired","backupSize","sourceClusterDisplayName","freeformTags","definedTags","systemTags"})
public OpensearchClusterBackup(String id,
                               String displayName,
                               String compartmentId,
                               OpensearchClusterBackup.BackupType backupType,
                               Date timeCreated,
                               Date timeUpdated,
                               OpensearchClusterBackup.LifecycleState lifecycleState,
                               String lifecyleDetails,
                               String sourceClusterId,
                               String namespace,
                               String bucketName,
                               String prefix,
                               Date timeExpired,
                               Double backupSize,
                               String sourceClusterDisplayName,
                               Map<String,String> freeformTags,
                               Map<String,Map<String,Object>> definedTags,
                               Map<String,Map<String,Object>> systemTags)

Deprecated.

Method Detail

builder

public static OpensearchClusterBackup.Builder builder()

Create a new builder.

toBuilder

public OpensearchClusterBackup.Builder toBuilder()

getId

public String getId()

The OCID of the cluster backup.

Returns:

the value

getDisplayName

public String getDisplayName()

The name of the cluster backup.

Avoid entering confidential information.

Returns:

the value

getCompartmentId

public String getCompartmentId()

The OCID of the compartment where the cluster backup is located.

Returns:

the value

getBackupType

public OpensearchClusterBackup.BackupType getBackupType()

Specifies whether the cluster backup was created manually, or automatically as a scheduled backup.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

The date and time the cluster backup was created.

Format defined by RFC3339.

Returns:

the value

getTimeUpdated

public Date getTimeUpdated()

The date and time the cluster backup was updated.

Format defined by RFC3339.

Returns:

the value

getLifecycleState

public OpensearchClusterBackup.LifecycleState getLifecycleState()

The current state of the cluster backup.

Returns:

the value

getLifecyleDetails

public String getLifecyleDetails()

Additional information about the current lifecycle state of the cluster backup.

Returns:

the value

getSourceClusterId

public String getSourceClusterId()

The OCID of the source OpenSearch cluster for the cluster backup.

Returns:

the value

getNamespace

public String getNamespace()

The Object Storage namespace for the cluster backup.

Returns:

the value

getBucketName

public String getBucketName()

The name of the Object Storage bucket for the cluster backup.

Returns:

the value

getPrefix

public String getPrefix()

The prefix within the Object Storage bucket for the cluster backup.

Returns:

the value

getTimeExpired

public Date getTimeExpired()

The date and time the cluster backup expires.

Format defined by RFC3339.

Returns:

the value

getBackupSize

public Double getBackupSize()

The size in GB of the cluster backup.

Returns:

the value

getSourceClusterDisplayName

public String getSourceClusterDisplayName()

The name of the source OpenSearch cluster for the cluster backup.

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