class OCI::LogAnalytics::Models::AssociableEntity

Entity details including whether or not it is eligible for association with the source.

Constants

ELIGIBILITY_STATUS_ENUM

Attributes

agent_id[RW]

The OCID of the Management Agent. @return [String]

eligibility_status[R]

This field indicates whether the entity is (in)eligible to be associated with this source.

@return [String]

entity_id[RW]

The entity OCID. @return [String]

entity_name[RW]

The name of the entity. @return [String]

entity_type_display_name[RW]

The display name of the entity type. @return [String]

entity_type_name[RW]

The type name of the entity. @return [String]

host[RW]

The entity host. @return [String]

ineligibility_details[RW]

The reason the entity is not eligible for association. @return [String]

Public Class Methods

attribute_map() click to toggle source

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

# File lib/oci/log_analytics/models/associable_entity.rb, line 51
def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'entity_id': :'entityId',
    'entity_name': :'entityName',
    'entity_type_name': :'entityTypeName',
    'entity_type_display_name': :'entityTypeDisplayName',
    'host': :'host',
    'agent_id': :'agentId',
    'eligibility_status': :'eligibilityStatus',
    'ineligibility_details': :'ineligibilityDetails'
    # 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] :entity_id The value to assign to the {#entity_id} property @option attributes [String] :entity_name The value to assign to the {#entity_name} property @option attributes [String] :entity_type_name The value to assign to the {#entity_type_name} property @option attributes [String] :entity_type_display_name The value to assign to the {#entity_type_display_name} property @option attributes [String] :host The value to assign to the {#host} property @option attributes [String] :agent_id The value to assign to the {#agent_id} property @option attributes [String] :eligibility_status The value to assign to the {#eligibility_status} property @option attributes [String] :ineligibility_details The value to assign to the {#ineligibility_details} property

# File lib/oci/log_analytics/models/associable_entity.rb, line 96
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.entity_id = attributes[:'entityId'] if attributes[:'entityId']

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

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

  self.entity_name = attributes[:'entityName'] if attributes[:'entityName']

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

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

  self.entity_type_name = attributes[:'entityTypeName'] if attributes[:'entityTypeName']

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

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

  self.entity_type_display_name = attributes[:'entityTypeDisplayName'] if attributes[:'entityTypeDisplayName']

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

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

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

  self.agent_id = attributes[:'agentId'] if attributes[:'agentId']

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

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

  self.eligibility_status = attributes[:'eligibilityStatus'] if attributes[:'eligibilityStatus']

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

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

  self.ineligibility_details = attributes[:'ineligibilityDetails'] if attributes[:'ineligibilityDetails']

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

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

Attribute type mapping.

# File lib/oci/log_analytics/models/associable_entity.rb, line 67
def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'entity_id': :'String',
    'entity_name': :'String',
    'entity_type_name': :'String',
    'entity_type_display_name': :'String',
    'host': :'String',
    'agent_id': :'String',
    'eligibility_status': :'String',
    'ineligibility_details': :'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/log_analytics/models/associable_entity.rb, line 167
def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    entity_id == other.entity_id &&
    entity_name == other.entity_name &&
    entity_type_name == other.entity_type_name &&
    entity_type_display_name == other.entity_type_display_name &&
    host == other.host &&
    agent_id == other.agent_id &&
    eligibility_status == other.eligibility_status &&
    ineligibility_details == other.ineligibility_details
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/log_analytics/models/associable_entity.rb, line 204
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
eligibility_status=(eligibility_status) click to toggle source

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

# File lib/oci/log_analytics/models/associable_entity.rb, line 151
def eligibility_status=(eligibility_status)
  # rubocop:disable Style/ConditionalAssignment
  if eligibility_status && !ELIGIBILITY_STATUS_ENUM.include?(eligibility_status)
    OCI.logger.debug("Unknown value for 'eligibility_status' [" + eligibility_status + "]. Mapping to 'ELIGIBILITY_STATUS_UNKNOWN_ENUM_VALUE'") if OCI.logger
    @eligibility_status = ELIGIBILITY_STATUS_UNKNOWN_ENUM_VALUE
  else
    @eligibility_status = eligibility_status
  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/log_analytics/models/associable_entity.rb, line 184
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/log_analytics/models/associable_entity.rb, line 193
def hash
  [entity_id, entity_name, entity_type_name, entity_type_display_name, host, agent_id, eligibility_status, ineligibility_details].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/log_analytics/models/associable_entity.rb, line 237
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/log_analytics/models/associable_entity.rb, line 231
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/log_analytics/models/associable_entity.rb, line 254
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