public final class SearchNearestEntitiesRequest extends GeneratedMessageV3 implements SearchNearestEntitiesRequestOrBuilder
The request message for
FeatureOnlineStoreService.SearchNearestEntities.
Protobuf type google.cloud.aiplatform.v1beta1.SearchNearestEntitiesRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int FEATURE_VIEW_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
public static final int QUERY_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
public static final int RETURN_FULL_ENTITY_FIELD_NUMBER
Field Value |
---|
Type | Description |
int | |
Static Methods
public static SearchNearestEntitiesRequest getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static SearchNearestEntitiesRequest.Builder newBuilder()
public static SearchNearestEntitiesRequest.Builder newBuilder(SearchNearestEntitiesRequest prototype)
public static SearchNearestEntitiesRequest parseDelimitedFrom(InputStream input)
public static SearchNearestEntitiesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchNearestEntitiesRequest parseFrom(byte[] data)
Parameter |
---|
Name | Description |
data | byte[]
|
public static SearchNearestEntitiesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchNearestEntitiesRequest parseFrom(ByteString data)
public static SearchNearestEntitiesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchNearestEntitiesRequest parseFrom(CodedInputStream input)
public static SearchNearestEntitiesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchNearestEntitiesRequest parseFrom(InputStream input)
public static SearchNearestEntitiesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchNearestEntitiesRequest parseFrom(ByteBuffer data)
public static SearchNearestEntitiesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<SearchNearestEntitiesRequest> parser()
Methods
public boolean equals(Object obj)
Parameter |
---|
Name | Description |
obj | Object
|
Overrides
public SearchNearestEntitiesRequest getDefaultInstanceForType()
public 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.
|
public 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.
|
public Parser<SearchNearestEntitiesRequest> getParserForType()
Overrides
public NearestNeighborQuery getQuery()
Required. The query.
.google.cloud.aiplatform.v1beta1.NearestNeighborQuery query = 2 [(.google.api.field_behavior) = REQUIRED];
public NearestNeighborQueryOrBuilder getQueryOrBuilder()
Required. The query.
.google.cloud.aiplatform.v1beta1.NearestNeighborQuery query = 2 [(.google.api.field_behavior) = REQUIRED];
public 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.
|
public int getSerializedSize()
Returns |
---|
Type | Description |
int | |
Overrides
public boolean hasQuery()
Required. The query.
.google.cloud.aiplatform.v1beta1.NearestNeighborQuery query = 2 [(.google.api.field_behavior) = REQUIRED];
Returns |
---|
Type | Description |
boolean | Whether the query field is set.
|
Returns |
---|
Type | Description |
int | |
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public SearchNearestEntitiesRequest.Builder newBuilderForType()
protected SearchNearestEntitiesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
public SearchNearestEntitiesRequest.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides