Class: Nexpose::ReportTemplateSummary
- Inherits:
-
Object
- Object
- Nexpose::ReportTemplateSummary
- Defined in:
- lib/nexpose/report.rb
Overview
Data object for report template summary information. Not meant for use in creating new templates.
Instance Attribute Summary collapse
-
#built_in ⇒ Object
readonly
Whether the report template is built-in, and therefore cannot be modified.
-
#description ⇒ Object
readonly
Description of the report template.
-
#id ⇒ Object
readonly
The ID of the report template.
-
#name ⇒ Object
readonly
The name of the report template.
-
#scope ⇒ Object
readonly
The visibility (scope) of the report template.
-
#type ⇒ Object
readonly
One of: data|document.
Class Method Summary collapse
Instance Method Summary collapse
-
#initialize(id, name, type, scope, built_in, description) ⇒ ReportTemplateSummary
constructor
A new instance of ReportTemplateSummary.
Constructor Details
#initialize(id, name, type, scope, built_in, description) ⇒ ReportTemplateSummary
Returns a new instance of ReportTemplateSummary.
607 608 609 610 611 612 613 614 |
# File 'lib/nexpose/report.rb', line 607 def initialize(id, name, type, scope, built_in, description) @id = id @name = name @type = type @scope = scope @built_in = built_in @description = description end |
Instance Attribute Details
#built_in ⇒ Object (readonly)
Whether the report template is built-in, and therefore cannot be modified.
603 604 605 |
# File 'lib/nexpose/report.rb', line 603 def built_in @built_in end |
#description ⇒ Object (readonly)
Description of the report template.
605 606 607 |
# File 'lib/nexpose/report.rb', line 605 def description @description end |
#id ⇒ Object (readonly)
The ID of the report template.
592 593 594 |
# File 'lib/nexpose/report.rb', line 592 def id @id end |
#name ⇒ Object (readonly)
The name of the report template.
594 595 596 |
# File 'lib/nexpose/report.rb', line 594 def name @name end |
#scope ⇒ Object (readonly)
The visibility (scope) of the report template. One of: global|silo
601 602 603 |
# File 'lib/nexpose/report.rb', line 601 def scope @scope end |
#type ⇒ Object (readonly)
One of: data|document. With a data template, you can export comma-separated value (CSV) files with vulnerability-based data. With a document template, you can create PDF, RTF, HTML, or XML reports with asset-based information.
599 600 601 |
# File 'lib/nexpose/report.rb', line 599 def type @type end |
Class Method Details
.parse(xml) ⇒ Object
616 617 618 619 620 621 622 623 624 625 |
# File 'lib/nexpose/report.rb', line 616 def self.parse(xml) description = nil xml.elements.each('description') { |desc| description = desc.text } ReportTemplateSummary.new(xml.attributes['id'], xml.attributes['name'], xml.attributes['type'], xml.attributes['scope'], xml.attributes['builtin'] == '1', description) end |