software.amazon.awssdk.services.forecast.model

Class CreateWhatIfForecastRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.forecast.model.ForecastRequest

software.amazon.awssdk.services.forecast.model.CreateWhatIfForecastRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateWhatIfForecastRequest.Builder,CreateWhatIfForecastRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateWhatIfForecastRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateWhatIfForecastRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
boolean	hasTimeSeriesTransformations() For responses, this returns true if the service returned a value for the TimeSeriesTransformations property.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateWhatIfForecastRequest.Builder>	serializableBuilderClass()
List<Tag>	tags() A list of tags to apply to the what if forecast.
TimeSeriesReplacementsDataSource	timeSeriesReplacementsDataSource() The replacement time series dataset, which contains the rows that you want to change in the related time series dataset.
List<TimeSeriesTransformation>	timeSeriesTransformations() The transformations that are applied to the baseline time series.
CreateWhatIfForecastRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	whatIfAnalysisArn() The Amazon Resource Name (ARN) of the what-if analysis.
String	whatIfForecastName() The name of the what-if forecast.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

whatIfForecastName

public final String whatIfForecastName()

The name of the what-if forecast. Names must be unique within each what-if analysis.

Returns:

The name of the what-if forecast. Names must be unique within each what-if analysis.

whatIfAnalysisArn

public final String whatIfAnalysisArn()

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

Returns:

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

hasTimeSeriesTransformations

public final boolean hasTimeSeriesTransformations()

For responses, this returns true if the service returned a value for the TimeSeriesTransformations 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.

timeSeriesTransformations

public final List<TimeSeriesTransformation> timeSeriesTransformations()

The transformations that are applied to the baseline time series. Each transformation contains an action and a set of conditions. An action is applied only when all conditions are met. If no conditions are provided, the action is applied to all items.

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 hasTimeSeriesTransformations() method.

Returns:

The transformations that are applied to the baseline time series. Each transformation contains an action and a set of conditions. An action is applied only when all conditions are met. If no conditions are provided, the action is applied to all items.

timeSeriesReplacementsDataSource

public final TimeSeriesReplacementsDataSource timeSeriesReplacementsDataSource()

The replacement time series dataset, which contains the rows that you want to change in the related time series dataset. A replacement time series does not need to contain all rows that are in the baseline related time series. Include only the rows (measure-dimension combinations) that you want to include in the what-if forecast.

This dataset is merged with the original time series to create a transformed dataset that is used for the what-if analysis.

This dataset should contain the items to modify (such as item_id or workforce_type), any relevant dimensions, the timestamp column, and at least one of the related time series columns. This file should not contain duplicate timestamps for the same time series.

Timestamps and item_ids not included in this dataset are not included in the what-if analysis.

Returns:

The replacement time series dataset, which contains the rows that you want to change in the related time series dataset. A replacement time series does not need to contain all rows that are in the baseline related time series. Include only the rows (measure-dimension combinations) that you want to include in the what-if forecast.

This dataset is merged with the original time series to create a transformed dataset that is used for the what-if analysis.

This dataset should contain the items to modify (such as item_id or workforce_type), any relevant dimensions, the timestamp column, and at least one of the related time series columns. This file should not contain duplicate timestamps for the same time series.

Timestamps and item_ids not included in this dataset are not included in the what-if analysis.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags 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.

tags

public final List<Tag> tags()

A list of tags to apply to the what if forecast.

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 hasTags() method.

Returns:

A list of tags to apply to the what if forecast.

toBuilder

public CreateWhatIfForecastRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateWhatIfForecastRequest.Builder,CreateWhatIfForecastRequest>

Specified by:

toBuilder in class ForecastRequest

builder

public static CreateWhatIfForecastRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo