DescribePredictorResponse (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.forecast.model.ForecastResponse
    - - software.amazon.awssdk.services.forecast.model.DescribePredictorResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribePredictorResponse.Builder,DescribePredictorResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribePredictorResponse
extends ForecastResponse
implements ToCopyableBuilder<DescribePredictorResponse.Builder,DescribePredictorResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribePredictorResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribePredictorResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`algorithmArn()` The Amazon Resource Name (ARN) of the algorithm used for model training.
`List<String>`	`autoMLAlgorithmArns()` When `PerformAutoML` is specified, the ARN of the chosen algorithm.
`static DescribePredictorResponse.Builder`	`builder()`
`Instant`	`creationTime()` When the model training task was created.
`List<String>`	`datasetImportJobArns()` An array of the ARNs of the dataset import jobs used to import training data for the predictor.
`EncryptionConfig`	`encryptionConfig()` An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`EvaluationParameters`	`evaluationParameters()` Used to override the default evaluation parameters of the specified algorithm.
`FeaturizationConfig`	`featurizationConfig()` The featurization configuration.
`Integer`	`forecastHorizon()` The number of time-steps of the forecast.
`List<String>`	`forecastTypes()` The forecast types used during predictor training.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAutoMLAlgorithmArns()` Returns true if the AutoMLAlgorithmArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasDatasetImportJobArns()` Returns true if the DatasetImportJobArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasForecastTypes()` Returns true if the ForecastTypes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasTrainingParameters()` Returns true if the TrainingParameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`HyperParameterTuningJobConfig`	`hpoConfig()` The hyperparameter override values for the algorithm.
`InputDataConfig`	`inputDataConfig()` Describes the dataset group that contains the data to use to train the predictor.
`Instant`	`lastModificationTime()` Initially, the same as `CreationTime` (when the status is `CREATE_PENDING`).
`String`	`message()` If an error occurred, an informational message about the error.
`Boolean`	`performAutoML()` Whether the predictor is set to perform AutoML.
`Boolean`	`performHPO()` Whether the predictor is set to perform hyperparameter optimization (HPO).
`String`	`predictorArn()` The ARN of the predictor.
`PredictorExecutionDetails`	`predictorExecutionDetails()` Details on the the status and results of the backtests performed to evaluate the accuracy of the predictor.
`String`	`predictorName()` The name of the predictor.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribePredictorResponse.Builder>`	`serializableBuilderClass()`
`String`	`status()` The status of the predictor.
`DescribePredictorResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Map<String,String>`	`trainingParameters()` The default training parameters or overrides selected during model training.

Methods inherited from class software.amazon.awssdk.services.forecast.model.ForecastResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - predictorArn
```
public String predictorArn()
```
    The ARN of the predictor.
    
    Returns:
    
    The ARN of the predictor.
  - predictorName
```
public String predictorName()
```
    The name of the predictor.
    
    Returns:
    
    The name of the predictor.
  - algorithmArn
```
public String algorithmArn()
```
    The Amazon Resource Name (ARN) of the algorithm used for model training.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the algorithm used for model training.
  - forecastHorizon
```
public Integer forecastHorizon()
```
    The number of time-steps of the forecast. The forecast horizon is also called the prediction length.
    
    Returns:
    
    The number of time-steps of the forecast. The forecast horizon is also called the prediction length.
  - hasForecastTypes
```
public boolean hasForecastTypes()
```
    Returns true if the ForecastTypes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - forecastTypes
```
public List<String> forecastTypes()
```
    The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"]
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasForecastTypes() to see if a value was sent in this field.
    
    Returns:
    
    The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"]
  - performAutoML
```
public Boolean performAutoML()
```
    Whether the predictor is set to perform AutoML.
    
    Returns:
    
    Whether the predictor is set to perform AutoML.
  - performHPO
```
public Boolean performHPO()
```
    Whether the predictor is set to perform hyperparameter optimization (HPO).
    
    Returns:
    
    Whether the predictor is set to perform hyperparameter optimization (HPO).
  - hasTrainingParameters
```
public boolean hasTrainingParameters()
```
    Returns true if the TrainingParameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - trainingParameters
```
public 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTrainingParameters() to see if a value was sent in this field.
    
    Returns:
    
    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.
  - evaluationParameters
```
public 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.
    
    Returns:
    
    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.
  - hpoConfig
```
public HyperParameterTuningJobConfig hpoConfig()
```
    The hyperparameter override values for the algorithm.
    
    Returns:
    
    The hyperparameter override values for the algorithm.
  - inputDataConfig
```
public InputDataConfig inputDataConfig()
```
    Describes the dataset group that contains the data to use to train the predictor.
    
    Returns:
    
    Describes the dataset group that contains the data to use to train the predictor.
  - featurizationConfig
```
public FeaturizationConfig featurizationConfig()
```
    The featurization configuration.
    
    Returns:
    
    The featurization configuration.
  - encryptionConfig
```
public EncryptionConfig encryptionConfig()
```
    An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
    
    Returns:
    
    An AWS Key Management Service (KMS) key and the AWS Identity and Access Management (IAM) role that Amazon Forecast can assume to access the key.
  - predictorExecutionDetails
```
public 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.
    
    Returns:
    
    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.
  - hasDatasetImportJobArns
```
public boolean hasDatasetImportJobArns()
```
    Returns true if the DatasetImportJobArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - datasetImportJobArns
```
public List<String> datasetImportJobArns()
```
    An array of the ARNs of the dataset import jobs used to import training data for the predictor.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasDatasetImportJobArns() to see if a value was sent in this field.
    
    Returns:
    
    An array of the ARNs of the dataset import jobs used to import training data for the predictor.
  - hasAutoMLAlgorithmArns
```
public boolean hasAutoMLAlgorithmArns()
```
    Returns true if the AutoMLAlgorithmArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - autoMLAlgorithmArns
```
public List<String> autoMLAlgorithmArns()
```
    When PerformAutoML is specified, the ARN of the chosen algorithm.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasAutoMLAlgorithmArns() to see if a value was sent in this field.
    
    Returns:
    
    When PerformAutoML is specified, the ARN of the chosen algorithm.
  - status
```
public String status()
```
    The status of the predictor. States include:
    - ACTIVE
    - CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
    - DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
    - UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED
    The Status of the predictor must be ACTIVE before you can use the predictor to create a forecast.
    Returns:
    The status of the predictor. States include:
    
    ACTIVE
    
    CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
    
    DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
    
    UPDATE_PENDING, UPDATE_IN_PROGRESS, UPDATE_FAILED
    
    The Status of the predictor must be ACTIVE before you can use the predictor to create a forecast.
  - message
```
public String message()
```
    If an error occurred, an informational message about the error.
    
    Returns:
    
    If an error occurred, an informational message about the error.
  - creationTime
```
public Instant creationTime()
```
    When the model training task was created.
    
    Returns:
    
    When the model training task was created.
  - lastModificationTime
```
public Instant lastModificationTime()
```
    Initially, the same as CreationTime (when the status is CREATE_PENDING). This value is updated when training starts (when the status changes to CREATE_IN_PROGRESS), and when training has completed (when the status changes to ACTIVE) or fails (when the status changes to CREATE_FAILED).
    
    Returns:
    
    Initially, the same as CreationTime (when the status is CREATE_PENDING). This value is updated when training starts (when the status changes to CREATE_IN_PROGRESS), and when training has completed (when the status changes to ACTIVE) or fails (when the status changes to CREATE_FAILED).
  - toBuilder
```
public DescribePredictorResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribePredictorResponse.Builder,DescribePredictorResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribePredictorResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribePredictorResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribePredictorResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.forecast.model.ForecastResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

predictorArn

predictorName

algorithmArn

forecastHorizon

hasForecastTypes

forecastTypes

performAutoML

performHPO

hasTrainingParameters

trainingParameters

evaluationParameters

hpoConfig

inputDataConfig

featurizationConfig

encryptionConfig

predictorExecutionDetails

hasDatasetImportJobArns

datasetImportJobArns

hasAutoMLAlgorithmArns

autoMLAlgorithmArns

status

message

creationTime

lastModificationTime

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields