Class: OCI::VulnerabilityScanning::Models::HostScanAgentConfiguration

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/vulnerability_scanning/models/host_scan_agent_configuration.rb

Overview

Agent configuration for host scan agent settings. This model is polymorphic, presenting different configuration options based on selected agent vendor. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Constant Summary collapse

VENDOR_ENUM = 
[
  VENDOR_OCI = 'OCI'.freeze,
  VENDOR_QUALYS = 'QUALYS'.freeze,
  VENDOR_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
VENDOR_TYPE_ENUM = 
[
  VENDOR_TYPE_OCI = 'OCI'.freeze,
  VENDOR_TYPE_QUALYS = 'QUALYS'.freeze,
  VENDOR_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ HostScanAgentConfiguration

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :vendor (String) —

    The value to assign to the #vendor property

  • :vendor_type (String) —

    The value to assign to the #vendor_type property



77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_agent_configuration.rb', line 77

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

  self.vendor_type = attributes[:'vendorType'] if attributes[:'vendorType']

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

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

Instance Attribute Details

#vendor ⇒ String

[Required] Vendor to use for the host scan agent.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_agent_configuration.rb', line 27

def vendor
  @vendor
end

#vendor_type ⇒ String

Vendor to use for the host scan agent.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_agent_configuration.rb', line 31

def vendor_type
  @vendor_type
end

Class Method Details

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_agent_configuration.rb', line 34

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'vendor': :'vendor',
    'vendor_type': :'vendorType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



58
59
60
61
62
63
64
65
66
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_agent_configuration.rb', line 58

def self.get_subtype(object_hash)
  type = object_hash[:'vendor'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::VulnerabilityScanning::Models::HostScanAgentConfigurationQualys' if type == 'QUALYS'
  return 'OCI::VulnerabilityScanning::Models::HostScanAgentConfigurationOCI' if type == 'OCI'

  # TODO: Log a warning when the subtype is not found.
  'OCI::VulnerabilityScanning::Models::HostScanAgentConfiguration'
end

.swagger_types ⇒ Object

Attribute type mapping.



44
45
46
47
48
49
50
51
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_agent_configuration.rb', line 44

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'vendor': :'String',
    'vendor_type': :'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



125
126
127
128
129
130
131
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_agent_configuration.rb', line 125

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

  self.class == other.class &&
    vendor == other.vendor &&
    vendor_type == other.vendor_type
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



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

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


136
137
138
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_agent_configuration.rb', line 136

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



145
146
147
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_agent_configuration.rb', line 145

def hash
  [vendor, vendor_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



189
190
191
192
193
194
195
196
197
198
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_agent_configuration.rb', line 189

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



183
184
185
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_agent_configuration.rb', line 183

def to_s
  to_hash.to_s
end