Class: OCI::DataLabelingServiceDataplane::Models::CreateAnnotationDetails
- Inherits:
-
Object
- Object
- OCI::DataLabelingServiceDataplane::Models::CreateAnnotationDetails
- Defined in:
- lib/oci/data_labeling_service_dataplane/models/create_annotation_details.rb
Overview
This is the payload sent in the CreateAnnotation operation. It contains all the information required for a user to create an annotation for a record.
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The OCID of the compartment for the annotation.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
The defined tags for this resource.
-
#entities ⇒ Array<OCI::DataLabelingServiceDataplane::Models::Entity>
[Required] The entity types are validated against the dataset to ensure consistency.
-
#freeform_tags ⇒ Hash<String, String>
A simple key-value pair that is applied without any predefined name, type, or scope.
-
#record_id ⇒ String
[Required] The OCID of the record annotated.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ CreateAnnotationDetails
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ CreateAnnotationDetails
Initializes the object
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 |
# File 'lib/oci/data_labeling_service_dataplane/models/create_annotation_details.rb', line 72 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_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.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.entities = attributes[:'entities'] if attributes[:'entities'] self. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The OCID of the compartment for the annotation.
17 18 19 |
# File 'lib/oci/data_labeling_service_dataplane/models/create_annotation_details.rb', line 17 def compartment_id @compartment_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\"}}
33 34 35 |
# File 'lib/oci/data_labeling_service_dataplane/models/create_annotation_details.rb', line 33 def @defined_tags end |
#entities ⇒ Array<OCI::DataLabelingServiceDataplane::Models::Entity>
[Required] The entity types are validated against the dataset to ensure consistency.
21 22 23 |
# File 'lib/oci/data_labeling_service_dataplane/models/create_annotation_details.rb', line 21 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\"}
27 28 29 |
# File 'lib/oci/data_labeling_service_dataplane/models/create_annotation_details.rb', line 27 def @freeform_tags end |
#record_id ⇒ String
[Required] The OCID of the record annotated.
13 14 15 |
# File 'lib/oci/data_labeling_service_dataplane/models/create_annotation_details.rb', line 13 def record_id @record_id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
36 37 38 39 40 41 42 43 44 45 46 |
# File 'lib/oci/data_labeling_service_dataplane/models/create_annotation_details.rb', line 36 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'record_id': :'recordId', 'compartment_id': :'compartmentId', 'entities': :'entities', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
49 50 51 52 53 54 55 56 57 58 59 |
# File 'lib/oci/data_labeling_service_dataplane/models/create_annotation_details.rb', line 49 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'record_id': :'String', 'compartment_id': :'String', 'entities': :'Array<OCI::DataLabelingServiceDataplane::Models::Entity>', '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.
112 113 114 115 116 117 118 119 120 121 |
# File 'lib/oci/data_labeling_service_dataplane/models/create_annotation_details.rb', line 112 def ==(other) return true if equal?(other) self.class == other.class && record_id == other.record_id && compartment_id == other.compartment_id && entities == other.entities && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 |
# File 'lib/oci/data_labeling_service_dataplane/models/create_annotation_details.rb', line 146 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
126 127 128 |
# File 'lib/oci/data_labeling_service_dataplane/models/create_annotation_details.rb', line 126 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
135 136 137 |
# File 'lib/oci/data_labeling_service_dataplane/models/create_annotation_details.rb', line 135 def hash [record_id, compartment_id, entities, , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
179 180 181 182 183 184 185 186 187 188 |
# File 'lib/oci/data_labeling_service_dataplane/models/create_annotation_details.rb', line 179 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
173 174 175 |
# File 'lib/oci/data_labeling_service_dataplane/models/create_annotation_details.rb', line 173 def to_s to_hash.to_s end |