Guide

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

---

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	description a description of the field
String	format the format that a field must conform to
Int	maxItems the maximum number of items in a list
Double	maximum the maximum value (inclusive) which the numeric field may contain
Int	minItems the minimum number of items in a list
Double	minimum 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