com.ibm.eventstreams.serdes

Class SchemaRegistryConfig



  • public class SchemaRegistryConfig
    extends Object
    The Event Streams schema registry configuration keys and values
    • Field Detail

      • PROPERTY_API_URL

        public static final String PROPERTY_API_URL
        Used in Consumer and Producer configuration properties to specify the location of the Schema Registry REST API.
        See Also:
        Constant Field Values
      • PROPERTY_API_SKIP_SSL_VALIDATION

        public static final String PROPERTY_API_SKIP_SSL_VALIDATION
        Used in Consumer and Producer configuration properties to specify whether SSL validation should be skipped when accessing the Schema Registry REST API.
        See Also:
        Constant Field Values
      • PROPERTY_OUTPUT_GENERIC

        public static final String PROPERTY_OUTPUT_GENERIC
        Used in Consumer configuration properties to specify whether to always return the consumer record value as a generic record. If not specified or set to false deserializer will be to return a specific record when available.
        See Also:
        Constant Field Values
      • PROPERTY_SCHEMA_CACHE_REFRESH_RATE

        public static final String PROPERTY_SCHEMA_CACHE_REFRESH_RATE
        Used in Producer/Consumer configuration properties to specify the refresh rate of cached schemas. Expects an instance of a java.lang.Long with the value set being in milliseconds. Setting this value to a negative number will refresh the cache with each message sent, this is not recommended for producers/consumers with high throughput. If not specified this value will default to 600,000 milliseconds (10 minutes).
        See Also:
        Constant Field Values
      • PROPERTY_SCHEMA_ID_OVERRIDE

        public static final String PROPERTY_SCHEMA_ID_OVERRIDE
        Used in Producer and Stream configuration to override the schema id header in the message if applicable. If override property has been given a value and the message schema does not match the header schema then the override schema will be checked and the headers overwritten if a match is found. If no schema headers are found in the message and this property is set, the serializer will attempt to set the schema message headers. Cannot work without PROPERTY_SCHEMA_VERSION_OVERRIDE also being set.
        See Also:
        Constant Field Values
      • PROPERTY_SCHEMA_VERSION_OVERRIDE

        public static final String PROPERTY_SCHEMA_VERSION_OVERRIDE
        Used in Producer and Stream configuration to override the schema version header in the message if applicable. If override property has been given a value and the message schema does not match the header schema then the override schema will be checked and the headers overwritten if a match is found. If no schema headers are found in the message and this property is set, the serializer will attempt to set the schema message headers. Cannot work without PROPERTY_SCHEMA_ID_OVERRIDE also being set.
        See Also:
        Constant Field Values
      • PROPERTY_BEHAVIOR_TYPE

        public static final String PROPERTY_BEHAVIOR_TYPE
        Used in Consumer configuration properties to control how the deserializer should handle records that cannot be deserialized. If not specified, the deserializer will follow BEHAVIOR_STRICT behavior (which is that an exception will be thrown for records that are not deserializable).
        See Also:
        Constant Field Values
      • PROPERTY_ENCODING_TYPE

        public static final String PROPERTY_ENCODING_TYPE
        Used in Consumer and Producer configuration properties to specify whether serialized messages should be JSON or binary encoded. If not specified, messages will be ENCODING_BINARY binary encoded.
        See Also:
        Constant Field Values
      • HEADER_SCHEMA_ID

        public static final String HEADER_SCHEMA_ID
        Used in message headers to identify the UUID for the schema in use for the message.
        See Also:
        Constant Field Values
      • HEADER_SCHEMA_VERSION

        public static final String HEADER_SCHEMA_VERSION
        Used in message headers to identify the version number for the schema in use for the message.
        See Also:
        Constant Field Values
      • HEADER_SCHEMA_ENCODING

        public static final String HEADER_SCHEMA_ENCODING
        Used in message headers to identify the encoding for a message.
        See Also:
        Constant Field Values
    • Constructor Detail

      • SchemaRegistryConfig

        public SchemaRegistryConfig()

Copyright © 2019. All rights reserved.