Class: OCI::CapacityManagement::Models::OccmDemandSignalDeliverySummary

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

Overview

A summary model containing information about the demand signal delivery resources.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_DETAILS_ENUM = 
[
  LIFECYCLE_DETAILS_ACCEPTED = 'ACCEPTED'.freeze,
  LIFECYCLE_DETAILS_DECLINED = 'DECLINED'.freeze,
  LIFECYCLE_DETAILS_DELIVERED = 'DELIVERED'.freeze,
  LIFECYCLE_DETAILS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OccmDemandSignalDeliverySummary

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_item_id (String) —

    The value to assign to the #demand_signal_item_id property

  • :accepted_quantity (Integer) —

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

  • :justification (String) —

    The value to assign to the #justification property

  • :time_delivered (DateTime) —

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



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
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_delivery_summary.rb', line 157

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_item_id = attributes[:'demandSignalItemId'] if attributes[:'demandSignalItemId']

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

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

  self.accepted_quantity = attributes[:'acceptedQuantity'] if attributes[:'acceptedQuantity']

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

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

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

  self.time_delivered = attributes[:'timeDelivered'] if attributes[:'timeDelivered']

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

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

  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

#accepted_quantity ⇒ Integer

[Required] The quantity of the resource that OCI will supply to the customer.

Returns:

  • (Integer) 


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

def accepted_quantity
  @accepted_quantity
end

#compartment_id ⇒ String

[Required] The OCID of the tenancy from which the demand signal delivery resource is created.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_delivery_summary.rb', line 38

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


91
92
93
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_delivery_summary.rb', line 91

def defined_tags
  @defined_tags
end

#demand_signal_id ⇒ String

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

Returns:

  • (String) 


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

def demand_signal_id
  @demand_signal_id
end

#demand_signal_item_id ⇒ String

[Required] The OCID of the demand signal item corresponding to which this delivery is made.

Returns:

  • (String) 


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

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


85
86
87
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_delivery_summary.rb', line 85

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of this demand signal delivery resource.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_delivery_summary.rb', line 33

def id
  @id
end

#justification ⇒ String

This field could be used by OCI to communicate the reason for accepting or declining the request.

Returns:

  • (String) 


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

def justification
  @justification
end

#lifecycle_details ⇒ String

[Required] The enum values corresponding to the various states associated with the delivery resource.

ACCEPTED -> OCI has accepted your resource request and will deliver the quantity as specified by acceptance quantity of this resource. DECLINED -> OCI has declined you resource request. DELIVERED -> OCI has delivered the accepted quantity to the customers.

Note: Under extreme rare scenarios the delivery state can toggle between ACCEPTED and DECLINED states

Returns:

  • (String) 


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

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current lifecycle state of the resource.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_delivery_summary.rb', line 58

def lifecycle_state
  @lifecycle_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>>) 


97
98
99
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_delivery_summary.rb', line 97

def system_tags
  @system_tags
end

#time_delivered ⇒ DateTime

The date on which the OCI delivered the resource to the customers.

Returns:

  • (DateTime) 


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

def time_delivered
  @time_delivered
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'demand_signal_id': :'demandSignalId',
    'demand_signal_item_id': :'demandSignalItemId',
    'accepted_quantity': :'acceptedQuantity',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'justification': :'justification',
    'time_delivered': :'timeDelivered',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_delivery_summary.rb', line 120

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'demand_signal_id': :'String',
    'demand_signal_item_id': :'String',
    'accepted_quantity': :'Integer',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'justification': :'String',
    'time_delivered': :'DateTime',
    '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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_delivery_summary.rb', line 261

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_item_id == other.demand_signal_item_id &&
    accepted_quantity == other.accepted_quantity &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    justification == other.justification &&
    time_delivered == other.time_delivered &&
    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



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

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


282
283
284
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_delivery_summary.rb', line 282

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



291
292
293
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_delivery_summary.rb', line 291

def hash
  [id, compartment_id, demand_signal_id, demand_signal_item_id, accepted_quantity, lifecycle_state, lifecycle_details, justification, time_delivered, 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



335
336
337
338
339
340
341
342
343
344
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_delivery_summary.rb', line 335

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



329
330
331
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_delivery_summary.rb', line 329

def to_s
  to_hash.to_s
end