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 |
|---|
| 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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static GqlQuery.Builder newBuilder()
newBuilder(GqlQuery prototype)
public static GqlQuery.Builder newBuilder(GqlQuery prototype)
| Parameter |
|---|
| Name | Description |
prototype | GqlQuery
|
public static GqlQuery parseDelimitedFrom(InputStream input)
public static GqlQuery parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static GqlQuery parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static GqlQuery parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static GqlQuery parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static GqlQuery parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static GqlQuery parseFrom(CodedInputStream input)
public static GqlQuery parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static GqlQuery parseFrom(InputStream input)
public static GqlQuery parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static GqlQuery parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static GqlQuery parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<GqlQuery> parser()
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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
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()
getNamedBindings()
public Map<String,GqlQueryParameter> getNamedBindings()
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;
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;
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
|
getParserForType()
public Parser<GqlQuery> getParserForType()
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
|
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;
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
|
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
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public GqlQuery.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected GqlQuery.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public GqlQuery.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
