Class: OCI::DataScience::Models::CreateModelGroupDetails

Inherits:
CreateBaseModelGroupDetails show all
Defined in:
lib/oci/data_science/models/create_model_group_details.rb

Overview

Parameters needed to create a model group. Model Group is a group of models.

Constant Summary

Constants inherited from CreateBaseModelGroupDetails

OCI::DataScience::Models::CreateBaseModelGroupDetails::CREATE_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from CreateBaseModelGroupDetails

#compartment_id, #create_type, #project_id

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CreateBaseModelGroupDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CreateModelGroupDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
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
# File 'lib/oci/data_science/models/create_model_group_details.rb', line 104

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['createType'] = 'CREATE'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.model_group_details = attributes[:'modelGroupDetails'] if attributes[:'modelGroupDetails']

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

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

  self.member_model_entries = attributes[:'memberModelEntries'] if attributes[:'memberModelEntries']

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

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

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

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

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

  self.version_label = attributes[:'versionLabel'] if attributes[:'versionLabel']

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

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

  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

#defined_tagsHash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


48
49
50
# File 'lib/oci/data_science/models/create_model_group_details.rb', line 48

def defined_tags
  @defined_tags
end

#descriptionString

A short description of the modelGroup.

Returns:

  • (String)


28
29
30
# File 'lib/oci/data_science/models/create_model_group_details.rb', line 28

def description
  @description
end

#display_nameString

A user-friendly display name for the resource. It does not have to be unique and can be modified. Avoid entering confidential information. Example: My ModelGroup

Returns:

  • (String)


24
25
26
# File 'lib/oci/data_science/models/create_model_group_details.rb', line 24

def display_name
  @display_name
end

#freeform_tagsHash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>)


42
43
44
# File 'lib/oci/data_science/models/create_model_group_details.rb', line 42

def freeform_tags
  @freeform_tags
end

#member_model_entriesOCI::DataScience::Models::MemberModelEntries

This attribute is required.



18
19
20
# File 'lib/oci/data_science/models/create_model_group_details.rb', line 18

def member_model_entries
  @member_model_entries
end

#model_group_detailsOCI::DataScience::Models::ModelGroupDetails

This attribute is required.



14
15
16
# File 'lib/oci/data_science/models/create_model_group_details.rb', line 14

def model_group_details
  @model_group_details
end

#model_group_version_history_idString

The OCID of the model group version history to which the modelGroup is associated.

Returns:

  • (String)


32
33
34
# File 'lib/oci/data_science/models/create_model_group_details.rb', line 32

def model_group_version_history_id
  @model_group_version_history_id
end

#version_labelString

An additional description of the lifecycle state of the model group.

Returns:

  • (String)


36
37
38
# File 'lib/oci/data_science/models/create_model_group_details.rb', line 36

def version_label
  @version_label
end

Class Method Details

.attribute_mapObject

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



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# File 'lib/oci/data_science/models/create_model_group_details.rb', line 51

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'create_type': :'createType',
    'compartment_id': :'compartmentId',
    'project_id': :'projectId',
    'model_group_details': :'modelGroupDetails',
    'member_model_entries': :'memberModelEntries',
    'display_name': :'displayName',
    'description': :'description',
    'model_group_version_history_id': :'modelGroupVersionHistoryId',
    'version_label': :'versionLabel',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
# File 'lib/oci/data_science/models/create_model_group_details.rb', line 70

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'create_type': :'String',
    'compartment_id': :'String',
    'project_id': :'String',
    'model_group_details': :'OCI::DataScience::Models::ModelGroupDetails',
    'member_model_entries': :'OCI::DataScience::Models::MemberModelEntries',
    'display_name': :'String',
    'description': :'String',
    'model_group_version_history_id': :'String',
    'version_label': :'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



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
# File 'lib/oci/data_science/models/create_model_group_details.rb', line 166

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

  self.class == other.class &&
    create_type == other.create_type &&
    compartment_id == other.compartment_id &&
    project_id == other.project_id &&
    model_group_details == other.model_group_details &&
    member_model_entries == other.member_model_entries &&
    display_name == other.display_name &&
    description == other.description &&
    model_group_version_history_id == other.model_group_version_history_id &&
    version_label == other.version_label &&
    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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
# File 'lib/oci/data_science/models/create_model_group_details.rb', line 206

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


186
187
188
# File 'lib/oci/data_science/models/create_model_group_details.rb', line 186

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



195
196
197
# File 'lib/oci/data_science/models/create_model_group_details.rb', line 195

def hash
  [create_type, compartment_id, project_id, model_group_details, member_model_entries, display_name, description, model_group_version_history_id, version_label, freeform_tags, defined_tags].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



239
240
241
242
243
244
245
246
247
248
# File 'lib/oci/data_science/models/create_model_group_details.rb', line 239

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



233
234
235
# File 'lib/oci/data_science/models/create_model_group_details.rb', line 233

def to_s
  to_hash.to_s
end