PutDocumentsRequest
Stay organized with collections
Save and categorize content based on your preferences.
Encapsulates a request to index documents into an AppSearchClient
database.
Inherited Method Summary
From class java.lang.Object
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-31 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-31 UTC."],[[["\u003cp\u003e\u003ccode\u003ePutDocumentsRequest\u003c/code\u003e encapsulates a request to index documents into an AppSearchClient database.\u003c/p\u003e\n"],["\u003cp\u003eIt allows adding \u003ccode\u003eGenericDocument\u003c/code\u003e objects for indexing and for tracking taken action metrics.\u003c/p\u003e\n"],["\u003cp\u003eYou can build a \u003ccode\u003ePutDocumentsRequest\u003c/code\u003e using the provided \u003ccode\u003ePutDocumentsRequest.Builder\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe class provides methods to retrieve the lists of \u003ccode\u003eGenericDocument\u003c/code\u003e objects for indexing and for taken action metrics.\u003c/p\u003e\n"]]],[],null,["# PutDocumentsRequest\n\npublic final class **PutDocumentsRequest** extends [Object](//developer.android.com/reference/java/lang/Object.html) \nEncapsulates a request to index documents into an [AppSearchClient](/android/reference/com/google/android/gms/appsearch/AppSearchClient)\ndatabase. \n\n##### See Also\n\n- [AppSearchClient.put(PutDocumentsRequest, String)](/android/reference/com/google/android/gms/appsearch/AppSearchClient#put(com.google.android.gms.appsearch.PutDocumentsRequest,%20java.lang.String)) \n\n### Nested Class Summary\n\n|-------|---|---|---------------------------------------------------------------------------------------------------------------------|\n| class | [PutDocumentsRequest.Builder](/android/reference/com/google/android/gms/appsearch/PutDocumentsRequest.Builder) || Builder for [PutDocumentsRequest](/android/reference/com/google/android/gms/appsearch/PutDocumentsRequest) objects. |\n\n### Public Method Summary\n\n|---------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [List](//developer.android.com/reference/java/util/List.html)\\\u003c[GenericDocument](/android/reference/com/google/android/gms/appsearch/GenericDocument)\\\u003e | [getGenericDocuments](/android/reference/com/google/android/gms/appsearch/PutDocumentsRequest#getGenericDocuments())() Returns a list of [GenericDocument](/android/reference/com/google/android/gms/appsearch/GenericDocument) objects that are part of this request. |\n| [List](//developer.android.com/reference/java/util/List.html)\\\u003c[GenericDocument](/android/reference/com/google/android/gms/appsearch/GenericDocument)\\\u003e | [getTakenActionGenericDocuments](/android/reference/com/google/android/gms/appsearch/PutDocumentsRequest#getTakenActionGenericDocuments())() Returns a list of [GenericDocument](/android/reference/com/google/android/gms/appsearch/GenericDocument) objects containing taken action metrics that are part of this request. |\n\n### Inherited Method Summary\n\nFrom class java.lang.Object \n\n|----------------------------------------------------------------------------|--------------------------------------------------------------------------------|\n| [Object](//developer.android.com/reference/java/lang/Object.html) | clone() |\n| boolean | equals([Object](//developer.android.com/reference/java/lang/Object.html) arg0) |\n| void | finalize() |\n| final [Class](//developer.android.com/reference/java/lang/Class.html)\\\u003c?\\\u003e | getClass() |\n| int | hashCode() |\n| final void | notify() |\n| final void | notifyAll() |\n| [String](//developer.android.com/reference/java/lang/String.html) | toString() |\n| final void | wait(long arg0, int arg1) |\n| final void | wait(long arg0) |\n| final void | wait() |\n\nPublic Methods\n--------------\n\n#### public [List](//developer.android.com/reference/java/util/List.html)\\\u003c[GenericDocument](/android/reference/com/google/android/gms/appsearch/GenericDocument)\\\u003e\n**getGenericDocuments** ()\n\nReturns a list of [GenericDocument](/android/reference/com/google/android/gms/appsearch/GenericDocument)\nobjects that are part of this request. \n\n#### public [List](//developer.android.com/reference/java/util/List.html)\\\u003c[GenericDocument](/android/reference/com/google/android/gms/appsearch/GenericDocument)\\\u003e\n**getTakenActionGenericDocuments** ()\n\nReturns a list of [GenericDocument](/android/reference/com/google/android/gms/appsearch/GenericDocument)\nobjects containing taken action metrics that are part of this request.\n\nSee [PutDocumentsRequest.Builder.addTakenActionGenericDocuments(GenericDocument)](/android/reference/com/google/android/gms/appsearch/PutDocumentsRequest.Builder#addTakenActionGenericDocuments(com.google.android.gms.appsearch.GenericDocument...))."]]
