Package com.google.cloud.aiplatform.v1

Class SearchNearestEntitiesRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<SearchNearestEntitiesRequest.Builder>
com.google.cloud.aiplatform.v1.SearchNearestEntitiesRequest.Builder
All Implemented Interfaces:
SearchNearestEntitiesRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
SearchNearestEntitiesRequest
public static final class SearchNearestEntitiesRequest.Builder extends com.google.protobuf.GeneratedMessage.Builder<SearchNearestEntitiesRequest.Builder> implements SearchNearestEntitiesRequestOrBuilder
 The request message for
 [FeatureOnlineStoreService.SearchNearestEntities][google.cloud.aiplatform.v1.FeatureOnlineStoreService.SearchNearestEntities].
Protobuf type google.cloud.aiplatform.v1.SearchNearestEntitiesRequest

  • 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.Builder<SearchNearestEntitiesRequest.Builder>

    • clear

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<SearchNearestEntitiesRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public SearchNearestEntitiesRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchNearestEntitiesRequest.Builder>

    • mergeFrom

      public SearchNearestEntitiesRequest.Builder mergeFrom(SearchNearestEntitiesRequest other)

    • isInitialized

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

    • mergeFrom

      public SearchNearestEntitiesRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchNearestEntitiesRequest.Builder>
      Throws:
      IOException

    • 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.

    • setFeatureView

      public SearchNearestEntitiesRequest.Builder setFeatureView(String value)
       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) = { ... }
      Parameters:
      value - The featureView to set.
      Returns:
      This builder for chaining.

    • clearFeatureView

      public SearchNearestEntitiesRequest.Builder clearFeatureView()
       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:
      This builder for chaining.

    • setFeatureViewBytes

      public SearchNearestEntitiesRequest.Builder setFeatureViewBytes(com.google.protobuf.ByteString value)
       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) = { ... }
      Parameters:
      value - The bytes for featureView to set.
      Returns:
      This builder for chaining.

    • 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.

    • setQuery

      public SearchNearestEntitiesRequest.Builder setQuery(NearestNeighborQuery value)
       Required. The query.
      .google.cloud.aiplatform.v1.NearestNeighborQuery query = 2 [(.google.api.field_behavior) = REQUIRED];

    • setQuery

      public SearchNearestEntitiesRequest.Builder setQuery(NearestNeighborQuery.Builder builderForValue)
       Required. The query.
      .google.cloud.aiplatform.v1.NearestNeighborQuery query = 2 [(.google.api.field_behavior) = REQUIRED];

    • mergeQuery

      public SearchNearestEntitiesRequest.Builder mergeQuery(NearestNeighborQuery value)
       Required. The query.
      .google.cloud.aiplatform.v1.NearestNeighborQuery query = 2 [(.google.api.field_behavior) = REQUIRED];

    • clearQuery

      public SearchNearestEntitiesRequest.Builder clearQuery()
       Required. The query.
      .google.cloud.aiplatform.v1.NearestNeighborQuery query = 2 [(.google.api.field_behavior) = REQUIRED];

    • getQueryBuilder

      public NearestNeighborQuery.Builder getQueryBuilder()
       Required. The query.
      .google.cloud.aiplatform.v1.NearestNeighborQuery query = 2 [(.google.api.field_behavior) = REQUIRED];

    • 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.

    • setReturnFullEntity

      public SearchNearestEntitiesRequest.Builder setReturnFullEntity(boolean value)
       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];
      Parameters:
      value - The returnFullEntity to set.
      Returns:
      This builder for chaining.

    • clearReturnFullEntity

      public SearchNearestEntitiesRequest.Builder clearReturnFullEntity()
       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:
      This builder for chaining.