com.microsoft.azure.documentdb

Class QueryIterable<T extends Resource>

java.lang.Object

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

Type Parameters:

T - the resource type of the query iterable.

All Implemented Interfaces:

Iterable<T>

public class QueryIterable<T extends Resource>
extends Object
implements Iterable<T>

This is the template class for iterable resources in the Azure Cosmos DB database service.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	QueryIterable(DocumentClient client, com.microsoft.azure.documentdb.internal.ResourceType resourceType, Class<T> classT, String resourceLink, FeedOptionsBase options)
protected	QueryIterable(DocumentClient client, com.microsoft.azure.documentdb.internal.ResourceType resourceType, Class<T> classT, String resourceLink, FeedOptionsBase options, Object partitionKey)
protected	QueryIterable(DocumentClient client, com.microsoft.azure.documentdb.internal.ResourceType resourceType, Class<T> classT, String resourceLink, SqlQuerySpec querySpec, FeedOptionsBase options)
protected	QueryIterable(DocumentClient client, com.microsoft.azure.documentdb.internal.ResourceType resourceType, Class<T> classT, String resourceLink, SqlQuerySpec querySpec, FeedOptionsBase options, Object partitionKey)

Method Summary

Modifier and Type	Method and Description
List<T>	fetchNextBlock() Fetch the next block of query results.
Map<String,String>	getResponseHeaders() Gets the response headers.
Iterator<T>	iterator() Gets the iterator of the iterable.
void	reset() Resets the iterable.
List<T>	toList() Get the list of the iterable resources.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

QueryIterable

protected QueryIterable(DocumentClient client,
                        com.microsoft.azure.documentdb.internal.ResourceType resourceType,
                        Class<T> classT,
                        String resourceLink,
                        FeedOptionsBase options)

QueryIterable

protected QueryIterable(DocumentClient client,
                        com.microsoft.azure.documentdb.internal.ResourceType resourceType,
                        Class<T> classT,
                        String resourceLink,
                        SqlQuerySpec querySpec,
                        FeedOptionsBase options)

QueryIterable

protected QueryIterable(DocumentClient client,
                        com.microsoft.azure.documentdb.internal.ResourceType resourceType,
                        Class<T> classT,
                        String resourceLink,
                        FeedOptionsBase options,
                        Object partitionKey)

QueryIterable

protected QueryIterable(DocumentClient client,
                        com.microsoft.azure.documentdb.internal.ResourceType resourceType,
                        Class<T> classT,
                        String resourceLink,
                        SqlQuerySpec querySpec,
                        FeedOptionsBase options,
                        Object partitionKey)

Method Detail

getResponseHeaders

public Map<String,String> getResponseHeaders()

Gets the response headers.

Returns:

the response headers.

iterator

public Iterator<T> iterator()

Gets the iterator of the iterable.

Specified by:

iterator in interface Iterable<T extends Resource>

Returns:

the iterator.

toList

public List<T> toList()

Get the list of the iterable resources.

Returns:

the list of the iterable resources.

reset

public void reset()

Resets the iterable.

fetchNextBlock

public List<T> fetchNextBlock()
                       throws DocumentClientException

Fetch the next block of query results.

Returns:

the list of fetched resources.

Throws:

DocumentClientException - the document client exception.