Class: OCI::DataIntegration::Models::CsvFormatAttribute

Inherits:
AbstractFormatAttribute show all
Defined in:
lib/oci/data_integration/models/csv_format_attribute.rb

Overview

The CSV format attribute.

Constant Summary

Constants inherited from AbstractFormatAttribute

AbstractFormatAttribute::MODEL_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from AbstractFormatAttribute

#is_file_pattern, #model_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from AbstractFormatAttribute

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CsvFormatAttribute

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :is_file_pattern (BOOLEAN) —

    The value to assign to the #is_file_pattern proprety

  • :encoding (String) —

    The value to assign to the #encoding property

  • :escape_character (String) —

    The value to assign to the #escape_character property

  • :delimiter (String) —

    The value to assign to the #delimiter property

  • :quote_character (String) —

    The value to assign to the #quote_character property

  • :has_header (BOOLEAN) —

    The value to assign to the #has_header property

  • :timestamp_format (String) —

    The value to assign to the #timestamp_format property

[View source]

81
82
83
84
85
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
 
# File 'lib/oci/data_integration/models/csv_format_attribute.rb', line 81

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

Instance Attribute Details

#delimiter ⇒ String

The delimiter for the CSV format.

Returns:

  • (String) 

22
23
24
 
# File 'lib/oci/data_integration/models/csv_format_attribute.rb', line 22

def delimiter
  @delimiter
end

#encoding ⇒ String

The encoding for the file.

Returns:

  • (String) 

14
15
16
 
# File 'lib/oci/data_integration/models/csv_format_attribute.rb', line 14

def encoding
  @encoding
end

#escape_character ⇒ String

The escape character for the CSV format.

Returns:

  • (String) 

18
19
20
 
# File 'lib/oci/data_integration/models/csv_format_attribute.rb', line 18

def escape_character
  @escape_character
end

#has_header ⇒ BOOLEAN

Defines whether the file has a header row.

Returns:

  • (BOOLEAN) 

30
31
32
 
# File 'lib/oci/data_integration/models/csv_format_attribute.rb', line 30

def has_header
  @has_header
end

#quote_character ⇒ String

The quote character for the CSV format.

Returns:

  • (String) 

26
27
28
 
# File 'lib/oci/data_integration/models/csv_format_attribute.rb', line 26

def quote_character
  @quote_character
end

#timestamp_format ⇒ String

Format for timestamp information.

Returns:

  • (String) 

34
35
36
 
# File 'lib/oci/data_integration/models/csv_format_attribute.rb', line 34

def timestamp_format
  @timestamp_format
end

Class Method Details

.attribute_map ⇒ Object

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

[View source]

37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/oci/data_integration/models/csv_format_attribute.rb', line 37

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

.swagger_types ⇒ Object

Attribute type mapping.

[View source]

53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/oci/data_integration/models/csv_format_attribute.rb', line 53

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

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared

[View source]

127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/oci/data_integration/models/csv_format_attribute.rb', line 127

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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself

[View source]

164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/oci/data_integration/models/csv_format_attribute.rb', line 164

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
[View source]

144
145
146
 
# File 'lib/oci/data_integration/models/csv_format_attribute.rb', line 144

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code

[View source]

153
154
155
 
# File 'lib/oci/data_integration/models/csv_format_attribute.rb', line 153

def hash
  [model_type, is_file_pattern, encoding, escape_character, delimiter, quote_character, has_header, timestamp_format].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash

[View source]

197
198
199
200
201
202
203
204
205
206
 
# File 'lib/oci/data_integration/models/csv_format_attribute.rb', line 197

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

[View source]

191
192
193
 
# File 'lib/oci/data_integration/models/csv_format_attribute.rb', line 191

def to_s
  to_hash.to_s
end