Class DescribeWhatIfForecastExportResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeWhatIfForecastExportResponse.Builder,
DescribeWhatIfForecastExportResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Instant
When the what-if forecast export was created.final DataDestination
Returns the value of the Destination property for this object.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Long
The approximate time remaining to complete the what-if forecast export, in minutes.final String
format()
The format of the exported data, CSV or PARQUET.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the WhatIfForecastArns property.final Instant
The last time the resource was modified.final String
message()
If an error occurred, an informational message about the error.static Class
<? extends DescribeWhatIfForecastExportResponse.Builder> final String
status()
The status of the what-if forecast.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.An array of Amazon Resource Names (ARNs) that represent all of the what-if forecasts exported in this resource.final String
The Amazon Resource Name (ARN) of the what-if forecast export.final String
The name of the what-if forecast export.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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
whatIfForecastExportArn
The Amazon Resource Name (ARN) of the what-if forecast export.
- Returns:
- The Amazon Resource Name (ARN) of the what-if forecast export.
-
whatIfForecastExportName
The name of the what-if forecast export.
- Returns:
- The name of the what-if forecast export.
-
hasWhatIfForecastArns
public final boolean hasWhatIfForecastArns()For responses, this returns true if the service returned a value for the WhatIfForecastArns property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
whatIfForecastArns
An array of Amazon Resource Names (ARNs) that represent all of the what-if forecasts exported in this resource.
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
hasWhatIfForecastArns()
method.- Returns:
- An array of Amazon Resource Names (ARNs) that represent all of the what-if forecasts exported in this resource.
-
destination
Returns the value of the Destination property for this object.- Returns:
- The value of the Destination property for this object.
-
message
If an error occurred, an informational message about the error.
- Returns:
- If an error occurred, an informational message about the error.
-
status
The status of the what-if forecast. States include:
-
ACTIVE
-
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
-
CREATE_STOPPING
,CREATE_STOPPED
-
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
The
Status
of the what-if forecast export must beACTIVE
before you can access the forecast export.- Returns:
- The status of the what-if forecast. States include:
-
ACTIVE
-
CREATE_PENDING
,CREATE_IN_PROGRESS
,CREATE_FAILED
-
CREATE_STOPPING
,CREATE_STOPPED
-
DELETE_PENDING
,DELETE_IN_PROGRESS
,DELETE_FAILED
The
Status
of the what-if forecast export must beACTIVE
before you can access the forecast export. -
-
-
creationTime
When the what-if forecast export was created.
- Returns:
- When the what-if forecast export was created.
-
estimatedTimeRemainingInMinutes
The approximate time remaining to complete the what-if forecast export, in minutes.
- Returns:
- The approximate time remaining to complete the what-if forecast export, in minutes.
-
lastModificationTime
The last time the resource was modified. The timestamp depends on the status of the job:
-
CREATE_PENDING
- TheCreationTime
. -
CREATE_IN_PROGRESS
- The current timestamp. -
CREATE_STOPPING
- The current timestamp. -
CREATE_STOPPED
- When the job stopped. -
ACTIVE
orCREATE_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
- TheCreationTime
. -
CREATE_IN_PROGRESS
- The current timestamp. -
CREATE_STOPPING
- The current timestamp. -
CREATE_STOPPED
- When the job stopped. -
ACTIVE
orCREATE_FAILED
- When the job finished or failed.
-
-
-
format
The format of the exported data, CSV or PARQUET.
- Returns:
- The format of the exported data, CSV or PARQUET.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeWhatIfForecastExportResponse.Builder,
DescribeWhatIfForecastExportResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends DescribeWhatIfForecastExportResponse.Builder> serializableBuilderClass() -
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-