Class ImportJob

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

Details about an import job.

See Also:

  • Method Details

    • jobId

      public final String jobId()

      The identifier of the import job.

      Returns:
      The identifier of the import job.

    • name

      public final String name()

      A user-friendly name for the import job.

      Returns:
      A user-friendly name for the import job.

    • status

      public final ImportJobStatus status()

      The status of the import job.

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

      Returns:
      The status of the import job.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the import job.

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

      Returns:
      The status of the import job.
      See Also:

    • preSignedUrl

      public final String preSignedUrl()

      The pre-signed URL target for uploading the input file.

      Returns:
      The pre-signed URL target for uploading the input file.

    • importedItemsCount

      public final Integer importedItemsCount()

      The number of addresses in the input that were successfully imported into the address list.

      Returns:
      The number of addresses in the input that were successfully imported into the address list.

    • failedItemsCount

      public final Integer failedItemsCount()

      The number of addresses in the input that failed to get imported into address list.

      Returns:
      The number of addresses in the input that failed to get imported into address list.

    • importDataFormat

      public final ImportDataFormat importDataFormat()

      The format of the input for the import job.

      Returns:
      The format of the input for the import job.

    • addressListId

      public final String addressListId()

      The unique identifier of the address list the import job was created for.

      Returns:
      The unique identifier of the address list the import job was created for.

    • createdTimestamp

      public final Instant createdTimestamp()

      The timestamp of when the import job was created.

      Returns:
      The timestamp of when the import job was created.

    • startTimestamp

      public final Instant startTimestamp()

      The timestamp of when the import job was started.

      Returns:
      The timestamp of when the import job was started.

    • completedTimestamp

      public final Instant completedTimestamp()

      The timestamp of when the import job was completed.

      Returns:
      The timestamp of when the import job was completed.

    • error

      public final String error()

      The reason for failure of an import job.

      Returns:
      The reason for failure of an import job.

    • toBuilder

      public ImportJob.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<ImportJob.Builder,ImportJob>
      Returns:
      a builder for type T

    • builder

      public static ImportJob.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ImportJob.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.