# Class Field.Builder (5.0.3)

    public static final class Field.Builder

A field builder. Fields must have a name, and optionally a locale
and at most one of text, html, atom or date.

## Inheritance

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

## 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-)

## Methods

### build()

    public Field build()

Builds a field using this builder. The field must have a
valid name, string value, type.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.Field` | a [Field](https://docs.cloud.google.com/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.Field) built by this builder |

### setAtom(String atom)

    public Field.Builder setAtom(String atom)

Sets an atomic value, indivisible text, for the field.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `atom` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` the indivisible text of the field |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.Field.Builder` | this builder |

### setDate(Date date)

    public Field.Builder setDate(Date date)

Sets a date associated with the field.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `date` | `https://docs.oracle.com/javase/8/docs/api/java/util/Date.html` the date of the field |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.Field.Builder` | this builder |

### setGeoPoint(GeoPoint geoPoint)

    public Field.Builder setGeoPoint(GeoPoint geoPoint)

Sets a [GeoPoint](https://docs.cloud.google.com/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.GeoPoint) value for the field.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `geoPoint` | `https://docs.cloud.google.com/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.GeoPoint` the [GeoPoint](https://docs.cloud.google.com/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.GeoPoint) value of the field |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.Field.Builder` | this builder |

### setHTML(String html)

    public Field.Builder setHTML(String html)

Sets a HTML value for the field.

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.Field.Builder` | this builder |

### setLocale(Locale locale)

    public Field.Builder setLocale(Locale locale)

Sets the Locale of the field value. If none is given, then the locale
of the document will be used.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `locale` | `https://docs.oracle.com/javase/8/docs/api/java/util/Locale.html` the locale the field value is written in |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.Field.Builder` | this builder |

### setName(String name)

    public Field.Builder setName(String name)

Sets a name for the field. The field name length must be
between 1 and FieldChecker#MAXIMUM_NAME_LENGTH and it should match
[com.google.appengine.api.search.checkers.SearchApiLimits#FIELD_NAME_PATTERN](https://docs.cloud.google.com/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.checkers.SearchApiLimits#com_google_appengine_api_search_checkers_SearchApiLimits_FIELD_NAME_PATTERN).

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.Field.Builder` | this builder |

### setNumber(double number)

    public Field.Builder setNumber(double number)

Sets a numeric value for the field. The `number` must be between
[com.google.appengine.api.search.checkers.SearchApiLimits#MINIMUM_NUMBER_VALUE](https://docs.cloud.google.com/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.checkers.SearchApiLimits#com_google_appengine_api_search_checkers_SearchApiLimits_MINIMUM_NUMBER_VALUE) and
[com.google.appengine.api.search.checkers.SearchApiLimits#MAXIMUM_NUMBER_VALUE](https://docs.cloud.google.com/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.checkers.SearchApiLimits#com_google_appengine_api_search_checkers_SearchApiLimits_MAXIMUM_NUMBER_VALUE).

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `number` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` the numeric value of the field |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.Field.Builder` | this builder |

### setText(String text)

    public Field.Builder setText(String text)

Sets a text value for the field.

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.Field.Builder` | this builder |

### setTokenizedPrefix(String tokenizedPrefix)

    public Field.Builder setTokenizedPrefix(String tokenizedPrefix)

Sets a tokenized prefix value for the field.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `tokenizedPrefix` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` the string value of the field |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.Field.Builder` | this builder |

### setUntokenizedPrefix(String untokenizedPrefix)

    public Field.Builder setUntokenizedPrefix(String untokenizedPrefix)

Sets an untokenized prefix value for the field.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `untokenizedPrefix` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` the string value of the field |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.Field.Builder` | this builder |

### setVector(List\<Double\> vector)

    public Field.Builder setVector(List<Double> vector)

Sets a vector value for the field.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `vector` | `https://docs.oracle.com/javase/8/docs/api/java/util/List.html<https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html>` a list of Double values forming a vector field value |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.Field.Builder` | this builder |