Package io.confluent.kafka.schemaregistry.client

Interface SchemaRegistryClient

All Superinterfaces:

AutoCloseable, Closeable, SchemaVersionFetcher

All Known Implementing Classes:

CachedSchemaRegistryClient, MockSchemaRegistryClient

public interface SchemaRegistryClient
extends Closeable, SchemaVersionFetcher

Method Summary

Modifier and Type	Method	Description
default void	close()
default AssociationResponse	createAssociation(AssociationCreateOrUpdateRequest request)
default AssociationResponse	createOrUpdateAssociation(AssociationCreateOrUpdateRequest request)
default void	deleteAssociations(String resourceId, String resourceType, List<String> associationTypes, boolean cascadeLifecycle)
default void	deleteCompatibility(String subject)
default void	deleteConfig(String subject)
default void	deleteMode(String subject)
default Integer	deleteSchemaVersion(String subject, String version)
default Integer	deleteSchemaVersion(String subject, String version, boolean isPermanent)
default Integer	deleteSchemaVersion(Map<String,String> requestProperties, String subject, String version)
default Integer	deleteSchemaVersion(Map<String,String> requestProperties, String subject, String version, boolean isPermanent)
default List<Integer>	deleteSubject(String subject)
default List<Integer>	deleteSubject(String subject, boolean isPermanent)
default List<Integer>	deleteSubject(Map<String,String> requestProperties, String subject)
default List<Integer>	deleteSubject(Map<String,String> requestProperties, String subject, boolean isPermanent)
default Collection<String>	getAllContexts()
Collection<String>	getAllSubjects()
default Collection<String>	getAllSubjects(boolean lookupDeletedSubject)
Collection<String>	getAllSubjectsById(int id)
default Collection<String>	getAllSubjectsByPrefix(String subjectPrefix)
List<Integer>	getAllVersions(String subject)
default List<Integer>	getAllVersions(String subject, boolean lookupDeletedSchema)
default Collection<SubjectVersion>	getAllVersionsById(int id)
default List<Association>	getAssociationsByResourceId(String resourceId, String resourceType, List<String> associationTypes, String lifecycle, int offset, int limit)
default List<Association>	getAssociationsBySubject(String subject, String resourceType, List<String> associationTypes, String lifecycle, int offset, int limit)
default org.apache.avro.Schema	getById(int id)	Deprecated. use getSchemaById(int) instead
default org.apache.avro.Schema	getByID(int id)	Deprecated. use getSchemaById(int) instead
default org.apache.avro.Schema	getBySubjectAndId(String subject, int id)	Deprecated. use getSchemaBySubjectAndId(String, int) instead
default org.apache.avro.Schema	getBySubjectAndID(String subject, int id)	Deprecated. use getSchemaBySubjectAndId(String, int) instead
default Schema	getByVersion(String subject, int version, boolean lookupDeletedSchema)
default String	getCompatibility(String subject)
default Config	getConfig(String subject)
default String	getGuid(String subject, ParsedSchema schema)
default String	getGuid(String subject, ParsedSchema schema, boolean normalize)
int	getId(String subject, ParsedSchema schema)
default int	getId(String subject, ParsedSchema schema, boolean normalize)
default int	getId(String subject, org.apache.avro.Schema schema)	Deprecated.
default RegisterSchemaResponse	getIdWithResponse(String subject, ParsedSchema schema, boolean normalize)
SchemaMetadata	getLatestSchemaMetadata(String subject)
default SchemaMetadata	getLatestWithMetadata(String subject, Map<String,String> metadata, boolean lookupDeletedSchema)
String	getMode()
String	getMode(String subject)
default ParsedSchema	getSchemaByGuid(String guid, String format)
ParsedSchema	getSchemaById(int id)
ParsedSchema	getSchemaBySubjectAndId(String subject, int id)
SchemaMetadata	getSchemaMetadata(String subject, int version)
default SchemaMetadata	getSchemaMetadata(String subject, int version, boolean lookupDeletedSchema)
default SchemaRegistryDeployment	getSchemaRegistryDeployment()
default SchemaRegistryServerVersion	getSchemaRegistryServerVersion()
default List<ParsedSchema>	getSchemas(String subjectPrefix, boolean lookupDeletedSchema, boolean latestOnly)
int	getVersion(String subject, ParsedSchema schema)
default int	getVersion(String subject, ParsedSchema schema, boolean normalize)
default int	getVersion(String subject, org.apache.avro.Schema schema)	Deprecated.
default Optional<ParsedSchema>	parseSchema(Schema schema)
Optional<ParsedSchema>	parseSchema(String schemaType, String schemaString, List<SchemaReference> references)
default Optional<ParsedSchema>	parseSchema(String schemaType, String schemaString, List<SchemaReference> references, Metadata metadata, RuleSet ruleSet)
default ParsedSchema	parseSchemaOrElseThrow(Schema schema)
int	register(String subject, ParsedSchema schema)
default int	register(String subject, ParsedSchema schema, boolean normalize)
int	register(String subject, ParsedSchema schema, int version, int id)
default int	register(String subject, org.apache.avro.Schema schema)	Deprecated. use register(String, ParsedSchema) instead; for example, you can convert a Schema into a ParsedSchema via new AvroSchema(schema)
default int	register(String subject, org.apache.avro.Schema schema, int version, int id)	Deprecated. use register(String, ParsedSchema, int, int) instead; for example, you can convert a Schema into a ParsedSchema via new AvroSchema(schema)
default RegisterSchemaResponse	registerWithResponse(String subject, ParsedSchema schema, boolean normalize)
default RegisterSchemaResponse	registerWithResponse(String subject, ParsedSchema schema, boolean normalize, boolean propagateSchemaTags)
void	reset()
String	setMode(String mode)
String	setMode(String mode, String subject)
default String	setMode(String mode, String subject, boolean force)
default String	tenant()
boolean	testCompatibility(String subject, ParsedSchema schema)
default boolean	testCompatibility(String subject, org.apache.avro.Schema schema)	Deprecated.
default List<String>	testCompatibilityVerbose(String subject, ParsedSchema schema)
default List<String>	testCompatibilityVerbose(String subject, ParsedSchema schema, boolean normalize)
default com.google.common.base.Ticker	ticker()
default String	updateCompatibility(String subject, String compatibility)
default Config	updateConfig(String subject, Config config)

Method Details

tenant

default String tenant()

Specified by:

tenant in interface SchemaVersionFetcher

ticker

default com.google.common.base.Ticker ticker()

parseSchema

Optional<ParsedSchema> parseSchema(String schemaType,
 String schemaString,
 List<SchemaReference> references)

parseSchema

default Optional<ParsedSchema> parseSchema(String schemaType,
 String schemaString,
 List<SchemaReference> references,
 Metadata metadata,
 RuleSet ruleSet)

parseSchema

default Optional<ParsedSchema> parseSchema(Schema schema)

parseSchemaOrElseThrow

default ParsedSchema parseSchemaOrElseThrow(Schema schema)
                                     throws IOException

Throws:

IOException

register

@Deprecated
default int register(String subject,
 org.apache.avro.Schema schema)
              throws IOException,
RestClientException

Deprecated.

use register(String, ParsedSchema) instead; for example, you can convert a Schema into a ParsedSchema via new AvroSchema(schema)

Throws:

IOException

RestClientException

register

int register(String subject,
 ParsedSchema schema)
      throws IOException,
RestClientException

Throws:

IOException

RestClientException

register

default int register(String subject,
 ParsedSchema schema,
 boolean normalize)
              throws IOException,
RestClientException

Throws:

IOException

RestClientException

register

@Deprecated
default int register(String subject,
 org.apache.avro.Schema schema,
 int version,
 int id)
              throws IOException,
RestClientException

Deprecated.

use register(String, ParsedSchema, int, int) instead; for example, you can convert a Schema into a ParsedSchema via new AvroSchema(schema)

Throws:

IOException

RestClientException

register

int register(String subject,
 ParsedSchema schema,
 int version,
 int id)
      throws IOException,
RestClientException

Throws:

IOException

RestClientException

registerWithResponse

default RegisterSchemaResponse registerWithResponse(String subject,
 ParsedSchema schema,
 boolean normalize)
                                             throws IOException,
RestClientException

Throws:

IOException

RestClientException

registerWithResponse

default RegisterSchemaResponse registerWithResponse(String subject,
 ParsedSchema schema,
 boolean normalize,
 boolean propagateSchemaTags)
                                             throws IOException,
RestClientException

Throws:

IOException

RestClientException

getByID

@Deprecated
default org.apache.avro.Schema getByID(int id)
                                throws IOException,
RestClientException

Deprecated.

use getSchemaById(int) instead

Throws:

IOException

RestClientException

getById

@Deprecated
default org.apache.avro.Schema getById(int id)
                                throws IOException,
RestClientException

Deprecated.

use getSchemaById(int) instead

Throws:

IOException

RestClientException

getSchemaById

ParsedSchema getSchemaById(int id)
                    throws IOException,
RestClientException

Throws:

IOException

RestClientException

getBySubjectAndID

@Deprecated
default org.apache.avro.Schema getBySubjectAndID(String subject,
 int id)
                                          throws IOException,
RestClientException

Deprecated.

use getSchemaBySubjectAndId(String, int) instead

Throws:

IOException

RestClientException

getBySubjectAndId

@Deprecated
default org.apache.avro.Schema getBySubjectAndId(String subject,
 int id)
                                          throws IOException,
RestClientException

Deprecated.

use getSchemaBySubjectAndId(String, int) instead

Throws:

IOException

RestClientException

getSchemaBySubjectAndId

ParsedSchema getSchemaBySubjectAndId(String subject,
 int id)
                              throws IOException,
RestClientException

Throws:

IOException

RestClientException

getSchemaByGuid

default ParsedSchema getSchemaByGuid(String guid,
 String format)
                              throws IOException,
RestClientException

Throws:

IOException

RestClientException

getSchemas

default List<ParsedSchema> getSchemas(String subjectPrefix,
 boolean lookupDeletedSchema,
 boolean latestOnly)
                               throws IOException,
RestClientException

Throws:

IOException

RestClientException

getAllSubjectsById

Collection<String> getAllSubjectsById(int id)
                               throws IOException,
RestClientException

Throws:

IOException

RestClientException

getAllVersionsById

default Collection<SubjectVersion> getAllVersionsById(int id)
                                               throws IOException,
RestClientException

Throws:

IOException

RestClientException

getByVersion

default Schema getByVersion(String subject,
 int version,
 boolean lookupDeletedSchema)

Specified by:

getByVersion in interface SchemaVersionFetcher

getLatestSchemaMetadata

SchemaMetadata getLatestSchemaMetadata(String subject)
                                throws IOException,
RestClientException

Throws:

IOException

RestClientException

getSchemaMetadata

SchemaMetadata getSchemaMetadata(String subject,
 int version)
                          throws IOException,
RestClientException

Throws:

IOException

RestClientException

getSchemaMetadata

default SchemaMetadata getSchemaMetadata(String subject,
 int version,
 boolean lookupDeletedSchema)
                                  throws IOException,
RestClientException

Throws:

IOException

RestClientException

getLatestWithMetadata

default SchemaMetadata getLatestWithMetadata(String subject,
 Map<String,String> metadata,
 boolean lookupDeletedSchema)
                                      throws IOException,
RestClientException

Throws:

IOException

RestClientException

getVersion

@Deprecated
default int getVersion(String subject,
 org.apache.avro.Schema schema)
                throws IOException,
RestClientException

Deprecated.

Throws:

IOException

RestClientException

getVersion

int getVersion(String subject,
 ParsedSchema schema)
        throws IOException,
RestClientException

Throws:

IOException

RestClientException

getVersion

default int getVersion(String subject,
 ParsedSchema schema,
 boolean normalize)
                throws IOException,
RestClientException

Throws:

IOException

RestClientException

getAllVersions

List<Integer> getAllVersions(String subject)
                      throws IOException,
RestClientException

Throws:

IOException

RestClientException

getAllVersions

default List<Integer> getAllVersions(String subject,
 boolean lookupDeletedSchema)
                              throws IOException,
RestClientException

Throws:

IOException

RestClientException

testCompatibility

@Deprecated
default boolean testCompatibility(String subject,
 org.apache.avro.Schema schema)
                           throws IOException,
RestClientException

Deprecated.

Throws:

IOException

RestClientException

testCompatibility

boolean testCompatibility(String subject,
 ParsedSchema schema)
                   throws IOException,
RestClientException

Throws:

IOException

RestClientException

testCompatibilityVerbose

default List<String> testCompatibilityVerbose(String subject,
 ParsedSchema schema)
                                       throws IOException,
RestClientException

Throws:

IOException

RestClientException

testCompatibilityVerbose

default List<String> testCompatibilityVerbose(String subject,
 ParsedSchema schema,
 boolean normalize)
                                       throws IOException,
RestClientException

Throws:

IOException

RestClientException

updateCompatibility

default String updateCompatibility(String subject,
 String compatibility)
                            throws IOException,
RestClientException

Throws:

IOException

RestClientException

getCompatibility

default String getCompatibility(String subject)
                         throws IOException,
RestClientException

Throws:

IOException

RestClientException

deleteCompatibility

default void deleteCompatibility(String subject)
                          throws IOException,
RestClientException

Throws:

IOException

RestClientException

updateConfig

default Config updateConfig(String subject,
 Config config)
                     throws IOException,
RestClientException

Throws:

IOException

RestClientException

getConfig

default Config getConfig(String subject)
                  throws IOException,
RestClientException

Throws:

IOException

RestClientException

deleteConfig

default void deleteConfig(String subject)
                   throws IOException,
RestClientException

Throws:

IOException

RestClientException

setMode

String setMode(String mode)
        throws IOException,
RestClientException

Throws:

IOException

RestClientException

setMode

String setMode(String mode,
 String subject)
        throws IOException,
RestClientException

Throws:

IOException

RestClientException

setMode

default String setMode(String mode,
 String subject,
 boolean force)
                throws IOException,
RestClientException

Throws:

IOException

RestClientException

getMode

String getMode()
        throws IOException,
RestClientException

Throws:

IOException

RestClientException

getMode

String getMode(String subject)
        throws IOException,
RestClientException

Throws:

IOException

RestClientException

deleteMode

default void deleteMode(String subject)
                 throws IOException,
RestClientException

Throws:

IOException

RestClientException

getAllContexts

default Collection<String> getAllContexts()
                                   throws IOException,
RestClientException

Throws:

IOException

RestClientException

getSchemaRegistryDeployment

default SchemaRegistryDeployment getSchemaRegistryDeployment()
                                                      throws IOException,
RestClientException

Throws:

IOException

RestClientException

getSchemaRegistryServerVersion

default SchemaRegistryServerVersion getSchemaRegistryServerVersion()
                                                            throws IOException,
RestClientException

Throws:

IOException

RestClientException

getAllSubjects

Collection<String> getAllSubjects()
                           throws IOException,
RestClientException

Throws:

IOException

RestClientException

getAllSubjects

default Collection<String> getAllSubjects(boolean lookupDeletedSubject)
                                   throws IOException,
RestClientException

Throws:

IOException

RestClientException

getAllSubjectsByPrefix

default Collection<String> getAllSubjectsByPrefix(String subjectPrefix)
                                           throws IOException,
RestClientException

Throws:

IOException

RestClientException

getId

@Deprecated
default int getId(String subject,
 org.apache.avro.Schema schema)
           throws IOException,
RestClientException

Deprecated.

Throws:

IOException

RestClientException

getId

int getId(String subject,
 ParsedSchema schema)
   throws IOException,
RestClientException

Throws:

IOException

RestClientException

getId

default int getId(String subject,
 ParsedSchema schema,
 boolean normalize)
           throws IOException,
RestClientException

Throws:

IOException

RestClientException

getGuid

default String getGuid(String subject,
 ParsedSchema schema)
                throws IOException,
RestClientException

Throws:

IOException

RestClientException

getGuid

default String getGuid(String subject,
 ParsedSchema schema,
 boolean normalize)
                throws IOException,
RestClientException

Throws:

IOException

RestClientException

getIdWithResponse

default RegisterSchemaResponse getIdWithResponse(String subject,
 ParsedSchema schema,
 boolean normalize)
                                          throws IOException,
RestClientException

Throws:

IOException

RestClientException

deleteSubject

default List<Integer> deleteSubject(String subject)
                             throws IOException,
RestClientException

Throws:

IOException

RestClientException

deleteSubject

default List<Integer> deleteSubject(String subject,
 boolean isPermanent)
                             throws IOException,
RestClientException

Throws:

IOException

RestClientException

deleteSubject

default List<Integer> deleteSubject(Map<String,String> requestProperties,
 String subject)
                             throws IOException,
RestClientException

Throws:

IOException

RestClientException

deleteSubject

default List<Integer> deleteSubject(Map<String,String> requestProperties,
 String subject,
 boolean isPermanent)
                             throws IOException,
RestClientException

Throws:

IOException

RestClientException

deleteSchemaVersion

default Integer deleteSchemaVersion(String subject,
 String version)
                             throws IOException,
RestClientException

Throws:

IOException

RestClientException

deleteSchemaVersion

default Integer deleteSchemaVersion(String subject,
 String version,
 boolean isPermanent)
                             throws IOException,
RestClientException

Throws:

IOException

RestClientException

deleteSchemaVersion

default Integer deleteSchemaVersion(Map<String,String> requestProperties,
 String subject,
 String version)
                             throws IOException,
RestClientException

Throws:

IOException

RestClientException

deleteSchemaVersion

default Integer deleteSchemaVersion(Map<String,String> requestProperties,
 String subject,
 String version,
 boolean isPermanent)
                             throws IOException,
RestClientException

Throws:

IOException

RestClientException

reset

void reset()

close

default void close()
            throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

createAssociation

default AssociationResponse createAssociation(AssociationCreateOrUpdateRequest request)
                                       throws IOException,
RestClientException

Throws:

IOException

RestClientException

createOrUpdateAssociation

default AssociationResponse createOrUpdateAssociation(AssociationCreateOrUpdateRequest request)
                                               throws IOException,
RestClientException

Throws:

IOException

RestClientException

getAssociationsBySubject

default List<Association> getAssociationsBySubject(String subject,
 String resourceType,
 List<String> associationTypes,
 String lifecycle,
 int offset,
 int limit)
                                            throws IOException,
RestClientException

Throws:

IOException

RestClientException

getAssociationsByResourceId

default List<Association> getAssociationsByResourceId(String resourceId,
 String resourceType,
 List<String> associationTypes,
 String lifecycle,
 int offset,
 int limit)
                                               throws IOException,
RestClientException

Throws:

IOException

RestClientException

deleteAssociations

default void deleteAssociations(String resourceId,
 String resourceType,
 List<String> associationTypes,
 boolean cascadeLifecycle)
                         throws IOException,
RestClientException

Throws:

IOException

RestClientException