Class ForecastExportJobSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ForecastExportJobSummary.Builder,
ForecastExportJobSummary>
Provides a summary of the forecast export job properties used in the ListForecastExportJobs operation. To get
the complete set of properties, call the DescribeForecastExportJob operation, and provide the listed
ForecastExportJobArn
.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Instant
When the forecast export job was created.final DataDestination
The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The Amazon Resource Name (ARN) of the forecast export job.final String
The name of the forecast export job.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
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 ForecastExportJobSummary.Builder> final String
status()
The status of the forecast export job.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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
forecastExportJobArn
The Amazon Resource Name (ARN) of the forecast export job.
- Returns:
- The Amazon Resource Name (ARN) of the forecast export job.
-
forecastExportJobName
The name of the forecast export job.
- Returns:
- The name of the forecast export job.
-
destination
The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.
- Returns:
- The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.
-
status
The status of the forecast export job. 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 forecast export job must beACTIVE
before you can access the forecast in your S3 bucket.- Returns:
- The status of the forecast export job. 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 forecast export job must beACTIVE
before you can access the forecast in your S3 bucket. -
-
-
message
If an error occurred, an informational message about the error.
- Returns:
- If an error occurred, an informational message about the error.
-
creationTime
When the forecast export job was created.
- Returns:
- When the forecast export job was created.
-
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.
-
-
-
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<ForecastExportJobSummary.Builder,
ForecastExportJobSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
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
-
sdkFields
-