Package software.amazon.awssdk.services.connect.model

Class IntervalDetails

java.lang.Object

software.amazon.awssdk.services.connect.model.IntervalDetails

All Implemented Interfaces:

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

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

Information about the interval period to use for returning results.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IntervalDetails.Builder

Method Summary

Modifier and Type	Method	Description
static IntervalDetails.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
IntervalPeriod	intervalPeriod()	IntervalPeriod: An aggregated grouping applied to request metrics.
String	intervalPeriodAsString()	IntervalPeriod: An aggregated grouping applied to request metrics.
List<SdkField<?>>	sdkFields()
static Class<? extends IntervalDetails.Builder>	serializableBuilderClass()
String	timeZone()	The timezone applied to requested metrics.
IntervalDetails.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

timeZone

public final String timeZone()

The timezone applied to requested metrics.

Returns:

The timezone applied to requested metrics.

intervalPeriod

public final IntervalPeriod intervalPeriod()

IntervalPeriod: An aggregated grouping applied to request metrics. Valid IntervalPeriod values are: FIFTEEN_MIN | THIRTY_MIN | HOUR | DAY | WEEK | TOTAL.

For example, if IntervalPeriod is selected THIRTY_MIN, StartTime and EndTime 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 the TOTAL interval period.

The following list describes restrictions on StartTime and EndTime based on what IntervalPeriod is requested.

• FIFTEEN_MIN: The difference between StartTime and EndTime must be less than 3 days.

• THIRTY_MIN: The difference between StartTime and EndTime must be less than 3 days.

• HOUR: The difference between StartTime and EndTime must be less than 3 days.

• DAY: The difference between StartTime and EndTime must be less than 35 days.

• WEEK: The difference between StartTime and EndTime must be less than 35 days.

• TOTAL: The difference between StartTime and EndTime must be less than 35 days.

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

Returns:

IntervalPeriod: An aggregated grouping applied to request metrics. Valid IntervalPeriod values are: FIFTEEN_MIN | THIRTY_MIN | HOUR | DAY | WEEK | TOTAL.

For example, if IntervalPeriod is selected THIRTY_MIN, StartTime and EndTime 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 the TOTAL interval period.

The following list describes restrictions on StartTime and EndTime based on what IntervalPeriod is requested.

• FIFTEEN_MIN: The difference between StartTime and EndTime must be less than 3 days.

• THIRTY_MIN: The difference between StartTime and EndTime must be less than 3 days.

• HOUR: The difference between StartTime and EndTime must be less than 3 days.

• DAY: The difference between StartTime and EndTime must be less than 35 days.

• WEEK: The difference between StartTime and EndTime must be less than 35 days.

• TOTAL: The difference between StartTime and EndTime must be less than 35 days.

See Also:

IntervalPeriod

intervalPeriodAsString

public final String intervalPeriodAsString()

IntervalPeriod: An aggregated grouping applied to request metrics. Valid IntervalPeriod values are: FIFTEEN_MIN | THIRTY_MIN | HOUR | DAY | WEEK | TOTAL.

For example, if IntervalPeriod is selected THIRTY_MIN, StartTime and EndTime 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 the TOTAL interval period.

The following list describes restrictions on StartTime and EndTime based on what IntervalPeriod is requested.

• FIFTEEN_MIN: The difference between StartTime and EndTime must be less than 3 days.

• THIRTY_MIN: The difference between StartTime and EndTime must be less than 3 days.

• HOUR: The difference between StartTime and EndTime must be less than 3 days.

• DAY: The difference between StartTime and EndTime must be less than 35 days.

• WEEK: The difference between StartTime and EndTime must be less than 35 days.

• TOTAL: The difference between StartTime and EndTime must be less than 35 days.

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

Returns:

IntervalPeriod: An aggregated grouping applied to request metrics. Valid IntervalPeriod values are: FIFTEEN_MIN | THIRTY_MIN | HOUR | DAY | WEEK | TOTAL.

For example, if IntervalPeriod is selected THIRTY_MIN, StartTime and EndTime 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 the TOTAL interval period.

The following list describes restrictions on StartTime and EndTime based on what IntervalPeriod is requested.

• FIFTEEN_MIN: The difference between StartTime and EndTime must be less than 3 days.

• THIRTY_MIN: The difference between StartTime and EndTime must be less than 3 days.

• HOUR: The difference between StartTime and EndTime must be less than 3 days.

• DAY: The difference between StartTime and EndTime must be less than 35 days.

• WEEK: The difference between StartTime and EndTime must be less than 35 days.

• TOTAL: The difference between StartTime and EndTime must be less than 35 days.

See Also:

IntervalPeriod

toBuilder

public IntervalDetails.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<IntervalDetails.Builder,IntervalDetails>

builder

public static IntervalDetails.Builder builder()

serializableBuilderClass

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