public final class GqlQuery extends com.google.protobuf.GeneratedMessageV3 implements GqlQueryOrBuilder
A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).Protobuf type
google.datastore.v1.GqlQuery
Modifier and Type | Class and Description |
---|---|
static class |
GqlQuery.Builder
A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
Modifier and Type | Field and Description |
---|---|
static int |
ALLOW_LITERALS_FIELD_NUMBER |
static int |
NAMED_BINDINGS_FIELD_NUMBER |
static int |
POSITIONAL_BINDINGS_FIELD_NUMBER |
static int |
QUERY_STRING_FIELD_NUMBER |
Modifier and Type | Method and Description |
---|---|
boolean |
containsNamedBindings(java.lang.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.
|
boolean |
equals(java.lang.Object obj) |
boolean |
getAllowLiterals()
When false, the query string must not contain any literals and instead must
bind all values.
|
static GqlQuery |
getDefaultInstance() |
GqlQuery |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
java.util.Map<java.lang.String,GqlQueryParameter> |
getNamedBindings()
Deprecated.
|
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.
|
java.util.Map<java.lang.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.
|
GqlQueryParameter |
getNamedBindingsOrDefault(java.lang.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.
|
GqlQueryParameter |
getNamedBindingsOrThrow(java.lang.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.
|
com.google.protobuf.Parser<GqlQuery> |
getParserForType() |
GqlQueryParameter |
getPositionalBindings(int index)
Numbered binding site @1 references the first numbered parameter,
effectively using 1-based indexing, rather than the usual 0.
|
int |
getPositionalBindingsCount()
Numbered binding site @1 references the first numbered parameter,
effectively using 1-based indexing, rather than the usual 0.
|
java.util.List<GqlQueryParameter> |
getPositionalBindingsList()
Numbered binding site @1 references the first numbered parameter,
effectively using 1-based indexing, rather than the usual 0.
|
GqlQueryParameterOrBuilder |
getPositionalBindingsOrBuilder(int index)
Numbered binding site @1 references the first numbered parameter,
effectively using 1-based indexing, rather than the usual 0.
|
java.util.List<? extends GqlQueryParameterOrBuilder> |
getPositionalBindingsOrBuilderList()
Numbered binding site @1 references the first numbered parameter,
effectively using 1-based indexing, rather than the usual 0.
|
java.lang.String |
getQueryString()
A string of the format described
[here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
|
com.google.protobuf.ByteString |
getQueryStringBytes()
A string of the format described
[here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
|
int |
getSerializedSize() |
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
int |
hashCode() |
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapField |
internalGetMapField(int number) |
boolean |
isInitialized() |
static GqlQuery.Builder |
newBuilder() |
static GqlQuery.Builder |
newBuilder(GqlQuery prototype) |
GqlQuery.Builder |
newBuilderForType() |
protected GqlQuery.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
static GqlQuery |
parseDelimitedFrom(java.io.InputStream input) |
static GqlQuery |
parseDelimitedFrom(java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static GqlQuery |
parseFrom(byte[] data) |
static GqlQuery |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static GqlQuery |
parseFrom(java.nio.ByteBuffer data) |
static GqlQuery |
parseFrom(java.nio.ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static GqlQuery |
parseFrom(com.google.protobuf.ByteString data) |
static GqlQuery |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static GqlQuery |
parseFrom(com.google.protobuf.CodedInputStream input) |
static GqlQuery |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static GqlQuery |
parseFrom(java.io.InputStream input) |
static GqlQuery |
parseFrom(java.io.InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<GqlQuery> |
parser() |
GqlQuery.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, makeExtensionsImmutable, newBuilderForType, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
public static final int QUERY_STRING_FIELD_NUMBER
public static final int ALLOW_LITERALS_FIELD_NUMBER
public static final int NAMED_BINDINGS_FIELD_NUMBER
public static final int POSITIONAL_BINDINGS_FIELD_NUMBER
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields
in interface com.google.protobuf.MessageOrBuilder
getUnknownFields
in class com.google.protobuf.GeneratedMessageV3
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapField internalGetMapField(int number)
internalGetMapField
in class com.google.protobuf.GeneratedMessageV3
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class com.google.protobuf.GeneratedMessageV3
public java.lang.String getQueryString()
A string of the format described [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
string query_string = 1;
getQueryString
in interface GqlQueryOrBuilder
public com.google.protobuf.ByteString getQueryStringBytes()
A string of the format described [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
string query_string = 1;
getQueryStringBytes
in interface GqlQueryOrBuilder
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;
getAllowLiterals
in interface GqlQueryOrBuilder
public int getNamedBindingsCount()
GqlQueryOrBuilder
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_$][A-Za-z_$0-9]*`, must not match regex `__.*__`, and must not be `""`.
map<string, .google.datastore.v1.GqlQueryParameter> named_bindings = 5;
getNamedBindingsCount
in interface GqlQueryOrBuilder
public boolean containsNamedBindings(java.lang.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_$][A-Za-z_$0-9]*`, must not match regex `__.*__`, and must not be `""`.
map<string, .google.datastore.v1.GqlQueryParameter> named_bindings = 5;
containsNamedBindings
in interface GqlQueryOrBuilder
@Deprecated public java.util.Map<java.lang.String,GqlQueryParameter> getNamedBindings()
getNamedBindingsMap()
instead.getNamedBindings
in interface GqlQueryOrBuilder
public java.util.Map<java.lang.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_$][A-Za-z_$0-9]*`, must not match regex `__.*__`, and must not be `""`.
map<string, .google.datastore.v1.GqlQueryParameter> named_bindings = 5;
getNamedBindingsMap
in interface GqlQueryOrBuilder
public GqlQueryParameter getNamedBindingsOrDefault(java.lang.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_$][A-Za-z_$0-9]*`, must not match regex `__.*__`, and must not be `""`.
map<string, .google.datastore.v1.GqlQueryParameter> named_bindings = 5;
getNamedBindingsOrDefault
in interface GqlQueryOrBuilder
public GqlQueryParameter getNamedBindingsOrThrow(java.lang.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_$][A-Za-z_$0-9]*`, must not match regex `__.*__`, and must not be `""`.
map<string, .google.datastore.v1.GqlQueryParameter> named_bindings = 5;
getNamedBindingsOrThrow
in interface GqlQueryOrBuilder
public java.util.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;
getPositionalBindingsList
in interface GqlQueryOrBuilder
public java.util.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;
getPositionalBindingsOrBuilderList
in interface GqlQueryOrBuilder
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;
getPositionalBindingsCount
in interface GqlQueryOrBuilder
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;
getPositionalBindings
in interface GqlQueryOrBuilder
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;
getPositionalBindingsOrBuilder
in interface GqlQueryOrBuilder
public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
in class com.google.protobuf.GeneratedMessageV3
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException
writeTo
in interface com.google.protobuf.MessageLite
writeTo
in class com.google.protobuf.GeneratedMessageV3
java.io.IOException
public int getSerializedSize()
getSerializedSize
in interface com.google.protobuf.MessageLite
getSerializedSize
in class com.google.protobuf.GeneratedMessageV3
public boolean equals(java.lang.Object obj)
equals
in interface com.google.protobuf.Message
equals
in class com.google.protobuf.AbstractMessage
public int hashCode()
hashCode
in interface com.google.protobuf.Message
hashCode
in class com.google.protobuf.AbstractMessage
public static GqlQuery parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static GqlQuery parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static GqlQuery parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static GqlQuery parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static GqlQuery parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static GqlQuery parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static GqlQuery parseFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOException
public static GqlQuery parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static GqlQuery parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
java.io.IOException
public static GqlQuery parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public static GqlQuery parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
java.io.IOException
public static GqlQuery parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
java.io.IOException
public GqlQuery.Builder newBuilderForType()
newBuilderForType
in interface com.google.protobuf.Message
newBuilderForType
in interface com.google.protobuf.MessageLite
public static GqlQuery.Builder newBuilder()
public static GqlQuery.Builder newBuilder(GqlQuery prototype)
public GqlQuery.Builder toBuilder()
toBuilder
in interface com.google.protobuf.Message
toBuilder
in interface com.google.protobuf.MessageLite
protected GqlQuery.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class com.google.protobuf.GeneratedMessageV3
public static GqlQuery getDefaultInstance()
public static com.google.protobuf.Parser<GqlQuery> parser()
public com.google.protobuf.Parser<GqlQuery> getParserForType()
getParserForType
in interface com.google.protobuf.Message
getParserForType
in interface com.google.protobuf.MessageLite
getParserForType
in class com.google.protobuf.GeneratedMessageV3
public GqlQuery getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder