Class AggregateDataObjectsRequest (0.1.0)
public final class AggregateDataObjectsRequest extends GeneratedMessageV3 implements AggregateDataObjectsRequestOrBuilder
Request message for
DataObjectSearchService.AggregateDataObjects.
Protobuf type google.cloud.vectorsearch.v1beta.AggregateDataObjectsRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
AGGREGATE_FIELD_NUMBER
public static final int AGGREGATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static AggregateDataObjectsRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static AggregateDataObjectsRequest.Builder newBuilder()
newBuilder(AggregateDataObjectsRequest prototype)
public static AggregateDataObjectsRequest.Builder newBuilder(AggregateDataObjectsRequest prototype)
public static AggregateDataObjectsRequest parseDelimitedFrom(InputStream input)
public static AggregateDataObjectsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static AggregateDataObjectsRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AggregateDataObjectsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static AggregateDataObjectsRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AggregateDataObjectsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AggregateDataObjectsRequest parseFrom(CodedInputStream input)
public static AggregateDataObjectsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static AggregateDataObjectsRequest parseFrom(InputStream input)
public static AggregateDataObjectsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static AggregateDataObjectsRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AggregateDataObjectsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<AggregateDataObjectsRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getAggregate()
public AggregationMethod getAggregate()
Required. The aggregation method to apply to the query.
.google.cloud.vectorsearch.v1beta.AggregationMethod aggregate = 3 [(.google.api.field_behavior) = REQUIRED];
getAggregateValue()
public int getAggregateValue()
Required. The aggregation method to apply to the query.
.google.cloud.vectorsearch.v1beta.AggregationMethod aggregate = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for aggregate.
|
getDefaultInstanceForType()
public AggregateDataObjectsRequest getDefaultInstanceForType()
getFilter()
public Struct getFilter()
Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}},
represented as a google.protobuf.Struct.
.google.protobuf.Struct filter = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
Struct |
The filter.
|
getFilterOrBuilder()
public StructOrBuilder getFilterOrBuilder()
Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}},
represented as a google.protobuf.Struct.
.google.protobuf.Struct filter = 2 [(.google.api.field_behavior) = OPTIONAL];
getParent()
public String getParent()
Required. The resource name of the Collection for which to query.
Format: projects/{project}/locations/{location}/collections/{collection}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The parent.
|
getParentBytes()
public ByteString getParentBytes()
Required. The resource name of the Collection for which to query.
Format: projects/{project}/locations/{location}/collections/{collection}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for parent.
|
getParserForType()
public Parser<AggregateDataObjectsRequest> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hasFilter()
public boolean hasFilter()
Optional. A JSON filter expression, e.g. {"genre": {"$eq": "sci-fi"}},
represented as a google.protobuf.Struct.
.google.protobuf.Struct filter = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the filter field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public AggregateDataObjectsRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AggregateDataObjectsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public AggregateDataObjectsRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-11-19 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-11-19 UTC."],[],[]]
