Package software.amazon.awssdk.services.forecast.model

Interface PredictorSummary.Builder

All Superinterfaces:
Buildable, CopyableBuilder<PredictorSummary.Builder,PredictorSummary>, SdkBuilder<PredictorSummary.Builder,PredictorSummary>, SdkPojo
Enclosing class:
PredictorSummary
public static interface PredictorSummary.Builder extends SdkPojo, CopyableBuilder<PredictorSummary.Builder,PredictorSummary>

  • Method Details

    • predictorArn

      PredictorSummary.Builder predictorArn(String predictorArn)

      The ARN of the predictor.

      Parameters:
      predictorArn - The ARN of the predictor.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • predictorName

      PredictorSummary.Builder predictorName(String predictorName)

      The name of the predictor.

      Parameters:
      predictorName - The name of the predictor.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • datasetGroupArn

      PredictorSummary.Builder datasetGroupArn(String datasetGroupArn)

      The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.

      Parameters:
      datasetGroupArn - The Amazon Resource Name (ARN) of the dataset group that contains the data used to train the predictor.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • isAutoPredictor

      PredictorSummary.Builder isAutoPredictor(Boolean isAutoPredictor)

      Whether AutoPredictor was used to create the predictor.

      Parameters:
      isAutoPredictor - Whether AutoPredictor was used to create the predictor.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • referencePredictorSummary

      PredictorSummary.Builder referencePredictorSummary(ReferencePredictorSummary referencePredictorSummary)

      A summary of the reference predictor used if the predictor was retrained or upgraded.

      Parameters:
      referencePredictorSummary - A summary of the reference predictor used if the predictor was retrained or upgraded.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • referencePredictorSummary

      default PredictorSummary.Builder referencePredictorSummary(Consumer<ReferencePredictorSummary.Builder> referencePredictorSummary)

      A summary of the reference predictor used if the predictor was retrained or upgraded.

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

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

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

    • status

      PredictorSummary.Builder status(String status)

      The status of the predictor. States include:

      • ACTIVE

      • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

      • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

      • CREATE_STOPPING, CREATE_STOPPED

      The Status of the predictor must be ACTIVE before you can use the predictor to create a forecast.

      Parameters:
      status - The status of the predictor. States include:

      • ACTIVE

      • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

      • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

      • CREATE_STOPPING, CREATE_STOPPED

      The Status of the predictor must be ACTIVE before you can use the predictor to create a forecast.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • message

      PredictorSummary.Builder message(String message)

      If an error occurred, an informational message about the error.

      Parameters:
      message - If an error occurred, an informational message about the error.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • creationTime

      PredictorSummary.Builder creationTime(Instant creationTime)

      When the model training task was created.

      Parameters:
      creationTime - When the model training task was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastModificationTime

      PredictorSummary.Builder lastModificationTime(Instant lastModificationTime)

      The last time the resource was modified. The timestamp depends on the status of the job:

      • CREATE_PENDING - The CreationTime.

      • CREATE_IN_PROGRESS - The current timestamp.

      • CREATE_STOPPING - The current timestamp.

      • CREATE_STOPPED - When the job stopped.

      • ACTIVE or CREATE_FAILED - When the job finished or failed.

      Parameters:
      lastModificationTime - The last time the resource was modified. The timestamp depends on the status of the job:

      • CREATE_PENDING - The CreationTime.

      • CREATE_IN_PROGRESS - The current timestamp.

      • CREATE_STOPPING - The current timestamp.

      • CREATE_STOPPED - When the job stopped.

      • ACTIVE or CREATE_FAILED - When the job finished or failed.

      Returns:
      Returns a reference to this object so that method calls can be chained together.