org.apache.pulsar.client.api.schema

Interface GenericRecord

All Superinterfaces:

GenericObject

@InterfaceAudience.Public
 @InterfaceStability.Stable
public interface GenericRecord
extends GenericObject

An interface represents a message with schema.

Method Summary

Modifier and Type	Method and Description
default Object	getField(Field field) Retrieve the value of the provided field.
Object	getField(String fieldName) Retrieve the value of the provided fieldName.
List<Field>	getFields() Returns the list of fields associated with the record.
default Object	getNativeObject() Return the internal native representation of the Record, like a AVRO GenericRecord.
default SchemaType	getSchemaType() Return the schema tyoe.
byte[]	getSchemaVersion() Return schema version.

Method Detail

getSchemaVersion

byte[] getSchemaVersion()

Return schema version.

Returns:

schema version, or null if the information is not available.

getFields

List<Field> getFields()

Returns the list of fields associated with the record.

Returns:

the list of fields associated with the record.

getField

default Object getField(Field field)

Retrieve the value of the provided field.

Parameters:

field - the field to retrieve the value

Returns:

the value object

getField

Object getField(String fieldName)

Retrieve the value of the provided fieldName.

Parameters:

fieldName - the field name

Returns:

the value object, or null if field doesn't exist

getSchemaType

default SchemaType getSchemaType()

Return the schema tyoe.

Specified by:

getSchemaType in interface GenericObject

Returns:

the schema type

Throws:

UnsupportedOperationException - if this feature is not implemented

See Also:

SchemaType.AVRO, SchemaType.PROTOBUF_NATIVE, SchemaType.JSON

getNativeObject

default Object getNativeObject()

Return the internal native representation of the Record, like a AVRO GenericRecord.

Specified by:

getNativeObject in interface GenericObject

Returns:

the internal representation of the record

Throws:

UnsupportedOperationException - if the operation is not supported