Uses of Class
org.apache.avro.Schema
Packages that use Schema
Package
Description
Avro kernel classes.
Interfaces and base classes shared by generic, specific and reflect.
A container file for Avro data.
A generic representation for Avro data.
Utilities for Encoding and Decoding Avro data.
Implementation of Avro schemas as LL(1) grammars.
Interfaces and base classes for AvroPath.
Use Java reflection to generate schemas and protocols for existing
classes.
Generate specific Java classes for schemas and protocols.
Common utility classes.
-
Uses of Schema in org.apache.avro
Fields in org.apache.avro declared as SchemaModifier and TypeFieldDescriptionfinal Schema
Resolver.Action.reader
static final Schema
Protocol.SYSTEM_ERROR
An error that can be thrown by any message.static final Schema
Protocol.SYSTEM_ERRORS
Union type for generating system errors.final Schema
Resolver.Action.writer
Methods in org.apache.avro that return SchemaModifier and TypeMethodDescriptionLogicalType.addToSchema
(Schema schema) Add this logical type to the given Schema.LogicalTypes.Decimal.addToSchema
(Schema schema) static Schema
Schema.applyAliases
(Schema writer, Schema reader) Rewrite a writer's schema using the aliases from a reader's schema.static Schema
Schema.create
(Schema.Type type) Create a schema for a primitive type.static Schema
Schema.createArray
(Schema elementType) Create an array schema.static Schema
Create an enum schema.static Schema
Schema.createEnum
(String name, String doc, String namespace, List<String> values, String enumDefault) Create an enum schema.static Schema
Schema.createFixed
(String name, String doc, String space, int size) Create a fixed schema.static Schema
Create a map schema.static Schema
Schema.createRecord
(String name, String doc, String namespace, boolean isError) Create a named record schema.static Schema
Schema.createRecord
(String name, String doc, String namespace, boolean isError, List<Schema.Field> fields) Create a named record schema with fields already set.static Schema
Schema.createRecord
(List<Schema.Field> fields) Deprecated.static Schema
Schema.createUnion
(List<Schema> types) Create a union schema.static Schema
Schema.createUnion
(Schema... types) Create a union schema.Find a schema by name and namespace.Schema.getElementType()
If this is an array, returns its element type.Protocol.Message.getErrors()
Errors that might be thrown.ParseContext.getNamedSchema
(String fullName) Get a schema by name.SchemaCompatibility.SchemaPairCompatibility.getReader()
Gets the reader schema that was validated.SchemaCompatibility.Incompatibility.getReaderFragment()
Returns the fragment of the reader schema that failed compatibility check.Conversion.getRecommendedSchema()
Conversions.BigDecimalConversion.getRecommendedSchema()
Conversions.DecimalConversion.getRecommendedSchema()
Conversions.DurationConversion.getRecommendedSchema()
Conversions.UUIDConversion.getRecommendedSchema()
Protocol.Message.getRequest()
The parameters of this message.Protocol.Message.getResponse()
The returned data.Returns the named type.UnresolvedUnionException.getUnionSchema()
Schema.getValueType()
If this is a map, returns its value type.SchemaCompatibility.SchemaPairCompatibility.getWriter()
Gets the writer schema that was validated.SchemaCompatibility.Incompatibility.getWriterFragment()
Returns the fragment of the writer schema that failed compatibility check.SchemaParser.ParseResult.mainSchema()
The main schema parsed from a file.FormattedSchemaParser.parse
(ParseContext parseContext, URI baseUri, CharSequence formattedSchema) Parse schema definitions from a text based source.JsonSchemaParser.parse
(ParseContext parseContext, URI baseUri, CharSequence formattedSchema) static Schema
Deprecated.useSchemaParser
instead.static Schema
Schema.parse
(InputStream in) Deprecated.useSchemaParser
instead.static Schema
Deprecated.useSchemaParser
instead.static Schema
Deprecated.useSchemaParser
instead.Parse a schema from the provided file.Schema.Parser.parse
(InputStream in) Parse a schema from the provided stream.Parse a schema from the provided string.Read a schema from one or more json stringsstatic Schema
JsonSchemaParser.parseInternal
(String... fragments) Parse a schema written in the internal (JSON) format without any validations.Schema.Parser.parseInternal
(String s) Resolve unresolved references in a schema that was parsed for this context using the types known to this context.SchemaParser.resolve
(SchemaParser.ParseResult result) Deprecated.Schema.Field.schema()
This field'sSchema
.Methods in org.apache.avro that return types with arguments of type SchemaModifier and TypeMethodDescriptionstatic SchemaBuilder.ArrayBuilder
<Schema> SchemaBuilder.array()
Create a builder for an Avro array This is equivalent to:static SchemaBuilder.TypeBuilder
<Schema> SchemaBuilder.builder()
Create a builder for Avro schemas.static SchemaBuilder.TypeBuilder
<Schema> Create a builder for Avro schemas with a default namespace.static SchemaBuilder.EnumBuilder
<Schema> SchemaBuilder.enumeration
(String name) Create a builder for an Avro enum with the specified name and symbols (values).static SchemaBuilder.FixedBuilder
<Schema> Create a builder for an Avro fixed type with the specified name and size.SchemaParser.getParsedNamedSchemas()
Get all parsed schemata.Protocol.getTypes()
The types of this protocol.Schema.getTypes()
If this is a union, returns its types.Schema.Parser.getTypes()
Returns the set of defined, named types known to this parser.Protocol.getUnresolvedTypes()
Deprecated.can return invalid schemata: do NOT use!static SchemaBuilder.MapBuilder
<Schema> SchemaBuilder.map()
Create a builder for an Avro map This is equivalent to:static SchemaBuilder.BaseTypeBuilder
<Schema> SchemaBuilder.nullable()
Create a builder for a union of a type and null.SchemaParser.ParseResult.parsedNamedSchemas()
The list of named schemata that were parsed.static SchemaBuilder.RecordBuilder
<Schema> Create a builder for an Avro record with the specified name.ParseContext.resolveAllSchemas()
Resolve all (named) schemas that were parsed.ParseContext.typesByName()
Return all known types by their fullname.SchemaBuilder.unionOf()
Create a builder for an Avro union This is equivalent to:Methods in org.apache.avro with parameters of type SchemaModifier and TypeMethodDescriptionLogicalType.addToSchema
(Schema schema) Add this logical type to the given Schema.LogicalTypes.Decimal.addToSchema
(Schema schema) static Schema
Schema.applyAliases
(Schema writer, Schema reader) Rewrite a writer's schema using the aliases from a reader's schema.SchemaCompatibility.checkReaderWriterCompatibility
(Schema reader, Schema writer) Validates that the provided reader schema can be used to decode avro data written with the provided writer schema.static Object
Conversions.convertToLogicalType
(Object datum, Schema schema, LogicalType type, Conversion<?> conversion) Convert an underlying representation of a logical type (such as a ByteBuffer) to a higher level object (such as a BigDecimal).static <T> Object
Conversions.convertToRawType
(Object datum, Schema schema, LogicalType type, Conversion<T> conversion) Convert a high level representation of a logical type (such as a BigDecimal) to its underlying representation object (such as a ByteBuffer)static Schema
Schema.createArray
(Schema elementType) Create an array schema.static Schema
Create a map schema.Create a one-way message.Protocol.createMessage
(String name, String doc, Map<String, ?> propMap, Schema request, Schema response, Schema errors) Create a two-way message.Protocol.createMessage
(String name, String doc, JsonProperties propMap, Schema request) Create a one-way message.Protocol.createMessage
(String name, String doc, JsonProperties propMap, Schema request, Schema response, Schema errors) Create a two-way message.Protocol.createMessage
(String name, String doc, Schema request) Deprecated.Deprecated.Protocol.createMessage
(Protocol.Message m, Schema request) Create a one-way message using thename
,doc
, andprops
ofm
.Protocol.createMessage
(Protocol.Message m, Schema request, Schema response, Schema errors) Create a two-way message using thename
,doc
, andprops
ofm
.static Schema
Schema.createUnion
(Schema... types) Create a union schema.static String
Format a schema with the specified format.Write the specified schema as a String.Conversion.fromArray
(Collection<?> value, Schema schema, LogicalType type) Conversion.fromBoolean
(Boolean value, Schema schema, LogicalType type) Conversion.fromBytes
(ByteBuffer value, Schema schema, LogicalType type) Conversions.BigDecimalConversion.fromBytes
(ByteBuffer value, Schema schema, LogicalType type) Conversions.DecimalConversion.fromBytes
(ByteBuffer value, Schema schema, LogicalType type) Conversion.fromCharSequence
(CharSequence value, Schema schema, LogicalType type) Conversions.UUIDConversion.fromCharSequence
(CharSequence value, Schema schema, LogicalType type) Conversion.fromDouble
(Double value, Schema schema, LogicalType type) Conversion.fromEnumSymbol
(GenericEnumSymbol<?> value, Schema schema, LogicalType type) Conversion.fromFixed
(GenericFixed value, Schema schema, LogicalType type) Conversions.DecimalConversion.fromFixed
(GenericFixed value, Schema schema, LogicalType type) Conversions.DurationConversion.fromFixed
(GenericFixed value, Schema schema, LogicalType type) Conversions.UUIDConversion.fromFixed
(GenericFixed value, Schema schema, LogicalType type) Conversion.fromFloat
(Float value, Schema schema, LogicalType type) Conversion.fromInt
(Integer value, Schema schema, LogicalType type) Conversion.fromLong
(Long value, Schema schema, LogicalType type) Conversion.fromMap
(Map<?, ?> value, Schema schema, LogicalType type) Conversion.fromRecord
(IndexedRecord value, Schema schema, LogicalType type) static LogicalType
LogicalTypes.fromSchema
(Schema schema) Returns theLogicalType
from the schema, if one is present.LogicalTypes.LogicalTypeFactory.fromSchema
(Schema schema) static LogicalType
LogicalTypes.fromSchemaIgnoreInvalid
(Schema schema) SchemaCompatibility.SchemaCompatibilityResult.incompatible
(SchemaCompatibility.SchemaIncompatibilityType incompatibilityType, Schema readerFragment, Schema writerFragment, String message, List<String> location) Returns a details object representing an incompatible schema pair, including error details.static boolean
Returns true iff w and r are both primitive types and either they are the same type or w is promotable to r.Complete configuration of this array, setting the schema of the array items to the schema provided.static Schema.Field
SchemaCompatibility.lookupWriterField
(Schema writerSchema, Schema.Field readerField) Identifies the writer field that corresponds to the specified reader field.static byte[]
SchemaNormalization.parsingFingerprint
(String fpName, Schema s) ReturnsSchemaNormalization.fingerprint(java.lang.String, byte[])
applied to the parsing canonical form of the supplied schema.static long
SchemaNormalization.parsingFingerprint64
(Schema s) ReturnsSchemaNormalization.fingerprint64(byte[])
applied to the parsing canonical form of the supplied schema.void
Put the schema into this context.Resolve unresolved references in a schema that was parsed for this context using the types known to this context.static Resolver.Action
Resolver.EnumAdjust.resolve
(Schema w, Schema r, GenericData d) If writer and reader don't have same name, aResolver.ErrorAction.ErrorType.NAMES_DONT_MATCH
is returned, otherwise an appropriateResolver.EnumAdjust
is.static Resolver.Action
Resolver.Promote.resolve
(Schema w, Schema r, GenericData d) Return a promotion.static Resolver.Action
Resolver.ReaderUnion.resolve
(Schema w, Schema r, GenericData d, Map<Schema.SeenPair, Resolver.Action> seen) Returns aResolver.ReaderUnion
action for resolving w and r, or anResolver.ErrorAction
if there is no branch in the reader that matches the writer.static Resolver.Action
Uses GenericData.get() for the data param.static Resolver.Action
Resolver.resolve
(Schema writer, Schema reader, GenericData data) Returns aResolver.Action
tree for resolving the writer schema writer and the reader schema reader.static Resolver.Action
Resolver.WriterUnion.resolve
(Schema writeSchema, Schema readSchema, GenericData data, Map<Schema.SeenPair, Resolver.Action> seen) static boolean
SchemaCompatibility.schemaNameEquals
(Schema reader, Schema writer) Tests the equality of two Avro named schemas.Collection
<?> Conversion.toArray
(T value, Schema schema, LogicalType type) Conversion.toBoolean
(T value, Schema schema, LogicalType type) Conversion.toBytes
(T value, Schema schema, LogicalType type) Conversions.BigDecimalConversion.toBytes
(BigDecimal value, Schema schema, LogicalType type) Conversions.DecimalConversion.toBytes
(BigDecimal value, Schema schema, LogicalType type) Conversion.toCharSequence
(T value, Schema schema, LogicalType type) Conversions.UUIDConversion.toCharSequence
(UUID value, Schema schema, LogicalType type) Conversion.toDouble
(T value, Schema schema, LogicalType type) Conversion.toEnumSymbol
(T value, Schema schema, LogicalType type) Conversion.toFixed
(T value, Schema schema, LogicalType type) Conversions.DecimalConversion.toFixed
(BigDecimal value, Schema schema, LogicalType type) Conversions.DurationConversion.toFixed
(TimePeriod value, Schema schema, LogicalType type) Conversions.UUIDConversion.toFixed
(UUID value, Schema schema, LogicalType type) Conversion.toFloat
(T value, Schema schema, LogicalType type) Conversion.toInt
(T value, Schema schema, LogicalType type) Conversion.toLong
(T value, Schema schema, LogicalType type) Map
<?, ?> Conversion.toMap
(T value, Schema schema, LogicalType type) static String
SchemaNormalization.toParsingForm
(Schema s) Returns "Parsing Canonical Form" of a schema as defined by Avro spec.Conversion.toRecord
(T value, Schema schema, LogicalType type) final R
Use the schema provided as the type.Final step in configuring this field, finalizing name, namespace, alias, and order.void
Validate this logical type for the given Schema.void
void
void
void
void
void
void
void
void
void
void
void
void
void
Validates that one schema is compatible with another.void
Validate one schema against others.void
void
Complete configuration of this map, setting the schema of the map values to the schema provided.Method parameters in org.apache.avro with type arguments of type SchemaModifier and TypeMethodDescriptionAdds the provided types to the set of defined, named types known to this parser.Deprecated.use addTypes(Iterabletypes) static Schema
Schema.createUnion
(List<Schema> types) Create a union schema.void
Protocol.setTypes
(Collection<Schema> newTypes) Set the types of this protocol.Schema.toString
(Collection<Schema> referencedSchemas, boolean pretty) Deprecated.void
Validate one schema against others.void
void
Constructors in org.apache.avro with parameters of type SchemaModifierConstructorDescriptionprotected
Action
(Schema w, Schema r, GenericData data, Resolver.Action.Type t) Container
(Schema w, Schema r, GenericData d, Resolver.Action e) DoNothing
(Schema w, Schema r, GenericData d) ErrorAction
(Schema w, Schema r, GenericData d, Resolver.ErrorAction.ErrorType e) Field
(Schema.Field field, Schema schema) Constructs a new Field instance with the samename
,doc
,defaultValue
, andorder
asfield
has with changing the schema to the specified one.ReaderUnion
(Schema w, Schema r, GenericData d, int firstMatch, Resolver.Action actual) SchemaPairCompatibility
(SchemaCompatibility.SchemaCompatibilityResult result, Schema reader, Schema writer, String description) Constructs a new instance.SchemaValidationException
(Schema reader, Schema writer) SchemaValidationException
(Schema reader, Schema writer, Throwable cause) Skip
(Schema w, GenericData d) UnresolvedUnionException
(Schema unionSchema, Object unresolvedDatum) UnresolvedUnionException
(Schema unionSchema, Schema.Field field, Object unresolvedDatum) -
Uses of Schema in org.apache.avro.data
Fields in org.apache.avro.data declared as SchemaMethods in org.apache.avro.data that return SchemaModifier and TypeMethodDescriptionTimeConversions.DateConversion.getRecommendedSchema()
TimeConversions.LocalTimestampMicrosConversion.getRecommendedSchema()
TimeConversions.LocalTimestampMillisConversion.getRecommendedSchema()
TimeConversions.LocalTimestampNanosConversion.getRecommendedSchema()
TimeConversions.TimeMicrosConversion.getRecommendedSchema()
TimeConversions.TimeMillisConversion.getRecommendedSchema()
TimeConversions.TimestampMicrosConversion.getRecommendedSchema()
TimeConversions.TimestampMillisConversion.getRecommendedSchema()
TimeConversions.TimestampNanosConversion.getRecommendedSchema()
protected final Schema
RecordBuilderBase.schema()
Methods in org.apache.avro.data with parameters of type SchemaModifier and TypeMethodDescriptionTimeConversions.DateConversion.fromInt
(Integer daysFromEpoch, Schema schema, LogicalType type) TimeConversions.TimeMillisConversion.fromInt
(Integer millisFromMidnight, Schema schema, LogicalType type) TimeConversions.LocalTimestampMicrosConversion.fromLong
(Long microsFromEpoch, Schema schema, LogicalType type) TimeConversions.LocalTimestampMillisConversion.fromLong
(Long millisFromEpoch, Schema schema, LogicalType type) TimeConversions.LocalTimestampNanosConversion.fromLong
(Long microsFromEpoch, Schema schema, LogicalType type) TimeConversions.TimeMicrosConversion.fromLong
(Long microsFromMidnight, Schema schema, LogicalType type) TimeConversions.TimestampMicrosConversion.fromLong
(Long microsFromEpoch, Schema schema, LogicalType type) TimeConversions.TimestampMillisConversion.fromLong
(Long millisFromEpoch, Schema schema, LogicalType type) TimeConversions.TimestampNanosConversion.fromLong
(Long microsFromEpoch, Schema schema, LogicalType type) void
void
TimeConversions.DateConversion.toInt
(LocalDate date, Schema schema, LogicalType type) TimeConversions.TimeMillisConversion.toInt
(LocalTime time, Schema schema, LogicalType type) TimeConversions.LocalTimestampMicrosConversion.toLong
(LocalDateTime timestamp, Schema schema, LogicalType type) TimeConversions.LocalTimestampMillisConversion.toLong
(LocalDateTime timestamp, Schema schema, LogicalType type) TimeConversions.LocalTimestampNanosConversion.toLong
(LocalDateTime timestamp, Schema schema, LogicalType type) TimeConversions.TimeMicrosConversion.toLong
(LocalTime time, Schema schema, LogicalType type) TimeConversions.TimestampMicrosConversion.toLong
(Instant instant, Schema schema, LogicalType type) TimeConversions.TimestampMillisConversion.toLong
(Instant timestamp, Schema schema, LogicalType type) TimeConversions.TimestampNanosConversion.toLong
(Instant instant, Schema schema, LogicalType type) Constructors in org.apache.avro.data with parameters of type SchemaModifierConstructorDescriptionprotected
RecordBuilderBase
(Schema schema, GenericData data) Creates a RecordBuilderBase for building records of the given type. -
Uses of Schema in org.apache.avro.file
Methods in org.apache.avro.file that return SchemaModifier and TypeMethodDescriptionDataFileReader12.getSchema()
Return the schema used in this file.DataFileStream.getSchema()
Return the schema used in this file.FileReader.getSchema()
Return the schema for data in this file.Methods in org.apache.avro.file with parameters of type SchemaModifier and TypeMethodDescriptionOpen a new file for data matching a schema with a random sync.DataFileWriter.create
(Schema schema, OutputStream outs) Open a new file for data matching a schema with a random sync.DataFileWriter.create
(Schema schema, OutputStream outs, byte[] sync) Open a new file for data matching a schema with an explicit sync. -
Uses of Schema in org.apache.avro.generic
Methods in org.apache.avro.generic that return SchemaModifier and TypeMethodDescriptionprotected Schema
GenericData.getEnumSchema
(Object enu) Called to obtain the schema of a enum.GenericDatumReader.getExpected()
Get the reader's schema.protected Schema
GenericData.getFixedSchema
(Object fixed) Called to obtain the schema of a fixed.protected Schema
GenericData.getRecordSchema
(Object record) Called to obtain the schema of a record.GenericContainer.getSchema()
The schema of this instance.GenericData.AbstractArray.getSchema()
GenericData.EnumSymbol.getSchema()
GenericData.Fixed.getSchema()
GenericData.Record.getSchema()
GenericDatumReader.getSchema()
Return the writer's schema.Create a schema given an example datum.Methods in org.apache.avro.generic with parameters of type SchemaModifier and TypeMethodDescriptionint
Compare objects according to their schema.protected int
Comparison implementation.protected Object
GenericDatumReader.convert
(Object datum, Schema schema, LogicalType type, Conversion<?> conversion) Convert an underlying representation of a logical type (such as a ByteBuffer) to a higher level object (such as a BigDecimal).protected <T> Object
GenericDatumWriter.convert
(Schema schema, LogicalType logicalType, Conversion<T> conversion, Object datum) Convert a high level representation of a logical type (such as a BigDecimal) to its underlying representation object (such as a ByteBuffer).GenericData.createDatumReader
(Schema schema) Returns aDatumReader
for this kind of data.GenericData.createDatumReader
(Schema writer, Schema reader) Returns aDatumReader
for this kind of data.GenericData.createDatumWriter
(Schema schema) Returns aDatumWriter
for this kind of data.GenericData.createEnum
(String symbol, Schema schema) Called to create an enum value.protected Object
GenericDatumReader.createEnum
(String symbol, Schema schema) Called to create an enum value.GenericData.createFixed
(Object old, byte[] bytes, Schema schema) Called to create an fixed value.GenericData.createFixed
(Object old, Schema schema) Called to create an fixed value.protected Object
GenericDatumReader.createFixed
(Object old, byte[] bytes, Schema schema) Deprecated.As of Avro 1.6.0 this method has been moved toGenericData.createFixed(Object, byte[], Schema)
protected Object
GenericDatumReader.createFixed
(Object old, Schema schema) Deprecated.As of Avro 1.6.0 this method has been moved toGenericData.createFixed(Object, Schema)
<T> T
Makes a deep copy of a value given its schema.protected Class
GenericDatumReader.findStringClass
(Schema schema) Determines the class to used to represent a string Schema.GenericData.getNewRecordSupplier
(Schema schema) create a supplier that allows to get new record instances for a given schema in an optimized wayprotected Object
GenericData.getRecordState
(Object record, Schema schema) Produce state for repeated calls toGenericData.getField(Object,String,int,Object)
andGenericData.setField(Object,String,int,Object,Object)
on the same record.protected final ResolvingDecoder
GenericDatumReader.getResolver
(Schema actual, Schema expected) Gets a resolving decoder for use by this GenericDatumReader.int
Compute a hash code according to a schema, consistent withGenericData.compare(Object,Object,Schema)
.protected boolean
GenericData.instanceOf
(Schema schema, Object datum) Called byGenericData.resolveUnion(Schema,Object)
.protected Object
Called to create new array instances.GenericData.InstanceSupplier.newInstance
(Object oldInstance, Schema schema) Called to create new record instances.protected Object
Deprecated.As of Avro 1.6.0 this method has been moved toGenericData.newRecord(Object, Schema)
protected Object
GenericDatumReader.read
(Object old, Schema expected, ResolvingDecoder in) Called to read data.protected Object
GenericDatumReader.readArray
(Object old, Schema expected, ResolvingDecoder in) Called to read an array instance.protected Object
Called to read byte arrays.protected Object
Called to read an enum value.protected Object
Called to read a fixed value.protected Object
Called to read integers.protected Object
GenericDatumReader.readMap
(Object old, Schema expected, ResolvingDecoder in) Called to read a map instance.protected Object
GenericDatumReader.readMapKey
(Object old, Schema expected, Decoder in) Called by the default implementation ofGenericDatumReader.readMap(java.lang.Object, org.apache.avro.Schema, org.apache.avro.io.ResolvingDecoder)
to read a key value.protected Object
GenericDatumReader.readRecord
(Object old, Schema expected, ResolvingDecoder in) Called to read a record instance.protected Object
GenericDatumReader.readString
(Object old, Schema expected, Decoder in) Called to read strings.protected Object
GenericDatumReader.readWithConversion
(Object old, Schema expected, LogicalType logicalType, Conversion<?> conversion, ResolvingDecoder in) protected Object
GenericDatumReader.readWithoutConversion
(Object old, Schema expected, ResolvingDecoder in) int
GenericData.resolveUnion
(Schema union, Object datum) Return the index for a datum within a union.protected int
GenericDatumWriter.resolveUnion
(Schema union, Object datum) Called to find the index for a datum within a union.void
GenericDatumReader.setExpected
(Schema reader) Set the reader's schema.protected void
void
void
static void
GenericData.setStringType
(Schema s, GenericData.StringType stringType) Set the Java type to be used when reading this schema.static void
Skip an instance of a schema.boolean
Returns true if a Java datum matches a schema.protected void
Called to write data.protected void
GenericDatumWriter.writeArray
(Schema schema, Object datum, Encoder out) Called to write a array.protected void
Called to write an enum value.protected void
GenericDatumWriter.writeFixed
(Schema schema, Object datum, Encoder out) Called to write a fixed value.protected void
Called to write a map.protected void
GenericDatumWriter.writeRecord
(Schema schema, Object datum, Encoder out) Called to write a record.protected void
GenericDatumWriter.writeString
(Schema schema, Object datum, Encoder out) Called to write a string.protected void
GenericDatumWriter.writeWithoutConversion
(Schema schema, Object datum, Encoder out) Called to write data.Constructors in org.apache.avro.generic with parameters of type SchemaModifierConstructorDescriptionAbstractArray
(Schema schema) Array
(Schema schema, Collection<T> c) BooleanArray
(int capacity, Schema schema) BooleanArray
(Schema schema, Collection<Boolean> c) DoubleArray
(int capacity, Schema schema) DoubleArray
(Schema schema, Collection<Double> c) EnumSymbol
(Schema schema, Object symbol) Maps existing Objects into an Avro enum by calling toString(), eg for Java EnumsEnumSymbol
(Schema schema, String symbol) FloatArray
(int capacity, Schema schema) FloatArray
(Schema schema, Collection<Float> c) GenericDatumReader
(Schema schema) Construct where the writer's and reader's schemas are the same.GenericDatumReader
(Schema writer, Schema reader) Construct given writer's and reader's schema.GenericDatumReader
(Schema writer, Schema reader, GenericData data) GenericDatumWriter
(Schema root) GenericDatumWriter
(Schema root, GenericData data) GenericRecordBuilder
(Schema schema) Creates a GenericRecordBuilder for building Record instances.IntArray
(Schema schema, Collection<Integer> c) LongArray
(Schema schema, Collection<Long> c) -
Uses of Schema in org.apache.avro.io
Methods in org.apache.avro.io with parameters of type SchemaModifier and TypeMethodDescriptionstatic int
Compare binary encoded data.static int
Compare binary encoded data.<D> DatumReader
<D> FastReaderBuilder.createDatumReader
(Schema schema) <D> DatumReader
<D> FastReaderBuilder.createDatumReader
(Schema writerSchema, Schema readerSchema) void
FastReaderBuilder.RecordReader.finishInitialization
(FastReaderBuilder.ExecutionStep[] readSteps, Schema schema, GenericData.InstanceSupplier supp) static int
Hash binary encoded data.DecoderFactory.jsonDecoder
(Schema schema, InputStream input) Creates aJsonDecoder
using the InputStream provided for reading data that conforms to the Schema provided.DecoderFactory.jsonDecoder
(Schema schema, String input) Creates aJsonDecoder
using the String provided for reading data that conforms to the Schema provided.EncoderFactory.jsonEncoder
(Schema schema, OutputStream out) Creates aJsonEncoder
using the OutputStream provided for writing data conforming to the Schema provided.EncoderFactory.jsonEncoder
(Schema schema, OutputStream out, boolean pretty) Creates aJsonEncoder
using the OutputStream provided for writing data conforming to the Schema provided with optional pretty printing.EncoderFactory.jsonEncoder
(Schema schema, OutputStream out, boolean pretty, boolean autoflush) Creates aJsonEncoder
using the OutputStream provided for writing data conforming to the Schema provided with optional pretty printing.static Object
Produces an opaque resolver that can be used to construct a newResolvingDecoder(Object, Decoder)
.DecoderFactory.resolvingDecoder
(Schema writer, Schema reader, Decoder wrapped) Creates aResolvingDecoder
wrapping the Decoder provided.void
Set the writer's schema.void
Set the schema.default void
DecoderFactory.validatingDecoder
(Schema schema, Decoder wrapped) Creates aValidatingDecoder
wrapping the Decoder provided.EncoderFactory.validatingEncoder
(Schema schema, Encoder encoder) Creates aValidatingEncoder
that wraps the Encoder provided. -
Uses of Schema in org.apache.avro.io.parsing
Methods in org.apache.avro.io.parsing with parameters of type SchemaModifier and TypeMethodDescriptionstatic void
Encodes the given Json node n on to the encoder e according to the schema s.Returns the non-terminal that is the start symbol for the grammar for the grammar for the given schema sc.JsonGrammarGenerator.generate
(Schema sc, Map<org.apache.avro.io.parsing.ValidatingGrammarGenerator.LitS, Symbol> seen) Returns the non-terminal that is the start symbol for grammar of the given schema sc.final Symbol
Resolves the writer schema writer and the reader schema reader and returns the start symbol for the grammar generated.Returns the non-terminal that is the start symbol for the grammar for the given schema sc.ValidatingGrammarGenerator.generate
(Schema sc, Map<org.apache.avro.io.parsing.ValidatingGrammarGenerator.LitS, Symbol> seen) Returns the non-terminal that is the start symbol for the grammar for the given schema sc. -
Uses of Schema in org.apache.avro.message
Methods in org.apache.avro.message that return SchemaModifier and TypeMethodDescriptionSchemaStore.Cache.findByFingerprint
(long fingerprint) SchemaStore.findByFingerprint
(long fingerprint) Retrieves a fingerprint by its AVRO-CRC-64 fingerprint.Methods in org.apache.avro.message with parameters of type SchemaModifier and TypeMethodDescriptionvoid
Adds aSchema
that can be used to decode buffers.void
Adds a schema to this cache that can be retrieved using its AVRO-CRC-64 fingerprint.Constructors in org.apache.avro.message with parameters of type SchemaModifierConstructorDescriptionBinaryMessageDecoder
(GenericData model, Schema readSchema) Creates a newBinaryMessageEncoder
that uses the givendata model
to construct datum instances described by theschema
.BinaryMessageDecoder
(GenericData model, Schema readSchema, SchemaStore resolver) Creates a newBinaryMessageEncoder
that uses the givendata model
to construct datum instances described by theschema
.BinaryMessageEncoder
(GenericData model, Schema schema) Creates a newBinaryMessageEncoder
that uses the givendata model
to deconstruct datum instances described by theschema
.BinaryMessageEncoder
(GenericData model, Schema schema, boolean shouldCopy) Creates a newBinaryMessageEncoder
that uses the givendata model
to deconstruct datum instances described by theschema
.RawMessageDecoder
(GenericData model, Schema schema) Creates a newRawMessageDecoder
that uses the givendata model
to construct datum instances described by theschema
.RawMessageDecoder
(GenericData model, Schema writeSchema, Schema readSchema) Creates a newRawMessageDecoder
that uses the givendata model
to construct datum instances described by thereadSchema
.RawMessageEncoder
(GenericData model, Schema schema) Creates a newRawMessageEncoder
that uses the givendata model
to deconstruct datum instances described by theschema
.RawMessageEncoder
(GenericData model, Schema schema, boolean shouldCopy) Creates a newRawMessageEncoder
that uses the givendata model
to deconstruct datum instances described by theschema
. -
Uses of Schema in org.apache.avro.path
Methods in org.apache.avro.path with parameters of type SchemaModifier and TypeMethodDescriptionproduces a user-facing exception to be thrown back out to user codeConstructors in org.apache.avro.path with parameters of type SchemaModifierConstructorDescriptionTracingClassCastException
(ClassCastException cause, Object datum, Schema expected, boolean customCoderUsed) TracingNullPointException
(NullPointerException cause, Schema expected, boolean customCoderUsed) -
Uses of Schema in org.apache.avro.reflect
Fields in org.apache.avro.reflect declared as SchemaMethods in org.apache.avro.reflect that return SchemaModifier and TypeMethodDescriptionprotected Schema
ReflectData.AllowNull.createFieldSchema
(Field field, Map<String, Schema> names) protected Schema
ReflectData.createFieldSchema
(Field field, Map<String, Schema> names) Create a schema for a field.protected Schema
ReflectData.createSchema
(Type type, Map<String, Schema> names) protected Schema
ReflectData.getRecordSchema
(Object record) protected Schema
CustomEncoding.getSchema()
static Schema
ReflectData.makeNullable
(Schema schema) Create and return a union of the null schema and the provided schema.Methods in org.apache.avro.reflect with parameters of type SchemaModifier and TypeMethodDescriptionprotected int
ReflectData.createDatumReader
(Schema schema) ReflectData.createDatumReader
(Schema writer, Schema reader) ReflectData.createDatumWriter
(Schema schema) ReflectData.createFixed
(Object old, Schema schema) protected Object
ReflectData.createSchemaDefaultValue
(Type type, Field field, Schema fieldSchema) Get default value for a schema field.protected Object
ReflectData.getRecordState
(Object record, Schema schema) static Schema
ReflectData.makeNullable
(Schema schema) Create and return a union of the null schema and the provided schema.protected Object
protected Object
ReflectDatumReader.readArray
(Object old, Schema expected, ResolvingDecoder in) protected Object
protected Object
boolean
protected void
protected void
ReflectDatumWriter.writeArray
(Schema schema, Object datum, Encoder out) Called to write a array.Method parameters in org.apache.avro.reflect with type arguments of type SchemaModifier and TypeMethodDescriptionprotected Schema
ReflectData.AllowNull.createFieldSchema
(Field field, Map<String, Schema> names) protected Schema
ReflectData.createFieldSchema
(Field field, Map<String, Schema> names) Create a schema for a field.protected Schema
ReflectData.createSchema
(Type type, Map<String, Schema> names) Constructors in org.apache.avro.reflect with parameters of type SchemaModifierConstructorDescriptionReflectDatumReader
(Schema root) Construct where the writer's and reader's schemas are the same.ReflectDatumReader
(Schema writer, Schema reader) Construct given writer's and reader's schema.ReflectDatumReader
(Schema writer, Schema reader, ReflectData data) Construct given writer's and reader's schema and the data model.ReflectDatumWriter
(Schema root) ReflectDatumWriter
(Schema root, ReflectData reflectData) -
Uses of Schema in org.apache.avro.specific
Methods in org.apache.avro.specific that return SchemaModifier and TypeMethodDescriptionprotected Schema
SpecificData.createSchema
(Type type, Map<String, Schema> names) Create the schema for a Java type.protected Schema
SpecificData.getEnumSchema
(Object datum) Find the schema for a Java type.abstract Schema
SpecificExceptionBase.getSchema()
abstract Schema
SpecificFixed.getSchema()
Methods in org.apache.avro.specific with parameters of type SchemaModifier and TypeMethodDescriptionprotected int
SpecificData.createDatumReader
(Schema schema) SpecificData.createDatumReader
(Schema writer, Schema reader) SpecificData.createDatumWriter
(Schema schema) SpecificData.createEnum
(String symbol, Schema schema) SpecificData.createFixed
(Object old, Schema schema) protected Class
SpecificDatumReader.findStringClass
(Schema schema) Return the class that implements a schema, or null if none exists.static String
SpecificData.getClassName
(Schema schema) Returns the Java class name indicated by a schema's name and namespace.static SpecificData
SpecificData.getForSchema
(Schema reader) For RECORD and UNION type schemas, this method returns the SpecificData instance of the class associated with the schema, in order to get the right conversions for any logical types used.SpecificData.getNewRecordSupplier
(Schema schema) static Object
SpecificData.newInstance
(Class c, Schema s) Create an instance of a class.protected Object
SpecificDatumReader.readRecord
(Object old, Schema expected, ResolvingDecoder in) void
protected void
protected void
SpecificDatumWriter.writeRecord
(Schema schema, Object datum, Encoder out) protected void
SpecificDatumWriter.writeString
(Schema schema, Object datum, Encoder out) Method parameters in org.apache.avro.specific with type arguments of type SchemaModifier and TypeMethodDescriptionprotected Schema
SpecificData.createSchema
(Type type, Map<String, Schema> names) Create the schema for a Java type.Constructors in org.apache.avro.specific with parameters of type SchemaModifierConstructorDescriptionSpecificDatumReader
(Schema schema) Construct where the writer's and reader's schemas are the same.SpecificDatumReader
(Schema writer, Schema reader) Construct given writer's and reader's schema.SpecificDatumReader
(Schema writer, Schema reader, SpecificData data) Construct given writer's schema, reader's schema, and aSpecificData
.SpecificDatumWriter
(Schema schema) SpecificDatumWriter
(Schema root, SpecificData specificData) protected
SpecificErrorBuilderBase
(Schema schema) Creates a SpecificErrorBuilderBase for building errors of the given type.protected
SpecificErrorBuilderBase
(Schema schema, SpecificData model) Creates a SpecificErrorBuilderBase for building errors of the given type.protected
SpecificRecordBuilderBase
(Schema schema) Creates a SpecificRecordBuilderBase for building records of the given type.protected
SpecificRecordBuilderBase
(Schema schema, SpecificData model) Creates a SpecificRecordBuilderBase for building records of the given type. -
Uses of Schema in org.apache.avro.util
Methods in org.apache.avro.util that return SchemaModifier and TypeMethodDescriptionSchemaResolver.ResolvingVisitor.getResolved
(Schema schema) static Schema
SchemaResolver.unresolvedSchema
(String name) Create a schema to represent an "unresolved" schema.Methods in org.apache.avro.util with parameters of type SchemaModifier and TypeMethodDescriptionSchemaResolver.IsResolvedSchemaVisitor.afterVisitNonTerminal
(Schema nonTerminal) SchemaResolver.ResolvingVisitor.afterVisitNonTerminal
(Schema nt) SchemaVisitor.afterVisitNonTerminal
(Schema nonTerminal) Invoked for schemas with children after its children have been visited.void
SchemaResolver.ResolvingVisitor.copyProperties
(Schema first, Schema second) static String
SchemaResolver.ResolvingVisitor.getResolved
(Schema schema) static String
SchemaResolver.getUnresolvedSchemaName
(Schema schema) Get the unresolved schema name.static boolean
SchemaResolver.isFullyResolvedSchema
(Schema schema) Is this an unresolved schema?static boolean
SchemaResolver.isUnresolvedSchema
(Schema schema) Is this an unresolved schema.static <T> T
Schemas.visit
(Schema start, SchemaVisitor<T> visitor) Depth first visit.SchemaResolver.IsResolvedSchemaVisitor.visitNonTerminal
(Schema nonTerminal) SchemaResolver.ResolvingVisitor.visitNonTerminal
(Schema nt) SchemaVisitor.visitNonTerminal
(Schema nonTerminal) Invoked for schema with children before proceeding to visit the children.SchemaResolver.IsResolvedSchemaVisitor.visitTerminal
(Schema terminal) SchemaResolver.ResolvingVisitor.visitTerminal
(Schema terminal) SchemaVisitor.visitTerminal
(Schema terminal) Invoked for schemas that do not have "child" schemas (like string, int …) or for a previously encountered schema with children, which will be treated as a terminal.Constructors in org.apache.avro.util with parameters of type SchemaModifierConstructorDescriptionRandomData
(GenericData genericData, Schema schema, int count) RandomData
(GenericData genericData, Schema schema, int count, boolean utf8ForString) RandomData
(GenericData genericData, Schema schema, int count, long seed) RandomData
(GenericData genericData, Schema schema, int count, long seed, boolean utf8ForString) RandomData
(Schema schema, int count) RandomData
(Schema schema, int count, boolean utf8ForString) RandomData
(Schema schema, int count, long seed) RandomData
(Schema schema, int count, long seed, boolean utf8ForString) Constructor parameters in org.apache.avro.util with type arguments of type Schema
SchemaParser.parse(CharSequence)
.