Class TimeAlignmentBoundary
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Integer
The day of the month to use for time alignment during aggregation.final DayOfWeek
The day of week to use for time alignment during aggregation.final String
The day of week to use for time alignment during aggregation.final boolean
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 Integer
hour()
The hour of day to use for time alignment during aggregation.final Month
month()
The month to use for time alignment during aggregation.final String
The month to use for time alignment during aggregation.static Class
<? extends TimeAlignmentBoundary.Builder> 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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 returnMonth.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommonthAsString()
.- Returns:
- The month to use for time alignment during aggregation. The month must be in uppercase.
- See Also:
-
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 returnMonth.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommonthAsString()
.- Returns:
- The month to use for time alignment during aggregation. The month must be in uppercase.
- See Also:
-
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
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 returnDayOfWeek.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdayOfWeekAsString()
.- Returns:
- The day of week to use for time alignment during aggregation. The day must be in uppercase.
- See Also:
-
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 returnDayOfWeek.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdayOfWeekAsString()
.- Returns:
- The day of week to use for time alignment during aggregation. The day must be in uppercase.
- See Also:
-
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
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 interfaceToCopyableBuilder<TimeAlignmentBoundary.Builder,
TimeAlignmentBoundary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-