Package com.mypurecloud.sdk.v2.api

Class UsageApiAsync

java.lang.Object

com.mypurecloud.sdk.v2.api.UsageApiAsync

public class UsageApiAsync
extends Object

Constructor Summary

Constructors

Constructor	Description
UsageApiAsync()
UsageApiAsync(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
Future<ApiUsageQueryResult>	getOauthClientUsageQueryResultAsync(GetOauthClientUsageQueryResultRequest request, AsyncApiCallback<ApiUsageQueryResult> callback)	Get the results of a usage query
Future<ApiResponse<ApiUsageQueryResult>>	getOauthClientUsageQueryResultAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<ApiUsageQueryResult>> callback)	Get the results of a usage query
Future<UsageExecutionResult>	getOauthClientUsageSummaryAsync(GetOauthClientUsageSummaryRequest request, AsyncApiCallback<UsageExecutionResult> callback)	Get a summary of OAuth client API usage After calling this method, you will then need to poll for the query results based on the returned execution Id
Future<ApiResponse<UsageExecutionResult>>	getOauthClientUsageSummaryAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<UsageExecutionResult>> callback)	Get a summary of OAuth client API usage After calling this method, you will then need to poll for the query results based on the returned execution Id
Future<OrganizationPublicApiUsageResultsResponse>	getUsageAggregatesQueryJobAsync(GetUsageAggregatesQueryJobRequest request, AsyncApiCallback<OrganizationPublicApiUsageResultsResponse> callback)	Get the status and results of the usage query
Future<ApiResponse<OrganizationPublicApiUsageResultsResponse>>	getUsageAggregatesQueryJobAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<OrganizationPublicApiUsageResultsResponse>> callback)	Get the status and results of the usage query
Future<ClientPublicApiUsageResultsResponse>	getUsageClientClientIdAggregatesQueryJobAsync(GetUsageClientClientIdAggregatesQueryJobRequest request, AsyncApiCallback<ClientPublicApiUsageResultsResponse> callback)	Get the status and results of the usage query
Future<ApiResponse<ClientPublicApiUsageResultsResponse>>	getUsageClientClientIdAggregatesQueryJobAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<ClientPublicApiUsageResultsResponse>> callback)	Get the status and results of the usage query
Future<ApiUsageQueryResult>	getUsageQueryExecutionIdResultsAsync(GetUsageQueryExecutionIdResultsRequest request, AsyncApiCallback<ApiUsageQueryResult> callback)	Get the results of a usage query
Future<ApiResponse<ApiUsageQueryResult>>	getUsageQueryExecutionIdResultsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<ApiUsageQueryResult>> callback)	Get the results of a usage query
Future<ApiUsageQueryResult>	getUsageSimplesearchExecutionIdResultsAsync(GetUsageSimplesearchExecutionIdResultsRequest request, AsyncApiCallback<ApiUsageQueryResult> callback)	Get the results of a usage search.
Future<ApiResponse<ApiUsageQueryResult>>	getUsageSimplesearchExecutionIdResultsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<ApiUsageQueryResult>> callback)	Get the results of a usage search.
Future<UsageExecutionResult>	postOauthClientUsageQueryAsync(PostOauthClientUsageQueryRequest request, AsyncApiCallback<UsageExecutionResult> callback)	Query for OAuth client API usage After calling this method, you will then need to poll for the query results based on the returned execution Id
Future<ApiResponse<UsageExecutionResult>>	postOauthClientUsageQueryAsync(ApiRequest<ApiUsageClientQuery> request, AsyncApiCallback<ApiResponse<UsageExecutionResult>> callback)	Query for OAuth client API usage After calling this method, you will then need to poll for the query results based on the returned execution Id
Future<OrganizationUsageQueryResponse>	postUsageAggregatesQueryJobsAsync(PostUsageAggregatesQueryJobsRequest request, AsyncApiCallback<OrganizationUsageQueryResponse> callback)	Query your organization's public api usage.
Future<ApiResponse<OrganizationUsageQueryResponse>>	postUsageAggregatesQueryJobsAsync(ApiRequest<OrganizationPublicApiUsageQueryRequest> request, AsyncApiCallback<ApiResponse<OrganizationUsageQueryResponse>> callback)	Query your organization's public api usage.
Future<ClientUsageQueryResponse>	postUsageClientClientIdAggregatesQueryJobsAsync(PostUsageClientClientIdAggregatesQueryJobsRequest request, AsyncApiCallback<ClientUsageQueryResponse> callback)	Query your client's public api usage.
Future<ApiResponse<ClientUsageQueryResponse>>	postUsageClientClientIdAggregatesQueryJobsAsync(ApiRequest<ClientPublicApiUsageQueryRequest> request, AsyncApiCallback<ApiResponse<ClientUsageQueryResponse>> callback)	Query your client's public api usage.
Future<UsageExecutionResult>	postUsageQueryAsync(PostUsageQueryRequest request, AsyncApiCallback<UsageExecutionResult> callback)	Query organization API Usage - After calling this method, you will then need to poll for the query results based on the returned execution Id
Future<ApiResponse<UsageExecutionResult>>	postUsageQueryAsync(ApiRequest<ApiUsageOrganizationQuery> request, AsyncApiCallback<ApiResponse<UsageExecutionResult>> callback)	Query organization API Usage - After calling this method, you will then need to poll for the query results based on the returned execution Id
Future<UsageExecutionResult>	postUsageSimplesearchAsync(PostUsageSimplesearchRequest request, AsyncApiCallback<UsageExecutionResult> callback)	Search organization API Usage After calling this method, you will then need to poll for the query results based on the returned execution Id.
Future<ApiResponse<UsageExecutionResult>>	postUsageSimplesearchAsync(ApiRequest<ApiUsageSimpleSearch> request, AsyncApiCallback<ApiResponse<UsageExecutionResult>> callback)	Search organization API Usage After calling this method, you will then need to poll for the query results based on the returned execution Id.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

UsageApiAsync

public UsageApiAsync()

UsageApiAsync

public UsageApiAsync(ApiClient apiClient)

Method Details

getOauthClientUsageQueryResultAsync

public Future<ApiUsageQueryResult> getOauthClientUsageQueryResultAsync(GetOauthClientUsageQueryResultRequest request,
 AsyncApiCallback<ApiUsageQueryResult> callback)

Get the results of a usage query

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getOauthClientUsageQueryResultAsync

public Future<ApiResponse<ApiUsageQueryResult>> getOauthClientUsageQueryResultAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<ApiUsageQueryResult>> callback)

Get the results of a usage query

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getOauthClientUsageSummaryAsync

public Future<UsageExecutionResult> getOauthClientUsageSummaryAsync(GetOauthClientUsageSummaryRequest request,
 AsyncApiCallback<UsageExecutionResult> callback)

Get a summary of OAuth client API usage After calling this method, you will then need to poll for the query results based on the returned execution Id

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getOauthClientUsageSummaryAsync

public Future<ApiResponse<UsageExecutionResult>> getOauthClientUsageSummaryAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<UsageExecutionResult>> callback)

Get a summary of OAuth client API usage After calling this method, you will then need to poll for the query results based on the returned execution Id

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getUsageAggregatesQueryJobAsync

public Future<OrganizationPublicApiUsageResultsResponse> getUsageAggregatesQueryJobAsync(GetUsageAggregatesQueryJobRequest request,
 AsyncApiCallback<OrganizationPublicApiUsageResultsResponse> callback)

Get the status and results of the usage query

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getUsageAggregatesQueryJobAsync

public Future<ApiResponse<OrganizationPublicApiUsageResultsResponse>> getUsageAggregatesQueryJobAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<OrganizationPublicApiUsageResultsResponse>> callback)

Get the status and results of the usage query

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getUsageClientClientIdAggregatesQueryJobAsync

public Future<ClientPublicApiUsageResultsResponse> getUsageClientClientIdAggregatesQueryJobAsync(GetUsageClientClientIdAggregatesQueryJobRequest request,
 AsyncApiCallback<ClientPublicApiUsageResultsResponse> callback)

Get the status and results of the usage query

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getUsageClientClientIdAggregatesQueryJobAsync

public Future<ApiResponse<ClientPublicApiUsageResultsResponse>> getUsageClientClientIdAggregatesQueryJobAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<ClientPublicApiUsageResultsResponse>> callback)

Get the status and results of the usage query

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getUsageQueryExecutionIdResultsAsync

public Future<ApiUsageQueryResult> getUsageQueryExecutionIdResultsAsync(GetUsageQueryExecutionIdResultsRequest request,
 AsyncApiCallback<ApiUsageQueryResult> callback)

Get the results of a usage query

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getUsageQueryExecutionIdResultsAsync

public Future<ApiResponse<ApiUsageQueryResult>> getUsageQueryExecutionIdResultsAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<ApiUsageQueryResult>> callback)

Get the results of a usage query

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getUsageSimplesearchExecutionIdResultsAsync

public Future<ApiUsageQueryResult> getUsageSimplesearchExecutionIdResultsAsync(GetUsageSimplesearchExecutionIdResultsRequest request,
 AsyncApiCallback<ApiUsageQueryResult> callback)

Get the results of a usage search. Number of records to be returned is limited to 20,000 results.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

getUsageSimplesearchExecutionIdResultsAsync

public Future<ApiResponse<ApiUsageQueryResult>> getUsageSimplesearchExecutionIdResultsAsync(ApiRequest<Void> request,
 AsyncApiCallback<ApiResponse<ApiUsageQueryResult>> callback)

Get the results of a usage search. Number of records to be returned is limited to 20,000 results.

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postOauthClientUsageQueryAsync

public Future<UsageExecutionResult> postOauthClientUsageQueryAsync(PostOauthClientUsageQueryRequest request,
 AsyncApiCallback<UsageExecutionResult> callback)

Query for OAuth client API usage After calling this method, you will then need to poll for the query results based on the returned execution Id

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postOauthClientUsageQueryAsync

public Future<ApiResponse<UsageExecutionResult>> postOauthClientUsageQueryAsync(ApiRequest<ApiUsageClientQuery> request,
 AsyncApiCallback<ApiResponse<UsageExecutionResult>> callback)

Query for OAuth client API usage After calling this method, you will then need to poll for the query results based on the returned execution Id

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postUsageAggregatesQueryJobsAsync

public Future<OrganizationUsageQueryResponse> postUsageAggregatesQueryJobsAsync(PostUsageAggregatesQueryJobsRequest request,
 AsyncApiCallback<OrganizationUsageQueryResponse> callback)

Query your organization's public api usage. After calling this method, you will need to save the queryExecutionId from the response and use it in a call to the results endpoint to get the results

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postUsageAggregatesQueryJobsAsync

public Future<ApiResponse<OrganizationUsageQueryResponse>> postUsageAggregatesQueryJobsAsync(ApiRequest<OrganizationPublicApiUsageQueryRequest> request,
 AsyncApiCallback<ApiResponse<OrganizationUsageQueryResponse>> callback)

Query your organization's public api usage. After calling this method, you will need to save the queryExecutionId from the response and use it in a call to the results endpoint to get the results

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postUsageClientClientIdAggregatesQueryJobsAsync

public Future<ClientUsageQueryResponse> postUsageClientClientIdAggregatesQueryJobsAsync(PostUsageClientClientIdAggregatesQueryJobsRequest request,
 AsyncApiCallback<ClientUsageQueryResponse> callback)

Query your client's public api usage. After calling this method, you will need to save the queryExecutionId from the response and use it in a call to the results endpoint to get the results

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postUsageClientClientIdAggregatesQueryJobsAsync

public Future<ApiResponse<ClientUsageQueryResponse>> postUsageClientClientIdAggregatesQueryJobsAsync(ApiRequest<ClientPublicApiUsageQueryRequest> request,
 AsyncApiCallback<ApiResponse<ClientUsageQueryResponse>> callback)

Query your client's public api usage. After calling this method, you will need to save the queryExecutionId from the response and use it in a call to the results endpoint to get the results

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postUsageQueryAsync

public Future<UsageExecutionResult> postUsageQueryAsync(PostUsageQueryRequest request,
 AsyncApiCallback<UsageExecutionResult> callback)

Query organization API Usage - After calling this method, you will then need to poll for the query results based on the returned execution Id

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postUsageQueryAsync

public Future<ApiResponse<UsageExecutionResult>> postUsageQueryAsync(ApiRequest<ApiUsageOrganizationQuery> request,
 AsyncApiCallback<ApiResponse<UsageExecutionResult>> callback)

Query organization API Usage - After calling this method, you will then need to poll for the query results based on the returned execution Id

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postUsageSimplesearchAsync

public Future<UsageExecutionResult> postUsageSimplesearchAsync(PostUsageSimplesearchRequest request,
 AsyncApiCallback<UsageExecutionResult> callback)

Search organization API Usage After calling this method, you will then need to poll for the query results based on the returned execution Id. The number of records is limited to 20,000 results

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed

postUsageSimplesearchAsync

public Future<ApiResponse<UsageExecutionResult>> postUsageSimplesearchAsync(ApiRequest<ApiUsageSimpleSearch> request,
 AsyncApiCallback<ApiResponse<UsageExecutionResult>> callback)

Search organization API Usage After calling this method, you will then need to poll for the query results based on the returned execution Id. The number of records is limited to 20,000 results

Parameters:

request - the request object

callback - the action to perform when the request is completed

Returns:

the future indication when the request has completed