Added in API level 31
PutDocumentsRequest
public
final
class
PutDocumentsRequest
extends Object
| java.lang.Object | |
| ↳ | android.app.appsearch.PutDocumentsRequest |
Encapsulates a request to index documents into an AppSearchSession database.
Summary
Nested classes | |
|---|---|
class |
PutDocumentsRequest.Builder
Builder for |
Public methods | |
|---|---|
List<GenericDocument>
|
getGenericDocuments()
Returns a list of |
List<GenericDocument>
|
getTakenActionGenericDocuments()
Returns a list of |
Inherited methods | |
|---|---|
Public methods
getGenericDocuments
Added in API level 31
public List<GenericDocument> getGenericDocuments ()
Returns a list of GenericDocument objects that are part of this request.
| Returns | |
|---|---|
List<GenericDocument> |
This value cannot be null. |
getTakenActionGenericDocuments
public List<GenericDocument> getTakenActionGenericDocuments ()
Returns a list of GenericDocument objects containing taken action metrics that are
part of this request.
See Builder.addTakenActionGenericDocuments(GenericDocument...).
| Returns | |
|---|---|
List<GenericDocument> |
This value cannot be null. |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[null,null,["Last updated 2025-02-10 UTC."],[],[],null,["# PutDocumentsRequest\n\nAdded in [API level 31](/guide/topics/manifest/uses-sdk-element#ApiLevels) \nSummary: [Nested Classes](#nestedclasses) \\| [Methods](#pubmethods) \\| [Inherited Methods](#inhmethods) \n\nPutDocumentsRequest\n===================\n\n*** ** * ** ***\n\n[Kotlin](/reference/kotlin/android/app/appsearch/PutDocumentsRequest \"View this page in Kotlin\") \\|Java\n\n\n`\npublic\n\nfinal\n\nclass\nPutDocumentsRequest\n`\n\n\n`\n\nextends `[Object](/reference/java/lang/Object)`\n\n\n`\n\n`\n\n\n`\n\n|---|-------------------------------------------|\n| [java.lang.Object](/reference/java/lang/Object) ||\n| ↳ | android.app.appsearch.PutDocumentsRequest |\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nEncapsulates a request to index documents into an [AppSearchSession](/reference/android/app/appsearch/AppSearchSession) database. \n**See also:**\n\n- [AppSearchSession.put(PutDocumentsRequest, Executor, BatchResultCallback)](/reference/android/app/appsearch/AppSearchSession#put(android.app.appsearch.PutDocumentsRequest,%20java.util.concurrent.Executor,%20android.app.appsearch.BatchResultCallback\u003cjava.lang.String,java.lang.Void\u003e))\n\nSummary\n-------\n\n| ### Nested classes ||\n|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` class` | [PutDocumentsRequest.Builder](/reference/android/app/appsearch/PutDocumentsRequest.Builder) Builder for [PutDocumentsRequest](/reference/android/app/appsearch/PutDocumentsRequest) objects. |\n\n| ### Public methods ||\n|---------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ` `[List](/reference/java/util/List)`\u003c`[GenericDocument](/reference/android/app/appsearch/GenericDocument)`\u003e` | ` `[getGenericDocuments](/reference/android/app/appsearch/PutDocumentsRequest#getGenericDocuments())`() ` Returns a list of [GenericDocument](/reference/android/app/appsearch/GenericDocument) objects that are part of this request. |\n| ` `[List](/reference/java/util/List)`\u003c`[GenericDocument](/reference/android/app/appsearch/GenericDocument)`\u003e` | ` `[getTakenActionGenericDocuments](/reference/android/app/appsearch/PutDocumentsRequest#getTakenActionGenericDocuments())`() ` Returns a list of [GenericDocument](/reference/android/app/appsearch/GenericDocument) objects containing taken action metrics that are part of this request. |\n\n| ### Inherited methods |\n|-----------------------|---|\n| From class ` `[java.lang.Object](/reference/java/lang/Object)` ` |---------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ` `[Object](/reference/java/lang/Object) | ` `[clone](/reference/java/lang/Object#clone())`() ` Creates and returns a copy of this object. | | ` boolean` | ` `[equals](/reference/java/lang/Object#equals(java.lang.Object))`(`[Object](/reference/java/lang/Object)` obj) ` Indicates whether some other object is \"equal to\" this one. | | ` void` | ` `[finalize](/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 `[Class](/reference/java/lang/Class)`\u003c?\u003e` | ` `[getClass](/reference/java/lang/Object#getClass())`() ` Returns the runtime class of this `Object`. | | ` int` | ` `[hashCode](/reference/java/lang/Object#hashCode())`() ` Returns a hash code value for the object. | | ` final void` | ` `[notify](/reference/java/lang/Object#notify())`() ` Wakes up a single thread that is waiting on this object's monitor. | | ` final void` | ` `[notifyAll](/reference/java/lang/Object#notifyAll())`() ` Wakes up all threads that are waiting on this object's monitor. | | ` `[String](/reference/java/lang/String) | ` `[toString](/reference/java/lang/Object#toString())`() ` Returns a string representation of the object. | | ` final void` | ` `[wait](/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` | ` `[wait](/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` | ` `[wait](/reference/java/lang/Object#wait())`() ` Causes the current thread to wait until it is awakened, typically by being *notified* or *interrupted*. | ||\n\nPublic methods\n--------------\n\n### getGenericDocuments\n\nAdded in [API level 31](/guide/topics/manifest/uses-sdk-element#ApiLevels) \n\n```\npublic List\u003cGenericDocument\u003e getGenericDocuments ()\n```\n\nReturns a list of [GenericDocument](/reference/android/app/appsearch/GenericDocument) objects that are part of this request.\n\n\u003cbr /\u003e\n\n| Returns ||\n|------------------------------------------------------------------------------------------------------------|-------------------------------------|\n| [List](/reference/java/util/List)`\u003c`[GenericDocument](/reference/android/app/appsearch/GenericDocument)`\u003e` | This value cannot be `null`. \u003cbr /\u003e |\n\n### getTakenActionGenericDocuments\n\nAdded in [API level 35](/guide/topics/manifest/uses-sdk-element#ApiLevels) \nAlso in [T Extensions 13](/sdkExtensions) \n\n```\npublic List\u003cGenericDocument\u003e getTakenActionGenericDocuments ()\n```\n\nReturns a list of [GenericDocument](/reference/android/app/appsearch/GenericDocument) objects containing taken action metrics that are\npart of this request.\n\nSee [Builder.addTakenActionGenericDocuments(GenericDocument...)](/reference/android/app/appsearch/PutDocumentsRequest.Builder#addTakenActionGenericDocuments(android.app.appsearch.GenericDocument[])).\n\n\u003cbr /\u003e\n\n| Returns ||\n|------------------------------------------------------------------------------------------------------------|-------------------------------------|\n| [List](/reference/java/util/List)`\u003c`[GenericDocument](/reference/android/app/appsearch/GenericDocument)`\u003e` | This value cannot be `null`. \u003cbr /\u003e |"]]