AppSearchSession.SetSchema Method

Definition

Sets the schema that represents the organizational structure of data within the AppSearch database.

[Android.Runtime.Register("setSchema", "(Landroid/app/appsearch/SetSchemaRequest;Ljava/util/concurrent/Executor;Ljava/util/concurrent/Executor;Ljava/util/function/Consumer;)V", "", ApiSince=31)]
public void SetSchema (Android.App.AppSearch.SetSchemaRequest request, Java.Util.Concurrent.IExecutor workExecutor, Java.Util.Concurrent.IExecutor callbackExecutor, Java.Util.Functions.IConsumer callback);
[<Android.Runtime.Register("setSchema", "(Landroid/app/appsearch/SetSchemaRequest;Ljava/util/concurrent/Executor;Ljava/util/concurrent/Executor;Ljava/util/function/Consumer;)V", "", ApiSince=31)>]
member this.SetSchema : Android.App.AppSearch.SetSchemaRequest * Java.Util.Concurrent.IExecutor * Java.Util.Concurrent.IExecutor * Java.Util.Functions.IConsumer -> unit

Parameters

request
SetSchemaRequest

the schema to set or update the AppSearch database to.

workExecutor
IExecutor

Executor on which to schedule heavy client-side background work such as transforming documents.

callbackExecutor
IExecutor

Executor on which to invoke the callback.

callback
IConsumer

Callback to receive errors resulting from setting the schema. If the operation succeeds, the callback will be invoked with null.

Attributes

Remarks

Sets the schema that represents the organizational structure of data within the AppSearch database.

Upon creating an AppSearchSession, #setSchema should be called. If the schema needs to be updated, or it has not been previously set, then the provided schema will be saved and persisted to disk. Otherwise, #setSchema is handled efficiently as a no-op call.

Java documentation for android.app.appsearch.AppSearchSession.setSchema(android.app.appsearch.SetSchemaRequest, java.util.concurrent.Executor, java.util.concurrent.Executor, java.util.function.Consumer<android.app.appsearch.AppSearchResult<android.app.appsearch.SetSchemaResponse>>).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

Applies to