Package com.google.cloud.aiplatform.v1

Class SearchNearestEntitiesRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.SearchNearestEntitiesRequest
All Implemented Interfaces:
SearchNearestEntitiesRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class SearchNearestEntitiesRequest extends com.google.protobuf.GeneratedMessage implements SearchNearestEntitiesRequestOrBuilder
 The request message for
 [FeatureOnlineStoreService.SearchNearestEntities][google.cloud.aiplatform.v1.FeatureOnlineStoreService.SearchNearestEntities].
Protobuf type google.cloud.aiplatform.v1.SearchNearestEntitiesRequest
See Also:

  • Field Details

    • FEATURE_VIEW_FIELD_NUMBER

      public static final int FEATURE_VIEW_FIELD_NUMBER
      See Also:

    • QUERY_FIELD_NUMBER

      public static final int QUERY_FIELD_NUMBER
      See Also:

    • RETURN_FULL_ENTITY_FIELD_NUMBER

      public static final int RETURN_FULL_ENTITY_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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) = { ... }
      Specified by:
      getFeatureView in interface SearchNearestEntitiesRequestOrBuilder
      Returns:
      The featureView.

    • getFeatureViewBytes

      public 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) = { ... }
      Specified by:
      getFeatureViewBytes in interface SearchNearestEntitiesRequestOrBuilder
      Returns:
      The bytes for featureView.

    • hasQuery

      public boolean hasQuery()
       Required. The query.
      .google.cloud.aiplatform.v1.NearestNeighborQuery query = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasQuery in interface SearchNearestEntitiesRequestOrBuilder
      Returns:
      Whether the query field is set.

    • getQuery

      public NearestNeighborQuery getQuery()
       Required. The query.
      .google.cloud.aiplatform.v1.NearestNeighborQuery query = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getQuery in interface SearchNearestEntitiesRequestOrBuilder
      Returns:
      The query.

    • getQueryOrBuilder

      public NearestNeighborQueryOrBuilder getQueryOrBuilder()
       Required. The query.
      .google.cloud.aiplatform.v1.NearestNeighborQuery query = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getQueryOrBuilder in interface SearchNearestEntitiesRequestOrBuilder

    • 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];
      Specified by:
      getReturnFullEntity in interface SearchNearestEntitiesRequestOrBuilder
      Returns:
      The returnFullEntity.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static SearchNearestEntitiesRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchNearestEntitiesRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchNearestEntitiesRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchNearestEntitiesRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchNearestEntitiesRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchNearestEntitiesRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchNearestEntitiesRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchNearestEntitiesRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SearchNearestEntitiesRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SearchNearestEntitiesRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchNearestEntitiesRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchNearestEntitiesRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public SearchNearestEntitiesRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static SearchNearestEntitiesRequest.Builder newBuilder()

    • newBuilder

      public static SearchNearestEntitiesRequest.Builder newBuilder(SearchNearestEntitiesRequest prototype)

    • toBuilder

      public SearchNearestEntitiesRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected SearchNearestEntitiesRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static SearchNearestEntitiesRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SearchNearestEntitiesRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<SearchNearestEntitiesRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public SearchNearestEntitiesRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder