Class: OCI::VulnerabilityScanning::Models::HostScanAgentConfigurationQualys

Inherits:
HostScanAgentConfiguration show all
Defined in:
lib/oci/vulnerability_scanning/models/host_scan_agent_configuration_qualys.rb

Overview

Agent configuration options for vendor Qualys.

Constant Summary

Constants inherited from HostScanAgentConfiguration

OCI::VulnerabilityScanning::Models::HostScanAgentConfiguration::VENDOR_ENUM, OCI::VulnerabilityScanning::Models::HostScanAgentConfiguration::VENDOR_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from HostScanAgentConfiguration

#vendor, #vendor_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from HostScanAgentConfiguration

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ HostScanAgentConfigurationQualys

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :vendor_type (String) —

    The value to assign to the #vendor_type proprety

  • :vault_secret_id (String) —

    The value to assign to the #vault_secret_id property

  • :should_un_install (BOOLEAN) —

    The value to assign to the #should_un_install property



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_agent_configuration_qualys.rb', line 53

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['vendor'] = 'QUALYS'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.vault_secret_id = attributes[:'vaultSecretId'] if attributes[:'vaultSecretId']

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

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

  self.should_un_install = attributes[:'shouldUnInstall'] unless attributes[:'shouldUnInstall'].nil?

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

  self.should_un_install = attributes[:'should_un_install'] unless attributes[:'should_un_install'].nil?
end

Instance Attribute Details

#should_un_install ⇒ BOOLEAN

[Required] Boolean flag letting agent know if it should un-install the Qualys agent when it is stopped.

Returns:

  • (BOOLEAN) 


18
19
20
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_agent_configuration_qualys.rb', line 18

def should_un_install
  @should_un_install
end

#vault_secret_id ⇒ String

[Required] Vault secret OCID which stores license information. Content inside this secret in vault would be base64 string containing information about customer's Qualys susbcription license.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_agent_configuration_qualys.rb', line 14

def vault_secret_id
  @vault_secret_id
end

Class Method Details

.attribute_map ⇒ Object

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



21
22
23
24
25
26
27
28
29
30
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_agent_configuration_qualys.rb', line 21

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

.swagger_types ⇒ Object

Attribute type mapping.



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

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



83
84
85
86
87
88
89
90
91
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_agent_configuration_qualys.rb', line 83

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

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



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_agent_configuration_qualys.rb', line 116

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


96
97
98
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_agent_configuration_qualys.rb', line 96

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



105
106
107
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_agent_configuration_qualys.rb', line 105

def hash
  [vendor, vendor_type, vault_secret_id, should_un_install].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



149
150
151
152
153
154
155
156
157
158
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_agent_configuration_qualys.rb', line 149

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



143
144
145
 
# File 'lib/oci/vulnerability_scanning/models/host_scan_agent_configuration_qualys.rb', line 143

def to_s
  to_hash.to_s
end