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

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeAutoPredictorResponse.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DescribeAutoPredictorResponse.Builder`	`builder()`
`Instant`	`creationTime()` The timestamp of the CreateAutoPredictor request.
`DataConfig`	`dataConfig()` The data configuration for your dataset group and any additional datasets.
`List<String>`	`datasetImportJobArns()` An array of the ARNs of the dataset import jobs used to import training data for the predictor.
`EncryptionConfig`	`encryptionConfig()` Returns the value of the EncryptionConfig property for this object.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Long`	`estimatedTimeRemainingInMinutes()` The estimated time remaining in minutes for the predictor training job to complete.
`ExplainabilityInfo`	`explainabilityInfo()` Provides the status and ARN of the Predictor Explainability.
`List<String>`	`forecastDimensions()` An array of dimension (field) names that specify the attributes used to group your time series.
`String`	`forecastFrequency()` The frequency of predictions in a forecast.
`Integer`	`forecastHorizon()` The number of time-steps that the model predicts.
`List<String>`	`forecastTypes()` The forecast types used during predictor training.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasDatasetImportJobArns()` For responses, this returns true if the service returned a value for the DatasetImportJobArns property.
`boolean`	`hasForecastDimensions()` For responses, this returns true if the service returned a value for the ForecastDimensions property.
`boolean`	`hasForecastTypes()` For responses, this returns true if the service returned a value for the ForecastTypes property.
`int`	`hashCode()`
`Instant`	`lastModificationTime()` The last time the resource was modified.
`String`	`message()` In the event of an error, a message detailing the cause of the error.
`MonitorInfo`	`monitorInfo()` A object with the Amazon Resource Name (ARN) and status of the monitor resource.
`OptimizationMetric`	`optimizationMetric()` The accuracy metric used to optimize the predictor.
`String`	`optimizationMetricAsString()` The accuracy metric used to optimize the predictor.
`String`	`predictorArn()` The Amazon Resource Name (ARN) of the predictor
`String`	`predictorName()` The name of the predictor.
`ReferencePredictorSummary`	`referencePredictorSummary()` The ARN and state of the reference predictor.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeAutoPredictorResponse.Builder>`	`serializableBuilderClass()`
`String`	`status()` The status of the predictor.
`TimeAlignmentBoundary`	`timeAlignmentBoundary()` The time boundary Forecast uses when aggregating data.
`DescribeAutoPredictorResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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 final String predictorArn()
```
    The Amazon Resource Name (ARN) of the predictor
    
    Returns:
    
    The Amazon Resource Name (ARN) of the predictor
  - predictorName
```
public final String predictorName()
```
    The name of the predictor.
    
    Returns:
    
    The name of the predictor.
  - forecastHorizon
```
public final Integer forecastHorizon()
```
    The number of time-steps that the model predicts. The forecast horizon is also called the prediction length.
    
    Returns:
    
    The number of time-steps that the model predicts. The forecast horizon is also called the prediction length.
  - hasForecastTypes
```
public final boolean hasForecastTypes()
```
    For responses, this returns true if the service returned a value for the ForecastTypes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - forecastTypes
```
public final 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasForecastTypes() method.
    
    Returns:
    
    The forecast types used during predictor training. Default value is ["0.1","0.5","0.9"].
  - forecastFrequency
```
public final 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.
    
    Returns:
    
    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.
  - hasForecastDimensions
```
public final boolean hasForecastDimensions()
```
    For responses, this returns true if the service returned a value for the ForecastDimensions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - forecastDimensions
```
public final List<String> forecastDimensions()
```
    An array of dimension (field) names that specify the attributes used to group your time series.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasForecastDimensions() method.
    
    Returns:
    
    An array of dimension (field) names that specify the attributes used to group your time series.
  - hasDatasetImportJobArns
```
public final boolean hasDatasetImportJobArns()
```
    For responses, this returns true if the service returned a value for the DatasetImportJobArns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - datasetImportJobArns
```
public final 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDatasetImportJobArns() method.
    
    Returns:
    
    An array of the ARNs of the dataset import jobs used to import training data for the predictor.
  - dataConfig
```
public final DataConfig dataConfig()
```
    The data configuration for your dataset group and any additional datasets.
    
    Returns:
    
    The data configuration for your dataset group and any additional datasets.
  - encryptionConfig
```
public final EncryptionConfig encryptionConfig()
```
    Returns the value of the EncryptionConfig property for this object.
    
    Returns:
    
    The value of the EncryptionConfig property for this object.
  - referencePredictorSummary
```
public final ReferencePredictorSummary referencePredictorSummary()
```
    The ARN and state of the reference predictor. This parameter is only valid for retrained or upgraded predictors.
    
    Returns:
    
    The ARN and state of the reference predictor. This parameter is only valid for retrained or upgraded predictors.
  - estimatedTimeRemainingInMinutes
```
public final Long estimatedTimeRemainingInMinutes()
```
    The estimated time remaining in minutes for the predictor training job to complete.
    
    Returns:
    
    The estimated time remaining in minutes for the predictor training job to complete.
  - status
```
public final 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
    Returns:
    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
  - message
```
public final String message()
```
    In the event of an error, a message detailing the cause of the error.
    
    Returns:
    
    In the event of an error, a message detailing the cause of the error.
  - creationTime
```
public final Instant creationTime()
```
    The timestamp of the CreateAutoPredictor request.
    
    Returns:
    
    The timestamp of the CreateAutoPredictor request.
  - lastModificationTime
```
public final 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.
    Returns:
    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.
  - optimizationMetric
```
public final OptimizationMetric optimizationMetric()
```
    The accuracy metric used to optimize the predictor.
    
    If the service returns an enum value that is not available in the current SDK version, optimizationMetric will return OptimizationMetric.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from optimizationMetricAsString().
    
    Returns:
    
    The accuracy metric used to optimize the predictor.
    
    See Also:
    
    OptimizationMetric
  - optimizationMetricAsString
```
public final String optimizationMetricAsString()
```
    The accuracy metric used to optimize the predictor.
    
    If the service returns an enum value that is not available in the current SDK version, optimizationMetric will return OptimizationMetric.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from optimizationMetricAsString().
    
    Returns:
    
    The accuracy metric used to optimize the predictor.
    
    See Also:
    
    OptimizationMetric
  - explainabilityInfo
```
public final ExplainabilityInfo explainabilityInfo()
```
    Provides the status and ARN of the Predictor Explainability.
    
    Returns:
    
    Provides the status and ARN of the Predictor Explainability.
  - monitorInfo
```
public final MonitorInfo monitorInfo()
```
    A object with the Amazon Resource Name (ARN) and status of the monitor resource.
    
    Returns:
    
    A object with the Amazon Resource Name (ARN) and status of the monitor resource.
  - timeAlignmentBoundary
```
public final TimeAlignmentBoundary timeAlignmentBoundary()
```
    The time boundary Forecast uses when aggregating data.
    
    Returns:
    
    The time boundary Forecast uses when aggregating data.
  - toBuilder
```
public DescribeAutoPredictorResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeAutoPredictorResponse.Builder,DescribeAutoPredictorResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribeAutoPredictorResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeAutoPredictorResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeAutoPredictorResponse

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

forecastHorizon

hasForecastTypes

forecastTypes

forecastFrequency

hasForecastDimensions

forecastDimensions

hasDatasetImportJobArns

datasetImportJobArns

dataConfig

encryptionConfig

referencePredictorSummary

estimatedTimeRemainingInMinutes

status

message

creationTime

lastModificationTime

optimizationMetric

optimizationMetricAsString

explainabilityInfo

monitorInfo

timeAlignmentBoundary

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields