Class: OCI::DataScience::Models::ContainerSummary

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

Overview

Summary representation of a container

Constant Summary collapse

TARGET_WORKLOADS_ENUM = 
[
  TARGET_WORKLOADS_MODEL_DEPLOYMENT = 'MODEL_DEPLOYMENT'.freeze,
  TARGET_WORKLOADS_JOB_RUN = 'JOB_RUN'.freeze,
  TARGET_WORKLOADS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
USAGES_ENUM = 
[
  USAGES_INFERENCE = 'INFERENCE'.freeze,
  USAGES_FINE_TUNE = 'FINE_TUNE'.freeze,
  USAGES_EVALUATION = 'EVALUATION'.freeze,
  USAGES_BATCH_INFERENCE = 'BATCH_INFERENCE'.freeze,
  USAGES_OTHER = 'OTHER'.freeze,
  USAGES_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.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 = {}) ⇒ ContainerSummary

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
 
# File 'lib/oci/data_science/models/container_summary.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.container_name = attributes[:'containerName'] if attributes[:'containerName']

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

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

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

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

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

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

  self.is_latest = attributes[:'isLatest'] unless attributes[:'isLatest'].nil?
  self.is_latest = false if is_latest.nil? && !attributes.key?(:'isLatest') # rubocop:disable Style/StringLiterals

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

  self.is_latest = attributes[:'is_latest'] unless attributes[:'is_latest'].nil?
  self.is_latest = false if is_latest.nil? && !attributes.key?(:'isLatest') && !attributes.key?(:'is_latest') # rubocop:disable Style/StringLiterals

  self.target_workloads = attributes[:'targetWorkloads'] if attributes[:'targetWorkloads']

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

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

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

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

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

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

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

  self.tag_configuration_list = attributes[:'tagConfigurationList'] if attributes[:'tagConfigurationList']

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

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

  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

#container_name ⇒ String

[Required] The name of the container. This can be same for different tags

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/data_science/models/container_summary.rb', line 35

def container_name
  @container_name
end

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


87
88
89
 
# File 'lib/oci/data_science/models/container_summary.rb', line 87

def defined_tags
  @defined_tags
end

#description ⇒ String

Description of the container.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/data_science/models/container_summary.rb', line 47

def description
  @description
end

#display_name ⇒ String

The display name of the container.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/data_science/models/container_summary.rb', line 39

def display_name
  @display_name
end

#family_name ⇒ String

The family name of the container.

Returns:

  • (String) 


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

def family_name
  @family_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>) 


81
82
83
 
# File 'lib/oci/data_science/models/container_summary.rb', line 81

def freeform_tags
  @freeform_tags
end

#is_latest ⇒ BOOLEAN

[Required] The latest tag of the container.

Returns:

  • (BOOLEAN) 


51
52
53
 
# File 'lib/oci/data_science/models/container_summary.rb', line 51

def is_latest
  @is_latest
end

#lifecycle_state ⇒ String

[Required] Container Version LifecycleState.

Returns:

  • (String) 


67
68
69
 
# File 'lib/oci/data_science/models/container_summary.rb', line 67

def lifecycle_state
  @lifecycle_state
end

#tag ⇒ String

[Required] Container Tag.

Returns:

  • (String) 


63
64
65
 
# File 'lib/oci/data_science/models/container_summary.rb', line 63

def tag
  @tag
end

#tag_configuration_list ⇒ Array<OCI::DataScience::Models::TagConfiguration>

An array of defined metadata details for the model.

Returns:



75
76
77
 
# File 'lib/oci/data_science/models/container_summary.rb', line 75

def tag_configuration_list
  @tag_configuration_list
end

#target_workloads ⇒ Array<String>

The list of target workload. This Container can be used with given data science resources.

Returns:

  • (Array<String>) 


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

def target_workloads
  @target_workloads
end

#usages ⇒ Array<String>

The list of usages of this container. This Container can be used for given use-cases.

Returns:

  • (Array<String>) 


59
60
61
 
# File 'lib/oci/data_science/models/container_summary.rb', line 59

def usages
  @usages
end

#workload_configuration_details_list ⇒ Array<OCI::DataScience::Models::WorkloadConfigurationDetails>

workload configuration of the container.

Returns:



71
72
73
 
# File 'lib/oci/data_science/models/container_summary.rb', line 71

def workload_configuration_details_list
  @workload_configuration_details_list
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'container_name': :'containerName',
    'display_name': :'displayName',
    'family_name': :'familyName',
    'description': :'description',
    'is_latest': :'isLatest',
    'target_workloads': :'targetWorkloads',
    'usages': :'usages',
    'tag': :'tag',
    'lifecycle_state': :'lifecycleState',
    'workload_configuration_details_list': :'workloadConfigurationDetailsList',
    'tag_configuration_list': :'tagConfigurationList',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'container_name': :'String',
    'display_name': :'String',
    'family_name': :'String',
    'description': :'String',
    'is_latest': :'BOOLEAN',
    'target_workloads': :'Array<String>',
    'usages': :'Array<String>',
    'tag': :'String',
    'lifecycle_state': :'String',
    'workload_configuration_details_list': :'Array<OCI::DataScience::Models::WorkloadConfigurationDetails>',
    'tag_configuration_list': :'Array<OCI::DataScience::Models::TagConfiguration>',
    '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



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/oci/data_science/models/container_summary.rb', line 285

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

  self.class == other.class &&
    container_name == other.container_name &&
    display_name == other.display_name &&
    family_name == other.family_name &&
    description == other.description &&
    is_latest == other.is_latest &&
    target_workloads == other.target_workloads &&
    usages == other.usages &&
    tag == other.tag &&
    lifecycle_state == other.lifecycle_state &&
    workload_configuration_details_list == other.workload_configuration_details_list &&
    tag_configuration_list == other.tag_configuration_list &&
    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



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/oci/data_science/models/container_summary.rb', line 327

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


307
308
309
 
# File 'lib/oci/data_science/models/container_summary.rb', line 307

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



316
317
318
 
# File 'lib/oci/data_science/models/container_summary.rb', line 316

def hash
  [container_name, display_name, family_name, description, is_latest, target_workloads, usages, tag, lifecycle_state, workload_configuration_details_list, tag_configuration_list, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



360
361
362
363
364
365
366
367
368
369
 
# File 'lib/oci/data_science/models/container_summary.rb', line 360

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



354
355
356
 
# File 'lib/oci/data_science/models/container_summary.rb', line 354

def to_s
  to_hash.to_s
end