ReportUsageRequest.Builder


public static final class ReportUsageRequest.Builder
extends Object

java.lang.Object
   ↳ android.app.appsearch.ReportUsageRequest.Builder


Builder for ReportUsageRequest objects.

Summary

Public constructors

Builder(String namespace, String documentId)

Creates a new ReportUsageRequest.Builder instance.

Public methods

ReportUsageRequest build()

Builds a new ReportUsageRequest.

ReportUsageRequest.Builder setUsageTimestampMillis(long usageTimestampMillis)

Sets the timestamp in milliseconds of the usage report (the time at which the document was used).

Inherited methods

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the object.

final void notify()

Wakes up a single thread that is waiting on this object's monitor.

final void notifyAll()

Wakes up all threads that are waiting on this object's monitor.

String toString()

Returns a string representation of the object.

final void wait(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(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()

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

Public constructors

Builder

Added in API level 31
public Builder (String namespace, 
                String documentId)

Creates a new ReportUsageRequest.Builder instance.

Parameters
namespace String: The namespace of the document that was used (such as from GenericDocument.getNamespace(). This value cannot be null.

documentId String: The ID of document that was used (such as from GenericDocument.getId(). This value cannot be null.

Public methods

build

Added in API level 31
public ReportUsageRequest build ()

Builds a new ReportUsageRequest.

Returns
ReportUsageRequest This value cannot be null.

setUsageTimestampMillis

Added in API level 31
public ReportUsageRequest.Builder setUsageTimestampMillis (long usageTimestampMillis)

Sets 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.

If unset, this defaults to the current timestamp at the time that the ReportUsageRequest is constructed.

Parameters
usageTimestampMillis long: Value is a non-negative timestamp measured as the number of milliseconds since 1970-01-01T00:00:00Z.

Returns
ReportUsageRequest.Builder This value cannot be null.