ReportUsageRequest
Stay organized with collections
Save and categorize content based on your preferences.
Inherited Constant Summary
From interface android.os.Parcelable
| int |
CONTENTS_FILE_DESCRIPTOR |
|
| int |
PARCELABLE_WRITE_RETURN_VALUE |
|
Inherited Method Summary
From class java.lang.Object
From interface android.os.Parcelable
| abstract int |
describeContents
()
|
| abstract void |
writeToParcel
( Parcel
arg0,
int arg1)
|
Public Methods
public String
getDocumentId
()
Returns the ID of document that was used.
public String
getNamespace
()
Returns the namespace of the document that was used.
public long
getUsageTimestampMillis
()
Returns the timestamp in milliseconds of the usage report (the time at which the
document was used).
The value is in the System.currentTimeMillis()
time base.
public void
writeToParcel
( Parcel
dest, int
flags)
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\u003eReportUsageRequest\u003c/code\u003e enables reporting the usage of a specific document within AppSearch.\u003c/p\u003e\n"],["\u003cp\u003eIt includes information such as the document ID, namespace, and usage timestamp.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can create \u003ccode\u003eReportUsageRequest\u003c/code\u003e objects using a dedicated Builder class.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eAppSearchClient.reportUsage()\u003c/code\u003e is used to send the usage report.\u003c/p\u003e\n"],["\u003cp\u003eThis class implements \u003ccode\u003eParcelable\u003c/code\u003e for efficient data transfer across processes.\u003c/p\u003e\n"]]],[],null,["# ReportUsageRequest\n\npublic final class **ReportUsageRequest** extends [Object](//developer.android.com/reference/java/lang/Object.html) \nimplements [Parcelable](//developer.android.com/reference/android/os/Parcelable.html) \nA request to report usage of a document.\n\nSee [AppSearchClient.reportUsage(ReportUsageRequest, String)](/android/reference/com/google/android/gms/appsearch/AppSearchClient#reportUsage(com.google.android.gms.appsearch.ReportUsageRequest,%20java.lang.String)) for a detailed description\nof usage reporting. \n\n##### See Also\n\n- [AppSearchClient.reportUsage(ReportUsageRequest, String)](/android/reference/com/google/android/gms/appsearch/AppSearchClient#reportUsage(com.google.android.gms.appsearch.ReportUsageRequest,%20java.lang.String)) \n\n### Nested Class Summary\n\n|-------|---|---|-------------------------------------------------------------------------------------------------------------------|\n| class | [ReportUsageRequest.Builder](/android/reference/com/google/android/gms/appsearch/ReportUsageRequest.Builder) || Builder for [ReportUsageRequest](/android/reference/com/google/android/gms/appsearch/ReportUsageRequest) objects. |\n\n### Inherited Constant Summary\n\nFrom interface android.os.Parcelable \n\n|-----|-------------------------------|---|\n| int | CONTENTS_FILE_DESCRIPTOR | |\n| int | PARCELABLE_WRITE_RETURN_VALUE | |\n\n### Field Summary\n\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------|---|\n| public static final [Creator](//developer.android.com/reference/android/os/Parcelable.Creator.html)\\\u003c[ReportUsageRequest](/android/reference/com/google/android/gms/appsearch/ReportUsageRequest)\\\u003e | [CREATOR](/android/reference/com/google/android/gms/appsearch/ReportUsageRequest#CREATOR) | |\n\n### Public Method Summary\n\n|-------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [String](//developer.android.com/reference/java/lang/String.html) | [getDocumentId](/android/reference/com/google/android/gms/appsearch/ReportUsageRequest#getDocumentId())() Returns the ID of document that was used. |\n| [String](//developer.android.com/reference/java/lang/String.html) | [getNamespace](/android/reference/com/google/android/gms/appsearch/ReportUsageRequest#getNamespace())() Returns the namespace of the document that was used. |\n| long | [getUsageTimestampMillis](/android/reference/com/google/android/gms/appsearch/ReportUsageRequest#getUsageTimestampMillis())() Returns the timestamp in milliseconds of the usage report (the time at which the document was used). |\n| void | [writeToParcel](/android/reference/com/google/android/gms/appsearch/ReportUsageRequest#writeToParcel(android.os.Parcel,%20int))([Parcel](//developer.android.com/reference/android/os/Parcel.html) dest, int flags) |\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\nFrom interface android.os.Parcelable \n\n|---------------|--------------------------------------------------------------------------------------------------|\n| abstract int | describeContents() |\n| abstract void | writeToParcel([Parcel](//developer.android.com/reference/android/os/Parcel.html) arg0, int arg1) |\n\nFields\n------\n\n#### public static final [Creator](//developer.android.com/reference/android/os/Parcelable.Creator.html)\\\u003c[ReportUsageRequest](/android/reference/com/google/android/gms/appsearch/ReportUsageRequest)\\\u003e\n**CREATOR**\n\nPublic Methods\n--------------\n\n#### public [String](//developer.android.com/reference/java/lang/String.html) **getDocumentId** ()\n\nReturns the ID of document that was used. \n\n#### public [String](//developer.android.com/reference/java/lang/String.html) **getNamespace** ()\n\nReturns the namespace of the document that was used. \n\n#### public long **getUsageTimestampMillis** ()\n\nReturns the timestamp in milliseconds of the usage report (the time at which the\ndocument was used).\n\nThe value is in the [System.currentTimeMillis()](//developer.android.com/reference/java/lang/System.html#currentTimeMillis())\ntime base. \n\n#### public void **writeToParcel** ([Parcel](//developer.android.com/reference/android/os/Parcel.html) dest, int flags)"]]
