Package software.amazon.awssdk.services.forecast.model

Class ForecastExportJobSummary

java.lang.Object

software.amazon.awssdk.services.forecast.model.ForecastExportJobSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ForecastExportJobSummary.Builder,ForecastExportJobSummary>

@Generated("software.amazon.awssdk:codegen")
public final class ForecastExportJobSummary
extends Object
implements SdkPojo, Serializable, 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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ForecastExportJobSummary.Builder

Method Summary

Modifier and Type	Method	Description
static ForecastExportJobSummary.Builder	builder()
Instant	creationTime()	When the forecast export job was created.
DataDestination	destination()	The path to the Amazon Simple Storage Service (Amazon S3) bucket where the forecast is exported.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	forecastExportJobArn()	The Amazon Resource Name (ARN) of the forecast export job.
String	forecastExportJobName()	The name of the forecast export job.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastModificationTime()	The last time the resource was modified.
String	message()	If an error occurred, an informational message about the error.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ForecastExportJobSummary.Builder>	serializableBuilderClass()
String	status()	The status of the forecast export job.
ForecastExportJobSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

forecastExportJobArn

public final String forecastExportJobArn()

The Amazon Resource Name (ARN) of the forecast export job.

Returns:

The Amazon Resource Name (ARN) of the forecast export job.

forecastExportJobName

public final String forecastExportJobName()

The name of the forecast export job.

Returns:

The name of the forecast export job.

destination

public final DataDestination 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

public final String 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 be ACTIVE 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 be ACTIVE before you can access the forecast in your S3 bucket.

message

public final 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 final Instant creationTime()

When the forecast export job was created.

Returns:

When the forecast export job was created.

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.

toBuilder

public ForecastExportJobSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ForecastExportJobSummary.Builder,ForecastExportJobSummary>

builder

public static ForecastExportJobSummary.Builder builder()

serializableBuilderClass

public static Class<? extends ForecastExportJobSummary.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo