Class TimeSeriesForecastingSettings

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.TimeSeriesForecastingSettings

All Implemented Interfaces:

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

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

Time series forecast settings for the SageMaker Canvas application.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TimeSeriesForecastingSettings.Builder

Method Summary

Modifier and Type	Method	Description
final String	amazonForecastRoleArn()	The IAM role that Canvas passes to Amazon Forecast for time series forecasting.
static TimeSeriesForecastingSettings.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final List<SdkField<?>>	sdkFields()
static Class<? extends TimeSeriesForecastingSettings.Builder>	serializableBuilderClass()
final FeatureStatus	status()	Describes whether time series forecasting is enabled or disabled in the Canvas application.
final String	statusAsString()	Describes whether time series forecasting is enabled or disabled in the Canvas application.
TimeSeriesForecastingSettings.Builder	toBuilder()	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 class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Details

status

public final FeatureStatus status()

Describes whether time series forecasting is enabled or disabled in the Canvas application.

If the service returns an enum value that is not available in the current SDK version, status will return FeatureStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

Describes whether time series forecasting is enabled or disabled in the Canvas application.

See Also:

• FeatureStatus

statusAsString

public final String statusAsString()

Describes whether time series forecasting is enabled or disabled in the Canvas application.

If the service returns an enum value that is not available in the current SDK version, status will return FeatureStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

Describes whether time series forecasting is enabled or disabled in the Canvas application.

See Also:

• FeatureStatus

amazonForecastRoleArn

public final String amazonForecastRoleArn()

The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default, Canvas uses the execution role specified in the UserProfile that launches the Canvas application. If an execution role is not specified in the UserProfile, Canvas uses the execution role specified in the Domain that owns the UserProfile. To allow time series forecasting, this IAM role should have the AmazonSageMakerCanvasForecastAccess policy attached and forecast.amazonaws.com added in the trust relationship as a service principal.

Returns:

The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default, Canvas uses the execution role specified in the UserProfile that launches the Canvas application. If an execution role is not specified in the UserProfile, Canvas uses the execution role specified in the Domain that owns the UserProfile. To allow time series forecasting, this IAM role should have the AmazonSageMakerCanvasForecastAccess policy attached and forecast.amazonaws.com added in the trust relationship as a service principal.

toBuilder

public TimeSeriesForecastingSettings.Builder 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 interface ToCopyableBuilder<TimeSeriesForecastingSettings.Builder,TimeSeriesForecastingSettings>

Returns:

a builder for type T

builder

public static TimeSeriesForecastingSettings.Builder builder()

serializableBuilderClass

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

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 an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.