Class SearchNearestEntitiesRequest (3.41.0)

public final class SearchNearestEntitiesRequest extends GeneratedMessageV3 implements SearchNearestEntitiesRequestOrBuilder

The request message for FeatureOnlineStoreService.SearchNearestEntities.

Protobuf type google.cloud.aiplatform.v1.SearchNearestEntitiesRequest

Static Fields

FEATURE_VIEW_FIELD_NUMBER

public static final int FEATURE_VIEW_FIELD_NUMBER
Field Value
TypeDescription
int

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER
Field Value
TypeDescription
int

RETURN_FULL_ENTITY_FIELD_NUMBER

public static final int RETURN_FULL_ENTITY_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SearchNearestEntitiesRequest getDefaultInstance()
Returns
TypeDescription
SearchNearestEntitiesRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static SearchNearestEntitiesRequest.Builder newBuilder()
Returns
TypeDescription
SearchNearestEntitiesRequest.Builder

newBuilder(SearchNearestEntitiesRequest prototype)

public static SearchNearestEntitiesRequest.Builder newBuilder(SearchNearestEntitiesRequest prototype)
Parameter
NameDescription
prototypeSearchNearestEntitiesRequest
Returns
TypeDescription
SearchNearestEntitiesRequest.Builder

parseDelimitedFrom(InputStream input)

public static SearchNearestEntitiesRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchNearestEntitiesRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchNearestEntitiesRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchNearestEntitiesRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SearchNearestEntitiesRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SearchNearestEntitiesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchNearestEntitiesRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchNearestEntitiesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchNearestEntitiesRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SearchNearestEntitiesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchNearestEntitiesRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchNearestEntitiesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchNearestEntitiesRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SearchNearestEntitiesRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchNearestEntitiesRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchNearestEntitiesRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SearchNearestEntitiesRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SearchNearestEntitiesRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchNearestEntitiesRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchNearestEntitiesRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SearchNearestEntitiesRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SearchNearestEntitiesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchNearestEntitiesRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SearchNearestEntitiesRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SearchNearestEntitiesRequest> parser()
Returns
TypeDescription
Parser<SearchNearestEntitiesRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public SearchNearestEntitiesRequest getDefaultInstanceForType()
Returns
TypeDescription
SearchNearestEntitiesRequest

getFeatureView()

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
TypeDescription
String

The featureView.

getFeatureViewBytes()

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
TypeDescription
ByteString

The bytes for featureView.

getParserForType()

public Parser<SearchNearestEntitiesRequest> getParserForType()
Returns
TypeDescription
Parser<SearchNearestEntitiesRequest>
Overrides

getQuery()

public NearestNeighborQuery getQuery()

Required. The query.

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

Returns
TypeDescription
NearestNeighborQuery

The query.

getQueryOrBuilder()

public NearestNeighborQueryOrBuilder getQueryOrBuilder()

Required. The query.

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

Returns
TypeDescription
NearestNeighborQueryOrBuilder

getReturnFullEntity()

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
TypeDescription
boolean

The returnFullEntity.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasQuery()

public boolean hasQuery()

Required. The query.

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

Returns
TypeDescription
boolean

Whether the query field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SearchNearestEntitiesRequest.Builder newBuilderForType()
Returns
TypeDescription
SearchNearestEntitiesRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SearchNearestEntitiesRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SearchNearestEntitiesRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SearchNearestEntitiesRequest.Builder toBuilder()
Returns
TypeDescription
SearchNearestEntitiesRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException