GenerateSecurityAssessmentReportDetails

class oci.data_safe.models.GenerateSecurityAssessmentReportDetails(**kwargs)

Bases: object

The details used to generate a new security assessment report.

Attributes:

FORMAT_PDF

A constant which can be used with the format property of a GenerateSecurityAssessmentReportDetails.

FORMAT_STIGXLS

A constant which can be used with the format property of a GenerateSecurityAssessmentReportDetails.

FORMAT_XLS

A constant which can be used with the format property of a GenerateSecurityAssessmentReportDetails.

format

[Required] Gets the format of this GenerateSecurityAssessmentReportDetails.

is_single_report

Gets the is_single_report of this GenerateSecurityAssessmentReportDetails.

Methods:

__init__(**kwargs)

Initializes a new GenerateSecurityAssessmentReportDetails object with values from keyword arguments.

FORMAT_PDF = 'PDF'

A constant which can be used with the format property of a GenerateSecurityAssessmentReportDetails. This constant has a value of “PDF”

FORMAT_STIGXLS = 'STIGXLS'

A constant which can be used with the format property of a GenerateSecurityAssessmentReportDetails. This constant has a value of “STIGXLS”

FORMAT_XLS = 'XLS'

A constant which can be used with the format property of a GenerateSecurityAssessmentReportDetails. This constant has a value of “XLS”

__init__(**kwargs)

Initializes a new GenerateSecurityAssessmentReportDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • format (str) – The value to assign to the format property of this GenerateSecurityAssessmentReportDetails. Allowed values for this property are: “PDF”, “XLS”, “STIGXLS”

  • is_single_report (bool) – The value to assign to the is_single_report property of this GenerateSecurityAssessmentReportDetails.

property format

[Required] Gets the format of this GenerateSecurityAssessmentReportDetails. Format of the Security Assessment report.

Allowed values for this property are: “PDF”, “XLS”, “STIGXLS”

Returns

The format of this GenerateSecurityAssessmentReportDetails.

Return type

str

property is_single_report

Gets the is_single_report of this GenerateSecurityAssessmentReportDetails. Optional flag controlling the output format of a target group report: - true: Generate a single consolidated report file for the entire target group. - false: Generate a ZIP archive containing one file per target in the group.

Important: - This flag is only applicable when the security assessment OCID refers to a target group assessment (targetType TARGET_DATABASE_GROUP). - If isSingleReport is set to true for an individual target (targetType TARGET_DATABASE), the request will return an error. - If isSingleReport is null or false for an individual target, the value is ignored and the selected output format for the assessment type is generated.

Returns

The is_single_report of this GenerateSecurityAssessmentReportDetails.

Return type

bool