Class: OCI::DataLabelingService::Models::ImportFormat

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_labeling_service/models/import_format.rb

Overview

File format details used for importing dataset

Constant Summary collapse

NAME_ENUM =
[
  NAME_JSONL_CONSOLIDATED = 'JSONL_CONSOLIDATED'.freeze,
  NAME_JSONL_COMPACT_PLUS_CONTENT = 'JSONL_COMPACT_PLUS_CONTENT'.freeze,
  NAME_CONLL = 'CONLL'.freeze,
  NAME_SPACY = 'SPACY'.freeze,
  NAME_COCO = 'COCO'.freeze,
  NAME_YOLO = 'YOLO'.freeze,
  NAME_PASCAL_VOC = 'PASCAL_VOC'.freeze,
  NAME_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
VERSION_ENUM =
[
  VERSION_V2003 = 'V2003'.freeze,
  VERSION_V5 = 'V5'.freeze,
  VERSION_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ImportFormat

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :name (String)

    The value to assign to the #name property

  • :version (String)

    The value to assign to the #version property



65
66
67
68
69
70
71
72
73
74
75
# File 'lib/oci/data_labeling_service/models/import_format.rb', line 65

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

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

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

  self.version = attributes[:'version'] if attributes[:'version']
  self.version = "null" if version.nil? && !attributes.key?(:'version') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#nameString

[Required] Name of import format

Returns:

  • (String)


31
32
33
# File 'lib/oci/data_labeling_service/models/import_format.rb', line 31

def name
  @name
end

#versionString

Version of import format

Returns:

  • (String)


35
36
37
# File 'lib/oci/data_labeling_service/models/import_format.rb', line 35

def version
  @version
end

Class Method Details

.attribute_mapObject

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



38
39
40
41
42
43
44
45
# File 'lib/oci/data_labeling_service/models/import_format.rb', line 38

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'version': :'version'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



48
49
50
51
52
53
54
55
# File 'lib/oci/data_labeling_service/models/import_format.rb', line 48

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'version': :'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



110
111
112
113
114
115
116
# File 'lib/oci/data_labeling_service/models/import_format.rb', line 110

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

  self.class == other.class &&
    name == other.name &&
    version == other.version
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



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
# File 'lib/oci/data_labeling_service/models/import_format.rb', line 141

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


121
122
123
# File 'lib/oci/data_labeling_service/models/import_format.rb', line 121

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



130
131
132
# File 'lib/oci/data_labeling_service/models/import_format.rb', line 130

def hash
  [name, version].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



174
175
176
177
178
179
180
181
182
183
# File 'lib/oci/data_labeling_service/models/import_format.rb', line 174

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



168
169
170
# File 'lib/oci/data_labeling_service/models/import_format.rb', line 168

def to_s
  to_hash.to_s
end