Query (Google Cloud Datastore Parent 2.16.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.datastore.v1.Query

All Implemented Interfaces:

QueryOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
```
public final class Query
extends com.google.protobuf.GeneratedMessageV3
implements QueryOrBuilder
```
```
 A query for entities.
 
```
Protobuf type google.datastore.v1.Query
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Query.Builder
A query for entities.
- Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
  com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
- Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
  com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Nested Classes
Modifier and Type	Class and Description
`static class`	`Query.Builder` A query for entities.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DISTINCT_ON_FIELD_NUMBER`
`static int`	`END_CURSOR_FIELD_NUMBER`
`static int`	`FILTER_FIELD_NUMBER`
`static int`	`KIND_FIELD_NUMBER`
`static int`	`LIMIT_FIELD_NUMBER`
`static int`	`OFFSET_FIELD_NUMBER`
`static int`	`ORDER_FIELD_NUMBER`
`static int`	`PROJECTION_FIELD_NUMBER`
`static int`	`START_CURSOR_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`static Query`	`getDefaultInstance()`
`Query`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`PropertyReference`	`getDistinctOn(int index)` The properties to make distinct.
`int`	`getDistinctOnCount()` The properties to make distinct.
`List<PropertyReference>`	`getDistinctOnList()` The properties to make distinct.
`PropertyReferenceOrBuilder`	`getDistinctOnOrBuilder(int index)` The properties to make distinct.
`List<? extends PropertyReferenceOrBuilder>`	`getDistinctOnOrBuilderList()` The properties to make distinct.
`com.google.protobuf.ByteString`	`getEndCursor()` An ending point for the query results.
`Filter`	`getFilter()` The filter to apply.
`FilterOrBuilder`	`getFilterOrBuilder()` The filter to apply.
`KindExpression`	`getKind(int index)` The kinds to query (if empty, returns entities of all kinds).
`int`	`getKindCount()` The kinds to query (if empty, returns entities of all kinds).
`List<KindExpression>`	`getKindList()` The kinds to query (if empty, returns entities of all kinds).
`KindExpressionOrBuilder`	`getKindOrBuilder(int index)` The kinds to query (if empty, returns entities of all kinds).
`List<? extends KindExpressionOrBuilder>`	`getKindOrBuilderList()` The kinds to query (if empty, returns entities of all kinds).
`com.google.protobuf.Int32Value`	`getLimit()` The maximum number of results to return.
`com.google.protobuf.Int32ValueOrBuilder`	`getLimitOrBuilder()` The maximum number of results to return.
`int`	`getOffset()` The number of results to skip.
`PropertyOrder`	`getOrder(int index)` The order to apply to the query results (if empty, order is unspecified).
`int`	`getOrderCount()` The order to apply to the query results (if empty, order is unspecified).
`List<PropertyOrder>`	`getOrderList()` The order to apply to the query results (if empty, order is unspecified).
`PropertyOrderOrBuilder`	`getOrderOrBuilder(int index)` The order to apply to the query results (if empty, order is unspecified).
`List<? extends PropertyOrderOrBuilder>`	`getOrderOrBuilderList()` The order to apply to the query results (if empty, order is unspecified).
`com.google.protobuf.Parser<Query>`	`getParserForType()`
`Projection`	`getProjection(int index)` The projection to return.
`int`	`getProjectionCount()` The projection to return.
`List<Projection>`	`getProjectionList()` The projection to return.
`ProjectionOrBuilder`	`getProjectionOrBuilder(int index)` The projection to return.
`List<? extends ProjectionOrBuilder>`	`getProjectionOrBuilderList()` The projection to return.
`int`	`getSerializedSize()`
`com.google.protobuf.ByteString`	`getStartCursor()` A starting point for the query results.
`boolean`	`hasFilter()` The filter to apply.
`int`	`hashCode()`
`boolean`	`hasLimit()` The maximum number of results to return.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static Query.Builder`	`newBuilder()`
`static Query.Builder`	`newBuilder(Query prototype)`
`Query.Builder`	`newBuilderForType()`
`protected Query.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static Query`	`parseDelimitedFrom(InputStream input)`
`static Query`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Query`	`parseFrom(byte[] data)`
`static Query`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Query`	`parseFrom(ByteBuffer data)`
`static Query`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Query`	`parseFrom(com.google.protobuf.ByteString data)`
`static Query`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Query`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static Query`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Query`	`parseFrom(InputStream input)`
`static Query`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<Query>`	`parser()`
`Query.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- PROJECTION_FIELD_NUMBER
```
public static final int PROJECTION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- KIND_FIELD_NUMBER
```
public static final int KIND_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- FILTER_FIELD_NUMBER
```
public static final int FILTER_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ORDER_FIELD_NUMBER
```
public static final int ORDER_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DISTINCT_ON_FIELD_NUMBER
```
public static final int DISTINCT_ON_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- START_CURSOR_FIELD_NUMBER
```
public static final int START_CURSOR_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- END_CURSOR_FIELD_NUMBER
```
public static final int END_CURSOR_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- OFFSET_FIELD_NUMBER
```
public static final int OFFSET_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LIMIT_FIELD_NUMBER
```
public static final int LIMIT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getProjectionList
```
public List<Projection> getProjectionList()
```
```
 The projection to return. Defaults to returning all properties.
 
```
repeated .google.datastore.v1.Projection projection = 2;
Specified by:

getProjectionList in interface QueryOrBuilder

getProjectionOrBuilderList
```
public List<? extends ProjectionOrBuilder> getProjectionOrBuilderList()
```
```
 The projection to return. Defaults to returning all properties.
 
```
repeated .google.datastore.v1.Projection projection = 2;
Specified by:

getProjectionOrBuilderList in interface QueryOrBuilder

getProjectionCount
```
public int getProjectionCount()
```
```
 The projection to return. Defaults to returning all properties.
 
```
repeated .google.datastore.v1.Projection projection = 2;
Specified by:

getProjectionCount in interface QueryOrBuilder

getProjection
```
public Projection getProjection(int index)
```
```
 The projection to return. Defaults to returning all properties.
 
```
repeated .google.datastore.v1.Projection projection = 2;
Specified by:

getProjection in interface QueryOrBuilder

getProjectionOrBuilder
```
public ProjectionOrBuilder getProjectionOrBuilder(int index)
```
```
 The projection to return. Defaults to returning all properties.
 
```
repeated .google.datastore.v1.Projection projection = 2;
Specified by:

getProjectionOrBuilder in interface QueryOrBuilder

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;

Specified by:: getKindList in interface QueryOrBuilder

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;

Specified by:: getKindOrBuilderList in interface QueryOrBuilder

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;

Specified by:: getKindCount in interface QueryOrBuilder

getKind

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;

Specified by:: getKind in interface QueryOrBuilder

getKindOrBuilder

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;

Specified by:: getKindOrBuilder in interface QueryOrBuilder

hasFilter
```
public boolean hasFilter()
```
```
 The filter to apply.
 
```
.google.datastore.v1.Filter filter = 4;
Specified by:

hasFilter in interface QueryOrBuilder

Returns:

Whether the filter field is set.

getFilter
```
public Filter getFilter()
```
```
 The filter to apply.
 
```
.google.datastore.v1.Filter filter = 4;
Specified by:

getFilter in interface QueryOrBuilder

Returns:

The filter.

getFilterOrBuilder
```
public FilterOrBuilder getFilterOrBuilder()
```
```
 The filter to apply.
 
```
.google.datastore.v1.Filter filter = 4;
Specified by:

getFilterOrBuilder in interface QueryOrBuilder

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;

Specified by:: getOrderList in interface QueryOrBuilder

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;

Specified by:: getOrderOrBuilderList in interface QueryOrBuilder

getOrderCount
```
public int getOrderCount()
```
```
 The order to apply to the query results (if empty, order is unspecified).
 
```
repeated .google.datastore.v1.PropertyOrder order = 5;
Specified by:

getOrderCount in interface QueryOrBuilder

getOrder

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;

Specified by:: getOrder in interface QueryOrBuilder

getOrderOrBuilder

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;

Specified by:: getOrderOrBuilder in interface QueryOrBuilder