Class: OCI::Opensearch::Models::BackupPolicy

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/opensearch/models/backup_policy.rb

Overview

Backup policy as optionally used for Opensearch cluster.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BackupPolicy

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :is_enabled (BOOLEAN) —

    The value to assign to the #is_enabled property

  • :retention_in_days (Integer) —

    The value to assign to the #retention_in_days property

  • :frequency_in_hours (Integer) —

    The value to assign to the #frequency_in_hours property



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/oci/opensearch/models/backup_policy.rb', line 55

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.is_enabled = attributes[:'isEnabled'] unless attributes[:'isEnabled'].nil?
  self.is_enabled = true if is_enabled.nil? && !attributes.key?(:'isEnabled') # rubocop:disable Style/StringLiterals

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

  self.is_enabled = attributes[:'is_enabled'] unless attributes[:'is_enabled'].nil?
  self.is_enabled = true if is_enabled.nil? && !attributes.key?(:'isEnabled') && !attributes.key?(:'is_enabled') # rubocop:disable Style/StringLiterals

  self.retention_in_days = attributes[:'retentionInDays'] if attributes[:'retentionInDays']

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

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

  self.frequency_in_hours = attributes[:'frequencyInHours'] if attributes[:'frequencyInHours']

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

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

Instance Attribute Details

#frequency_in_hours ⇒ Integer

Specifies how often backup should be performed

Returns:

  • (Integer) 


22
23
24
 
# File 'lib/oci/opensearch/models/backup_policy.rb', line 22

def frequency_in_hours
  @frequency_in_hours
end

#is_enabled ⇒ BOOLEAN

Specifies if automatic backups are enabled.

Returns:

  • (BOOLEAN) 


14
15
16
 
# File 'lib/oci/opensearch/models/backup_policy.rb', line 14

def is_enabled
  @is_enabled
end

#retention_in_days ⇒ Integer

Specifies how long backup copy should remain on Storage in days

Returns:

  • (Integer) 


18
19
20
 
# File 'lib/oci/opensearch/models/backup_policy.rb', line 18

def retention_in_days
  @retention_in_days
end

Class Method Details

.attribute_map ⇒ Object

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



25
26
27
28
29
30
31
32
33
 
# File 'lib/oci/opensearch/models/backup_policy.rb', line 25

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'is_enabled': :'isEnabled',
    'retention_in_days': :'retentionInDays',
    'frequency_in_hours': :'frequencyInHours'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



36
37
38
39
40
41
42
43
44
 
# File 'lib/oci/opensearch/models/backup_policy.rb', line 36

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'is_enabled': :'BOOLEAN',
    'retention_in_days': :'Integer',
    'frequency_in_hours': :'Integer'
    # 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



89
90
91
92
93
94
95
96
 
# File 'lib/oci/opensearch/models/backup_policy.rb', line 89

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

  self.class == other.class &&
    is_enabled == other.is_enabled &&
    retention_in_days == other.retention_in_days &&
    frequency_in_hours == other.frequency_in_hours
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



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/oci/opensearch/models/backup_policy.rb', line 121

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


101
102
103
 
# File 'lib/oci/opensearch/models/backup_policy.rb', line 101

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



110
111
112
 
# File 'lib/oci/opensearch/models/backup_policy.rb', line 110

def hash
  [is_enabled, retention_in_days, frequency_in_hours].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



154
155
156
157
158
159
160
161
162
163
 
# File 'lib/oci/opensearch/models/backup_policy.rb', line 154

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



148
149
150
 
# File 'lib/oci/opensearch/models/backup_policy.rb', line 148

def to_s
  to_hash.to_s
end