AppSearchAccount.Builder

Kotlin |Java

public static final class AppSearchAccount.Builder
extends Builder<AppSearchAccount.Builder>

java.lang.Object
↳	android.app.appsearch.GenericDocument.Builder<android.app.appsearch.AppSearchAccount.Builder>
	↳	android.app.appsearch.AppSearchAccount.Builder

The builder class for AppSearchAccount.

Summary

Public constructors
`Builder(String namespace, String id)` Creates a new `AppSearchAccount.Builder`

Public methods
`AppSearchAccount`	`build()` Builds the `AppSearchAccount` object.
`AppSearchAccount.Builder`	`setAccountId(String accountId)` Sets the account id of `AppSearchAccount`.
`AppSearchAccount.Builder`	`setAccountName(String accountName)` Sets the name of `AppSearchAccount`.
`AppSearchAccount.Builder`	`setAccountType(String accountType)` Sets the type of `AppSearchAccount`.

Inherited methods

From class


        
          android.app.appsearch.GenericDocument.Builder

`GenericDocument`	`build()` Builds the `GenericDocument` object.
`BuilderType`	`clearProperty(String name)` Clears the value for the property with the given name.
`BuilderType`	`setCreationTimestampMillis(long creationTimestampMillis)` Sets the creation timestamp of the `GenericDocument`, in milliseconds.
`BuilderType`	`setId(String id)` Sets the ID of this document, changing the value provided in the constructor.
`BuilderType`	`setNamespace(String namespace)` Sets the app-defined namespace this document resides in, changing the value provided in the constructor.
`BuilderType`	`setPropertyBlobHandle(String name, AppSearchBlobHandle... values)` Sets one or multiple `AppSearchBlobHandle` values for a property, replacing its previous values.
`BuilderType`	`setPropertyBoolean(String name, boolean... values)` Sets one or multiple `boolean` values for a property, replacing its previous values.
`BuilderType`	`setPropertyBytes(String name, byte... values)` Sets one or multiple `byte[]` for a property, replacing its previous values.
`BuilderType`	`setPropertyDocument(String name, GenericDocument... values)` Sets one or multiple `GenericDocument` values for a property, replacing its previous values.
`BuilderType`	`setPropertyDouble(String name, double... values)` Sets one or multiple `double` values for a property, replacing its previous values.
`BuilderType`	`setPropertyEmbedding(String name, EmbeddingVector... values)` Sets one or multiple `EmbeddingVector` values for a property, replacing its previous values.
`BuilderType`	`setPropertyLong(String name, long... values)` Sets one or multiple `long` values for a property, replacing its previous values.
`BuilderType`	`setPropertyString(String name, String... values)` Sets one or multiple `String` values for a property, replacing its previous values.
`BuilderType`	`setSchemaType(String schemaType)` Sets the schema type of this document, changing the value provided in the constructor.
`BuilderType`	`setScore(int score)` Sets the score of the `GenericDocument`.
`BuilderType`	`setTtlMillis(long ttlMillis)` Sets the TTL (time-to-live) of the `GenericDocument`, in milliseconds.

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

Added in API level 37
Also in T Extensions 22

public Builder (String namespace, 
                String id)

Creates a new AppSearchAccount.Builder

Parameters
`namespace`	`String`: The namespace of the account. This value cannot be `null`.
`id`	`String`: The document ID of the account. This value cannot be `null`.

Public methods

build

Added in API level 37
Also in T Extensions 22

public AppSearchAccount build ()

Builds the AppSearchAccount object.

Returns
`AppSearchAccount`	This value cannot be `null`.

setAccountId

Added in API level 37
Also in T Extensions 22

public AppSearchAccount.Builder setAccountId (String accountId)

Sets the account id of AppSearchAccount.

Parameters
`accountId`	`String`: A non-null, permanent identifier for the account.

Returns
`AppSearchAccount.Builder`	This value cannot be `null`.

setAccountName

Added in API level 37
Also in T Extensions 22

public AppSearchAccount.Builder setAccountName (String accountName)

Sets the name of AppSearchAccount.

Parameters
`accountName`	`String`: The non-null name for the specific user account.

Returns
`AppSearchAccount.Builder`	This value cannot be `null`.

setAccountType

Added in API level 37
Also in T Extensions 22

public AppSearchAccount.Builder setAccountType (String accountType)

Sets the type of AppSearchAccount.

Parameters
`accountType`	`String`: The non-null, unique identifier for the account service. This must correspond to a registered `Authenticator` type on the system.

Returns
`AppSearchAccount.Builder`	This value cannot be `null`.