SearchAction.Builder

Kotlin |Java

@Document.BuilderProducer
class SearchAction.Builder

Builder for SearchAction.

Summary

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

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

Builder(searchAction: SearchAction)

Constructor for Builder with all the existing values.

Builder(namespace: String, id: String, actionTimestampMillis: Long)

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

fun build(): SearchAction

fun setDocumentTtlMillis(documentTtlMillis: Long): T

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.

fun setFetchedResultCount(fetchedResultCount: Int): SearchAction.Builder

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

See also
`getFetchedResultCount`

fun setQuery(query: String?): SearchAction.Builder

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

protected val mActionTimestampMillis: Long

protected val mActionType: Int

protected val mDocumentTtlMillis: Long

protected val mId: String!

protected val mNamespace: String!