Interface ExportSummary.Builder

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

  • Method Details

    • exportJobId

      ExportSummary.Builder exportJobId(String exportJobId)

      The unique identifier of the export job.

      Parameters:
      exportJobId - The unique identifier of the export job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      ExportSummary.Builder name(String name)

      The user-provided name of the export job, if one was specified.

      Parameters:
      name - The user-provided name of the export job, if one was specified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      ExportSummary.Builder status(String status)

      The current state of the export job.

      Parameters:
      status - The current state of the export job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      ExportSummary.Builder status(ExportStatus status)

      The current state of the export job.

      Parameters:
      status - The current state of the export job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dataType

      ExportSummary.Builder dataType(String dataType)

      The category of data that the export job produces.

      Parameters:
      dataType - The category of data that the export job produces.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • dataType

      ExportSummary.Builder dataType(ExportDataType dataType)

      The category of data that the export job produces.

      Parameters:
      dataType - The category of data that the export job produces.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • outputConfiguration

      ExportSummary.Builder outputConfiguration(ExportOutputSummary outputConfiguration)

      The output configuration of the export job. For findings exports, this reports the output format. Present only for findings exports; absent for other data types.

      Parameters:
      outputConfiguration - The output configuration of the export job. For findings exports, this reports the output format. Present only for findings exports; absent for other data types.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outputConfiguration

      default ExportSummary.Builder outputConfiguration(Consumer<ExportOutputSummary.Builder> outputConfiguration)

      The output configuration of the export job. For findings exports, this reports the output format. Present only for findings exports; absent for other data types.

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

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

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

    • scopes

      ExportSummary.Builder scopes(ExportScopes scopes)

      The organization scopes that the export job was started with, echoed verbatim. Absent if the caller didn't supply Scopes.

      Parameters:
      scopes - The organization scopes that the export job was started with, echoed verbatim. Absent if the caller didn't supply Scopes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • scopes

      default ExportSummary.Builder scopes(Consumer<ExportScopes.Builder> scopes)

      The organization scopes that the export job was started with, echoed verbatim. Absent if the caller didn't supply Scopes.

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

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

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

    • destination

      ExportSummary.Builder destination(ExportDestination destination)

      The destination that the export job writes to.

      Parameters:
      destination - The destination that the export job writes to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destination

      default ExportSummary.Builder destination(Consumer<ExportDestination.Builder> destination)

      The destination that the export job writes to.

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

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

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

    • failureCode

      ExportSummary.Builder failureCode(String failureCode)

      A code that classifies why the export job failed. Present only when Status is FAILED.

      Parameters:
      failureCode - A code that classifies why the export job failed. Present only when Status is FAILED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • failureCode

      ExportSummary.Builder failureCode(ExportFailureCode failureCode)

      A code that classifies why the export job failed. Present only when Status is FAILED.

      Parameters:
      failureCode - A code that classifies why the export job failed. Present only when Status is FAILED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • failureMessage

      ExportSummary.Builder failureMessage(String failureMessage)

      A human-readable message about why the export job failed. Present only when Status is FAILED.

      Parameters:
      failureMessage - A human-readable message about why the export job failed. Present only when Status is FAILED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startedAt

      ExportSummary.Builder startedAt(Instant startedAt)

      The time when the export job was created.

      For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

      Parameters:
      startedAt - The time when the export job was created.

      For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

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

    • endedAt

      ExportSummary.Builder endedAt(Instant endedAt)

      The time when the export job reached a terminal state. Absent while the job is RUNNING.

      For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

      Parameters:
      endedAt - The time when the export job reached a terminal state. Absent while the job is RUNNING .

      For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

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