Package com.mypurecloud.sdk.v2.model

Class OrganizationPublicApiUsageQueryRequest

java.lang.Object

com.mypurecloud.sdk.v2.model.OrganizationPublicApiUsageQueryRequest

All Implemented Interfaces:

Serializable

public class OrganizationPublicApiUsageQueryRequest
extends Object
implements Serializable

OrganizationPublicApiUsageQueryRequest

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
OrganizationPublicApiUsageQueryRequest()
OrganizationPublicApiUsageQueryRequest(Boolean initWithEmptyList)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

OrganizationPublicApiUsageQueryRequest

public OrganizationPublicApiUsageQueryRequest()

OrganizationPublicApiUsageQueryRequest

public OrganizationPublicApiUsageQueryRequest(Boolean initWithEmptyList)

Method Details

interval

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

Specify the granularity to aggregate the data to.

getGranularity

public OrganizationPublicApiUsageQueryRequest.GranularityEnum getGranularity()

setGranularity

public void setGranularity(OrganizationPublicApiUsageQueryRequest.GranularityEnum granularity)

sortBy

public OrganizationPublicApiUsageQueryRequest 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 OrganizationPublicApiUsageQueryRequest metrics(List<OrganizationPublicApiUsageQueryRequest.MetricsEnum> metrics)

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

getMetrics

public List<OrganizationPublicApiUsageQueryRequest.MetricsEnum> getMetrics()

setMetrics

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

templateUris

public OrganizationPublicApiUsageQueryRequest 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 OrganizationPublicApiUsageQueryRequest httpMethods(List<OrganizationPublicApiUsageQueryRequest.HttpMethodsEnum> httpMethods)

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

getHttpMethods

public List<OrganizationPublicApiUsageQueryRequest.HttpMethodsEnum> getHttpMethods()

setHttpMethods

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

platforms

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

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

getGroupBy

public List<OrganizationPublicApiUsageQueryRequest.GroupByEnum> getGroupBy()

setGroupBy

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

userIds

public OrganizationPublicApiUsageQueryRequest userIds(List<String> userIds)

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

getUserIds

public List<String> getUserIds()

setUserIds

public void setUserIds(List<String> userIds)

oauthClientIds

public OrganizationPublicApiUsageQueryRequest oauthClientIds(List<String> oauthClientIds)

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

getOauthClientIds

public List<String> getOauthClientIds()

setOauthClientIds

public void setOauthClientIds(List<String> oauthClientIds)

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