com.vmware.vcloud.api.rest.client

Interface VcdClient.Query<QueryResultClass>

Type Parameters:

QueryResultClass - Type of individual query result. Must be ReferenceType or a type derived from QueryResultRecordType.

Enclosing interface:

VcdClient

public static interface VcdClient.Query<QueryResultClass>

Represents a query which can be executed against VCD.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_PAGE_SIZE

Method Summary

Modifier and Type	Method and Description
ListIterator<VcdClient.QueryListPage<QueryResultClass>>	execute() Executes the query and returns an iterator over list of pages of results.
QueryResultClass	findUnique() Convenience wrapper over execute() for the case where exactly one match is expected.
static org.apache.cxf.jaxrs.ext.search.client.SearchConditionBuilder	getFilterBuilder() Return a SearchConditionBuilder - Apache CXF's FIQL Query builder configured for use as per URL query format requirements
VcdClient.Query<QueryResultClass>	setEqualityFilter(String attributeName, String attributeValue) Sets equality filter to query that the specified attribute name has the specified value.
VcdClient.Query<QueryResultClass>	setFields(Collection<String> fields) Sets query fields.
VcdClient.Query<QueryResultClass>	setFilter(String filter) Sets query filter.
VcdClient.Query<QueryResultClass>	setIncludeLinks(boolean includeLinks) Sets flag for including links in query results.
VcdClient.Query<QueryResultClass>	setPage(int page) Sets page number to retrieve.
VcdClient.Query<QueryResultClass>	setPageSize(int pageSize) Sets page size.
VcdClient.Query<QueryResultClass>	setQueryResultFormat(QueryResultFormat queryResultFormat) Sets query result format.
VcdClient.Query<QueryResultClass>	setSortAsc(String fieldName) Sets ascending sort order by specified field.
VcdClient.Query<QueryResultClass>	setSortDesc(String fieldName) Sets descending sort order by specified field.
Stream<QueryResultClass>	stream() Executes the query and returns an Stream of all results over all pages

Field Detail

DEFAULT_MAX_PAGE_SIZE

static final int DEFAULT_MAX_PAGE_SIZE

See Also:

Constant Field Values

Method Detail

setQueryResultFormat

VcdClient.Query<QueryResultClass> setQueryResultFormat(QueryResultFormat queryResultFormat)

Sets query result format.

By default, query result format is set to QueryResultFormat.RECORDS if QueryResultClass is derived from QueryResultRecordType and QueryResultFormat.REFERENCES if QueryResultClass is ReferenceType.

When QueryResultClass is derived from QueryResultRecordType this method can be used to override result format with QueryResultFormat.ID_RECORDS.

Parameters:

queryResultFormat - Desired query result format

Returns:

this instance to enable chaining of method invocations

setPage

VcdClient.Query<QueryResultClass> setPage(int page)

Sets page number to retrieve.

By default query execution retrieves first page.

Parameters:

page - page number; must be >= 1

Returns:

this instance to enable chaining of method invocations

setPageSize

VcdClient.Query<QueryResultClass> setPageSize(int pageSize)

Sets page size.

By default, page size configured in VCD is used.

Parameters:

pageSize - number of records per page; must be >= 1

Returns:

this instance to enable chaining of method invocations

setFilter

VcdClient.Query<QueryResultClass> setFilter(String filter)

Sets query filter.

This expects specified filter to be URL encoded. Call to this method will replace an existing filter.

Parameters:

filter - query filter

Returns:

this instance to enable chaining of method invocations

setFields

VcdClient.Query<QueryResultClass> setFields(Collection<String> fields)

Sets query fields.

Comma-separated list of attribute names or metadata key names to return.

Parameters:

fields - query fields

Returns:

this instance to enable chaining of method invocations

getFilterBuilder

static org.apache.cxf.jaxrs.ext.search.client.SearchConditionBuilder getFilterBuilder()

Return a SearchConditionBuilder - Apache CXF's FIQL Query builder configured for use as per URL query format requirements

Returns:

an instance of SearchConditionBuilder FIQL query builder

setEqualityFilter

VcdClient.Query<QueryResultClass> setEqualityFilter(String attributeName,
                                                    String attributeValue)

Sets equality filter to query that the specified attribute name has the specified value. Eg, attributeName==attributeValue

This URL encodes the specified attribute value. Call to this method will append the specified filter to an existing query filter.

Parameters:

attributeName - name of the attribute whose value is to be queries.

attributeValue - value of the attribute being queried.

Returns:

this instance to enable chaining of method invocations

setSortDesc

VcdClient.Query<QueryResultClass> setSortDesc(String fieldName)

Sets descending sort order by specified field.

Parameters:

fieldName - field to sort by

Returns:

this instance to enable chaining of method invocations

setSortAsc

VcdClient.Query<QueryResultClass> setSortAsc(String fieldName)

Sets ascending sort order by specified field.

Parameters:

fieldName - field to sort by

Returns:

this instance to enable chaining of method invocations

setIncludeLinks

VcdClient.Query<QueryResultClass> setIncludeLinks(boolean includeLinks)

Sets flag for including links in query results.

Parameters:

includeLinks - boolean indicating whether to include links in queries or not

Returns:

this instance to enable chaining of method invocations

execute

ListIterator<VcdClient.QueryListPage<QueryResultClass>> execute()

Executes the query and returns an iterator over list of pages of results. The iterator is positioned just before the requested page so that calling next() returns the requested page.

The returned iterator doesn't support mutating operations: add, set, and remove. Invoking corresponding methods will result in UnsupportedOperationException.

Returns:

an iterator over list of pages of results

stream

Stream<QueryResultClass> stream()

Executes the query and returns an Stream of all results over all pages

Returns:

an iterator over list of pages of results

findUnique

QueryResultClass findUnique()

Convenience wrapper over execute() for the case where exactly one match is expected.

Returns:

the matching row

Throws:

MissingRecordException - if the number of matches is zero

MultipleRecordsException - if the number of matches is greatr than 1