Interface GqlQueryOrBuilder (2.19.0)

Version latest

• 2.19.0 (latest)
• 2.18.5
• 2.17.6

public interface GqlQueryOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsNamedBindings(String key)

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

getAllowLiterals()

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

getNamedBindings()

public abstract Map<String,GqlQueryParameter> getNamedBindings()

Use #getNamedBindingsMap() instead.

Returns
Type	Description
Map<String,GqlQueryParameter>

getNamedBindingsCount()

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

getPositionalBindings(int index)

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract String getQueryString()

A string of the format described here.

string query_string = 1;

Returns
Type	Description
String	The queryString.

getQueryStringBytes()

public abstract ByteString getQueryStringBytes()

A string of the format described here.

string query_string = 1;

Returns
Type	Description
ByteString	The bytes for queryString.