class OCI::DataIntegration::Models::CsvFormatAttribute

The CSV format attribute.

Attributes

delimiter[RW]

The delimiter for the CSV format. @return [String]

encoding[RW]

The encoding for the file. @return [String]

escape_character[RW]

The escape character for the CSV format. @return [String]

has_header[RW]

Defines whether the file has a header row. @return [BOOLEAN]

quote_character[RW]

The quote character for the CSV format. @return [String]

timestamp_format[RW]

Format for timestamp information. @return [String]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/data_integration/models/csv_format_attribute.rb, line 36
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'modelType',
    'is_file_pattern': :'isFilePattern',
    'encoding': :'encoding',
    'escape_character': :'escapeCharacter',
    'delimiter': :'delimiter',
    'quote_character': :'quoteCharacter',
    'has_header': :'hasHeader',
    'timestamp_format': :'timestampFormat'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [BOOLEAN] :is_file_pattern The value to assign to the {OCI::DataIntegration::Models::AbstractFormatAttribute#is_file_pattern is_file_pattern} proprety @option attributes [String] :encoding The value to assign to the {#encoding} property @option attributes [String] :escape_character The value to assign to the {#escape_character} property @option attributes [String] :delimiter The value to assign to the {#delimiter} property @option attributes [String] :quote_character The value to assign to the {#quote_character} property @option attributes [BOOLEAN] :has_header The value to assign to the {#has_header} property @option attributes [String] :timestamp_format The value to assign to the {#timestamp_format} property

# File lib/oci/data_integration/models/csv_format_attribute.rb, line 80
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['modelType'] = 'CSV_FORMAT'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.encoding = attributes[:'encoding'] if attributes[:'encoding']

  self.escape_character = attributes[:'escapeCharacter'] if attributes[:'escapeCharacter']

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

  self.escape_character = attributes[:'escape_character'] if attributes[:'escape_character']

  self.delimiter = attributes[:'delimiter'] if attributes[:'delimiter']

  self.quote_character = attributes[:'quoteCharacter'] if attributes[:'quoteCharacter']

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

  self.quote_character = attributes[:'quote_character'] if attributes[:'quote_character']

  self.has_header = attributes[:'hasHeader'] unless attributes[:'hasHeader'].nil?

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

  self.has_header = attributes[:'has_header'] unless attributes[:'has_header'].nil?

  self.timestamp_format = attributes[:'timestampFormat'] if attributes[:'timestampFormat']

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

  self.timestamp_format = attributes[:'timestamp_format'] if attributes[:'timestamp_format']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/data_integration/models/csv_format_attribute.rb, line 52
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'model_type': :'String',
    'is_file_pattern': :'BOOLEAN',
    'encoding': :'String',
    'escape_character': :'String',
    'delimiter': :'String',
    'quote_character': :'String',
    'has_header': :'BOOLEAN',
    'timestamp_format': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

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

# File lib/oci/data_integration/models/csv_format_attribute.rb, line 126
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    model_type == other.model_type &&
    is_file_pattern == other.is_file_pattern &&
    encoding == other.encoding &&
    escape_character == other.escape_character &&
    delimiter == other.delimiter &&
    quote_character == other.quote_character &&
    has_header == other.has_header &&
    timestamp_format == other.timestamp_format
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/oci/data_integration/models/csv_format_attribute.rb, line 163
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) click to toggle source

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

# File lib/oci/data_integration/models/csv_format_attribute.rb, line 143
def eql?(other)
  self == other
end
hash() click to toggle source

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

# File lib/oci/data_integration/models/csv_format_attribute.rb, line 152
def hash
  [model_type, is_file_pattern, encoding, escape_character, delimiter, quote_character, has_header, timestamp_format].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/oci/data_integration/models/csv_format_attribute.rb, line 196
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() click to toggle source

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

# File lib/oci/data_integration/models/csv_format_attribute.rb, line 190
def to_s
  to_hash.to_s
end

Private Instance Methods

_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/oci/data_integration/models/csv_format_attribute.rb, line 213
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