TakenAction.BuilderBase

Kotlin |Java

@ExperimentalAppSearchApi
public class TakenAction.BuilderBase<T extends TakenAction.BuilderBase<T>>

Known direct subclasses

`ClickAction.BuilderBase`	Builder for `ClickAction`.
`DismissAction.BuilderBase`	Builder for `DismissAction`.
`ImpressionAction.BuilderBase`	Builder for `ImpressionAction`.
`SearchAction.BuilderBase`	Builder for `SearchAction`.

Known indirect subclasses

`ClickAction.Builder`	Builder for `ClickAction`.
`DismissAction.Builder`	Builder for `DismissAction`.
`ImpressionAction.Builder`	Builder for `ImpressionAction`.
`SearchAction.Builder`	Builder for `SearchAction`.

Builder for TakenAction.

Summary

Public constructors
`BuilderBase(@NonNull TakenAction takenAction)` Constructs `TakenAction.BuilderBase` by copying existing values from the given `TakenAction`.
`BuilderBase( @NonNull String namespace, @NonNull String id, long actionTimestampMillis, int actionType )` Constructs `TakenAction.BuilderBase` with given `namespace`, `id`, `actionTimestampMillis` and `actionType`.

Public methods
`@NonNull TakenAction`	`build()` For AppSearch annotation processor requirement only.
`@NonNull T`	`setDocumentTtlMillis(long documentTtlMillis)` Sets the time-to-live (TTL) of the `TakenAction` document as a duration in milliseconds.

public BuilderBase(@NonNull TakenAction takenAction)

Constructs TakenAction.BuilderBase by copying existing values from the given TakenAction.

Parameters
`@NonNull TakenAction takenAction`	an existing `TakenAction` object.

public BuilderBase(
    @NonNull String namespace,
    @NonNull String id,
    long actionTimestampMillis,
    int actionType
)

Constructs TakenAction.BuilderBase with given namespace, id, actionTimestampMillis and actionType.

Parameters
`@NonNull String namespace`	The namespace of the `TakenAction` document.
`@NonNull String id`	The id of the `TakenAction` document.
`long actionTimestampMillis`	The timestamp when the user took the action, in milliseconds since Unix epoch.
`int actionType`	The action type enum of the Document.

public @NonNull TakenAction build()

For AppSearch annotation processor requirement only. The client should never call it since it is impossible to instantiate an abstract class.

Throws
`java.lang.UnsupportedOperationException`

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.