Package com.mypurecloud.sdk.v2.model

Class ClientPublicApiUsageQueryRequest

java.lang.Object

com.mypurecloud.sdk.v2.model.ClientPublicApiUsageQueryRequest

All Implemented Interfaces:

Serializable

public class ClientPublicApiUsageQueryRequest
extends Object
implements Serializable

ClientPublicApiUsageQueryRequest

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ClientPublicApiUsageQueryRequest.GranularityEnum	Specify the granularity to aggregate the data to.
static enum	ClientPublicApiUsageQueryRequest.GroupByEnum	Gets or Sets groupBy
static enum	ClientPublicApiUsageQueryRequest.HttpMethodsEnum	Gets or Sets httpMethods
static enum	ClientPublicApiUsageQueryRequest.MetricsEnum	Gets or Sets metrics

Constructor Summary

Constructors

Constructor	Description
ClientPublicApiUsageQueryRequest()
ClientPublicApiUsageQueryRequest(Boolean initWithEmptyList)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
ClientPublicApiUsageQueryRequest.GranularityEnum	getGranularity()
List<ClientPublicApiUsageQueryRequest.GroupByEnum>	getGroupBy()
List<ClientPublicApiUsageQueryRequest.HttpMethodsEnum>	getHttpMethods()
String	getInterval()
List<ClientPublicApiUsageQueryRequest.MetricsEnum>	getMetrics()
List<String>	getOrganizationIds()
List<String>	getPlatforms()
List<UsageQuerySortBy>	getSortBy()
List<String>	getTemplateUris()
ClientPublicApiUsageQueryRequest	granularity(ClientPublicApiUsageQueryRequest.GranularityEnum granularity)	Specify the granularity to aggregate the data to.
ClientPublicApiUsageQueryRequest	groupBy(List<ClientPublicApiUsageQueryRequest.GroupByEnum> groupBy)	Specify how to aggregate the data (by default the data is not aggregated).
int	hashCode()
ClientPublicApiUsageQueryRequest	httpMethods(List<ClientPublicApiUsageQueryRequest.HttpMethodsEnum> httpMethods)	Specify if you only want a subset of httpMethods represented in the query.
ClientPublicApiUsageQueryRequest	interval(String interval)	Specify the interval to query on.
ClientPublicApiUsageQueryRequest	metrics(List<ClientPublicApiUsageQueryRequest.MetricsEnum> metrics)	Specify which metrics you want returned (all will be returned by default).
ClientPublicApiUsageQueryRequest	organizationIds(List<String> organizationIds)	Specify if you only want a subset of organizationIds represented in the query.
ClientPublicApiUsageQueryRequest	platforms(List<String> platforms)	Specify if you only want a subset of platforms represented in the query.
void	setGranularity(ClientPublicApiUsageQueryRequest.GranularityEnum granularity)
void	setGroupBy(List<ClientPublicApiUsageQueryRequest.GroupByEnum> groupBy)
void	setHttpMethods(List<ClientPublicApiUsageQueryRequest.HttpMethodsEnum> httpMethods)
void	setInterval(String interval)
void	setMetrics(List<ClientPublicApiUsageQueryRequest.MetricsEnum> metrics)
void	setOrganizationIds(List<String> organizationIds)
void	setPlatforms(List<String> platforms)
void	setSortBy(List<UsageQuerySortBy> sortBy)
void	setTemplateUris(List<String> templateUris)
ClientPublicApiUsageQueryRequest	sortBy(List<UsageQuerySortBy> sortBy)	Specify how to sort the returned data.
ClientPublicApiUsageQueryRequest	templateUris(List<String> templateUris)	Specify if you only want a subset of templateUris represented in the query.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ClientPublicApiUsageQueryRequest

public ClientPublicApiUsageQueryRequest()

ClientPublicApiUsageQueryRequest

public ClientPublicApiUsageQueryRequest(Boolean initWithEmptyList)

Method Details

interval

public ClientPublicApiUsageQueryRequest interval(String interval)

Specify the interval to query on. Start and end are inclusive. Start date cannot be more than a year ago. End date cannot be more than 90 days after the start. 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 ClientPublicApiUsageQueryRequest granularity(ClientPublicApiUsageQueryRequest.GranularityEnum granularity)

Specify the granularity to aggregate the data to.

getGranularity

public ClientPublicApiUsageQueryRequest.GranularityEnum getGranularity()

setGranularity

public void setGranularity(ClientPublicApiUsageQueryRequest.GranularityEnum granularity)

sortBy

public ClientPublicApiUsageQueryRequest sortBy(List<UsageQuerySortBy> sortBy)

Specify how to sort the returned data.

getSortBy

public List<UsageQuerySortBy> getSortBy()

setSortBy

public void setSortBy(List<UsageQuerySortBy> sortBy)

metrics

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

Specify which metrics you want returned (all will be returned by default).

getMetrics

public List<ClientPublicApiUsageQueryRequest.MetricsEnum> getMetrics()

setMetrics

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

templateUris

public ClientPublicApiUsageQueryRequest templateUris(List<String> templateUris)

Specify if you only want a subset of templateUris represented in the query.

getTemplateUris

public List<String> getTemplateUris()

setTemplateUris

public void setTemplateUris(List<String> templateUris)

httpMethods

public ClientPublicApiUsageQueryRequest httpMethods(List<ClientPublicApiUsageQueryRequest.HttpMethodsEnum> httpMethods)

Specify if you only want a subset of httpMethods represented in the query.

getHttpMethods

public List<ClientPublicApiUsageQueryRequest.HttpMethodsEnum> getHttpMethods()

setHttpMethods

public void setHttpMethods(List<ClientPublicApiUsageQueryRequest.HttpMethodsEnum> httpMethods)

platforms

public ClientPublicApiUsageQueryRequest platforms(List<String> platforms)

Specify if you only want a subset of platforms represented in the query.

getPlatforms

public List<String> getPlatforms()

setPlatforms

public void setPlatforms(List<String> platforms)

groupBy

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

Specify how to aggregate the data (by default the data is not aggregated).

getGroupBy

public List<ClientPublicApiUsageQueryRequest.GroupByEnum> getGroupBy()

setGroupBy

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

organizationIds

public ClientPublicApiUsageQueryRequest organizationIds(List<String> organizationIds)

Specify if you only want a subset of organizationIds represented in the query.

getOrganizationIds

public List<String> getOrganizationIds()

setOrganizationIds

public void setOrganizationIds(List<String> organizationIds)

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