class OCI::Core::Models::LaunchInstanceAgentConfigDetails

Configuration options for the Oracle Cloud Agent software running on the instance.

Attributes

are_all_plugins_disabled[RW]

Whether Oracle Cloud Agent can run all the available plugins. This includes the management and monitoring plugins.

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 [BOOLEAN]

is_management_disabled[RW]

Whether Oracle Cloud Agent can run all the available management plugins. Default value is false (management plugins are enabled).

These are the management plugins: OS Management Service Agent and Compute Instance Run Command.

The management plugins are controlled by this parameter and by the per-plugin configuration in the `pluginsConfig` object.

  • If `isManagementDisabled` is true, all of the management plugins are disabled, regardless of

the per-plugin configuration.

  • If `isManagementDisabled` is false, all of the management plugins are enabled. You

can optionally disable individual management plugins by providing a value in the `pluginsConfig` object.

@return [BOOLEAN]

is_monitoring_disabled[RW]

Whether Oracle Cloud Agent can gather performance metrics and monitor the instance using the monitoring plugins. Default value is false (monitoring plugins are enabled).

These are the monitoring plugins: Compute Instance Monitoring and Custom Logs Monitoring.

The monitoring plugins are controlled by this parameter and by the per-plugin configuration in the `pluginsConfig` object.

  • If `isMonitoringDisabled` is true, all of the monitoring plugins are disabled, regardless of

the per-plugin configuration.

  • If `isMonitoringDisabled` is false, all of the monitoring plugins are enabled. You

can optionally disable individual monitoring plugins by providing a value in the `pluginsConfig` object.

@return [BOOLEAN]

plugins_config[RW]

The configuration of plugins associated with this instance. @return [Array<OCI::Core::Models::InstanceAgentPluginConfigDetails>]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/core/models/launch_instance_agent_config_details.rb, line 62
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'is_monitoring_disabled': :'isMonitoringDisabled',
    'is_management_disabled': :'isManagementDisabled',
    'are_all_plugins_disabled': :'areAllPluginsDisabled',
    'plugins_config': :'pluginsConfig'
    # 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 [BOOLEAN] :is_monitoring_disabled The value to assign to the {#is_monitoring_disabled} property @option attributes [BOOLEAN] :is_management_disabled The value to assign to the {#is_management_disabled} property @option attributes [BOOLEAN] :are_all_plugins_disabled The value to assign to the {#are_all_plugins_disabled} property @option attributes [Array<OCI::Core::Models::InstanceAgentPluginConfigDetails>] :plugins_config The value to assign to the {#plugins_config} property

# File lib/oci/core/models/launch_instance_agent_config_details.rb, line 95
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.is_monitoring_disabled = attributes[:'isMonitoringDisabled'] unless attributes[:'isMonitoringDisabled'].nil?
  self.is_monitoring_disabled = false if is_monitoring_disabled.nil? && !attributes.key?(:'isMonitoringDisabled') # rubocop:disable Style/StringLiterals

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

  self.is_monitoring_disabled = attributes[:'is_monitoring_disabled'] unless attributes[:'is_monitoring_disabled'].nil?
  self.is_monitoring_disabled = false if is_monitoring_disabled.nil? && !attributes.key?(:'isMonitoringDisabled') && !attributes.key?(:'is_monitoring_disabled') # rubocop:disable Style/StringLiterals

  self.is_management_disabled = attributes[:'isManagementDisabled'] unless attributes[:'isManagementDisabled'].nil?
  self.is_management_disabled = false if is_management_disabled.nil? && !attributes.key?(:'isManagementDisabled') # rubocop:disable Style/StringLiterals

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

  self.is_management_disabled = attributes[:'is_management_disabled'] unless attributes[:'is_management_disabled'].nil?
  self.is_management_disabled = false if is_management_disabled.nil? && !attributes.key?(:'isManagementDisabled') && !attributes.key?(:'is_management_disabled') # rubocop:disable Style/StringLiterals

  self.are_all_plugins_disabled = attributes[:'areAllPluginsDisabled'] unless attributes[:'areAllPluginsDisabled'].nil?
  self.are_all_plugins_disabled = false if are_all_plugins_disabled.nil? && !attributes.key?(:'areAllPluginsDisabled') # rubocop:disable Style/StringLiterals

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

  self.are_all_plugins_disabled = attributes[:'are_all_plugins_disabled'] unless attributes[:'are_all_plugins_disabled'].nil?
  self.are_all_plugins_disabled = false if are_all_plugins_disabled.nil? && !attributes.key?(:'areAllPluginsDisabled') && !attributes.key?(:'are_all_plugins_disabled') # rubocop:disable Style/StringLiterals

  self.plugins_config = attributes[:'pluginsConfig'] if attributes[:'pluginsConfig']

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

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

Attribute type mapping.

# File lib/oci/core/models/launch_instance_agent_config_details.rb, line 74
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'is_monitoring_disabled': :'BOOLEAN',
    'is_management_disabled': :'BOOLEAN',
    'are_all_plugins_disabled': :'BOOLEAN',
    'plugins_config': :'Array<OCI::Core::Models::InstanceAgentPluginConfigDetails>'
    # 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/launch_instance_agent_config_details.rb, line 139
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    is_monitoring_disabled == other.is_monitoring_disabled &&
    is_management_disabled == other.is_management_disabled &&
    are_all_plugins_disabled == other.are_all_plugins_disabled &&
    plugins_config == other.plugins_config
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/launch_instance_agent_config_details.rb, line 172
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) click to toggle source

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

# File lib/oci/core/models/launch_instance_agent_config_details.rb, line 152
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/launch_instance_agent_config_details.rb, line 161
def hash
  [is_monitoring_disabled, is_management_disabled, are_all_plugins_disabled, plugins_config].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/launch_instance_agent_config_details.rb, line 205
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/launch_instance_agent_config_details.rb, line 199
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/launch_instance_agent_config_details.rb, line 222
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