Class DescribeEnrichmentJobResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseResponse
software.amazon.awssdk.services.iotsitewise.model.DescribeEnrichmentJobResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeEnrichmentJobResponse.Builder,DescribeEnrichmentJobResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeEnrichmentJobResponse extends IoTSiteWiseResponse implements ToCopyableBuilder<DescribeEnrichmentJobResponse.Builder,DescribeEnrichmentJobResponse>

  • Method Details

    • jobId

      public final String jobId()

      The unique identifier of the enrichment job.

      Returns:
      The unique identifier of the enrichment job.

    • status

      public final EnrichmentJobStatus status()

      Current status of the enrichment job. Possible values:

      • PENDING: Job is waiting to start processing
      • RUNNING: Job is actively processing video data
      • COMPLETED: Job finished successfully; embeddings available in IoT SiteWise
      • FAILED: Job encountered an error; see failureMessage for details
      • TIMED_OUT: Job exceeded maximum processing time limit
      • CANCELLED: Job was cancelled by user request

      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 enrichment job. Possible values:

      • PENDING: Job is waiting to start processing
      • RUNNING: Job is actively processing video data
      • COMPLETED: Job finished successfully; embeddings available in IoT SiteWise
      • FAILED: Job encountered an error; see failureMessage for details
      • TIMED_OUT: Job exceeded maximum processing time limit
      • CANCELLED: Job was cancelled by user request
      See Also:

    • statusAsString

      public final String statusAsString()

      Current status of the enrichment job. Possible values:

      • PENDING: Job is waiting to start processing
      • RUNNING: Job is actively processing video data
      • COMPLETED: Job finished successfully; embeddings available in IoT SiteWise
      • FAILED: Job encountered an error; see failureMessage for details
      • TIMED_OUT: Job exceeded maximum processing time limit
      • CANCELLED: Job was cancelled by user request

      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 enrichment job. Possible values:

      • PENDING: Job is waiting to start processing
      • RUNNING: Job is actively processing video data
      • COMPLETED: Job finished successfully; embeddings available in IoT SiteWise
      • FAILED: Job encountered an error; see failureMessage for details
      • TIMED_OUT: Job exceeded maximum processing time limit
      • CANCELLED: Job was cancelled by user request
      See Also:

    • workspaceName

      public final String workspaceName()

      The name of the IoT SiteWise workspace containing the job.

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

    • jobType

      public final JobType jobType()

      The type of enrichment job, derived from the job configuration. 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, derived from the job configuration. Currently EVENT_DETECTION is the only supported type.
      See Also:

    • jobTypeAsString

      public final String jobTypeAsString()

      The type of enrichment job, derived from the job configuration. 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, derived from the job configuration. Currently EVENT_DETECTION is the only supported type.
      See Also:

    • jobConfiguration

      public final EnrichmentJobConfiguration jobConfiguration()

      The complete job configuration as originally submitted, including the analysis type and parameters. For event detection jobs, this includes the dataset ID, time series identifier, and trim settings defining the analysis time range.

      Returns:
      The complete job configuration as originally submitted, including the analysis type and parameters. For event detection jobs, this includes the dataset ID, time series identifier, and trim settings defining the analysis time range.

    • createdAt

      public final Instant createdAt()

      Timestamp when the enrichment job was created in ISO 8601 format.

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

    • updatedAt

      public final Instant updatedAt()

      Timestamp when the job status was last updated in ISO 8601 format. Useful for tracking recent activity.

      Returns:
      Timestamp when the job status was last updated in ISO 8601 format. Useful for tracking recent activity.

    • completedAt

      public final Instant completedAt()

      Timestamp when the job completed successfully in ISO 8601 format. Only present if status is COMPLETED.

      Returns:
      Timestamp when the job completed successfully in ISO 8601 format. Only present if status is COMPLETED.

    • cancelledAt

      public final Instant cancelledAt()

      Timestamp when the job was cancelled in ISO 8601 format. Only present if status is CANCELLED.

      Returns:
      Timestamp when the job was cancelled in ISO 8601 format. Only present if status is CANCELLED.

    • failureMessage

      public final String failureMessage()

      Human-readable error message explaining why the job failed. Only present if status is FAILED. Use this information to diagnose configuration issues, permission problems, or data processing errors.

      Returns:
      Human-readable error message explaining why the job failed. Only present if status is FAILED. Use this information to diagnose configuration issues, permission problems, or data processing errors.

    • toBuilder

      public DescribeEnrichmentJobResponse.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<DescribeEnrichmentJobResponse.Builder,DescribeEnrichmentJobResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeEnrichmentJobResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeEnrichmentJobResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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