Package com.veeva.vault.sdk.api.query

Interface QueryExecutionRequest.Builder

Enclosing interface:

QueryExecutionRequest

public static interface QueryExecutionRequest.Builder

Creates an instance of QueryExecutionRequest. Calling at least one method to set the query is required.

Method Summary

Modifier and Type	Method	Description
QueryExecutionRequest	build()	Retrieves the completed QueryExecutionRequest.
QueryExecutionRequest.Builder	withQuery(Query query)	Sets the VQL Query, replacing any previously set Query or query string.
QueryExecutionRequest.Builder	withQueryDescribe()	Enables Query Describe on the query.
QueryExecutionRequest.Builder	withQueryFacetRequest(QueryFacetRequest queryFacetRequest)	Sets the QueryFacetRequest, replacing any previously set QueryFacetRequest.
QueryExecutionRequest.Builder	withQueryRecordPropertyTypes(List<QueryRecordPropertyType> queryRecordPropertyTypes)	Sets the requested QueryRecordPropertyTypes, replacing any previously set QueryRecordPropertyTypes.
QueryExecutionRequest.Builder	withQueryString(String queryString)	Sets the VQL query string, replacing any previously set query string or Query.
QueryExecutionRequest.Builder	withTokenRequest(TokenRequest tokenRequest, QueryEscapeOverride... escapeOverrides)	Sets the TokenRequest and QueryEscapeOverride(s), replacing any previously set TokenRequest and QueryEscapeOverride(s).

Method Details

withQuery

QueryExecutionRequest.Builder withQuery(Query query)

Sets the VQL Query, replacing any previously set Query or query string.

Parameters:

query - VQL query to be executed

Returns:

this Builder

withQueryString

QueryExecutionRequest.Builder withQueryString(String queryString)

Sets the VQL query string, replacing any previously set query string or Query.

Parameters:

queryString - VQL query string to be executed

Returns:

this Builder

withTokenRequest

QueryExecutionRequest.Builder withTokenRequest(TokenRequest tokenRequest,
 QueryEscapeOverride... escapeOverrides)

Sets the TokenRequest and QueryEscapeOverride(s), replacing any previously set TokenRequest and QueryEscapeOverride(s).

Filters on a String field support tokens containing all the types listed in TokenRequest except for List. A filter using CONTAINS only supports a token containing a List. All other fields support tokens containing either their type or a String.

Vault escapes all special VQL characters in String tokens if escape overrides are not provided.

Parameters:

tokenRequest - a token request containing all custom tokens used in the query

escapeOverrides - overrides(s) indicating which characters not to escape

Returns:

this Builder

withQueryFacetRequest

QueryExecutionRequest.Builder withQueryFacetRequest(QueryFacetRequest queryFacetRequest)

Sets the QueryFacetRequest, replacing any previously set QueryFacetRequest.

Parameters:

queryFacetRequest - a request containing the fields to facet on and options for running the facet query

Returns:

this Builder

withQueryRecordPropertyTypes

QueryExecutionRequest.Builder withQueryRecordPropertyTypes(List<QueryRecordPropertyType> queryRecordPropertyTypes)

Sets the requested QueryRecordPropertyTypes, replacing any previously set QueryRecordPropertyTypes.

Record properties contain additional record-level information and are only supported on Vault objects. Requesting record properties on a query has no effect when the query target does not support them, such as documents.

Parameters:

queryRecordPropertyTypes - types of record properties to fetch

Returns:

this Builder

withQueryDescribe

QueryExecutionRequest.Builder withQueryDescribe()

Enables Query Describe on the query.

Returns:

this Builder

build

QueryExecutionRequest build()

Retrieves the completed QueryExecutionRequest.

The query must be non-null.

Returns:

the completed QueryExecutionRequest