Class GqlQuery (2.19.0)

public final class GqlQuery extends GeneratedMessageV3 implements GqlQueryOrBuilder

A GQL query.

Protobuf type google.datastore.v1.GqlQuery

Implements

GqlQueryOrBuilder

Static Fields

ALLOW_LITERALS_FIELD_NUMBER

public static final int ALLOW_LITERALS_FIELD_NUMBER
Field Value
TypeDescription
int

NAMED_BINDINGS_FIELD_NUMBER

public static final int NAMED_BINDINGS_FIELD_NUMBER
Field Value
TypeDescription
int

POSITIONAL_BINDINGS_FIELD_NUMBER

public static final int POSITIONAL_BINDINGS_FIELD_NUMBER
Field Value
TypeDescription
int

QUERY_STRING_FIELD_NUMBER

public static final int QUERY_STRING_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static GqlQuery getDefaultInstance()
Returns
TypeDescription
GqlQuery

getDescriptor()

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

newBuilder()

public static GqlQuery.Builder newBuilder()
Returns
TypeDescription
GqlQuery.Builder

newBuilder(GqlQuery prototype)

public static GqlQuery.Builder newBuilder(GqlQuery prototype)
Parameter
NameDescription
prototypeGqlQuery
Returns
TypeDescription
GqlQuery.Builder

parseDelimitedFrom(InputStream input)

public static GqlQuery parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
GqlQuery
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GqlQuery parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GqlQuery
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static GqlQuery parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
GqlQuery
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GqlQuery parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GqlQuery
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static GqlQuery parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
GqlQuery
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GqlQuery parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GqlQuery
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static GqlQuery parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
GqlQuery
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GqlQuery parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GqlQuery
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static GqlQuery parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
GqlQuery
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GqlQuery parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GqlQuery
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static GqlQuery parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
GqlQuery
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GqlQuery parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GqlQuery
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<GqlQuery> parser()
Returns
TypeDescription
Parser<GqlQuery>

Methods

containsNamedBindings(String key)

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

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

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

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;

Returns
TypeDescription
boolean

The allowLiterals.

getDefaultInstanceForType()

public GqlQuery getDefaultInstanceForType()
Returns
TypeDescription
GqlQuery

getNamedBindings()

public Map<String,GqlQueryParameter> getNamedBindings()
Returns
TypeDescription
Map<String,GqlQueryParameter>

getNamedBindingsCount()

public 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.

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
TypeDescription
int

getNamedBindingsMap()

public Map<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
TypeDescription
Map<String,GqlQueryParameter>

getNamedBindingsOrDefault(String key, GqlQueryParameter defaultValue)

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

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

Parameters
NameDescription
keyString
defaultValueGqlQueryParameter
Returns
TypeDescription
GqlQueryParameter

getNamedBindingsOrThrow(String key)

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

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

Parameter
NameDescription
keyString
Returns
TypeDescription
GqlQueryParameter

getParserForType()

public Parser<GqlQuery> getParserForType()
Returns
TypeDescription
Parser<GqlQuery>
Overrides

getPositionalBindings(int index)

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;

Parameter
NameDescription
indexint
Returns
TypeDescription
GqlQueryParameter

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;

Returns
TypeDescription
int

getPositionalBindingsList()

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

Returns
TypeDescription
List<GqlQueryParameter>

getPositionalBindingsOrBuilder(int index)

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;

Parameter
NameDescription
indexint
Returns
TypeDescription
GqlQueryParameterOrBuilder

getPositionalBindingsOrBuilderList()

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

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

getQueryString()

public String getQueryString()

A string of the format described here.

string query_string = 1;

Returns
TypeDescription
String

The queryString.

getQueryStringBytes()

public ByteString getQueryStringBytes()

A string of the format described here.

string query_string = 1;

Returns
TypeDescription
ByteString

The bytes for queryString.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public GqlQuery.Builder newBuilderForType()
Returns
TypeDescription
GqlQuery.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected GqlQuery.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
GqlQuery.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public GqlQuery.Builder toBuilder()
Returns
TypeDescription
GqlQuery.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException