Interface AggregateDataObjectsRequestOrBuilder (0.1.0)

public interface AggregateDataObjectsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAggregate()

public abstract 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 abstract 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.

getFilter()

public abstract 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 abstract 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 abstract 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 abstract 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.

hasFilter()

public abstract 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.