Class: OCI::DataLabelingServiceDataplane::Models::RecordMetadata

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_labeling_service_dataplane/models/record_metadata.rb

Overview

Collection of record's metadata. This can be, for example, the height, width or depth of image for an image record.

This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Direct Known Subclasses

DocumentMetadata, ImageMetadata, TextMetadata

Constant Summary collapse

RECORD_TYPE_ENUM = 
[
  RECORD_TYPE_IMAGE_METADATA = 'IMAGE_METADATA'.freeze,
  RECORD_TYPE_TEXT_METADATA = 'TEXT_METADATA'.freeze,
  RECORD_TYPE_DOCUMENT_METADATA = 'DOCUMENT_METADATA'.freeze,
  RECORD_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RecordMetadata

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :record_type (String) —

    The value to assign to the #record_type property



71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/oci/data_labeling_service_dataplane/models/record_metadata.rb', line 71

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.record_type = attributes[:'recordType'] if attributes[:'recordType']

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

  self.record_type = attributes[:'record_type'] if attributes[:'record_type']
end

Instance Attribute Details

#record_type ⇒ String

The record type based on dataset format details. IMAGE_METADATA - Collection of metadata related to image record. TEXT_METADATA - Collection of metadata related to text record. DOCUMENT_METADATA - Collection of metadata related to document record.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/data_labeling_service_dataplane/models/record_metadata.rb', line 27

def record_type
  @record_type
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
 
# File 'lib/oci/data_labeling_service_dataplane/models/record_metadata.rb', line 30

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'record_type': :'recordType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



52
53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/data_labeling_service_dataplane/models/record_metadata.rb', line 52

def self.get_subtype(object_hash)
  type = object_hash[:'recordType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::DataLabelingServiceDataplane::Models::DocumentMetadata' if type == 'DOCUMENT_METADATA'
  return 'OCI::DataLabelingServiceDataplane::Models::ImageMetadata' if type == 'IMAGE_METADATA'
  return 'OCI::DataLabelingServiceDataplane::Models::TextMetadata' if type == 'TEXT_METADATA'

  # TODO: Log a warning when the subtype is not found.
  'OCI::DataLabelingServiceDataplane::Models::RecordMetadata'
end

.swagger_types ⇒ Object

Attribute type mapping.



39
40
41
42
43
44
45
 
# File 'lib/oci/data_labeling_service_dataplane/models/record_metadata.rb', line 39

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



104
105
106
107
108
109
 
# File 'lib/oci/data_labeling_service_dataplane/models/record_metadata.rb', line 104

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

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



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/oci/data_labeling_service_dataplane/models/record_metadata.rb', line 134

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


114
115
116
 
# File 'lib/oci/data_labeling_service_dataplane/models/record_metadata.rb', line 114

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



123
124
125
 
# File 'lib/oci/data_labeling_service_dataplane/models/record_metadata.rb', line 123

def hash
  [record_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



167
168
169
170
171
172
173
174
175
176
 
# File 'lib/oci/data_labeling_service_dataplane/models/record_metadata.rb', line 167

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



161
162
163
 
# File 'lib/oci/data_labeling_service_dataplane/models/record_metadata.rb', line 161

def to_s
  to_hash.to_s
end