ai.tecton.client.request

Class GetFeaturesRequest.Builder

java.lang.Object

ai.tecton.client.request.GetFeaturesRequest.Builder

Enclosing class:

GetFeaturesRequest

public static final class GetFeaturesRequest.Builder
extends java.lang.Object

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

Constructor Summary

Constructors

Constructor and Description
Builder() Constructor for instantiating an empty Builder

Method Summary

Modifier and Type	Method and Description
GetFeaturesRequest	build() Returns an instance of GetFeaturesRequest created from the fields set on this builder
GetFeaturesRequest.Builder	featureServiceName(java.lang.String featureServiceName) Setter for featureServiceName
GetFeaturesRequest.Builder	getFeaturesRequestData(GetFeaturesRequestData getFeaturesRequestData) Setter for GetFeaturesRequestData
GetFeaturesRequest.Builder	metadataOptions(java.util.Set<MetadataOption> metadataOptions) Setter for metadataOptions
GetFeaturesRequest.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()

Constructor for instantiating an empty Builder

Method Detail

metadataOptions

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

Setter for metadataOptions

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

workspaceName

public GetFeaturesRequest.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 GetFeaturesRequest.Builder featureServiceName(java.lang.String featureServiceName)

Setter for featureServiceName

Parameters:

featureServiceName - Name of the Feature Service for which the feature vector is being requested

Returns:

this Builder

getFeaturesRequestData

public GetFeaturesRequest.Builder getFeaturesRequestData(GetFeaturesRequestData getFeaturesRequestData)

Setter for GetFeaturesRequestData

Parameters:

getFeaturesRequestData - GetFeaturesRequestData object with joinKeyMap and/or requestContextMap

Returns:

this Builder

build

public GetFeaturesRequest build()

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

Returns:

GetFeaturesRequest object

Throws:

InvalidRequestParameterException - when workspaceName and/or featureServiceName is null or empty