ReportUsageRequest.Builder

AI-generated Key Takeaways

• ReportUsageRequest.Builder is used to build ReportUsageRequest objects.

• A new builder instance is created with a document's namespace and documentId.

• You can set the usage timestamp for the report in milliseconds.

• The build() method creates the final ReportUsageRequest object.

public static final class ReportUsageRequest.Builder extends Object

Builder for ReportUsageRequest objects.

Public Constructor Summary

Builder(String namespace, String documentId) Creates a new ReportUsageRequest.Builder instance.

Public Method Summary

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 Method Summary

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

Public Constructors

public Builder (String namespace, String documentId)

Creates a new ReportUsageRequest.Builder instance.

Parameters

namespace	The namespace of the document that was used (such as from GenericDocument.getNamespace().
documentId	The ID of document that was used (such as from GenericDocument.getId().

Public Methods

public ReportUsageRequest build ()

Builds a new ReportUsageRequest.

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.