Package com.mypurecloud.sdk.v2.model

Class RateLimitAggregationQuery

java.lang.Object

com.mypurecloud.sdk.v2.model.RateLimitAggregationQuery

All Implemented Interfaces:

Serializable

public class RateLimitAggregationQuery
extends Object
implements Serializable

RateLimitAggregationQuery

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	RateLimitAggregationQuery.AlternateTimeDimensionEnum	Dimension to use as the alternative timestamp for data in the aggregate.
static enum	RateLimitAggregationQuery.GroupByEnum	Gets or Sets groupBy
static enum	RateLimitAggregationQuery.MetricsEnum	Gets or Sets metrics

Constructor Summary

Constructors

Constructor	Description
RateLimitAggregationQuery()
RateLimitAggregationQuery(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
RateLimitAggregationQuery	alternateTimeDimension(RateLimitAggregationQuery.AlternateTimeDimensionEnum alternateTimeDimension)	Dimension to use as the alternative timestamp for data in the aggregate.
boolean	equals(Object o)
RateLimitAggregationQuery	filter(RateLimitAggregateQueryFilter filter)	Behaves like a SQL WHERE clause.
RateLimitAggregationQuery	flattenMultivaluedDimensions(Boolean flattenMultivaluedDimensions)	Flattens any multivalued dimensions used in response groups (e.g.
RateLimitAggregationQuery.AlternateTimeDimensionEnum	getAlternateTimeDimension()
RateLimitAggregateQueryFilter	getFilter()
Boolean	getFlattenMultivaluedDimensions()
String	getGranularity()
List<RateLimitAggregationQuery.GroupByEnum>	getGroupBy()
String	getInterval()
List<RateLimitAggregationQuery.MetricsEnum>	getMetrics()
String	getTimeZone()
List<RateLimitAggregationView>	getViews()
RateLimitAggregationQuery	granularity(String granularity)	Granularity aggregates metrics into subpartitions within the time interval specified.
RateLimitAggregationQuery	groupBy(List<RateLimitAggregationQuery.GroupByEnum> groupBy)	Behaves like a SQL GROUPBY.
int	hashCode()
RateLimitAggregationQuery	interval(String interval)	Behaves like one clause in a SQL WHERE.
RateLimitAggregationQuery	metrics(List<RateLimitAggregationQuery.MetricsEnum> metrics)	Behaves like a SQL SELECT clause.
void	setAlternateTimeDimension(RateLimitAggregationQuery.AlternateTimeDimensionEnum alternateTimeDimension)
void	setFilter(RateLimitAggregateQueryFilter filter)
void	setFlattenMultivaluedDimensions(Boolean flattenMultivaluedDimensions)
void	setGranularity(String granularity)
void	setGroupBy(List<RateLimitAggregationQuery.GroupByEnum> groupBy)
void	setInterval(String interval)
void	setMetrics(List<RateLimitAggregationQuery.MetricsEnum> metrics)
void	setTimeZone(String timeZone)
void	setViews(List<RateLimitAggregationView> views)
RateLimitAggregationQuery	timeZone(String timeZone)	Time zone context used to calculate response intervals (this allows resolving DST changes).
String	toString()
RateLimitAggregationQuery	views(List<RateLimitAggregationView> views)	Custom derived metric views

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

RateLimitAggregationQuery

public RateLimitAggregationQuery()

RateLimitAggregationQuery

public RateLimitAggregationQuery(Boolean initWithEmptyList)

Method Details

interval

public RateLimitAggregationQuery interval(String interval)

Behaves like one clause in a SQL WHERE. Specifies the date and time range of data being queried. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss

getInterval

public String getInterval()

setInterval

public void setInterval(String interval)

granularity

public RateLimitAggregationQuery granularity(String granularity)

Granularity aggregates metrics into subpartitions within the time interval specified. The default granularity is the same duration as the interval. Periods are represented as an ISO-8601 string. For example: P1D or P1DT12H

getGranularity

public String getGranularity()

setGranularity

public void setGranularity(String granularity)

timeZone

public RateLimitAggregationQuery timeZone(String timeZone)

Time zone context used to calculate response intervals (this allows resolving DST changes). The interval offset is used even when timeZone is specified. Default is UTC. Time zones are represented as a string of the zone name as found in the IANA time zone database. For example: UTC, Etc/UTC, or Europe/London

getTimeZone

public String getTimeZone()

setTimeZone

public void setTimeZone(String timeZone)

groupBy

public RateLimitAggregationQuery groupBy(List<RateLimitAggregationQuery.GroupByEnum> groupBy)

Behaves like a SQL GROUPBY. Allows for multiple levels of grouping as a list of dimensions. Partitions resulting aggregate computations into distinct named subgroups rather than across the entire result set as if it were one group.

getGroupBy

public List<RateLimitAggregationQuery.GroupByEnum> getGroupBy()

setGroupBy

public void setGroupBy(List<RateLimitAggregationQuery.GroupByEnum> groupBy)

filter

public RateLimitAggregationQuery filter(RateLimitAggregateQueryFilter filter)

Behaves like a SQL WHERE clause. This is ANDed with the interval parameter. Expresses boolean logical predicates as well as dimensional filters

getFilter

public RateLimitAggregateQueryFilter getFilter()

setFilter

public void setFilter(RateLimitAggregateQueryFilter filter)

metrics

public RateLimitAggregationQuery metrics(List<RateLimitAggregationQuery.MetricsEnum> metrics)

Behaves like a SQL SELECT clause. Only named metrics will be retrieved.

getMetrics

public List<RateLimitAggregationQuery.MetricsEnum> getMetrics()

setMetrics

public void setMetrics(List<RateLimitAggregationQuery.MetricsEnum> metrics)

flattenMultivaluedDimensions

public RateLimitAggregationQuery flattenMultivaluedDimensions(Boolean flattenMultivaluedDimensions)

Flattens any multivalued dimensions used in response groups (e.g. ['a','b','c']->'a,b,c')

getFlattenMultivaluedDimensions

public Boolean getFlattenMultivaluedDimensions()

setFlattenMultivaluedDimensions

public void setFlattenMultivaluedDimensions(Boolean flattenMultivaluedDimensions)

views

public RateLimitAggregationQuery views(List<RateLimitAggregationView> views)

Custom derived metric views

getViews

public List<RateLimitAggregationView> getViews()

setViews

public void setViews(List<RateLimitAggregationView> views)

alternateTimeDimension

public RateLimitAggregationQuery alternateTimeDimension(RateLimitAggregationQuery.AlternateTimeDimensionEnum alternateTimeDimension)

Dimension to use as the alternative timestamp for data in the aggregate. Choosing \"eventTime\" uses the actual time of the data event.

getAlternateTimeDimension

public RateLimitAggregationQuery.AlternateTimeDimensionEnum getAlternateTimeDimension()

setAlternateTimeDimension

public void setAlternateTimeDimension(RateLimitAggregationQuery.AlternateTimeDimensionEnum alternateTimeDimension)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object