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

Interface DescribeAutoPredictorResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<DescribeAutoPredictorResponse.Builder,DescribeAutoPredictorResponse>, ForecastResponse.Builder, SdkBuilder<DescribeAutoPredictorResponse.Builder,DescribeAutoPredictorResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
DescribeAutoPredictorResponse
public static interface DescribeAutoPredictorResponse.Builder extends ForecastResponse.Builder, SdkPojo, CopyableBuilder<DescribeAutoPredictorResponse.Builder,DescribeAutoPredictorResponse>

  • Method Details

    • predictorArn

      DescribeAutoPredictorResponse.Builder predictorArn(String predictorArn)

      The Amazon Resource Name (ARN) of the predictor

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

    • predictorName

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

    • forecastHorizon

      DescribeAutoPredictorResponse.Builder forecastHorizon(Integer forecastHorizon)

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

      Parameters:
      forecastHorizon - The number of time-steps that the model predicts. 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

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

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

    • forecastFrequency

      DescribeAutoPredictorResponse.Builder forecastFrequency(String forecastFrequency)

      The frequency of predictions in a forecast.

      Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "Y" indicates every year and "5min" indicates every five minutes.

      Parameters:
      forecastFrequency - The frequency of predictions in a forecast.

      Valid intervals are Y (Year), M (Month), W (Week), D (Day), H (Hour), 30min (30 minutes), 15min (15 minutes), 10min (10 minutes), 5min (5 minutes), and 1min (1 minute). For example, "Y" indicates every year and "5min" indicates every five minutes.

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

    • forecastDimensions

      DescribeAutoPredictorResponse.Builder forecastDimensions(Collection<String> forecastDimensions)

      An array of dimension (field) names that specify the attributes used to group your time series.

      Parameters:
      forecastDimensions - An array of dimension (field) names that specify the attributes used to group your time series.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • forecastDimensions

      DescribeAutoPredictorResponse.Builder forecastDimensions(String... forecastDimensions)

      An array of dimension (field) names that specify the attributes used to group your time series.

      Parameters:
      forecastDimensions - An array of dimension (field) names that specify the attributes used to group your time series.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • datasetImportJobArns

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

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

    • dataConfig

      DescribeAutoPredictorResponse.Builder dataConfig(DataConfig dataConfig)

      The data configuration for your dataset group and any additional datasets.

      Parameters:
      dataConfig - The data configuration for your dataset group and any additional datasets.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataConfig

      default DescribeAutoPredictorResponse.Builder dataConfig(Consumer<DataConfig.Builder> dataConfig)

      The data configuration for your dataset group and any additional datasets.

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

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

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

    • encryptionConfig

      DescribeAutoPredictorResponse.Builder encryptionConfig(EncryptionConfig encryptionConfig)
      Sets the value of the EncryptionConfig property for this object.
      Parameters:
      encryptionConfig - The new value for the EncryptionConfig property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encryptionConfig

      default DescribeAutoPredictorResponse.Builder encryptionConfig(Consumer<EncryptionConfig.Builder> encryptionConfig)
      Sets the value of the EncryptionConfig property for this object. 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:

    • referencePredictorSummary

      DescribeAutoPredictorResponse.Builder referencePredictorSummary(ReferencePredictorSummary referencePredictorSummary)

      The ARN and state of the reference predictor. This parameter is only valid for retrained or upgraded predictors.

      Parameters:
      referencePredictorSummary - The ARN and state of the reference predictor. This parameter is only valid for retrained or upgraded predictors.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • referencePredictorSummary

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

      The ARN and state of the reference predictor. This parameter is only valid for retrained or upgraded predictors.

      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:

    • estimatedTimeRemainingInMinutes

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

    • status

      DescribeAutoPredictorResponse.Builder status(String status)

      The status of the predictor. States include:

      • ACTIVE

      • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

      • CREATE_STOPPING, CREATE_STOPPED

      • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

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

      • ACTIVE

      • CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED

      • CREATE_STOPPING, CREATE_STOPPED

      • DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED

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

    • message

      DescribeAutoPredictorResponse.Builder message(String message)

      In the event of an error, a message detailing the cause of the error.

      Parameters:
      message - In the event of an error, a message detailing the cause of the error.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • creationTime

      DescribeAutoPredictorResponse.Builder creationTime(Instant creationTime)

      The timestamp of the CreateAutoPredictor request.

      Parameters:
      creationTime - The timestamp of the CreateAutoPredictor request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastModificationTime

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

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

      DescribeAutoPredictorResponse.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:

    • explainabilityInfo

      DescribeAutoPredictorResponse.Builder explainabilityInfo(ExplainabilityInfo explainabilityInfo)

      Provides the status and ARN of the Predictor Explainability.

      Parameters:
      explainabilityInfo - Provides the status and ARN of the Predictor Explainability.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • explainabilityInfo

      default DescribeAutoPredictorResponse.Builder explainabilityInfo(Consumer<ExplainabilityInfo.Builder> explainabilityInfo)

      Provides the status and ARN of the Predictor Explainability.

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

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

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

    • monitorInfo

      DescribeAutoPredictorResponse.Builder monitorInfo(MonitorInfo monitorInfo)

      A object with the Amazon Resource Name (ARN) and status of the monitor resource.

      Parameters:
      monitorInfo - A object with the Amazon Resource Name (ARN) and status of the monitor resource.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • monitorInfo

      default DescribeAutoPredictorResponse.Builder monitorInfo(Consumer<MonitorInfo.Builder> monitorInfo)

      A object with the Amazon Resource Name (ARN) and status of the monitor resource.

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

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

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

    • timeAlignmentBoundary

      DescribeAutoPredictorResponse.Builder timeAlignmentBoundary(TimeAlignmentBoundary timeAlignmentBoundary)

      The time boundary Forecast uses when aggregating data.

      Parameters:
      timeAlignmentBoundary - The time boundary Forecast uses when aggregating data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timeAlignmentBoundary

      default DescribeAutoPredictorResponse.Builder timeAlignmentBoundary(Consumer<TimeAlignmentBoundary.Builder> timeAlignmentBoundary)

      The time boundary Forecast uses when aggregating data.

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

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

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