Interface EnrichmentJobSummary.Builder

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

  • Method Details

    • jobId

      EnrichmentJobSummary.Builder jobId(String jobId)

      Unique identifier for the enrichment job.

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

    • status

      EnrichmentJobSummary.Builder status(String 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.

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

    • status

      EnrichmentJobSummary.Builder status(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.

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

    • workspaceName

      EnrichmentJobSummary.Builder workspaceName(String workspaceName)

      The name of the IoT SiteWise workspace containing this job.

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

    • jobType

      EnrichmentJobSummary.Builder jobType(String jobType)

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

      Parameters:
      jobType - The type of enrichment job. 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

      EnrichmentJobSummary.Builder jobType(JobType jobType)

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

      Parameters:
      jobType - The type of enrichment job. 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:

    • datasetId

      EnrichmentJobSummary.Builder datasetId(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.

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

    • propertyAlias

      EnrichmentJobSummary.Builder propertyAlias(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.

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

    • timeSeriesId

      EnrichmentJobSummary.Builder timeSeriesId(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.

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

    • createdAt

      EnrichmentJobSummary.Builder createdAt(Instant createdAt)

      Timestamp when the job was created in ISO 8601 format.

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

    • updatedAt

      EnrichmentJobSummary.Builder updatedAt(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.

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