Class: OCI::Iot::Models::ChangeIotDomainDataRetentionPeriodDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/iot/models/change_iot_domain_data_retention_period_details.rb

Overview

The configuration details for data retention periods.

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_RAW_DATA = 'RAW_DATA'.freeze,
  TYPE_REJECTED_DATA = 'REJECTED_DATA'.freeze,
  TYPE_HISTORIZED_DATA = 'HISTORIZED_DATA'.freeze,
  TYPE_RAW_COMMAND_DATA = 'RAW_COMMAND_DATA'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ChangeIotDomainDataRetentionPeriodDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/oci/iot/models/change_iot_domain_data_retention_period_details.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.type = attributes[:'type'] if attributes[:'type']

  self.data_retention_period_in_days = attributes[:'dataRetentionPeriodInDays'] if attributes[:'dataRetentionPeriodInDays']

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

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

Instance Attribute Details

#data_retention_period_in_days ⇒ Integer

[Required] The duration (in days) for which data will be retained in the IoT domain.

Returns:

  • (Integer) 


25
26
27
 
# File 'lib/oci/iot/models/change_iot_domain_data_retention_period_details.rb', line 25

def data_retention_period_in_days
  @data_retention_period_in_days
end

#type ⇒ String

[Required] The type of data retention period to apply. Allowed values are RAW_DATA, REJECTED_DATA, HISTORIZED_DATA, and RAW_COMMAND_DATA.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/iot/models/change_iot_domain_data_retention_period_details.rb', line 21

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



28
29
30
31
32
33
34
35
 
# File 'lib/oci/iot/models/change_iot_domain_data_retention_period_details.rb', line 28

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'data_retention_period_in_days': :'dataRetentionPeriodInDays'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



38
39
40
41
42
43
44
45
 
# File 'lib/oci/iot/models/change_iot_domain_data_retention_period_details.rb', line 38

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



85
86
87
88
89
90
91
 
# File 'lib/oci/iot/models/change_iot_domain_data_retention_period_details.rb', line 85

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

  self.class == other.class &&
    type == other.type &&
    data_retention_period_in_days == other.data_retention_period_in_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



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/oci/iot/models/change_iot_domain_data_retention_period_details.rb', line 116

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


96
97
98
 
# File 'lib/oci/iot/models/change_iot_domain_data_retention_period_details.rb', line 96

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



105
106
107
 
# File 'lib/oci/iot/models/change_iot_domain_data_retention_period_details.rb', line 105

def hash
  [type, data_retention_period_in_days].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



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

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



143
144
145
 
# File 'lib/oci/iot/models/change_iot_domain_data_retention_period_details.rb', line 143

def to_s
  to_hash.to_s
end