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

Class CreateWhatIfAnalysisRequest

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.CreateWhatIfAnalysisRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateWhatIfAnalysisRequest.Builder,CreateWhatIfAnalysisRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateWhatIfAnalysisRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateWhatIfAnalysisRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	forecastArn()	The Amazon Resource Name (ARN) of the baseline forecast.
<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.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateWhatIfAnalysisRequest.Builder>	serializableBuilderClass()
List<Tag>	tags()	A list of tags to apply to the what if forecast.
TimeSeriesSelector	timeSeriesSelector()	Defines the set of time series that are used in the what-if analysis with a TimeSeriesIdentifiers object.
CreateWhatIfAnalysisRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	whatIfAnalysisName()	The name of the what-if analysis.

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

whatIfAnalysisName

public final String whatIfAnalysisName()

The name of the what-if analysis. Each name must be unique.

Returns:

The name of the what-if analysis. Each name must be unique.

forecastArn

public final String forecastArn()

The Amazon Resource Name (ARN) of the baseline forecast.

Returns:

The Amazon Resource Name (ARN) of the baseline forecast.

timeSeriesSelector

public final TimeSeriesSelector timeSeriesSelector()

Defines the set of time series that are used in the what-if analysis with a TimeSeriesIdentifiers object. What-if analyses are performed only for the time series in this object.

The TimeSeriesIdentifiers object needs the following information:

• DataSource

• Format

• Schema

Returns:

Defines the set of time series that are used in the what-if analysis with a TimeSeriesIdentifiers object. What-if analyses are performed only for the time series in this object.

The TimeSeriesIdentifiers object needs the following information:

• DataSource

• Format

• Schema

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 CreateWhatIfAnalysisRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateWhatIfAnalysisRequest.Builder,CreateWhatIfAnalysisRequest>

Specified by:

toBuilder in class ForecastRequest

builder

public static CreateWhatIfAnalysisRequest.Builder builder()

serializableBuilderClass

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