• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1// Signature format: 2.0
2package android.app.appsearch {
3
4  public final class AppSearchBatchResult<KeyType, ValueType> {
5    method @NonNull public java.util.Map<KeyType,android.app.appsearch.AppSearchResult<ValueType>> getAll();
6    method @NonNull public java.util.Map<KeyType,android.app.appsearch.AppSearchResult<ValueType>> getFailures();
7    method @NonNull public java.util.Map<KeyType,ValueType> getSuccesses();
8    method public boolean isSuccess();
9  }
10
11  public static final class AppSearchBatchResult.Builder<KeyType, ValueType> {
12    ctor public AppSearchBatchResult.Builder();
13    ctor public AppSearchBatchResult.Builder(@NonNull android.app.appsearch.AppSearchBatchResult<KeyType,ValueType>);
14    method @NonNull public android.app.appsearch.AppSearchBatchResult<KeyType,ValueType> build();
15    method @NonNull public android.app.appsearch.AppSearchBatchResult.Builder<KeyType,ValueType> setFailure(@NonNull KeyType, int, @Nullable String);
16    method @NonNull public android.app.appsearch.AppSearchBatchResult.Builder<KeyType,ValueType> setResult(@NonNull KeyType, @NonNull android.app.appsearch.AppSearchResult<ValueType>);
17    method @NonNull public android.app.appsearch.AppSearchBatchResult.Builder<KeyType,ValueType> setSuccess(@NonNull KeyType, @Nullable ValueType);
18  }
19
20  public final class AppSearchBlobHandle implements android.os.Parcelable {
21    method @NonNull public static android.app.appsearch.AppSearchBlobHandle createWithSha256(@NonNull byte[], @NonNull String, @NonNull String, @NonNull String);
22    method public final int describeContents();
23    method @NonNull public String getDatabaseName();
24    method @NonNull public String getNamespace();
25    method @NonNull public String getPackageName();
26    method @NonNull public byte[] getSha256Digest();
27    method public void writeToParcel(@NonNull android.os.Parcel, int);
28    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.AppSearchBlobHandle> CREATOR;
29  }
30
31  public class AppSearchManager {
32    method public void createEnterpriseGlobalSearchSession(@NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<android.app.appsearch.AppSearchResult<android.app.appsearch.EnterpriseGlobalSearchSession>>);
33    method public void createGlobalSearchSession(@NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<android.app.appsearch.AppSearchResult<android.app.appsearch.GlobalSearchSession>>);
34    method public void createSearchSession(@NonNull android.app.appsearch.AppSearchManager.SearchContext, @NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<android.app.appsearch.AppSearchResult<android.app.appsearch.AppSearchSession>>);
35  }
36
37  public static final class AppSearchManager.SearchContext {
38    method @NonNull public String getDatabaseName();
39  }
40
41  public static final class AppSearchManager.SearchContext.Builder {
42    ctor public AppSearchManager.SearchContext.Builder(@NonNull String);
43    method @NonNull public android.app.appsearch.AppSearchManager.SearchContext build();
44  }
45
46  public final class AppSearchResult<ValueType> {
47    method @Nullable public String getErrorMessage();
48    method public int getResultCode();
49    method @Nullable public ValueType getResultValue();
50    method public boolean isSuccess();
51    method @NonNull public static <ValueType> android.app.appsearch.AppSearchResult<ValueType> newFailedResult(int, @Nullable String);
52    method @NonNull public static <ValueType> android.app.appsearch.AppSearchResult<ValueType> newSuccessfulResult(@Nullable ValueType);
53    field public static final int RESULT_ALREADY_EXISTS = 12; // 0xc
54    field public static final int RESULT_DENIED = 9; // 0x9
55    field public static final int RESULT_INTERNAL_ERROR = 2; // 0x2
56    field public static final int RESULT_INVALID_ARGUMENT = 3; // 0x3
57    field public static final int RESULT_INVALID_SCHEMA = 7; // 0x7
58    field public static final int RESULT_IO_ERROR = 4; // 0x4
59    field public static final int RESULT_NOT_FOUND = 6; // 0x6
60    field public static final int RESULT_OK = 0; // 0x0
61    field public static final int RESULT_OUT_OF_SPACE = 5; // 0x5
62    field public static final int RESULT_RATE_LIMITED = 10; // 0xa
63    field public static final int RESULT_SECURITY_ERROR = 8; // 0x8
64    field public static final int RESULT_UNKNOWN_ERROR = 1; // 0x1
65  }
66
67  public final class AppSearchSchema implements android.os.Parcelable {
68    method public final int describeContents();
69    method @NonNull public java.util.List<java.lang.String> getParentTypes();
70    method @NonNull public java.util.List<android.app.appsearch.AppSearchSchema.PropertyConfig> getProperties();
71    method @NonNull public String getSchemaType();
72    method public void writeToParcel(@NonNull android.os.Parcel, int);
73    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.AppSearchSchema> CREATOR;
74  }
75
76  public static final class AppSearchSchema.BlobHandlePropertyConfig extends android.app.appsearch.AppSearchSchema.PropertyConfig {
77  }
78
79  public static final class AppSearchSchema.BlobHandlePropertyConfig.Builder {
80    ctor public AppSearchSchema.BlobHandlePropertyConfig.Builder(@NonNull String);
81    method @NonNull public android.app.appsearch.AppSearchSchema.BlobHandlePropertyConfig build();
82    method @NonNull public android.app.appsearch.AppSearchSchema.BlobHandlePropertyConfig.Builder setCardinality(int);
83  }
84
85  public static final class AppSearchSchema.BooleanPropertyConfig extends android.app.appsearch.AppSearchSchema.PropertyConfig {
86    method public boolean isScoringEnabled();
87  }
88
89  public static final class AppSearchSchema.BooleanPropertyConfig.Builder {
90    ctor public AppSearchSchema.BooleanPropertyConfig.Builder(@NonNull String);
91    method @NonNull public android.app.appsearch.AppSearchSchema.BooleanPropertyConfig build();
92    method @NonNull public android.app.appsearch.AppSearchSchema.BooleanPropertyConfig.Builder setCardinality(int);
93    method @NonNull public android.app.appsearch.AppSearchSchema.BooleanPropertyConfig.Builder setScoringEnabled(boolean);
94  }
95
96  public static final class AppSearchSchema.Builder {
97    ctor public AppSearchSchema.Builder(@NonNull String);
98    ctor public AppSearchSchema.Builder(@NonNull android.app.appsearch.AppSearchSchema);
99    method @NonNull public android.app.appsearch.AppSearchSchema.Builder addParentType(@NonNull String);
100    method @NonNull public android.app.appsearch.AppSearchSchema.Builder addProperty(@NonNull android.app.appsearch.AppSearchSchema.PropertyConfig);
101    method @NonNull public android.app.appsearch.AppSearchSchema build();
102    method @NonNull public android.app.appsearch.AppSearchSchema.Builder clearParentTypes();
103    method @NonNull public android.app.appsearch.AppSearchSchema.Builder clearProperties();
104    method @NonNull public android.app.appsearch.AppSearchSchema.Builder setSchemaType(@NonNull String);
105  }
106
107  public static final class AppSearchSchema.BytesPropertyConfig extends android.app.appsearch.AppSearchSchema.PropertyConfig {
108  }
109
110  public static final class AppSearchSchema.BytesPropertyConfig.Builder {
111    ctor public AppSearchSchema.BytesPropertyConfig.Builder(@NonNull String);
112    method @NonNull public android.app.appsearch.AppSearchSchema.BytesPropertyConfig build();
113    method @NonNull public android.app.appsearch.AppSearchSchema.BytesPropertyConfig.Builder setCardinality(int);
114  }
115
116  public static final class AppSearchSchema.DocumentPropertyConfig extends android.app.appsearch.AppSearchSchema.PropertyConfig {
117    method @NonNull public java.util.List<java.lang.String> getIndexableNestedProperties();
118    method @NonNull public String getSchemaType();
119    method public boolean shouldIndexNestedProperties();
120  }
121
122  public static final class AppSearchSchema.DocumentPropertyConfig.Builder {
123    ctor public AppSearchSchema.DocumentPropertyConfig.Builder(@NonNull String, @NonNull String);
124    method @NonNull public android.app.appsearch.AppSearchSchema.DocumentPropertyConfig.Builder addIndexableNestedProperties(@NonNull java.lang.String...);
125    method @NonNull public android.app.appsearch.AppSearchSchema.DocumentPropertyConfig.Builder addIndexableNestedProperties(@NonNull java.util.Collection<java.lang.String>);
126    method @NonNull public android.app.appsearch.AppSearchSchema.DocumentPropertyConfig.Builder addIndexableNestedPropertyPaths(@NonNull android.app.appsearch.PropertyPath...);
127    method @NonNull public android.app.appsearch.AppSearchSchema.DocumentPropertyConfig.Builder addIndexableNestedPropertyPaths(@NonNull java.util.Collection<android.app.appsearch.PropertyPath>);
128    method @NonNull public android.app.appsearch.AppSearchSchema.DocumentPropertyConfig build();
129    method @NonNull public android.app.appsearch.AppSearchSchema.DocumentPropertyConfig.Builder setCardinality(int);
130    method @NonNull public android.app.appsearch.AppSearchSchema.DocumentPropertyConfig.Builder setShouldIndexNestedProperties(boolean);
131  }
132
133  public static final class AppSearchSchema.DoublePropertyConfig extends android.app.appsearch.AppSearchSchema.PropertyConfig {
134    method public boolean isScoringEnabled();
135  }
136
137  public static final class AppSearchSchema.DoublePropertyConfig.Builder {
138    ctor public AppSearchSchema.DoublePropertyConfig.Builder(@NonNull String);
139    method @NonNull public android.app.appsearch.AppSearchSchema.DoublePropertyConfig build();
140    method @NonNull public android.app.appsearch.AppSearchSchema.DoublePropertyConfig.Builder setCardinality(int);
141    method @NonNull public android.app.appsearch.AppSearchSchema.DoublePropertyConfig.Builder setScoringEnabled(boolean);
142  }
143
144  public static final class AppSearchSchema.EmbeddingPropertyConfig extends android.app.appsearch.AppSearchSchema.PropertyConfig {
145    method public int getIndexingType();
146    method public int getQuantizationType();
147    field public static final int INDEXING_TYPE_NONE = 0; // 0x0
148    field public static final int INDEXING_TYPE_SIMILARITY = 1; // 0x1
149    field public static final int QUANTIZATION_TYPE_8_BIT = 1; // 0x1
150    field public static final int QUANTIZATION_TYPE_NONE = 0; // 0x0
151  }
152
153  public static final class AppSearchSchema.EmbeddingPropertyConfig.Builder {
154    ctor public AppSearchSchema.EmbeddingPropertyConfig.Builder(@NonNull String);
155    method @NonNull public android.app.appsearch.AppSearchSchema.EmbeddingPropertyConfig build();
156    method @NonNull public android.app.appsearch.AppSearchSchema.EmbeddingPropertyConfig.Builder setCardinality(int);
157    method @NonNull public android.app.appsearch.AppSearchSchema.EmbeddingPropertyConfig.Builder setIndexingType(int);
158    method @NonNull public android.app.appsearch.AppSearchSchema.EmbeddingPropertyConfig.Builder setQuantizationType(int);
159  }
160
161  public static final class AppSearchSchema.LongPropertyConfig extends android.app.appsearch.AppSearchSchema.PropertyConfig {
162    method public int getIndexingType();
163    method public boolean isScoringEnabled();
164    field public static final int INDEXING_TYPE_NONE = 0; // 0x0
165    field public static final int INDEXING_TYPE_RANGE = 1; // 0x1
166  }
167
168  public static final class AppSearchSchema.LongPropertyConfig.Builder {
169    ctor public AppSearchSchema.LongPropertyConfig.Builder(@NonNull String);
170    method @NonNull public android.app.appsearch.AppSearchSchema.LongPropertyConfig build();
171    method @NonNull public android.app.appsearch.AppSearchSchema.LongPropertyConfig.Builder setCardinality(int);
172    method @NonNull public android.app.appsearch.AppSearchSchema.LongPropertyConfig.Builder setIndexingType(int);
173    method @NonNull public android.app.appsearch.AppSearchSchema.LongPropertyConfig.Builder setScoringEnabled(boolean);
174  }
175
176  public abstract static class AppSearchSchema.PropertyConfig {
177    method public int getCardinality();
178    method @NonNull public String getName();
179    field public static final int CARDINALITY_OPTIONAL = 2; // 0x2
180    field public static final int CARDINALITY_REPEATED = 1; // 0x1
181    field public static final int CARDINALITY_REQUIRED = 3; // 0x3
182  }
183
184  public static final class AppSearchSchema.StringPropertyConfig extends android.app.appsearch.AppSearchSchema.PropertyConfig {
185    method public int getIndexingType();
186    method public int getJoinableValueType();
187    method public int getTokenizerType();
188    field public static final int INDEXING_TYPE_EXACT_TERMS = 1; // 0x1
189    field public static final int INDEXING_TYPE_NONE = 0; // 0x0
190    field public static final int INDEXING_TYPE_PREFIXES = 2; // 0x2
191    field public static final int JOINABLE_VALUE_TYPE_NONE = 0; // 0x0
192    field public static final int JOINABLE_VALUE_TYPE_QUALIFIED_ID = 1; // 0x1
193    field public static final int TOKENIZER_TYPE_NONE = 0; // 0x0
194    field public static final int TOKENIZER_TYPE_PLAIN = 1; // 0x1
195    field public static final int TOKENIZER_TYPE_RFC822 = 3; // 0x3
196    field public static final int TOKENIZER_TYPE_VERBATIM = 2; // 0x2
197  }
198
199  public static final class AppSearchSchema.StringPropertyConfig.Builder {
200    ctor public AppSearchSchema.StringPropertyConfig.Builder(@NonNull String);
201    method @NonNull public android.app.appsearch.AppSearchSchema.StringPropertyConfig build();
202    method @NonNull public android.app.appsearch.AppSearchSchema.StringPropertyConfig.Builder setCardinality(int);
203    method @NonNull public android.app.appsearch.AppSearchSchema.StringPropertyConfig.Builder setIndexingType(int);
204    method @NonNull public android.app.appsearch.AppSearchSchema.StringPropertyConfig.Builder setJoinableValueType(int);
205    method @NonNull public android.app.appsearch.AppSearchSchema.StringPropertyConfig.Builder setTokenizerType(int);
206  }
207
208  public final class AppSearchSession implements java.io.Closeable {
209    method public void close();
210    method public void commitBlob(@NonNull java.util.Set<android.app.appsearch.AppSearchBlobHandle>, @NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<android.app.appsearch.AppSearchResult<android.app.appsearch.CommitBlobResponse>>);
211    method public void getByDocumentId(@NonNull android.app.appsearch.GetByDocumentIdRequest, @NonNull java.util.concurrent.Executor, @NonNull android.app.appsearch.BatchResultCallback<java.lang.String,android.app.appsearch.GenericDocument>);
212    method public void getNamespaces(@NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<android.app.appsearch.AppSearchResult<java.util.Set<java.lang.String>>>);
213    method public void getSchema(@NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<android.app.appsearch.AppSearchResult<android.app.appsearch.GetSchemaResponse>>);
214    method public void getStorageInfo(@NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<android.app.appsearch.AppSearchResult<android.app.appsearch.StorageInfo>>);
215    method public void openBlobForRead(@NonNull java.util.Set<android.app.appsearch.AppSearchBlobHandle>, @NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<android.app.appsearch.AppSearchResult<android.app.appsearch.OpenBlobForReadResponse>>);
216    method public void openBlobForWrite(@NonNull java.util.Set<android.app.appsearch.AppSearchBlobHandle>, @NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<android.app.appsearch.AppSearchResult<android.app.appsearch.OpenBlobForWriteResponse>>);
217    method public void put(@NonNull android.app.appsearch.PutDocumentsRequest, @NonNull java.util.concurrent.Executor, @NonNull android.app.appsearch.BatchResultCallback<java.lang.String,java.lang.Void>);
218    method public void remove(@NonNull android.app.appsearch.RemoveByDocumentIdRequest, @NonNull java.util.concurrent.Executor, @NonNull android.app.appsearch.BatchResultCallback<java.lang.String,java.lang.Void>);
219    method public void remove(@NonNull String, @NonNull android.app.appsearch.SearchSpec, @NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<android.app.appsearch.AppSearchResult<java.lang.Void>>);
220    method public void removeBlob(@NonNull java.util.Set<android.app.appsearch.AppSearchBlobHandle>, @NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<android.app.appsearch.AppSearchResult<android.app.appsearch.RemoveBlobResponse>>);
221    method public void reportUsage(@NonNull android.app.appsearch.ReportUsageRequest, @NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<android.app.appsearch.AppSearchResult<java.lang.Void>>);
222    method @NonNull public android.app.appsearch.SearchResults search(@NonNull String, @NonNull android.app.appsearch.SearchSpec);
223    method public void searchSuggestion(@NonNull String, @NonNull android.app.appsearch.SearchSuggestionSpec, @NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<android.app.appsearch.AppSearchResult<java.util.List<android.app.appsearch.SearchSuggestionResult>>>);
224    method public void setBlobVisibility(@NonNull android.app.appsearch.SetBlobVisibilityRequest, @NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<android.app.appsearch.AppSearchResult<java.lang.Void>>);
225    method public void setSchema(@NonNull android.app.appsearch.SetSchemaRequest, @NonNull java.util.concurrent.Executor, @NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<android.app.appsearch.AppSearchResult<android.app.appsearch.SetSchemaResponse>>);
226  }
227
228  public interface BatchResultCallback<KeyType, ValueType> {
229    method public void onResult(@NonNull android.app.appsearch.AppSearchBatchResult<KeyType,ValueType>);
230    method public default void onSystemError(@Nullable Throwable);
231  }
232
233  public final class CommitBlobResponse implements android.os.Parcelable {
234    ctor public CommitBlobResponse(@NonNull android.app.appsearch.AppSearchBatchResult<android.app.appsearch.AppSearchBlobHandle,java.lang.Void>);
235    method public final int describeContents();
236    method @NonNull public android.app.appsearch.AppSearchBatchResult<android.app.appsearch.AppSearchBlobHandle,java.lang.Void> getResult();
237    method public void writeToParcel(@NonNull android.os.Parcel, int);
238    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.CommitBlobResponse> CREATOR;
239  }
240
241  public final class EmbeddingVector implements android.os.Parcelable {
242    ctor public EmbeddingVector(@NonNull float[], @NonNull String);
243    method public final int describeContents();
244    method @NonNull public String getModelSignature();
245    method @NonNull public float[] getValues();
246    method public void writeToParcel(@NonNull android.os.Parcel, int);
247    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.EmbeddingVector> CREATOR;
248  }
249
250  public class EnterpriseGlobalSearchSession {
251    method public void getByDocumentId(@NonNull String, @NonNull String, @NonNull android.app.appsearch.GetByDocumentIdRequest, @NonNull java.util.concurrent.Executor, @NonNull android.app.appsearch.BatchResultCallback<java.lang.String,android.app.appsearch.GenericDocument>);
252    method public void getSchema(@NonNull String, @NonNull String, @NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<android.app.appsearch.AppSearchResult<android.app.appsearch.GetSchemaResponse>>);
253    method public void openBlobForRead(@NonNull java.util.Set<android.app.appsearch.AppSearchBlobHandle>, @NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<android.app.appsearch.AppSearchResult<android.app.appsearch.OpenBlobForReadResponse>>);
254    method @NonNull public android.app.appsearch.SearchResults search(@NonNull String, @NonNull android.app.appsearch.SearchSpec);
255  }
256
257  public class GenericDocument {
258    ctor protected GenericDocument(@NonNull android.app.appsearch.GenericDocument);
259    method public long getCreationTimestampMillis();
260    method @NonNull public String getId();
261    method public static int getMaxIndexedProperties();
262    method @NonNull public String getNamespace();
263    method @Nullable public Object getProperty(@NonNull String);
264    method @Nullable public android.app.appsearch.AppSearchBlobHandle getPropertyBlobHandle(@NonNull String);
265    method @Nullable public android.app.appsearch.AppSearchBlobHandle[] getPropertyBlobHandleArray(@NonNull String);
266    method public boolean getPropertyBoolean(@NonNull String);
267    method @Nullable public boolean[] getPropertyBooleanArray(@NonNull String);
268    method @Nullable public byte[] getPropertyBytes(@NonNull String);
269    method @Nullable public byte[][] getPropertyBytesArray(@NonNull String);
270    method @Nullable public android.app.appsearch.GenericDocument getPropertyDocument(@NonNull String);
271    method @Nullable public android.app.appsearch.GenericDocument[] getPropertyDocumentArray(@NonNull String);
272    method public double getPropertyDouble(@NonNull String);
273    method @Nullable public double[] getPropertyDoubleArray(@NonNull String);
274    method @Nullable public android.app.appsearch.EmbeddingVector getPropertyEmbedding(@NonNull String);
275    method @Nullable public android.app.appsearch.EmbeddingVector[] getPropertyEmbeddingArray(@NonNull String);
276    method public long getPropertyLong(@NonNull String);
277    method @Nullable public long[] getPropertyLongArray(@NonNull String);
278    method @NonNull public java.util.Set<java.lang.String> getPropertyNames();
279    method @Nullable public String getPropertyString(@NonNull String);
280    method @Nullable public String[] getPropertyStringArray(@NonNull String);
281    method @NonNull public String getSchemaType();
282    method public int getScore();
283    method public long getTtlMillis();
284  }
285
286  public static class GenericDocument.Builder<BuilderType extends android.app.appsearch.GenericDocument.Builder> {
287    ctor public GenericDocument.Builder(@NonNull String, @NonNull String, @NonNull String);
288    ctor public GenericDocument.Builder(@NonNull android.app.appsearch.GenericDocument);
289    method @NonNull public android.app.appsearch.GenericDocument build();
290    method @NonNull public BuilderType clearProperty(@NonNull String);
291    method @NonNull public BuilderType setCreationTimestampMillis(long);
292    method @NonNull public BuilderType setId(@NonNull String);
293    method @NonNull public BuilderType setNamespace(@NonNull String);
294    method @NonNull public BuilderType setPropertyBlobHandle(@NonNull String, @NonNull android.app.appsearch.AppSearchBlobHandle...);
295    method @NonNull public BuilderType setPropertyBoolean(@NonNull String, @NonNull boolean...);
296    method @NonNull public BuilderType setPropertyBytes(@NonNull String, @NonNull byte[]...);
297    method @NonNull public BuilderType setPropertyDocument(@NonNull String, @NonNull android.app.appsearch.GenericDocument...);
298    method @NonNull public BuilderType setPropertyDouble(@NonNull String, @NonNull double...);
299    method @NonNull public BuilderType setPropertyEmbedding(@NonNull String, @NonNull android.app.appsearch.EmbeddingVector...);
300    method @NonNull public BuilderType setPropertyLong(@NonNull String, @NonNull long...);
301    method @NonNull public BuilderType setPropertyString(@NonNull String, @NonNull java.lang.String...);
302    method @NonNull public BuilderType setSchemaType(@NonNull String);
303    method @NonNull public BuilderType setScore(@IntRange(from=0, to=java.lang.Integer.MAX_VALUE) int);
304    method @NonNull public BuilderType setTtlMillis(long);
305  }
306
307  public final class GetByDocumentIdRequest implements android.os.Parcelable {
308    method public final int describeContents();
309    method @NonNull public java.util.Set<java.lang.String> getIds();
310    method @NonNull public String getNamespace();
311    method @NonNull public java.util.Map<java.lang.String,java.util.List<android.app.appsearch.PropertyPath>> getProjectionPaths();
312    method @NonNull public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getProjections();
313    method public void writeToParcel(@NonNull android.os.Parcel, int);
314    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.GetByDocumentIdRequest> CREATOR;
315    field public static final String PROJECTION_SCHEMA_TYPE_WILDCARD = "*";
316  }
317
318  public static final class GetByDocumentIdRequest.Builder {
319    ctor public GetByDocumentIdRequest.Builder(@NonNull String);
320    method @NonNull public android.app.appsearch.GetByDocumentIdRequest.Builder addIds(@NonNull java.lang.String...);
321    method @NonNull public android.app.appsearch.GetByDocumentIdRequest.Builder addIds(@NonNull java.util.Collection<java.lang.String>);
322    method @NonNull public android.app.appsearch.GetByDocumentIdRequest.Builder addProjection(@NonNull String, @NonNull java.util.Collection<java.lang.String>);
323    method @NonNull public android.app.appsearch.GetByDocumentIdRequest.Builder addProjectionPaths(@NonNull String, @NonNull java.util.Collection<android.app.appsearch.PropertyPath>);
324    method @NonNull public android.app.appsearch.GetByDocumentIdRequest build();
325  }
326
327  public final class GetSchemaResponse implements android.os.Parcelable {
328    method public final int describeContents();
329    method @NonNull public java.util.Map<java.lang.String,android.app.appsearch.PackageIdentifier> getPubliclyVisibleSchemas();
330    method @NonNull public java.util.Map<java.lang.String,java.util.Set<java.util.Set<java.lang.Integer>>> getRequiredPermissionsForSchemaTypeVisibility();
331    method @NonNull public java.util.Set<java.lang.String> getSchemaTypesNotDisplayedBySystem();
332    method @NonNull public java.util.Map<java.lang.String,java.util.Set<android.app.appsearch.SchemaVisibilityConfig>> getSchemaTypesVisibleToConfigs();
333    method @NonNull public java.util.Map<java.lang.String,java.util.Set<android.app.appsearch.PackageIdentifier>> getSchemaTypesVisibleToPackages();
334    method @NonNull public java.util.Set<android.app.appsearch.AppSearchSchema> getSchemas();
335    method @IntRange(from=0) public int getVersion();
336    method public void writeToParcel(@NonNull android.os.Parcel, int);
337    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.GetSchemaResponse> CREATOR;
338  }
339
340  public static final class GetSchemaResponse.Builder {
341    ctor public GetSchemaResponse.Builder();
342    ctor public GetSchemaResponse.Builder(@NonNull android.app.appsearch.GetSchemaResponse);
343    method @NonNull public android.app.appsearch.GetSchemaResponse.Builder addSchema(@NonNull android.app.appsearch.AppSearchSchema);
344    method @NonNull public android.app.appsearch.GetSchemaResponse.Builder addSchemaTypeNotDisplayedBySystem(@NonNull String);
345    method @NonNull public android.app.appsearch.GetSchemaResponse build();
346    method @NonNull public android.app.appsearch.GetSchemaResponse.Builder clearPubliclyVisibleSchema(@NonNull String);
347    method @NonNull public android.app.appsearch.GetSchemaResponse.Builder clearRequiredPermissionsForSchemaTypeVisibility(@NonNull String);
348    method @NonNull public android.app.appsearch.GetSchemaResponse.Builder clearSchemaTypeNotDisplayedBySystem(@NonNull String);
349    method @NonNull public android.app.appsearch.GetSchemaResponse.Builder clearSchemaTypeVisibleToConfigs(@NonNull String);
350    method @NonNull public android.app.appsearch.GetSchemaResponse.Builder clearSchemaTypeVisibleToPackages(@NonNull String);
351    method @NonNull public android.app.appsearch.GetSchemaResponse.Builder clearSchemas();
352    method @NonNull public android.app.appsearch.GetSchemaResponse.Builder setPubliclyVisibleSchema(@NonNull String, @NonNull android.app.appsearch.PackageIdentifier);
353    method @NonNull public android.app.appsearch.GetSchemaResponse.Builder setRequiredPermissionsForSchemaTypeVisibility(@NonNull String, @NonNull java.util.Set<java.util.Set<java.lang.Integer>>);
354    method @NonNull public android.app.appsearch.GetSchemaResponse.Builder setSchemaTypeVisibleToConfigs(@NonNull String, @NonNull java.util.Set<android.app.appsearch.SchemaVisibilityConfig>);
355    method @NonNull public android.app.appsearch.GetSchemaResponse.Builder setSchemaTypeVisibleToPackages(@NonNull String, @NonNull java.util.Set<android.app.appsearch.PackageIdentifier>);
356    method @NonNull public android.app.appsearch.GetSchemaResponse.Builder setVersion(@IntRange(from=0) int);
357  }
358
359  public class GlobalSearchSession implements java.io.Closeable {
360    method public void close();
361    method public void getByDocumentId(@NonNull String, @NonNull String, @NonNull android.app.appsearch.GetByDocumentIdRequest, @NonNull java.util.concurrent.Executor, @NonNull android.app.appsearch.BatchResultCallback<java.lang.String,android.app.appsearch.GenericDocument>);
362    method public void getSchema(@NonNull String, @NonNull String, @NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<android.app.appsearch.AppSearchResult<android.app.appsearch.GetSchemaResponse>>);
363    method public void openBlobForRead(@NonNull java.util.Set<android.app.appsearch.AppSearchBlobHandle>, @NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<android.app.appsearch.AppSearchResult<android.app.appsearch.OpenBlobForReadResponse>>);
364    method public void registerObserverCallback(@NonNull String, @NonNull android.app.appsearch.observer.ObserverSpec, @NonNull java.util.concurrent.Executor, @NonNull android.app.appsearch.observer.ObserverCallback) throws android.app.appsearch.exceptions.AppSearchException;
365    method public void reportSystemUsage(@NonNull android.app.appsearch.ReportSystemUsageRequest, @NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<android.app.appsearch.AppSearchResult<java.lang.Void>>);
366    method @NonNull public android.app.appsearch.SearchResults search(@NonNull String, @NonNull android.app.appsearch.SearchSpec);
367    method public void unregisterObserverCallback(@NonNull String, @NonNull android.app.appsearch.observer.ObserverCallback) throws android.app.appsearch.exceptions.AppSearchException;
368  }
369
370  public final class JoinSpec implements android.os.Parcelable {
371    method public final int describeContents();
372    method public int getAggregationScoringStrategy();
373    method @NonNull public String getChildPropertyExpression();
374    method public int getMaxJoinedResultCount();
375    method @NonNull public String getNestedQuery();
376    method @NonNull public android.app.appsearch.SearchSpec getNestedSearchSpec();
377    method public void writeToParcel(@NonNull android.os.Parcel, int);
378    field public static final int AGGREGATION_SCORING_AVG_RANKING_SIGNAL = 3; // 0x3
379    field public static final int AGGREGATION_SCORING_MAX_RANKING_SIGNAL = 4; // 0x4
380    field public static final int AGGREGATION_SCORING_MIN_RANKING_SIGNAL = 2; // 0x2
381    field public static final int AGGREGATION_SCORING_OUTER_RESULT_RANKING_SIGNAL = 0; // 0x0
382    field public static final int AGGREGATION_SCORING_RESULT_COUNT = 1; // 0x1
383    field public static final int AGGREGATION_SCORING_SUM_RANKING_SIGNAL = 5; // 0x5
384    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.JoinSpec> CREATOR;
385  }
386
387  public static final class JoinSpec.Builder {
388    ctor public JoinSpec.Builder(@NonNull String);
389    ctor public JoinSpec.Builder(@NonNull android.app.appsearch.JoinSpec);
390    method @NonNull public android.app.appsearch.JoinSpec build();
391    method @NonNull public android.app.appsearch.JoinSpec.Builder setAggregationScoringStrategy(int);
392    method @NonNull public android.app.appsearch.JoinSpec.Builder setChildPropertyExpression(@NonNull String);
393    method @NonNull public android.app.appsearch.JoinSpec.Builder setMaxJoinedResultCount(int);
394    method @NonNull public android.app.appsearch.JoinSpec.Builder setNestedSearch(@NonNull String, @NonNull android.app.appsearch.SearchSpec);
395  }
396
397  public abstract class Migrator {
398    ctor public Migrator();
399    method @NonNull @WorkerThread public abstract android.app.appsearch.GenericDocument onDowngrade(int, int, @NonNull android.app.appsearch.GenericDocument);
400    method @NonNull @WorkerThread public abstract android.app.appsearch.GenericDocument onUpgrade(int, int, @NonNull android.app.appsearch.GenericDocument);
401    method public abstract boolean shouldMigrate(int, int);
402  }
403
404  public final class OpenBlobForReadResponse implements java.io.Closeable android.os.Parcelable {
405    ctor public OpenBlobForReadResponse(@NonNull android.app.appsearch.AppSearchBatchResult<android.app.appsearch.AppSearchBlobHandle,android.os.ParcelFileDescriptor>);
406    method public void close();
407    method public final int describeContents();
408    method @NonNull public android.app.appsearch.AppSearchBatchResult<android.app.appsearch.AppSearchBlobHandle,android.os.ParcelFileDescriptor> getResult();
409    method public void writeToParcel(@NonNull android.os.Parcel, int);
410    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.OpenBlobForReadResponse> CREATOR;
411  }
412
413  public final class OpenBlobForWriteResponse implements java.io.Closeable android.os.Parcelable {
414    ctor public OpenBlobForWriteResponse(@NonNull android.app.appsearch.AppSearchBatchResult<android.app.appsearch.AppSearchBlobHandle,android.os.ParcelFileDescriptor>);
415    method public void close();
416    method public final int describeContents();
417    method @NonNull public android.app.appsearch.AppSearchBatchResult<android.app.appsearch.AppSearchBlobHandle,android.os.ParcelFileDescriptor> getResult();
418    method public void writeToParcel(@NonNull android.os.Parcel, int);
419    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.OpenBlobForWriteResponse> CREATOR;
420  }
421
422  public class PackageIdentifier {
423    ctor public PackageIdentifier(@NonNull String, @NonNull byte[]);
424    method @NonNull public String getPackageName();
425    method @NonNull public byte[] getSha256Certificate();
426  }
427
428  public class PropertyPath implements java.lang.Iterable<android.app.appsearch.PropertyPath.PathSegment> {
429    ctor public PropertyPath(@NonNull java.util.List<android.app.appsearch.PropertyPath.PathSegment>);
430    ctor public PropertyPath(@NonNull String);
431    method @NonNull public android.app.appsearch.PropertyPath.PathSegment get(int);
432    method @NonNull public java.util.Iterator<android.app.appsearch.PropertyPath.PathSegment> iterator();
433    method public int size();
434  }
435
436  public static class PropertyPath.PathSegment {
437    method @NonNull public static android.app.appsearch.PropertyPath.PathSegment create(@NonNull String, int);
438    method @NonNull public static android.app.appsearch.PropertyPath.PathSegment create(@NonNull String);
439    method public int getPropertyIndex();
440    method @NonNull public String getPropertyName();
441    field public static final int NON_REPEATED_CARDINALITY = -1; // 0xffffffff
442  }
443
444  public final class PutDocumentsRequest {
445    method @NonNull public java.util.List<android.app.appsearch.GenericDocument> getGenericDocuments();
446    method @NonNull public java.util.List<android.app.appsearch.GenericDocument> getTakenActionGenericDocuments();
447  }
448
449  public static final class PutDocumentsRequest.Builder {
450    ctor public PutDocumentsRequest.Builder();
451    method @NonNull public android.app.appsearch.PutDocumentsRequest.Builder addGenericDocuments(@NonNull android.app.appsearch.GenericDocument...);
452    method @NonNull public android.app.appsearch.PutDocumentsRequest.Builder addGenericDocuments(@NonNull java.util.Collection<? extends android.app.appsearch.GenericDocument>);
453    method @NonNull public android.app.appsearch.PutDocumentsRequest.Builder addTakenActionGenericDocuments(@NonNull android.app.appsearch.GenericDocument...) throws android.app.appsearch.exceptions.AppSearchException;
454    method @NonNull public android.app.appsearch.PutDocumentsRequest.Builder addTakenActionGenericDocuments(@NonNull java.util.Collection<? extends android.app.appsearch.GenericDocument>) throws android.app.appsearch.exceptions.AppSearchException;
455    method @NonNull public android.app.appsearch.PutDocumentsRequest build();
456  }
457
458  public final class RemoveBlobResponse implements android.os.Parcelable {
459    ctor public RemoveBlobResponse(@NonNull android.app.appsearch.AppSearchBatchResult<android.app.appsearch.AppSearchBlobHandle,java.lang.Void>);
460    method public final int describeContents();
461    method @NonNull public android.app.appsearch.AppSearchBatchResult<android.app.appsearch.AppSearchBlobHandle,java.lang.Void> getResult();
462    method public void writeToParcel(@NonNull android.os.Parcel, int);
463    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.RemoveBlobResponse> CREATOR;
464  }
465
466  public final class RemoveByDocumentIdRequest implements android.os.Parcelable {
467    method public final int describeContents();
468    method @NonNull public java.util.Set<java.lang.String> getIds();
469    method @NonNull public String getNamespace();
470    method public void writeToParcel(@NonNull android.os.Parcel, int);
471    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.RemoveByDocumentIdRequest> CREATOR;
472  }
473
474  public static final class RemoveByDocumentIdRequest.Builder {
475    ctor public RemoveByDocumentIdRequest.Builder(@NonNull String);
476    method @NonNull public android.app.appsearch.RemoveByDocumentIdRequest.Builder addIds(@NonNull java.lang.String...);
477    method @NonNull public android.app.appsearch.RemoveByDocumentIdRequest.Builder addIds(@NonNull java.util.Collection<java.lang.String>);
478    method @NonNull public android.app.appsearch.RemoveByDocumentIdRequest build();
479  }
480
481  public final class ReportSystemUsageRequest {
482    method @NonNull public String getDatabaseName();
483    method @NonNull public String getDocumentId();
484    method @NonNull public String getNamespace();
485    method @NonNull public String getPackageName();
486    method public long getUsageTimestampMillis();
487  }
488
489  public static final class ReportSystemUsageRequest.Builder {
490    ctor public ReportSystemUsageRequest.Builder(@NonNull String, @NonNull String, @NonNull String, @NonNull String);
491    method @NonNull public android.app.appsearch.ReportSystemUsageRequest build();
492    method @NonNull public android.app.appsearch.ReportSystemUsageRequest.Builder setUsageTimestampMillis(long);
493  }
494
495  public final class ReportUsageRequest implements android.os.Parcelable {
496    method public final int describeContents();
497    method @NonNull public String getDocumentId();
498    method @NonNull public String getNamespace();
499    method public long getUsageTimestampMillis();
500    method public void writeToParcel(@NonNull android.os.Parcel, int);
501    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.ReportUsageRequest> CREATOR;
502  }
503
504  public static final class ReportUsageRequest.Builder {
505    ctor public ReportUsageRequest.Builder(@NonNull String, @NonNull String);
506    method @NonNull public android.app.appsearch.ReportUsageRequest build();
507    method @NonNull public android.app.appsearch.ReportUsageRequest.Builder setUsageTimestampMillis(long);
508  }
509
510  public final class SchemaVisibilityConfig implements android.os.Parcelable {
511    method public final int describeContents();
512    method @NonNull public java.util.List<android.app.appsearch.PackageIdentifier> getAllowedPackages();
513    method @Nullable public android.app.appsearch.PackageIdentifier getPubliclyVisibleTargetPackage();
514    method @NonNull public java.util.Set<java.util.Set<java.lang.Integer>> getRequiredPermissions();
515    method public void writeToParcel(@NonNull android.os.Parcel, int);
516    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.SchemaVisibilityConfig> CREATOR;
517  }
518
519  public static final class SchemaVisibilityConfig.Builder {
520    ctor public SchemaVisibilityConfig.Builder();
521    method @NonNull public android.app.appsearch.SchemaVisibilityConfig.Builder addAllowedPackage(@NonNull android.app.appsearch.PackageIdentifier);
522    method @NonNull public android.app.appsearch.SchemaVisibilityConfig.Builder addRequiredPermissions(@NonNull java.util.Set<java.lang.Integer>);
523    method @NonNull public android.app.appsearch.SchemaVisibilityConfig build();
524    method @NonNull public android.app.appsearch.SchemaVisibilityConfig.Builder clearAllowedPackages();
525    method @NonNull public android.app.appsearch.SchemaVisibilityConfig.Builder clearRequiredPermissions();
526    method @NonNull public android.app.appsearch.SchemaVisibilityConfig.Builder setPubliclyVisibleTargetPackage(@Nullable android.app.appsearch.PackageIdentifier);
527  }
528
529  public final class SearchResult implements android.os.Parcelable {
530    method public final int describeContents();
531    method @NonNull public String getDatabaseName();
532    method @NonNull public android.app.appsearch.GenericDocument getGenericDocument();
533    method @NonNull public java.util.List<java.lang.Double> getInformationalRankingSignals();
534    method @NonNull public java.util.List<android.app.appsearch.SearchResult> getJoinedResults();
535    method @NonNull public java.util.List<android.app.appsearch.SearchResult.MatchInfo> getMatchInfos();
536    method @NonNull public String getPackageName();
537    method @NonNull public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getParentTypeMap();
538    method public double getRankingSignal();
539    method public void writeToParcel(@NonNull android.os.Parcel, int);
540    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.SearchResult> CREATOR;
541  }
542
543  public static final class SearchResult.Builder {
544    ctor public SearchResult.Builder(@NonNull String, @NonNull String);
545    method @NonNull public android.app.appsearch.SearchResult.Builder addInformationalRankingSignal(double);
546    method @NonNull public android.app.appsearch.SearchResult.Builder addJoinedResult(@NonNull android.app.appsearch.SearchResult);
547    method @NonNull public android.app.appsearch.SearchResult.Builder addMatchInfo(@NonNull android.app.appsearch.SearchResult.MatchInfo);
548    method @NonNull public android.app.appsearch.SearchResult build();
549    method @NonNull public android.app.appsearch.SearchResult.Builder setGenericDocument(@NonNull android.app.appsearch.GenericDocument);
550    method @NonNull public android.app.appsearch.SearchResult.Builder setParentTypeMap(@NonNull java.util.Map<java.lang.String,java.util.List<java.lang.String>>);
551    method @NonNull public android.app.appsearch.SearchResult.Builder setRankingSignal(double);
552  }
553
554  public static final class SearchResult.MatchInfo implements android.os.Parcelable {
555    method public final int describeContents();
556    method @NonNull public CharSequence getExactMatch();
557    method @NonNull public android.app.appsearch.SearchResult.MatchRange getExactMatchRange();
558    method @NonNull public String getFullText();
559    method @NonNull public String getPropertyPath();
560    method @NonNull public android.app.appsearch.PropertyPath getPropertyPathObject();
561    method @NonNull public CharSequence getSnippet();
562    method @NonNull public android.app.appsearch.SearchResult.MatchRange getSnippetRange();
563    method @NonNull public CharSequence getSubmatch();
564    method @NonNull public android.app.appsearch.SearchResult.MatchRange getSubmatchRange();
565    method public void writeToParcel(@NonNull android.os.Parcel, int);
566    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.SearchResult.MatchInfo> CREATOR;
567  }
568
569  public static final class SearchResult.MatchInfo.Builder {
570    ctor public SearchResult.MatchInfo.Builder(@NonNull String);
571    method @NonNull public android.app.appsearch.SearchResult.MatchInfo build();
572    method @NonNull public android.app.appsearch.SearchResult.MatchInfo.Builder setExactMatchRange(@NonNull android.app.appsearch.SearchResult.MatchRange);
573    method @NonNull public android.app.appsearch.SearchResult.MatchInfo.Builder setSnippetRange(@NonNull android.app.appsearch.SearchResult.MatchRange);
574    method @NonNull public android.app.appsearch.SearchResult.MatchInfo.Builder setSubmatchRange(@NonNull android.app.appsearch.SearchResult.MatchRange);
575  }
576
577  public static final class SearchResult.MatchRange {
578    ctor public SearchResult.MatchRange(int, int);
579    method public int getEnd();
580    method public int getStart();
581  }
582
583  public class SearchResults implements java.io.Closeable {
584    method public void close();
585    method public void getNextPage(@NonNull java.util.concurrent.Executor, @NonNull java.util.function.Consumer<android.app.appsearch.AppSearchResult<java.util.List<android.app.appsearch.SearchResult>>>);
586  }
587
588  public final class SearchSpec implements android.os.Parcelable {
589    method public final int describeContents();
590    method @NonNull public String getAdvancedRankingExpression();
591    method public int getDefaultEmbeddingSearchMetricType();
592    method @NonNull public java.util.List<android.app.appsearch.EmbeddingVector> getEmbeddingParameters();
593    method @NonNull public java.util.List<java.lang.String> getFilterDocumentIds();
594    method @NonNull public java.util.List<java.lang.String> getFilterNamespaces();
595    method @NonNull public java.util.List<java.lang.String> getFilterPackageNames();
596    method @NonNull public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getFilterProperties();
597    method @NonNull public java.util.List<java.lang.String> getFilterSchemas();
598    method @NonNull public java.util.List<java.lang.String> getInformationalRankingExpressions();
599    method @Nullable public android.app.appsearch.JoinSpec getJoinSpec();
600    method public int getMaxSnippetSize();
601    method public int getOrder();
602    method @NonNull public java.util.Map<java.lang.String,java.util.List<android.app.appsearch.PropertyPath>> getProjectionPaths();
603    method @NonNull public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getProjections();
604    method @NonNull public java.util.Map<java.lang.String,java.util.Map<android.app.appsearch.PropertyPath,java.lang.Double>> getPropertyWeightPaths();
605    method @NonNull public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.Double>> getPropertyWeights();
606    method public int getRankingStrategy();
607    method public int getResultCountPerPage();
608    method public int getResultGroupingLimit();
609    method public int getResultGroupingTypeFlags();
610    method @Nullable public String getSearchSourceLogTag();
611    method @NonNull public java.util.List<java.lang.String> getSearchStringParameters();
612    method public int getSnippetCount();
613    method public int getSnippetCountPerProperty();
614    method public int getTermMatch();
615    method public boolean isListFilterHasPropertyFunctionEnabled();
616    method public boolean isListFilterMatchScoreExpressionFunctionEnabled();
617    method public boolean isListFilterQueryLanguageEnabled();
618    method public boolean isNumericSearchEnabled();
619    method public boolean isScorablePropertyRankingEnabled();
620    method public boolean isVerbatimSearchEnabled();
621    method public void writeToParcel(@NonNull android.os.Parcel, int);
622    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.SearchSpec> CREATOR;
623    field public static final int EMBEDDING_SEARCH_METRIC_TYPE_COSINE = 1; // 0x1
624    field public static final int EMBEDDING_SEARCH_METRIC_TYPE_DEFAULT = 0; // 0x0
625    field public static final int EMBEDDING_SEARCH_METRIC_TYPE_DOT_PRODUCT = 2; // 0x2
626    field public static final int EMBEDDING_SEARCH_METRIC_TYPE_EUCLIDEAN = 3; // 0x3
627    field public static final int GROUPING_TYPE_PER_NAMESPACE = 2; // 0x2
628    field public static final int GROUPING_TYPE_PER_PACKAGE = 1; // 0x1
629    field public static final int GROUPING_TYPE_PER_SCHEMA = 4; // 0x4
630    field public static final int ORDER_ASCENDING = 1; // 0x1
631    field public static final int ORDER_DESCENDING = 0; // 0x0
632    field @Deprecated public static final String PROJECTION_SCHEMA_TYPE_WILDCARD = "*";
633    field public static final int RANKING_STRATEGY_ADVANCED_RANKING_EXPRESSION = 9; // 0x9
634    field public static final int RANKING_STRATEGY_CREATION_TIMESTAMP = 2; // 0x2
635    field public static final int RANKING_STRATEGY_DOCUMENT_SCORE = 1; // 0x1
636    field public static final int RANKING_STRATEGY_JOIN_AGGREGATE_SCORE = 8; // 0x8
637    field public static final int RANKING_STRATEGY_NONE = 0; // 0x0
638    field public static final int RANKING_STRATEGY_RELEVANCE_SCORE = 3; // 0x3
639    field public static final int RANKING_STRATEGY_SYSTEM_USAGE_COUNT = 6; // 0x6
640    field public static final int RANKING_STRATEGY_SYSTEM_USAGE_LAST_USED_TIMESTAMP = 7; // 0x7
641    field public static final int RANKING_STRATEGY_USAGE_COUNT = 4; // 0x4
642    field public static final int RANKING_STRATEGY_USAGE_LAST_USED_TIMESTAMP = 5; // 0x5
643    field public static final String SCHEMA_TYPE_WILDCARD = "*";
644    field public static final int TERM_MATCH_EXACT_ONLY = 1; // 0x1
645    field public static final int TERM_MATCH_PREFIX = 2; // 0x2
646  }
647
648  public static final class SearchSpec.Builder {
649    ctor public SearchSpec.Builder();
650    ctor public SearchSpec.Builder(@NonNull android.app.appsearch.SearchSpec);
651    method @NonNull public android.app.appsearch.SearchSpec.Builder addEmbeddingParameters(@NonNull android.app.appsearch.EmbeddingVector...);
652    method @NonNull public android.app.appsearch.SearchSpec.Builder addEmbeddingParameters(@NonNull java.util.Collection<android.app.appsearch.EmbeddingVector>);
653    method @NonNull public android.app.appsearch.SearchSpec.Builder addFilterDocumentIds(@NonNull java.lang.String...);
654    method @NonNull public android.app.appsearch.SearchSpec.Builder addFilterDocumentIds(@NonNull java.util.Collection<java.lang.String>);
655    method @NonNull public android.app.appsearch.SearchSpec.Builder addFilterNamespaces(@NonNull java.lang.String...);
656    method @NonNull public android.app.appsearch.SearchSpec.Builder addFilterNamespaces(@NonNull java.util.Collection<java.lang.String>);
657    method @NonNull public android.app.appsearch.SearchSpec.Builder addFilterPackageNames(@NonNull java.lang.String...);
658    method @NonNull public android.app.appsearch.SearchSpec.Builder addFilterPackageNames(@NonNull java.util.Collection<java.lang.String>);
659    method @NonNull public android.app.appsearch.SearchSpec.Builder addFilterProperties(@NonNull String, @NonNull java.util.Collection<java.lang.String>);
660    method @NonNull public android.app.appsearch.SearchSpec.Builder addFilterPropertyPaths(@NonNull String, @NonNull java.util.Collection<android.app.appsearch.PropertyPath>);
661    method @NonNull public android.app.appsearch.SearchSpec.Builder addFilterSchemas(@NonNull java.lang.String...);
662    method @NonNull public android.app.appsearch.SearchSpec.Builder addFilterSchemas(@NonNull java.util.Collection<java.lang.String>);
663    method @NonNull public android.app.appsearch.SearchSpec.Builder addInformationalRankingExpressions(@NonNull java.lang.String...);
664    method @NonNull public android.app.appsearch.SearchSpec.Builder addInformationalRankingExpressions(@NonNull java.util.Collection<java.lang.String>);
665    method @NonNull public android.app.appsearch.SearchSpec.Builder addProjection(@NonNull String, @NonNull java.util.Collection<java.lang.String>);
666    method @NonNull public android.app.appsearch.SearchSpec.Builder addProjectionPaths(@NonNull String, @NonNull java.util.Collection<android.app.appsearch.PropertyPath>);
667    method @NonNull public android.app.appsearch.SearchSpec.Builder addSearchStringParameters(@NonNull java.lang.String...);
668    method @NonNull public android.app.appsearch.SearchSpec.Builder addSearchStringParameters(@NonNull java.util.List<java.lang.String>);
669    method @NonNull public android.app.appsearch.SearchSpec build();
670    method @NonNull public android.app.appsearch.SearchSpec.Builder clearEmbeddingParameters();
671    method @NonNull public android.app.appsearch.SearchSpec.Builder clearFilterDocumentIds();
672    method @NonNull public android.app.appsearch.SearchSpec.Builder clearFilterNamespaces();
673    method @NonNull public android.app.appsearch.SearchSpec.Builder clearFilterPackageNames();
674    method @NonNull public android.app.appsearch.SearchSpec.Builder clearFilterProperties();
675    method @NonNull public android.app.appsearch.SearchSpec.Builder clearFilterSchemas();
676    method @NonNull public android.app.appsearch.SearchSpec.Builder clearInformationalRankingExpressions();
677    method @NonNull public android.app.appsearch.SearchSpec.Builder clearJoinSpec();
678    method @NonNull public android.app.appsearch.SearchSpec.Builder clearProjections();
679    method @NonNull public android.app.appsearch.SearchSpec.Builder clearPropertyWeights();
680    method @NonNull public android.app.appsearch.SearchSpec.Builder clearResultGrouping();
681    method @NonNull public android.app.appsearch.SearchSpec.Builder clearSearchSourceLogTag();
682    method @NonNull public android.app.appsearch.SearchSpec.Builder clearSearchStringParameters();
683    method @NonNull public android.app.appsearch.SearchSpec.Builder setDefaultEmbeddingSearchMetricType(int);
684    method @NonNull public android.app.appsearch.SearchSpec.Builder setJoinSpec(@NonNull android.app.appsearch.JoinSpec);
685    method @NonNull public android.app.appsearch.SearchSpec.Builder setListFilterHasPropertyFunctionEnabled(boolean);
686    method @NonNull public android.app.appsearch.SearchSpec.Builder setListFilterMatchScoreExpressionFunctionEnabled(boolean);
687    method @NonNull public android.app.appsearch.SearchSpec.Builder setListFilterQueryLanguageEnabled(boolean);
688    method @NonNull public android.app.appsearch.SearchSpec.Builder setMaxSnippetSize(@IntRange(from=0, to=0x2710) int);
689    method @NonNull public android.app.appsearch.SearchSpec.Builder setNumericSearchEnabled(boolean);
690    method @NonNull public android.app.appsearch.SearchSpec.Builder setOrder(int);
691    method @NonNull public android.app.appsearch.SearchSpec.Builder setPropertyWeightPaths(@NonNull String, @NonNull java.util.Map<android.app.appsearch.PropertyPath,java.lang.Double>);
692    method @NonNull public android.app.appsearch.SearchSpec.Builder setPropertyWeights(@NonNull String, @NonNull java.util.Map<java.lang.String,java.lang.Double>);
693    method @NonNull public android.app.appsearch.SearchSpec.Builder setRankingStrategy(int);
694    method @NonNull public android.app.appsearch.SearchSpec.Builder setRankingStrategy(@NonNull String);
695    method @NonNull public android.app.appsearch.SearchSpec.Builder setResultCountPerPage(@IntRange(from=0, to=0x2710) int);
696    method @NonNull public android.app.appsearch.SearchSpec.Builder setResultGrouping(int, int);
697    method @NonNull public android.app.appsearch.SearchSpec.Builder setScorablePropertyRankingEnabled(boolean);
698    method @NonNull public android.app.appsearch.SearchSpec.Builder setSearchSourceLogTag(@NonNull String);
699    method @NonNull public android.app.appsearch.SearchSpec.Builder setSnippetCount(@IntRange(from=0, to=0x2710) int);
700    method @NonNull public android.app.appsearch.SearchSpec.Builder setSnippetCountPerProperty(@IntRange(from=0, to=0x2710) int);
701    method @NonNull public android.app.appsearch.SearchSpec.Builder setTermMatch(int);
702    method @NonNull public android.app.appsearch.SearchSpec.Builder setVerbatimSearchEnabled(boolean);
703  }
704
705  public final class SearchSuggestionResult implements android.os.Parcelable {
706    method public final int describeContents();
707    method @NonNull public String getSuggestedResult();
708    method public void writeToParcel(@NonNull android.os.Parcel, int);
709    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.SearchSuggestionResult> CREATOR;
710  }
711
712  public static final class SearchSuggestionResult.Builder {
713    ctor public SearchSuggestionResult.Builder();
714    method @NonNull public android.app.appsearch.SearchSuggestionResult build();
715    method @NonNull public android.app.appsearch.SearchSuggestionResult.Builder setSuggestedResult(@NonNull String);
716  }
717
718  public final class SearchSuggestionSpec implements android.os.Parcelable {
719    method public final int describeContents();
720    method @NonNull public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getFilterDocumentIds();
721    method @NonNull public java.util.List<java.lang.String> getFilterNamespaces();
722    method @NonNull public java.util.Map<java.lang.String,java.util.List<java.lang.String>> getFilterProperties();
723    method @NonNull public java.util.List<java.lang.String> getFilterSchemas();
724    method public int getMaximumResultCount();
725    method public int getRankingStrategy();
726    method @NonNull public java.util.List<java.lang.String> getSearchStringParameters();
727    method public void writeToParcel(@NonNull android.os.Parcel, int);
728    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.SearchSuggestionSpec> CREATOR;
729    field public static final int SUGGESTION_RANKING_STRATEGY_DOCUMENT_COUNT = 0; // 0x0
730    field public static final int SUGGESTION_RANKING_STRATEGY_NONE = 2; // 0x2
731    field public static final int SUGGESTION_RANKING_STRATEGY_TERM_FREQUENCY = 1; // 0x1
732  }
733
734  public static final class SearchSuggestionSpec.Builder {
735    ctor public SearchSuggestionSpec.Builder(@IntRange(from=1) int);
736    method @NonNull public android.app.appsearch.SearchSuggestionSpec.Builder addFilterDocumentIds(@NonNull String, @NonNull java.lang.String...);
737    method @NonNull public android.app.appsearch.SearchSuggestionSpec.Builder addFilterDocumentIds(@NonNull String, @NonNull java.util.Collection<java.lang.String>);
738    method @NonNull public android.app.appsearch.SearchSuggestionSpec.Builder addFilterNamespaces(@NonNull java.lang.String...);
739    method @NonNull public android.app.appsearch.SearchSuggestionSpec.Builder addFilterNamespaces(@NonNull java.util.Collection<java.lang.String>);
740    method @NonNull public android.app.appsearch.SearchSuggestionSpec.Builder addFilterProperties(@NonNull String, @NonNull java.util.Collection<java.lang.String>);
741    method @NonNull public android.app.appsearch.SearchSuggestionSpec.Builder addFilterPropertyPaths(@NonNull String, @NonNull java.util.Collection<android.app.appsearch.PropertyPath>);
742    method @NonNull public android.app.appsearch.SearchSuggestionSpec.Builder addFilterSchemas(@NonNull java.lang.String...);
743    method @NonNull public android.app.appsearch.SearchSuggestionSpec.Builder addFilterSchemas(@NonNull java.util.Collection<java.lang.String>);
744    method @NonNull public android.app.appsearch.SearchSuggestionSpec.Builder addSearchStringParameters(@NonNull java.lang.String...);
745    method @NonNull public android.app.appsearch.SearchSuggestionSpec.Builder addSearchStringParameters(@NonNull java.util.List<java.lang.String>);
746    method @NonNull public android.app.appsearch.SearchSuggestionSpec build();
747    method @NonNull public android.app.appsearch.SearchSuggestionSpec.Builder setRankingStrategy(int);
748  }
749
750  public class SetBlobVisibilityRequest {
751    method @NonNull public java.util.Set<java.lang.String> getNamespacesNotDisplayedBySystem();
752    method @NonNull public java.util.Map<java.lang.String,java.util.Set<android.app.appsearch.SchemaVisibilityConfig>> getNamespacesVisibleToConfigs();
753  }
754
755  public static final class SetBlobVisibilityRequest.Builder {
756    ctor public SetBlobVisibilityRequest.Builder();
757    method @NonNull public android.app.appsearch.SetBlobVisibilityRequest.Builder addNamespaceVisibleToConfig(@NonNull String, @NonNull android.app.appsearch.SchemaVisibilityConfig);
758    method @NonNull public android.app.appsearch.SetBlobVisibilityRequest build();
759    method @NonNull public android.app.appsearch.SetBlobVisibilityRequest.Builder clearNamespaceVisibleToConfigs(@NonNull String);
760    method @NonNull public android.app.appsearch.SetBlobVisibilityRequest.Builder setNamespaceDisplayedBySystem(@NonNull String, boolean);
761  }
762
763  public final class SetSchemaRequest {
764    method @NonNull public java.util.Map<java.lang.String,android.app.appsearch.Migrator> getMigrators();
765    method @NonNull public java.util.Map<java.lang.String,android.app.appsearch.PackageIdentifier> getPubliclyVisibleSchemas();
766    method @NonNull public java.util.Map<java.lang.String,java.util.Set<java.util.Set<java.lang.Integer>>> getRequiredPermissionsForSchemaTypeVisibility();
767    method @NonNull public java.util.Set<android.app.appsearch.AppSearchSchema> getSchemas();
768    method @NonNull public java.util.Set<java.lang.String> getSchemasNotDisplayedBySystem();
769    method @NonNull public java.util.Map<java.lang.String,java.util.Set<android.app.appsearch.SchemaVisibilityConfig>> getSchemasVisibleToConfigs();
770    method @NonNull public java.util.Map<java.lang.String,java.util.Set<android.app.appsearch.PackageIdentifier>> getSchemasVisibleToPackages();
771    method @IntRange(from=1) public int getVersion();
772    method public boolean isForceOverride();
773    field public static final int READ_ASSISTANT_APP_SEARCH_DATA = 6; // 0x6
774    field public static final int READ_CALENDAR = 2; // 0x2
775    field public static final int READ_CONTACTS = 3; // 0x3
776    field public static final int READ_EXTERNAL_STORAGE = 4; // 0x4
777    field public static final int READ_HOME_APP_SEARCH_DATA = 5; // 0x5
778    field public static final int READ_SMS = 1; // 0x1
779  }
780
781  public static final class SetSchemaRequest.Builder {
782    ctor public SetSchemaRequest.Builder();
783    ctor public SetSchemaRequest.Builder(@NonNull android.app.appsearch.SetSchemaRequest);
784    method @NonNull public android.app.appsearch.SetSchemaRequest.Builder addRequiredPermissionsForSchemaTypeVisibility(@NonNull String, @NonNull java.util.Set<java.lang.Integer>);
785    method @NonNull public android.app.appsearch.SetSchemaRequest.Builder addSchemaTypeVisibleToConfig(@NonNull String, @NonNull android.app.appsearch.SchemaVisibilityConfig);
786    method @NonNull public android.app.appsearch.SetSchemaRequest.Builder addSchemas(@NonNull android.app.appsearch.AppSearchSchema...);
787    method @NonNull public android.app.appsearch.SetSchemaRequest.Builder addSchemas(@NonNull java.util.Collection<android.app.appsearch.AppSearchSchema>);
788    method @NonNull public android.app.appsearch.SetSchemaRequest build();
789    method @NonNull public android.app.appsearch.SetSchemaRequest.Builder clearMigrators();
790    method @NonNull public android.app.appsearch.SetSchemaRequest.Builder clearRequiredPermissionsForSchemaTypeVisibility(@NonNull String);
791    method @NonNull public android.app.appsearch.SetSchemaRequest.Builder clearSchemaTypeVisibleToConfigs(@NonNull String);
792    method @NonNull public android.app.appsearch.SetSchemaRequest.Builder clearSchemas();
793    method @NonNull public android.app.appsearch.SetSchemaRequest.Builder setForceOverride(boolean);
794    method @NonNull public android.app.appsearch.SetSchemaRequest.Builder setMigrator(@NonNull String, @NonNull android.app.appsearch.Migrator);
795    method @NonNull public android.app.appsearch.SetSchemaRequest.Builder setMigrators(@NonNull java.util.Map<java.lang.String,android.app.appsearch.Migrator>);
796    method @NonNull public android.app.appsearch.SetSchemaRequest.Builder setPubliclyVisibleSchema(@NonNull String, @Nullable android.app.appsearch.PackageIdentifier);
797    method @NonNull public android.app.appsearch.SetSchemaRequest.Builder setSchemaTypeDisplayedBySystem(@NonNull String, boolean);
798    method @NonNull public android.app.appsearch.SetSchemaRequest.Builder setSchemaTypeVisibilityForPackage(@NonNull String, boolean, @NonNull android.app.appsearch.PackageIdentifier);
799    method @NonNull public android.app.appsearch.SetSchemaRequest.Builder setVersion(@IntRange(from=1) int);
800  }
801
802  public final class SetSchemaResponse implements android.os.Parcelable {
803    method public final int describeContents();
804    method @NonNull public java.util.Set<java.lang.String> getDeletedTypes();
805    method @NonNull public java.util.Set<java.lang.String> getIncompatibleTypes();
806    method @NonNull public java.util.Set<java.lang.String> getMigratedTypes();
807    method @NonNull public java.util.List<android.app.appsearch.SetSchemaResponse.MigrationFailure> getMigrationFailures();
808    method public void writeToParcel(@NonNull android.os.Parcel, int);
809    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.SetSchemaResponse> CREATOR;
810  }
811
812  public static final class SetSchemaResponse.Builder {
813    ctor public SetSchemaResponse.Builder();
814    method @NonNull public android.app.appsearch.SetSchemaResponse.Builder addDeletedType(@NonNull String);
815    method @NonNull public android.app.appsearch.SetSchemaResponse.Builder addDeletedTypes(@NonNull java.util.Collection<java.lang.String>);
816    method @NonNull public android.app.appsearch.SetSchemaResponse.Builder addIncompatibleType(@NonNull String);
817    method @NonNull public android.app.appsearch.SetSchemaResponse.Builder addIncompatibleTypes(@NonNull java.util.Collection<java.lang.String>);
818    method @NonNull public android.app.appsearch.SetSchemaResponse.Builder addMigratedType(@NonNull String);
819    method @NonNull public android.app.appsearch.SetSchemaResponse.Builder addMigratedTypes(@NonNull java.util.Collection<java.lang.String>);
820    method @NonNull public android.app.appsearch.SetSchemaResponse.Builder addMigrationFailure(@NonNull android.app.appsearch.SetSchemaResponse.MigrationFailure);
821    method @NonNull public android.app.appsearch.SetSchemaResponse.Builder addMigrationFailures(@NonNull java.util.Collection<android.app.appsearch.SetSchemaResponse.MigrationFailure>);
822    method @NonNull public android.app.appsearch.SetSchemaResponse build();
823  }
824
825  public static class SetSchemaResponse.MigrationFailure implements android.os.Parcelable {
826    ctor public SetSchemaResponse.MigrationFailure(@NonNull String, @NonNull String, @NonNull String, @NonNull android.app.appsearch.AppSearchResult<?>);
827    method public final int describeContents();
828    method @NonNull public android.app.appsearch.AppSearchResult<java.lang.Void> getAppSearchResult();
829    method @NonNull public String getDocumentId();
830    method @NonNull public String getNamespace();
831    method @NonNull public String getSchemaType();
832    method public void writeToParcel(@NonNull android.os.Parcel, int);
833    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.SetSchemaResponse.MigrationFailure> CREATOR;
834  }
835
836  public final class StorageInfo implements android.os.Parcelable {
837    method public final int describeContents();
838    method public int getAliveDocumentsCount();
839    method public int getAliveNamespacesCount();
840    method public int getBlobsCount();
841    method public long getBlobsSizeBytes();
842    method public long getSizeBytes();
843    method public void writeToParcel(@NonNull android.os.Parcel, int);
844    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.StorageInfo> CREATOR;
845  }
846
847  public static final class StorageInfo.Builder {
848    ctor public StorageInfo.Builder();
849    method @NonNull public android.app.appsearch.StorageInfo build();
850    method @NonNull public android.app.appsearch.StorageInfo.Builder setAliveDocumentsCount(int);
851    method @NonNull public android.app.appsearch.StorageInfo.Builder setAliveNamespacesCount(int);
852    method @NonNull public android.app.appsearch.StorageInfo.Builder setBlobsCount(int);
853    method @NonNull public android.app.appsearch.StorageInfo.Builder setBlobsSizeBytes(long);
854    method @NonNull public android.app.appsearch.StorageInfo.Builder setSizeBytes(long);
855  }
856
857}
858
859package android.app.appsearch.exceptions {
860
861  public class AppSearchException extends java.lang.Exception {
862    ctor public AppSearchException(int);
863    ctor public AppSearchException(int, @Nullable String);
864    ctor public AppSearchException(int, @Nullable String, @Nullable Throwable);
865    method public int getResultCode();
866    method @NonNull public <T> android.app.appsearch.AppSearchResult<T> toAppSearchResult();
867  }
868
869}
870
871package android.app.appsearch.observer {
872
873  public final class DocumentChangeInfo {
874    ctor public DocumentChangeInfo(@NonNull String, @NonNull String, @NonNull String, @NonNull String, @NonNull java.util.Set<java.lang.String>);
875    method @NonNull public java.util.Set<java.lang.String> getChangedDocumentIds();
876    method @NonNull public String getDatabaseName();
877    method @NonNull public String getNamespace();
878    method @NonNull public String getPackageName();
879    method @NonNull public String getSchemaName();
880  }
881
882  public interface ObserverCallback {
883    method public void onDocumentChanged(@NonNull android.app.appsearch.observer.DocumentChangeInfo);
884    method public void onSchemaChanged(@NonNull android.app.appsearch.observer.SchemaChangeInfo);
885  }
886
887  public final class ObserverSpec implements android.os.Parcelable {
888    method public final int describeContents();
889    method @NonNull public java.util.Set<java.lang.String> getFilterSchemas();
890    method public void writeToParcel(@NonNull android.os.Parcel, int);
891    field @NonNull public static final android.os.Parcelable.Creator<android.app.appsearch.observer.ObserverSpec> CREATOR;
892  }
893
894  public static final class ObserverSpec.Builder {
895    ctor public ObserverSpec.Builder();
896    method @NonNull public android.app.appsearch.observer.ObserverSpec.Builder addFilterSchemas(@NonNull java.lang.String...);
897    method @NonNull public android.app.appsearch.observer.ObserverSpec.Builder addFilterSchemas(@NonNull java.util.Collection<java.lang.String>);
898    method @NonNull public android.app.appsearch.observer.ObserverSpec build();
899  }
900
901  public final class SchemaChangeInfo {
902    ctor public SchemaChangeInfo(@NonNull String, @NonNull String, @NonNull java.util.Set<java.lang.String>);
903    method @NonNull public java.util.Set<java.lang.String> getChangedSchemaNames();
904    method @NonNull public String getDatabaseName();
905    method @NonNull public String getPackageName();
906  }
907
908}
909
910package android.app.appsearch.util {
911
912  public class DocumentIdUtil {
913    method @NonNull public static String createQualifiedId(@NonNull String, @NonNull String, @NonNull android.app.appsearch.GenericDocument);
914    method @NonNull public static String createQualifiedId(@NonNull String, @NonNull String, @NonNull String, @NonNull String);
915  }
916
917}
918
919