Class: InfluxDB2::API::RetentionRule

Inherits:
Object
  • Object
show all
Defined in:
apis/lib/influxdb2/apis/generated/models/retention_rule.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RetentionRule

Initializes the object

Parameters:

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

    Model attributes in the form of hash



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'apis/lib/influxdb2/apis/generated/models/retention_rule.rb', line 74

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `InfluxDB2::RetentionRule` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `InfluxDB2::RetentionRule`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = 'expire'
  end

  if attributes.key?(:'every_seconds')
    self.every_seconds = attributes[:'every_seconds']
  end

  if attributes.key?(:'shard_group_duration_seconds')
    self.shard_group_duration_seconds = attributes[:'shard_group_duration_seconds']
  end
end

Instance Attribute Details

#every_seconds ⇒ Object

Duration in seconds for how long data will be kept in the database. 0 means infinite.



21
22
23
 
# File 'apis/lib/influxdb2/apis/generated/models/retention_rule.rb', line 21

def every_seconds
  @every_seconds
end

#shard_group_duration_seconds ⇒ Object

Shard duration measured in seconds.



24
25
26
 
# File 'apis/lib/influxdb2/apis/generated/models/retention_rule.rb', line 24

def shard_group_duration_seconds
  @shard_group_duration_seconds
end

#type ⇒ Object

Returns the value of attribute type.



18
19
20
 
# File 'apis/lib/influxdb2/apis/generated/models/retention_rule.rb', line 18

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
 
# File 'apis/lib/influxdb2/apis/generated/models/retention_rule.rb', line 49

def self.attribute_map
  {
    :'type' => :'type',
    :'every_seconds' => :'everySeconds',
    :'shard_group_duration_seconds' => :'shardGroupDurationSeconds',
  }
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



181
182
183
 
# File 'apis/lib/influxdb2/apis/generated/models/retention_rule.rb', line 181

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



67
68
69
70
 
# File 'apis/lib/influxdb2/apis/generated/models/retention_rule.rb', line 67

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
 
# File 'apis/lib/influxdb2/apis/generated/models/retention_rule.rb', line 58

def self.openapi_types
  {
    :'type' => :'String',
    :'every_seconds' => :'Integer',
    :'shard_group_duration_seconds' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



158
159
160
161
162
163
164
 
# File 'apis/lib/influxdb2/apis/generated/models/retention_rule.rb', line 158

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      every_seconds == o.every_seconds &&
      shard_group_duration_seconds == o.shard_group_duration_seconds
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'apis/lib/influxdb2/apis/generated/models/retention_rule.rb', line 211

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    InfluxDB2::API.const_get(type).build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'apis/lib/influxdb2/apis/generated/models/retention_rule.rb', line 280

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
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



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'apis/lib/influxdb2/apis/generated/models/retention_rule.rb', line 188

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


168
169
170
 
# File 'apis/lib/influxdb2/apis/generated/models/retention_rule.rb', line 168

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



174
175
176
 
# File 'apis/lib/influxdb2/apis/generated/models/retention_rule.rb', line 174

def hash
  [type, every_seconds, shard_group_duration_seconds].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'apis/lib/influxdb2/apis/generated/models/retention_rule.rb', line 104

def list_invalid_properties
  invalid_properties = Array.new
  if @type.nil?
    invalid_properties.push('invalid value for "type", type cannot be nil.')
  end

  if @every_seconds.nil?
    invalid_properties.push('invalid value for "every_seconds", every_seconds cannot be nil.')
  end

  if @every_seconds < 0
    invalid_properties.push('invalid value for "every_seconds", must be greater than or equal to 0.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



256
257
258
 
# File 'apis/lib/influxdb2/apis/generated/models/retention_rule.rb', line 256

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'apis/lib/influxdb2/apis/generated/models/retention_rule.rb', line 262

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    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



250
251
252
 
# File 'apis/lib/influxdb2/apis/generated/models/retention_rule.rb', line 250

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



123
124
125
126
127
128
129
130
 
# File 'apis/lib/influxdb2/apis/generated/models/retention_rule.rb', line 123

def valid?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["expire"])
  return false unless type_validator.valid?(@type)
  return false if @every_seconds.nil?
  return false if @every_seconds < 0
  true
end