Class: OCI::ComputeInstanceAgent::Models::InstanceAgentPlugin

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/compute_instance_agent/models/instance_agent_plugin.rb

Overview

An Oracle Cloud Agent plugin.

Constant Summary collapse

STATUS_ENUM = 
[
  STATUS_RUNNING = 'RUNNING'.freeze,
  STATUS_STOPPED = 'STOPPED'.freeze,
  STATUS_NOT_SUPPORTED = 'NOT_SUPPORTED'.freeze,
  STATUS_INVALID = 'INVALID'.freeze,
  STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InstanceAgentPlugin

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :name (String) —

    The value to assign to the #name property

  • :status (String) —

    The value to assign to the #status property

  • :time_last_updated_utc (DateTime) —

    The value to assign to the #time_last_updated_utc property

  • :message (String) —

    The value to assign to the #message property



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_plugin.rb', line 83

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

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

  self.time_last_updated_utc = attributes[:'timeLastUpdatedUtc'] if attributes[:'timeLastUpdatedUtc']

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

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

  self.message = attributes[:'message'] if attributes[:'message']
end

Instance Attribute Details

#message ⇒ String

An optional message from the plugin.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_plugin.rb', line 47

def message
  @message
end

#name ⇒ String

[Required] The plugin name.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_plugin.rb', line 22

def name
  @name
end

#status ⇒ String

[Required] The plugin status.

These are the available statuses: * RUNNING - The plugin is running. * STOPPED - The plugin is stopped. * NOT_SUPPORTED - The plugin is not supported on this platform. * INVALID - The plugin status is not recognizable by the service.

To determine whether the plugin is enabled, use the get_instance operation in the Core Services API. To enable or disable the plugin, use the update_instance operation in the Core Services API.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_plugin.rb', line 39

def status
  @status
end

#time_last_updated_utc ⇒ DateTime

[Required] The last updated time of the plugin, in UTC.

Returns:

  • (DateTime) 


43
44
45
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_plugin.rb', line 43

def time_last_updated_utc
  @time_last_updated_utc
end

Class Method Details

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
58
59
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_plugin.rb', line 50

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'status': :'status',
    'time_last_updated_utc': :'timeLastUpdatedUtc',
    'message': :'message'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_plugin.rb', line 62

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'status': :'String',
    'time_last_updated_utc': :'DateTime',
    'message': :'String'
    # 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



122
123
124
125
126
127
128
129
130
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_plugin.rb', line 122

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

  self.class == other.class &&
    name == other.name &&
    status == other.status &&
    time_last_updated_utc == other.time_last_updated_utc &&
    message == other.message
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



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_plugin.rb', line 155

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


135
136
137
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_plugin.rb', line 135

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



144
145
146
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_plugin.rb', line 144

def hash
  [name, status, time_last_updated_utc, message].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



188
189
190
191
192
193
194
195
196
197
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_plugin.rb', line 188

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



182
183
184
 
# File 'lib/oci/compute_instance_agent/models/instance_agent_plugin.rb', line 182

def to_s
  to_hash.to_s
end