Class: OCI::DisasterRecovery::Models::OkeClusterBackupConfig

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/disaster_recovery/models/oke_cluster_backup_config.rb

Overview

The details of backup performed on OKE Cluster.

Constant Summary collapse

REPLICATE_IMAGES_ENUM = 
[
  REPLICATE_IMAGES_ENABLE = 'ENABLE'.freeze,
  REPLICATE_IMAGES_DISABLE = 'DISABLE'.freeze,
  REPLICATE_IMAGES_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OkeClusterBackupConfig

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/oci/disaster_recovery/models/oke_cluster_backup_config.rb', line 92

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.namespaces = attributes[:'namespaces'] if attributes[:'namespaces']

  self.backup_schedule = attributes[:'backupSchedule'] if attributes[:'backupSchedule']
  self.backup_schedule = "FREQ=WEEKLY;INTERVAL=1" if backup_schedule.nil? && !attributes.key?(:'backupSchedule') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :backupSchedule and :backup_schedule' if attributes.key?(:'backupSchedule') && attributes.key?(:'backup_schedule')

  self.backup_schedule = attributes[:'backup_schedule'] if attributes[:'backup_schedule']
  self.backup_schedule = "FREQ=WEEKLY;INTERVAL=1" if backup_schedule.nil? && !attributes.key?(:'backupSchedule') && !attributes.key?(:'backup_schedule') # rubocop:disable Style/StringLiterals

  self.replicate_images = attributes[:'replicateImages'] if attributes[:'replicateImages']

  raise 'You cannot provide both :replicateImages and :replicate_images' if attributes.key?(:'replicateImages') && attributes.key?(:'replicate_images')

  self.replicate_images = attributes[:'replicate_images'] if attributes[:'replicate_images']

  self.max_number_of_backups_retained = attributes[:'maxNumberOfBackupsRetained'] if attributes[:'maxNumberOfBackupsRetained']
  self.max_number_of_backups_retained = 5 if max_number_of_backups_retained.nil? && !attributes.key?(:'maxNumberOfBackupsRetained') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :maxNumberOfBackupsRetained and :max_number_of_backups_retained' if attributes.key?(:'maxNumberOfBackupsRetained') && attributes.key?(:'max_number_of_backups_retained')

  self.max_number_of_backups_retained = attributes[:'max_number_of_backups_retained'] if attributes[:'max_number_of_backups_retained']
  self.max_number_of_backups_retained = 5 if max_number_of_backups_retained.nil? && !attributes.key?(:'maxNumberOfBackupsRetained') && !attributes.key?(:'max_number_of_backups_retained') # rubocop:disable Style/StringLiterals

  self.image_replication_vault_secret_id = attributes[:'imageReplicationVaultSecretId'] if attributes[:'imageReplicationVaultSecretId']

  raise 'You cannot provide both :imageReplicationVaultSecretId and :image_replication_vault_secret_id' if attributes.key?(:'imageReplicationVaultSecretId') && attributes.key?(:'image_replication_vault_secret_id')

  self.image_replication_vault_secret_id = attributes[:'image_replication_vault_secret_id'] if attributes[:'image_replication_vault_secret_id']
end

Instance Attribute Details

#backup_schedule ⇒ String

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:

  • (String) 


35
36
37
 
# File 'lib/oci/disaster_recovery/models/oke_cluster_backup_config.rb', line 35

def backup_schedule
  @backup_schedule
end

#image_replication_vault_secret_id ⇒ String

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:

  • (String) 


53
54
55
 
# File 'lib/oci/disaster_recovery/models/oke_cluster_backup_config.rb', line 53

def image_replication_vault_secret_id
  @image_replication_vault_secret_id
end

#max_number_of_backups_retained ⇒ Integer

The maximum number of backups that should be retained. This property applies to the OKE cluster member in primary region.

Returns:

  • (Integer) 


47
48
49
 
# File 'lib/oci/disaster_recovery/models/oke_cluster_backup_config.rb', line 47

def max_number_of_backups_retained
  @max_number_of_backups_retained
end

#namespaces ⇒ Array<String>

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:

  • (Array<String>) 


26
27
28
 
# File 'lib/oci/disaster_recovery/models/oke_cluster_backup_config.rb', line 26

def namespaces
  @namespaces
end

#replicate_images ⇒ String

Controls the behaviour of image replication across regions. This property applies to the OKE cluster member in primary region.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/disaster_recovery/models/oke_cluster_backup_config.rb', line 41

def replicate_images
  @replicate_images
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/oci/disaster_recovery/models/oke_cluster_backup_config.rb', line 56

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'namespaces': :'namespaces',
    'backup_schedule': :'backupSchedule',
    'replicate_images': :'replicateImages',
    'max_number_of_backups_retained': :'maxNumberOfBackupsRetained',
    'image_replication_vault_secret_id': :'imageReplicationVaultSecretId'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/oci/disaster_recovery/models/oke_cluster_backup_config.rb', line 69

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'namespaces': :'Array<String>',
    'backup_schedule': :'String',
    'replicate_images': :'String',
    'max_number_of_backups_retained': :'Integer',
    'image_replication_vault_secret_id': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



149
150
151
152
153
154
155
156
157
158
 
# File 'lib/oci/disaster_recovery/models/oke_cluster_backup_config.rb', line 149

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    namespaces == other.namespaces &&
    backup_schedule == other.backup_schedule &&
    replicate_images == other.replicate_images &&
    max_number_of_backups_retained == other.max_number_of_backups_retained &&
    image_replication_vault_secret_id == other.image_replication_vault_secret_id
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/oci/disaster_recovery/models/oke_cluster_backup_config.rb', line 183

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


163
164
165
 
# File 'lib/oci/disaster_recovery/models/oke_cluster_backup_config.rb', line 163

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



172
173
174
 
# File 'lib/oci/disaster_recovery/models/oke_cluster_backup_config.rb', line 172

def hash
  [namespaces, backup_schedule, replicate_images, max_number_of_backups_retained, image_replication_vault_secret_id].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



216
217
218
219
220
221
222
223
224
225
 
# File 'lib/oci/disaster_recovery/models/oke_cluster_backup_config.rb', line 216

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



210
211
212
 
# File 'lib/oci/disaster_recovery/models/oke_cluster_backup_config.rb', line 210

def to_s
  to_hash.to_s
end