Package com.mypurecloud.sdk.v2.model

Class ApiUsageClientQuery

java.lang.Object

com.mypurecloud.sdk.v2.model.ApiUsageClientQuery

All Implemented Interfaces:

Serializable

public class ApiUsageClientQuery
extends Object
implements Serializable

ApiUsageClientQuery

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ApiUsageClientQuery.GranularityEnum	Date granularity of the results
static enum	ApiUsageClientQuery.GroupByEnum	Gets or Sets groupBy
static enum	ApiUsageClientQuery.MetricsEnum	Gets or Sets metrics

Constructor Summary

Constructors

Constructor	Description
ApiUsageClientQuery()
ApiUsageClientQuery(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
ApiUsageClientQuery.GranularityEnum	getGranularity()
List<ApiUsageClientQuery.GroupByEnum>	getGroupBy()
String	getInterval()
List<ApiUsageClientQuery.MetricsEnum>	getMetrics()
ApiUsageClientQuery	granularity(ApiUsageClientQuery.GranularityEnum granularity)	Date granularity of the results
ApiUsageClientQuery	groupBy(List<ApiUsageClientQuery.GroupByEnum> groupBy)	Behaves like a SQL GROUPBY.
int	hashCode()
ApiUsageClientQuery	interval(String interval)	Behaves like one clause in a SQL WHERE.
ApiUsageClientQuery	metrics(List<ApiUsageClientQuery.MetricsEnum> metrics)	Behaves like a SQL SELECT clause.
void	setGranularity(ApiUsageClientQuery.GranularityEnum granularity)
void	setGroupBy(List<ApiUsageClientQuery.GroupByEnum> groupBy)
void	setInterval(String interval)
void	setMetrics(List<ApiUsageClientQuery.MetricsEnum> metrics)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ApiUsageClientQuery

public ApiUsageClientQuery()

ApiUsageClientQuery

public ApiUsageClientQuery(Boolean initWithEmptyList)

Method Details

interval

public ApiUsageClientQuery 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 ApiUsageClientQuery granularity(ApiUsageClientQuery.GranularityEnum granularity)

Date granularity of the results

getGranularity

public ApiUsageClientQuery.GranularityEnum getGranularity()

setGranularity

public void setGranularity(ApiUsageClientQuery.GranularityEnum granularity)

metrics

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

Behaves like a SQL SELECT clause. Enables retrieving only named metrics. If omitted, all metrics that are available will be returned (like SELECT *).

getMetrics

public List<ApiUsageClientQuery.MetricsEnum> getMetrics()

setMetrics

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

groupBy

public ApiUsageClientQuery groupBy(List<ApiUsageClientQuery.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<ApiUsageClientQuery.GroupByEnum> getGroupBy()

setGroupBy

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

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