B C D E G H I P S V

B

BEHAVIOR_PERMISSIVE - Static variable in class com.ibm.eventstreams.serdes.SchemaRegistryConfig

A value for the SchemaRegistryConfig.PROPERTY_BEHAVIOR_TYPE property to specify that the deserializer should return null for records that cannot be deserialized.

BEHAVIOR_STRICT - Static variable in class com.ibm.eventstreams.serdes.SchemaRegistryConfig

A value for the SchemaRegistryConfig.PROPERTY_BEHAVIOR_TYPE property to specify that the deserializer should throw an exception for records that cannot be deserialized.

C

close() - Method in class com.ibm.eventstreams.serdes.EventStreamsDeserializer

close() - Method in class com.ibm.eventstreams.serdes.EventStreamsSerdes

close() - Method in class com.ibm.eventstreams.serdes.EventStreamsSerializer

com.ibm.eventstreams.serdes - package com.ibm.eventstreams.serdes

Provides classes to serialize generic or specific IndexedRecord objects into Kafka records and deserialize generic or specific IndexedRecord objects from Kafka records using schemas retrieved from an IBM Event Streams schema registry.

com.ibm.eventstreams.serdes.exceptions - package com.ibm.eventstreams.serdes.exceptions

Exceptions that can occur when serializing and deserializing records using schemas retrieved from an IBM Event Streams schema registry.

configure(Map<String, ?>, boolean) - Method in class com.ibm.eventstreams.serdes.EventStreamsDeserializer

configure(Map<String, ?>, boolean) - Method in class com.ibm.eventstreams.serdes.EventStreamsSerdes

configure(Map<String, ?>, boolean) - Method in class com.ibm.eventstreams.serdes.EventStreamsSerializer

createHeaders(Map<String, String>) - Static method in class com.ibm.eventstreams.serdes.HeaderFactory

Create Kafka headers from a map of String keys and String values.

D

deserialize(String, byte[]) - Method in class com.ibm.eventstreams.serdes.EventStreamsDeserializer

deserialize(String, Headers, byte[]) - Method in class com.ibm.eventstreams.serdes.EventStreamsDeserializer

deserializer() - Method in class com.ibm.eventstreams.serdes.EventStreamsSerdes

E

ENCODING_BINARY - Static variable in class com.ibm.eventstreams.serdes.SchemaRegistryConfig

A value for the SchemaRegistryConfig.PROPERTY_ENCODING_TYPE property to indicate that serialized messages should be binary encoded.

ENCODING_JSON - Static variable in class com.ibm.eventstreams.serdes.SchemaRegistryConfig

A value for the SchemaRegistryConfig.PROPERTY_ENCODING_TYPE property to indicate that serialized messages should be JSON encoded.

EventStreamsDeserializer - Class in com.ibm.eventstreams.serdes

The Event Streams deserializer used by Kafka to convert bytes to generic or specific IndexedRecord objects, using schemas retrieved from the schema registry.

EventStreamsDeserializer() - Constructor for class com.ibm.eventstreams.serdes.EventStreamsDeserializer

EventStreamsSerdes - Class in com.ibm.eventstreams.serdes

Wraps the Event Streams serializer and deserializer.

EventStreamsSerdes() - Constructor for class com.ibm.eventstreams.serdes.EventStreamsSerdes

EventStreamsSerializer - Class in com.ibm.eventstreams.serdes

The Event Streams serializer used by Kafka to convert generic or specific IndexedRecord objects to bytes, using schemas retrieved from the schema registry.

EventStreamsSerializer() - Constructor for class com.ibm.eventstreams.serdes.EventStreamsSerializer

G

getActualSchema() - Method in exception com.ibm.eventstreams.serdes.exceptions.SchemaMismatchException

Returns the actual schema

getDefaultSchema() - Method in class com.ibm.eventstreams.serdes.SchemaRegistry

Get the default schema as determined by the SchemaRegistryConfig.PROPERTY_SCHEMA_ID_OVERRIDE and SchemaRegistryConfig.PROPERTY_SCHEMA_VERSION_OVERRIDE configuration options.

getExpectedSchema() - Method in exception com.ibm.eventstreams.serdes.exceptions.SchemaMismatchException

Returns the expected schema

getHeader() - Method in exception com.ibm.eventstreams.serdes.exceptions.HeaderNotFoundException

Returns the header that was missing from the record.

getId() - Method in class com.ibm.eventstreams.serdes.SchemaInfo

Returns the ID of the schema.

getIdAsBytes() - Method in class com.ibm.eventstreams.serdes.SchemaInfo

Returns the unique ID for the schema as bytes.

getName() - Method in class com.ibm.eventstreams.serdes.SchemaInfo

Returns the name of the schema.

getOverrideHeaders() - Method in class com.ibm.eventstreams.serdes.SchemaRegistry

Get the Kafka headers for the default schema as determined by the SchemaRegistryConfig.PROPERTY_SCHEMA_ID_OVERRIDE and SchemaRegistryConfig.PROPERTY_SCHEMA_VERSION_OVERRIDE configuration options.

getProperty() - Method in exception com.ibm.eventstreams.serdes.exceptions.InvalidPropertyValueException

Returns the property that was incorrectly specified.

getProperty() - Method in exception com.ibm.eventstreams.serdes.exceptions.PropertyNotFoundException

Returns the property that was missing from the configuration.

getSchema() - Method in class com.ibm.eventstreams.serdes.SchemaInfo

Returns the Avro schema definition.

getSchema(String, int) - Method in class com.ibm.eventstreams.serdes.SchemaRegistry

Retrieves a single schema from the Registry.

getSchema(String, String) - Method in class com.ibm.eventstreams.serdes.SchemaRegistry

Retrieves a single schema from the Registry.

getSchemaId() - Method in exception com.ibm.eventstreams.serdes.exceptions.SchemaNotFoundException

Returns the ID of the schema that could not be found.

getSchemaName() - Method in exception com.ibm.eventstreams.serdes.exceptions.SchemaDisabledException

Returns the disabled schema name

getSchemaVersion() - Method in exception com.ibm.eventstreams.serdes.exceptions.SchemaDisabledException

Returns the disabled schema version

getSchemaVersion() - Method in exception com.ibm.eventstreams.serdes.exceptions.SchemaNotFoundException

Returns the version of the schema that could not be found.

getState() - Method in class com.ibm.eventstreams.serdes.SchemaInfo

Returns whether this schema is active or deprecated.

getStateDeprecationComment() - Method in class com.ibm.eventstreams.serdes.SchemaInfo

Returns the comment associated with the reason for deprecation of this schema.

getStatus() - Method in exception com.ibm.eventstreams.serdes.exceptions.SchemaRegistryApiException

getStatus() - Method in exception com.ibm.eventstreams.serdes.exceptions.SchemaRegistryAuthException

Returns the HTTP status code to enable differentiation between an invalid API key (401) and an API key that isn't allowed to access the Schema Registry (403).

getStatus() - Method in exception com.ibm.eventstreams.serdes.exceptions.SchemaRegistryServerErrorException

getVersion() - Method in class com.ibm.eventstreams.serdes.SchemaInfo

Returns the version number for this version of the schema.

getVersionAsBytes() - Method in class com.ibm.eventstreams.serdes.SchemaInfo

Returns the version number for this version of the schema as bytes.

getVersionName() - Method in class com.ibm.eventstreams.serdes.SchemaInfo

Returns the version name for this version of the schema.

getVersionState() - Method in class com.ibm.eventstreams.serdes.SchemaInfo

Returns whether this version of the schema is active or deprecated.

getVersionStateDeprecationComment() - Method in class com.ibm.eventstreams.serdes.SchemaInfo

Returns the comment associated with the reason for deprecation of this version of the schema.

H

HEADER_SCHEMA_ENCODING - Static variable in class com.ibm.eventstreams.serdes.SchemaRegistryConfig

Used in message headers to identify the encoding for a message.

HEADER_SCHEMA_ID - Static variable in class com.ibm.eventstreams.serdes.SchemaRegistryConfig

Used in message headers to identify the UUID for the schema in use for the message.

HEADER_SCHEMA_VERSION - Static variable in class com.ibm.eventstreams.serdes.SchemaRegistryConfig

Used in message headers to identify the version number for the schema in use for the message.

HeaderFactory - Class in com.ibm.eventstreams.serdes

Factory class to create Kafka headers

HeaderFactory() - Constructor for class com.ibm.eventstreams.serdes.HeaderFactory

HeaderNotFoundException - Exception in com.ibm.eventstreams.serdes.exceptions

Indicates that a record was encountered without a required header.

HeaderNotFoundException(String) - Constructor for exception com.ibm.eventstreams.serdes.exceptions.HeaderNotFoundException

HeadersNotFoundException - Exception in com.ibm.eventstreams.serdes.exceptions

Indicates that a record was encountered without a set of headers.

HeadersNotFoundException() - Constructor for exception com.ibm.eventstreams.serdes.exceptions.HeadersNotFoundException

I

InvalidPropertyValueException - Exception in com.ibm.eventstreams.serdes.exceptions

Indicates that a serializer or deserializer class could not be initialised due to a property being provided with an invalid value.

InvalidPropertyValueException(String) - Constructor for exception com.ibm.eventstreams.serdes.exceptions.InvalidPropertyValueException

isEnabled() - Method in class com.ibm.eventstreams.serdes.SchemaInfo

Returns whether this schema is enabled or disabled.

isVersionEnabled() - Method in class com.ibm.eventstreams.serdes.SchemaInfo

Returns whether this version of the schema is enabled or disabled.

P

PROPERTY_API_SKIP_SSL_VALIDATION - Static variable in class com.ibm.eventstreams.serdes.SchemaRegistryConfig

Used in Consumer and Producer configuration properties to specify whether SSL validation should be skipped when accessing the Schema Registry REST API.

PROPERTY_API_URL - Static variable in class com.ibm.eventstreams.serdes.SchemaRegistryConfig

Used in Consumer and Producer configuration properties to specify the location of the Schema Registry REST API.

PROPERTY_BEHAVIOR_TYPE - Static variable in class com.ibm.eventstreams.serdes.SchemaRegistryConfig

Used in Consumer configuration properties to control how the deserializer should handle records that cannot be deserialized.

PROPERTY_ENCODING_TYPE - Static variable in class com.ibm.eventstreams.serdes.SchemaRegistryConfig

Used in Consumer and Producer configuration properties to specify whether serialized messages should be JSON or binary encoded.

PROPERTY_OUTPUT_GENERIC - Static variable in class com.ibm.eventstreams.serdes.SchemaRegistryConfig

Used in Consumer configuration properties to specify whether to always return the consumer record value as a generic record.

PROPERTY_SCHEMA_CACHE_REFRESH_RATE - Static variable in class com.ibm.eventstreams.serdes.SchemaRegistryConfig

Used in Producer/Consumer configuration properties to specify the refresh rate of cached schemas.

PROPERTY_SCHEMA_ID_OVERRIDE - Static variable in class com.ibm.eventstreams.serdes.SchemaRegistryConfig

Used in Producer and Stream configuration to override the schema id header in the message if applicable.

PROPERTY_SCHEMA_VERSION_OVERRIDE - Static variable in class com.ibm.eventstreams.serdes.SchemaRegistryConfig

Used in Producer and Stream configuration to override the schema version header in the message if applicable.

PropertyNotFoundException - Exception in com.ibm.eventstreams.serdes.exceptions

Indicates that a serializer or deserializer class could not be initialised due to a required property not being set.

PropertyNotFoundException(String) - Constructor for exception com.ibm.eventstreams.serdes.exceptions.PropertyNotFoundException

S

SchemaDisabledException - Exception in com.ibm.eventstreams.serdes.exceptions

Indicates that a schema is disabled and cannot be used

SchemaDisabledException(String) - Constructor for exception com.ibm.eventstreams.serdes.exceptions.SchemaDisabledException

SchemaDisabledException(String, String) - Constructor for exception com.ibm.eventstreams.serdes.exceptions.SchemaDisabledException

SchemaInfo - Class in com.ibm.eventstreams.serdes

Information about a single version of a single schema, retrieved from the Schema Registry.

SchemaInfo.State - Enum in com.ibm.eventstreams.serdes

Possible states for a schema or schema version.

SchemaMismatchException - Exception in com.ibm.eventstreams.serdes.exceptions

Indicates that a schema does not match what is expected

SchemaMismatchException(String, Schema, Schema) - Constructor for exception com.ibm.eventstreams.serdes.exceptions.SchemaMismatchException

SchemaMismatchException(Schema, Schema) - Constructor for exception com.ibm.eventstreams.serdes.exceptions.SchemaMismatchException

SchemaNotFoundException - Exception in com.ibm.eventstreams.serdes.exceptions

Indicates that a schema could not be found in the registry.

SchemaNotFoundException(String) - Constructor for exception com.ibm.eventstreams.serdes.exceptions.SchemaNotFoundException

SchemaNotFoundException(String, String) - Constructor for exception com.ibm.eventstreams.serdes.exceptions.SchemaNotFoundException

SchemaRegistry - Class in com.ibm.eventstreams.serdes

Helper class for retrieving schema definitions from the Schema Registry.

SchemaRegistry(Properties) - Constructor for class com.ibm.eventstreams.serdes.SchemaRegistry

SchemaRegistry(String, String, boolean) - Constructor for class com.ibm.eventstreams.serdes.SchemaRegistry

SchemaRegistryApiException - Exception in com.ibm.eventstreams.serdes.exceptions

Thrown in the event of an unexpected response from the Schema Registry.

SchemaRegistryApiException(int) - Constructor for exception com.ibm.eventstreams.serdes.exceptions.SchemaRegistryApiException

SchemaRegistryApiException(int, Throwable) - Constructor for exception com.ibm.eventstreams.serdes.exceptions.SchemaRegistryApiException

SchemaRegistryAuthException - Exception in com.ibm.eventstreams.serdes.exceptions

Indicates an authentication failure with the credentials provided by the client.

SchemaRegistryAuthException(int) - Constructor for exception com.ibm.eventstreams.serdes.exceptions.SchemaRegistryAuthException

SchemaRegistryAuthException(int, Throwable) - Constructor for exception com.ibm.eventstreams.serdes.exceptions.SchemaRegistryAuthException

SchemaRegistryConfig - Class in com.ibm.eventstreams.serdes

The Event Streams schema registry configuration keys and values

SchemaRegistryConfig() - Constructor for class com.ibm.eventstreams.serdes.SchemaRegistryConfig

SchemaRegistryConnectionException - Exception in com.ibm.eventstreams.serdes.exceptions

Thrown in the event of a failure to connect to the Schema Registry.

SchemaRegistryConnectionException(Throwable) - Constructor for exception com.ibm.eventstreams.serdes.exceptions.SchemaRegistryConnectionException

SchemaRegistryServerErrorException - Exception in com.ibm.eventstreams.serdes.exceptions

Indicates a server error (e.g.

SchemaRegistryServerErrorException(int) - Constructor for exception com.ibm.eventstreams.serdes.exceptions.SchemaRegistryServerErrorException

SchemaRegistryServerErrorException(int, String) - Constructor for exception com.ibm.eventstreams.serdes.exceptions.SchemaRegistryServerErrorException

serialize(String, IndexedRecord) - Method in class com.ibm.eventstreams.serdes.EventStreamsSerializer

serialize(String, Headers, IndexedRecord) - Method in class com.ibm.eventstreams.serdes.EventStreamsSerializer

serializer() - Method in class com.ibm.eventstreams.serdes.EventStreamsSerdes

V

valueOf(String) - Static method in enum com.ibm.eventstreams.serdes.SchemaInfo.State

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.ibm.eventstreams.serdes.SchemaInfo.State

Returns an array containing the constants of this enum type, in the order they are declared.

B C D E G H I P S V