Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels) Summary: [Nested Classes](https://developer.android.com/reference/android/app/appsearch/PutDocumentsRequest#nestedclasses) \| [Methods](https://developer.android.com/reference/android/app/appsearch/PutDocumentsRequest#pubmethods) \| [Inherited Methods](https://developer.android.com/reference/android/app/appsearch/PutDocumentsRequest#inhmethods)

# PutDocumentsRequest

*** ** * ** ***

` public final class PutDocumentsRequest `   
` extends https://developer.android.com/reference/java/lang/Object ` ` `

|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object) ||
| ↳ | android.app.appsearch.PutDocumentsRequest |

<br />

*** ** * ** ***

Encapsulates a request to index documents into an `https://developer.android.com/reference/android/app/appsearch/AppSearchSession` database.
**See also:**

- `https://developer.android.com/reference/android/app/appsearch/AppSearchSession#put(android.app.appsearch.PutDocumentsRequest,%20java.util.concurrent.Executor,%20android.app.appsearch.BatchResultCallback<java.lang.String,java.lang.Void>)`

## Summary

| ### Nested classes ||
|---|---|
| ` class` | `https://developer.android.com/reference/android/app/appsearch/PutDocumentsRequest.Builder` Builder for `https://developer.android.com/reference/android/app/appsearch/PutDocumentsRequest` objects. |

| ### Public methods ||
|---|---|
| ` https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/app/appsearch/GenericDocument>` | ` https://developer.android.com/reference/android/app/appsearch/PutDocumentsRequest#getGenericDocuments()() ` Returns a list of `https://developer.android.com/reference/android/app/appsearch/GenericDocument` objects that are part of this request. |
| ` https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/app/appsearch/GenericDocument>` | ` https://developer.android.com/reference/android/app/appsearch/PutDocumentsRequest#getTakenActionGenericDocuments()() ` Returns a list of `https://developer.android.com/reference/android/app/appsearch/GenericDocument` objects containing taken action metrics that are part of this request. |

### Inherited methods

From class ` https://developer.android.com/reference/java/lang/Object ` ` https://developer.android.com/reference/java/lang/Object` ` https://developer.android.com/reference/java/lang/Object#clone()() `

Creates and returns a copy of this object.
` boolean` ` https://developer.android.com/reference/java/lang/Object#equals(java.lang.Object)(https://developer.android.com/reference/java/lang/Object obj) `

Indicates whether some other object is "equal to" this one.
` void` ` https://developer.android.com/reference/java/lang/Object#finalize()() `

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
` final https://developer.android.com/reference/java/lang/Class<?>` ` https://developer.android.com/reference/java/lang/Object#getClass()() `

Returns the runtime class of this `Object`.
` int` ` https://developer.android.com/reference/java/lang/Object#hashCode()() `

Returns a hash code value for the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#notify()() `

Wakes up a single thread that is waiting on this object's monitor.
` final void` ` https://developer.android.com/reference/java/lang/Object#notifyAll()() `

Wakes up all threads that are waiting on this object's monitor.
` https://developer.android.com/reference/java/lang/String` ` https://developer.android.com/reference/java/lang/Object#toString()() `

Returns a string representation of the object.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long,%20int)(long timeoutMillis, int nanos) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait(long)(long timeoutMillis) `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*, or until a certain amount of real time has elapsed.
` final void` ` https://developer.android.com/reference/java/lang/Object#wait()() `

Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*.

## Public methods

### getGenericDocuments

Added in [API level 31](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)

```
public List<GenericDocument> getGenericDocuments ()
```

Returns a list of `https://developer.android.com/reference/android/app/appsearch/GenericDocument` objects that are part of this request.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/app/appsearch/GenericDocument>` | This value cannot be `null`. <br /> |

### getTakenActionGenericDocuments

Added in [API level 35](https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels)  
Also in [T Extensions 13](https://developer.android.com/sdkExtensions)

```
public List<GenericDocument> getTakenActionGenericDocuments ()
```

Returns a list of `https://developer.android.com/reference/android/app/appsearch/GenericDocument` objects containing taken action metrics that are part of this request.

See `https://developer.android.com/reference/android/app/appsearch/PutDocumentsRequest.Builder#addTakenActionGenericDocuments(android.app.appsearch.GenericDocument[])`.

<br />

| Returns ||
|---|---|
| `https://developer.android.com/reference/java/util/List<https://developer.android.com/reference/android/app/appsearch/GenericDocument>` | This value cannot be `null`. <br /> |