Class: OCI::OsManagementHub::Models::ManagementStation

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

Overview

Provides information about the management station, including name, state, and configuration.

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
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ManagementStation

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/oci/os_management_hub/models/management_station.rb', line 201

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

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

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

  self.mirror_sync_status = attributes[:'mirrorSyncStatus'] if attributes[:'mirrorSyncStatus']

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

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

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

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

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

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

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/os_management_hub/models/management_station.rb', line 43

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.rb', line 111

def defined_tags
  @defined_tags
end

#description ⇒ String

User-specified description for the management station.

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/os_management_hub/models/management_station.rb', line 59

def description
  @description
end

#display_name ⇒ String

[Required] A user-friendly name for the management station.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/os_management_hub/models/management_station.rb', line 55

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.rb', line 104

def freeform_tags
  @freeform_tags
end

#health ⇒ OCI::OsManagementHub::Models::StationHealth

Returns:



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

def health
  @health
end

#hostname ⇒ String

[Required] Hostname of the management station.

Returns:

  • (String) 


63
64
65
 
# File 'lib/oci/os_management_hub/models/management_station.rb', line 63

def hostname
  @hostname
end

#id ⇒ String

[Required] The OCID of the management station.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/os_management_hub/models/management_station.rb', line 35

def id
  @id
end

#lifecycle_state ⇒ String

The current state of the management station.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#managed_instance_id ⇒ String

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

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/os_management_hub/models/management_station.rb', line 39

def managed_instance_id
  @managed_instance_id
end

#mirror ⇒ OCI::OsManagementHub::Models::MirrorConfiguration

This attribute is required.

Returns:



90
91
92
 
# File 'lib/oci/os_management_hub/models/management_station.rb', line 90

def mirror
  @mirror
end

#mirror_capacity ⇒ Integer

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

Returns:

  • (Integer) 


75
76
77
 
# File 'lib/oci/os_management_hub/models/management_station.rb', line 75

def mirror_capacity
  @mirror_capacity
end

#mirror_sync_status ⇒ OCI::OsManagementHub::Models::MirrorSyncStatus

Returns:



82
83
84
 
# File 'lib/oci/os_management_hub/models/management_station.rb', line 82

def mirror_sync_status
  @mirror_sync_status
end

#overall_percentage ⇒ Integer

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

Returns:

  • (Integer) 


71
72
73
 
# File 'lib/oci/os_management_hub/models/management_station.rb', line 71

def overall_percentage
  @overall_percentage
end

#overall_state ⇒ String

Current state of the mirror sync for the management station.

Returns:

  • (String) 


67
68
69
 
# File 'lib/oci/os_management_hub/models/management_station.rb', line 67

def overall_state
  @overall_state
end

#profile_id ⇒ String

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

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/os_management_hub/models/management_station.rb', line 51

def profile_id
  @profile_id
end

#proxy ⇒ OCI::OsManagementHub::Models::ProxyConfiguration

This attribute is required.

Returns:



86
87
88
 
# File 'lib/oci/os_management_hub/models/management_station.rb', line 86

def proxy
  @proxy
end

#scheduled_job_id ⇒ String

The OCID of the scheduled job for the mirror sync.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/os_management_hub/models/management_station.rb', line 47

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.rb', line 117

def system_tags
  @system_tags
end

#total_mirrors ⇒ Integer

The number of software sources that the station is mirroring.

Returns:

  • (Integer) 


79
80
81
 
# File 'lib/oci/os_management_hub/models/management_station.rb', line 79

def total_mirrors
  @total_mirrors
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
144
145
 
# File 'lib/oci/os_management_hub/models/management_station.rb', line 120

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'managed_instance_id': :'managedInstanceId',
    'compartment_id': :'compartmentId',
    'scheduled_job_id': :'scheduledJobId',
    'profile_id': :'profileId',
    'display_name': :'displayName',
    'description': :'description',
    'hostname': :'hostname',
    'overall_state': :'overallState',
    'overall_percentage': :'overallPercentage',
    'mirror_capacity': :'mirrorCapacity',
    'total_mirrors': :'totalMirrors',
    'mirror_sync_status': :'mirrorSyncStatus',
    'proxy': :'proxy',
    'mirror': :'mirror',
    'health': :'health',
    'lifecycle_state': :'lifecycleState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'managed_instance_id': :'String',
    'compartment_id': :'String',
    'scheduled_job_id': :'String',
    'profile_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'hostname': :'String',
    'overall_state': :'String',
    'overall_percentage': :'Integer',
    'mirror_capacity': :'Integer',
    'total_mirrors': :'Integer',
    'mirror_sync_status': :'OCI::OsManagementHub::Models::MirrorSyncStatus',
    'proxy': :'OCI::OsManagementHub::Models::ProxyConfiguration',
    'mirror': :'OCI::OsManagementHub::Models::MirrorConfiguration',
    'health': :'OCI::OsManagementHub::Models::StationHealth',
    '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



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

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 &&
    scheduled_job_id == other.scheduled_job_id &&
    profile_id == other.profile_id &&
    display_name == other.display_name &&
    description == other.description &&
    hostname == other.hostname &&
    overall_state == other.overall_state &&
    overall_percentage == other.overall_percentage &&
    mirror_capacity == other.mirror_capacity &&
    total_mirrors == other.total_mirrors &&
    mirror_sync_status == other.mirror_sync_status &&
    proxy == other.proxy &&
    mirror == other.mirror &&
    health == other.health &&
    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



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

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


366
367
368
 
# File 'lib/oci/os_management_hub/models/management_station.rb', line 366

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



375
376
377
 
# File 'lib/oci/os_management_hub/models/management_station.rb', line 375

def hash
  [id, managed_instance_id, compartment_id, scheduled_job_id, profile_id, display_name, description, hostname, overall_state, overall_percentage, mirror_capacity, total_mirrors, mirror_sync_status, proxy, mirror, health, 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



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

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



413
414
415
 
# File 'lib/oci/os_management_hub/models/management_station.rb', line 413

def to_s
  to_hash.to_s
end