Class UploadJobItem

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

The summary information for an individual upload job.

See Also:

  • Method Details

    • jobId

      public final String jobId()

      The unique identifier of the upload job.

      Returns:
      The unique identifier of the upload job.

    • displayName

      public final String displayName()

      The name of the upload job.

      Returns:
      The name of the upload job.

    • status

      public final UploadJobStatus status()

      The current status of the upload job.

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

      Returns:
      The current status of the upload job.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the upload job.

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

      Returns:
      The current status of the upload job.
      See Also:

    • statusReason

      public final StatusReason statusReason()

      The reason for the current status of the upload job.

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

      Returns:
      The reason for the current status of the upload job.
      See Also:

    • statusReasonAsString

      public final String statusReasonAsString()

      The reason for the current status of the upload job.

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

      Returns:
      The reason for the current status of the upload job.
      See Also:

    • createdAt

      public final Instant createdAt()

      The timestamp when the upload job was created.

      Returns:
      The timestamp when the upload job was created.

    • completedAt

      public final Instant completedAt()

      The timestamp when the upload job was completed.

      Returns:
      The timestamp when the upload job was completed.

    • dataExpiry

      public final Integer dataExpiry()

      The expiry duration for the profiles ingested with the upload job.

      Returns:
      The expiry duration for the profiles ingested with the upload job.

    • toBuilder

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

    • builder

      public static UploadJobItem.Builder builder()

    • serializableBuilderClass

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