public static final class ProximityClient.ClientParams extends Object
ProximityClient
's behavior.
A ClientParams instance is immutable, and can be initialized with a builder
.Modifier and Type | Class and Description |
---|---|
static class |
ProximityClient.ClientParams.Builder
A builder for
ProximityClient.ClientParams . |
Modifier and Type | Field and Description |
---|---|
String |
apiKey |
List<String> |
deploymentTags |
int |
maxIndexesToQuery |
long |
maxMemory |
String |
organizationId |
String |
path |
String |
secretKey |
int |
threadPoolSize |
Constructor and Description |
---|
ClientParams(String organizationId,
String apiKey,
String secretKey,
String path,
long maxMemory,
List<String> deploymentTags,
int threadPoolSize,
int maxIndexesToQuery)
Deprecated.
as of 5.3.0 - use
ProximityClient.ClientParams.Builder . New fields will not be added here. |
public final String organizationId
public final String apiKey
public final String secretKey
public final String path
public final long maxMemory
public final int threadPoolSize
public final int maxIndexesToQuery
public ClientParams(String organizationId, String apiKey, String secretKey, String path, long maxMemory, List<String> deploymentTags, int threadPoolSize, int maxIndexesToQuery)
ProximityClient.ClientParams.Builder
. New fields will not be added here.organizationId
- the organization-id provided by FactualapiKey
- the API key, available via http://factual.comsecretKey
- the secret key, available via http://factual.compath
- the filesystem path for the directory which will be used for caching data filesmaxMemory
- the maximum memory, in bytes, which will be used by the client. If the required
memory for the latest configuration exceeds this value, getSyncState() will return
SyncState.INSUFFICIENT_MEMORYdeploymentTags
- specifies which indices should be loaded in this client. If more than one
deployment tag is specified, only indices which have ALL the tags will be loaded.threadPoolSize
- the size of the threadpool to use for queries to ProximityClient.testMultiplePoints(List, int)
and ProximityClient.testPoint(double, double, boolean, boolean)
.
the special value -1 means to choose a reasonable number based on the number of CPUs;
setting to 0 will allocate no threadpool and cause calls to these methods to
throw an exception.maxIndexesToQuery
- ProximityClient will not query more than this many indexes.
If you have more than this number on disk, it is unspecified which will be
used, so you should typically use this feature only temporarily, for performance
benchmarking.