Class: OCI::DataScience::Models::ModelDeploymentModelStateSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_science/models/model_deployment_model_state_summary.rb

Overview

Status of the model in a model group deployment.

Constant Summary collapse

STATE_ENUM = 
[
  STATE_SUCCESS = 'SUCCESS'.freeze,
  STATE_FAILED = 'FAILED'.freeze,
  STATE_INCONSISTENT = 'INCONSISTENT'.freeze,
  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 = {}) ⇒ ModelDeploymentModelStateSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :model_id (String) —

    The value to assign to the #model_id property

  • :project_id (String) —

    The value to assign to the #project_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :inference_key (String) —

    The value to assign to the #inference_key property

  • :state (String) —

    The value to assign to the #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

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

    The value to assign to the #system_tags property



103
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
 
# File 'lib/oci/data_science/models/model_deployment_model_state_summary.rb', line 103

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

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

  self.model_id = attributes[:'model_id'] if attributes[:'model_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.inference_key = attributes[:'inferenceKey'] if attributes[:'inferenceKey']

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

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

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

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

Instance Attribute Details

#defined_tags ⇒ Hash<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>>) 


49
50
51
 
# File 'lib/oci/data_science/models/model_deployment_model_state_summary.rb', line 49

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] A user-friendly display name for the resource.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/data_science/models/model_deployment_model_state_summary.rb', line 29

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<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>) 


43
44
45
 
# File 'lib/oci/data_science/models/model_deployment_model_state_summary.rb', line 43

def freeform_tags
  @freeform_tags
end

#inference_key ⇒ String

[Required] SaaS friendly name for the model OCID.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/data_science/models/model_deployment_model_state_summary.rb', line 33

def inference_key
  @inference_key
end

#model_id ⇒ String

[Required] The OCID of the deployed model in model deployment.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/data_science/models/model_deployment_model_state_summary.rb', line 21

def model_id
  @model_id
end

#project_id ⇒ String

[Required] The OCID of the project associated with the model.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/data_science/models/model_deployment_model_state_summary.rb', line 25

def project_id
  @project_id
end

#state ⇒ String

[Required] The state of the deployed model in model deployment.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/data_science/models/model_deployment_model_state_summary.rb', line 37

def state
  @state
end

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

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


55
56
57
 
# File 'lib/oci/data_science/models/model_deployment_model_state_summary.rb', line 55

def system_tags
  @system_tags
end

Class Method Details

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/oci/data_science/models/model_deployment_model_state_summary.rb', line 58

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'model_id': :'modelId',
    'project_id': :'projectId',
    'display_name': :'displayName',
    'inference_key': :'inferenceKey',
    'state': :'state',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/oci/data_science/models/model_deployment_model_state_summary.rb', line 74

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'model_id': :'String',
    'project_id': :'String',
    'display_name': :'String',
    'inference_key': :'String',
    'state': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_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



174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/oci/data_science/models/model_deployment_model_state_summary.rb', line 174

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

  self.class == other.class &&
    model_id == other.model_id &&
    project_id == other.project_id &&
    display_name == other.display_name &&
    inference_key == other.inference_key &&
    state == other.state &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/oci/data_science/models/model_deployment_model_state_summary.rb', line 211

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


191
192
193
 
# File 'lib/oci/data_science/models/model_deployment_model_state_summary.rb', line 191

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



200
201
202
 
# File 'lib/oci/data_science/models/model_deployment_model_state_summary.rb', line 200

def hash
  [model_id, project_id, display_name, inference_key, state, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



244
245
246
247
248
249
250
251
252
253
 
# File 'lib/oci/data_science/models/model_deployment_model_state_summary.rb', line 244

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



238
239
240
 
# File 'lib/oci/data_science/models/model_deployment_model_state_summary.rb', line 238

def to_s
  to_hash.to_s
end