Class: OCI::Ocvp::Models::ManagementAppliance

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/ocvp/models/management_appliance.rb

Overview

Information about management appliance.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_DETAILS_ENUM = 
[
  LIFECYCLE_DETAILS_HEALTHY = 'HEALTHY'.freeze,
  LIFECYCLE_DETAILS_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_DETAILS_DELETING = 'DELETING'.freeze,
  LIFECYCLE_DETAILS_DELETED = 'DELETED'.freeze,
  LIFECYCLE_DETAILS_FAILED = 'FAILED'.freeze,
  LIFECYCLE_DETAILS_CREATING = 'CREATING'.freeze,
  LIFECYCLE_DETAILS_WAITING_FOR_HEARTBEAT = 'WAITING_FOR_HEARTBEAT'.freeze,
  LIFECYCLE_DETAILS_HEARTBEAT_TIMEOUT = 'HEARTBEAT_TIMEOUT'.freeze,
  LIFECYCLE_DETAILS_CAN_NOT_CONNECT_TO_VCENTER = 'CAN_NOT_CONNECT_TO_VCENTER'.freeze,
  LIFECYCLE_DETAILS_UI_PLUGIN_IS_NOT_REGISTERED = 'UI_PLUGIN_IS_NOT_REGISTERED'.freeze,
  LIFECYCLE_DETAILS_UNKNOWN_DETAILS = 'UNKNOWN_DETAILS'.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 = {}) ⇒ ManagementAppliance

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/oci/ocvp/models/management_appliance.rb', line 212

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

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

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

  self.compute_instance_id = attributes[:'computeInstanceId'] if attributes[:'computeInstanceId']

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

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

  self.management_agent_id = attributes[:'managementAgentId'] if attributes[:'managementAgentId']

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

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

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

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

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

  self.time_configuration_updated = attributes[:'timeConfigurationUpdated'] if attributes[:'timeConfigurationUpdated']

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

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

  self.time_last_heartbeat = attributes[:'timeLastHeartbeat'] if attributes[:'timeLastHeartbeat']

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

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

  self.heartbeat_connection_states = attributes[:'heartbeatConnectionStates'] if attributes[:'heartbeatConnectionStates']

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

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

  self.plugin_version = attributes[:'pluginVersion'] if attributes[:'pluginVersion']

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

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

  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 OCID of compartment in OCI, that this appliance is going to be created in.

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/ocvp/models/management_appliance.rb', line 46

def compartment_id
  @compartment_id
end

#compute_instance_id ⇒ String

The OCID of compute instance of management appliance in OCI.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/ocvp/models/management_appliance.rb', line 56

def compute_instance_id
  @compute_instance_id
end

#configuration ⇒ OCI::Ocvp::Models::ManagementApplianceConfiguration

This attribute is required.

Returns:



77
78
79
 
# File 'lib/oci/ocvp/models/management_appliance.rb', line 77

def configuration
  @configuration
end

#connections ⇒ Array<OCI::Ocvp::Models::ManagementApplianceConnection>

[Required] Array of connections for management appliance.

Returns:



81
82
83
 
# File 'lib/oci/ocvp/models/management_appliance.rb', line 81

def connections
  @connections
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


125
126
127
 
# File 'lib/oci/ocvp/models/management_appliance.rb', line 125

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] A descriptive name for the management appliance. It must be unique, start with a letter, and contain only letters, digits, whitespaces, dashes and underscores. Avoid entering confidential information.

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/ocvp/models/management_appliance.rb', line 65

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


117
118
119
 
# File 'lib/oci/ocvp/models/management_appliance.rb', line 117

def freeform_tags
  @freeform_tags
end

#heartbeat_connection_states ⇒ Array<OCI::Ocvp::Models::ManagementApplianceConnectionStatus>

Current states of connections.

Returns:



101
102
103
 
# File 'lib/oci/ocvp/models/management_appliance.rb', line 101

def heartbeat_connection_states
  @heartbeat_connection_states
end

#id ⇒ String

[Required] The OCID of management appliance.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/ocvp/models/management_appliance.rb', line 41

def id
  @id
end

#lifecycle_details ⇒ String

Information about current lifecycleState. For FAILED and NEEDS_ATTENTION contains explanations. For other states may contain some details about their progress.

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/ocvp/models/management_appliance.rb', line 73

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] Current state of the management appliance.

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/ocvp/models/management_appliance.rb', line 69

def lifecycle_state
  @lifecycle_state
end

#management_agent_id ⇒ String

The OCID of management agent, that this appliance is running in.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/ocvp/models/management_appliance.rb', line 61

def management_agent_id
  @management_agent_id
end

#plugin_version ⇒ String

Current version of OCVS management plugin installed by Management Agent. As soon as OCVS service team publishes a new version OCVS management plugin (ocvs-ma-plugin-<version>.zip) to Management Agent service, the service distributes it to Management Appliances owned by customers. This field shows which version of the OCVS management plugin is currently installed and running for this customer.

Returns:

  • (String) 


109
110
111
 
# File 'lib/oci/ocvp/models/management_appliance.rb', line 109

def plugin_version
  @plugin_version
end

#sddc_id ⇒ String

[Required] The OCID of SDDC in OCI, that this appliance is going to be registered in.

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/ocvp/models/management_appliance.rb', line 51

def sddc_id
  @sddc_id
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {orcl-cloud: {free-tier-retain: true}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


131
132
133
 
# File 'lib/oci/ocvp/models/management_appliance.rb', line 131

def system_tags
  @system_tags
end

#time_configuration_updated ⇒ DateTime

The date and time the configuration of management appliance was last updated in the format defined by RFC3339.

Returns:

  • (DateTime) 


93
94
95
 
# File 'lib/oci/ocvp/models/management_appliance.rb', line 93

def time_configuration_updated
  @time_configuration_updated
end

#time_created ⇒ DateTime

[Required] The date and time the management appliance was created in the format defined by RFC3339.

Returns:

  • (DateTime) 


85
86
87
 
# File 'lib/oci/ocvp/models/management_appliance.rb', line 85

def time_created
  @time_created
end

#time_last_heartbeat ⇒ DateTime

The date and time the management appliance has last received heartbeat in the format defined by RFC3339.

Returns:

  • (DateTime) 


97
98
99
 
# File 'lib/oci/ocvp/models/management_appliance.rb', line 97

def time_last_heartbeat
  @time_last_heartbeat
end

#time_updated ⇒ DateTime

The date and time the management appliance was last updated in the format defined by RFC3339.

Returns:

  • (DateTime) 


89
90
91
 
# File 'lib/oci/ocvp/models/management_appliance.rb', line 89

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/oci/ocvp/models/management_appliance.rb', line 134

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'sddc_id': :'sddcId',
    'compute_instance_id': :'computeInstanceId',
    'management_agent_id': :'managementAgentId',
    'display_name': :'displayName',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'configuration': :'configuration',
    'connections': :'connections',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'time_configuration_updated': :'timeConfigurationUpdated',
    'time_last_heartbeat': :'timeLastHeartbeat',
    'heartbeat_connection_states': :'heartbeatConnectionStates',
    'plugin_version': :'pluginVersion',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/oci/ocvp/models/management_appliance.rb', line 161

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'sddc_id': :'String',
    'compute_instance_id': :'String',
    'management_agent_id': :'String',
    'display_name': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'configuration': :'OCI::Ocvp::Models::ManagementApplianceConfiguration',
    'connections': :'Array<OCI::Ocvp::Models::ManagementApplianceConnection>',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'time_configuration_updated': :'DateTime',
    'time_last_heartbeat': :'DateTime',
    'heartbeat_connection_states': :'Array<OCI::Ocvp::Models::ManagementApplianceConnectionStatus>',
    'plugin_version': :'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



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/oci/ocvp/models/management_appliance.rb', line 354

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    sddc_id == other.sddc_id &&
    compute_instance_id == other.compute_instance_id &&
    management_agent_id == other.management_agent_id &&
    display_name == other.display_name &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    configuration == other.configuration &&
    connections == other.connections &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    time_configuration_updated == other.time_configuration_updated &&
    time_last_heartbeat == other.time_last_heartbeat &&
    heartbeat_connection_states == other.heartbeat_connection_states &&
    plugin_version == other.plugin_version &&
    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



402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/oci/ocvp/models/management_appliance.rb', line 402

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


382
383
384
 
# File 'lib/oci/ocvp/models/management_appliance.rb', line 382

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



391
392
393
 
# File 'lib/oci/ocvp/models/management_appliance.rb', line 391

def hash
  [id, compartment_id, sddc_id, compute_instance_id, management_agent_id, display_name, lifecycle_state, lifecycle_details, configuration, connections, time_created, time_updated, time_configuration_updated, time_last_heartbeat, heartbeat_connection_states, plugin_version, 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



435
436
437
438
439
440
441
442
443
444
 
# File 'lib/oci/ocvp/models/management_appliance.rb', line 435

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



429
430
431
 
# File 'lib/oci/ocvp/models/management_appliance.rb', line 429

def to_s
  to_hash.to_s
end