com.google.cloud.aiplatform.v1beta1

Interface SearchNearestEntitiesRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

SearchNearestEntitiesRequest, SearchNearestEntitiesRequest.Builder

public interface SearchNearestEntitiesRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getFeatureView() Required.
com.google.protobuf.ByteString	getFeatureViewBytes() Required.
NearestNeighborQuery	getQuery() Required.
NearestNeighborQueryOrBuilder	getQueryOrBuilder() Required.
boolean	getReturnFullEntity() Optional.
boolean	hasQuery() Required.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getFeatureView

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:

The featureView.

getFeatureViewBytes

com.google.protobuf.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:

The bytes for featureView.

hasQuery

boolean hasQuery()

 Required. The query.
 

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

Returns:

Whether the query field is set.

getQuery

NearestNeighborQuery getQuery()

 Required. The query.
 

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

Returns:

The query.

getQueryOrBuilder

NearestNeighborQueryOrBuilder getQueryOrBuilder()

 Required. The query.
 

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

getReturnFullEntity

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:

The returnFullEntity.