Package software.amazon.awssdk.services.iotsitewise.model

Class JobSummary

java.lang.Object
software.amazon.awssdk.services.iotsitewise.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 the job summary information.

See Also:

  • Method Details

    • id

      public final String id()

      The ID of the job.

      Returns:
      The ID of the job.

    • name

      public final String name()

      The unique name that helps identify the job request.

      Returns:
      The unique name that helps identify the job request.

    • status

      public final JobStatus status()

      The status of the bulk import job can be one of following values:

      • PENDING – IoT SiteWise is waiting for the current bulk import job to finish.

      • CANCELLED – The bulk import job has been canceled.

      • RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3.

      • COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3.

      • FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.

      • COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.

      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 status of the bulk import job can be one of following values:

      • PENDING – IoT SiteWise is waiting for the current bulk import job to finish.

      • CANCELLED – The bulk import job has been canceled.

      • RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3.

      • COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3.

      • FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.

      • COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the bulk import job can be one of following values:

      • PENDING – IoT SiteWise is waiting for the current bulk import job to finish.

      • CANCELLED – The bulk import job has been canceled.

      • RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3.

      • COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3.

      • FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.

      • COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.

      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 status of the bulk import job can be one of following values:

      • PENDING – IoT SiteWise is waiting for the current bulk import job to finish.

      • CANCELLED – The bulk import job has been canceled.

      • RUNNING – IoT SiteWise is processing your request to import your data from Amazon S3.

      • COMPLETED – IoT SiteWise successfully completed your request to import data from Amazon S3.

      • FAILED – IoT SiteWise couldn't process your request to import data from Amazon S3. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.

      • COMPLETED_WITH_FAILURES – IoT SiteWise completed your request to import data from Amazon S3 with errors. You can use logs saved in the specified error report location in Amazon S3 to troubleshoot issues.

      See Also:

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