Class GqlQuery (2.20.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
Type Description
int

NAMED_BINDINGS_FIELD_NUMBER

public static final int NAMED_BINDINGS_FIELD_NUMBER
Field Value
Type Description
int

POSITIONAL_BINDINGS_FIELD_NUMBER

public static final int POSITIONAL_BINDINGS_FIELD_NUMBER
Field Value
Type Description
int

QUERY_STRING_FIELD_NUMBER

public static final int QUERY_STRING_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static GqlQuery getDefaultInstance()
Returns
Type Description
GqlQuery

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static GqlQuery.Builder newBuilder()
Returns
Type Description
GqlQuery.Builder

newBuilder(GqlQuery prototype)

public static GqlQuery.Builder newBuilder(GqlQuery prototype)
Parameter
Name Description
prototype GqlQuery
Returns
Type Description
GqlQuery.Builder

parseDelimitedFrom(InputStream input)

public static GqlQuery parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GqlQuery
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GqlQuery parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GqlQuery
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static GqlQuery parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
GqlQuery
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GqlQuery parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GqlQuery
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static GqlQuery parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
GqlQuery
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GqlQuery parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GqlQuery
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static GqlQuery parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
GqlQuery
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GqlQuery parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GqlQuery
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static GqlQuery parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GqlQuery
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GqlQuery parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GqlQuery
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static GqlQuery parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
GqlQuery
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GqlQuery parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GqlQuery
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<GqlQuery> parser()
Returns
Type Description
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
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
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
Type Description
boolean

The allowLiterals.

getDefaultInstanceForType()

public GqlQuery getDefaultInstanceForType()
Returns
Type Description
GqlQuery

getNamedBindings() (deprecated)

public Map<String,GqlQueryParameter> getNamedBindings()
Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
key String
defaultValue GqlQueryParameter
Returns
Type Description
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
Name Description
key String
Returns
Type Description
GqlQueryParameter

getParserForType()

public Parser<GqlQuery> getParserForType()
Returns
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
List<? extends com.google.datastore.v1.GqlQueryParameterOrBuilder>

getQueryString()

public String getQueryString()

A string of the format described here.

string query_string = 1;

Returns
Type Description
String

The queryString.

getQueryStringBytes()

public ByteString getQueryStringBytes()

A string of the format described here.

string query_string = 1;

Returns
Type Description
ByteString

The bytes for queryString.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public GqlQuery.Builder newBuilderForType()
Returns
Type Description
GqlQuery.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected GqlQuery.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
GqlQuery.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public GqlQuery.Builder toBuilder()
Returns
Type Description
GqlQuery.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException