Class: OCI::CapacityManagement::Models::CreateOccmDemandSignalItemDetails

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

Overview

Details about different fields required to create a demand signal item resource.

Constant Summary collapse

REQUEST_TYPE_ENUM = 
[
  REQUEST_TYPE_DEMAND = 'DEMAND'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateOccmDemandSignalItemDetails

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

  • :demand_signal_id (String) —

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

  • :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

  • :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



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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/oci/capacity_management/models/create_occm_demand_signal_item_details.rb', line 146

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

#availability_domain ⇒ String

The name of the availability domain for which you want to request the OCI resource. This is an optional parameter.

Returns:

  • (String) 


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

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) 


19
20
21
 
# File 'lib/oci/capacity_management/models/create_occm_demand_signal_item_details.rb', line 19

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


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

def defined_tags
  @defined_tags
end

#demand_quantity ⇒ Integer

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

Returns:

  • (Integer) 


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

def demand_quantity
  @demand_quantity
end

#demand_signal_catalog_resource_id ⇒ String

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

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/capacity_management/models/create_occm_demand_signal_item_details.rb', line 29

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 we need to create this item.

Returns:

  • (String) 


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

def demand_signal_id
  @demand_signal_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>) 


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

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


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

def notes
  @notes
end

#region ⇒ String

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

Returns:

  • (String) 


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

def region
  @region
end

#request_type ⇒ String

[Required] The type of request (DEMAND or RETURN) that you want to make for this demand signal item.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/capacity_management/models/create_occm_demand_signal_item_details.rb', line 34

def request_type
  @request_type
end

#resource_properties ⇒ Hash<String, String>

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

Returns:

  • (Hash<String, String>) 


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

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


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

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) 


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

def time_needed_before
  @time_needed_before
end

Class Method Details

.attribute_map ⇒ Object

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



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/oci/capacity_management/models/create_occm_demand_signal_item_details.rb', line 86

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

.swagger_types ⇒ Object

Attribute type mapping.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/oci/capacity_management/models/create_occm_demand_signal_item_details.rb', line 107

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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/oci/capacity_management/models/create_occm_demand_signal_item_details.rb', line 238

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    demand_signal_id == other.demand_signal_id &&
    demand_signal_catalog_resource_id == other.demand_signal_catalog_resource_id &&
    request_type == other.request_type &&
    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 &&
    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



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/oci/capacity_management/models/create_occm_demand_signal_item_details.rb', line 280

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


260
261
262
 
# File 'lib/oci/capacity_management/models/create_occm_demand_signal_item_details.rb', line 260

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



269
270
271
 
# File 'lib/oci/capacity_management/models/create_occm_demand_signal_item_details.rb', line 269

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



313
314
315
316
317
318
319
320
321
322
 
# File 'lib/oci/capacity_management/models/create_occm_demand_signal_item_details.rb', line 313

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



307
308
309
 
# File 'lib/oci/capacity_management/models/create_occm_demand_signal_item_details.rb', line 307

def to_s
  to_hash.to_s
end