Interface FindingsOutput.Builder

All Superinterfaces:
Buildable, CopyableBuilder<FindingsOutput.Builder,FindingsOutput>, SdkBuilder<FindingsOutput.Builder,FindingsOutput>, SdkPojo
Enclosing class:
FindingsOutput
@Mutable @NotThreadSafe public static interface FindingsOutput.Builder extends SdkPojo, CopyableBuilder<FindingsOutput.Builder,FindingsOutput>

  • Method Details

    • format

      FindingsOutput.Builder format(String format)

      The output format of the export. CSV produces comma-separated rows that are suitable for spreadsheets and analysis tools. OCSF_JSON produces newline-delimited JSON records in the Open Cybersecurity Schema Framework (OCSF) format used elsewhere in Security Hub.

      Parameters:
      format - The output format of the export. CSV produces comma-separated rows that are suitable for spreadsheets and analysis tools. OCSF_JSON produces newline-delimited JSON records in the Open Cybersecurity Schema Framework (OCSF) format used elsewhere in Security Hub.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • format

      FindingsOutput.Builder format(FindingsExportFormat format)

      The output format of the export. CSV produces comma-separated rows that are suitable for spreadsheets and analysis tools. OCSF_JSON produces newline-delimited JSON records in the Open Cybersecurity Schema Framework (OCSF) format used elsewhere in Security Hub.

      Parameters:
      format - The output format of the export. CSV produces comma-separated rows that are suitable for spreadsheets and analysis tools. OCSF_JSON produces newline-delimited JSON records in the Open Cybersecurity Schema Framework (OCSF) format used elsewhere in Security Hub.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • filters

      FindingsOutput.Builder filters(OcsfFindingFilters filters)

      An optional set of OCSF finding filters that restrict which findings are exported. The filter structure is the same as the one used by GetFindingsV2. If you omit this member, Security Hub exports all findings available to the caller. When echoed by GetExportJobV2, relative date ranges are returned unresolved.

      Parameters:
      filters - An optional set of OCSF finding filters that restrict which findings are exported. The filter structure is the same as the one used by GetFindingsV2. If you omit this member, Security Hub exports all findings available to the caller. When echoed by GetExportJobV2, relative date ranges are returned unresolved.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      default FindingsOutput.Builder filters(Consumer<OcsfFindingFilters.Builder> filters)

      An optional set of OCSF finding filters that restrict which findings are exported. The filter structure is the same as the one used by GetFindingsV2. If you omit this member, Security Hub exports all findings available to the caller. When echoed by GetExportJobV2, relative date ranges are returned unresolved.

      This is a convenience method that creates an instance of the OcsfFindingFilters.Builder avoiding the need to create one manually via OcsfFindingFilters.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(OcsfFindingFilters).

      Parameters:
      filters - a consumer that will call methods on OcsfFindingFilters.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • selectedFieldsWithStrings

      FindingsOutput.Builder selectedFieldsWithStrings(Collection<String> selectedFields)

      The OCSF finding fields to include in the export, specified as OCSF field paths (for example, finding_info.title or severity). You can specify from 1 to 50 fields.

      Whether this parameter is required depends on the value of Format:

      • CSV – Required. The field paths that you specify become the columns of the output, in the order that you provide them. If you omit this parameter, the request returns a ValidationException.

      • OCSF_JSON – Not supported. This format includes each finding in full, so field selection doesn't apply. If you specify this parameter, the request returns a ValidationException.

      Parameters:
      selectedFields - The OCSF finding fields to include in the export, specified as OCSF field paths (for example, finding_info.title or severity). You can specify from 1 to 50 fields.

      Whether this parameter is required depends on the value of Format:

      • CSV – Required. The field paths that you specify become the columns of the output, in the order that you provide them. If you omit this parameter, the request returns a ValidationException.

      • OCSF_JSON – Not supported. This format includes each finding in full, so field selection doesn't apply. If you specify this parameter, the request returns a ValidationException.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • selectedFieldsWithStrings

      FindingsOutput.Builder selectedFieldsWithStrings(String... selectedFields)

      The OCSF finding fields to include in the export, specified as OCSF field paths (for example, finding_info.title or severity). You can specify from 1 to 50 fields.

      Whether this parameter is required depends on the value of Format:

      • CSV – Required. The field paths that you specify become the columns of the output, in the order that you provide them. If you omit this parameter, the request returns a ValidationException.

      • OCSF_JSON – Not supported. This format includes each finding in full, so field selection doesn't apply. If you specify this parameter, the request returns a ValidationException.

      Parameters:
      selectedFields - The OCSF finding fields to include in the export, specified as OCSF field paths (for example, finding_info.title or severity). You can specify from 1 to 50 fields.

      Whether this parameter is required depends on the value of Format:

      • CSV – Required. The field paths that you specify become the columns of the output, in the order that you provide them. If you omit this parameter, the request returns a ValidationException.

      • OCSF_JSON – Not supported. This format includes each finding in full, so field selection doesn't apply. If you specify this parameter, the request returns a ValidationException.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • selectedFields

      FindingsOutput.Builder selectedFields(Collection<FindingsSelectableField> selectedFields)

      The OCSF finding fields to include in the export, specified as OCSF field paths (for example, finding_info.title or severity). You can specify from 1 to 50 fields.

      Whether this parameter is required depends on the value of Format:

      • CSV – Required. The field paths that you specify become the columns of the output, in the order that you provide them. If you omit this parameter, the request returns a ValidationException.

      • OCSF_JSON – Not supported. This format includes each finding in full, so field selection doesn't apply. If you specify this parameter, the request returns a ValidationException.

      Parameters:
      selectedFields - The OCSF finding fields to include in the export, specified as OCSF field paths (for example, finding_info.title or severity). You can specify from 1 to 50 fields.

      Whether this parameter is required depends on the value of Format:

      • CSV – Required. The field paths that you specify become the columns of the output, in the order that you provide them. If you omit this parameter, the request returns a ValidationException.

      • OCSF_JSON – Not supported. This format includes each finding in full, so field selection doesn't apply. If you specify this parameter, the request returns a ValidationException.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • selectedFields

      FindingsOutput.Builder selectedFields(FindingsSelectableField... selectedFields)

      The OCSF finding fields to include in the export, specified as OCSF field paths (for example, finding_info.title or severity). You can specify from 1 to 50 fields.

      Whether this parameter is required depends on the value of Format:

      • CSV – Required. The field paths that you specify become the columns of the output, in the order that you provide them. If you omit this parameter, the request returns a ValidationException.

      • OCSF_JSON – Not supported. This format includes each finding in full, so field selection doesn't apply. If you specify this parameter, the request returns a ValidationException.

      Parameters:
      selectedFields - The OCSF finding fields to include in the export, specified as OCSF field paths (for example, finding_info.title or severity). You can specify from 1 to 50 fields.

      Whether this parameter is required depends on the value of Format:

      • CSV – Required. The field paths that you specify become the columns of the output, in the order that you provide them. If you omit this parameter, the request returns a ValidationException.

      • OCSF_JSON – Not supported. This format includes each finding in full, so field selection doesn't apply. If you specify this parameter, the request returns a ValidationException.

      Returns:
      Returns a reference to this object so that method calls can be chained together.