class InfluxDB2::Dialect

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

Attributes

comment_prefix[R]

Character prefixed to comment strings

date_time_format[R]

Format of timestamps

delimiter[R]

Separator between cells; the default is ,

header[RW]

If true, the results will contain a header row

Public Class Methods

attribute_map() click to toggle source

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

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/influxdb2/client/models/dialect.rb, line 230
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# 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
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/influxdb2/client/models/dialect.rb, line 79
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# 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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# 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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# 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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# 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
comment_prefix=(comment_prefix) click to toggle source

Custom attribute writer method with validation @param [Object] comment_prefix Value to be assigned

# File lib/influxdb2/client/models/dialect.rb, line 181
def comment_prefix=(comment_prefix)
  if !comment_prefix.nil? && comment_prefix.to_s.length > 1
    fail ArgumentError, '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
    fail ArgumentError, 'invalid value for "comment_prefix", the character length must be great than or equal to 0.'
  end

  @comment_prefix = comment_prefix
end
date_time_format=(date_time_format) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] date_time_format Object to be assigned

# File lib/influxdb2/client/models/dialect.rb, line 195
def date_time_format=(date_time_format)
  validator = EnumAttributeValidator.new('String', ["RFC3339", "RFC3339Nano"])
  unless validator.valid?(date_time_format)
    fail ArgumentError, "invalid value for \"date_time_format\", must be one of #{validator.allowable_values}."
  end
  @date_time_format = date_time_format
end
delimiter=(delimiter) click to toggle source

Custom attribute writer method with validation @param [Object] delimiter Value to be assigned

# File lib/influxdb2/client/models/dialect.rb, line 167
def delimiter=(delimiter)
  if !delimiter.nil? && delimiter.to_s.length > 1
    fail ArgumentError, 'invalid value for "delimiter", the character length must be smaller than or equal to 1.'
  end

  if !delimiter.nil? && delimiter.to_s.length < 1
    fail ArgumentError, 'invalid value for "delimiter", the character length must be great than or equal to 1.'
  end

  @delimiter = delimiter
end
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/influxdb2/client/models/dialect.rb, line 217
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/influxdb2/client/models/dialect.rb, line 223
def hash
  [header, delimiter, annotations, comment_prefix, date_time_format].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# 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() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/influxdb2/client/models/dialect.rb, line 305
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# 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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/influxdb2/client/models/dialect.rb, line 299
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# 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