Class JobSummary

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

Contains summary information about an asynchronous job in a list response.

See Also:

  • Method Details

    • jobId

      public final String jobId()

      The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.

      Returns:
      The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.

    • status

      public final JobStatus status()

      The current lifecycle status of the job.

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

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

    • statusAsString

      public final String statusAsString()

      The current lifecycle status of the job.

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

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

    • operationType

      public final String operationType()

      The type of mutating operation that created the job.

      Returns:
      The type of mutating operation that created the job.

    • createdAt

      public final Instant createdAt()

      The time when the resource was created, in Unix epoch time.

      Returns:
      The time when the resource was created, in Unix epoch time.

    • updatedAt

      public final Instant updatedAt()

      The time when the resource was last updated, in Unix epoch time.

      Returns:
      The time when the resource was last updated, in Unix epoch time.

    • brandProfileId

      public final String brandProfileId()

      The brand profile that the job operates on. This value is absent for operations that create a brand profile.

      Returns:
      The brand profile that the job operates on. This value is absent for operations that create a brand profile.

    • errorCode

      public final String errorCode()

      A machine-readable code that identifies why the job failed. This value is present only when the job status is FAILED.

      Returns:
      A machine-readable code that identifies why the job failed. This value is present only when the job status is FAILED.

    • errorMessage

      public final String errorMessage()

      A human-readable description of why the job failed. This value is present only when the job status is FAILED.

      Returns:
      A human-readable description of why the job failed. This value is present only when the job status is FAILED.

    • hasResources

      public final boolean hasResources()
      For responses, this returns true if the service returned a value for the Resources property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • resources

      public final List<JobResource> resources()

      The resources that were created or updated by the job.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasResources() method.

      Returns:
      The resources that were created or updated by the job.

    • toBuilder

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

    • builder

      public static JobSummary.Builder builder()

    • serializableBuilderClass

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