Class: OCI::VulnerabilityScanning::Models::ApplicationScanSettings

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

Overview

Agent scan settings for applicaiton scan

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ApplicationScanSettings

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/oci/vulnerability_scanning/models/application_scan_settings.rb', line 59

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

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

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

  self.is_enabled = attributes[:'isEnabled'] unless attributes[:'isEnabled'].nil?

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

  self.is_enabled = attributes[:'is_enabled'] unless attributes[:'is_enabled'].nil?

  self.folders_to_scan = attributes[:'foldersToScan'] if attributes[:'foldersToScan']

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

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

Instance Attribute Details

#application_scan_recurrence ⇒ String

[Required] Scan recurrences in RFC-5545 section 3.3.10 format. Only supported input are weekly, biweekly, monthly listed below FREQ=WEEKLY;WKST=<weekday>;INTERVAL=1 - This weekly scan on the specified weekday (e.g. Sunday) FREQ=WEEKLY;WKST=<weekday>;INTERVAL=2 - This bi-weekly scan on the specified weekday (e.g. Sunday) FREQ=MONTHLY;WKST=<weekday>;INTERVAL=1 - This monthly scan on the specified weekday (e.g. Sunday, starting from the next such weekday based on the time of setting creation)

Returns:

  • (String) 


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

def application_scan_recurrence
  @application_scan_recurrence
end

#folders_to_scan ⇒ Array<OCI::VulnerabilityScanning::Models::FolderToScan>

[Required] List of folders selected for scanning

Returns:



26
27
28
 
# File 'lib/oci/vulnerability_scanning/models/application_scan_settings.rb', line 26

def folders_to_scan
  @folders_to_scan
end

#is_enabled ⇒ BOOLEAN

[Required] Enable or disable application scan

Returns:

  • (BOOLEAN) 


22
23
24
 
# File 'lib/oci/vulnerability_scanning/models/application_scan_settings.rb', line 22

def is_enabled
  @is_enabled
end

Class Method Details

.attribute_map ⇒ Object

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



29
30
31
32
33
34
35
36
37
 
# File 'lib/oci/vulnerability_scanning/models/application_scan_settings.rb', line 29

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'application_scan_recurrence': :'applicationScanRecurrence',
    'is_enabled': :'isEnabled',
    'folders_to_scan': :'foldersToScan'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



40
41
42
43
44
45
46
47
48
 
# File 'lib/oci/vulnerability_scanning/models/application_scan_settings.rb', line 40

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'application_scan_recurrence': :'String',
    'is_enabled': :'BOOLEAN',
    'folders_to_scan': :'Array<OCI::VulnerabilityScanning::Models::FolderToScan>'
    # 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



91
92
93
94
95
96
97
98
 
# File 'lib/oci/vulnerability_scanning/models/application_scan_settings.rb', line 91

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

  self.class == other.class &&
    application_scan_recurrence == other.application_scan_recurrence &&
    is_enabled == other.is_enabled &&
    folders_to_scan == other.folders_to_scan
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



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/oci/vulnerability_scanning/models/application_scan_settings.rb', line 123

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


103
104
105
 
# File 'lib/oci/vulnerability_scanning/models/application_scan_settings.rb', line 103

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



112
113
114
 
# File 'lib/oci/vulnerability_scanning/models/application_scan_settings.rb', line 112

def hash
  [application_scan_recurrence, is_enabled, folders_to_scan].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



156
157
158
159
160
161
162
163
164
165
 
# File 'lib/oci/vulnerability_scanning/models/application_scan_settings.rb', line 156

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



150
151
152
 
# File 'lib/oci/vulnerability_scanning/models/application_scan_settings.rb', line 150

def to_s
  to_hash.to_s
end