SearchAction.Builder

Kotlin |Java

@Document.BuilderProducer
public final class SearchAction.Builder

Builder for SearchAction.

Summary

Public constructors
`Builder(@NonNull SearchAction searchAction)` Constructor for `Builder` with all the existing values.
`Builder( @NonNull String namespace, @NonNull String id, long actionTimestampMillis )` Constructor for `SearchAction.Builder`.

Public methods
`@NonNull SearchAction`	`build()` Builds a `SearchAction`.
`@NonNull T`	`setDocumentTtlMillis(long documentTtlMillis)` Sets the time-to-live (TTL) of the `TakenAction` document as a duration in milliseconds.
`@NonNull SearchAction.Builder`	`setFetchedResultCount(int fetchedResultCount)` Sets total number of results fetched from AppSearch by the client in this `SearchAction`.
`@NonNull SearchAction.Builder`	`setQuery(@Nullable String query)` Sets the user-entered search input (without any operators or rewriting).

protected long mActionTimestampMillis

protected int mActionType

protected long mDocumentTtlMillis

protected final String mId

protected final String mNamespace

public Builder(@NonNull SearchAction searchAction)

Constructor for Builder with all the existing values.

public Builder(
    @NonNull String namespace,
    @NonNull String id,
    long actionTimestampMillis
)

Parameters
`@NonNull String namespace`	Namespace for the Document. See `Document.Namespace`.
`@NonNull String id`	Unique identifier for the Document. See `Document.Id`.
`long actionTimestampMillis`	The timestamp when the user took the action, in milliseconds since Unix epoch.

public @NonNull SearchAction build()

public @NonNull T setDocumentTtlMillis(long documentTtlMillis)

Sets the time-to-live (TTL) of the TakenAction document as a duration in milliseconds.

The document will be automatically deleted when the TTL expires (since getActionTimestampMillis).

The default TTL for TakenAction document is 60 days.

public @NonNull SearchAction.Builder setFetchedResultCount(int fetchedResultCount)

Sets total number of results fetched from AppSearch by the client in this SearchAction.

See also
`getFetchedResultCount`

public @NonNull SearchAction.Builder setQuery(@Nullable String query)

Sets the user-entered search input (without any operators or rewriting).