software.amazon.awssdk.services.forecast.model

Class WhatIfForecastExportSummary

java.lang.Object

software.amazon.awssdk.services.forecast.model.WhatIfForecastExportSummary

All Implemented Interfaces:

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

@Generated(value="software.amazon.awssdk:codegen")
public final class WhatIfForecastExportSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<WhatIfForecastExportSummary.Builder,WhatIfForecastExportSummary>

Provides a summary of the what-if forecast export properties used in the ListWhatIfForecastExports operation. To get the complete set of properties, call the DescribeWhatIfForecastExport operation, and provide the WhatIfForecastExportArn that is listed in the summary.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	WhatIfForecastExportSummary.Builder

Method Summary

Modifier and Type	Method and Description
static WhatIfForecastExportSummary.Builder	builder()
Instant	creationTime() When the what-if forecast export 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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasWhatIfForecastArns() For responses, this returns true if the service returned a value for the WhatIfForecastArns property.
Instant	lastModificationTime() The last time the resource was modified.
String	message() If an error occurred, an informational message about the error.
List<SdkField<?>>	sdkFields()
static Class<? extends WhatIfForecastExportSummary.Builder>	serializableBuilderClass()
String	status() The status of the what-if forecast export.
WhatIfForecastExportSummary.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<String>	whatIfForecastArns() An array of Amazon Resource Names (ARNs) that define the what-if forecasts included in the export.
String	whatIfForecastExportArn() The Amazon Resource Name (ARN) of the what-if forecast export.
String	whatIfForecastExportName() The what-if forecast export name.

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

whatIfForecastExportArn

public final String whatIfForecastExportArn()

The Amazon Resource Name (ARN) of the what-if forecast export.

Returns:

The Amazon Resource Name (ARN) 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 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.

whatIfForecastArns

public final List<String> whatIfForecastArns()

An array of Amazon Resource Names (ARNs) that define the what-if forecasts included in the export.

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 define the what-if forecasts included in the export.

whatIfForecastExportName

public final String whatIfForecastExportName()

The what-if forecast export name.

Returns:

The what-if forecast export name.

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 what-if forecast export. 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 analysis must be ACTIVE before you can access the analysis.

Returns:

The status of the what-if forecast export. 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 analysis must be ACTIVE before you can access the analysis.

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 what-if forecast export was created.

Returns:

When the what-if forecast export 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 WhatIfForecastExportSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<WhatIfForecastExportSummary.Builder,WhatIfForecastExportSummary>

builder

public static WhatIfForecastExportSummary.Builder builder()

serializableBuilderClass

public static Class<? extends WhatIfForecastExportSummary.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