com.microsoft.azure.documentdb

Class FeedResponse<T extends Resource>

java.lang.Object

com.microsoft.azure.documentdb.FeedResponse<T>

Type Parameters:

T - the resource type of the feed response.

public final class FeedResponse<T extends Resource>
extends Object

Template class used by feed methods (enumeration operations) in the Azure Cosmos DB database service.

Method Summary

Modifier and Type	Method and Description
String	getActivityId() Gets the activity ID for the request.
long	getCollectionQuota() Max Quota.
long	getCollectionSizeQuota() Max Quota.
long	getCollectionSizeUsage() Current Usage.
long	getCollectionUsage() Current Usage.
String	getCurrentResourceQuotaUsage() Gets the current size of this entity (in megabytes (MB) for server resources and in count for master resources).
long	getDatabaseQuota() Max Quota.
long	getDatabaseUsage() Current Usage.
String	getMaxResourceQuota() Gets the maximum size limit for this entity (in megabytes (MB) for server resources and in count for master resources).
long	getPermissionQuota() Max Quota.
long	getPermissionUsage() Current Usage.
QueryIterable<T>	getQueryIterable() Gets the query iterable of T.
Iterator<T>	getQueryIterator() Gets the query iterator of T.
double	getRequestCharge() Gets the number of index paths (terms) generated by the operation.
String	getResponseContinuation() Gets the continuation token to be used for continuing the enumeration.
Map<String,String>	getResponseHeaders() Gets the response headers.
boolean	getRUPerMinuteUsed() Gets the flag associated with the response from the Azure Cosmos DB database service whether this feed request is served from Request Units(RUs)/minute capacity or not.
String	getSessionToken() Gets the session token for use in session consistency.
long	getStoredProceduresQuota() Max Quota.
long	getStoredProceduresUsage() Current Usage.
long	getTriggersQuota() Max Quota.
long	getTriggersUsage() Current Usage.
long	getUserDefinedFunctionsQuota() Max Quota.
long	getUserDefinedFunctionsUsage() Current Usage.
long	getUserQuota() Max Quota.
long	getUserUsage() Current Usage.

Methods inherited from class java.lang.Object

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

Method Detail

getDatabaseQuota

public long getDatabaseQuota()

Max Quota.

Returns:

the database quota.

getDatabaseUsage

public long getDatabaseUsage()

Current Usage.

Returns:

the current database usage.

getCollectionQuota

public long getCollectionQuota()

Max Quota.

Returns:

the collection quota.

getCollectionUsage

public long getCollectionUsage()

Current Usage.

Returns:

the current collection usage.

getUserQuota

public long getUserQuota()

Max Quota.

Returns:

the user quota.

getUserUsage

public long getUserUsage()

Current Usage.

Returns:

the current user usage.

getPermissionQuota

public long getPermissionQuota()

Max Quota.

Returns:

the permission quota.

getPermissionUsage

public long getPermissionUsage()

Current Usage.

Returns:

the current permission usage.

getCollectionSizeQuota

public long getCollectionSizeQuota()

Max Quota.

Returns:

the collection size quota.

getCollectionSizeUsage

public long getCollectionSizeUsage()

Current Usage.

Returns:

the current collection size usage.

getStoredProceduresQuota

public long getStoredProceduresQuota()

Max Quota.

Returns:

the stored procedure quota.

getStoredProceduresUsage

public long getStoredProceduresUsage()

Current Usage.

Returns:

the current stored procedure usage.

getTriggersQuota

public long getTriggersQuota()

Max Quota.

Returns:

the triggers quota.

getTriggersUsage

public long getTriggersUsage()

Current Usage.

Returns:

the current triggers usage.

getUserDefinedFunctionsQuota

public long getUserDefinedFunctionsQuota()

Max Quota.

Returns:

the user defined functions quota.

getUserDefinedFunctionsUsage

public long getUserDefinedFunctionsUsage()

Current Usage.

Returns:

the current user defined functions usage.

getMaxResourceQuota

public String getMaxResourceQuota()

Gets the maximum size limit for this entity (in megabytes (MB) for server resources and in count for master resources).

Returns:

the max resource quota.

getCurrentResourceQuotaUsage

public String getCurrentResourceQuotaUsage()

Gets the current size of this entity (in megabytes (MB) for server resources and in count for master resources).

Returns:

the current resource quota usage.

getRequestCharge

public double getRequestCharge()

Gets the number of index paths (terms) generated by the operation.

Returns:

the request charge.

getRUPerMinuteUsed

public boolean getRUPerMinuteUsed()

Gets the flag associated with the response from the Azure Cosmos DB database service whether this feed request is served from Request Units(RUs)/minute capacity or not.

Returns:

True if this request is served from RUs/minute capacity. Otherwise, false.

getActivityId

public String getActivityId()

Gets the activity ID for the request.

Returns:

the activity id.

getResponseContinuation

public String getResponseContinuation()

Gets the continuation token to be used for continuing the enumeration.

Returns:

the response continuation.

getSessionToken

public String getSessionToken()

Gets the session token for use in session consistency.

Returns:

the session token.

getResponseHeaders

public Map<String,String> getResponseHeaders()

Gets the response headers.

Returns:

the response headers.

getQueryIterable

public QueryIterable<T> getQueryIterable()

Gets the query iterable of T.

Returns:

the iterable.

getQueryIterator

public Iterator<T> getQueryIterator()

Gets the query iterator of T.

Returns:

the iterator.