Class CreateOkeClusterBackupConfigDetails


  • @Generated(value="OracleSDKGenerator",
               comments="API Version: 20220125")
    public final class CreateOkeClusterBackupConfigDetails
    extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Create backup configuration properties for an OKE member.
    Note: Objects should always be created or deserialized using the CreateOkeClusterBackupConfigDetails.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 CreateOkeClusterBackupConfigDetails.Builder, which maintain a set of all explicitly set fields called CreateOkeClusterBackupConfigDetails.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).
    • Method Detail

      • getNamespaces

        public List<String> getNamespaces()
        A list of namespaces that need to be backed up.

        The default value is null. If a list of namespaces is not provided, all namespaces will be backed up. This property applies to the OKE cluster member in primary region.

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

        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 (see examples below). This schedule will use the UTC timezone. This property applies to the OKE cluster member in primary region.

        The backup frequency can be HOURLY, DAILY, WEEKLY or MONTHLY, and the upper and lower interval bounds are as follows HOURLY - Minimum = 1 - Maximum = 24 DAILY - Minimum = 1 - Maximum = 30 WEEKLY - Minimum = 1 - Maximum = 1 MONTHLY - Minimum = 1 - Maximum = 12

        Examples: FREQ=WEEKLY;BYDAY=MO,WE;BYHOUR=10;INTERVAL=1 -> Run a backup every week on monday and wednesday at 10:00 AM. FREQ=WEEKLY;BYDAY=MO,WE;BYHOUR=10;INTERVAL=2 -> Invalid configuration (can not specify interval of 2).

        FREQ=HOURLY;INTERVAL=25 -> Invalid configuration (can not specify interval of 25). FREQ=HOURLY;INTERVAL=0 -> Invalid configuration (can not specify interval of 0). FREQ=HOURLY;INTERVAL=24 -> Run a backup every 24 hours. FREQ=HOURLY;INTERVAL=1 -> Run a backup every hour. FREQ=HOURLY;BYMINUTE=30;INTERVAL=15 -> Run a backup every 15 hours at the 30th minute.

        FREQ=DAILY;INTERVAL=31 -> Invalid configuration (can not specify interval of 31). FREQ=DAILY;INTERVAL=0 -> Invalid configuration (can not specify interval of 0). FREQ=DAILY;INTERVAL=30 -> Run a backup every 30 days at 12:00 midnight. FREQ=DAILY;BYHOUR=17;BYMINUTE=10;INTERVAL=1 -> Run a backup every day at 05:10 PM.

        Returns:
        the value
      • getReplicateImages

        public OkeClusterImageReplication getReplicateImages()
        Controls the behaviour of image replication across regions.

        Image replication is enabled by default for DR Protection Groups with a primary role. 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