Class: OCI::CapacityManagement::Models::OccCapacityRequestSummary

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

Overview

A summary model for the capacity request model.

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 = {}) ⇒ OccCapacityRequestSummary

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

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :occ_availability_catalog_id (String) —

    The value to assign to the #occ_availability_catalog_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :namespace (String) —

    The value to assign to the #namespace property

  • :occ_customer_group_id (String) —

    The value to assign to the #occ_customer_group_id property

  • :region (String) —

    The value to assign to the #region property

  • :availability_domain (String) —

    The value to assign to the #availability_domain property

  • :date_expected_capacity_handover (DateTime) —

    The value to assign to the #date_expected_capacity_handover property

  • :request_state (String) —

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



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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/oci/capacity_management/models/occ_capacity_request_summary.rb', line 173

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

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

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

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

  self.availability_domain = attributes[:'availabilityDomain'] if attributes[:'availabilityDomain']

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

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

  self.date_expected_capacity_handover = attributes[:'dateExpectedCapacityHandover'] if attributes[:'dateExpectedCapacityHandover']

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

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

  self.request_state = attributes[:'requestState'] if attributes[:'requestState']

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

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

  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

#availability_domain ⇒ String

[Required] The availability domain (AD) for which the capacity request was made.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/capacity_management/models/occ_capacity_request_summary.rb', line 53

def availability_domain
  @availability_domain
end

#compartment_id ⇒ String

[Required] The OCID of the tenancy from which the request was made.

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#date_expected_capacity_handover ⇒ DateTime

[Required] The date by which the capacity requested by customers before dateFinalCustomerOrder needs to be fulfilled.

Returns:

  • (DateTime) 


57
58
59
 
# File 'lib/oci/capacity_management/models/occ_capacity_request_summary.rb', line 57

def date_expected_capacity_handover
  @date_expected_capacity_handover
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>>) 


89
90
91
 
# File 'lib/oci/capacity_management/models/occ_capacity_request_summary.rb', line 89

def defined_tags
  @defined_tags
end

#description ⇒ String

Meaningful text about the capacity request.

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

[Required] The display name of the capacity request.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/capacity_management/models/occ_capacity_request_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>) 


83
84
85
 
# File 'lib/oci/capacity_management/models/occ_capacity_request_summary.rb', line 83

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the capacity request.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/capacity_management/models/occ_capacity_request_summary.rb', line 20

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) 


77
78
79
 
# File 'lib/oci/capacity_management/models/occ_capacity_request_summary.rb', line 77

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

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

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/capacity_management/models/occ_capacity_request_summary.rb', line 73

def lifecycle_state
  @lifecycle_state
end

#namespace ⇒ String

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

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/capacity_management/models/occ_capacity_request_summary.rb', line 41

def namespace
  @namespace
end

#occ_availability_catalog_id ⇒ String

[Required] The OCID of the availability catalog against which the capacity request was placed.

Returns:

  • (String) 


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

def occ_availability_catalog_id
  @occ_availability_catalog_id
end

#occ_customer_group_id ⇒ String

[Required] The OCID of the customer group to which this customer belongs to.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/capacity_management/models/occ_capacity_request_summary.rb', line 45

def occ_customer_group_id
  @occ_customer_group_id
end

#region ⇒ String

[Required] The name of the region for which the capacity request was made.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/capacity_management/models/occ_capacity_request_summary.rb', line 49

def region
  @region
end

#request_state ⇒ String

[Required] A list of states through which the capacity request goes by.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/capacity_management/models/occ_capacity_request_summary.rb', line 61

def request_state
  @request_state
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>>) 


95
96
97
 
# File 'lib/oci/capacity_management/models/occ_capacity_request_summary.rb', line 95

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The time when the capacity request was created.

Returns:

  • (DateTime) 


65
66
67
 
# File 'lib/oci/capacity_management/models/occ_capacity_request_summary.rb', line 65

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The time when the capacity request was updated.

Returns:

  • (DateTime) 


69
70
71
 
# File 'lib/oci/capacity_management/models/occ_capacity_request_summary.rb', line 69

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/oci/capacity_management/models/occ_capacity_request_summary.rb', line 98

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'occ_availability_catalog_id': :'occAvailabilityCatalogId',
    'display_name': :'displayName',
    'description': :'description',
    'namespace': :'namespace',
    'occ_customer_group_id': :'occCustomerGroupId',
    'region': :'region',
    'availability_domain': :'availabilityDomain',
    'date_expected_capacity_handover': :'dateExpectedCapacityHandover',
    'request_state': :'requestState',
    '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.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/oci/capacity_management/models/occ_capacity_request_summary.rb', line 124

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'occ_availability_catalog_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'namespace': :'String',
    'occ_customer_group_id': :'String',
    'region': :'String',
    'availability_domain': :'String',
    'date_expected_capacity_handover': :'DateTime',
    'request_state': :'String',
    '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



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
 
# File 'lib/oci/capacity_management/models/occ_capacity_request_summary.rb', line 292

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    occ_availability_catalog_id == other.occ_availability_catalog_id &&
    display_name == other.display_name &&
    description == other.description &&
    namespace == other.namespace &&
    occ_customer_group_id == other.occ_customer_group_id &&
    region == other.region &&
    availability_domain == other.availability_domain &&
    date_expected_capacity_handover == other.date_expected_capacity_handover &&
    request_state == other.request_state &&
    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



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/oci/capacity_management/models/occ_capacity_request_summary.rb', line 339

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


319
320
321
 
# File 'lib/oci/capacity_management/models/occ_capacity_request_summary.rb', line 319

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



328
329
330
 
# File 'lib/oci/capacity_management/models/occ_capacity_request_summary.rb', line 328

def hash
  [id, compartment_id, occ_availability_catalog_id, display_name, description, namespace, occ_customer_group_id, region, availability_domain, date_expected_capacity_handover, request_state, 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



372
373
374
375
376
377
378
379
380
381
 
# File 'lib/oci/capacity_management/models/occ_capacity_request_summary.rb', line 372

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



366
367
368
 
# File 'lib/oci/capacity_management/models/occ_capacity_request_summary.rb', line 366

def to_s
  to_hash.to_s
end