Class: OCI::CapacityManagement::Models::CreateOccCapacityRequestDetails

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

Overview

Details about the create request for the capacity request.

Constant Summary collapse

NAMESPACE_ENUM = 
[
  NAMESPACE_COMPUTE = 'COMPUTE'.freeze
].freeze
REQUEST_STATE_ENUM = 
[
  REQUEST_STATE_CREATED = 'CREATED'.freeze,
  REQUEST_STATE_SUBMITTED = 'SUBMITTED'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateOccCapacityRequestDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



138
139
140
141
142
143
144
145
146
147
148
149
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
 
# File 'lib/oci/capacity_management/models/create_occ_capacity_request_details.rb', line 138

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

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

  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.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.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.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']
  self.request_state = "CREATED" if request_state.nil? && !attributes.key?(:'requestState') # rubocop:disable Style/StringLiterals

  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.request_state = "CREATED" if request_state.nil? && !attributes.key?(:'requestState') && !attributes.key?(:'request_state') # rubocop:disable Style/StringLiterals

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

Instance Attribute Details

#availability_domain ⇒ String

[Required] The availability domain (AD) for which the capacity request is made. If this is specified then the capacity will be validated and fulfilled within the scope of this AD.

Returns:

  • (String) 


63
64
65
 
# File 'lib/oci/capacity_management/models/create_occ_capacity_request_details.rb', line 63

def availability_domain
  @availability_domain
end

#compartment_id ⇒ String

[Required] Since all resources are at tenancy level hence this will be the ocid of the tenancy where operation is to be performed.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/capacity_management/models/create_occ_capacity_request_details.rb', line 23

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) 


67
68
69
 
# File 'lib/oci/capacity_management/models/create_occ_capacity_request_details.rb', line 67

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


55
56
57
 
# File 'lib/oci/capacity_management/models/create_occ_capacity_request_details.rb', line 55

def defined_tags
  @defined_tags
end

#description ⇒ String

Meaningful text about the capacity request.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/capacity_management/models/create_occ_capacity_request_details.rb', line 43

def description
  @description
end

#details ⇒ Array<OCI::CapacityManagement::Models::OccCapacityRequestBaseDetails>

[Required] A list of different resources requested by the user.

Returns:



75
76
77
 
# File 'lib/oci/capacity_management/models/create_occ_capacity_request_details.rb', line 75

def details
  @details
end

#display_name ⇒ String

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

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/capacity_management/models/create_occ_capacity_request_details.rb', line 39

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


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

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


59
60
61
 
# File 'lib/oci/capacity_management/models/create_occ_capacity_request_details.rb', line 59

def lifecycle_details
  @lifecycle_details
end

#namespace ⇒ String

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

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/capacity_management/models/create_occ_capacity_request_details.rb', line 31

def namespace
  @namespace
end

#occ_availability_catalog_id ⇒ String

[Required] The OCID of the availability catalog against which capacity request is made.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/capacity_management/models/create_occ_capacity_request_details.rb', line 27

def occ_availability_catalog_id
  @occ_availability_catalog_id
end

#region ⇒ String

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

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/capacity_management/models/create_occ_capacity_request_details.rb', line 35

def region
  @region
end

#request_state ⇒ String

The subset of request states available for creating the capacity request.

Returns:

  • (String) 


71
72
73
 
# File 'lib/oci/capacity_management/models/create_occ_capacity_request_details.rb', line 71

def request_state
  @request_state
end

Class Method Details

.attribute_map ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/oci/capacity_management/models/create_occ_capacity_request_details.rb', line 78

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'occ_availability_catalog_id': :'occAvailabilityCatalogId',
    'namespace': :'namespace',
    'region': :'region',
    'display_name': :'displayName',
    'description': :'description',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'lifecycle_details': :'lifecycleDetails',
    'availability_domain': :'availabilityDomain',
    'date_expected_capacity_handover': :'dateExpectedCapacityHandover',
    'request_state': :'requestState',
    'details': :'details'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'occ_availability_catalog_id': :'String',
    'namespace': :'String',
    'region': :'String',
    'display_name': :'String',
    'description': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'lifecycle_details': :'String',
    'availability_domain': :'String',
    'date_expected_capacity_handover': :'DateTime',
    'request_state': :'String',
    'details': :'Array<OCI::CapacityManagement::Models::OccCapacityRequestBaseDetails>'
    # 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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/oci/capacity_management/models/create_occ_capacity_request_details.rb', line 232

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    occ_availability_catalog_id == other.occ_availability_catalog_id &&
    namespace == other.namespace &&
    region == other.region &&
    display_name == other.display_name &&
    description == other.description &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    lifecycle_details == other.lifecycle_details &&
    availability_domain == other.availability_domain &&
    date_expected_capacity_handover == other.date_expected_capacity_handover &&
    request_state == other.request_state &&
    details == other.details
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



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/oci/capacity_management/models/create_occ_capacity_request_details.rb', line 274

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


254
255
256
 
# File 'lib/oci/capacity_management/models/create_occ_capacity_request_details.rb', line 254

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



263
264
265
 
# File 'lib/oci/capacity_management/models/create_occ_capacity_request_details.rb', line 263

def hash
  [compartment_id, occ_availability_catalog_id, namespace, region, display_name, description, freeform_tags, defined_tags, lifecycle_details, availability_domain, date_expected_capacity_handover, request_state, details].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



307
308
309
310
311
312
313
314
315
316
 
# File 'lib/oci/capacity_management/models/create_occ_capacity_request_details.rb', line 307

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



301
302
303
 
# File 'lib/oci/capacity_management/models/create_occ_capacity_request_details.rb', line 301

def to_s
  to_hash.to_s
end