ai.tecton.client.request

Class GetFeaturesBatchRequest.Builder

java.lang.Object

ai.tecton.client.request.GetFeaturesBatchRequest.Builder

Enclosing class:

GetFeaturesBatchRequest

public static class GetFeaturesBatchRequest.Builder
extends java.lang.Object

A Builder class for building instances of GetFeaturesBatchRequest objects from values configured by setters

Constructor Summary

Constructors

Constructor and Description
Builder() Constructs an empty Builder

Method Summary

Modifier and Type	Method and Description
GetFeaturesBatchRequest.Builder	addRequestData(GetFeaturesRequestData requestData) Adds a single GetFeaturesRequestData object to the List
GetFeaturesBatchRequest	build() Returns an instance of GetFeaturesBatchRequest created from the fields set on this builder
GetFeaturesBatchRequest.Builder	featureServiceName(java.lang.String featureServiceName) Setter for featureServiceName
GetFeaturesBatchRequest.Builder	metadataOptions(java.util.Set<MetadataOption> metadataOptions) Setter for MetadataOption
GetFeaturesBatchRequest.Builder	microBatchSize(int microBatchSize) Setter for microBatchSize
GetFeaturesBatchRequest.Builder	requestDataList(java.util.List<GetFeaturesRequestData> requestDataList) Setter for a List of GetFeaturesRequestData
GetFeaturesBatchRequest.Builder	timeout(java.time.Duration timeout)
GetFeaturesBatchRequest.Builder	workspaceName(java.lang.String workspaceName) Setter for workspaceName

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Constructs an empty Builder

Method Detail

workspaceName

public GetFeaturesBatchRequest.Builder workspaceName(java.lang.String workspaceName)

Setter for workspaceName

Parameters:

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

Returns:

this Builder

featureServiceName

public GetFeaturesBatchRequest.Builder featureServiceName(java.lang.String featureServiceName)

Setter for featureServiceName

Parameters:

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

Returns:

this Builder

requestDataList

public GetFeaturesBatchRequest.Builder requestDataList(java.util.List<GetFeaturesRequestData> requestDataList)
                                                throws TectonClientException

Setter for a List of GetFeaturesRequestData

Parameters:

requestDataList - List of GetFeaturesRequestData objects with joinKeyMap and/or requestContextMap

Returns:

this Builder

Throws:

TectonClientException - when requestDataList is null or empty

addRequestData

public GetFeaturesBatchRequest.Builder addRequestData(GetFeaturesRequestData requestData)

Adds a single GetFeaturesRequestData object to the List

Parameters:

requestData - GetFeaturesRequestData object with joinKeyMap and/or requestContextMap

Returns:

this Builder

metadataOptions

public GetFeaturesBatchRequest.Builder metadataOptions(java.util.Set<MetadataOption> metadataOptions)

Setter for MetadataOption

Parameters:

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

Returns:

this Builder

microBatchSize

public GetFeaturesBatchRequest.Builder microBatchSize(int microBatchSize)
                                               throws TectonClientException

Setter for microBatchSize

Parameters:

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

Returns:

this Builder

Throws:

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

TectonClientException

timeout

public GetFeaturesBatchRequest.Builder timeout(java.time.Duration timeout)

Parameters:

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.

Returns:

this Builder

build

public GetFeaturesBatchRequest build()
                              throws TectonClientException

Returns an instance of GetFeaturesBatchRequest created from the fields set on this builder

Returns:

GetFeaturesBatchRequest object

Throws:

TectonClientException - when requestDataList is invalid ( when the requestDataList is null or empty, or any joinKeyMap or requestContextMap is null or empty)

InvalidRequestParameterException - when microBatchSize is out of bounds of [1,