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

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()
Returns
Type Description
AggregateDataObjectsRequest

getDescriptor()

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

newBuilder()

public static AggregateDataObjectsRequest.Builder newBuilder()
Returns
Type Description
AggregateDataObjectsRequest.Builder

newBuilder(AggregateDataObjectsRequest prototype)

public static AggregateDataObjectsRequest.Builder newBuilder(AggregateDataObjectsRequest prototype)
Parameter
Name Description
prototype AggregateDataObjectsRequest
Returns
Type Description
AggregateDataObjectsRequest.Builder

parseDelimitedFrom(InputStream input)

public static AggregateDataObjectsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AggregateDataObjectsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AggregateDataObjectsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AggregateDataObjectsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AggregateDataObjectsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AggregateDataObjectsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AggregateDataObjectsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AggregateDataObjectsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AggregateDataObjectsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AggregateDataObjectsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AggregateDataObjectsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AggregateDataObjectsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AggregateDataObjectsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AggregateDataObjectsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AggregateDataObjectsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AggregateDataObjectsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AggregateDataObjectsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AggregateDataObjectsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AggregateDataObjectsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AggregateDataObjectsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AggregateDataObjectsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AggregateDataObjectsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AggregateDataObjectsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AggregateDataObjectsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AggregateDataObjectsRequest> parser()
Returns
Type Description
Parser<AggregateDataObjectsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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];

Returns
Type Description
AggregationMethod

The aggregate.

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()
Returns
Type Description
AggregateDataObjectsRequest

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

Returns
Type Description
StructOrBuilder

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()
Returns
Type Description
Parser<AggregateDataObjectsRequest>
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()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AggregateDataObjectsRequest.Builder newBuilderForType()
Returns
Type Description
AggregateDataObjectsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AggregateDataObjectsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AggregateDataObjectsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AggregateDataObjectsRequest.Builder toBuilder()
Returns
Type Description
AggregateDataObjectsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException