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

Class TimeAlignmentBoundary

java.lang.Object

software.amazon.awssdk.services.forecast.model.TimeAlignmentBoundary

All Implemented Interfaces:

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

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

The time boundary Forecast uses to align and aggregate your data to match your forecast frequency. Provide the unit of time and the time boundary as a key value pair. If you don't provide a time boundary, Forecast uses a set of Default Time Boundaries.

For more information about aggregation, see Data Aggregation for Different Forecast Frequencies. For more information setting a custom time boundary, see Specifying a Time Boundary.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TimeAlignmentBoundary.Builder

Method Summary

Modifier and Type	Method	Description
static TimeAlignmentBoundary.Builder	builder()
Integer	dayOfMonth()	The day of the month to use for time alignment during aggregation.
DayOfWeek	dayOfWeek()	The day of week to use for time alignment during aggregation.
String	dayOfWeekAsString()	The day of week to use for time alignment during aggregation.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	hour()	The hour of day to use for time alignment during aggregation.
Month	month()	The month to use for time alignment during aggregation.
String	monthAsString()	The month to use for time alignment during aggregation.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends TimeAlignmentBoundary.Builder>	serializableBuilderClass()
TimeAlignmentBoundary.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

month

public final Month month()

The month to use for time alignment during aggregation. The month must be in uppercase.

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

Returns:

The month to use for time alignment during aggregation. The month must be in uppercase.

See Also:

Month

monthAsString

public final String monthAsString()

The month to use for time alignment during aggregation. The month must be in uppercase.

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

Returns:

The month to use for time alignment during aggregation. The month must be in uppercase.

See Also:

Month

dayOfMonth

public final Integer dayOfMonth()

The day of the month to use for time alignment during aggregation.

Returns:

The day of the month to use for time alignment during aggregation.

dayOfWeek

public final DayOfWeek dayOfWeek()

The day of week to use for time alignment during aggregation. The day must be in uppercase.

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

Returns:

The day of week to use for time alignment during aggregation. The day must be in uppercase.

See Also:

DayOfWeek

dayOfWeekAsString

public final String dayOfWeekAsString()

The day of week to use for time alignment during aggregation. The day must be in uppercase.

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

Returns:

The day of week to use for time alignment during aggregation. The day must be in uppercase.

See Also:

DayOfWeek

hour

public final Integer hour()

The hour of day to use for time alignment during aggregation.

Returns:

The hour of day to use for time alignment during aggregation.

toBuilder

public TimeAlignmentBoundary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TimeAlignmentBoundary.Builder,TimeAlignmentBoundary>

builder

public static TimeAlignmentBoundary.Builder builder()

serializableBuilderClass

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