# Class GqlQuery.Builder<V> (3.1.0)

3.1.0 (latest) 2.40.0 2.37.0 2.36.0 2.34.0 2.33.3 2.32.3 2.31.4 2.30.0 2.29.1 2.28.2 2.27.1 2.26.4 2.25.2 2.24.3 2.23.0 2.22.0 2.21.3 2.20.2 2.19.2 2.18.5 2.17.6

    public static final class GqlQuery.Builder<V>

A GQL query builder.

## Inheritance

[java.lang.Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html) \> GqlQuery.Builder\<V\>

## Inherited Members

[Object.clone()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--) [Object.equals(Object)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-) [Object.finalize()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--) [Object.getClass()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--) [Object.hashCode()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--) [Object.notify()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--) [Object.notifyAll()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--) [Object.toString()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--) [Object.wait()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--) [Object.wait(long)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-) [Object.wait(long,int)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-)

| ## Type Parameter ||
|---|---|
| **Name** | **Description** |
| `V` |   |

## Methods

### addBinding(boolean\[\] value)

    public GqlQuery.Builder<V> addBinding(boolean[] value)

Sets a new positional binding.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `value` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html[]` a boolean value or a list of boolean values to be set as a new positional binding |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.GqlQuery.Builder<V>` |   |

### addBinding(Timestamp\[\] value)

    public GqlQuery.Builder<V> addBinding(Timestamp[] value)

Sets a new positional binding.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `value` | `com.google.cloud.Timestamp[]` a Timestamp object or a list of Timestamp objects to be set as a new positional binding |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.GqlQuery.Builder<V>` |   |

### addBinding(Blob\[\] value)

    public GqlQuery.Builder<V> addBinding(Blob[] value)

Sets a new positional binding.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `value` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.Blob[]` a [Blob](https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.Blob) object or a list of [Blob](https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.Blob) objects to be set as a new positional binding |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.GqlQuery.Builder<V>` |   |

### addBinding(Cursor cursor)

    public GqlQuery.Builder<V> addBinding(Cursor cursor)

Sets a new positional binding.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `cursor` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.Cursor` a [Cursor](https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.Cursor) object to be set as a new positional binding |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.GqlQuery.Builder<V>` |   |

### addBinding(Key\[\] value)

    public GqlQuery.Builder<V> addBinding(Key[] value)

Sets a new positional binding.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `value` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.Key[]` a [Key](https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.Key) object or a list of [Key](https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.Key) objects to be set as a new positional binding |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.GqlQuery.Builder<V>` |   |

### addBinding(double\[\] value)

    public GqlQuery.Builder<V> addBinding(double[] value)

Sets a new positional binding.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `value` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html[]` a double value or a list of double values to be set as a new positional binding |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.GqlQuery.Builder<V>` |   |

### addBinding(String\[\] value)

    public GqlQuery.Builder<V> addBinding(String[] value)

Sets a new positional binding.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `value` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[]` a String object or a list of String objects to be set as a new positional binding |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.GqlQuery.Builder<V>` |   |

### addBinding(long\[\] value)

    public GqlQuery.Builder<V> addBinding(long[] value)

Sets a new positional binding.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `value` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html[]` a long value or a list of long values to be set as a new positional binding |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.GqlQuery.Builder<V>` |   |

### build()

    public GqlQuery<V> build()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.GqlQuery<V>` |   |

### clearBindings()

    public GqlQuery.Builder<V> clearBindings()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.GqlQuery.Builder<V>` |   |

### setAllowLiteral(boolean allowLiteral)

    public GqlQuery.Builder<V> setAllowLiteral(boolean allowLiteral)

Sets whether the query string can contain literals. When `false`, the query string must
not contain any literals and instead must bind all values.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `allowLiteral` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.GqlQuery.Builder<V>` |   |

### setBinding(String name, boolean\[\] value)

    public GqlQuery.Builder<V> setBinding(String name, boolean[] value)

Sets a new named binding.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `name` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` name of the binding |
| `value` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html[]` a boolean value or a list of boolean values that binds to a given name |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.GqlQuery.Builder<V>` |   |

### setBinding(String name, Timestamp\[\] value)

    public GqlQuery.Builder<V> setBinding(String name, Timestamp[] value)

Sets a new named binding.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `name` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` name of the binding |
| `value` | `com.google.cloud.Timestamp[]` a Timestamp object or a list of Timestamp objects that binds to a given name |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.GqlQuery.Builder<V>` |   |

### setBinding(String name, Blob\[\] value)

    public GqlQuery.Builder<V> setBinding(String name, Blob[] value)

Sets a new named binding.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `name` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` name of the binding |
| `value` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.Blob[]` a [Blob](https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.Blob) object or list of [Blob](https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.Blob) objects that binds to a given name |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.GqlQuery.Builder<V>` |   |

### setBinding(String name, Cursor cursor)

    public GqlQuery.Builder<V> setBinding(String name, Cursor cursor)

Sets a new named binding.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `name` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` name of the binding |
| `cursor` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.Cursor` a [Cursor](https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.Cursor) object that binds to a given name |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.GqlQuery.Builder<V>` |   |

### setBinding(String name, Key\[\] value)

    public GqlQuery.Builder<V> setBinding(String name, Key[] value)

Sets a new named binding.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `name` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` name of the binding |
| `value` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.Key[]` a [Key](https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.Key) object or a list of [Key](https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.Key) objects that binds to a given name |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.GqlQuery.Builder<V>` |   |

### setBinding(String name, double\[\] value)

    public GqlQuery.Builder<V> setBinding(String name, double[] value)

Sets a new named binding.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `name` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` name of the binding |
| `value` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html[]` a double value or a list of double values that binds to a given name |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.GqlQuery.Builder<V>` |   |

### setBinding(String name, String\[\] value)

    public GqlQuery.Builder<V> setBinding(String name, String[] value)

Sets a new named binding.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `name` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` name of the binding |
| `value` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[]` a String object or a list of String objects that binds to a given name |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.GqlQuery.Builder<V>` |   |

### setBinding(String name, long\[\] value)

    public GqlQuery.Builder<V> setBinding(String name, long[] value)

Sets a new named binding.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `name` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` name of the binding |
| `value` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html[]` a long value or a list of long values that binds to a given name |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.GqlQuery.Builder<V>` |   |

### setNamespace(String namespace)

    public GqlQuery.Builder<V> setNamespace(String namespace)

Sets the namespace for the GQL query.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `namespace` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.GqlQuery.Builder<V>` |   |

### setNullBinding(String name)

    public GqlQuery.Builder<V> setNullBinding(String name)

Sets a new named binding with null value.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `name` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` of the binding |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.GqlQuery.Builder<V>` |   |

### setQuery(String query)

    public GqlQuery.Builder<V> setQuery(String query)

Sets the GQL query.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `query` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-datastore/latest/com.google.cloud.datastore.GqlQuery.Builder<V>` |   |