com.groupbyinc.api

Class CloudBridge

java.lang.Object

com.groupbyinc.api.AbstractBridge

com.groupbyinc.api.CloudBridge

public class CloudBridge
extends AbstractBridge

Field Summary

Fields inherited from class com.groupbyinc.api.AbstractBridge

clientKey, CLUSTER, COLON, DEFAULT_MAX_TRIES, DEFAULT_RETRY_TIMEOUT, HTTP, HTTPS, UTF_8

Constructor Summary

Constructors

Constructor and Description
CloudBridge(java.lang.String clientKey, java.lang.String customerId) Constructor to create a bridge object that connects to the Search API.
CloudBridge(java.lang.String clientKey, java.lang.String customerId, com.groupbyinc.api.config.ConnectionConfiguration config) Constructor to create a bridge object that connects to the search api.

Method Summary

Modifier and Type	Method and Description
void	setCachingEnabled(boolean cachingEnabled) If using the semantic layer, this tells the semantic layer to not cache the response.

Methods inherited from class com.groupbyinc.api.AbstractBridge

addHeader, containsHeader, fireRequest, fireRequest, generateSecuredPayload, generateSecuredPayload, generateSecuredPayload, generateURI, getBridgeRefinementsUrl, getBridgeUrl, getClusterBridgeUrl, getHeaders, handleErrorStatus, map, mapRefinements, refinements, refinements, refinements, removeHeader, search, search, search, search, setHeaders, setMaxTries, setRetryTimeout, shutdown

Methods inherited from class java.lang.Object

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

Constructor Detail

CloudBridge

public CloudBridge(java.lang.String clientKey,
                   java.lang.String customerId)

Constructor to create a bridge object that connects to the Search API. JSON Reference: The key as found in your Key Management page in the command center {"clientKey": "--clientKey--"}

Parameters:

clientKey - The key as found in your Key Management page in the Command Center.

customerId - The name of your subdomain. For example, if your Command Center is at https://--customerId--.groupbycloud.com, this should be --customerId--

CloudBridge

public CloudBridge(java.lang.String clientKey,
                   java.lang.String customerId,
                   com.groupbyinc.api.config.ConnectionConfiguration config)

Constructor to create a bridge object that connects to the search api. JSON Reference: The key as found in your Key Management page in the command center {"clientKey": "--clientKey--"}

Parameters:

clientKey - The key as found in your Key Management page in the Command Center.

customerId - The name of your subdomain. The name of your subdomain. For example, if your Command Center at is https://--customerId--.groupbycloud.com, this should be --customerId--

config - Configuration for the underlying HttpClient instance.

Method Detail

setCachingEnabled

public void setCachingEnabled(boolean cachingEnabled)

If using the semantic layer, this tells the semantic layer to not cache the response. By default caching is on when using the semantic layer. Currently this is undocumented until the semantic layer is globally enabled.

Parameters:

cachingEnabled - Turn off caching by setting this to false.