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

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeForecastResponse.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DescribeForecastResponse.Builder`	`builder()`
`Instant`	`creationTime()` When the forecast creation task was created.
`String`	`datasetGroupArn()` The ARN of the dataset group that provided the data used to train the predictor.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`forecastArn()` The forecast ARN as specified in the request.
`String`	`forecastName()` The name of the forecast.
`List<String>`	`forecastTypes()` The quantiles at which probabilistic forecasts were generated.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`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()`
`Instant`	`lastModificationTime()` Initially, the same as `CreationTime` (status is `CREATE_PENDING`).
`String`	`message()` If an error occurred, an informational message about the error.
`String`	`predictorArn()` The ARN of the predictor used to generate the forecast.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeForecastResponse.Builder>`	`serializableBuilderClass()`
`String`	`status()` The status of the forecast.
`DescribeForecastResponse.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
  - forecastArn
```
public String forecastArn()
```
    The forecast ARN as specified in the request.
    
    Returns:
    
    The forecast ARN as specified in the request.
  - forecastName
```
public String forecastName()
```
    The name of the forecast.
    
    Returns:
    
    The name of the forecast.
  - 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 quantiles at which probabilistic forecasts were generated.
    
    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 quantiles at which probabilistic forecasts were generated.
  - predictorArn
```
public String predictorArn()
```
    The ARN of the predictor used to generate the forecast.
    
    Returns:
    
    The ARN of the predictor used to generate the forecast.
  - datasetGroupArn
```
public String datasetGroupArn()
```
    The ARN of the dataset group that provided the data used to train the predictor.
    
    Returns:
    
    The ARN of the dataset group that provided the data used to train the predictor.
  - status
```
public String status()
```
    The status of the forecast. States include:
    - ACTIVE
    - CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
    - DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
    The Status of the forecast must be ACTIVE before you can query or export the forecast.
    Returns:
    The status of the forecast. States include:
    
    ACTIVE
    
    CREATE_PENDING, CREATE_IN_PROGRESS, CREATE_FAILED
    
    DELETE_PENDING, DELETE_IN_PROGRESS, DELETE_FAILED
    
    The Status of the forecast must be ACTIVE before you can query or export the 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 forecast creation task was created.
    
    Returns:
    
    When the forecast creation task was created.
  - lastModificationTime
```
public Instant lastModificationTime()
```
    Initially, the same as CreationTime (status is CREATE_PENDING). Updated when inference (creating the forecast) starts (status changed to CREATE_IN_PROGRESS), and when inference is complete (status changed to ACTIVE) or fails (status changed to CREATE_FAILED).
    
    Returns:
    
    Initially, the same as CreationTime (status is CREATE_PENDING). Updated when inference (creating the forecast) starts (status changed to CREATE_IN_PROGRESS), and when inference is complete (status changed to ACTIVE) or fails (status changed to CREATE_FAILED).
  - toBuilder
```
public DescribeForecastResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeForecastResponse.Builder,DescribeForecastResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribeForecastResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeForecastResponse.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 DescribeForecastResponse

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

forecastArn

forecastName

hasForecastTypes

forecastTypes

predictorArn

datasetGroupArn

status

message

creationTime

lastModificationTime

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields