Class SearchNearestEntitiesRequest.Builder (3.45.0)

public static final class SearchNearestEntitiesRequest.Builder extends GeneratedMessageV3.Builder<SearchNearestEntitiesRequest.Builder> implements SearchNearestEntitiesRequestOrBuilder

The request message for FeatureOnlineStoreService.SearchNearestEntities.

Protobuf type google.cloud.aiplatform.v1.SearchNearestEntitiesRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SearchNearestEntitiesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SearchNearestEntitiesRequest.Builder
Overrides

build()

public SearchNearestEntitiesRequest build()
Returns
Type Description
SearchNearestEntitiesRequest

buildPartial()

public SearchNearestEntitiesRequest buildPartial()
Returns
Type Description
SearchNearestEntitiesRequest

clear()

public SearchNearestEntitiesRequest.Builder clear()
Returns
Type Description
SearchNearestEntitiesRequest.Builder
Overrides

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
Type Description
SearchNearestEntitiesRequest.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public SearchNearestEntitiesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
SearchNearestEntitiesRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchNearestEntitiesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
SearchNearestEntitiesRequest.Builder
Overrides

clearQuery()

public SearchNearestEntitiesRequest.Builder clearQuery()

Required. The query.

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

Returns
Type Description
SearchNearestEntitiesRequest.Builder

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
Type Description
SearchNearestEntitiesRequest.Builder

This builder for chaining.

clone()

public SearchNearestEntitiesRequest.Builder clone()
Returns
Type Description
SearchNearestEntitiesRequest.Builder
Overrides

getDefaultInstanceForType()

public SearchNearestEntitiesRequest getDefaultInstanceForType()
Returns
Type Description
SearchNearestEntitiesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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
Type Description
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
Type Description
ByteString

The bytes for featureView.

getQuery()

public NearestNeighborQuery getQuery()

Required. The query.

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

Returns
Type Description
NearestNeighborQuery

The query.

getQueryBuilder()

public NearestNeighborQuery.Builder getQueryBuilder()

Required. The query.

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

Returns
Type Description
NearestNeighborQuery.Builder

getQueryOrBuilder()

public NearestNeighborQueryOrBuilder getQueryOrBuilder()

Required. The query.

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

Returns
Type Description
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
Type Description
boolean

The returnFullEntity.

hasQuery()

public boolean hasQuery()

Required. The query.

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

Returns
Type Description
boolean

Whether the query field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SearchNearestEntitiesRequest other)

public SearchNearestEntitiesRequest.Builder mergeFrom(SearchNearestEntitiesRequest other)
Parameter
Name Description
other SearchNearestEntitiesRequest
Returns
Type Description
SearchNearestEntitiesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchNearestEntitiesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchNearestEntitiesRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SearchNearestEntitiesRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SearchNearestEntitiesRequest.Builder
Overrides

mergeQuery(NearestNeighborQuery value)

public SearchNearestEntitiesRequest.Builder mergeQuery(NearestNeighborQuery value)

Required. The query.

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

Parameter
Name Description
value NearestNeighborQuery
Returns
Type Description
SearchNearestEntitiesRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchNearestEntitiesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SearchNearestEntitiesRequest.Builder
Overrides

setFeatureView(String value)

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) = { ... }

Parameter
Name Description
value String

The featureView to set.

Returns
Type Description
SearchNearestEntitiesRequest.Builder

This builder for chaining.

setFeatureViewBytes(ByteString value)

public SearchNearestEntitiesRequest.Builder setFeatureViewBytes(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) = { ... }

Parameter
Name Description
value ByteString

The bytes for featureView to set.

Returns
Type Description
SearchNearestEntitiesRequest.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public SearchNearestEntitiesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SearchNearestEntitiesRequest.Builder
Overrides

setQuery(NearestNeighborQuery value)

public SearchNearestEntitiesRequest.Builder setQuery(NearestNeighborQuery value)

Required. The query.

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

Parameter
Name Description
value NearestNeighborQuery
Returns
Type Description
SearchNearestEntitiesRequest.Builder

setQuery(NearestNeighborQuery.Builder builderForValue)

public SearchNearestEntitiesRequest.Builder setQuery(NearestNeighborQuery.Builder builderForValue)

Required. The query.

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

Parameter
Name Description
builderForValue NearestNeighborQuery.Builder
Returns
Type Description
SearchNearestEntitiesRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SearchNearestEntitiesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
SearchNearestEntitiesRequest.Builder
Overrides

setReturnFullEntity(boolean value)

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];

Parameter
Name Description
value boolean

The returnFullEntity to set.

Returns
Type Description
SearchNearestEntitiesRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchNearestEntitiesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SearchNearestEntitiesRequest.Builder
Overrides