Class: OCI::CloudBridge::Models::Agent

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

Overview

Description of Agent.

Constant Summary collapse

AGENT_TYPE_ENUM = 
[
  AGENT_TYPE_APPLIANCE = 'APPLIANCE'.freeze,
  AGENT_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
HEART_BEAT_STATUS_ENUM = 
[
  HEART_BEAT_STATUS_HEALTHY = 'HEALTHY'.freeze,
  HEART_BEAT_STATUS_UNHEALTHY = 'UNHEALTHY'.freeze,
  HEART_BEAT_STATUS_FAILED = 'FAILED'.freeze,
  HEART_BEAT_STATUS_INACTIVE = 'INACTIVE'.freeze,
  HEART_BEAT_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.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 = {}) ⇒ Agent

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

  • :agent_pub_key (String) —

    The value to assign to the #agent_pub_key property

  • :time_expire_agent_key_in_ms (DateTime) —

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

  • :plugin_list (Array<OCI::CloudBridge::Models::PluginSummary>) —

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



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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/oci/cloud_bridge/models/agent.rb', line 198

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

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

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

  self.time_expire_agent_key_in_ms = attributes[:'timeExpireAgentKeyInMs'] if attributes[:'timeExpireAgentKeyInMs']

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

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

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

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

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

  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_pub_key ⇒ String

Resource principal public key.

Returns:

  • (String) 


80
81
82
 
# File 'lib/oci/cloud_bridge/models/agent.rb', line 80

def agent_pub_key
  @agent_pub_key
end

#agent_type ⇒ String

[Required] Type of the Agent.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/cloud_bridge/models/agent.rb', line 48

def agent_type
  @agent_type
end

#agent_version ⇒ String

[Required] Agent identifier.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/cloud_bridge/models/agent.rb', line 52

def agent_version
  @agent_version
end

#compartment_id ⇒ String

[Required] Compartment identifier.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/cloud_bridge/models/agent.rb', line 44

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


110
111
112
 
# File 'lib/oci/cloud_bridge/models/agent.rb', line 110

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] Agent identifier, can be renamed.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/cloud_bridge/models/agent.rb', line 40

def display_name
  @display_name
end

#environment_id ⇒ String

[Required] Environment identifier.

Returns:

  • (String) 


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

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


103
104
105
 
# File 'lib/oci/cloud_bridge/models/agent.rb', line 103

def freeform_tags
  @freeform_tags
end

#heart_beat_status ⇒ String

The current heartbeat status of the Agent based on its timeLastSyncReceived value.

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/cloud_bridge/models/agent.rb', line 72

def heart_beat_status
  @heart_beat_status
end

#id ⇒ String

[Required] Unique identifier that is immutable on creation.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/cloud_bridge/models/agent.rb', line 36

def id
  @id
end

#lifecycle_details ⇒ String

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

Returns:

  • (String) 


92
93
94
 
# File 'lib/oci/cloud_bridge/models/agent.rb', line 92

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

[Required] The current state of the Agent.

Returns:

  • (String) 


88
89
90
 
# File 'lib/oci/cloud_bridge/models/agent.rb', line 88

def lifecycle_state
  @lifecycle_state
end

#os_version ⇒ String

[Required] OS version.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/cloud_bridge/models/agent.rb', line 56

def os_version
  @os_version
end

#plugin_list ⇒ Array<OCI::CloudBridge::Models::PluginSummary>

List of plugins associated with the agent.

Returns:



96
97
98
 
# File 'lib/oci/cloud_bridge/models/agent.rb', line 96

def plugin_list
  @plugin_list
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>>) 


117
118
119
 
# File 'lib/oci/cloud_bridge/models/agent.rb', line 117

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


60
61
62
 
# File 'lib/oci/cloud_bridge/models/agent.rb', line 60

def time_created
  @time_created
end

#time_expire_agent_key_in_ms ⇒ DateTime

The time since epoch for when the public key will expire. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


84
85
86
 
# File 'lib/oci/cloud_bridge/models/agent.rb', line 84

def time_expire_agent_key_in_ms
  @time_expire_agent_key_in_ms
end

#time_last_sync_received ⇒ DateTime

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

Returns:

  • (DateTime) 


68
69
70
 
# File 'lib/oci/cloud_bridge/models/agent.rb', line 68

def time_last_sync_received
  @time_last_sync_received
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


64
65
66
 
# File 'lib/oci/cloud_bridge/models/agent.rb', line 64

def time_updated
  @time_updated
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
 
# File 'lib/oci/cloud_bridge/models/agent.rb', line 120

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',
    'agent_pub_key': :'agentPubKey',
    'time_expire_agent_key_in_ms': :'timeExpireAgentKeyInMs',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'plugin_list': :'pluginList',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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',
    'agent_pub_key': :'String',
    'time_expire_agent_key_in_ms': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'plugin_list': :'Array<OCI::CloudBridge::Models::PluginSummary>',
    '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



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/oci/cloud_bridge/models/agent.rb', line 361

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 &&
    agent_pub_key == other.agent_pub_key &&
    time_expire_agent_key_in_ms == other.time_expire_agent_key_in_ms &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    plugin_list == other.plugin_list &&
    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



409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
 
# File 'lib/oci/cloud_bridge/models/agent.rb', line 409

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


389
390
391
 
# File 'lib/oci/cloud_bridge/models/agent.rb', line 389

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



398
399
400
 
# File 'lib/oci/cloud_bridge/models/agent.rb', line 398

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, agent_pub_key, time_expire_agent_key_in_ms, lifecycle_state, lifecycle_details, plugin_list, 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



442
443
444
445
446
447
448
449
450
451
 
# File 'lib/oci/cloud_bridge/models/agent.rb', line 442

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



436
437
438
 
# File 'lib/oci/cloud_bridge/models/agent.rb', line 436

def to_s
  to_hash.to_s
end