Class GqlQuery (2.28.2)

publicfinalclass GqlQueryextendsGeneratedMessageV3implementsGqlQueryOrBuilder

A GQL query.

Protobuf type google.datastore.v1.GqlQuery

Implements

GqlQueryOrBuilder

Inherited Members

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

Static Fields

ALLOW_LITERALS_FIELD_NUMBER

publicstaticfinalintALLOW_LITERALS_FIELD_NUMBER
Field Value
Type Description
int

NAMED_BINDINGS_FIELD_NUMBER

publicstaticfinalintNAMED_BINDINGS_FIELD_NUMBER
Field Value
Type Description
int

POSITIONAL_BINDINGS_FIELD_NUMBER

publicstaticfinalintPOSITIONAL_BINDINGS_FIELD_NUMBER
Field Value
Type Description
int

QUERY_STRING_FIELD_NUMBER

publicstaticfinalintQUERY_STRING_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticGqlQuerygetDefaultInstance()
Returns
Type Description
GqlQuery

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

newBuilder()

publicstaticGqlQuery.BuildernewBuilder()
Returns
Type Description
GqlQuery.Builder

newBuilder(GqlQuery prototype)

publicstaticGqlQuery.BuildernewBuilder(GqlQueryprototype)
Parameter
Name Description
prototype GqlQuery
Returns
Type Description
GqlQuery.Builder

parseDelimitedFrom(InputStream input)

publicstaticGqlQueryparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
GqlQuery
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticGqlQueryparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GqlQuery
Exceptions
Type Description
IOException

parseFrom(byte[] data)

publicstaticGqlQueryparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
GqlQuery
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticGqlQueryparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GqlQuery
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticGqlQueryparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
GqlQuery
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticGqlQueryparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GqlQuery
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticGqlQueryparseFrom(CodedInputStreaminput)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
GqlQuery
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticGqlQueryparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GqlQuery
Exceptions
Type Description
IOException

parseFrom(InputStream input)

publicstaticGqlQueryparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
GqlQuery
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticGqlQueryparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GqlQuery
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

publicstaticGqlQueryparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
GqlQuery
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticGqlQueryparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GqlQuery
Exceptions
Type Description
InvalidProtocolBufferException

parser()

publicstaticParser<GqlQuery>parser()
Returns
Type Description
Parser<GqlQuery>

Methods

containsNamedBindings(String key)

publicbooleancontainsNamedBindings(Stringkey)

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_$, must not match regex __.__, and must not be "".

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

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAllowLiterals()

publicbooleangetAllowLiterals()

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;

Returns
Type Description
boolean

The allowLiterals.

getDefaultInstanceForType()

publicGqlQuerygetDefaultInstanceForType()
Returns
Type Description
GqlQuery

getNamedBindings() (deprecated)

publicMap<String,GqlQueryParameter>getNamedBindings()
Returns
Type Description
Map<String,GqlQueryParameter>

getNamedBindingsCount()

publicintgetNamedBindingsCount()

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_$, must not match regex __.__, and must not be "".

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

Returns
Type Description
int

getNamedBindingsMap()

publicMap<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_$, must not match regex __.__, and must not be "".

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

Returns
Type Description
Map<String,GqlQueryParameter>

getNamedBindingsOrDefault(String key, GqlQueryParameter defaultValue)

publicGqlQueryParametergetNamedBindingsOrDefault(Stringkey,GqlQueryParameterdefaultValue)

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_$, must not match regex __.__, and must not be "".

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

Parameters
Name Description
key String
defaultValue GqlQueryParameter
Returns
Type Description
GqlQueryParameter

getNamedBindingsOrThrow(String key)

publicGqlQueryParametergetNamedBindingsOrThrow(Stringkey)

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_$, must not match regex __.__, and must not be "".

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

Parameter
Name Description
key String
Returns
Type Description
GqlQueryParameter

getParserForType()

publicParser<GqlQuery>getParserForType()
Returns
Type Description
Parser<GqlQuery>
Overrides

getPositionalBindings(int index)

publicGqlQueryParametergetPositionalBindings(intindex)

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;

Parameter
Name Description
index int
Returns
Type Description
GqlQueryParameter

getPositionalBindingsCount()

publicintgetPositionalBindingsCount()

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;

Returns
Type Description
int

getPositionalBindingsList()

publicList<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;

Returns
Type Description
List<GqlQueryParameter>

getPositionalBindingsOrBuilder(int index)

publicGqlQueryParameterOrBuildergetPositionalBindingsOrBuilder(intindex)

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;

Parameter
Name Description
index int
Returns
Type Description
GqlQueryParameterOrBuilder

getPositionalBindingsOrBuilderList()

publicList<?extendsGqlQueryParameterOrBuilder>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;

Returns
Type Description
List<? extends com.google.datastore.v1.GqlQueryParameterOrBuilder>

getQueryString()

publicStringgetQueryString()

A string of the format described here.

string query_string = 1;

Returns
Type Description
String

The queryString.

getQueryStringBytes()

publicByteStringgetQueryStringBytes()

A string of the format described here.

string query_string = 1;

Returns
Type Description
ByteString

The bytes for queryString.

getSerializedSize()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protectedMapFieldReflectionAccessorinternalGetMapFieldReflection(intnumber)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

publicGqlQuery.BuildernewBuilderForType()
Returns
Type Description
GqlQuery.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedGqlQuery.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
GqlQuery.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

publicGqlQuery.BuildertoBuilder()
Returns
Type Description
GqlQuery.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月19日 UTC.