com.google.datastore.v1

Class GqlQuery

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.datastore.v1.GqlQuery

All Implemented Interfaces:

GqlQueryOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable

public final class GqlQuery
extends com.google.protobuf.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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable

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

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 com.google.protobuf.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.
com.google.protobuf.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).
com.google.protobuf.ByteString	getQueryStringBytes() A string of the format described [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
boolean	isInitialized()
static GqlQuery.Builder	newBuilder()
static GqlQuery.Builder	newBuilder(GqlQuery prototype)
GqlQuery.Builder	newBuilderForType()
protected GqlQuery.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
static GqlQuery	parseDelimitedFrom(java.io.InputStream input)
static GqlQuery	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GqlQuery	parseFrom(byte[] data)
static GqlQuery	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GqlQuery	parseFrom(java.nio.ByteBuffer data)
static GqlQuery	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GqlQuery	parseFrom(com.google.protobuf.ByteString data)
static GqlQuery	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GqlQuery	parseFrom(com.google.protobuf.CodedInputStream input)
static GqlQuery	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GqlQuery	parseFrom(java.io.InputStream input)
static GqlQuery	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<GqlQuery>	parser()
GqlQuery.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, makeExtensionsImmutable, newBuilderForType, 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, 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 com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

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

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.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 com.google.protobuf.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

getPositionalBindingsList

public java.util.List<GqlQueryParameter> getPositionalBindingsList()

 Numbered binding site @1 references the first numbered parameter,
 effectively using 1-based indexing, rather than the usual 0.
 For each binding site numbered i in `query_string`, there must be an i-th
 numbered parameter. The inverse must also be true.
 

repeated .google.datastore.v1.GqlQueryParameter positional_bindings = 4;

Specified by:

getPositionalBindingsList in interface GqlQueryOrBuilder

getPositionalBindingsOrBuilderList

public 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.
 For each binding site numbered i in `query_string`, there must be an i-th
 numbered parameter. The inverse must also be true.
 

repeated .google.datastore.v1.GqlQueryParameter positional_bindings = 4;

Specified by:

getPositionalBindingsOrBuilderList in interface GqlQueryOrBuilder

getPositionalBindingsCount

public int getPositionalBindingsCount()

 Numbered binding site @1 references the first numbered parameter,
 effectively using 1-based indexing, rather than the usual 0.
 For each binding site numbered i in `query_string`, there must be an i-th
 numbered parameter. The inverse must also be true.
 

repeated .google.datastore.v1.GqlQueryParameter positional_bindings = 4;

Specified by:

getPositionalBindingsCount in interface GqlQueryOrBuilder

getPositionalBindings

public GqlQueryParameter getPositionalBindings(int index)

 Numbered binding site @1 references the first numbered parameter,
 effectively using 1-based indexing, rather than the usual 0.
 For each binding site numbered i in `query_string`, there must be an i-th
 numbered parameter. The inverse must also be true.
 

repeated .google.datastore.v1.GqlQueryParameter positional_bindings = 4;

Specified by:

getPositionalBindings in interface GqlQueryOrBuilder

getPositionalBindingsOrBuilder

public GqlQueryParameterOrBuilder getPositionalBindingsOrBuilder(int index)

 Numbered binding site @1 references the first numbered parameter,
 effectively using 1-based indexing, rather than the usual 0.
 For each binding site numbered i in `query_string`, there must be an i-th
 numbered parameter. The inverse must also be true.
 

repeated .google.datastore.v1.GqlQueryParameter positional_bindings = 4;

Specified by:

getPositionalBindingsOrBuilder in interface GqlQueryOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static GqlQuery parseFrom(java.nio.ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GqlQuery parseFrom(java.nio.ByteBuffer data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GqlQuery parseFrom(com.google.protobuf.ByteString data)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GqlQuery parseFrom(com.google.protobuf.ByteString data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GqlQuery parseFrom(byte[] data)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GqlQuery parseFrom(byte[] data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GqlQuery parseFrom(java.io.InputStream input)
                          throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static GqlQuery parseFrom(java.io.InputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static GqlQuery parseDelimitedFrom(java.io.InputStream input)
                                   throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static GqlQuery parseDelimitedFrom(java.io.InputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static GqlQuery parseFrom(com.google.protobuf.CodedInputStream input)
                          throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static GqlQuery parseFrom(com.google.protobuf.CodedInputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public GqlQuery.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static GqlQuery.Builder newBuilder()

newBuilder

public static GqlQuery.Builder newBuilder(GqlQuery prototype)

toBuilder

public GqlQuery.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected GqlQuery.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static GqlQuery getDefaultInstance()

parser

public static com.google.protobuf.Parser<GqlQuery> parser()

getParserForType

public com.google.protobuf.Parser<GqlQuery> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public GqlQuery getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder