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
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
public static final Descriptors.Descriptor getDescriptor()
Methods
public SearchNearestEntitiesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
public SearchNearestEntitiesRequest build()
public SearchNearestEntitiesRequest buildPartial()
public SearchNearestEntitiesRequest.Builder clear()
Overrides
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) = { ... }
public SearchNearestEntitiesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
public SearchNearestEntitiesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
public SearchNearestEntitiesRequest.Builder clearQuery()
Required. The query.
.google.cloud.aiplatform.v1.NearestNeighborQuery query = 2 [(.google.api.field_behavior) = REQUIRED];
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];
public SearchNearestEntitiesRequest.Builder clone()
Overrides
public SearchNearestEntitiesRequest getDefaultInstanceForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
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.
|
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.
|
public NearestNeighborQuery getQuery()
Required. The query.
.google.cloud.aiplatform.v1.NearestNeighborQuery query = 2 [(.google.api.field_behavior) = REQUIRED];
public NearestNeighborQuery.Builder getQueryBuilder()
Required. The query.
.google.cloud.aiplatform.v1.NearestNeighborQuery query = 2 [(.google.api.field_behavior) = REQUIRED];
public NearestNeighborQueryOrBuilder getQueryOrBuilder()
Required. The query.
.google.cloud.aiplatform.v1.NearestNeighborQuery query = 2 [(.google.api.field_behavior) = REQUIRED];
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.
|
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.
|
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public SearchNearestEntitiesRequest.Builder mergeFrom(SearchNearestEntitiesRequest other)
public SearchNearestEntitiesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
public SearchNearestEntitiesRequest.Builder mergeFrom(Message other)
| Parameter |
| Name |
Description |
other |
Message
|
Overrides
public SearchNearestEntitiesRequest.Builder mergeQuery(NearestNeighborQuery value)
Required. The query.
.google.cloud.aiplatform.v1.NearestNeighborQuery query = 2 [(.google.api.field_behavior) = REQUIRED];
public final SearchNearestEntitiesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
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.
|
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.
|
public SearchNearestEntitiesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
public SearchNearestEntitiesRequest.Builder setQuery(NearestNeighborQuery value)
Required. The query.
.google.cloud.aiplatform.v1.NearestNeighborQuery query = 2 [(.google.api.field_behavior) = REQUIRED];
public SearchNearestEntitiesRequest.Builder setQuery(NearestNeighborQuery.Builder builderForValue)
Required. The query.
.google.cloud.aiplatform.v1.NearestNeighborQuery query = 2 [(.google.api.field_behavior) = REQUIRED];
public SearchNearestEntitiesRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
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.
|
public final SearchNearestEntitiesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
