Class: OCI::CapacityManagement::Models::OccAvailabilityCatalogSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/capacity_management/models/occ_availability_catalog_summary.rb

Overview

A catalog containing resource availability details for a customer.

Constant Summary collapse

NAMESPACE_ENUM = 
[
  NAMESPACE_COMPUTE = 'COMPUTE'.freeze,
  NAMESPACE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OccAvailabilityCatalogSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :namespace (String) —

    The value to assign to the #namespace property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :occ_customer_group_id (String) —

    The value to assign to the #occ_customer_group_id property

  • :catalog_state (String) —

    The value to assign to the #catalog_state property

  • :metadata_details (OCI::CapacityManagement::Models::MetadataDetails) —

    The value to assign to the #metadata_details property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

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



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
232
233
234
 
# File 'lib/oci/capacity_management/models/occ_availability_catalog_summary.rb', line 151

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

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

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

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

  self.catalog_state = attributes[:'catalogState'] if attributes[:'catalogState']

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

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

  self.metadata_details = attributes[:'metadataDetails'] if attributes[:'metadataDetails']

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

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

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

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

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

  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']

  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

#catalog_state ⇒ String

[Required] Represents whether this version of the availability catalog has been made available to the customer. The state is No by default.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/capacity_management/models/occ_availability_catalog_summary.rb', line 44

def catalog_state
  @catalog_state
end

#compartment_id ⇒ String

[Required] The OCID of the tenancy where the availability catalog resides.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/capacity_management/models/occ_availability_catalog_summary.rb', line 28

def compartment_id
  @compartment_id
end

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

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

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


76
77
78
 
# File 'lib/oci/capacity_management/models/occ_availability_catalog_summary.rb', line 76

def defined_tags
  @defined_tags
end

#description ⇒ String

Text information about the availability catalog.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/capacity_management/models/occ_availability_catalog_summary.rb', line 36

def description
  @description
end

#display_name ⇒ String

[Required] An user-friendly name for the availability catalog. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/capacity_management/models/occ_availability_catalog_summary.rb', line 32

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


70
71
72
 
# File 'lib/oci/capacity_management/models/occ_availability_catalog_summary.rb', line 70

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the availability catalog.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/capacity_management/models/occ_availability_catalog_summary.rb', line 19

def id
  @id
end

#lifecycle_details ⇒ String

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in a Failed State.

Returns:

  • (String) 


64
65
66
 
# File 'lib/oci/capacity_management/models/occ_availability_catalog_summary.rb', line 64

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current lifecycle state of the customer group.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/capacity_management/models/occ_availability_catalog_summary.rb', line 60

def lifecycle_state
  @lifecycle_state
end

#metadata_details ⇒ OCI::CapacityManagement::Models::MetadataDetails

This attribute is required.

Returns:



48
49
50
 
# File 'lib/oci/capacity_management/models/occ_availability_catalog_summary.rb', line 48

def metadata_details
  @metadata_details
end

#namespace ⇒ String

[Required] The name of the OCI service in consideration. For example, Compute, Exadata, and so on.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/capacity_management/models/occ_availability_catalog_summary.rb', line 24

def namespace
  @namespace
end

#occ_customer_group_id ⇒ String

[Required] The Customer Group OCID to which the availability catalog belongs.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/capacity_management/models/occ_availability_catalog_summary.rb', line 40

def occ_customer_group_id
  @occ_customer_group_id
end

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

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

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


82
83
84
 
# File 'lib/oci/capacity_management/models/occ_availability_catalog_summary.rb', line 82

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The time when the availability catalog was created.

Returns:

  • (DateTime) 


52
53
54
 
# File 'lib/oci/capacity_management/models/occ_availability_catalog_summary.rb', line 52

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The time when the availability catalog was last updated.

Returns:

  • (DateTime) 


56
57
58
 
# File 'lib/oci/capacity_management/models/occ_availability_catalog_summary.rb', line 56

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'namespace': :'namespace',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'occ_customer_group_id': :'occCustomerGroupId',
    'catalog_state': :'catalogState',
    'metadata_details': :'metadataDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'namespace': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'occ_customer_group_id': :'String',
    'catalog_state': :'String',
    'metadata_details': :'OCI::CapacityManagement::Models::MetadataDetails',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'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



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/oci/capacity_management/models/occ_availability_catalog_summary.rb', line 256

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

  self.class == other.class &&
    id == other.id &&
    namespace == other.namespace &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    description == other.description &&
    occ_customer_group_id == other.occ_customer_group_id &&
    catalog_state == other.catalog_state &&
    metadata_details == other.metadata_details &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    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



300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/oci/capacity_management/models/occ_availability_catalog_summary.rb', line 300

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


280
281
282
 
# File 'lib/oci/capacity_management/models/occ_availability_catalog_summary.rb', line 280

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



289
290
291
 
# File 'lib/oci/capacity_management/models/occ_availability_catalog_summary.rb', line 289

def hash
  [id, namespace, compartment_id, display_name, description, occ_customer_group_id, catalog_state, metadata_details, time_created, time_updated, lifecycle_state, lifecycle_details, 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



333
334
335
336
337
338
339
340
341
342
 
# File 'lib/oci/capacity_management/models/occ_availability_catalog_summary.rb', line 333

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



327
328
329
 
# File 'lib/oci/capacity_management/models/occ_availability_catalog_summary.rb', line 327

def to_s
  to_hash.to_s
end