Class: OCI::OsManagementHub::Models::ManagementStationSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/os_management_hub/models/management_station_summary.rb

Overview

Provides summary information for a management station.

Constant Summary collapse

OVERALL_STATE_ENUM = 
[
  OVERALL_STATE_NORMAL = 'NORMAL'.freeze,
  OVERALL_STATE_REGISTRATIONERROR = 'REGISTRATIONERROR'.freeze,
  OVERALL_STATE_SYNCING = 'SYNCING'.freeze,
  OVERALL_STATE_SYNCFAILED = 'SYNCFAILED'.freeze,
  OVERALL_STATE_WARNING = 'WARNING'.freeze,
  OVERALL_STATE_ERROR = 'ERROR'.freeze,
  OVERALL_STATE_UNAVAILABLE = 'UNAVAILABLE'.freeze,
  OVERALL_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
HEALTH_STATE_ENUM = 
[
  HEALTH_STATE_HEALTHY = 'HEALTHY'.freeze,
  HEALTH_STATE_UNHEALTHY = 'UNHEALTHY'.freeze,
  HEALTH_STATE_UNAVAILABLE = 'UNAVAILABLE'.freeze,
  HEALTH_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LOCATION_ENUM = 
[
  LOCATION_ON_PREMISE = 'ON_PREMISE'.freeze,
  LOCATION_OCI_COMPUTE = 'OCI_COMPUTE'.freeze,
  LOCATION_AZURE = 'AZURE'.freeze,
  LOCATION_EC2 = 'EC2'.freeze,
  LOCATION_GCP = 'GCP'.freeze,
  LOCATION_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ManagementStationSummary

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

  • :managed_instance_id (String) —

    The value to assign to the #managed_instance_id property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :profile_id (String) —

    The value to assign to the #profile_id property

  • :scheduled_job_id (String) —

    The value to assign to the #scheduled_job_id property

  • :time_next_execution (DateTime) —

    The value to assign to the #time_next_execution property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :hostname (String) —

    The value to assign to the #hostname property

  • :overall_state (String) —

    The value to assign to the #overall_state property

  • :health_state (String) —

    The value to assign to the #health_state property

  • :overall_percentage (Integer) —

    The value to assign to the #overall_percentage property

  • :mirror_capacity (Integer) —

    The value to assign to the #mirror_capacity property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :location (String) —

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



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
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
 
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 195

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

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

  self.managed_instance_id = attributes[:'managed_instance_id'] if attributes[:'managed_instance_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.profile_id = attributes[:'profileId'] if attributes[:'profileId']

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

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

  self.scheduled_job_id = attributes[:'scheduledJobId'] if attributes[:'scheduledJobId']

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

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

  self.time_next_execution = attributes[:'timeNextExecution'] if attributes[:'timeNextExecution']

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

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

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

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

  self.overall_state = attributes[:'overallState'] if attributes[:'overallState']

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

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

  self.health_state = attributes[:'healthState'] if attributes[:'healthState']

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

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

  self.overall_percentage = attributes[:'overallPercentage'] if attributes[:'overallPercentage']

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

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

  self.mirror_capacity = attributes[:'mirrorCapacity'] if attributes[:'mirrorCapacity']

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

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

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

  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 the compartment that contains the management station.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 49

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. For more information, see Resource Tags. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


111
112
113
 
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 111

def defined_tags
  @defined_tags
end

#description ⇒ String

User-specified description of the management station.

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 69

def description
  @description
end

#display_name ⇒ String

[Required] User-friendly name for the management station.

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/os_management_hub/models/management_station_summary.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>) 


104
105
106
 
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 104

def freeform_tags
  @freeform_tags
end

#health_state ⇒ String

Overall health status of the managment station.

Returns:

  • (String) 


81
82
83
 
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 81

def health_state
  @health_state
end

#hostname ⇒ String

[Required] Hostname of the management station.

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 73

def hostname
  @hostname
end

#id ⇒ String

[Required] The OCID of the management station.

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 41

def id
  @id
end

#lifecycle_state ⇒ String

The current state of the management station.

Returns:

  • (String) 


93
94
95
 
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 93

def lifecycle_state
  @lifecycle_state
end

#location ⇒ String

The location of the instance that is acting as the management station.

Returns:

  • (String) 


97
98
99
 
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 97

def location
  @location
end

#managed_instance_id ⇒ String

The OCID of the instance that is acting as the management station.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 45

def managed_instance_id
  @managed_instance_id
end

#mirror_capacity ⇒ Integer

A decimal number representing the amount of mirror capacity used by the sync.

Returns:

  • (Integer) 


89
90
91
 
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 89

def mirror_capacity
  @mirror_capacity
end

#overall_percentage ⇒ Integer

A decimal number representing the progress of the current mirror sync.

Returns:

  • (Integer) 


85
86
87
 
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 85

def overall_percentage
  @overall_percentage
end

#overall_state ⇒ String

Current state of the mirror sync for the management station.

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 77

def overall_state
  @overall_state
end

#profile_id ⇒ String

The OCID of the registration profile used for the management station.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 53

def profile_id
  @profile_id
end

#scheduled_job_id ⇒ String

The OCID of the scheduled job for the mirror sync.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 57

def scheduled_job_id
  @scheduled_job_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>>) 


117
118
119
 
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 117

def system_tags
  @system_tags
end

#time_next_execution ⇒ DateTime

The date and time of the next scheduled mirror sync (in RFC 3339 format).

Returns:

  • (DateTime) 


61
62
63
 
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 61

def time_next_execution
  @time_next_execution
end

Class Method Details

.attribute_map ⇒ Object

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



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 120

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'managed_instance_id': :'managedInstanceId',
    'compartment_id': :'compartmentId',
    'profile_id': :'profileId',
    'scheduled_job_id': :'scheduledJobId',
    'time_next_execution': :'timeNextExecution',
    'display_name': :'displayName',
    'description': :'description',
    'hostname': :'hostname',
    'overall_state': :'overallState',
    'health_state': :'healthState',
    'overall_percentage': :'overallPercentage',
    'mirror_capacity': :'mirrorCapacity',
    'lifecycle_state': :'lifecycleState',
    'location': :'location',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 146

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'managed_instance_id': :'String',
    'compartment_id': :'String',
    'profile_id': :'String',
    'scheduled_job_id': :'String',
    'time_next_execution': :'DateTime',
    'display_name': :'String',
    'description': :'String',
    'hostname': :'String',
    'overall_state': :'String',
    'health_state': :'String',
    'overall_percentage': :'Integer',
    'mirror_capacity': :'Integer',
    'lifecycle_state': :'String',
    'location': :'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



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 340

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

  self.class == other.class &&
    id == other.id &&
    managed_instance_id == other.managed_instance_id &&
    compartment_id == other.compartment_id &&
    profile_id == other.profile_id &&
    scheduled_job_id == other.scheduled_job_id &&
    time_next_execution == other.time_next_execution &&
    display_name == other.display_name &&
    description == other.description &&
    hostname == other.hostname &&
    overall_state == other.overall_state &&
    health_state == other.health_state &&
    overall_percentage == other.overall_percentage &&
    mirror_capacity == other.mirror_capacity &&
    lifecycle_state == other.lifecycle_state &&
    location == other.location &&
    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



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 387

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


367
368
369
 
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 367

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



376
377
378
 
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 376

def hash
  [id, managed_instance_id, compartment_id, profile_id, scheduled_job_id, time_next_execution, display_name, description, hostname, overall_state, health_state, overall_percentage, mirror_capacity, lifecycle_state, location, 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



420
421
422
423
424
425
426
427
428
429
 
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 420

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



414
415
416
 
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 414

def to_s
  to_hash.to_s
end