Interface DescribeEnrichmentJobResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<DescribeEnrichmentJobResponse.Builder,DescribeEnrichmentJobResponse>, IoTSiteWiseResponse.Builder, SdkBuilder<DescribeEnrichmentJobResponse.Builder,DescribeEnrichmentJobResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
DescribeEnrichmentJobResponse
@Mutable @NotThreadSafe public static interface DescribeEnrichmentJobResponse.Builder extends IoTSiteWiseResponse.Builder, SdkPojo, CopyableBuilder<DescribeEnrichmentJobResponse.Builder,DescribeEnrichmentJobResponse>

  • Method Details

    • jobId

      DescribeEnrichmentJobResponse.Builder jobId(String jobId)

      The unique identifier of the enrichment job.

      Parameters:
      jobId - The unique identifier of the enrichment job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      DescribeEnrichmentJobResponse.Builder status(String 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
      Parameters:
      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
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      DescribeEnrichmentJobResponse.Builder status(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
      Parameters:
      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
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • workspaceName

      DescribeEnrichmentJobResponse.Builder workspaceName(String workspaceName)

      The name of the IoT SiteWise workspace containing the job.

      Parameters:
      workspaceName - The name of the IoT SiteWise workspace containing the job.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • jobType

      DescribeEnrichmentJobResponse.Builder jobType(String jobType)

      The type of enrichment job, derived from the job configuration. Currently EVENT_DETECTION is the only supported type.

      Parameters:
      jobType - The type of enrichment job, derived from the job configuration. Currently EVENT_DETECTION is the only supported type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • jobType

      DescribeEnrichmentJobResponse.Builder jobType(JobType jobType)

      The type of enrichment job, derived from the job configuration. Currently EVENT_DETECTION is the only supported type.

      Parameters:
      jobType - The type of enrichment job, derived from the job configuration. Currently EVENT_DETECTION is the only supported type.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • jobConfiguration

      DescribeEnrichmentJobResponse.Builder jobConfiguration(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • jobConfiguration

      default DescribeEnrichmentJobResponse.Builder jobConfiguration(Consumer<EnrichmentJobConfiguration.Builder> 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.

      This is a convenience method that creates an instance of the EnrichmentJobConfiguration.Builder avoiding the need to create one manually via EnrichmentJobConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to jobConfiguration(EnrichmentJobConfiguration).

      Parameters:
      jobConfiguration - a consumer that will call methods on EnrichmentJobConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • createdAt

      DescribeEnrichmentJobResponse.Builder createdAt(Instant createdAt)

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

      Parameters:
      createdAt - Timestamp when the enrichment job was created in ISO 8601 format.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updatedAt

      DescribeEnrichmentJobResponse.Builder updatedAt(Instant updatedAt)

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

      Parameters:
      updatedAt - Timestamp when the job status was last updated in ISO 8601 format. Useful for tracking recent activity.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • completedAt

      DescribeEnrichmentJobResponse.Builder completedAt(Instant completedAt)

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

      Parameters:
      completedAt - Timestamp when the job completed successfully in ISO 8601 format. Only present if status is COMPLETED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cancelledAt

      DescribeEnrichmentJobResponse.Builder cancelledAt(Instant cancelledAt)

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

      Parameters:
      cancelledAt - Timestamp when the job was cancelled in ISO 8601 format. Only present if status is CANCELLED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • failureMessage

      DescribeEnrichmentJobResponse.Builder failureMessage(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.