# Class ScoredDocument.Builder (5.0.3)

    public static final class ScoredDocument.Builder extends Document.Builder

A builder of scored documents. This is not thread-safe.

## Inheritance

[java.lang.Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html) \> [Document.Builder](https://docs.cloud.google.com/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.Document.Builder) \> ScoredDocument.Builder

## Inherited Members

[Document.Builder.addFacet(Facet)](https://docs.cloud.google.com/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.Document.Builder#com_google_appengine_api_search_Document_Builder_addFacet_com_google_appengine_api_search_Facet_) [Document.Builder.addField(Field)](https://docs.cloud.google.com/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.Document.Builder#com_google_appengine_api_search_Document_Builder_addField_com_google_appengine_api_search_Field_) [Document.Builder.addField(Field.Builder)](https://docs.cloud.google.com/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.Document.Builder#com_google_appengine_api_search_Document_Builder_addField_com_google_appengine_api_search_Field_Builder_) [Document.Builder.build()](https://docs.cloud.google.com/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.Document.Builder#com_google_appengine_api_search_Document_Builder_build__) [Document.Builder.setId(String)](https://docs.cloud.google.com/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.Document.Builder#com_google_appengine_api_search_Document_Builder_setId_java_lang_String_) [Document.Builder.setLocale(Locale)](https://docs.cloud.google.com/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.Document.Builder#com_google_appengine_api_search_Document_Builder_setLocale_java_util_Locale_) [Document.Builder.setRank(int)](https://docs.cloud.google.com/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.Document.Builder#com_google_appengine_api_search_Document_Builder_setRank_int_) [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

### addExpression(Field expression)

    public ScoredDocument.Builder addExpression(Field expression)

Adds the expression to the builder.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `expression` | `https://docs.cloud.google.com/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.Field` the expression field to add |

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

### addScore(double score)

    public ScoredDocument.Builder addScore(double score)

Adds the score to the builder.

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

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

### build()

    public ScoredDocument build()

Builds a valid document. The builder must have set a valid document
id, and have a non-empty set of valid fields.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.ScoredDocument` | the scored document built by this builder |

**Overrides** [Document.Builder.build()](https://docs.cloud.google.com/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.Document.Builder#com_google_appengine_api_search_Document_Builder_build__)

### setCursor(Cursor cursor)

    public ScoredDocument.Builder setCursor(Cursor cursor)

Sets the cursor to the next set of results from search.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `cursor` | `https://docs.cloud.google.com/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.Cursor` the [Cursor](https://docs.cloud.google.com/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.Cursor) for the next set of results from search |

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