Added in API level 31

GetByDocumentIdRequest

Kotlin |Java

public final class GetByDocumentIdRequest
extends Object implements Parcelable

java.lang.Object
↳	android.app.appsearch.GetByDocumentIdRequest

Encapsulates a request to retrieve documents by namespace and IDs from the AppSearchSession database.

See also:

AppSearchSession.getByDocumentId(GetByDocumentIdRequest, Executor, BatchResultCallback)

Summary

Nested classes
`class`	`GetByDocumentIdRequest.Builder` Builder for `GetByDocumentIdRequest` objects.

Constants
`String`	`PROJECTION_SCHEMA_TYPE_WILDCARD` Schema type to be used in `GetByDocumentIdRequest.Builder.addProjection` to apply property paths to all results, excepting any types that have had their own, specific property paths set.

Inherited constants

From interface android.os.Parcelable

`int`	`CONTENTS_FILE_DESCRIPTOR` Descriptor bit used with `describeContents()`: indicates that the Parcelable object's flattened representation includes a file descriptor.
`int`	`PARCELABLE_WRITE_RETURN_VALUE` Flag for use with `writeToParcel(Parcel, int)`: the object being written is a return value, that is the result of a function such as "`Parcelable someFunction()`", "`void someFunction(out Parcelable)`", or "`void someFunction(inout Parcelable)`".

Fields
`public static final Creator<GetByDocumentIdRequest>`	`CREATOR`

Public methods
`int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`Set<String>`	`getIds()` Returns the set of document IDs attached to the request.
`String`	`getNamespace()` Returns the namespace attached to the request.
`Map<String, List<PropertyPath>>`	`getProjectionPaths()` Returns a map from schema type to property paths to be used for projection.
`Map<String, List<String>>`	`getProjections()` Returns a map from schema type to property paths to be used for projection.
`void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Inherited methods

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.

From interface


        
          android.os.Parcelable

`abstract int`	`describeContents()` Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
`abstract void`	`writeToParcel(Parcel dest, int flags)` Flatten this object in to a Parcel.

Constants

PROJECTION_SCHEMA_TYPE_WILDCARD

Added in API level 31

public static final String PROJECTION_SCHEMA_TYPE_WILDCARD

Schema type to be used in GetByDocumentIdRequest.Builder.addProjection to apply property paths to all results, excepting any types that have had their own, specific property paths set.

Constant Value: "*"

Fields

CREATOR

Added in API level 35
Also in T Extensions 13

public static final Creator<GetByDocumentIdRequest> CREATOR

Public methods

describeContents

Added in API level 35

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
`int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `CONTENTS_FILE_DESCRIPTOR`

getIds

Added in API level 31

public Set<String> getIds ()

Returns the set of document IDs attached to the request.

Returns
`Set<String>`	This value cannot be `null`.

getNamespace

Added in API level 31

public String getNamespace ()

Returns the namespace attached to the request.

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

getProjectionPaths

Added in API level 34
Also in T Extensions 7

public Map<String, List<PropertyPath>> getProjectionPaths ()

Returns a map from schema type to property paths to be used for projection.

If the map is empty, then all properties will be retrieved for all results.

Calling this function repeatedly is inefficient. Prefer to retain the Map returned by this function, rather than calling it multiple times.

Returns
`Map<String, List<PropertyPath>>`	This value cannot be `null`.

getProjections

Added in API level 31

public Map<String, List<String>> getProjections ()

Returns a map from schema type to property paths to be used for projection.

If the map is empty, then all properties will be retrieved for all results.

Calling this function repeatedly is inefficient. Prefer to retain the Map returned by this function, rather than calling it multiple times.

Returns
`Map<String, List<String>>`	This value cannot be `null`.

writeToParcel

Added in API level 35

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
`dest`	`Parcel`: This value cannot be `null`.
`flags`	`int`: Additional flags about how the object should be written. May be 0 or `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`. Value is either `0` or a combination of the following: `Parcelable.PARCELABLE_WRITE_RETURN_VALUE`

GetByDocumentIdRequest

Summary

Nested classes

Constants

Inherited constants

Fields

Public methods

Inherited methods

Constants

PROJECTION_SCHEMA_TYPE_WILDCARD

Fields

CREATOR

Public methods

describeContents

getIds

getNamespace

getProjectionPaths

getProjections

writeToParcel