# GenerableDetail.GuideDetail


```
public final class GenerableDetail.GuideDetail
```

<br />

*** ** * ** ***

Holds the details of a single property in a `Generable` class, including its metadata and constraints specified by the Guide annotation.

## Summary

| ### Public constructors |
|---|
| `https://developers.google.com/android/reference/com/google/mlkit/genai/schema/guided/GenerableDetail.GuideDetail#GuideDetail(kotlin.String,kotlin.reflect.KClass,kotlin.Boolean,kotlin.String,kotlin.Int,kotlin.Int,kotlin.Double,kotlin.Double,kotlin.Array,kotlin.Boolean,kotlin.reflect.KClass)( @https://developer.android.com/reference/androidx/annotation/NonNull.html https://developer.android.com/reference/java/lang/String.html name, @https://developer.android.com/reference/androidx/annotation/NonNull.html https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html<@https://developer.android.com/reference/androidx/annotation/NonNull.html ?> type, boolean nullable, https://developer.android.com/reference/java/lang/String.html description, https://developer.android.com/reference/java/lang/Integer.html maxItems, https://developer.android.com/reference/java/lang/Integer.html minItems, https://developer.android.com/reference/java/lang/Double.html maximum, https://developer.android.com/reference/java/lang/Double.html minimum, String[] enumValues, boolean isList, https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html<@https://developer.android.com/reference/androidx/annotation/NonNull.html ?> listItemType )` |

| ### Public methods |
|---|---|
| `final https://developer.android.com/reference/java/lang/String.html` | `https://developers.google.com/android/reference/com/google/mlkit/genai/schema/guided/GenerableDetail.GuideDetail#getDescription()()` Description of the field, matching Guide.description. |
| `final String[]` | `https://developers.google.com/android/reference/com/google/mlkit/genai/schema/guided/GenerableDetail.GuideDetail#getEnumValues()()` Possible enum values, matching Guide.enumValues. |
| `final https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html<@https://developer.android.com/reference/androidx/annotation/NonNull.html ?>` | `https://developers.google.com/android/reference/com/google/mlkit/genai/schema/guided/GenerableDetail.GuideDetail#getListItemType()()` The class type of the list items, if the property is a list. |
| `final https://developer.android.com/reference/java/lang/Integer.html` | `https://developers.google.com/android/reference/com/google/mlkit/genai/schema/guided/GenerableDetail.GuideDetail#getMaxItems()()` Maximum number of items, matching Guide.maxItems. |
| `final https://developer.android.com/reference/java/lang/Double.html` | `https://developers.google.com/android/reference/com/google/mlkit/genai/schema/guided/GenerableDetail.GuideDetail#getMaximum()()` Maximum value, matching Guide.maximum. |
| `final https://developer.android.com/reference/java/lang/Integer.html` | `https://developers.google.com/android/reference/com/google/mlkit/genai/schema/guided/GenerableDetail.GuideDetail#getMinItems()()` Minimum number of items, matching Guide.minItems. |
| `final https://developer.android.com/reference/java/lang/Double.html` | `https://developers.google.com/android/reference/com/google/mlkit/genai/schema/guided/GenerableDetail.GuideDetail#getMinimum()()` Minimum value, matching Guide.minimum. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull.html https://developer.android.com/reference/java/lang/String.html` | `https://developers.google.com/android/reference/com/google/mlkit/genai/schema/guided/GenerableDetail.GuideDetail#getName()()` The name of the property. |
| `final boolean` | `https://developers.google.com/android/reference/com/google/mlkit/genai/schema/guided/GenerableDetail.GuideDetail#getNullable()()` Whether the property is nullable. |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull.html https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.reflect/-k-class/index.html<@https://developer.android.com/reference/androidx/annotation/NonNull.html ?>` | `https://developers.google.com/android/reference/com/google/mlkit/genai/schema/guided/GenerableDetail.GuideDetail#getType()()` The class type of the property. |
| `final boolean` | `https://developers.google.com/android/reference/com/google/mlkit/genai/schema/guided/GenerableDetail.GuideDetail#getIsList()()` Whether the property is a list. |

## Public constructors

### GuideDetail

```
public GuideDetail(
    @NonNull String name,
    @NonNull KClass<@NonNull ?> type,
    boolean nullable,
    String description,
    Integer maxItems,
    Integer minItems,
    Double maximum,
    Double minimum,
    String[] enumValues,
    boolean isList,
    KClass<@NonNull ?> listItemType
)
```

## Public methods

### getDescription

```
public final String getDescription()
```

Description of the field, matching Guide.description.

### getEnumValues

```
public final String[] getEnumValues()
```

Possible enum values, matching Guide.enumValues.

### getListItemType

```
public final KClass<@NonNull ?> getListItemType()
```

The class type of the list items, if the property is a list.

### getMaxItems

```
public final Integer getMaxItems()
```

Maximum number of items, matching Guide.maxItems.

### getMaximum

```
public final Double getMaximum()
```

Maximum value, matching Guide.maximum.

### getMinItems

```
public final Integer getMinItems()
```

Minimum number of items, matching Guide.minItems.

### getMinimum

```
public final Double getMinimum()
```

Minimum value, matching Guide.minimum.

### getName

```
public final @NonNull String getName()
```

The name of the property.

### getNullable

```
public final boolean getNullable()
```

Whether the property is nullable.

### getType

```
public final @NonNull KClass<@NonNull ?> getType()
```

The class type of the property.

### isList

```
public final boolean isList()
```

Whether the property is a list.