Package org.apache.beam.sdk.schemas.annotations

Annotation Interface SchemaFieldDescription

@Documented @Retention(RUNTIME) @Target({FIELD,METHOD}) public @interface SchemaFieldDescription
When used on a 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.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    value
    The description to use for the generated schema field.

  • Element Details

    • value

      @Nonnull String value
      The description to use for the generated schema field.