SearchNearestEntitiesRequest.Builder (proto-google-cloud-aiplatform-v1 3.44.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.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.GeneratedMessageV3.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 Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`SearchNearestEntitiesRequest.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`SearchNearestEntitiesRequest`	`build()`
`SearchNearestEntitiesRequest`	`buildPartial()`
`SearchNearestEntitiesRequest.Builder`	`clear()`
`SearchNearestEntitiesRequest.Builder`	`clearFeatureView()` Required.
`SearchNearestEntitiesRequest.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`SearchNearestEntitiesRequest.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`SearchNearestEntitiesRequest.Builder`	`clearQuery()` Required.
`SearchNearestEntitiesRequest.Builder`	`clearReturnFullEntity()` Optional.
`SearchNearestEntitiesRequest.Builder`	`clone()`
`SearchNearestEntitiesRequest`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`String`	`getFeatureView()` Required.
`com.google.protobuf.ByteString`	`getFeatureViewBytes()` Required.
`NearestNeighborQuery`	`getQuery()` Required.
`NearestNeighborQuery.Builder`	`getQueryBuilder()` Required.
`NearestNeighborQueryOrBuilder`	`getQueryOrBuilder()` Required.
`boolean`	`getReturnFullEntity()` Optional.
`boolean`	`hasQuery()` Required.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`SearchNearestEntitiesRequest.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`SearchNearestEntitiesRequest.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`SearchNearestEntitiesRequest.Builder`	`mergeFrom(SearchNearestEntitiesRequest other)`
`SearchNearestEntitiesRequest.Builder`	`mergeQuery(NearestNeighborQuery value)` Required.
`SearchNearestEntitiesRequest.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`SearchNearestEntitiesRequest.Builder`	`setFeatureView(String value)` Required.
`SearchNearestEntitiesRequest.Builder`	`setFeatureViewBytes(com.google.protobuf.ByteString value)` Required.
`SearchNearestEntitiesRequest.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`SearchNearestEntitiesRequest.Builder`	`setQuery(NearestNeighborQuery.Builder builderForValue)` Required.
`SearchNearestEntitiesRequest.Builder`	`setQuery(NearestNeighborQuery value)` Required.
`SearchNearestEntitiesRequest.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`SearchNearestEntitiesRequest.Builder`	`setReturnFullEntity(boolean value)` Optional.
`SearchNearestEntitiesRequest.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

- Method Detail
  - getDescriptor
```
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.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.GeneratedMessageV3.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.GeneratedMessageV3.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
  - clone
```
public SearchNearestEntitiesRequest.Builder clone()
```
    Specified by:
    
    clone in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clone in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clone in class com.google.protobuf.GeneratedMessageV3.Builder<SearchNearestEntitiesRequest.Builder>
  - setField
```
public SearchNearestEntitiesRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                     Object value)
```
    Specified by:
    
    setField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchNearestEntitiesRequest.Builder>
  - clearField
```
public SearchNearestEntitiesRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
    Specified by:
    
    clearField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchNearestEntitiesRequest.Builder>
  - clearOneof
```
public SearchNearestEntitiesRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
    Specified by:
    
    clearOneof in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<SearchNearestEntitiesRequest.Builder>
  - setRepeatedField
```
public SearchNearestEntitiesRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                             int index,
                                                             Object value)
```
    Specified by:
    
    setRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchNearestEntitiesRequest.Builder>
  - addRepeatedField
```
public SearchNearestEntitiesRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                             Object value)
```
    Specified by:
    
    addRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchNearestEntitiesRequest.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.GeneratedMessageV3.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.
  - setUnknownFields
```
public final SearchNearestEntitiesRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    setUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchNearestEntitiesRequest.Builder>
  - mergeUnknownFields
```
public final SearchNearestEntitiesRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    mergeUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchNearestEntitiesRequest.Builder>

Class SearchNearestEntitiesRequest.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.Message.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getFeatureView

getFeatureViewBytes

setFeatureView

clearFeatureView

setFeatureViewBytes

hasQuery

getQuery

setQuery

setQuery

mergeQuery

clearQuery

getQueryBuilder

getQueryOrBuilder

getReturnFullEntity

setReturnFullEntity

clearReturnFullEntity

setUnknownFields

mergeUnknownFields