class OCI::DataScience::Models::Model
Models are mathematical representations of the relationships between data. Models are represented by their associated metadata and artifacts.
Constants
- LIFECYCLE_STATE_ENUM
Attributes
[Required] The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model's compartment. @return [String]
[Required] The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the user who created the model. @return [String]
An array of custom metadata details for the model. @return [Array<OCI::DataScience::Models::Metadata>]
An array of defined metadata details for the model. @return [Array<OCI::DataScience::Models::Metadata>]
A short description of the model. @return [String]
[Required] A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information. @return [String]
[Required] The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the model. @return [String]
Input schema file content in String format @return [String]
[Required] The state of the model. @return [String]
Output schema file content in String format @return [String]
[Required] The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the project associated with the model. @return [String]
[Required] The date and time the resource was created in the timestamp format defined by [RFC3339](tools.ietf.org/html/rfc3339). Example: 2019-08-25T21:10:29.41Z
@return [DateTime]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/data_science/models/model.rb, line 82 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'compartment_id': :'compartmentId', 'project_id': :'projectId', 'display_name': :'displayName', 'description': :'description', 'lifecycle_state': :'lifecycleState', 'time_created': :'timeCreated', 'created_by': :'createdBy', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'custom_metadata_list': :'customMetadataList', 'defined_metadata_list': :'definedMetadataList', 'input_schema': :'inputSchema', 'output_schema': :'outputSchema' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model
attributes in the form of hash @option attributes [String] :id The value to assign to the {#id} property @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property @option attributes [String] :project_id The value to assign to the {#project_id} property @option attributes [String] :display_name The value to assign to the {#display_name} property @option attributes [String] :description The value to assign to the {#description} property @option attributes [String] :lifecycle_state The value to assign to the {#lifecycle_state} property @option attributes [DateTime] :time_created The value to assign to the {#time_created} property @option attributes [String] :created_by The value to assign to the {#created_by} property @option attributes [Hash<String, String>] :freeform_tags The value to assign to the {#freeform_tags} property @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {#defined_tags} property @option attributes [Array<OCI::DataScience::Models::Metadata>] :custom_metadata_list The value to assign to the {#custom_metadata_list} property @option attributes [Array<OCI::DataScience::Models::Metadata>] :defined_metadata_list The value to assign to the {#defined_metadata_list} property @option attributes [String] :input_schema The value to assign to the {#input_schema} property @option attributes [String] :output_schema The value to assign to the {#output_schema} property
# File lib/oci/data_science/models/model.rb, line 145 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.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.project_id = attributes[:'projectId'] if attributes[:'projectId'] raise 'You cannot provide both :projectId and :project_id' if attributes.key?(:'projectId') && attributes.key?(:'project_id') self.project_id = attributes[:'project_id'] if attributes[:'project_id'] self.display_name = attributes[:'displayName'] if attributes[:'displayName'] raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name') self.display_name = attributes[:'display_name'] if attributes[:'display_name'] self.description = attributes[:'description'] if attributes[:'description'] 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.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.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.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'] self.custom_metadata_list = attributes[:'customMetadataList'] if attributes[:'customMetadataList'] raise 'You cannot provide both :customMetadataList and :custom_metadata_list' if attributes.key?(:'customMetadataList') && attributes.key?(:'custom_metadata_list') self.custom_metadata_list = attributes[:'custom_metadata_list'] if attributes[:'custom_metadata_list'] self.defined_metadata_list = attributes[:'definedMetadataList'] if attributes[:'definedMetadataList'] raise 'You cannot provide both :definedMetadataList and :defined_metadata_list' if attributes.key?(:'definedMetadataList') && attributes.key?(:'defined_metadata_list') self.defined_metadata_list = attributes[:'defined_metadata_list'] if attributes[:'defined_metadata_list'] self.input_schema = attributes[:'inputSchema'] if attributes[:'inputSchema'] raise 'You cannot provide both :inputSchema and :input_schema' if attributes.key?(:'inputSchema') && attributes.key?(:'input_schema') self.input_schema = attributes[:'input_schema'] if attributes[:'input_schema'] self.output_schema = attributes[:'outputSchema'] if attributes[:'outputSchema'] raise 'You cannot provide both :outputSchema and :output_schema' if attributes.key?(:'outputSchema') && attributes.key?(:'output_schema') self.output_schema = attributes[:'output_schema'] if attributes[:'output_schema'] end
Attribute type mapping.
# File lib/oci/data_science/models/model.rb, line 104 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'compartment_id': :'String', 'project_id': :'String', 'display_name': :'String', 'description': :'String', 'lifecycle_state': :'String', 'time_created': :'DateTime', 'created_by': :'String', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'custom_metadata_list': :'Array<OCI::DataScience::Models::Metadata>', 'defined_metadata_list': :'Array<OCI::DataScience::Models::Metadata>', 'input_schema': :'String', 'output_schema': :'String' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/data_science/models/model.rb, line 248 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && compartment_id == other.compartment_id && project_id == other.project_id && display_name == other.display_name && description == other.description && lifecycle_state == other.lifecycle_state && time_created == other.time_created && created_by == other.created_by && freeform_tags == other.freeform_tags && defined_tags == other.defined_tags && custom_metadata_list == other.custom_metadata_list && defined_metadata_list == other.defined_metadata_list && input_schema == other.input_schema && output_schema == other.output_schema end
Builds the object from hash @param [Hash] attributes Model
attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/data_science/models/model.rb, line 291 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/data_science/models/model.rb, line 271 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/data_science/models/model.rb, line 280 def hash [id, compartment_id, project_id, display_name, description, lifecycle_state, time_created, created_by, freeform_tags, defined_tags, custom_metadata_list, defined_metadata_list, input_schema, output_schema].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] lifecycle_state
Object
to be assigned
# File lib/oci/data_science/models/model.rb, line 232 def lifecycle_state=(lifecycle_state) # rubocop:disable Style/ConditionalAssignment if lifecycle_state && !LIFECYCLE_STATE_ENUM.include?(lifecycle_state) OCI.logger.debug("Unknown value for 'lifecycle_state' [" + lifecycle_state + "]. Mapping to 'LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE'") if OCI.logger @lifecycle_state = LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE else @lifecycle_state = lifecycle_state end # rubocop:enable Style/ConditionalAssignment end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/data_science/models/model.rb, line 324 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/data_science/models/model.rb, line 318 def to_s to_hash.to_s end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/data_science/models/model.rb, line 341 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end