public static final class GqlQuery.Builder extends GeneratedMessageV3.Builder<GqlQuery.Builder> implements GqlQueryOrBuilderA GQL query.
Protobuf type google.datastore.v1.GqlQuery
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > GqlQuery.BuilderImplements
GqlQueryOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllPositionalBindings(Iterable<? extends GqlQueryParameter> values)
public GqlQuery.Builder addAllPositionalBindings(Iterable<? extends GqlQueryParameter> values)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 |
values |
Iterable<? extends com.google.datastore.v1.GqlQueryParameter> |
| Returns | |
|---|---|
| Type | Description |
GqlQuery.Builder |
|
addPositionalBindings(GqlQueryParameter value)
public GqlQuery.Builder addPositionalBindings(GqlQueryParameter value)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 |
value |
GqlQueryParameter |
| Returns | |
|---|---|
| Type | Description |
GqlQuery.Builder |
|
addPositionalBindings(GqlQueryParameter.Builder builderForValue)
public GqlQuery.Builder addPositionalBindings(GqlQueryParameter.Builder builderForValue)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 |
builderForValue |
GqlQueryParameter.Builder |
| Returns | |
|---|---|
| Type | Description |
GqlQuery.Builder |
|
addPositionalBindings(int index, GqlQueryParameter value)
public GqlQuery.Builder addPositionalBindings(int index, GqlQueryParameter value)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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
GqlQueryParameter |
| Returns | |
|---|---|
| Type | Description |
GqlQuery.Builder |
|
addPositionalBindings(int index, GqlQueryParameter.Builder builderForValue)
public GqlQuery.Builder addPositionalBindings(int index, GqlQueryParameter.Builder builderForValue)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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
GqlQueryParameter.Builder |
| Returns | |
|---|---|
| Type | Description |
GqlQuery.Builder |
|
addPositionalBindingsBuilder()
public GqlQueryParameter.Builder addPositionalBindingsBuilder()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 |
GqlQueryParameter.Builder |
|
addPositionalBindingsBuilder(int index)
public GqlQueryParameter.Builder addPositionalBindingsBuilder(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.Builder |
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public GqlQuery.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
GqlQuery.Builder |
|
build()
public GqlQuery build()| Returns | |
|---|---|
| Type | Description |
GqlQuery |
|
buildPartial()
public GqlQuery buildPartial()| Returns | |
|---|---|
| Type | Description |
GqlQuery |
|
clear()
public GqlQuery.Builder clear()| Returns | |
|---|---|
| Type | Description |
GqlQuery.Builder |
|
clearAllowLiterals()
public GqlQuery.Builder clearAllowLiterals() 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 |
GqlQuery.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public GqlQuery.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
GqlQuery.Builder |
|
clearNamedBindings()
public GqlQuery.Builder clearNamedBindings()| Returns | |
|---|---|
| Type | Description |
GqlQuery.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public GqlQuery.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
GqlQuery.Builder |
|
clearPositionalBindings()
public GqlQuery.Builder clearPositionalBindings()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 |
GqlQuery.Builder |
|
clearQueryString()
public GqlQuery.Builder clearQueryString()A string of the format described here.
string query_string = 1;
| Returns | |
|---|---|
| Type | Description |
GqlQuery.Builder |
This builder for chaining. |
clone()
public GqlQuery.Builder clone()| Returns | |
|---|---|
| Type | Description |
GqlQuery.Builder |
|
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 |
|
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 |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getMutableNamedBindings() (deprecated)
public Map<String,GqlQueryParameter> getMutableNamedBindings()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,GqlQueryParameter> |
|
getNamedBindings() (deprecated)
public Map<String,GqlQueryParameter> getNamedBindings()Use #getNamedBindingsMap() instead.
| 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 |
|
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 |
|
getPositionalBindingsBuilder(int index)
public GqlQueryParameter.Builder getPositionalBindingsBuilder(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.Builder |
|
getPositionalBindingsBuilderList()
public List<GqlQueryParameter.Builder> getPositionalBindingsBuilderList()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<Builder> |
|
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(GqlQuery other)
public GqlQuery.Builder mergeFrom(GqlQuery other)| Parameter | |
|---|---|
| Name | Description |
other |
GqlQuery |
| Returns | |
|---|---|
| Type | Description |
GqlQuery.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public GqlQuery.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
GqlQuery.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public GqlQuery.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
GqlQuery.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final GqlQuery.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
GqlQuery.Builder |
|
putAllNamedBindings(Map<String,GqlQueryParameter> values)
public GqlQuery.Builder putAllNamedBindings(Map<String,GqlQueryParameter> values)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 |
values |
Map<String,GqlQueryParameter> |
| Returns | |
|---|---|
| Type | Description |
GqlQuery.Builder |
|
putNamedBindings(String key, GqlQueryParameter value)
public GqlQuery.Builder putNamedBindings(String key, GqlQueryParameter value)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 |
value |
GqlQueryParameter |
| Returns | |
|---|---|
| Type | Description |
GqlQuery.Builder |
|
putNamedBindingsBuilderIfAbsent(String key)
public GqlQueryParameter.Builder putNamedBindingsBuilderIfAbsent(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.Builder |
|
removeNamedBindings(String key)
public GqlQuery.Builder removeNamedBindings(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 |
GqlQuery.Builder |
|
removePositionalBindings(int index)
public GqlQuery.Builder removePositionalBindings(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 |
GqlQuery.Builder |
|
setAllowLiterals(boolean value)
public GqlQuery.Builder setAllowLiterals(boolean value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe allowLiterals to set. |
| Returns | |
|---|---|
| Type | Description |
GqlQuery.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public GqlQuery.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
GqlQuery.Builder |
|
setPositionalBindings(int index, GqlQueryParameter value)
public GqlQuery.Builder setPositionalBindings(int index, GqlQueryParameter value)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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
GqlQueryParameter |
| Returns | |
|---|---|
| Type | Description |
GqlQuery.Builder |
|
setPositionalBindings(int index, GqlQueryParameter.Builder builderForValue)
public GqlQuery.Builder setPositionalBindings(int index, GqlQueryParameter.Builder builderForValue)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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
GqlQueryParameter.Builder |
| Returns | |
|---|---|
| Type | Description |
GqlQuery.Builder |
|
setQueryString(String value)
public GqlQuery.Builder setQueryString(String value)A string of the format described here.
string query_string = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe queryString to set. |
| Returns | |
|---|---|
| Type | Description |
GqlQuery.Builder |
This builder for chaining. |
setQueryStringBytes(ByteString value)
public GqlQuery.Builder setQueryStringBytes(ByteString value)A string of the format described here.
string query_string = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for queryString to set. |
| Returns | |
|---|---|
| Type | Description |
GqlQuery.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public GqlQuery.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
GqlQuery.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final GqlQuery.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
GqlQuery.Builder |
|