public final class GqlQuery extends GeneratedMessageV3 implements GqlQueryOrBuilder
A GQL
query.
Protobuf type google.datastore.v1.GqlQuery
Static Fields
ALLOW_LITERALS_FIELD_NUMBER
public static final int ALLOW_LITERALS_FIELD_NUMBER
Field Value
NAMED_BINDINGS_FIELD_NUMBER
public static final int NAMED_BINDINGS_FIELD_NUMBER
Field Value
POSITIONAL_BINDINGS_FIELD_NUMBER
public static final int POSITIONAL_BINDINGS_FIELD_NUMBER
Field Value
QUERY_STRING_FIELD_NUMBER
public static final int QUERY_STRING_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static GqlQuery getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static GqlQuery.Builder newBuilder()
Returns
newBuilder(GqlQuery prototype)
public static GqlQuery.Builder newBuilder(GqlQuery prototype)
Parameter
Returns
public static GqlQuery parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static GqlQuery parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static GqlQuery parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static GqlQuery parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static GqlQuery parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static GqlQuery parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static GqlQuery parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static GqlQuery parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static GqlQuery parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static GqlQuery parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static GqlQuery parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static GqlQuery parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<GqlQuery> parser()
Returns
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
Returns
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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
getNamedBindings()
public Map<String,GqlQueryParameter> getNamedBindings()
Returns
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
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
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
Returns
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
Returns
getParserForType()
public Parser<GqlQuery> getParserForType()
Returns
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
Returns
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
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
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
Returns
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
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public GqlQuery.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected GqlQuery.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public GqlQuery.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions