Class EnrichmentJobSummary

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

Summary information for an enrichment job returned by ListEnrichmentJobs. This lightweight representation includes identifiers, status, and key metadata without the full job configuration.

Use DescribeEnrichmentJob to retrieve:

  • Complete job configuration (trim settings, full parameters)
  • Detailed timestamps (completedAt, cancelledAt)
  • Failure messages for failed jobs

The summary is optimized for display in lists and dashboards, providing enough information to identify and filter jobs without the overhead of full configuration details.

See Also:

  • Method Details

    • jobId

      public final String jobId()

      Unique identifier for the enrichment job.

      Returns:
      Unique identifier for the enrichment job.

    • status

      public final EnrichmentJobStatus status()

      Current status of the job: PENDING, RUNNING, COMPLETED, FAILED, TIMED_OUT, or CANCELLED. Use this to quickly identify active jobs or jobs requiring attention.

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

      Returns:
      Current status of the job: PENDING, RUNNING, COMPLETED, FAILED, TIMED_OUT, or CANCELLED. Use this to quickly identify active jobs or jobs requiring attention.
      See Also:

    • statusAsString

      public final String statusAsString()

      Current status of the job: PENDING, RUNNING, COMPLETED, FAILED, TIMED_OUT, or CANCELLED. Use this to quickly identify active jobs or jobs requiring attention.

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

      Returns:
      Current status of the job: PENDING, RUNNING, COMPLETED, FAILED, TIMED_OUT, or CANCELLED. Use this to quickly identify active jobs or jobs requiring attention.
      See Also:

    • workspaceName

      public final String workspaceName()

      The name of the IoT SiteWise workspace containing this job.

      Returns:
      The name of the IoT SiteWise workspace containing this job.

    • jobType

      public final JobType jobType()

      The type of enrichment job. Currently EVENT_DETECTION is the only supported type.

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

      Returns:
      The type of enrichment job. Currently EVENT_DETECTION is the only supported type.
      See Also:

    • jobTypeAsString

      public final String jobTypeAsString()

      The type of enrichment job. Currently EVENT_DETECTION is the only supported type.

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

      Returns:
      The type of enrichment job. Currently EVENT_DETECTION is the only supported type.
      See Also:

    • datasetId

      public final String datasetId()

      The dataset being enriched. Useful for filtering and identifying jobs without fetching the full configuration. This allows you to quickly find all jobs related to a specific dataset.

      Returns:
      The dataset being enriched. Useful for filtering and identifying jobs without fetching the full configuration. This allows you to quickly find all jobs related to a specific dataset.

    • propertyAlias

      public final String propertyAlias()

      The property alias (human-readable sensor name) of the time series being enriched. Present when the job was created using a propertyAlias. Use this to identify which sensor the job analyzes.

      Returns:
      The property alias (human-readable sensor name) of the time series being enriched. Present when the job was created using a propertyAlias. Use this to identify which sensor the job analyzes.

    • timeSeriesId

      public final String timeSeriesId()

      The system identifier of the time series being enriched. Present when the job was created using a timeSeriesId. Use this to identify which time series the job analyzes.

      Returns:
      The system identifier of the time series being enriched. Present when the job was created using a timeSeriesId. Use this to identify which time series the job analyzes.

    • createdAt

      public final Instant createdAt()

      Timestamp when the job was created in ISO 8601 format.

      Returns:
      Timestamp when the job was created in ISO 8601 format.

    • updatedAt

      public final Instant updatedAt()

      Timestamp of the last job status change in ISO 8601 format. Use this to track recent activity and identify stale jobs. For active jobs, this shows the last time the job transitioned to a new status.

      Returns:
      Timestamp of the last job status change in ISO 8601 format. Use this to track recent activity and identify stale jobs. For active jobs, this shows the last time the job transitioned to a new status.

    • toBuilder

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

    • builder

      public static EnrichmentJobSummary.Builder builder()

    • serializableBuilderClass

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