Interface DescribePredictorResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<DescribePredictorResponse.Builder,DescribePredictorResponse>, ForecastResponse.Builder, SdkBuilder<DescribePredictorResponse.Builder,DescribePredictorResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
DescribePredictorResponse

public static interface DescribePredictorResponse.Builder extends ForecastResponse.Builder, SdkPojo, CopyableBuilder<DescribePredictorResponse.Builder,DescribePredictorResponse>
  • Method Details

    • predictorArn

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

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

      DescribePredictorResponse.Builder algorithmArn(String algorithmArn)

      The Amazon Resource Name (ARN) of the algorithm used for model training.

      Parameters:
      algorithmArn - The Amazon Resource Name (ARN) of the algorithm used for model training.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • autoMLAlgorithmArns

      DescribePredictorResponse.Builder autoMLAlgorithmArns(Collection<String> autoMLAlgorithmArns)

      When PerformAutoML is specified, the ARN of the chosen algorithm.

      Parameters:
      autoMLAlgorithmArns - When PerformAutoML is specified, the ARN of the chosen algorithm.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • autoMLAlgorithmArns

      DescribePredictorResponse.Builder autoMLAlgorithmArns(String... autoMLAlgorithmArns)

      When PerformAutoML is specified, the ARN of the chosen algorithm.

      Parameters:
      autoMLAlgorithmArns - When PerformAutoML is specified, the ARN of the chosen algorithm.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • forecastHorizon

      DescribePredictorResponse.Builder forecastHorizon(Integer forecastHorizon)

      The number of time-steps of the forecast. The forecast horizon is also called the prediction length.

      Parameters:
      forecastHorizon - The number of time-steps of the forecast. The forecast horizon is also called the prediction length.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • forecastTypes

      DescribePredictorResponse.Builder forecastTypes(Collection<String> forecastTypes)

      The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"]

      Parameters:
      forecastTypes - The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"]
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • forecastTypes

      DescribePredictorResponse.Builder forecastTypes(String... forecastTypes)

      The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"]

      Parameters:
      forecastTypes - The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"]
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • performAutoML

      DescribePredictorResponse.Builder performAutoML(Boolean performAutoML)

      Whether the predictor is set to perform AutoML.

      Parameters:
      performAutoML - Whether the predictor is set to perform AutoML.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • autoMLOverrideStrategy

      DescribePredictorResponse.Builder autoMLOverrideStrategy(String autoMLOverrideStrategy)

      The LatencyOptimized AutoML override strategy is only available in private beta. Contact Amazon Web Services Support or your account manager to learn more about access privileges.

      The AutoML strategy used to train the predictor. Unless LatencyOptimized is specified, the AutoML strategy optimizes predictor accuracy.

      This parameter is only valid for predictors trained using AutoML.

      Parameters:
      autoMLOverrideStrategy -

      The LatencyOptimized AutoML override strategy is only available in private beta. Contact Amazon Web Services Support or your account manager to learn more about access privileges.

      The AutoML strategy used to train the predictor. Unless LatencyOptimized is specified, the AutoML strategy optimizes predictor accuracy.

      This parameter is only valid for predictors trained using AutoML.

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

      DescribePredictorResponse.Builder autoMLOverrideStrategy(AutoMLOverrideStrategy autoMLOverrideStrategy)

      The LatencyOptimized AutoML override strategy is only available in private beta. Contact Amazon Web Services Support or your account manager to learn more about access privileges.

      The AutoML strategy used to train the predictor. Unless LatencyOptimized is specified, the AutoML strategy optimizes predictor accuracy.

      This parameter is only valid for predictors trained using AutoML.

      Parameters:
      autoMLOverrideStrategy -

      The LatencyOptimized AutoML override strategy is only available in private beta. Contact Amazon Web Services Support or your account manager to learn more about access privileges.

      The AutoML strategy used to train the predictor. Unless LatencyOptimized is specified, the AutoML strategy optimizes predictor accuracy.

      This parameter is only valid for predictors trained using AutoML.

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

      Whether the predictor is set to perform hyperparameter optimization (HPO).

      Parameters:
      performHPO - Whether the predictor is set to perform hyperparameter optimization (HPO).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • trainingParameters

      DescribePredictorResponse.Builder trainingParameters(Map<String,String> trainingParameters)

      The default training parameters or overrides selected during model training. When running AutoML or choosing HPO with CNN-QR or DeepAR+, the optimized values for the chosen hyperparameters are returned. For more information, see aws-forecast-choosing-recipes.

      Parameters:
      trainingParameters - The default training parameters or overrides selected during model training. When running AutoML or choosing HPO with CNN-QR or DeepAR+, the optimized values for the chosen hyperparameters are returned. For more information, see aws-forecast-choosing-recipes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • evaluationParameters

      DescribePredictorResponse.Builder evaluationParameters(EvaluationParameters evaluationParameters)

      Used to override the default evaluation parameters of the specified algorithm. Amazon Forecast evaluates a predictor by splitting a dataset into training data and testing data. The evaluation parameters define how to perform the split and the number of iterations.

      Parameters:
      evaluationParameters - Used to override the default evaluation parameters of the specified algorithm. Amazon Forecast evaluates a predictor by splitting a dataset into training data and testing data. The evaluation parameters define how to perform the split and the number of iterations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • evaluationParameters

      default DescribePredictorResponse.Builder evaluationParameters(Consumer<EvaluationParameters.Builder> evaluationParameters)

      Used to override the default evaluation parameters of the specified algorithm. Amazon Forecast evaluates a predictor by splitting a dataset into training data and testing data. The evaluation parameters define how to perform the split and the number of iterations.

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

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

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

      The hyperparameter override values for the algorithm.

      Parameters:
      hpoConfig - The hyperparameter override values for the algorithm.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • hpoConfig

      The hyperparameter override values for the algorithm.

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

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

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

      DescribePredictorResponse.Builder inputDataConfig(InputDataConfig inputDataConfig)

      Describes the dataset group that contains the data to use to train the predictor.

      Parameters:
      inputDataConfig - Describes the dataset group that contains the data to use to train the predictor.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • inputDataConfig

      default DescribePredictorResponse.Builder inputDataConfig(Consumer<InputDataConfig.Builder> inputDataConfig)

      Describes the dataset group that contains the data to use to train the predictor.

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

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

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

      DescribePredictorResponse.Builder featurizationConfig(FeaturizationConfig featurizationConfig)

      The featurization configuration.

      Parameters:
      featurizationConfig - The featurization configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • featurizationConfig

      default DescribePredictorResponse.Builder featurizationConfig(Consumer<FeaturizationConfig.Builder> featurizationConfig)

      The featurization configuration.

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

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

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

      DescribePredictorResponse.Builder encryptionConfig(EncryptionConfig encryptionConfig)

      An Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

      Parameters:
      encryptionConfig - An Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • encryptionConfig

      default DescribePredictorResponse.Builder encryptionConfig(Consumer<EncryptionConfig.Builder> encryptionConfig)

      An Key Management Service (KMS) key and the Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.

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

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

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

      DescribePredictorResponse.Builder predictorExecutionDetails(PredictorExecutionDetails predictorExecutionDetails)

      Details on the the status and results of the backtests performed to evaluate the accuracy of the predictor. You specify the number of backtests to perform when you call the operation.

      Parameters:
      predictorExecutionDetails - Details on the the status and results of the backtests performed to evaluate the accuracy of the predictor. You specify the number of backtests to perform when you call the operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • predictorExecutionDetails

      default DescribePredictorResponse.Builder predictorExecutionDetails(Consumer<PredictorExecutionDetails.Builder> predictorExecutionDetails)

      Details on the the status and results of the backtests performed to evaluate the accuracy of the predictor. You specify the number of backtests to perform when you call the operation.

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

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

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

      DescribePredictorResponse.Builder estimatedTimeRemainingInMinutes(Long estimatedTimeRemainingInMinutes)

      The estimated time remaining in minutes for the predictor training job to complete.

      Parameters:
      estimatedTimeRemainingInMinutes - The estimated time remaining in minutes for the predictor training job to complete.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • isAutoPredictor

      DescribePredictorResponse.Builder isAutoPredictor(Boolean isAutoPredictor)

      Whether the predictor was created with CreateAutoPredictor.

      Parameters:
      isAutoPredictor - Whether the predictor was created with CreateAutoPredictor.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • datasetImportJobArns

      DescribePredictorResponse.Builder datasetImportJobArns(Collection<String> datasetImportJobArns)

      An array of the ARNs of the dataset import jobs used to import training data for the predictor.

      Parameters:
      datasetImportJobArns - An array of the ARNs of the dataset import jobs used to import training data for the predictor.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • datasetImportJobArns

      DescribePredictorResponse.Builder datasetImportJobArns(String... datasetImportJobArns)

      An array of the ARNs of the dataset import jobs used to import training data for the predictor.

      Parameters:
      datasetImportJobArns - An array of the ARNs of the dataset import jobs used to import training data for the predictor.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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

      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

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

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

      DescribePredictorResponse.Builder optimizationMetric(String optimizationMetric)

      The accuracy metric used to optimize the predictor.

      Parameters:
      optimizationMetric - The accuracy metric used to optimize the predictor.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • optimizationMetric

      DescribePredictorResponse.Builder optimizationMetric(OptimizationMetric optimizationMetric)

      The accuracy metric used to optimize the predictor.

      Parameters:
      optimizationMetric - The accuracy metric used to optimize the predictor.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: