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

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

Overview

Summary of the 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

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

  • :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

  • :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



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

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.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.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_idString

[Required] The OCID of the tenancy containing the Management Station.

Returns:

  • (String)


33
34
35
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 33

def compartment_id
  @compartment_id
end

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


87
88
89
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 87

def defined_tags
  @defined_tags
end

#descriptionString

Details describing the Management Station config.

Returns:

  • (String)


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

def description
  @description
end

#display_nameString

[Required] ManagementStation name

Returns:

  • (String)


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

def display_name
  @display_name
end

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


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

def freeform_tags
  @freeform_tags
end

#hostnameString

[Required] Name of the host

Returns:

  • (String)


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

def hostname
  @hostname
end

#idString

[Required] OCID for the Management Station

Returns:

  • (String)


25
26
27
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 25

def id
  @id
end

#lifecycle_stateString

The current state of the Management Station config.

Returns:

  • (String)


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

def lifecycle_state
  @lifecycle_state
end

#managed_instance_idString

OCID for the Instance associated with the Management Station

Returns:

  • (String)


29
30
31
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 29

def managed_instance_id
  @managed_instance_id
end

#mirror_capacityInteger

A decimal number representing the mirror capacity

Returns:

  • (Integer)


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

def mirror_capacity
  @mirror_capacity
end

#overall_percentageInteger

A decimal number representing the completeness percentage

Returns:

  • (Integer)


65
66
67
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 65

def overall_percentage
  @overall_percentage
end

#overall_stateString

Current state of the mirroring

Returns:

  • (String)


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

def overall_state
  @overall_state
end

#profile_idString

OCID of the Registration Profile associated with the Management Station

Returns:

  • (String)


37
38
39
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 37

def profile_id
  @profile_id
end

#scheduled_job_idString

OCID of the Scheduled Job for mirror sync

Returns:

  • (String)


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

def scheduled_job_id
  @scheduled_job_id
end

#system_tagsHash<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/os_management_hub/models/management_station_summary.rb', line 93

def system_tags
  @system_tags
end

#time_next_executionDateTime

the time/date of the next scheduled execution of the Scheduled Job

Returns:

  • (DateTime)


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

def time_next_execution
  @time_next_execution
end

Class Method Details

.attribute_mapObject

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



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 96

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',
    'overall_percentage': :'overallPercentage',
    'mirror_capacity': :'mirrorCapacity',
    'lifecycle_state': :'lifecycleState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

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',
    'overall_percentage': :'Integer',
    'mirror_capacity': :'Integer',
    '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



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 276

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 &&
    overall_percentage == other.overall_percentage &&
    mirror_capacity == other.mirror_capacity &&
    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



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 321

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


301
302
303
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 301

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



310
311
312
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 310

def hash
  [id, managed_instance_id, compartment_id, profile_id, scheduled_job_id, time_next_execution, display_name, description, hostname, overall_state, overall_percentage, mirror_capacity, lifecycle_state, freeform_tags, defined_tags, system_tags].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



354
355
356
357
358
359
360
361
362
363
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 354

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



348
349
350
# File 'lib/oci/os_management_hub/models/management_station_summary.rb', line 348

def to_s
  to_hash.to_s
end