Interface GetExportJobV2Response.Builder

  • Method Details

    • exportJobId

      GetExportJobV2Response.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

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

      Parameters:
      name - The user-provided name of the export job, if one was specified when the job was started.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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

      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

      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

      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

      GetExportJobV2Response.Builder outputConfiguration(ExportOutput outputConfiguration)

      The output configuration that the export job was started with, including the format and any filters or selected fields.

      Parameters:
      outputConfiguration - The output configuration that the export job was started with, including the format and any filters or selected fields.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • outputConfiguration

      default GetExportJobV2Response.Builder outputConfiguration(Consumer<ExportOutput.Builder> outputConfiguration)

      The output configuration that the export job was started with, including the format and any filters or selected fields.

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

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

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

      The organization scopes that the export job was started with, echoed verbatim. This parameter is absent if the caller didn't supply Scopes. It contains only the organization or organizational unit (OU) identifiers that the caller submitted; it never contains resolved member-account identifiers.

      Parameters:
      scopes - The organization scopes that the export job was started with, echoed verbatim. This parameter is absent if the caller didn't supply Scopes. It contains only the organization or organizational unit (OU) identifiers that the caller submitted; it never contains resolved member-account identifiers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • scopes

      The organization scopes that the export job was started with, echoed verbatim. This parameter is absent if the caller didn't supply Scopes. It contains only the organization or organizational unit (OU) identifiers that the caller submitted; it never contains resolved member-account identifiers.

      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

      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

      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

      GetExportJobV2Response.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

      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

      GetExportJobV2Response.Builder failureMessage(String failureMessage)

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

      Parameters:
      failureMessage - A human-readable message that provides more detail 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

      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

      The time when the export job reached a terminal state (SUCCEEDED, FAILED, or CANCELLED). This parameter is 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 (SUCCEEDED, FAILED, or CANCELLED). This parameter is 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.