GqlQuery.Builder (proto-google-cloud-datastore-v1 0.6.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<GqlQuery.Builder>
    - - com.google.datastore.v1.GqlQuery.Builder

All Implemented Interfaces:

GqlQueryOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable

Enclosing class:

GqlQuery
```
public static final class GqlQuery.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<GqlQuery.Builder>
implements GqlQueryOrBuilder
```
```
 A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
 
```
Protobuf type google.datastore.v1.GqlQuery

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`GqlQuery.Builder`	`addAllPositionalBindings(java.lang.Iterable<? extends GqlQueryParameter> values)` Numbered binding site @1 references the first numbered parameter, effectively using 1-based indexing, rather than the usual 0.
`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.
`GqlQuery.Builder`	`addPositionalBindings(GqlQueryParameter value)` Numbered binding site @1 references the first numbered parameter, effectively using 1-based indexing, rather than the usual 0.
`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.
`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.
`GqlQueryParameter.Builder`	`addPositionalBindingsBuilder()` Numbered binding site @1 references the first numbered parameter, effectively using 1-based indexing, rather than the usual 0.
`GqlQueryParameter.Builder`	`addPositionalBindingsBuilder(int index)` Numbered binding site @1 references the first numbered parameter, effectively using 1-based indexing, rather than the usual 0.
`GqlQuery.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)`
`GqlQuery`	`build()`
`GqlQuery`	`buildPartial()`
`GqlQuery.Builder`	`clear()`
`GqlQuery.Builder`	`clearAllowLiterals()` When false, the query string must not contain any literals and instead must bind all values.
`GqlQuery.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`GqlQuery.Builder`	`clearNamedBindings()`
`GqlQuery.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`GqlQuery.Builder`	`clearPositionalBindings()` Numbered binding site @1 references the first numbered parameter, effectively using 1-based indexing, rather than the usual 0.
`GqlQuery.Builder`	`clearQueryString()` A string of the format described [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
`GqlQuery.Builder`	`clone()`
`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`	`getAllowLiterals()` When false, the query string must not contain any literals and instead must bind all values.
`GqlQuery`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`java.util.Map<java.lang.String,GqlQueryParameter>`	`getMutableNamedBindings()` Deprecated.
`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.
`GqlQueryParameter`	`getPositionalBindings(int index)` Numbered binding site @1 references the first numbered parameter, effectively using 1-based indexing, rather than the usual 0.
`GqlQueryParameter.Builder`	`getPositionalBindingsBuilder(int index)` Numbered binding site @1 references the first numbered parameter, effectively using 1-based indexing, rather than the usual 0.
`java.util.List<GqlQueryParameter.Builder>`	`getPositionalBindingsBuilderList()` 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).
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapField`	`internalGetMapField(int number)`
`protected com.google.protobuf.MapField`	`internalGetMutableMapField(int number)`
`boolean`	`isInitialized()`
`GqlQuery.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`GqlQuery.Builder`	`mergeFrom(GqlQuery other)`
`GqlQuery.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`GqlQuery.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`GqlQuery.Builder`	`putAllNamedBindings(java.util.Map<java.lang.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.
`GqlQuery.Builder`	`putNamedBindings(java.lang.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.
`GqlQuery.Builder`	`removeNamedBindings(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.
`GqlQuery.Builder`	`removePositionalBindings(int index)` Numbered binding site @1 references the first numbered parameter, effectively using 1-based indexing, rather than the usual 0.
`GqlQuery.Builder`	`setAllowLiterals(boolean value)` When false, the query string must not contain any literals and instead must bind all values.
`GqlQuery.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)`
`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.
`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.
`GqlQuery.Builder`	`setQueryString(java.lang.String value)` A string of the format described [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
`GqlQuery.Builder`	`setQueryStringBytes(com.google.protobuf.ByteString value)` A string of the format described [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
`GqlQuery.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)`
`GqlQuery.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField
```
protected com.google.protobuf.MapField internalGetMapField(int number)
```
Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<GqlQuery.Builder>

internalGetMutableMapField
```
protected com.google.protobuf.MapField internalGetMutableMapField(int number)
```
Overrides:

internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<GqlQuery.Builder>

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<GqlQuery.Builder>

clear
```
public GqlQuery.Builder clear()
```
Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<GqlQuery.Builder>

getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<GqlQuery.Builder>

getDefaultInstanceForType
```
public GqlQuery getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public GqlQuery build()
```
Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial
```
public GqlQuery buildPartial()
```
Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone
```
public GqlQuery.Builder clone()
```
Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<GqlQuery.Builder>

setField
```
public GqlQuery.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                 java.lang.Object value)
```
Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<GqlQuery.Builder>

clearField
```
public GqlQuery.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<GqlQuery.Builder>

clearOneof
```
public GqlQuery.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<GqlQuery.Builder>

setRepeatedField

public GqlQuery.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         int index,
                                         java.lang.Object value)

Specified by:: setRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GqlQuery.Builder>

addRepeatedField
```
public GqlQuery.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         java.lang.Object value)
```
Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GqlQuery.Builder>

mergeFrom
```
public GqlQuery.Builder mergeFrom(com.google.protobuf.Message other)
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GqlQuery.Builder>

mergeFrom

public GqlQuery.Builder mergeFrom(GqlQuery other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<GqlQuery.Builder>

mergeFrom
```
public GqlQuery.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws java.io.IOException
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GqlQuery.Builder>

Throws:

java.io.IOException

getQueryString

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;

Specified by:: getQueryString in interface GqlQueryOrBuilder

getQueryStringBytes

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;

Specified by:: getQueryStringBytes in interface GqlQueryOrBuilder

setQueryString

public GqlQuery.Builder setQueryString(java.lang.String value)

 A string of the format described
 [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).

string query_string = 1;

clearQueryString

public GqlQuery.Builder clearQueryString()

 A string of the format described
 [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).

string query_string = 1;

setQueryStringBytes

public GqlQuery.Builder setQueryStringBytes(com.google.protobuf.ByteString value)

 A string of the format described
 [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).

string query_string = 1;

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;

Specified by:: getAllowLiterals in interface GqlQueryOrBuilder

setAllowLiterals

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;

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;

getNamedBindingsCount

public int getNamedBindingsCount()

Description copied from interface: 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;

Specified by:: getNamedBindingsCount in interface GqlQueryOrBuilder

containsNamedBindings

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;

Specified by:: containsNamedBindings in interface GqlQueryOrBuilder

getNamedBindings
```
@Deprecated
public java.util.Map<java.lang.String,GqlQueryParameter> getNamedBindings()
```
Deprecated.

Use getNamedBindingsMap() instead.

Specified by:

getNamedBindings in interface GqlQueryOrBuilder

getNamedBindingsMap

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;

Specified by:: getNamedBindingsMap in interface GqlQueryOrBuilder

getNamedBindingsOrDefault

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;

Specified by:: getNamedBindingsOrDefault in interface GqlQueryOrBuilder

getNamedBindingsOrThrow

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;

Specified by:: getNamedBindingsOrThrow in interface GqlQueryOrBuilder

clearNamedBindings

public GqlQuery.Builder clearNamedBindings()

removeNamedBindings

public GqlQuery.Builder removeNamedBindings(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;

getMutableNamedBindings

@Deprecated
public java.util.Map<java.lang.String,GqlQueryParameter> getMutableNamedBindings()

Deprecated.

Use alternate mutation accessors instead.

putNamedBindings

public GqlQuery.Builder putNamedBindings(java.lang.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_$][A-Za-z_$0-9]*`, must not match regex
 `__.*__`, and must not be `""`.

map<string, .google.datastore.v1.GqlQueryParameter> named_bindings = 5;

putAllNamedBindings

public GqlQuery.Builder putAllNamedBindings(java.util.Map<java.lang.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_$][A-Za-z_$0-9]*`, must not match regex
 `__.*__`, and must not be `""`.

map<string, .google.datastore.v1.GqlQueryParameter> named_bindings = 5;