Class IntervalDetails
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<IntervalDetails.Builder,
IntervalDetails>
Information about the interval period to use for returning results.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic IntervalDetails.Builder
builder()
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 IntervalPeriod
IntervalPeriod
: An aggregated grouping applied to request metrics.final String
IntervalPeriod
: An aggregated grouping applied to request metrics.static Class
<? extends IntervalDetails.Builder> final String
timeZone()
The timezone applied to requested metrics.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
-
timeZone
The timezone applied to requested metrics.
- Returns:
- The timezone applied to requested metrics.
-
intervalPeriod
IntervalPeriod
: An aggregated grouping applied to request metrics. ValidIntervalPeriod
values are:FIFTEEN_MIN
|THIRTY_MIN
|HOUR
|DAY
|WEEK
|TOTAL
.For example, if
IntervalPeriod
is selectedTHIRTY_MIN
,StartTime
andEndTime
differs by 1 day, then Amazon Connect returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By default Amazon Connect aggregates results based on theTOTAL
interval period.The following list describes restrictions on
StartTime
andEndTime
based on whatIntervalPeriod
is requested.-
FIFTEEN_MIN
: The difference betweenStartTime
andEndTime
must be less than 3 days. -
THIRTY_MIN
: The difference betweenStartTime
andEndTime
must be less than 3 days. -
HOUR
: The difference betweenStartTime
andEndTime
must be less than 3 days. -
DAY
: The difference betweenStartTime
andEndTime
must be less than 35 days. -
WEEK
: The difference betweenStartTime
andEndTime
must be less than 35 days. -
TOTAL
: The difference betweenStartTime
andEndTime
must be less than 35 days.
If the service returns an enum value that is not available in the current SDK version,
intervalPeriod
will returnIntervalPeriod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromintervalPeriodAsString()
.- Returns:
IntervalPeriod
: An aggregated grouping applied to request metrics. ValidIntervalPeriod
values are:FIFTEEN_MIN
|THIRTY_MIN
|HOUR
|DAY
|WEEK
|TOTAL
.For example, if
IntervalPeriod
is selectedTHIRTY_MIN
,StartTime
andEndTime
differs by 1 day, then Amazon Connect returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By default Amazon Connect aggregates results based on theTOTAL
interval period.The following list describes restrictions on
StartTime
andEndTime
based on whatIntervalPeriod
is requested.-
FIFTEEN_MIN
: The difference betweenStartTime
andEndTime
must be less than 3 days. -
THIRTY_MIN
: The difference betweenStartTime
andEndTime
must be less than 3 days. -
HOUR
: The difference betweenStartTime
andEndTime
must be less than 3 days. -
DAY
: The difference betweenStartTime
andEndTime
must be less than 35 days. -
WEEK
: The difference betweenStartTime
andEndTime
must be less than 35 days. -
TOTAL
: The difference betweenStartTime
andEndTime
must be less than 35 days.
-
- See Also:
-
-
intervalPeriodAsString
IntervalPeriod
: An aggregated grouping applied to request metrics. ValidIntervalPeriod
values are:FIFTEEN_MIN
|THIRTY_MIN
|HOUR
|DAY
|WEEK
|TOTAL
.For example, if
IntervalPeriod
is selectedTHIRTY_MIN
,StartTime
andEndTime
differs by 1 day, then Amazon Connect returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By default Amazon Connect aggregates results based on theTOTAL
interval period.The following list describes restrictions on
StartTime
andEndTime
based on whatIntervalPeriod
is requested.-
FIFTEEN_MIN
: The difference betweenStartTime
andEndTime
must be less than 3 days. -
THIRTY_MIN
: The difference betweenStartTime
andEndTime
must be less than 3 days. -
HOUR
: The difference betweenStartTime
andEndTime
must be less than 3 days. -
DAY
: The difference betweenStartTime
andEndTime
must be less than 35 days. -
WEEK
: The difference betweenStartTime
andEndTime
must be less than 35 days. -
TOTAL
: The difference betweenStartTime
andEndTime
must be less than 35 days.
If the service returns an enum value that is not available in the current SDK version,
intervalPeriod
will returnIntervalPeriod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromintervalPeriodAsString()
.- Returns:
IntervalPeriod
: An aggregated grouping applied to request metrics. ValidIntervalPeriod
values are:FIFTEEN_MIN
|THIRTY_MIN
|HOUR
|DAY
|WEEK
|TOTAL
.For example, if
IntervalPeriod
is selectedTHIRTY_MIN
,StartTime
andEndTime
differs by 1 day, then Amazon Connect returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By default Amazon Connect aggregates results based on theTOTAL
interval period.The following list describes restrictions on
StartTime
andEndTime
based on whatIntervalPeriod
is requested.-
FIFTEEN_MIN
: The difference betweenStartTime
andEndTime
must be less than 3 days. -
THIRTY_MIN
: The difference betweenStartTime
andEndTime
must be less than 3 days. -
HOUR
: The difference betweenStartTime
andEndTime
must be less than 3 days. -
DAY
: The difference betweenStartTime
andEndTime
must be less than 35 days. -
WEEK
: The difference betweenStartTime
andEndTime
must be less than 35 days. -
TOTAL
: The difference betweenStartTime
andEndTime
must be less than 35 days.
-
- See Also:
-
-
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<IntervalDetails.Builder,
IntervalDetails> - 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
-