class OCI::Core::Models::InstanceAgentPluginConfigDetails

The configuration of plugins associated with this instance.

Constants

DESIRED_STATE_ENUM

Attributes

desired_state[R]

[Required] Whether the plugin should be enabled or disabled.

To enable the monitoring and management plugins, the `isMonitoringDisabled` and `isManagementDisabled` attributes must also be set to false.

@return [String]

name[RW]

[Required] The plugin name. To get a list of available plugins, use the {#list_instanceagent_available_plugins list_instanceagent_available_plugins} operation in the Oracle Cloud Agent API. For more information about the available plugins, see [Managing Plugins with Oracle Cloud Agent](docs.cloud.oracle.com/iaas/Content/Compute/Tasks/manage-plugins.htm).

@return [String]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/core/models/instance_agent_plugin_config_details.rb, line 34
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'desired_state': :'desiredState'
    # rubocop:enable Style/SymbolLiteral
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :name The value to assign to the {#name} property @option attributes [String] :desired_state The value to assign to the {#desired_state} property

# File lib/oci/core/models/instance_agent_plugin_config_details.rb, line 61
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.desired_state = attributes[:'desiredState'] if attributes[:'desiredState']

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

  self.desired_state = attributes[:'desired_state'] if attributes[:'desired_state']
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/oci/core/models/instance_agent_plugin_config_details.rb, line 44
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'desired_state': :'String'
    # rubocop:enable Style/SymbolLiteral
  }
end

Public Instance Methods

==(other) click to toggle source

Checks equality by comparing each attribute. @param [Object] other the other object to be compared

# File lib/oci/core/models/instance_agent_plugin_config_details.rb, line 96
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    name == other.name &&
    desired_state == other.desired_state
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/oci/core/models/instance_agent_plugin_config_details.rb, line 127
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
desired_state=(desired_state) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] desired_state Object to be assigned

# File lib/oci/core/models/instance_agent_plugin_config_details.rb, line 80
def desired_state=(desired_state)
  # rubocop:disable Style/ConditionalAssignment
  if desired_state && !DESIRED_STATE_ENUM.include?(desired_state)
    OCI.logger.debug("Unknown value for 'desired_state' [" + desired_state + "]. Mapping to 'DESIRED_STATE_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @desired_state = DESIRED_STATE_UNKNOWN_ENUM_VALUE
  else
    @desired_state = desired_state
  end
  # rubocop:enable Style/ConditionalAssignment
end
eql?(other) click to toggle source

@see the `==` method @param [Object] other the other object to be compared

# File lib/oci/core/models/instance_agent_plugin_config_details.rb, line 107
def eql?(other)
  self == other
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/oci/core/models/instance_agent_plugin_config_details.rb, line 116
def hash
  [name, desired_state].hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/oci/core/models/instance_agent_plugin_config_details.rb, line 160
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/oci/core/models/instance_agent_plugin_config_details.rb, line 154
def to_s
  to_hash.to_s
end

Private Instance Methods

_to_hash(value) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/oci/core/models/instance_agent_plugin_config_details.rb, line 177
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end