Class ExportSummary

java.lang.Object
software.amazon.awssdk.services.securityhub.model.ExportSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ExportSummary.Builder,ExportSummary>
@Generated("software.amazon.awssdk:codegen") public final class ExportSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ExportSummary.Builder,ExportSummary>

A summary of an export job, as returned by ListExportJobsV2.

See Also:

  • Method Details

    • exportJobId

      public final String exportJobId()

      The unique identifier of the export job.

      Returns:
      The unique identifier of the export job.

    • name

      public final String name()

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

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

    • status

      public final ExportStatus status()

      The current state of the export job.

      If the service returns an enum value that is not available in the current SDK version, status will return ExportStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current state of the export job.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current state of the export job.

      If the service returns an enum value that is not available in the current SDK version, status will return ExportStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current state of the export job.
      See Also:

    • dataType

      public final ExportDataType dataType()

      The category of data that the export job produces.

      If the service returns an enum value that is not available in the current SDK version, dataType will return ExportDataType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataTypeAsString().

      Returns:
      The category of data that the export job produces.
      See Also:

    • dataTypeAsString

      public final String dataTypeAsString()

      The category of data that the export job produces.

      If the service returns an enum value that is not available in the current SDK version, dataType will return ExportDataType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dataTypeAsString().

      Returns:
      The category of data that the export job produces.
      See Also:

    • outputConfiguration

      public final 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.

      Returns:
      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.

    • scopes

      public final ExportScopes scopes()

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

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

    • destination

      public final ExportDestination destination()

      The destination that the export job writes to.

      Returns:
      The destination that the export job writes to.

    • failureCode

      public final ExportFailureCode failureCode()

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

      If the service returns an enum value that is not available in the current SDK version, failureCode will return ExportFailureCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from failureCodeAsString().

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

    • failureCodeAsString

      public final String failureCodeAsString()

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

      If the service returns an enum value that is not available in the current SDK version, failureCode will return ExportFailureCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from failureCodeAsString().

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

    • failureMessage

      public final String failureMessage()

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

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

    • startedAt

      public final 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.

      Returns:
      The time when the export job was created.

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

    • endedAt

      public final 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.

      Returns:
      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.

    • toBuilder

      public ExportSummary.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ExportSummary.Builder,ExportSummary>
      Returns:
      a builder for type T

    • builder

      public static ExportSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ExportSummary.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.