Class: OCI::DataLabelingServiceDataplane::Models::Record

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

Overview

A record represents an entry in a dataset that needs labeling.

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 = {}) ⇒ Record

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/oci/data_labeling_service_dataplane/models/record.rb', line 132

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

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

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

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

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

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

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

  self.is_labeled = attributes[:'isLabeled'] unless attributes[:'isLabeled'].nil?

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

  self.is_labeled = attributes[:'is_labeled'] unless attributes[:'is_labeled'].nil?

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

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

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

  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 task.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#dataset_id ⇒ String

[Required] The OCID of the dataset to associate the record with.

Returns:

  • (String) 


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

def dataset_id
  @dataset_id
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>>) 


72
73
74
 
# File 'lib/oci/data_labeling_service_dataplane/models/record.rb', line 72

def defined_tags
  @defined_tags
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>) 


66
67
68
 
# File 'lib/oci/data_labeling_service_dataplane/models/record.rb', line 66

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the record.

Returns:

  • (String) 


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

def id
  @id
end

#is_labeled ⇒ BOOLEAN

[Required] Whether or not the record has been labeled and has associated annotations.

Returns:

  • (BOOLEAN) 


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

def is_labeled
  @is_labeled
end

#lifecycle_state ⇒ String

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

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

[Required] The name is created by the user. It is unique and immutable.

Returns:

  • (String) 


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

def name
  @name
end

#record_metadata ⇒ OCI::DataLabelingServiceDataplane::Models::RecordMetadata

Returns:



60
61
62
 
# File 'lib/oci/data_labeling_service_dataplane/models/record.rb', line 60

def record_metadata
  @record_metadata
end

#source_details ⇒ OCI::DataLabelingServiceDataplane::Models::SourceDetails

This attribute is required.

Returns:



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

def source_details
  @source_details
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


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

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) 


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

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/oci/data_labeling_service_dataplane/models/record.rb', line 75

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'name': :'name',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'dataset_id': :'datasetId',
    'compartment_id': :'compartmentId',
    'source_details': :'sourceDetails',
    'is_labeled': :'isLabeled',
    'lifecycle_state': :'lifecycleState',
    'record_metadata': :'recordMetadata',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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/record.rb', line 95

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'name': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'dataset_id': :'String',
    'compartment_id': :'String',
    'source_details': :'OCI::DataLabelingServiceDataplane::Models::SourceDetails',
    'is_labeled': :'BOOLEAN',
    'lifecycle_state': :'String',
    'record_metadata': :'OCI::DataLabelingServiceDataplane::Models::RecordMetadata',
    '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



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/oci/data_labeling_service_dataplane/models/record.rb', line 223

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

  self.class == other.class &&
    id == other.id &&
    name == other.name &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    dataset_id == other.dataset_id &&
    compartment_id == other.compartment_id &&
    source_details == other.source_details &&
    is_labeled == other.is_labeled &&
    lifecycle_state == other.lifecycle_state &&
    record_metadata == other.record_metadata &&
    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



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/oci/data_labeling_service_dataplane/models/record.rb', line 264

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


244
245
246
 
# File 'lib/oci/data_labeling_service_dataplane/models/record.rb', line 244

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



253
254
255
 
# File 'lib/oci/data_labeling_service_dataplane/models/record.rb', line 253

def hash
  [id, name, time_created, time_updated, dataset_id, compartment_id, source_details, is_labeled, lifecycle_state, record_metadata, 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



297
298
299
300
301
302
303
304
305
306
 
# File 'lib/oci/data_labeling_service_dataplane/models/record.rb', line 297

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



291
292
293
 
# File 'lib/oci/data_labeling_service_dataplane/models/record.rb', line 291

def to_s
  to_hash.to_s
end