Class: OCI::Psql::Models::BackupPolicy

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

Overview

PostgreSQL database system backup policy. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

KIND_ENUM = 
[
  KIND_DAILY = 'DAILY'.freeze,
  KIND_WEEKLY = 'WEEKLY'.freeze,
  KIND_MONTHLY = 'MONTHLY'.freeze,
  KIND_NONE = 'NONE'.freeze,
  KIND_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

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):

  • :kind (String) —

    The value to assign to the #kind property

  • :retention_days (Integer) —

    The value to assign to the #retention_days property



75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/oci/psql/models/backup_policy.rb', line 75

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.kind = attributes[:'kind'] if attributes[:'kind']

  self.retention_days = attributes[:'retentionDays'] if attributes[:'retentionDays']

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

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

Instance Attribute Details

#kind ⇒ String

The kind of backup policy.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/psql/models/backup_policy.rb', line 23

def kind
  @kind
end

#retention_days ⇒ Integer

How many days the data should be stored after the database system deletion.

Returns:

  • (Integer) 


27
28
29
 
# File 'lib/oci/psql/models/backup_policy.rb', line 27

def retention_days
  @retention_days
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
 
# File 'lib/oci/psql/models/backup_policy.rb', line 30

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'kind': :'kind',
    'retention_days': :'retentionDays'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/oci/psql/models/backup_policy.rb', line 54

def self.get_subtype(object_hash)
  type = object_hash[:'kind'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::Psql::Models::DailyBackupPolicy' if type == 'DAILY'
  return 'OCI::Psql::Models::WeeklyBackupPolicy' if type == 'WEEKLY'
  return 'OCI::Psql::Models::NoneBackupPolicy' if type == 'NONE'
  return 'OCI::Psql::Models::MonthlyBackupPolicy' if type == 'MONTHLY'

  # TODO: Log a warning when the subtype is not found.
  'OCI::Psql::Models::BackupPolicy'
end

.swagger_types ⇒ Object

Attribute type mapping.



40
41
42
43
44
45
46
47
 
# File 'lib/oci/psql/models/backup_policy.rb', line 40

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'kind': :'String',
    'retention_days': :'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



110
111
112
113
114
115
116
 
# File 'lib/oci/psql/models/backup_policy.rb', line 110

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

  self.class == other.class &&
    kind == other.kind &&
    retention_days == other.retention_days
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



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/oci/psql/models/backup_policy.rb', line 141

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


121
122
123
 
# File 'lib/oci/psql/models/backup_policy.rb', line 121

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



130
131
132
 
# File 'lib/oci/psql/models/backup_policy.rb', line 130

def hash
  [kind, retention_days].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



174
175
176
177
178
179
180
181
182
183
 
# File 'lib/oci/psql/models/backup_policy.rb', line 174

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



168
169
170
 
# File 'lib/oci/psql/models/backup_policy.rb', line 168

def to_s
  to_hash.to_s
end