@Documented
@Retention(value=RUNTIME)
@Target(value={FIELD,METHOD})
public @interface SchemaFieldDescription
POJO field, a Java Bean getter, or an AutoValue getter, the specified description is used
for the generated schema field.
For example, say we have a Java POJO with a field that we want in our schema, and we want to add a description for it:
@DefaultSchema(JavaFieldSchema.class)
class MyClass {
public String user;
@SchemaFieldDescription("The time in years since the user joined our platform")
public int ageInYears;
}
The resulting schema will have fields named "user" and "ageInYears", and the field "ageInYears" will have a description for its meaning.
| Modifier and Type | Required Element and Description |
|---|---|
java.lang.String |
value
The description to use for the generated schema field.
|
@Nonnull public abstract java.lang.String value