Class: OCI::Adm::Models::CreateVulnerabilityAuditDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/adm/models/create_vulnerability_audit_details.rb

Overview

Details to create a vulnerability audit.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateVulnerabilityAuditDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/oci/adm/models/create_vulnerability_audit_details.rb', line 106

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

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

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

  self.application_dependencies = attributes[:'applicationDependencies'] if attributes[:'applicationDependencies']

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

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

  self.build_type = attributes[:'buildType'] if attributes[:'buildType']

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

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

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

  self.usage_data = attributes[:'usageData'] if attributes[:'usageData']

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

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

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

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

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

Instance Attribute Details

#application_dependencies ⇒ Array<OCI::Adm::Models::ApplicationDependency>

List of application dependencies (without vulnerabilities).

Returns:



23
24
25
 
# File 'lib/oci/adm/models/create_vulnerability_audit_details.rb', line 23

def application_dependencies
  @application_dependencies
end

#build_type ⇒ String

The type of the build tool is restricted to only two values MAVEN or UNSET. Use UNSET when the list of application dependencies is not Maven-related or is a mix of Maven and other ecosystems. This option is soon to be deprecated.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/adm/models/create_vulnerability_audit_details.rb', line 27

def build_type
  @build_type
end

#compartment_id ⇒ String

The compartment Oracle Cloud identifier (OCID) of the vulnerability audit. If compartment identifier is not provided the compartment of the associated knowledge base will be used instead.

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/adm/models/create_vulnerability_audit_details.rb', line 19

def compartment_id
  @compartment_id
end

#configuration ⇒ OCI::Adm::Models::VulnerabilityAuditConfiguration

Returns:



30
31
32
 
# File 'lib/oci/adm/models/create_vulnerability_audit_details.rb', line 30

def configuration
  @configuration
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


52
53
54
 
# File 'lib/oci/adm/models/create_vulnerability_audit_details.rb', line 52

def defined_tags
  @defined_tags
end

#display_name ⇒ String

The name of the vulnerability audit.

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/adm/models/create_vulnerability_audit_details.rb', line 37

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


46
47
48
 
# File 'lib/oci/adm/models/create_vulnerability_audit_details.rb', line 46

def freeform_tags
  @freeform_tags
end

#knowledge_base_id ⇒ String

[Required] The Oracle Cloud identifier (OCID) of the knowledge base.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/adm/models/create_vulnerability_audit_details.rb', line 13

def knowledge_base_id
  @knowledge_base_id
end

#source ⇒ OCI::Adm::Models::VulnerabilityAuditSource

Returns:



40
41
42
 
# File 'lib/oci/adm/models/create_vulnerability_audit_details.rb', line 40

def source
  @source
end

#usage_data ⇒ OCI::Adm::Models::UsageDataDetails

Returns:



33
34
35
 
# File 'lib/oci/adm/models/create_vulnerability_audit_details.rb', line 33

def usage_data
  @usage_data
end

Class Method Details

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/oci/adm/models/create_vulnerability_audit_details.rb', line 55

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'knowledge_base_id': :'knowledgeBaseId',
    'compartment_id': :'compartmentId',
    'application_dependencies': :'applicationDependencies',
    'build_type': :'buildType',
    'configuration': :'configuration',
    'usage_data': :'usageData',
    'display_name': :'displayName',
    'source': :'source',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/oci/adm/models/create_vulnerability_audit_details.rb', line 73

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'knowledge_base_id': :'String',
    'compartment_id': :'String',
    'application_dependencies': :'Array<OCI::Adm::Models::ApplicationDependency>',
    'build_type': :'String',
    'configuration': :'OCI::Adm::Models::VulnerabilityAuditConfiguration',
    'usage_data': :'OCI::Adm::Models::UsageDataDetails',
    'display_name': :'String',
    'source': :'OCI::Adm::Models::VulnerabilityAuditSource',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # 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



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/oci/adm/models/create_vulnerability_audit_details.rb', line 172

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

  self.class == other.class &&
    knowledge_base_id == other.knowledge_base_id &&
    compartment_id == other.compartment_id &&
    application_dependencies == other.application_dependencies &&
    build_type == other.build_type &&
    configuration == other.configuration &&
    usage_data == other.usage_data &&
    display_name == other.display_name &&
    source == other.source &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
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



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/oci/adm/models/create_vulnerability_audit_details.rb', line 211

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


191
192
193
 
# File 'lib/oci/adm/models/create_vulnerability_audit_details.rb', line 191

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



200
201
202
 
# File 'lib/oci/adm/models/create_vulnerability_audit_details.rb', line 200

def hash
  [knowledge_base_id, compartment_id, application_dependencies, build_type, configuration, usage_data, display_name, source, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



244
245
246
247
248
249
250
251
252
253
 
# File 'lib/oci/adm/models/create_vulnerability_audit_details.rb', line 244

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



238
239
240
 
# File 'lib/oci/adm/models/create_vulnerability_audit_details.rb', line 238

def to_s
  to_hash.to_s
end