Class: OCI::CapacityManagement::Models::OccmDemandSignalCatalogResource

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

Overview

A model containing information about the details of a demand signal catalog resource.

Constant Summary collapse

NAMESPACE_ENUM = 
[
  NAMESPACE_COMPUTE = 'COMPUTE'.freeze,
  NAMESPACE_NETWORK = 'NETWORK'.freeze,
  NAMESPACE_GPU = 'GPU'.freeze,
  NAMESPACE_STORAGE = 'STORAGE'.freeze,
  NAMESPACE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ OccmDemandSignalCatalogResource

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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

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

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

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

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

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

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


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

def availability_domain
  @availability_domain
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


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

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


87
88
89
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_catalog_resource.rb', line 87

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


81
82
83
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_catalog_resource.rb', line 81

def freeform_tags
  @freeform_tags
end

#id ⇒ String

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

Returns:

  • (String) 


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

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current lifecycle state of the resource.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

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

Returns:

  • (String) 


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

def name
  @name
end

#namespace ⇒ String

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

Returns:

  • (String) 


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

def namespace
  @namespace
end

#region ⇒ String

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

Returns:

  • (String) 


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

def region
  @region
end

#resource_properties ⇒ OCI::CapacityManagement::Models::OccmDemandSignalResourcePropertiesCollection

Returns:



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

def resource_properties
  @resource_properties
end

#resource_property_constraints ⇒ OCI::CapacityManagement::Models::OccmDemandSignalResourcePropertyConstraintsCollection

Returns:



70
71
72
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_catalog_resource.rb', line 70

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


93
94
95
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_catalog_resource.rb', line 93

def system_tags
  @system_tags
end

#target_compartment_id ⇒ String

The OCID of the customer tenancy for which this resource will be available for the customer to order against.

Returns:

  • (String) 


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

def target_compartment_id
  @target_compartment_id
end

#time_created ⇒ DateTime

[Required] The time when the demand signal catalog resource was created.

Returns:

  • (DateTime) 


98
99
100
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_catalog_resource.rb', line 98

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] The time when the demand signal catalog resource was last updated.

Returns:

  • (DateTime) 


103
104
105
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_catalog_resource.rb', line 103

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'namespace': :'namespace',
    'name': :'name',
    'target_compartment_id': :'targetCompartmentId',
    'region': :'region',
    'availability_domain': :'availabilityDomain',
    'resource_properties': :'resourceProperties',
    'resource_property_constraints': :'resourcePropertyConstraints',
    'lifecycle_state': :'lifecycleState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_catalog_resource.rb', line 129

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'namespace': :'String',
    'name': :'String',
    'target_compartment_id': :'String',
    'region': :'String',
    'availability_domain': :'String',
    'resource_properties': :'OCI::CapacityManagement::Models::OccmDemandSignalResourcePropertiesCollection',
    'resource_property_constraints': :'OCI::CapacityManagement::Models::OccmDemandSignalResourcePropertyConstraintsCollection',
    'lifecycle_state': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>',
    'time_created': :'DateTime',
    'time_updated': :'DateTime'
    # 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



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_catalog_resource.rb', line 286

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    namespace == other.namespace &&
    name == other.name &&
    target_compartment_id == other.target_compartment_id &&
    region == other.region &&
    availability_domain == other.availability_domain &&
    resource_properties == other.resource_properties &&
    resource_property_constraints == other.resource_property_constraints &&
    lifecycle_state == other.lifecycle_state &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags &&
    time_created == other.time_created &&
    time_updated == other.time_updated
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



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_catalog_resource.rb', line 330

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


310
311
312
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_catalog_resource.rb', line 310

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



319
320
321
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_catalog_resource.rb', line 319

def hash
  [id, compartment_id, namespace, name, target_compartment_id, region, availability_domain, resource_properties, resource_property_constraints, lifecycle_state, freeform_tags, defined_tags, system_tags, time_created, time_updated].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



363
364
365
366
367
368
369
370
371
372
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_catalog_resource.rb', line 363

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



357
358
359
 
# File 'lib/oci/capacity_management/models/occm_demand_signal_catalog_resource.rb', line 357

def to_s
  to_hash.to_s
end