GqlQuery (java API)

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

All Implemented Interfaces:

GqlQueryOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, java.io.Serializable
```
public final class GqlQuery
extends GeneratedMessageV3
implements GqlQueryOrBuilder
```
```
 A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
 
```
Protobuf type google.datastore.v1.GqlQuery
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class GqlQuery.Builder
A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
- Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
  GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable

Nested Classes
Modifier and Type	Class and Description
`static class`	`GqlQuery.Builder` A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALLOW_LITERALS_FIELD_NUMBER`
`static int`	`NAMED_BINDINGS_FIELD_NUMBER`
`static int`	`POSITIONAL_BINDINGS_FIELD_NUMBER`
`static int`	`QUERY_STRING_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 Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsNamedBindings(java.lang.String key)` For each non-reserved named binding site in the query string, there must be a named parameter with that name, but not necessarily the inverse.
`boolean`	`equals(java.lang.Object obj)`
`boolean`	`getAllowLiterals()` When false, the query string must not contain any literals and instead must bind all values.
`static GqlQuery`	`getDefaultInstance()`
`GqlQuery`	`getDefaultInstanceForType()`
`static Descriptors.Descriptor`	`getDescriptor()`
`java.util.Map<java.lang.String,GqlQueryParameter>`	`getNamedBindings()` Deprecated.
`int`	`getNamedBindingsCount()` For each non-reserved named binding site in the query string, there must be a named parameter with that name, but not necessarily the inverse.
`java.util.Map<java.lang.String,GqlQueryParameter>`	`getNamedBindingsMap()` For each non-reserved named binding site in the query string, there must be a named parameter with that name, but not necessarily the inverse.
`GqlQueryParameter`	`getNamedBindingsOrDefault(java.lang.String key, GqlQueryParameter defaultValue)` For each non-reserved named binding site in the query string, there must be a named parameter with that name, but not necessarily the inverse.
`GqlQueryParameter`	`getNamedBindingsOrThrow(java.lang.String key)` For each non-reserved named binding site in the query string, there must be a named parameter with that name, but not necessarily the inverse.
`Parser<GqlQuery>`	`getParserForType()`
`GqlQueryParameter`	`getPositionalBindings(int index)` Numbered binding site @1 references the first numbered parameter, effectively using 1-based indexing, rather than the usual 0.
`int`	`getPositionalBindingsCount()` Numbered binding site @1 references the first numbered parameter, effectively using 1-based indexing, rather than the usual 0.
`java.util.List<GqlQueryParameter>`	`getPositionalBindingsList()` Numbered binding site @1 references the first numbered parameter, effectively using 1-based indexing, rather than the usual 0.
`GqlQueryParameterOrBuilder`	`getPositionalBindingsOrBuilder(int index)` Numbered binding site @1 references the first numbered parameter, effectively using 1-based indexing, rather than the usual 0.
`java.util.List<? extends GqlQueryParameterOrBuilder>`	`getPositionalBindingsOrBuilderList()` Numbered binding site @1 references the first numbered parameter, effectively using 1-based indexing, rather than the usual 0.
`java.lang.String`	`getQueryString()` A string of the format described [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
`ByteString`	`getQueryStringBytes()` A string of the format described [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
`int`	`getSerializedSize()`
`UnknownFieldSet`	`getUnknownFields()`
`int`	`hashCode()`
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected MapField`	`internalGetMapField(int number)`
`boolean`	`isInitialized()`
`static GqlQuery.Builder`	`newBuilder()`
`static GqlQuery.Builder`	`newBuilder(GqlQuery prototype)`
`GqlQuery.Builder`	`newBuilderForType()`
`protected GqlQuery.Builder`	`newBuilderForType(GeneratedMessageV3.BuilderParent parent)`
`static GqlQuery`	`parseDelimitedFrom(java.io.InputStream input)`
`static GqlQuery`	`parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)`
`static GqlQuery`	`parseFrom(byte[] data)`
`static GqlQuery`	`parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)`
`static GqlQuery`	`parseFrom(java.nio.ByteBuffer data)`
`static GqlQuery`	`parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry)`
`static GqlQuery`	`parseFrom(ByteString data)`
`static GqlQuery`	`parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)`
`static GqlQuery`	`parseFrom(CodedInputStream input)`
`static GqlQuery`	`parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`static GqlQuery`	`parseFrom(java.io.InputStream input)`
`static GqlQuery`	`parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)`
`static Parser<GqlQuery>`	`parser()`
`GqlQuery.Builder`	`toBuilder()`
`void`	`writeTo(CodedOutputStream output)`

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, hasField, hasOneof

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

Field Detail
- QUERY_STRING_FIELD_NUMBER
```
public static final int QUERY_STRING_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ALLOW_LITERALS_FIELD_NUMBER
```
public static final int ALLOW_LITERALS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- NAMED_BINDINGS_FIELD_NUMBER
```
public static final int NAMED_BINDINGS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- POSITIONAL_BINDINGS_FIELD_NUMBER
```
public static final int POSITIONAL_BINDINGS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

getUnknownFields
```
public final UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetMapField
```
protected MapField internalGetMapField(int number)
```
Overrides:

internalGetMapField in class GeneratedMessageV3

internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getQueryString

public java.lang.String getQueryString()

 A string of the format described
 [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).

string query_string = 1;

Specified by:: getQueryString in interface GqlQueryOrBuilder

getQueryStringBytes

public ByteString getQueryStringBytes()

 A string of the format described
 [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).

string query_string = 1;

Specified by:: getQueryStringBytes in interface GqlQueryOrBuilder

getAllowLiterals

public boolean getAllowLiterals()

 When false, the query string must not contain any literals and instead must
 bind all values. For example,
 `SELECT * FROM Kind WHERE a = 'string literal'` is not allowed, while
 `SELECT * FROM Kind WHERE a = @value` is.

bool allow_literals = 2;

Specified by:: getAllowLiterals in interface GqlQueryOrBuilder

getNamedBindingsCount

public int getNamedBindingsCount()

Description copied from interface: GqlQueryOrBuilder

 For each non-reserved named binding site in the query string, there must be
 a named parameter with that name, but not necessarily the inverse.
 Key must match regex `[A-Za-z_$][A-Za-z_$0-9]*`, must not match regex
 `__.*__`, and must not be `""`.

map<string, .google.datastore.v1.GqlQueryParameter> named_bindings = 5;

Specified by:: getNamedBindingsCount in interface GqlQueryOrBuilder

containsNamedBindings

public boolean containsNamedBindings(java.lang.String key)

 For each non-reserved named binding site in the query string, there must be
 a named parameter with that name, but not necessarily the inverse.
 Key must match regex `[A-Za-z_$][A-Za-z_$0-9]*`, must not match regex
 `__.*__`, and must not be `""`.

map<string, .google.datastore.v1.GqlQueryParameter> named_bindings = 5;

Specified by:: containsNamedBindings in interface GqlQueryOrBuilder

getNamedBindings
```
@Deprecated
public java.util.Map<java.lang.String,GqlQueryParameter> getNamedBindings()
```
Deprecated.

Use getNamedBindingsMap() instead.

Specified by:

getNamedBindings in interface GqlQueryOrBuilder

getNamedBindingsMap

public java.util.Map<java.lang.String,GqlQueryParameter> getNamedBindingsMap()

 For each non-reserved named binding site in the query string, there must be
 a named parameter with that name, but not necessarily the inverse.
 Key must match regex `[A-Za-z_$][A-Za-z_$0-9]*`, must not match regex
 `__.*__`, and must not be `""`.

map<string, .google.datastore.v1.GqlQueryParameter> named_bindings = 5;

Specified by:: getNamedBindingsMap in interface GqlQueryOrBuilder

getNamedBindingsOrDefault

public GqlQueryParameter getNamedBindingsOrDefault(java.lang.String key,
                                                   GqlQueryParameter defaultValue)

 For each non-reserved named binding site in the query string, there must be
 a named parameter with that name, but not necessarily the inverse.
 Key must match regex `[A-Za-z_$][A-Za-z_$0-9]*`, must not match regex
 `__.*__`, and must not be `""`.

map<string, .google.datastore.v1.GqlQueryParameter> named_bindings = 5;

Specified by:: getNamedBindingsOrDefault in interface GqlQueryOrBuilder

getNamedBindingsOrThrow

public GqlQueryParameter getNamedBindingsOrThrow(java.lang.String key)

 For each non-reserved named binding site in the query string, there must be
 a named parameter with that name, but not necessarily the inverse.
 Key must match regex `[A-Za-z_$][A-Za-z_$0-9]*`, must not match regex
 `__.*__`, and must not be `""`.

map<string, .google.datastore.v1.GqlQueryParameter> named_bindings = 5;

Specified by:: getNamedBindingsOrThrow in interface GqlQueryOrBuilder