Interface SearchNearestEntitiesRequestOrBuilder (3.37.0)

Version 3.37.0

• 3.54.0 (latest)
• 3.53.0
• 3.52.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public interface SearchNearestEntitiesRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFeatureView()

public abstract String getFeatureView()

Required. FeatureView resource format projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}

string feature_view = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The featureView.

getFeatureViewBytes()

public abstract ByteString getFeatureViewBytes()

Required. FeatureView resource format projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}

string feature_view = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for featureView.

getQuery()

public abstract NearestNeighborQuery getQuery()

Required. The query.

.google.cloud.aiplatform.v1.NearestNeighborQuery query = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
NearestNeighborQuery	The query.

getQueryOrBuilder()

public abstract NearestNeighborQueryOrBuilder getQueryOrBuilder()

Required. The query.

.google.cloud.aiplatform.v1.NearestNeighborQuery query = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
NearestNeighborQueryOrBuilder

getReturnFullEntity()

public abstract boolean getReturnFullEntity()

Optional. If set to true, the full entities (including all vector values and metadata) of the nearest neighbors are returned; otherwise only entity id of the nearest neighbors will be returned. Note that returning full entities will significantly increase the latency and cost of the query.

bool return_full_entity = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The returnFullEntity.

hasQuery()

public abstract boolean hasQuery()

Required. The query.

.google.cloud.aiplatform.v1.NearestNeighborQuery query = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the query field is set.