ai.tecton.client

Class TectonClient

java.lang.Object

ai.tecton.client.TectonClient

public class TectonClient
extends java.lang.Object

A client for interacting with the Tecton FeatureService API. The client provides several methods that make HTTP requests to the corresponding API endpoint and returns the response as a Java object.

Note: Each method throws TectonServiceException when it receives an error response from the API and a TectonClientException when an error or exception is encountered by the client. The message included in the exception will provide more information about the error.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TectonClient.Builder A Builder class for creating an instance of TectonClient object with specific configurations

Constructor Summary

Constructors

Constructor and Description
TectonClient(java.lang.String url, java.lang.String apiKey) Constructor for a simple Tecton Client
TectonClient(java.lang.String url, java.lang.String apiKey, okhttp3.OkHttpClient httpClient) Constructor for a Tecton Client with a custom OkHttpClient
TectonClient(java.lang.String url, java.lang.String apiKey, TectonClientOptions tectonClientOptions) Constructor for a Tecton Client with custom configurations

Method Summary

Modifier and Type	Method and Description
void	close() Releases all resources (connection pool, threads) held by the Tecton Client.
GetFeaturesResponse	getFeatures(GetFeaturesRequest getFeaturesRequest) Makes a request to the /get-features endpoint and returns the response in the form of a GetFeaturesResponse object
GetFeaturesBatchResponse	getFeaturesBatch(GetFeaturesBatchRequest batchRequest) Makes a batch request to retrieve a list of feature vector and metadata for a given workspace and feature service
GetFeatureServiceMetadataResponse	getFeatureServiceMetadata(GetFeatureServiceMetadataRequest getFeatureServiceMetadataRequest) Makes a request to the /metadata endpoint and returns the response in the form of a GetFeatureServiceMetadataResponse object
boolean	isClosed() Returns true if the Tecton Client has been closed, false otherwise

Methods inherited from class java.lang.Object

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

Constructor Detail

TectonClient

public TectonClient(java.lang.String url,
                    java.lang.String apiKey)

Constructor for a simple Tecton Client

Parameters:

url - The Tecton Base Url

apiKey - API Key for authenticating with the FeatureService API. See Authenticating with an API key for more information

TectonClient

public TectonClient(java.lang.String url,
                    java.lang.String apiKey,
                    TectonClientOptions tectonClientOptions)

Constructor for a Tecton Client with custom configurations

Parameters:

url - The Tecton Base Url

apiKey - API Key for authenticating with the FeatureService API. See Authenticating with an API key for more information

tectonClientOptions - A TectonClientOptions object with custom configurations

TectonClient

public TectonClient(java.lang.String url,
                    java.lang.String apiKey,
                    okhttp3.OkHttpClient httpClient)

Constructor for a Tecton Client with a custom OkHttpClient

Parameters:

url - The Tecton Base Url

apiKey - API Key for authenticating with the FeatureService API. See Authenticating with an API key for more information

httpClient - An OkHttpClient for making requests and receiving responses from the Feature Service API. Please refer to OkHttp Documentation for recommendations on creating and maintaining an OkHttp Client in your application. Tecton recommends configuring the ConnectionPool in the OkHttpClient for efficiently managing HTTP connections. If you intend to use the GetFeaturesBatchRequest to send parallel requests to Tecton, please also configure the maxRequestsPerHost in the client's Dispatcher.

Method Detail

getFeatures

public GetFeaturesResponse getFeatures(GetFeaturesRequest getFeaturesRequest)
                                throws TectonClientException,
                                       TectonServiceException

Makes a request to the /get-features endpoint and returns the response in the form of a GetFeaturesResponse object

Parameters:

getFeaturesRequest - A GetFeaturesRequest object with the request parameters

Returns:

GetFeaturesResponse object representing the response from the HTTP API

Throws:

TectonClientException - when the client is already closed or encounters an error while building the request or parsing the response

TectonServiceException - when the client receives an error response from the HTTP API

getFeatureServiceMetadata

public GetFeatureServiceMetadataResponse getFeatureServiceMetadata(GetFeatureServiceMetadataRequest getFeatureServiceMetadataRequest)
                                                            throws TectonClientException,
                                                                   TectonServiceException

Makes a request to the /metadata endpoint and returns the response in the form of a GetFeatureServiceMetadataResponse object

Parameters:

getFeatureServiceMetadataRequest - A GetFeatureServiceMetadataRequest object with the request parameters

Returns:

GetFeatureServiceMetadataResponse object representing the response from the HTTP API

Throws:

TectonClientException - when the client is already closed or encounters an error while building the request or parsing the response

TectonServiceException - when the client receives an error response from the HTTP API

getFeaturesBatch

public GetFeaturesBatchResponse getFeaturesBatch(GetFeaturesBatchRequest batchRequest)
                                          throws TectonClientException,
                                                 TectonServiceException

Makes a batch request to retrieve a list of feature vector and metadata for a given workspace and feature service

Parameters:

batchRequest - The GetFeaturesRequest object with the request parameters

Returns:

GetFeaturesBatchResponse object wih the list of feature vector and metadata (if requested)

Throws:

TectonClientException - when the client is already closed or the client encounters an error while building the request or parsing the response

TectonServiceException - when the client receives an error response from the HTTP API

close

public void close()

Releases all resources (connection pool, threads) held by the Tecton Client. Once the client is closed, all future calls with the client will fail.

isClosed

public boolean isClosed()

Returns true if the Tecton Client has been closed, false otherwise

Returns:

boolean