Package com.oracle.bmc.disasterrecovery.model

Class OkeClusterBackupConfig

java.lang.Object

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

com.oracle.bmc.disasterrecovery.model.OkeClusterBackupConfig

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

The details of backup performed on OKE Cluster.
Note: Objects should always be created or deserialized using the OkeClusterBackupConfig.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 OkeClusterBackupConfig.Builder, which maintain a set of all explicitly set fields called OkeClusterBackupConfig.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	OkeClusterBackupConfig.Builder

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
OkeClusterBackupConfig(List<String> namespaces, List<String> excludeNamespaces, String backupSchedule, OkeClusterImageReplication replicateImages, Integer maxNumberOfBackupsRetained, String imageReplicationVaultSecretId)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static OkeClusterBackupConfig.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getBackupSchedule()	The schedule for backing up namespaces to the destination region.
List<String>	getExcludeNamespaces()	A list of namespaces to be excluded from the backup.
String	getImageReplicationVaultSecretId()	The OCID of the vault secret that stores the image credential.
Integer	getMaxNumberOfBackupsRetained()	The maximum number of backups that should be retained.
List<String>	getNamespaces()	A list of namespaces to be included in the backup.
OkeClusterImageReplication	getReplicateImages()	Controls the behaviour of image replication across regions.
int	hashCode()
OkeClusterBackupConfig.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

OkeClusterBackupConfig

@Deprecated
@ConstructorProperties({"namespaces","excludeNamespaces","backupSchedule","replicateImages","maxNumberOfBackupsRetained","imageReplicationVaultSecretId"})
public OkeClusterBackupConfig(List<String> namespaces,
                              List<String> excludeNamespaces,
                              String backupSchedule,
                              OkeClusterImageReplication replicateImages,
                              Integer maxNumberOfBackupsRetained,
                              String imageReplicationVaultSecretId)

Deprecated.

Method Detail

builder

public static OkeClusterBackupConfig.Builder builder()

Create a new builder.

toBuilder

public OkeClusterBackupConfig.Builder toBuilder()

getNamespaces

public List<String> getNamespaces()

A list of namespaces to be included in the backup.

The default value is null. If a list of namespaces to include is not provided, all namespaces will be backed up. Specify either the namespaces or the excludeNamespaces parameter, but not both. This property applies to the OKE cluster member in primary region.

Example: ["default", "pv-nginx"]

Returns:

the value

getExcludeNamespaces

public List<String> getExcludeNamespaces()

A list of namespaces to be excluded from the backup.

The default value is null. If a list of namespaces to exclude is not provided, all namespaces will be backed up. Specify either the namespaces or the excludeNamespaces parameter, but not both. This property applies to OKE cluster members in the primary region.

Example: ["namespace_string_3", "namespace_string_4"]

Returns:

the value

getBackupSchedule

public String getBackupSchedule()

The schedule for backing up namespaces to the destination region.

If a backup schedule is not specified, only a single backup will be created. This format of the string specifying the backup schedule must conform with RFC-5545. This schedule will use the UTC timezone. This property applies to the OKE cluster member in primary region.

Example: FREQ=WEEKLY;BYDAY=MO,TU,WE,TH;BYHOUR=10;INTERVAL=1

Returns:

the value

getReplicateImages

public OkeClusterImageReplication getReplicateImages()

Controls the behaviour of image replication across regions.

This property applies to the OKE cluster member in primary region.

Returns:

the value

getMaxNumberOfBackupsRetained

public Integer getMaxNumberOfBackupsRetained()

The maximum number of backups that should be retained.

This property applies to the OKE cluster member in primary region.

Returns:

the value

getImageReplicationVaultSecretId

public String getImageReplicationVaultSecretId()

The OCID of the vault secret that stores the image credential.

This property applies to the OKE cluster member in both the primary and standby region.

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