Class: OCI::CapacityManagement::Models::OccmDemandSignalItem

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

Overview

An occm demand signal item is a resource that is used to communicate the forecasting need for a particular resource with OCI. It's a sub-resource and need to be grouped inside a demand signal.

Constant Summary collapse

DEMAND_SIGNAL_NAMESPACE_ENUM = 
[
  DEMAND_SIGNAL_NAMESPACE_COMPUTE = 'COMPUTE'.freeze,
  DEMAND_SIGNAL_NAMESPACE_NETWORK = 'NETWORK'.freeze,
  DEMAND_SIGNAL_NAMESPACE_GPU = 'GPU'.freeze,
  DEMAND_SIGNAL_NAMESPACE_STORAGE = 'STORAGE'.freeze,
  DEMAND_SIGNAL_NAMESPACE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
REQUEST_TYPE_ENUM = 
[
  REQUEST_TYPE_DEMAND = 'DEMAND'.freeze,
  REQUEST_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.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 = {}) ⇒ OccmDemandSignalItem

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

  • :demand_signal_id (String) —

    The value to assign to the #demand_signal_id property

  • :demand_signal_namespace (String) —

    The value to assign to the #demand_signal_namespace property

  • :demand_signal_catalog_resource_id (String) —

    The value to assign to the #demand_signal_catalog_resource_id property

  • :request_type (String) —

    The value to assign to the #request_type property

  • :resource_name (String) —

    The value to assign to the #resource_name property

  • :region (String) —

    The value to assign to the #region property

  • :availability_domain (String) —

    The value to assign to the #availability_domain property

  • :target_compartment_id (String) —

    The value to assign to the #target_compartment_id property

  • :demand_quantity (Integer) —

    The value to assign to the #demand_quantity property

  • :time_needed_before (DateTime) —

    The value to assign to the #time_needed_before property

  • :resource_properties (Hash<String, String>) —

    The value to assign to the #resource_properties property

  • :notes (String) —

    The value to assign to the #notes property

  • :lifecycle_state (String) —

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



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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_item.rb', line 206

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

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

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

  self.demand_signal_namespace = attributes[:'demandSignalNamespace'] if attributes[:'demandSignalNamespace']

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

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

  self.demand_signal_catalog_resource_id = attributes[:'demandSignalCatalogResourceId'] if attributes[:'demandSignalCatalogResourceId']

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

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

  self.request_type = attributes[:'requestType'] if attributes[:'requestType']

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

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

  self.resource_name = attributes[:'resourceName'] if attributes[:'resourceName']

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

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

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

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

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

  self.demand_quantity = attributes[:'demandQuantity'] if attributes[:'demandQuantity']

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

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

  self.time_needed_before = attributes[:'timeNeededBefore'] if attributes[:'timeNeededBefore']

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

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

  self.resource_properties = attributes[:'resourceProperties'] if attributes[:'resourceProperties']

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

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

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

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

The name of the availability domain for which you want to request the OCI resource.

Returns:

  • (String) 


79
80
81
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_item.rb', line 79

def availability_domain
  @availability_domain
end

#compartment_id ⇒ String

[Required] The OCID of the tenancy from which the demand signal item was created.

Returns:

  • (String) 


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

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


122
123
124
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_item.rb', line 122

def defined_tags
  @defined_tags
end

#demand_quantity ⇒ Integer

[Required] The quantity of the resource that you want to demand from OCI.

Returns:

  • (Integer) 


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

def demand_quantity
  @demand_quantity
end

#demand_signal_catalog_resource_id ⇒ String

[Required] The OCID of the corresponding demand signal catalog resource.

Returns:

  • (String) 


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

def demand_signal_catalog_resource_id
  @demand_signal_catalog_resource_id
end

#demand_signal_id ⇒ String

[Required] The OCID of the demand signal under which this item will be grouped.

Returns:

  • (String) 


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

def demand_signal_id
  @demand_signal_id
end

#demand_signal_namespace ⇒ String

[Required] The name of the OCI service in consideration for demand signal submission. For example: COMPUTE, NETWORK, GPU etc.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_item.rb', line 54

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


116
117
118
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_item.rb', line 116

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the demand signal item.

Returns:

  • (String) 


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

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current lifecycle state of the resource.

Returns:

  • (String) 


110
111
112
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_item.rb', line 110

def lifecycle_state
  @lifecycle_state
end

#notes ⇒ String

This field will serve as notes section for you. You can use this section to convey a message to OCI regarding your resource request.

NOTE: The previous value gets overwritten with the new one for this once updated.

Returns:

  • (String) 


106
107
108
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_item.rb', line 106

def notes
  @notes
end

#region ⇒ String

[Required] The name of region for which you want to request the OCI resource.

Returns:

  • (String) 


74
75
76
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_item.rb', line 74

def region
  @region
end

#request_type ⇒ String

[Required] The type of request (DEMAND or RETURN) made against a particular demand signal item.

Returns:

  • (String) 


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

def request_type
  @request_type
end

#resource_name ⇒ String

[Required] The name of the OCI resource that you want to request.

Returns:

  • (String) 


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

def resource_name
  @resource_name
end

#resource_properties ⇒ Hash<String, String>

[Required] A map of various properties associated with the OCI resource.

Returns:

  • (Hash<String, String>) 


99
100
101
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_item.rb', line 99

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


128
129
130
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_item.rb', line 128

def system_tags
  @system_tags
end

#target_compartment_id ⇒ String

The OCID of the tenancy for which you want to request the OCI resource for. This is an optional parameter.

Returns:

  • (String) 


84
85
86
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_item.rb', line 84

def target_compartment_id
  @target_compartment_id
end

#time_needed_before ⇒ DateTime

[Required] the date before which you would ideally like the OCI resource to be delivered to you.

Returns:

  • (DateTime) 


94
95
96
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_item.rb', line 94

def time_needed_before
  @time_needed_before
end

Class Method Details

.attribute_map ⇒ Object

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



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_item.rb', line 131

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'demand_signal_id': :'demandSignalId',
    'demand_signal_namespace': :'demandSignalNamespace',
    'demand_signal_catalog_resource_id': :'demandSignalCatalogResourceId',
    'request_type': :'requestType',
    'resource_name': :'resourceName',
    'region': :'region',
    'availability_domain': :'availabilityDomain',
    'target_compartment_id': :'targetCompartmentId',
    'demand_quantity': :'demandQuantity',
    'time_needed_before': :'timeNeededBefore',
    'resource_properties': :'resourceProperties',
    'notes': :'notes',
    'lifecycle_state': :'lifecycleState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_item.rb', line 157

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'demand_signal_id': :'String',
    'demand_signal_namespace': :'String',
    'demand_signal_catalog_resource_id': :'String',
    'request_type': :'String',
    'resource_name': :'String',
    'region': :'String',
    'availability_domain': :'String',
    'target_compartment_id': :'String',
    'demand_quantity': :'Integer',
    'time_needed_before': :'DateTime',
    'resource_properties': :'Hash<String, String>',
    'notes': :'String',
    'lifecycle_state': :'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



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_item.rb', line 355

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    demand_signal_id == other.demand_signal_id &&
    demand_signal_namespace == other.demand_signal_namespace &&
    demand_signal_catalog_resource_id == other.demand_signal_catalog_resource_id &&
    request_type == other.request_type &&
    resource_name == other.resource_name &&
    region == other.region &&
    availability_domain == other.availability_domain &&
    target_compartment_id == other.target_compartment_id &&
    demand_quantity == other.demand_quantity &&
    time_needed_before == other.time_needed_before &&
    resource_properties == other.resource_properties &&
    notes == other.notes &&
    lifecycle_state == other.lifecycle_state &&
    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



402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_item.rb', line 402

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


382
383
384
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_item.rb', line 382

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



391
392
393
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_item.rb', line 391

def hash
  [id, compartment_id, demand_signal_id, demand_signal_namespace, demand_signal_catalog_resource_id, request_type, resource_name, region, availability_domain, target_compartment_id, demand_quantity, time_needed_before, resource_properties, notes, lifecycle_state, 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



435
436
437
438
439
440
441
442
443
444
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_item.rb', line 435

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



429
430
431
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_item.rb', line 429

def to_s
  to_hash.to_s
end