ai.tecton.client.request

Class GetFeaturesBatchRequest

java.lang.Object

ai.tecton.client.request.GetFeaturesBatchRequest

public class GetFeaturesBatchRequest
extends java.lang.Object

A class that represents a batch request to retrieve a list of feature vectors from the feature server, for a given workspaceName and featureServiceName. The class can be used to make parallel requests to retrieve multiple feature vectors from the feature server API. The actual number of concurrent calls depends on the ConnectionPool size and maxParallelRequests configurations in the TectonClientOptions.

GetFeaturesBatchRequest uses either the /get-features or the /get-features-batch endpoint depending on the configuration microBatchSize. By default, the microBatchSize is set to RequestConstants.DEFAULT_MICRO_BATCH_SIZE. It can be configured to any value in the range [ 1, RequestConstants.MAX_MICRO_BATCH_SIZE ]

For a GetFeaturesBatchRequest with a GetFeaturesRequestData of size n and a microBatchSize of 1, the client enqueues n HTTP calls to be sent parallely to the /get-features endpoint. The client waits until all calls are complete or a specific time (configured with timeout) has elapsed and returns a List of GetFeaturesResponse objects of size n.

For a GetFeaturesBatchRequest with a GetFeaturesRequestData of size n and a microBatchSize of k where k is in the range [ 1, RequestConstants.MAX_MICRO_BATCH_SIZE ], the client enqueues Math.ceil(n/k) microbatch requests to be sent parallely to the /get-features-batch endpoint, waits until all microbatch requests are complete or a specific configured timeout has elapsed and returns a List of GetFeaturesResponse objects of size n.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GetFeaturesBatchRequest.Builder A Builder class for building instances of GetFeaturesBatchRequest objects from values configured by setters

Constructor Summary

Constructors

Constructor and Description
GetFeaturesBatchRequest(java.lang.String workspaceName, java.lang.String featureServiceName, java.util.List<GetFeaturesRequestData> requestDataList) Constructor that creates a new GetFeaturesBatchRequest with the specified parameters.
GetFeaturesBatchRequest(java.lang.String workspaceName, java.lang.String featureServiceName, java.util.List<GetFeaturesRequestData> requestDataList, java.util.Set<MetadataOption> metadataOptions) Constructor that creates a new GetFeaturesBatchRequest with the specified parameters.
GetFeaturesBatchRequest(java.lang.String workspaceName, java.lang.String featureServiceName, java.util.List<GetFeaturesRequestData> requestDataList, java.util.Set<MetadataOption> metadataOptions, int microBatchSize) Constructor that creates a new GetFeaturesBatchRequest with the specified parameters.
GetFeaturesBatchRequest(java.lang.String workspaceName, java.lang.String featureServiceName, java.util.List<GetFeaturesRequestData> requestDataList, java.util.Set<MetadataOption> metadataOptions, int microBatchSize, java.time.Duration timeout) Constructor that creates a new GetFeaturesBatchRequest with the specified parameters

Method Summary

Modifier and Type	Method and Description
java.lang.String	getEndpoint()
TectonHttpClient.HttpMethod	getMethod()
int	getMicroBatchSize() Getter for microBatchSize
java.util.List<? extends AbstractGetFeaturesRequest>	getRequestList() Return Batch Request List
java.time.Duration	getTimeout() Getter for timeout

Methods inherited from class java.lang.Object

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

Constructor Detail

GetFeaturesBatchRequest

public GetFeaturesBatchRequest(java.lang.String workspaceName,
                               java.lang.String featureServiceName,
                               java.util.List<GetFeaturesRequestData> requestDataList)

Constructor that creates a new GetFeaturesBatchRequest with the specified parameters. metadataOptions defaults to RequestConstants.DEFAULT_METADATA_OPTIONS , microBatchSize defaults to RequestConstants.DEFAULT_MICRO_BATCH_SIZE and timeout defaults to None

Parameters:

workspaceName - Name of the workspace in which the Feature Service is defined

featureServiceName - Name of the Feature Service for which the feature vectors are being requested

requestDataList - a List of GetFeaturesRequestData object with joinKeyMap and/or requestContextMap

Throws:

TectonClientException - when workspacename or featureServiceName is empty or null

TectonClientException - when requestDataList is invalid (null/empty or contains null/empty elements)

GetFeaturesBatchRequest

public GetFeaturesBatchRequest(java.lang.String workspaceName,
                               java.lang.String featureServiceName,
                               java.util.List<GetFeaturesRequestData> requestDataList,
                               java.util.Set<MetadataOption> metadataOptions)

Constructor that creates a new GetFeaturesBatchRequest with the specified parameters. microBatchSize defaults to RequestConstants.DEFAULT_MICRO_BATCH_SIZE and timeout defaults to None

Parameters:

workspaceName - Name of the workspace in which the Feature Service is defined

featureServiceName - Name of the Feature Service for which the feature vectors are being requested

requestDataList - a List of GetFeaturesRequestData object with joinKeyMap and/or requestContextMap

metadataOptions - A Set of MetadataOption for retrieving additional metadata about the feature values. Use RequestConstants.ALL_METADATA_OPTIONS to request all metadata and RequestConstants.NONE_METADATA_OPTIONS to request no metadata respectively. By default, RequestConstants.DEFAULT_METADATA_OPTIONS will be added to each request

Throws:

TectonClientException - when workspaceName or featureServiceName is empty or null

TectonClientException - when requestDataList is invalid (null/empty or contains null/empty elements)

GetFeaturesBatchRequest

public GetFeaturesBatchRequest(java.lang.String workspaceName,
                               java.lang.String featureServiceName,
                               java.util.List<GetFeaturesRequestData> requestDataList,
                               java.util.Set<MetadataOption> metadataOptions,
                               int microBatchSize)

Constructor that creates a new GetFeaturesBatchRequest with the specified parameters. timeout defaults to None.

Parameters:

workspaceName - Name of the workspace in which the Feature Service is defined

featureServiceName - Name of the Feature Service for which the feature vectors are being requested

requestDataList - a List of GetFeaturesRequestData object with joinKeyMap and/or requestContextMap

metadataOptions - A Set of MetadataOption for retrieving additional metadata about the feature values. Use RequestConstants.ALL_METADATA_OPTIONS to request all metadata and RequestConstants.NONE_METADATA_OPTIONS to request no metadata respectively. By default, RequestConstants.DEFAULT_METADATA_OPTIONS will be added to each request

microBatchSize - an int value between 1 and . The client splits the GetFeaturesBatchRequest into multiple micro batches of this size and executes them parallely. By default, the microBatchSize is set to

Throws:

TectonClientException - when workspaceName or featureServiceName is empty or null

TectonClientException - when requestDataList is invalid (null/empty or contains null/empty elements)

GetFeaturesBatchRequest

public GetFeaturesBatchRequest(java.lang.String workspaceName,
                               java.lang.String featureServiceName,
                               java.util.List<GetFeaturesRequestData> requestDataList,
                               java.util.Set<MetadataOption> metadataOptions,
                               int microBatchSize,
                               java.time.Duration timeout)

Constructor that creates a new GetFeaturesBatchRequest with the specified parameters

Parameters:

workspaceName - Name of the workspace in which the Feature Service is defined

featureServiceName - Name of the Feature Service for which the feature vectors are being requested

requestDataList - a List of GetFeaturesRequestData object with joinKeyMap and/or requestContextMap

metadataOptions - metadataOptions A Set of MetadataOption for retrieving additional metadata about the feature values. Use RequestConstants.ALL_METADATA_OPTIONS to request all metadata and RequestConstants.NONE_METADATA_OPTIONS to request no metadata respectively. By default, RequestConstants.DEFAULT_METADATA_OPTIONS will be added to each request

microBatchSize - an int value between 1 and . The client splits the GetFeaturesBatchRequest into multiple micro batches of this size and executes them parallely. By default, the microBatchSize is set to

timeout - The max time in Duration for which the client waits for the batch requests to complete before canceling the operation and returning the partial list of results.

Throws:

TectonClientException - when workspacename or featureServiceName is empty or null

TectonClientException - when requestDataList is invalid (null/empty or contains null/empty elements)

TectonClientException - when the microBatchSize is out of bounds of [ 1, ]

Method Detail

getRequestList

public java.util.List<? extends AbstractGetFeaturesRequest> getRequestList()

Return Batch Request List

Returns:

of {@link AbstractGetFeaturesRequest} representing the list of batch request

getTimeout

public java.time.Duration getTimeout()

Getter for timeout

Returns:

timeout in Duration

getMicroBatchSize

public int getMicroBatchSize()

Getter for microBatchSize

Returns:

microBatchSize ( if not set

getMethod

public TectonHttpClient.HttpMethod getMethod()

getEndpoint

public java.lang.String getEndpoint()