Guide

@Target(allowedTargets = [AnnotationTarget.PROPERTY])
@Retention(value = AnnotationRetention.SOURCE)
annotationGuide

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

Summary

Public constructors

Guide(
    description: String,
    minimum: Double,
    maximum: Double,
    minItems: Int,
    maxItems: Int,
    format: String
)

Public properties

String

a description of the field

String

the format that a field must conform to

Int

the maximum number of items in a list

Double

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

Int

the minimum number of items in a list

Double

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

Public constructors

Guide

Guide(
    description: String = "",
    minimum: Double = -1.0,
    maximum: Double = -1.0,
    minItems: Int = -1,
    maxItems: Int = -1,
    format: String = ""
)

Public properties

description

val description: String

a description of the field

format

val format: String

the format that a field must conform to

maxItems

val maxItems: Int

the maximum number of items in a list

maximum

val maximum: Double

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

minItems

val minItems: Int

the minimum number of items in a list

minimum

val minimum: Double

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

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-02-06 UTC.