Class: InfluxDB2::Dialect

Inherits:
Object
  • Object
show all
Defined in:
lib/influxdb2/client/models/dialect.rb

Overview

Dialect are options to change the default CSV output format; www.w3.org/TR/2015/REC-tabular-metadata-20151217/#dialect-descriptions

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Dialect

Initializes the object

Parameters:

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

    Model attributes in the form of hash



86
87
88
89
90
91
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
128
 
# File 'lib/influxdb2/client/models/dialect.rb', line 86

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `InfluxDB2::Dialect` 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::Dialect`. 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?(:'header')
    self.header = attributes[:'header']
  else
    self.header = true
  end

  if attributes.key?(:'delimiter')
    self.delimiter = attributes[:'delimiter']
  else
    self.delimiter = ','
  end

  if attributes.key?(:'annotations')
    if (value = attributes[:'annotations']).is_a?(Array)
      self.annotations = value
    end
  end

  if attributes.key?(:'comment_prefix')
    self.comment_prefix = attributes[:'comment_prefix']
  else
    self.comment_prefix = '#'
  end

  if attributes.key?(:'date_time_format')
    self.date_time_format = attributes[:'date_time_format']
  else
    self.date_time_format = 'RFC3339'
  end
end

Instance Attribute Details

#annotations ⇒ Object

www.w3.org/TR/2015/REC-tabular-data-model-20151217/#columns



26
27
28
 
# File 'lib/influxdb2/client/models/dialect.rb', line 26

def annotations
  @annotations
end

#comment_prefix ⇒ Object

Character prefixed to comment strings



29
30
31
 
# File 'lib/influxdb2/client/models/dialect.rb', line 29

def comment_prefix
  @comment_prefix
end

#date_time_format ⇒ Object

Format of timestamps



32
33
34
 
# File 'lib/influxdb2/client/models/dialect.rb', line 32

def date_time_format
  @date_time_format
end

#delimiter ⇒ Object

Separator between cells; the default is ,



23
24
25
 
# File 'lib/influxdb2/client/models/dialect.rb', line 23

def delimiter
  @delimiter
end

#header ⇒ Object

If true, the results will contain a header row



20
21
22
 
# File 'lib/influxdb2/client/models/dialect.rb', line 20

def header
  @header
end

Class Method Details

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
 
# File 'lib/influxdb2/client/models/dialect.rb', line 57

def self.attribute_map
  {
    :'header' => :'header',
    :'delimiter' => :'delimiter',
    :'annotations' => :'annotations',
    :'comment_prefix' => :'commentPrefix',
    :'date_time_format' => :'dateTimeFormat',
  }
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



230
231
232
 
# File 'lib/influxdb2/client/models/dialect.rb', line 230

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



79
80
81
82
 
# File 'lib/influxdb2/client/models/dialect.rb', line 79

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

.openapi_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
 
# File 'lib/influxdb2/client/models/dialect.rb', line 68

def self.openapi_types
  {
    :'header' => :'Boolean',
    :'delimiter' => :'String',
    :'annotations' => :'Array<String>',
    :'comment_prefix' => :'String',
    :'date_time_format' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



205
206
207
208
209
210
211
212
213
 
# File 'lib/influxdb2/client/models/dialect.rb', line 205

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      header == o.header &&
      delimiter == o.delimiter &&
      annotations == o.annotations &&
      comment_prefix == o.comment_prefix &&
      date_time_format == o.date_time_format
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



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/influxdb2/client/models/dialect.rb', line 260

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.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



329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/influxdb2/client/models/dialect.rb', line 329

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



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/influxdb2/client/models/dialect.rb', line 237

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


217
218
219
 
# File 'lib/influxdb2/client/models/dialect.rb', line 217

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



223
224
225
 
# File 'lib/influxdb2/client/models/dialect.rb', line 223

def hash
  [header, delimiter, annotations, comment_prefix, date_time_format].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



132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/influxdb2/client/models/dialect.rb', line 132

def list_invalid_properties
  invalid_properties = Array.new
  if !@delimiter.nil? && @delimiter.to_s.length > 1
    invalid_properties.push('invalid value for "delimiter", the character length must be smaller than or equal to 1.')
  end

  if !@delimiter.nil? && @delimiter.to_s.length < 1
    invalid_properties.push('invalid value for "delimiter", the character length must be great than or equal to 1.')
  end

  if !@comment_prefix.nil? && @comment_prefix.to_s.length > 1
    invalid_properties.push('invalid value for "comment_prefix", the character length must be smaller than or equal to 1.')
  end

  if !@comment_prefix.nil? && @comment_prefix.to_s.length < 0
    invalid_properties.push('invalid value for "comment_prefix", the character length must be great 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



305
306
307
 
# File 'lib/influxdb2/client/models/dialect.rb', line 305

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



311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/influxdb2/client/models/dialect.rb', line 311

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



299
300
301
 
# File 'lib/influxdb2/client/models/dialect.rb', line 299

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



155
156
157
158
159
160
161
162
163
 
# File 'lib/influxdb2/client/models/dialect.rb', line 155

def valid?
  return false if !@delimiter.nil? && @delimiter.to_s.length > 1
  return false if !@delimiter.nil? && @delimiter.to_s.length < 1
  return false if !@comment_prefix.nil? && @comment_prefix.to_s.length > 1
  return false if !@comment_prefix.nil? && @comment_prefix.to_s.length < 0
  date_time_format_validator = EnumAttributeValidator.new('String', ["RFC3339", "RFC3339Nano"])
  return false unless date_time_format_validator.valid?(@date_time_format)
  true
end