Class Query.Builder (2.12.4)

public static final class Query.Builder extends GeneratedMessageV3.Builder<Query.Builder> implements QueryOrBuilder

A query for entities.

Protobuf type google.datastore.v1.Query

Implements

QueryOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllDistinctOn(Iterable<? extends PropertyReference> values)

public Query.Builder addAllDistinctOn(Iterable<? extends PropertyReference> values)

The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned).

repeated .google.datastore.v1.PropertyReference distinct_on = 6;

Parameter
NameDescription
valuesIterable<? extends com.google.datastore.v1.PropertyReference>
Returns
TypeDescription
Query.Builder

addAllKind(Iterable<? extends KindExpression> values)

public Query.Builder addAllKind(Iterable<? extends KindExpression> values)

The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.

repeated .google.datastore.v1.KindExpression kind = 3;

Parameter
NameDescription
valuesIterable<? extends com.google.datastore.v1.KindExpression>
Returns
TypeDescription
Query.Builder

addAllOrder(Iterable<? extends PropertyOrder> values)

public Query.Builder addAllOrder(Iterable<? extends PropertyOrder> values)

The order to apply to the query results (if empty, order is unspecified).

repeated .google.datastore.v1.PropertyOrder order = 5;

Parameter
NameDescription
valuesIterable<? extends com.google.datastore.v1.PropertyOrder>
Returns
TypeDescription
Query.Builder

addAllProjection(Iterable<? extends Projection> values)

public Query.Builder addAllProjection(Iterable<? extends Projection> values)

The projection to return. Defaults to returning all properties.

repeated .google.datastore.v1.Projection projection = 2;

Parameter
NameDescription
valuesIterable<? extends com.google.datastore.v1.Projection>
Returns
TypeDescription
Query.Builder

addDistinctOn(PropertyReference value)

public Query.Builder addDistinctOn(PropertyReference value)

The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned).

repeated .google.datastore.v1.PropertyReference distinct_on = 6;

Parameter
NameDescription
valuePropertyReference
Returns
TypeDescription
Query.Builder

addDistinctOn(PropertyReference.Builder builderForValue)

public Query.Builder addDistinctOn(PropertyReference.Builder builderForValue)

The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned).

repeated .google.datastore.v1.PropertyReference distinct_on = 6;

Parameter
NameDescription
builderForValuePropertyReference.Builder
Returns
TypeDescription
Query.Builder

addDistinctOn(int index, PropertyReference value)

public Query.Builder addDistinctOn(int index, PropertyReference value)

The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned).

repeated .google.datastore.v1.PropertyReference distinct_on = 6;

Parameters
NameDescription
indexint
valuePropertyReference
Returns
TypeDescription
Query.Builder

addDistinctOn(int index, PropertyReference.Builder builderForValue)

public Query.Builder addDistinctOn(int index, PropertyReference.Builder builderForValue)

The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned).

repeated .google.datastore.v1.PropertyReference distinct_on = 6;

Parameters
NameDescription
indexint
builderForValuePropertyReference.Builder
Returns
TypeDescription
Query.Builder

addDistinctOnBuilder()

public PropertyReference.Builder addDistinctOnBuilder()

The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned).

repeated .google.datastore.v1.PropertyReference distinct_on = 6;

Returns
TypeDescription
PropertyReference.Builder

addDistinctOnBuilder(int index)

public PropertyReference.Builder addDistinctOnBuilder(int index)

The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned).

repeated .google.datastore.v1.PropertyReference distinct_on = 6;

Parameter
NameDescription
indexint
Returns
TypeDescription
PropertyReference.Builder

addKind(KindExpression value)

public Query.Builder addKind(KindExpression value)

The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.

repeated .google.datastore.v1.KindExpression kind = 3;

Parameter
NameDescription
valueKindExpression
Returns
TypeDescription
Query.Builder

addKind(KindExpression.Builder builderForValue)

public Query.Builder addKind(KindExpression.Builder builderForValue)

The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.

repeated .google.datastore.v1.KindExpression kind = 3;

Parameter
NameDescription
builderForValueKindExpression.Builder
Returns
TypeDescription
Query.Builder

addKind(int index, KindExpression value)

public Query.Builder addKind(int index, KindExpression value)

The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.

repeated .google.datastore.v1.KindExpression kind = 3;

Parameters
NameDescription
indexint
valueKindExpression
Returns
TypeDescription
Query.Builder

addKind(int index, KindExpression.Builder builderForValue)

public Query.Builder addKind(int index, KindExpression.Builder builderForValue)

The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.

repeated .google.datastore.v1.KindExpression kind = 3;

Parameters
NameDescription
indexint
builderForValueKindExpression.Builder
Returns
TypeDescription
Query.Builder

addKindBuilder()

public KindExpression.Builder addKindBuilder()

The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.

repeated .google.datastore.v1.KindExpression kind = 3;

Returns
TypeDescription
KindExpression.Builder

addKindBuilder(int index)

public KindExpression.Builder addKindBuilder(int index)

The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.

repeated .google.datastore.v1.KindExpression kind = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
KindExpression.Builder

addOrder(PropertyOrder value)

public Query.Builder addOrder(PropertyOrder value)

The order to apply to the query results (if empty, order is unspecified).

repeated .google.datastore.v1.PropertyOrder order = 5;

Parameter
NameDescription
valuePropertyOrder
Returns
TypeDescription
Query.Builder

addOrder(PropertyOrder.Builder builderForValue)

public Query.Builder addOrder(PropertyOrder.Builder builderForValue)

The order to apply to the query results (if empty, order is unspecified).

repeated .google.datastore.v1.PropertyOrder order = 5;

Parameter
NameDescription
builderForValuePropertyOrder.Builder
Returns
TypeDescription
Query.Builder

addOrder(int index, PropertyOrder value)

public Query.Builder addOrder(int index, PropertyOrder value)

The order to apply to the query results (if empty, order is unspecified).

repeated .google.datastore.v1.PropertyOrder order = 5;

Parameters
NameDescription
indexint
valuePropertyOrder
Returns
TypeDescription
Query.Builder

addOrder(int index, PropertyOrder.Builder builderForValue)

public Query.Builder addOrder(int index, PropertyOrder.Builder builderForValue)

The order to apply to the query results (if empty, order is unspecified).

repeated .google.datastore.v1.PropertyOrder order = 5;

Parameters
NameDescription
indexint
builderForValuePropertyOrder.Builder
Returns
TypeDescription
Query.Builder

addOrderBuilder()

public PropertyOrder.Builder addOrderBuilder()

The order to apply to the query results (if empty, order is unspecified).

repeated .google.datastore.v1.PropertyOrder order = 5;

Returns
TypeDescription
PropertyOrder.Builder

addOrderBuilder(int index)

public PropertyOrder.Builder addOrderBuilder(int index)

The order to apply to the query results (if empty, order is unspecified).

repeated .google.datastore.v1.PropertyOrder order = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
PropertyOrder.Builder

addProjection(Projection value)

public Query.Builder addProjection(Projection value)

The projection to return. Defaults to returning all properties.

repeated .google.datastore.v1.Projection projection = 2;

Parameter
NameDescription
valueProjection
Returns
TypeDescription
Query.Builder

addProjection(Projection.Builder builderForValue)

public Query.Builder addProjection(Projection.Builder builderForValue)

The projection to return. Defaults to returning all properties.

repeated .google.datastore.v1.Projection projection = 2;

Parameter
NameDescription
builderForValueProjection.Builder
Returns
TypeDescription
Query.Builder

addProjection(int index, Projection value)

public Query.Builder addProjection(int index, Projection value)

The projection to return. Defaults to returning all properties.

repeated .google.datastore.v1.Projection projection = 2;

Parameters
NameDescription
indexint
valueProjection
Returns
TypeDescription
Query.Builder

addProjection(int index, Projection.Builder builderForValue)

public Query.Builder addProjection(int index, Projection.Builder builderForValue)

The projection to return. Defaults to returning all properties.

repeated .google.datastore.v1.Projection projection = 2;

Parameters
NameDescription
indexint
builderForValueProjection.Builder
Returns
TypeDescription
Query.Builder

addProjectionBuilder()

public Projection.Builder addProjectionBuilder()

The projection to return. Defaults to returning all properties.

repeated .google.datastore.v1.Projection projection = 2;

Returns
TypeDescription
Projection.Builder

addProjectionBuilder(int index)

public Projection.Builder addProjectionBuilder(int index)

The projection to return. Defaults to returning all properties.

repeated .google.datastore.v1.Projection projection = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
Projection.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Query.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Query.Builder
Overrides

build()

public Query build()
Returns
TypeDescription
Query

buildPartial()

public Query buildPartial()
Returns
TypeDescription
Query

clear()

public Query.Builder clear()
Returns
TypeDescription
Query.Builder
Overrides

clearDistinctOn()

public Query.Builder clearDistinctOn()

The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned).

repeated .google.datastore.v1.PropertyReference distinct_on = 6;

Returns
TypeDescription
Query.Builder

clearEndCursor()

public Query.Builder clearEndCursor()

An ending point for the query results. Query cursors are returned in query result batches and can only be used to limit the same query.

bytes end_cursor = 8;

Returns
TypeDescription
Query.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Query.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Query.Builder
Overrides

clearFilter()

public Query.Builder clearFilter()

The filter to apply.

.google.datastore.v1.Filter filter = 4;

Returns
TypeDescription
Query.Builder

clearKind()

public Query.Builder clearKind()

The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.

repeated .google.datastore.v1.KindExpression kind = 3;

Returns
TypeDescription
Query.Builder

clearLimit()

public Query.Builder clearLimit()

The maximum number of results to return. Applies after all other constraints. Optional. Unspecified is interpreted as no limit. Must be >= 0 if specified.

.google.protobuf.Int32Value limit = 12;

Returns
TypeDescription
Query.Builder

clearOffset()

public Query.Builder clearOffset()

The number of results to skip. Applies before limit, but after all other constraints. Optional. Must be >= 0 if specified.

int32 offset = 10;

Returns
TypeDescription
Query.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Query.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Query.Builder
Overrides

clearOrder()

public Query.Builder clearOrder()

The order to apply to the query results (if empty, order is unspecified).

repeated .google.datastore.v1.PropertyOrder order = 5;

Returns
TypeDescription
Query.Builder

clearProjection()

public Query.Builder clearProjection()

The projection to return. Defaults to returning all properties.

repeated .google.datastore.v1.Projection projection = 2;

Returns
TypeDescription
Query.Builder

clearStartCursor()

public Query.Builder clearStartCursor()

A starting point for the query results. Query cursors are returned in query result batches and can only be used to continue the same query.

bytes start_cursor = 7;

Returns
TypeDescription
Query.Builder

This builder for chaining.

clone()

public Query.Builder clone()
Returns
TypeDescription
Query.Builder
Overrides

getDefaultInstanceForType()

public Query getDefaultInstanceForType()
Returns
TypeDescription
Query

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDistinctOn(int index)

public PropertyReference getDistinctOn(int index)

The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned).

repeated .google.datastore.v1.PropertyReference distinct_on = 6;

Parameter
NameDescription
indexint
Returns
TypeDescription
PropertyReference

getDistinctOnBuilder(int index)

public PropertyReference.Builder getDistinctOnBuilder(int index)

The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned).

repeated .google.datastore.v1.PropertyReference distinct_on = 6;

Parameter
NameDescription
indexint
Returns
TypeDescription
PropertyReference.Builder

getDistinctOnBuilderList()

public List<PropertyReference.Builder> getDistinctOnBuilderList()

The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned).

repeated .google.datastore.v1.PropertyReference distinct_on = 6;

Returns
TypeDescription
List<Builder>

getDistinctOnCount()

public int getDistinctOnCount()

The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned).

repeated .google.datastore.v1.PropertyReference distinct_on = 6;

Returns
TypeDescription
int

getDistinctOnList()

public List<PropertyReference> getDistinctOnList()

The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned).

repeated .google.datastore.v1.PropertyReference distinct_on = 6;

Returns
TypeDescription
List<PropertyReference>

getDistinctOnOrBuilder(int index)

public PropertyReferenceOrBuilder getDistinctOnOrBuilder(int index)

The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned).

repeated .google.datastore.v1.PropertyReference distinct_on = 6;

Parameter
NameDescription
indexint
Returns
TypeDescription
PropertyReferenceOrBuilder

getDistinctOnOrBuilderList()

public List<? extends PropertyReferenceOrBuilder> getDistinctOnOrBuilderList()

The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned).

repeated .google.datastore.v1.PropertyReference distinct_on = 6;

Returns
TypeDescription
List<? extends com.google.datastore.v1.PropertyReferenceOrBuilder>

getEndCursor()

public ByteString getEndCursor()

An ending point for the query results. Query cursors are returned in query result batches and can only be used to limit the same query.

bytes end_cursor = 8;

Returns
TypeDescription
ByteString

The endCursor.

getFilter()

public Filter getFilter()

The filter to apply.

.google.datastore.v1.Filter filter = 4;

Returns
TypeDescription
Filter

The filter.

getFilterBuilder()

public Filter.Builder getFilterBuilder()

The filter to apply.

.google.datastore.v1.Filter filter = 4;

Returns
TypeDescription
Filter.Builder

getFilterOrBuilder()

public FilterOrBuilder getFilterOrBuilder()

The filter to apply.

.google.datastore.v1.Filter filter = 4;

Returns
TypeDescription
FilterOrBuilder

getKind(int index)

public KindExpression getKind(int index)

The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.

repeated .google.datastore.v1.KindExpression kind = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
KindExpression

getKindBuilder(int index)

public KindExpression.Builder getKindBuilder(int index)

The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.

repeated .google.datastore.v1.KindExpression kind = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
KindExpression.Builder

getKindBuilderList()

public List<KindExpression.Builder> getKindBuilderList()

The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.

repeated .google.datastore.v1.KindExpression kind = 3;

Returns
TypeDescription
List<Builder>

getKindCount()

public int getKindCount()

The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.

repeated .google.datastore.v1.KindExpression kind = 3;

Returns
TypeDescription
int

getKindList()

public List<KindExpression> getKindList()

The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.

repeated .google.datastore.v1.KindExpression kind = 3;

Returns
TypeDescription
List<KindExpression>

getKindOrBuilder(int index)

public KindExpressionOrBuilder getKindOrBuilder(int index)

The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.

repeated .google.datastore.v1.KindExpression kind = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
KindExpressionOrBuilder

getKindOrBuilderList()

public List<? extends KindExpressionOrBuilder> getKindOrBuilderList()

The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.

repeated .google.datastore.v1.KindExpression kind = 3;

Returns
TypeDescription
List<? extends com.google.datastore.v1.KindExpressionOrBuilder>

getLimit()

public Int32Value getLimit()

The maximum number of results to return. Applies after all other constraints. Optional. Unspecified is interpreted as no limit. Must be >= 0 if specified.

.google.protobuf.Int32Value limit = 12;

Returns
TypeDescription
Int32Value

The limit.

getLimitBuilder()

public Int32Value.Builder getLimitBuilder()

The maximum number of results to return. Applies after all other constraints. Optional. Unspecified is interpreted as no limit. Must be >= 0 if specified.

.google.protobuf.Int32Value limit = 12;

Returns
TypeDescription
Builder

getLimitOrBuilder()

public Int32ValueOrBuilder getLimitOrBuilder()

The maximum number of results to return. Applies after all other constraints. Optional. Unspecified is interpreted as no limit. Must be >= 0 if specified.

.google.protobuf.Int32Value limit = 12;

Returns
TypeDescription
Int32ValueOrBuilder

getOffset()

public int getOffset()

The number of results to skip. Applies before limit, but after all other constraints. Optional. Must be >= 0 if specified.

int32 offset = 10;

Returns
TypeDescription
int

The offset.

getOrder(int index)

public PropertyOrder getOrder(int index)

The order to apply to the query results (if empty, order is unspecified).

repeated .google.datastore.v1.PropertyOrder order = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
PropertyOrder

getOrderBuilder(int index)

public PropertyOrder.Builder getOrderBuilder(int index)

The order to apply to the query results (if empty, order is unspecified).

repeated .google.datastore.v1.PropertyOrder order = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
PropertyOrder.Builder

getOrderBuilderList()

public List<PropertyOrder.Builder> getOrderBuilderList()

The order to apply to the query results (if empty, order is unspecified).

repeated .google.datastore.v1.PropertyOrder order = 5;

Returns
TypeDescription
List<Builder>

getOrderCount()

public int getOrderCount()

The order to apply to the query results (if empty, order is unspecified).

repeated .google.datastore.v1.PropertyOrder order = 5;

Returns
TypeDescription
int

getOrderList()

public List<PropertyOrder> getOrderList()

The order to apply to the query results (if empty, order is unspecified).

repeated .google.datastore.v1.PropertyOrder order = 5;

Returns
TypeDescription
List<PropertyOrder>

getOrderOrBuilder(int index)

public PropertyOrderOrBuilder getOrderOrBuilder(int index)

The order to apply to the query results (if empty, order is unspecified).

repeated .google.datastore.v1.PropertyOrder order = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
PropertyOrderOrBuilder

getOrderOrBuilderList()

public List<? extends PropertyOrderOrBuilder> getOrderOrBuilderList()

The order to apply to the query results (if empty, order is unspecified).

repeated .google.datastore.v1.PropertyOrder order = 5;

Returns
TypeDescription
List<? extends com.google.datastore.v1.PropertyOrderOrBuilder>

getProjection(int index)

public Projection getProjection(int index)

The projection to return. Defaults to returning all properties.

repeated .google.datastore.v1.Projection projection = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
Projection

getProjectionBuilder(int index)

public Projection.Builder getProjectionBuilder(int index)

The projection to return. Defaults to returning all properties.

repeated .google.datastore.v1.Projection projection = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
Projection.Builder

getProjectionBuilderList()

public List<Projection.Builder> getProjectionBuilderList()

The projection to return. Defaults to returning all properties.

repeated .google.datastore.v1.Projection projection = 2;

Returns
TypeDescription
List<Builder>

getProjectionCount()

public int getProjectionCount()

The projection to return. Defaults to returning all properties.

repeated .google.datastore.v1.Projection projection = 2;

Returns
TypeDescription
int

getProjectionList()

public List<Projection> getProjectionList()

The projection to return. Defaults to returning all properties.

repeated .google.datastore.v1.Projection projection = 2;

Returns
TypeDescription
List<Projection>

getProjectionOrBuilder(int index)

public ProjectionOrBuilder getProjectionOrBuilder(int index)

The projection to return. Defaults to returning all properties.

repeated .google.datastore.v1.Projection projection = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
ProjectionOrBuilder

getProjectionOrBuilderList()

public List<? extends ProjectionOrBuilder> getProjectionOrBuilderList()

The projection to return. Defaults to returning all properties.

repeated .google.datastore.v1.Projection projection = 2;

Returns
TypeDescription
List<? extends com.google.datastore.v1.ProjectionOrBuilder>

getStartCursor()

public ByteString getStartCursor()

A starting point for the query results. Query cursors are returned in query result batches and can only be used to continue the same query.

bytes start_cursor = 7;

Returns
TypeDescription
ByteString

The startCursor.

hasFilter()

public boolean hasFilter()

The filter to apply.

.google.datastore.v1.Filter filter = 4;

Returns
TypeDescription
boolean

Whether the filter field is set.

hasLimit()

public boolean hasLimit()

The maximum number of results to return. Applies after all other constraints. Optional. Unspecified is interpreted as no limit. Must be >= 0 if specified.

.google.protobuf.Int32Value limit = 12;

Returns
TypeDescription
boolean

Whether the limit field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFilter(Filter value)

public Query.Builder mergeFilter(Filter value)

The filter to apply.

.google.datastore.v1.Filter filter = 4;

Parameter
NameDescription
valueFilter
Returns
TypeDescription
Query.Builder

mergeFrom(Query other)

public Query.Builder mergeFrom(Query other)
Parameter
NameDescription
otherQuery
Returns
TypeDescription
Query.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Query.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Query.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Query.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Query.Builder
Overrides

mergeLimit(Int32Value value)

public Query.Builder mergeLimit(Int32Value value)

The maximum number of results to return. Applies after all other constraints. Optional. Unspecified is interpreted as no limit. Must be >= 0 if specified.

.google.protobuf.Int32Value limit = 12;

Parameter
NameDescription
valueInt32Value
Returns
TypeDescription
Query.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Query.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Query.Builder
Overrides

removeDistinctOn(int index)

public Query.Builder removeDistinctOn(int index)

The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned).

repeated .google.datastore.v1.PropertyReference distinct_on = 6;

Parameter
NameDescription
indexint
Returns
TypeDescription
Query.Builder

removeKind(int index)

public Query.Builder removeKind(int index)

The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.

repeated .google.datastore.v1.KindExpression kind = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
Query.Builder

removeOrder(int index)

public Query.Builder removeOrder(int index)

The order to apply to the query results (if empty, order is unspecified).

repeated .google.datastore.v1.PropertyOrder order = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
Query.Builder

removeProjection(int index)

public Query.Builder removeProjection(int index)

The projection to return. Defaults to returning all properties.

repeated .google.datastore.v1.Projection projection = 2;

Parameter
NameDescription
indexint
Returns
TypeDescription
Query.Builder

setDistinctOn(int index, PropertyReference value)

public Query.Builder setDistinctOn(int index, PropertyReference value)

The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned).

repeated .google.datastore.v1.PropertyReference distinct_on = 6;

Parameters
NameDescription
indexint
valuePropertyReference
Returns
TypeDescription
Query.Builder

setDistinctOn(int index, PropertyReference.Builder builderForValue)

public Query.Builder setDistinctOn(int index, PropertyReference.Builder builderForValue)

The properties to make distinct. The query results will contain the first result for each distinct combination of values for the given properties (if empty, all results are returned).

repeated .google.datastore.v1.PropertyReference distinct_on = 6;

Parameters
NameDescription
indexint
builderForValuePropertyReference.Builder
Returns
TypeDescription
Query.Builder

setEndCursor(ByteString value)

public Query.Builder setEndCursor(ByteString value)

An ending point for the query results. Query cursors are returned in query result batches and can only be used to limit the same query.

bytes end_cursor = 8;

Parameter
NameDescription
valueByteString

The endCursor to set.

Returns
TypeDescription
Query.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Query.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Query.Builder
Overrides

setFilter(Filter value)

public Query.Builder setFilter(Filter value)

The filter to apply.

.google.datastore.v1.Filter filter = 4;

Parameter
NameDescription
valueFilter
Returns
TypeDescription
Query.Builder

setFilter(Filter.Builder builderForValue)

public Query.Builder setFilter(Filter.Builder builderForValue)

The filter to apply.

.google.datastore.v1.Filter filter = 4;

Parameter
NameDescription
builderForValueFilter.Builder
Returns
TypeDescription
Query.Builder

setKind(int index, KindExpression value)

public Query.Builder setKind(int index, KindExpression value)

The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.

repeated .google.datastore.v1.KindExpression kind = 3;

Parameters
NameDescription
indexint
valueKindExpression
Returns
TypeDescription
Query.Builder

setKind(int index, KindExpression.Builder builderForValue)

public Query.Builder setKind(int index, KindExpression.Builder builderForValue)

The kinds to query (if empty, returns entities of all kinds). Currently at most 1 kind may be specified.

repeated .google.datastore.v1.KindExpression kind = 3;

Parameters
NameDescription
indexint
builderForValueKindExpression.Builder
Returns
TypeDescription
Query.Builder

setLimit(Int32Value value)

public Query.Builder setLimit(Int32Value value)

The maximum number of results to return. Applies after all other constraints. Optional. Unspecified is interpreted as no limit. Must be >= 0 if specified.

.google.protobuf.Int32Value limit = 12;

Parameter
NameDescription
valueInt32Value
Returns
TypeDescription
Query.Builder

setLimit(Int32Value.Builder builderForValue)

public Query.Builder setLimit(Int32Value.Builder builderForValue)

The maximum number of results to return. Applies after all other constraints. Optional. Unspecified is interpreted as no limit. Must be >= 0 if specified.

.google.protobuf.Int32Value limit = 12;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Query.Builder

setOffset(int value)

public Query.Builder setOffset(int value)

The number of results to skip. Applies before limit, but after all other constraints. Optional. Must be >= 0 if specified.

int32 offset = 10;

Parameter
NameDescription
valueint

The offset to set.

Returns
TypeDescription
Query.Builder

This builder for chaining.

setOrder(int index, PropertyOrder value)

public Query.Builder setOrder(int index, PropertyOrder value)

The order to apply to the query results (if empty, order is unspecified).

repeated .google.datastore.v1.PropertyOrder order = 5;

Parameters
NameDescription
indexint
valuePropertyOrder
Returns
TypeDescription
Query.Builder

setOrder(int index, PropertyOrder.Builder builderForValue)

public Query.Builder setOrder(int index, PropertyOrder.Builder builderForValue)

The order to apply to the query results (if empty, order is unspecified).

repeated .google.datastore.v1.PropertyOrder order = 5;

Parameters
NameDescription
indexint
builderForValuePropertyOrder.Builder
Returns
TypeDescription
Query.Builder

setProjection(int index, Projection value)

public Query.Builder setProjection(int index, Projection value)

The projection to return. Defaults to returning all properties.

repeated .google.datastore.v1.Projection projection = 2;

Parameters
NameDescription
indexint
valueProjection
Returns
TypeDescription
Query.Builder

setProjection(int index, Projection.Builder builderForValue)

public Query.Builder setProjection(int index, Projection.Builder builderForValue)

The projection to return. Defaults to returning all properties.

repeated .google.datastore.v1.Projection projection = 2;

Parameters
NameDescription
indexint
builderForValueProjection.Builder
Returns
TypeDescription
Query.Builder

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

public Query.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Query.Builder
Overrides

setStartCursor(ByteString value)

public Query.Builder setStartCursor(ByteString value)

A starting point for the query results. Query cursors are returned in query result batches and can only be used to continue the same query.

bytes start_cursor = 7;

Parameter
NameDescription
valueByteString

The startCursor to set.

Returns
TypeDescription
Query.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Query.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Query.Builder
Overrides