Class: OCI::DataLabelingServiceDataplane::Models::DelimitedFileTypeMetadata

Inherits:
TextFileTypeMetadata show all
Defined in:
lib/oci/data_labeling_service_dataplane/models/delimited_file_type_metadata.rb

Overview

Metadata of delimited files.

Constant Summary

Constants inherited from TextFileTypeMetadata

TextFileTypeMetadata::FORMAT_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from TextFileTypeMetadata

#format_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from TextFileTypeMetadata

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ DelimitedFileTypeMetadata

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :column_name (String) —

    The value to assign to the #column_name property

  • :column_index (Integer) —

    The value to assign to the #column_index property

  • :column_delimiter (String) —

    The value to assign to the #column_delimiter property

  • :line_delimiter (String) —

    The value to assign to the #line_delimiter property

  • :escape_character (String) —

    The value to assign to the #escape_character property



71
72
73
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
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/oci/data_labeling_service_dataplane/models/delimited_file_type_metadata.rb', line 71

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['formatType'] = 'DELIMITED'

  super(attributes)

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

  self.column_name = attributes[:'columnName'] if attributes[:'columnName']

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

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

  self.column_index = attributes[:'columnIndex'] if attributes[:'columnIndex']

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

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

  self.column_delimiter = attributes[:'columnDelimiter'] if attributes[:'columnDelimiter']
  self.column_delimiter = "," if column_delimiter.nil? && !attributes.key?(:'columnDelimiter') # rubocop:disable Style/StringLiterals

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

  self.column_delimiter = attributes[:'column_delimiter'] if attributes[:'column_delimiter']
  self.column_delimiter = "," if column_delimiter.nil? && !attributes.key?(:'columnDelimiter') && !attributes.key?(:'column_delimiter') # rubocop:disable Style/StringLiterals

  self.line_delimiter = attributes[:'lineDelimiter'] if attributes[:'lineDelimiter']

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

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

  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']
end

Instance Attribute Details

#column_delimiter ⇒ String

A column delimiter

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/data_labeling_service_dataplane/models/delimited_file_type_metadata.rb', line 22

def column_delimiter
  @column_delimiter
end

#column_index ⇒ Integer

[Required] The index of a selected column. This is a zero-based index.

Returns:

  • (Integer) 


18
19
20
 
# File 'lib/oci/data_labeling_service_dataplane/models/delimited_file_type_metadata.rb', line 18

def column_index
  @column_index
end

#column_name ⇒ String

The name of a selected column.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/data_labeling_service_dataplane/models/delimited_file_type_metadata.rb', line 14

def column_name
  @column_name
end

#escape_character ⇒ String

An escape character.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/data_labeling_service_dataplane/models/delimited_file_type_metadata.rb', line 30

def escape_character
  @escape_character
end

#line_delimiter ⇒ String

A line delimiter.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/data_labeling_service_dataplane/models/delimited_file_type_metadata.rb', line 26

def line_delimiter
  @line_delimiter
end

Class Method Details

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/oci/data_labeling_service_dataplane/models/delimited_file_type_metadata.rb', line 33

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'format_type': :'formatType',
    'column_name': :'columnName',
    'column_index': :'columnIndex',
    'column_delimiter': :'columnDelimiter',
    'line_delimiter': :'lineDelimiter',
    'escape_character': :'escapeCharacter'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/oci/data_labeling_service_dataplane/models/delimited_file_type_metadata.rb', line 47

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'format_type': :'String',
    'column_name': :'String',
    'column_index': :'Integer',
    'column_delimiter': :'String',
    'line_delimiter': :'String',
    'escape_character': :'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



121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/oci/data_labeling_service_dataplane/models/delimited_file_type_metadata.rb', line 121

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    format_type == other.format_type &&
    column_name == other.column_name &&
    column_index == other.column_index &&
    column_delimiter == other.column_delimiter &&
    line_delimiter == other.line_delimiter &&
    escape_character == other.escape_character
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



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/oci/data_labeling_service_dataplane/models/delimited_file_type_metadata.rb', line 156

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


136
137
138
 
# File 'lib/oci/data_labeling_service_dataplane/models/delimited_file_type_metadata.rb', line 136

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



145
146
147
 
# File 'lib/oci/data_labeling_service_dataplane/models/delimited_file_type_metadata.rb', line 145

def hash
  [format_type, column_name, column_index, column_delimiter, line_delimiter, escape_character].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



189
190
191
192
193
194
195
196
197
198
 
# File 'lib/oci/data_labeling_service_dataplane/models/delimited_file_type_metadata.rb', line 189

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



183
184
185
 
# File 'lib/oci/data_labeling_service_dataplane/models/delimited_file_type_metadata.rb', line 183

def to_s
  to_hash.to_s
end