# Print output for @column tags ?>
public
static
class
GenericDocument.Builder
extends Object
java.lang.Object | |
↳ | android.app.appsearch.GenericDocument.Builder<BuilderType extends android.app.appsearch.GenericDocument.Builder> |
The builder class for GenericDocument
.
Public constructors | |
---|---|
Builder(String namespace, String id, String schemaType)
Creates a new |
Public methods | |
---|---|
GenericDocument
|
build()
Builds the |
BuilderType
|
setCreationTimestampMillis(long creationTimestampMillis)
Sets the creation timestamp of the |
BuilderType
|
setPropertyBoolean(String name, boolean... values)
Sets one or multiple |
BuilderType
|
setPropertyBytes(String name, byte... values)
Sets one or multiple |
BuilderType
|
setPropertyDocument(String name, GenericDocument... values)
Sets one or multiple |
BuilderType
|
setPropertyDouble(String name, double... values)
Sets one or multiple |
BuilderType
|
setPropertyLong(String name, long... values)
Sets one or multiple |
BuilderType
|
setPropertyString(String name, String... values)
Sets one or multiple |
BuilderType
|
setScore(int score)
Sets the score of the |
BuilderType
|
setTtlMillis(long ttlMillis)
Sets the TTL (time-to-live) of the |
Inherited methods | |
---|---|
public Builder (String namespace, String id, String schemaType)
Creates a new GenericDocument.Builder
.
Document IDs are unique within a namespace.
The number of namespaces per app should be kept small for efficiency reasons.
Parameters | |
---|---|
namespace |
String : the namespace to set for the GenericDocument .
This value cannot be null . |
id |
String : the unique identifier for the GenericDocument in its namespace.
This value cannot be null . |
schemaType |
String : the AppSearchSchema type of the GenericDocument . The
provided schemaType must be defined using AppSearchSession#setSchema
prior to inserting a document of this schemaType into the AppSearch index
using AppSearchSession#put . Otherwise, the document will be rejected by
AppSearchSession#put with result code AppSearchResult.RESULT_NOT_FOUND .
This value cannot be null . |
public GenericDocument build ()
Builds the GenericDocument
object.
Returns | |
---|---|
GenericDocument |
This value cannot be null . |
public BuilderType setCreationTimestampMillis (long creationTimestampMillis)
Sets the creation timestamp of the GenericDocument
, in milliseconds.
This should be set using a value obtained from the System#currentTimeMillis
time base.
If this method is not called, this will be set to the time the object is built.
Parameters | |
---|---|
creationTimestampMillis |
long : a creation timestamp in milliseconds.
Value is a non-negative timestamp measured as the number of
milliseconds since 1970-01-01T00:00:00Z. |
Returns | |
---|---|
BuilderType |
This value cannot be null . |
public BuilderType setPropertyBoolean (String name, boolean... values)
Sets one or multiple boolean
values for a property, replacing its previous
values.
Parameters | |
---|---|
name |
String : the name associated with the values . Must match the name for this
property as given in AppSearchSchema.PropertyConfig#getName .
This value cannot be null . |
values |
boolean : the boolean values of the property.
This value cannot be null . |
Returns | |
---|---|
BuilderType |
This value cannot be null . |
public BuilderType setPropertyBytes (String name, byte... values)
Sets one or multiple byte[]
for a property, replacing its previous values.
Parameters | |
---|---|
name |
String : the name associated with the values . Must match the name for this
property as given in AppSearchSchema.PropertyConfig#getName .
This value cannot be null . |
values |
byte : the byte[] of the property.
This value cannot be null . |
Returns | |
---|---|
BuilderType |
Throws | |
---|---|
IllegalArgumentException |
if no values are provided, or if a passed in byte[] is null . |
public BuilderType setPropertyDocument (String name, GenericDocument... values)
Sets one or multiple GenericDocument
values for a property, replacing its
previous values.
Parameters | |
---|---|
name |
String : the name associated with the values . Must match the name for this
property as given in AppSearchSchema.PropertyConfig#getName .
This value cannot be null . |
values |
GenericDocument : the GenericDocument values of the property.
This value cannot be null . |
Returns | |
---|---|
BuilderType |
Throws | |
---|---|
IllegalArgumentException |
if no values are provided, or if a passed in GenericDocument is null . |
public BuilderType setPropertyDouble (String name, double... values)
Sets one or multiple double
values for a property, replacing its previous values.
Parameters | |
---|---|
name |
String : the name associated with the values . Must match the name for this
property as given in AppSearchSchema.PropertyConfig#getName .
This value cannot be null . |
values |
double : the double values of the property.
This value cannot be null . |
Returns | |
---|---|
BuilderType |
This value cannot be null . |
public BuilderType setPropertyLong (String name, long... values)
Sets one or multiple long
values for a property, replacing its previous values.
Parameters | |
---|---|
name |
String : the name associated with the values . Must match the name for this
property as given in AppSearchSchema.PropertyConfig#getName .
This value cannot be null . |
values |
long : the long values of the property.
This value cannot be null . |
Returns | |
---|---|
BuilderType |
This value cannot be null . |
public BuilderType setPropertyString (String name, String... values)
Sets one or multiple String
values for a property, replacing its previous values.
Parameters | |
---|---|
name |
String : the name associated with the values . Must match the name for this
property as given in AppSearchSchema.PropertyConfig#getName .
This value cannot be null . |
values |
String : the String values of the property.
This value cannot be null . |
Returns | |
---|---|
BuilderType |
Throws | |
---|---|
IllegalArgumentException |
if no values are provided, or if a passed in String is null . |
public BuilderType setScore (int score)
Sets the score of the GenericDocument
.
The score is a query-independent measure of the document's quality, relative to other
GenericDocument
objects of the same AppSearchSchema
type.
Results may be sorted by score using SearchSpec.Builder#setRankingStrategy
.
Documents with higher scores are considered better than documents with lower scores.
Any non-negative integer can be used a score. By default, scores are set to 0.
Parameters | |
---|---|
score |
int : any non-negative int representing the document's score.
Value is between 0 and Integer.MAX_VALUE inclusive |
Returns | |
---|---|
BuilderType |
This value cannot be null . |
public BuilderType setTtlMillis (long ttlMillis)
Sets the TTL (time-to-live) of the GenericDocument
, in milliseconds.
The TTL is measured against GenericDocument.getCreationTimestampMillis()
. At the timestamp of
creationTimestampMillis + ttlMillis
, measured in the System.currentTimeMillis()
time base, the document will be auto-deleted.
The default value is 0, which means the document is permanent and won't be
auto-deleted until the app is uninstalled or AppSearchSession#remove
is called.
Parameters | |
---|---|
ttlMillis |
long : a non-negative duration in milliseconds. |
Returns | |
---|---|
BuilderType |
This value cannot be null . |