Class: OCI::DataScience::Models::ModelDeployment

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

Overview

Model deployments are interactive coding environments for data scientists.

Constant Summary collapse

LIFECYCLE_STATE_ENUM =
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.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 = {}) ⇒ ModelDeployment

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
# File 'lib/oci/data_science/models/model_deployment.rb', line 150

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

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

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

  self.category_log_details = attributes[:'categoryLogDetails'] if attributes[:'categoryLogDetails']

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

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

  self.model_deployment_url = attributes[:'modelDeploymentUrl'] if attributes[:'modelDeploymentUrl']

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

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

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

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

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

  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

#category_log_detailsOCI::DataScience::Models::CategoryLogDetails



60
61
62
# File 'lib/oci/data_science/models/model_deployment.rb', line 60

def category_log_details
  @category_log_details
end

#compartment_idString

[Required] The OCID of the model deployment's compartment.

Returns:

  • (String)


54
55
56
# File 'lib/oci/data_science/models/model_deployment.rb', line 54

def compartment_id
  @compartment_id
end

#created_byString

[Required] The OCID of the user who created the model deployment.

Returns:

  • (String)


50
51
52
# File 'lib/oci/data_science/models/model_deployment.rb', line 50

def created_by
  @created_by
end

#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>>)


84
85
86
# File 'lib/oci/data_science/models/model_deployment.rb', line 84

def defined_tags
  @defined_tags
end

#descriptionString

A short description of the model deployment.

Returns:

  • (String)


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

def description
  @description
end

#display_nameString

[Required] A user-friendly display name for the resource. Does not have to be unique, and can be modified. Avoid entering confidential information. Example: My ModelDeployment

Returns:

  • (String)


38
39
40
# File 'lib/oci/data_science/models/model_deployment.rb', line 38

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>)


78
79
80
# File 'lib/oci/data_science/models/model_deployment.rb', line 78

def freeform_tags
  @freeform_tags
end

#idString

[Required] The OCID of the model deployment.

Returns:

  • (String)


26
27
28
# File 'lib/oci/data_science/models/model_deployment.rb', line 26

def id
  @id
end

#lifecycle_detailsString

Details about the state of the model deployment.

Returns:

  • (String)


72
73
74
# File 'lib/oci/data_science/models/model_deployment.rb', line 72

def lifecycle_details
  @lifecycle_details
end

#lifecycle_stateString

[Required] The state of the model deployment.

Returns:

  • (String)


68
69
70
# File 'lib/oci/data_science/models/model_deployment.rb', line 68

def lifecycle_state
  @lifecycle_state
end

#model_deployment_configuration_detailsOCI::DataScience::Models::ModelDeploymentConfigurationDetails



57
58
59
# File 'lib/oci/data_science/models/model_deployment.rb', line 57

def model_deployment_configuration_details
  @model_deployment_configuration_details
end

#model_deployment_urlString

[Required] The URL to interact with the model deployment.

Returns:

  • (String)


64
65
66
# File 'lib/oci/data_science/models/model_deployment.rb', line 64

def model_deployment_url
  @model_deployment_url
end

#project_idString

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

Returns:

  • (String)


46
47
48
# File 'lib/oci/data_science/models/model_deployment.rb', line 46

def project_id
  @project_id
end

#time_createdDateTime

[Required] The date and time the resource was created, in the timestamp format defined by RFC3339. Example: 2019-08-25T21:10:29.41Z

Returns:

  • (DateTime)


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

def time_created
  @time_created
end

Class Method Details

.attribute_mapObject

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



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
# File 'lib/oci/data_science/models/model_deployment.rb', line 87

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'time_created': :'timeCreated',
    'display_name': :'displayName',
    'description': :'description',
    'project_id': :'projectId',
    'created_by': :'createdBy',
    'compartment_id': :'compartmentId',
    'model_deployment_configuration_details': :'modelDeploymentConfigurationDetails',
    'category_log_details': :'categoryLogDetails',
    'model_deployment_url': :'modelDeploymentUrl',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
# File 'lib/oci/data_science/models/model_deployment.rb', line 109

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'time_created': :'DateTime',
    'display_name': :'String',
    'description': :'String',
    'project_id': :'String',
    'created_by': :'String',
    'compartment_id': :'String',
    'model_deployment_configuration_details': :'OCI::DataScience::Models::ModelDeploymentConfigurationDetails',
    'category_log_details': :'OCI::DataScience::Models::CategoryLogDetails',
    'model_deployment_url': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'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



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
# File 'lib/oci/data_science/models/model_deployment.rb', line 253

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

  self.class == other.class &&
    id == other.id &&
    time_created == other.time_created &&
    display_name == other.display_name &&
    description == other.description &&
    project_id == other.project_id &&
    created_by == other.created_by &&
    compartment_id == other.compartment_id &&
    model_deployment_configuration_details == other.model_deployment_configuration_details &&
    category_log_details == other.category_log_details &&
    model_deployment_url == other.model_deployment_url &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    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



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
# File 'lib/oci/data_science/models/model_deployment.rb', line 296

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


276
277
278
# File 'lib/oci/data_science/models/model_deployment.rb', line 276

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



285
286
287
# File 'lib/oci/data_science/models/model_deployment.rb', line 285

def hash
  [id, time_created, display_name, description, project_id, created_by, compartment_id, model_deployment_configuration_details, category_log_details, model_deployment_url, lifecycle_state, lifecycle_details, 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



329
330
331
332
333
334
335
336
337
338
# File 'lib/oci/data_science/models/model_deployment.rb', line 329

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



323
324
325
# File 'lib/oci/data_science/models/model_deployment.rb', line 323

def to_s
  to_hash.to_s
end