Class: OCI::DataLabelingServiceDataplane::Models::Annotation

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

Overview

An annotation represents a user- or machine-generated annotation for a given record. The details of the annotation are captured in the RecordAnnotationDetails.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Annotation

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :created_by (String) —

    The value to assign to the #created_by property

  • :updated_by (String) —

    The value to assign to the #updated_by property

  • :record_id (String) —

    The value to assign to the #record_id property

  • :entities (Array<OCI::DataLabelingServiceDataplane::Models::Entity>) —

    The value to assign to the #entities property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/oci/data_labeling_service_dataplane/models/annotation.rb', line 126

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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

  self.created_by = attributes[:'createdBy'] if attributes[:'createdBy']

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

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

  self.updated_by = attributes[:'updatedBy'] if attributes[:'updatedBy']

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

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

  self.record_id = attributes[:'recordId'] if attributes[:'recordId']

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

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

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment for the annotation. This is tied to the dataset. It is not changeable on the record itself.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/data_labeling_service_dataplane/models/annotation.rb', line 49

def compartment_id
  @compartment_id
end

#created_by ⇒ String

[Required] The OCID of the principal which created the annotation.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/data_labeling_service_dataplane/models/annotation.rb', line 33

def created_by
  @created_by
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


69
70
71
 
# File 'lib/oci/data_labeling_service_dataplane/models/annotation.rb', line 69

def defined_tags
  @defined_tags
end

#entities ⇒ Array<OCI::DataLabelingServiceDataplane::Models::Entity>

[Required] The entity types are validated against the dataset to ensure consistency.

Returns:



45
46
47
 
# File 'lib/oci/data_labeling_service_dataplane/models/annotation.rb', line 45

def entities
  @entities
end

#freeform_tags ⇒ Hash<String, String>

A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


63
64
65
 
# File 'lib/oci/data_labeling_service_dataplane/models/annotation.rb', line 63

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the annotation.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/data_labeling_service_dataplane/models/annotation.rb', line 21

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The lifecycle state of an annotation. ACTIVE - The annotation is active to be used for labeling. INACTIVE - The annotation has been marked as inactive and should not be used for labeling. DELETED - Tha annotation been deleted and no longer available for labeling.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/data_labeling_service_dataplane/models/annotation.rb', line 57

def lifecycle_state
  @lifecycle_state
end

#record_id ⇒ String

[Required] The OCID of the record annotated.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/data_labeling_service_dataplane/models/annotation.rb', line 41

def record_id
  @record_id
end

#time_created ⇒ DateTime

[Required] The date and time the annotation was created, in the timestamp format defined by RFC3339.

Returns:

  • (DateTime) 


25
26
27
 
# File 'lib/oci/data_labeling_service_dataplane/models/annotation.rb', line 25

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The date and time the resource was updated, in the timestamp format defined by RFC3339.

Returns:

  • (DateTime) 


29
30
31
 
# File 'lib/oci/data_labeling_service_dataplane/models/annotation.rb', line 29

def time_updated
  @time_updated
end

#updated_by ⇒ String

[Required] The OCID of the principal which updated the annotation.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/data_labeling_service_dataplane/models/annotation.rb', line 37

def updated_by
  @updated_by
end

Class Method Details

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/oci/data_labeling_service_dataplane/models/annotation.rb', line 72

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'created_by': :'createdBy',
    'updated_by': :'updatedBy',
    'record_id': :'recordId',
    'entities': :'entities',
    'compartment_id': :'compartmentId',
    'lifecycle_state': :'lifecycleState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/oci/data_labeling_service_dataplane/models/annotation.rb', line 91

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'created_by': :'String',
    'updated_by': :'String',
    'record_id': :'String',
    'entities': :'Array<OCI::DataLabelingServiceDataplane::Models::Entity>',
    'compartment_id': :'String',
    'lifecycle_state': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # 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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/oci/data_labeling_service_dataplane/models/annotation.rb', line 211

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

  self.class == other.class &&
    id == other.id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    created_by == other.created_by &&
    updated_by == other.updated_by &&
    record_id == other.record_id &&
    entities == other.entities &&
    compartment_id == other.compartment_id &&
    lifecycle_state == other.lifecycle_state &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
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



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/oci/data_labeling_service_dataplane/models/annotation.rb', line 251

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


231
232
233
 
# File 'lib/oci/data_labeling_service_dataplane/models/annotation.rb', line 231

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



240
241
242
 
# File 'lib/oci/data_labeling_service_dataplane/models/annotation.rb', line 240

def hash
  [id, time_created, time_updated, created_by, updated_by, record_id, entities, compartment_id, lifecycle_state, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



284
285
286
287
288
289
290
291
292
293
 
# File 'lib/oci/data_labeling_service_dataplane/models/annotation.rb', line 284

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



278
279
280
 
# File 'lib/oci/data_labeling_service_dataplane/models/annotation.rb', line 278

def to_s
  to_hash.to_s
end