Stay organized with collections Save and categorize content based on your preferences.

public static final class ReportSystemUsageRequest.Builder
extends Object



Builder for ReportSystemUsageRequest objects.

Summary

Public constructors

Builder(String packageName, String databaseName, String namespace, String documentId)

Creates a ReportSystemUsageRequest.Builder instance.

Public methods

ReportSystemUsageRequest build()

Builds a new ReportSystemUsageRequest.

ReportSystemUsageRequest.Builder setUsageTimestampMillis(long usageTimestampMillis)

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

Inherited methods

From class java.lang.Object

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

public Builder (String packageName, 
                String databaseName, 
                String namespace, 
                String documentId)

Creates a ReportSystemUsageRequest.Builder instance.

Parameters
packageName String: The package name of the app which owns the document that was used (e.g. from SearchResult#getPackageName). This value cannot be null.
databaseName String: The database in which the document that was used resides (e.g. from SearchResult#getDatabaseName). This value cannot be null.
namespace String: The namespace of the document that was used (e.g. from GenericDocument.getNamespace(). This value cannot be null.
documentId String: The ID of document that was used (e.g. from GenericDocument.getId(). This value cannot be null.

Public methods

build

public ReportSystemUsageRequest build ()

Builds a new ReportSystemUsageRequest.

Returns
ReportSystemUsageRequest This value cannot be null.

setUsageTimestampMillis

public ReportSystemUsageRequest.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 ReportSystemUsageRequest is constructed.

Parameters
usageTimestampMillis long: Value is a non-negative timestamp measured as the number of milliseconds since 1970-01-01T00:00:00Z.
Returns
ReportSystemUsageRequest.Builder 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 2023-02-08 UTC.