Class: OCI::CloudBridge::Models::AgentSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/cloud_bridge/models/agent_summary.rb

Overview

Summary of the Agent.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AgentSummary

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

  • :display_name (String) —

    The value to assign to the #display_name property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :agent_type (String) —

    The value to assign to the #agent_type property

  • :agent_version (String) —

    The value to assign to the #agent_version property

  • :os_version (String) —

    The value to assign to the #os_version property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :time_last_sync_received (DateTime) —

    The value to assign to the #time_last_sync_received property

  • :heart_beat_status (String) —

    The value to assign to the #heart_beat_status property

  • :environment_id (String) —

    The value to assign to the #environment_id property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

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



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
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
 
# File 'lib/oci/cloud_bridge/models/agent_summary.rb', line 155

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

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

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

  self.agent_version = attributes[:'agentVersion'] if attributes[:'agentVersion']

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

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

  self.os_version = attributes[:'osVersion'] if attributes[:'osVersion']

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

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

  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_last_sync_received = attributes[:'timeLastSyncReceived'] if attributes[:'timeLastSyncReceived']

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

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

  self.heart_beat_status = attributes[:'heartBeatStatus'] if attributes[:'heartBeatStatus']

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

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

  self.environment_id = attributes[:'environmentId'] if attributes[:'environmentId']

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

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

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

#agent_type ⇒ String

[Required] Type of Agent.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/cloud_bridge/models/agent_summary.rb', line 26

def agent_type
  @agent_type
end

#agent_version ⇒ String

[Required] Agent identifier.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/cloud_bridge/models/agent_summary.rb', line 30

def agent_version
  @agent_version
end

#compartment_id ⇒ String

[Required] Compartment identifier.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/cloud_bridge/models/agent_summary.rb', line 22

def compartment_id
  @compartment_id
end

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

[Required] The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


76
77
78
 
# File 'lib/oci/cloud_bridge/models/agent_summary.rb', line 76

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] Agent identifier, which can be renamed.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/cloud_bridge/models/agent_summary.rb', line 18

def display_name
  @display_name
end

#environment_id ⇒ String

[Required] Environment identifier.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/cloud_bridge/models/agent_summary.rb', line 54

def environment_id
  @environment_id
end

#freeform_tags ⇒ Hash<String, String>

[Required] The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


69
70
71
 
# File 'lib/oci/cloud_bridge/models/agent_summary.rb', line 69

def freeform_tags
  @freeform_tags
end

#heart_beat_status ⇒ String

Current heartbeat status of the Agent based on its timeLastSyncReceived value.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/cloud_bridge/models/agent_summary.rb', line 50

def heart_beat_status
  @heart_beat_status
end

#id ⇒ String

[Required] Unique identifier that is immutable on creation.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/cloud_bridge/models/agent_summary.rb', line 14

def id
  @id
end

#lifecycle_details ⇒ String

[Required] A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/cloud_bridge/models/agent_summary.rb', line 62

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the Agent.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/cloud_bridge/models/agent_summary.rb', line 58

def lifecycle_state
  @lifecycle_state
end

#os_version ⇒ String

[Required] OS version.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/cloud_bridge/models/agent_summary.rb', line 34

def os_version
  @os_version
end

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

The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}

Returns:

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


83
84
85
 
# File 'lib/oci/cloud_bridge/models/agent_summary.rb', line 83

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The time when the Agent was created. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


38
39
40
 
# File 'lib/oci/cloud_bridge/models/agent_summary.rb', line 38

def time_created
  @time_created
end

#time_last_sync_received ⇒ DateTime

The time when the last heartbeat of the Agent was noted. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


46
47
48
 
# File 'lib/oci/cloud_bridge/models/agent_summary.rb', line 46

def time_last_sync_received
  @time_last_sync_received
end

#time_updated ⇒ DateTime

[Required] The time when the Agent was updated. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


42
43
44
 
# File 'lib/oci/cloud_bridge/models/agent_summary.rb', line 42

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/oci/cloud_bridge/models/agent_summary.rb', line 86

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'compartment_id': :'compartmentId',
    'agent_type': :'agentType',
    'agent_version': :'agentVersion',
    'os_version': :'osVersion',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'time_last_sync_received': :'timeLastSyncReceived',
    'heart_beat_status': :'heartBeatStatus',
    'environment_id': :'environmentId',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/oci/cloud_bridge/models/agent_summary.rb', line 110

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'compartment_id': :'String',
    'agent_type': :'String',
    'agent_version': :'String',
    'os_version': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'time_last_sync_received': :'DateTime',
    'heart_beat_status': :'String',
    'environment_id': :'String',
    'lifecycle_state': :'String',
    'lifecycle_details': :'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



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/oci/cloud_bridge/models/agent_summary.rb', line 261

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    compartment_id == other.compartment_id &&
    agent_type == other.agent_type &&
    agent_version == other.agent_version &&
    os_version == other.os_version &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    time_last_sync_received == other.time_last_sync_received &&
    heart_beat_status == other.heart_beat_status &&
    environment_id == other.environment_id &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    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



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/oci/cloud_bridge/models/agent_summary.rb', line 306

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


286
287
288
 
# File 'lib/oci/cloud_bridge/models/agent_summary.rb', line 286

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



295
296
297
 
# File 'lib/oci/cloud_bridge/models/agent_summary.rb', line 295

def hash
  [id, display_name, compartment_id, agent_type, agent_version, os_version, time_created, time_updated, time_last_sync_received, heart_beat_status, environment_id, lifecycle_state, lifecycle_details, 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



339
340
341
342
343
344
345
346
347
348
 
# File 'lib/oci/cloud_bridge/models/agent_summary.rb', line 339

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



333
334
335
 
# File 'lib/oci/cloud_bridge/models/agent_summary.rb', line 333

def to_s
  to_hash.to_s
end