Class: OCI::CapacityManagement::Models::CreateInternalOccmDemandSignalDeliveryDetails

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

Overview

An internal model containing details about the properties required for creating a demand signal delivery resource.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateInternalOccmDemandSignalDeliveryDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :occ_customer_group_id (String) —

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

  • :justification (String) —

    The value to assign to the #justification property

  • :notes (String) —

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



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/oci/capacity_management/models/create_internal_occm_demand_signal_delivery_details.rb', line 108

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

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

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

Instance Attribute Details

#accepted_quantity ⇒ Integer

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

Returns:

  • (Integer) 


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

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) 


15
16
17
 
# File 'lib/oci/capacity_management/models/create_internal_occm_demand_signal_delivery_details.rb', line 15

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


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

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) 


25
26
27
 
# File 'lib/oci/capacity_management/models/create_internal_occm_demand_signal_delivery_details.rb', line 25

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) 


30
31
32
 
# File 'lib/oci/capacity_management/models/create_internal_occm_demand_signal_delivery_details.rb', line 30

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


51
52
53
 
# File 'lib/oci/capacity_management/models/create_internal_occm_demand_signal_delivery_details.rb', line 51

def freeform_tags
  @freeform_tags
end

#justification ⇒ String

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

Returns:

  • (String) 


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

def justification
  @justification
end

#notes ⇒ String

This field acts as a notes section for operators.

Returns:

  • (String) 


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

def notes
  @notes
end

#occ_customer_group_id ⇒ String

[Required] The OCID of the corresponding customer group to which this demand signal delivery resource belongs to.

Returns:

  • (String) 


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

def occ_customer_group_id
  @occ_customer_group_id
end

Class Method Details

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/oci/capacity_management/models/create_internal_occm_demand_signal_delivery_details.rb', line 60

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'occ_customer_group_id': :'occCustomerGroupId',
    'demand_signal_id': :'demandSignalId',
    'demand_signal_item_id': :'demandSignalItemId',
    'accepted_quantity': :'acceptedQuantity',
    'justification': :'justification',
    'notes': :'notes',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/oci/capacity_management/models/create_internal_occm_demand_signal_delivery_details.rb', line 77

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'occ_customer_group_id': :'String',
    'demand_signal_id': :'String',
    'demand_signal_item_id': :'String',
    'accepted_quantity': :'Integer',
    'justification': :'String',
    'notes': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_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



168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/oci/capacity_management/models/create_internal_occm_demand_signal_delivery_details.rb', line 168

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    occ_customer_group_id == other.occ_customer_group_id &&
    demand_signal_id == other.demand_signal_id &&
    demand_signal_item_id == other.demand_signal_item_id &&
    accepted_quantity == other.accepted_quantity &&
    justification == other.justification &&
    notes == other.notes &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/oci/capacity_management/models/create_internal_occm_demand_signal_delivery_details.rb', line 206

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


186
187
188
 
# File 'lib/oci/capacity_management/models/create_internal_occm_demand_signal_delivery_details.rb', line 186

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



195
196
197
 
# File 'lib/oci/capacity_management/models/create_internal_occm_demand_signal_delivery_details.rb', line 195

def hash
  [compartment_id, occ_customer_group_id, demand_signal_id, demand_signal_item_id, accepted_quantity, justification, notes, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



239
240
241
242
243
244
245
246
247
248
 
# File 'lib/oci/capacity_management/models/create_internal_occm_demand_signal_delivery_details.rb', line 239

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



233
234
235
 
# File 'lib/oci/capacity_management/models/create_internal_occm_demand_signal_delivery_details.rb', line 233

def to_s
  to_hash.to_s
end