IMPORTANT: In July 2025, we stopped releasing new versions of KTX modules, and we removed the KTX libraries from the Firebase Android BoM (v34.0.0). If you use KTX APIs from the previously released KTX modules, we recommend that you migrate your app to use KTX APIs from the main modules instead. For details, see the FAQ about this initiative.

Guide

@Target(allowedTargets = [AnnotationTarget.PROPERTY])
@Retention(value = AnnotationRetention.SOURCE)
public annotation Guide

This annotation is used with the firebase-ai-ksp-processor plugin to provide extra information on generated classes and fields.

Summary

Public fields
`final @NonNull String`	`description` a description of the field
`final @NonNull String`	`format` the format that a field must conform to
`final int`	`maxItems` the maximum number of items in a list
`final double`	`maximum` the maximum value (inclusive) which the numeric field may contain
`final int`	`minItems` the minimum number of items in a list
`final double`	`minimum` the minimum value (inclusive) which the numeric field may contain

Public constructors
`Guide( @NonNull String description, double minimum, double maximum, int minItems, int maxItems, @NonNull String format )`

Public fields

description

public final @NonNull String description

a description of the field

format

public final @NonNull String format

the format that a field must conform to

maxItems

public final int maxItems

the maximum number of items in a list

maximum

public final double maximum

the maximum value (inclusive) which the numeric field may contain

minItems

public final int minItems

the minimum number of items in a list

minimum

public final double minimum

the minimum value (inclusive) which the numeric field may contain

Public constructors

Guide

public Guide(
    @NonNull String description,
    double minimum,
    double maximum,
    int minItems,
    int maxItems,
    @NonNull String format
)