@DefaultAnnotation(org.checkerframework.checker.nullness.qual.NonNull.class) @Experimental(SCHEMAS)

Package org.apache.beam.sdk.schemas

Defines Schema and other classes for representing schema'd data in a Pipeline.

For further details, see the documentation for each class in this package.

Interface Summary

Interface	Description
Factory<T>	A Factory interface for schema-related objects for a specific Java type.
FieldValueGetter<ObjectT,ValueT>	For internal use only; no backwards-compatibility guarantees.
FieldValueSetter<ObjectT,ValueT>	For internal use only; no backwards-compatibility guarantees.
ProjectionConsumer	A ProjectionConsumer is a Schema-aware operation (such as a DoFn or PTransform) that has a FieldAccessDescriptor describing which fields the operation accesses.
ProjectionProducer<T>	A factory for operations that execute a projection on a Schema-aware PCollection.
Schema.LogicalType<InputT,BaseT>	A LogicalType allows users to define a custom schema type.
SchemaProvider	Concrete implementations of this class allow creation of schema service objects that vend a Schema for a specific type.
SchemaProviderRegistrar	SchemaProvider creators have the ability to automatically have their schemaProvider registered with this SDK by creating a ServiceLoader entry and a concrete implementation of this interface.
SchemaUserTypeCreator	A creator interface for user types that have schemas.

Class Summary

Class	Description
AutoValueSchema	A SchemaProvider for AutoValue classes.
AutoValueSchema.AbstractGetterTypeSupplier	FieldValueTypeSupplier that's based on AutoValue getters.
AvroRecordSchema	A SchemaProvider for AVRO generated SpecificRecords and POJOs.
CachingFactory<CreatedT>	A wrapper around a Factory that assumes the schema parameter never changes.
FieldAccessDescriptor	Used inside of a DoFn to describe which fields in a schema type need to be accessed for processing.
FieldAccessDescriptor.FieldDescriptor	Description of a single field.
FieldAccessDescriptor.FieldDescriptor.Builder	Builder class.
FieldAccessDescriptor.FieldDescriptor.Qualifier	OneOf union for a collection selector.
FieldTypeDescriptors	Utilities for converting between Schema field types and TypeDescriptors that define Java objects which can represent these field types.
FieldValueTypeInformation	Represents type information for a Java type that will be used to infer a Schema type.
FieldValueTypeInformation.Builder
GetterBasedSchemaProvider	A SchemaProvider base class that vends schemas and rows based on FieldValueGetters.
JavaBeanSchema	A SchemaProvider for Java Bean objects.
JavaBeanSchema.GetterTypeSupplier	FieldValueTypeSupplier that's based on getter methods.
JavaBeanSchema.SetterTypeSupplier	FieldValueTypeSupplier that's based on setter methods.
JavaFieldSchema	A SchemaProvider for Java POJO objects.
JavaFieldSchema.JavaFieldTypeSupplier	FieldValueTypeSupplier that's based on public fields.
RowMessages
Schema	Schema describes the fields in Row.
Schema.Builder	Builder class for building Schema objects.
Schema.Field	Field of a row.
Schema.Field.Builder	Builder for Schema.Field.
Schema.FieldType	A descriptor of a single field type.
Schema.Options
Schema.Options.Builder
SchemaCoder<T>	SchemaCoder is used as the coder for types that have schemas registered.
SchemaRegistry	A SchemaRegistry allows registering Schemas for a given Java Class or a TypeDescriptor.
SchemaTranslation	Utility methods for translating schemas.
SchemaUtils	A set of utility functions for schemas.

Enum Summary

Enum	Description
FieldAccessDescriptor.FieldDescriptor.ListQualifier	Qualifier for a list selector.
FieldAccessDescriptor.FieldDescriptor.MapQualifier	Qualifier for a map selector.
FieldAccessDescriptor.FieldDescriptor.Qualifier.Kind	The kind of qualifier.
Schema.EquivalenceNullablePolicy	Control whether nullable is included in equivalence check.
Schema.TypeName	An enumerated list of type constructors.

Exception Summary

Exception	Description
NoSuchSchemaException	Indicates that we are missing a schema for a type.