Package ai.velr

Class QueryOptions.Builder

java.lang.Object

ai.velr.QueryOptions.Builder

Enclosing class:

QueryOptions

public static final class QueryOptions.Builder
extends Object

Builder for QueryOptions.

Constructor Summary

Constructors

Constructor	Description
Builder()	Create an empty query-options builder.

Method Summary

Modifier and Type	Method	Description
QueryOptions	build()	Build immutable query options.
QueryOptions.Builder	maxResultRows(long maxResultRows)	Set the maximum number of rows returned by each result table.
QueryOptions.Builder	maxResultRows(Long maxResultRows)	Set the maximum number of rows returned by each result table.
QueryOptions.Builder	param(String name, Object value)	Add or replace one query parameter.
QueryOptions.Builder	params(Map<String,?> values)	Add query parameters from a map.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Create an empty query-options builder.

QueryOptions.builder() is the preferred entry point.

Method Details

maxResultRows

public QueryOptions.Builder maxResultRows(Long maxResultRows)

Set the maximum number of rows returned by each result table.

Parameters:

maxResultRows - maximum row count, or null for uncapped execution

Returns:

this builder

maxResultRows

public QueryOptions.Builder maxResultRows(long maxResultRows)

Set the maximum number of rows returned by each result table.

Parameters:

maxResultRows - maximum row count

Returns:

this builder

param

public QueryOptions.Builder param(String name,
 Object value)

Add or replace one query parameter.

Parameters:

name - parameter name without a leading $

value - parameter value

Returns:

this builder

params

public QueryOptions.Builder params(Map<String,?> values)

Add query parameters from a map.

Parameters:

values - parameter map; keys omit the leading $

Returns:

this builder

build

public QueryOptions build()

Build immutable query options.

Returns:

query options