Class: OCI::ComputeCloudAtCustomer::Models::CccInfrastructureSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/compute_cloud_at_customer/models/ccc_infrastructure_summary.rb

Overview

Summary information about a Compute Cloud@Customer infrastructure.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CccInfrastructureSummary

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

  • :short_name (String) —

    The value to assign to the #short_name property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :subnet_id (String) —

    The value to assign to the #subnet_id property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :connection_state (String) —

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



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
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
 
# File 'lib/oci/compute_cloud_at_customer/models/ccc_infrastructure_summary.rb', line 133

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

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

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

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

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

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

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

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

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

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

  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

#compartment_id ⇒ String

[Required] The compartment OCID associated with the infrastructure.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/compute_cloud_at_customer/models/ccc_infrastructure_summary.rb', line 37

def compartment_id
  @compartment_id
end

#connection_state ⇒ String

The current connection state of the infrastructure.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/compute_cloud_at_customer/models/ccc_infrastructure_summary.rb', line 54

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


70
71
72
 
# File 'lib/oci/compute_cloud_at_customer/models/ccc_infrastructure_summary.rb', line 70

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] The name that will be used to display the Compute Cloud@Customer infrastructure in the Oracle Cloud Infrastructure console. Does not have to be unique and can be changed. Avoid entering confidential information.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/compute_cloud_at_customer/models/ccc_infrastructure_summary.rb', line 31

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


64
65
66
 
# File 'lib/oci/compute_cloud_at_customer/models/ccc_infrastructure_summary.rb', line 64

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The Compute Cloud@Customer infrastructure OCID. This cannot be changed once created.

Returns:

  • (String) 


16
17
18
 
# File 'lib/oci/compute_cloud_at_customer/models/ccc_infrastructure_summary.rb', line 16

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current state of the Compute Cloud@Customer infrastructure.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/compute_cloud_at_customer/models/ccc_infrastructure_summary.rb', line 58

def lifecycle_state
  @lifecycle_state
end

#short_name ⇒ String

The Compute Cloud@Customer infrastructure short name. This is generated at the time the resource is created and cannot be changed. The short name can be used when communicating with Oracle Service and may be used during the configuration of the data center network.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/compute_cloud_at_customer/models/ccc_infrastructure_summary.rb', line 24

def short_name
  @short_name
end

#subnet_id ⇒ String

[Required] OCID for the network subnet that is used to communicate with Compute Cloud@Customer infrastructure.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/compute_cloud_at_customer/models/ccc_infrastructure_summary.rb', line 43

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


76
77
78
 
# File 'lib/oci/compute_cloud_at_customer/models/ccc_infrastructure_summary.rb', line 76

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] Compute Cloud@Customer infrastructure creation date and time. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


49
50
51
 
# File 'lib/oci/compute_cloud_at_customer/models/ccc_infrastructure_summary.rb', line 49

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/oci/compute_cloud_at_customer/models/ccc_infrastructure_summary.rb', line 79

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'short_name': :'shortName',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'subnet_id': :'subnetId',
    'time_created': :'timeCreated',
    'connection_state': :'connectionState',
    'lifecycle_state': :'lifecycleState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/oci/compute_cloud_at_customer/models/ccc_infrastructure_summary.rb', line 98

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'short_name': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'subnet_id': :'String',
    'time_created': :'DateTime',
    'connection_state': :'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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/oci/compute_cloud_at_customer/models/ccc_infrastructure_summary.rb', line 209

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

  self.class == other.class &&
    id == other.id &&
    short_name == other.short_name &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    subnet_id == other.subnet_id &&
    time_created == other.time_created &&
    connection_state == other.connection_state &&
    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



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/oci/compute_cloud_at_customer/models/ccc_infrastructure_summary.rb', line 249

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


229
230
231
 
# File 'lib/oci/compute_cloud_at_customer/models/ccc_infrastructure_summary.rb', line 229

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



238
239
240
 
# File 'lib/oci/compute_cloud_at_customer/models/ccc_infrastructure_summary.rb', line 238

def hash
  [id, short_name, display_name, compartment_id, subnet_id, time_created, connection_state, 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



282
283
284
285
286
287
288
289
290
291
 
# File 'lib/oci/compute_cloud_at_customer/models/ccc_infrastructure_summary.rb', line 282

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



276
277
278
 
# File 'lib/oci/compute_cloud_at_customer/models/ccc_infrastructure_summary.rb', line 276

def to_s
  to_hash.to_s
end