RestService (kafka-schema-registry-client 7.9.4 API)

java.lang.Object
- io.confluent.kafka.schemaregistry.client.rest.RestService

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.kafka.common.Configurable
```
public class RestService
extends Object
implements Closeable, org.apache.kafka.common.Configurable
```
Rest access layer for sending requests to the schema registry.

Field Summary

Fields
Modifier and Type Field and Description

static Map<String,String> DEFAULT_REQUEST_PROPERTIES

static String X_FORWARD_HEADER

Fields
Modifier and Type	Field and Description
`static Map<String,String>`	`DEFAULT_REQUEST_PROPERTIES`
`static String`	`X_FORWARD_HEADER`

Constructor Summary

Constructors
Constructor and Description
`RestService(List<String> baseUrls)`
`RestService(String baseUrlConfig)`
`RestService(String baseUrlConfig, boolean isForward)`
`RestService(UrlList baseUrls)`
`RestService(UrlList baseUrls, boolean isForward)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected HttpURLConnection`	`buildConnection(URL url, String method, Map<String,String> requestProperties)`
`void`	`close()`
`void`	`configure(Map<String,?> configs)`
`Config`	`deleteConfig(Map<String,String> requestProperties, String subject)`
`Config`	`deleteConfig(String subject)`
`Integer`	`deleteSchemaVersion(Map<String,String> requestProperties, String subject, String version)`
`Integer`	`deleteSchemaVersion(Map<String,String> requestProperties, String subject, String version, boolean permanentDelete)`
`List<Integer>`	`deleteSubject(Map<String,String> requestProperties, String subject)`
`List<Integer>`	`deleteSubject(Map<String,String> requestProperties, String subject, boolean permanentDelete)`
`Mode`	`deleteSubjectMode(Map<String,String> requestProperties, String subject)`
`Mode`	`deleteSubjectMode(String subject)`
`List<String>`	`getAllContexts()`
`List<String>`	`getAllContexts(Map<String,String> requestProperties)`
`List<String>`	`getAllContextsWithPagination(int limit, int offset)`
`List<String>`	`getAllSubjects()`
`List<String>`	`getAllSubjects(boolean deletedSubjects)`
`List<String>`	`getAllSubjects(Map<String,String> requestProperties)`
`List<String>`	`getAllSubjects(Map<String,String> requestProperties, String subjectPrefix, boolean deletedSubjects)`
`List<String>`	`getAllSubjects(Map<String,String> requestProperties, String subjectPrefix, boolean deletedSubjects, boolean deletedOnlySubjects)`
`List<String>`	`getAllSubjects(String subjectPrefix, boolean deletedSubjects)`
`List<String>`	`getAllSubjectsById(int id)`
`List<String>`	`getAllSubjectsById(int id, String subject)`
`List<String>`	`getAllSubjectsById(int id, String subject, boolean deleted)`
`List<String>`	`getAllSubjectsById(Map<String,String> requestProperties, int id)`
`List<String>`	`getAllSubjectsById(Map<String,String> requestProperties, int id, String subject)`
`List<String>`	`getAllSubjectsById(Map<String,String> requestProperties, int id, String subject, boolean lookupDeleted)`
`List<String>`	`getAllSubjectsByIdWithPagination(Map<String,String> requestProperties, int id, String subject, boolean lookupDeleted, int limit, int offset)`
`List<String>`	`getAllSubjectsWithPagination(int offset, int limit)`
`List<String>`	`getAllSubjectsWithPagination(Map<String,String> requestProperties, int offset, int limit)`
`List<Integer>`	`getAllVersions(Map<String,String> requestProperties, String subject)`
`List<Integer>`	`getAllVersions(Map<String,String> requestProperties, String subject, boolean lookupDeletedSchema)`
`List<Integer>`	`getAllVersions(Map<String,String> requestProperties, String subject, boolean lookupDeletedSchema, boolean lookupDeletedOnlySchema)`
`List<Integer>`	`getAllVersions(String subject)`
`List<SubjectVersion>`	`getAllVersionsById(int id)`
`List<SubjectVersion>`	`getAllVersionsById(int id, String subject)`
`List<SubjectVersion>`	`getAllVersionsById(int id, String subject, boolean deleted)`
`List<SubjectVersion>`	`getAllVersionsById(Map<String,String> requestProperties, int id)`
`List<SubjectVersion>`	`getAllVersionsById(Map<String,String> requestProperties, int id, String subject)`
`List<SubjectVersion>`	`getAllVersionsById(Map<String,String> requestProperties, int id, String subject, boolean lookupDeleted)`
`List<SubjectVersion>`	`getAllVersionsByIdWithPagination(Map<String,String> requestProperties, int id, String subject, boolean lookupDeleted, int offset, int limit)`
`List<Integer>`	`getAllVersionsWithPagination(Map<String,String> requestProperties, String subject, boolean lookupDeletedSchema, int offset, int limit)`
`UrlList`	`getBaseUrls()`
`ServerClusterId`	`getClusterId()`
`ServerClusterId`	`getClusterId(Map<String,String> requestProperties)`
`Config`	`getConfig(Map<String,String> requestProperties, String subject)`
`Config`	`getConfig(Map<String,String> requestProperties, String subject, boolean defaultToGlobal)`
`Config`	`getConfig(String subject)`
`List<String>`	`getDeletedOnlySubjects(String subjectPrefix)`
`List<Integer>`	`getDeletedOnlyVersions(String subject)`
`SchemaString`	`getId(int id)`
`SchemaString`	`getId(int id, boolean fetchMaxId)`
`SchemaString`	`getId(int id, String subject)`
`SchemaString`	`getId(int id, String subject, boolean fetchMaxId)`
`SchemaString`	`getId(Map<String,String> requestProperties, int id)`
`SchemaString`	`getId(Map<String,String> requestProperties, int id, String subject)`
`SchemaString`	`getId(Map<String,String> requestProperties, int id, String subject, boolean fetchMaxId)`
`SchemaString`	`getId(Map<String,String> requestProperties, int id, String subject, Set<String> findTags, boolean fetchMaxId)`
`SchemaString`	`getId(Map<String,String> requestProperties, int id, String subject, String format, Set<String> findTags, boolean fetchMaxId)`
`Schema`	`getLatestVersion(Map<String,String> requestProperties, String subject)`
`Schema`	`getLatestVersion(Map<String,String> requestProperties, String subject, Set<String> findTags)`
`Schema`	`getLatestVersion(Map<String,String> requestProperties, String subject, String format, Set<String> findTags)`
`Schema`	`getLatestVersion(String subject)`
`String`	`getLatestVersionSchemaOnly(String subject)`
`Schema`	`getLatestWithMetadata(Map<String,String> requestProperties, String subject, Map<String,String> metadata, boolean lookupDeletedSchema)`
`Schema`	`getLatestWithMetadata(Map<String,String> requestProperties, String subject, Map<String,String> metadata, String format, boolean lookupDeletedSchema)`
`Schema`	`getLatestWithMetadata(String subject, Map<String,String> metadata, boolean lookupDeletedSchema)`
`Mode`	`getMode()`
`Mode`	`getMode(String subject)`
`Mode`	`getMode(String subject, boolean defaultToGlobal)`
`String`	`getOnlySchemaById(int id)`
`String`	`getOnlySchemaById(Map<String,String> requestProperties, int id, String subject)`
`List<Integer>`	`getReferencedBy(Map<String,String> requestProperties, String subject, int version)`
`List<Integer>`	`getReferencedBy(String subject, int version)`
`List<Integer>`	`getReferencedByWithPagination(String subject, int version, int offset, int limit)`
`SchemaRegistryServerVersion`	`getSchemaRegistryServerVersion()`
`List<ExtendedSchema>`	`getSchemas(Map<String,String> requestProperties, String subjectPrefix, boolean includeAliases, boolean lookupDeletedSchema, boolean latestOnly, String ruleType, Integer offset, Integer limit)`
`List<Schema>`	`getSchemas(Map<String,String> requestProperties, String subjectPrefix, boolean lookupDeletedSchema, boolean latestOnly, String ruleType, Integer offset, Integer limit)`
`List<Schema>`	`getSchemas(String subjectPrefix, boolean lookupDeletedSchema, boolean latestOnly)`
`List<String>`	`getSchemaTypes()`
`List<String>`	`getSchemaTypes(Map<String,String> requestProperties)`
`Schema`	`getVersion(Map<String,String> requestProperties, String subject, int version)`
`Schema`	`getVersion(Map<String,String> requestProperties, String subject, int version, boolean lookupDeletedSchema)`
`Schema`	`getVersion(Map<String,String> requestProperties, String subject, int version, String format, boolean lookupDeletedSchema, Set<String> findTags)`
`Schema`	`getVersion(String subject, int version)`
`Schema`	`getVersion(String subject, int version, boolean lookupDeletedSchema)`
`String`	`getVersionSchemaOnly(String subject, int version)`
`<T> T`	`httpRequest(String path, String method, byte[] requestBodyData, Map<String,String> requestProperties, com.fasterxml.jackson.core.type.TypeReference<T> responseFormat)` Send an HTTP request.
`static boolean`	`isRetriable(RestClientException e)`
`Schema`	`lookUpSubjectVersion(Map<String,String> requestProperties, RegisterSchemaRequest registerSchemaRequest, String subject, boolean normalize, boolean lookupDeletedSchema)`
`Schema`	`lookUpSubjectVersion(Map<String,String> requestProperties, RegisterSchemaRequest registerSchemaRequest, String subject, boolean normalize, String format, boolean lookupDeletedSchema)`
`Schema`	`lookUpSubjectVersion(RegisterSchemaRequest registerSchemaRequest, String subject, boolean normalize, boolean lookupDeletedSchema)`
`Schema`	`lookUpSubjectVersion(String schemaString, String subject)`
`Schema`	`lookUpSubjectVersion(String schemaString, String subject, boolean lookupDeletedSchema)`
`Schema`	`lookUpSubjectVersion(String schemaString, String subject, boolean normalize, boolean lookupDeletedSchema)`
`Schema`	`lookUpSubjectVersion(String schemaString, String schemaType, List<SchemaReference> references, String subject, boolean lookupDeletedSchema)`
`Schema`	`lookUpSubjectVersion(String schemaString, String schemaType, List<SchemaReference> references, String subject, boolean normalize, boolean lookupDeletedSchema)`
`RegisterSchemaResponse`	`modifySchemaTags(Map<String,String> requestProperties, TagSchemaRequest tagSchemaRequest, String subject, String version)`
`RegisterSchemaResponse`	`registerSchema(Map<String,String> requestProperties, RegisterSchemaRequest registerSchemaRequest, String subject, boolean normalize)`
`RegisterSchemaResponse`	`registerSchema(Map<String,String> requestProperties, RegisterSchemaRequest registerSchemaRequest, String subject, boolean normalize, String format)`
`RegisterSchemaResponse`	`registerSchema(RegisterSchemaRequest registerSchemaRequest, String subject, boolean normalize)`
`int`	`registerSchema(String schemaString, String subject)`
`RegisterSchemaResponse`	`registerSchema(String schemaString, String subject, boolean normalize)`
`int`	`registerSchema(String schemaString, String subject, int version, int id)`
`RegisterSchemaResponse`	`registerSchema(String schemaString, String subject, int version, int id, boolean normalize)`
`RegisterSchemaResponse`	`registerSchema(String schemaString, String schemaType, List<SchemaReference> references, String subject)`
`RegisterSchemaResponse`	`registerSchema(String schemaString, String schemaType, List<SchemaReference> references, String subject, boolean normalize)`
`RegisterSchemaResponse`	`registerSchema(String schemaString, String schemaType, List<SchemaReference> references, String subject, int version, int id)`
`RegisterSchemaResponse`	`registerSchema(String schemaString, String schemaType, List<SchemaReference> references, String subject, int version, int id, boolean normalize)`
`void`	`setBasicAuthCredentialProvider(BasicAuthCredentialProvider basicAuthCredentialProvider)`
`void`	`setBearerAuthCredentialProvider(BearerAuthCredentialProvider bearerAuthCredentialProvider)`
`void`	`setHostnameVerifier(HostnameVerifier hostnameVerifier)`
`void`	`setHttpConnectTimeoutMs(int httpConnectTimeoutMs)`
`void`	`setHttpHeaders(Map<String,String> httpHeaders)`
`void`	`setHttpReadTimeoutMs(int httpReadTimeoutMs)`
`ModeUpdateRequest`	`setMode(Map<String,String> requestProperties, ModeUpdateRequest modeUpdateRequest, String subject, boolean force)` On success, this api simply echoes the request in the response.
`ModeUpdateRequest`	`setMode(String mode)`
`ModeUpdateRequest`	`setMode(String mode, String subject)`
`ModeUpdateRequest`	`setMode(String mode, String subject, boolean force)`
`void`	`setProxy(String proxyHost, int proxyPort)`
`void`	`setSslSocketFactory(SSLSocketFactory sslSocketFactory)`
`List<String>`	`testCompatibility(Map<String,String> requestProperties, RegisterSchemaRequest registerSchemaRequest, String subject, String version, boolean normalize, boolean verbose)`
`List<String>`	`testCompatibility(RegisterSchemaRequest registerSchemaRequest, String subject, String version, boolean normalize, boolean verbose)`
`List<String>`	`testCompatibility(String schemaString, String subject, boolean verbose)`
`List<String>`	`testCompatibility(String schemaString, String schemaType, List<SchemaReference> references, String subject, String version, boolean verbose)`
`List<String>`	`testCompatibility(String schemaString, String subject, String version)`
`ConfigUpdateRequest`	`updateCompatibility(String compatibility, String subject)`
`ConfigUpdateRequest`	`updateConfig(ConfigUpdateRequest configUpdateRequest, String subject)`
`ConfigUpdateRequest`	`updateConfig(Map<String,String> requestProperties, ConfigUpdateRequest configUpdateRequest, String subject)` On success, this api simply echoes the request in the response.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

X_FORWARD_HEADER

public static final String X_FORWARD_HEADER

See Also:: Constant Field Values

DEFAULT_REQUEST_PROPERTIES

public static final Map<String,String> DEFAULT_REQUEST_PROPERTIES

Constructor Detail

RestService
```
public RestService(UrlList baseUrls)
```

RestService

public RestService(List<String> baseUrls)

RestService

public RestService(String baseUrlConfig)

RestService

public RestService(String baseUrlConfig,
                   boolean isForward)

RestService

public RestService(UrlList baseUrls,
                   boolean isForward)

Method Detail

configure
```
public void configure(Map<String,?> configs)
```
Specified by:

configure in interface org.apache.kafka.common.Configurable

setSslSocketFactory

public void setSslSocketFactory(SSLSocketFactory sslSocketFactory)

setHostnameVerifier

public void setHostnameVerifier(HostnameVerifier hostnameVerifier)

setHttpConnectTimeoutMs

public void setHttpConnectTimeoutMs(int httpConnectTimeoutMs)

setHttpReadTimeoutMs

public void setHttpReadTimeoutMs(int httpReadTimeoutMs)

buildConnection

protected HttpURLConnection buildConnection(URL url,
                                            String method,
                                            Map<String,String> requestProperties)
                                     throws IOException

Throws:: IOException

httpRequest
```
public <T> T httpRequest(String path,
                         String method,
                         byte[] requestBodyData,
                         Map<String,String> requestProperties,
                         com.fasterxml.jackson.core.type.TypeReference<T> responseFormat)
                  throws IOException,
                         RestClientException
```
Send an HTTP request.

Type Parameters:

T - The type of the deserialized response to the HTTP request.

Parameters:

path - The relative path

method - HTTP method ("GET", "POST", "PUT", etc.)

requestBodyData - Bytes to be sent in the request body.

requestProperties - HTTP header properties.

responseFormat - Expected format of the response to the HTTP request.

Returns:

The deserialized response to the HTTP request, or null if no data is expected.

Throws:

IOException

RestClientException

isRetriable

public static boolean isRetriable(RestClientException e)

lookUpSubjectVersion

public Schema lookUpSubjectVersion(String schemaString,
                                   String subject)
                            throws IOException,
                                   RestClientException

Throws:: IOException; RestClientException

lookUpSubjectVersion

public Schema lookUpSubjectVersion(String schemaString,
                                   String subject,
                                   boolean lookupDeletedSchema)
                            throws IOException,
                                   RestClientException

Throws:: IOException; RestClientException

lookUpSubjectVersion

public Schema lookUpSubjectVersion(String schemaString,
                                   String subject,
                                   boolean normalize,
                                   boolean lookupDeletedSchema)
                            throws IOException,
                                   RestClientException

Throws:: IOException; RestClientException

lookUpSubjectVersion

public Schema lookUpSubjectVersion(String schemaString,
                                   String schemaType,
                                   List<SchemaReference> references,
                                   String subject,
                                   boolean lookupDeletedSchema)
                            throws IOException,
                                   RestClientException

Throws:: IOException; RestClientException

lookUpSubjectVersion

public Schema lookUpSubjectVersion(String schemaString,
                                   String schemaType,
                                   List<SchemaReference> references,
                                   String subject,
                                   boolean normalize,
                                   boolean lookupDeletedSchema)
                            throws IOException,
                                   RestClientException

Throws:: IOException; RestClientException

lookUpSubjectVersion

public Schema lookUpSubjectVersion(RegisterSchemaRequest registerSchemaRequest,
                                   String subject,
                                   boolean normalize,
                                   boolean lookupDeletedSchema)
                            throws IOException,
                                   RestClientException

Throws:: IOException; RestClientException

lookUpSubjectVersion

public Schema lookUpSubjectVersion(Map<String,String> requestProperties,
                                   RegisterSchemaRequest registerSchemaRequest,
                                   String subject,
                                   boolean normalize,
                                   boolean lookupDeletedSchema)
                            throws IOException,
                                   RestClientException

Throws:: IOException; RestClientException

lookUpSubjectVersion

public Schema lookUpSubjectVersion(Map<String,String> requestProperties,
                                   RegisterSchemaRequest registerSchemaRequest,
                                   String subject,
                                   boolean normalize,
                                   String format,
                                   boolean lookupDeletedSchema)
                            throws IOException,
                                   RestClientException

Throws:: IOException; RestClientException

registerSchema

public int registerSchema(String schemaString,
                          String subject)
                   throws IOException,
                          RestClientException

Throws:: IOException; RestClientException

registerSchema

public RegisterSchemaResponse registerSchema(String schemaString,
                                             String subject,
                                             boolean normalize)
                                      throws IOException,
                                             RestClientException

Throws:: IOException; RestClientException

registerSchema

public RegisterSchemaResponse registerSchema(String schemaString,
                                             String schemaType,
                                             List<SchemaReference> references,
                                             String subject)
                                      throws IOException,
                                             RestClientException

Throws:: IOException; RestClientException

registerSchema

public RegisterSchemaResponse registerSchema(String schemaString,
                                             String schemaType,
                                             List<SchemaReference> references,
                                             String subject,
                                             boolean normalize)
                                      throws IOException,
                                             RestClientException

Throws:: IOException; RestClientException

registerSchema

public int registerSchema(String schemaString,
                          String subject,
                          int version,
                          int id)
                   throws IOException,
                          RestClientException

Throws:: IOException; RestClientException

registerSchema

public RegisterSchemaResponse registerSchema(String schemaString,
                                             String subject,
                                             int version,
                                             int id,
                                             boolean normalize)
                                      throws IOException,
                                             RestClientException

Throws:: IOException; RestClientException

registerSchema

public RegisterSchemaResponse registerSchema(String schemaString,
                                             String schemaType,
                                             List<SchemaReference> references,
                                             String subject,
                                             int version,
                                             int id)
                                      throws IOException,
                                             RestClientException

Throws:: IOException; RestClientException

registerSchema

public RegisterSchemaResponse registerSchema(String schemaString,
                                             String schemaType,
                                             List<SchemaReference> references,
                                             String subject,
                                             int version,
                                             int id,
                                             boolean normalize)
                                      throws IOException,
                                             RestClientException

Throws:: IOException; RestClientException

registerSchema

public RegisterSchemaResponse registerSchema(RegisterSchemaRequest registerSchemaRequest,
                                             String subject,
                                             boolean normalize)
                                      throws IOException,
                                             RestClientException

Throws:: IOException; RestClientException

registerSchema

public RegisterSchemaResponse registerSchema(Map<String,String> requestProperties,
                                             RegisterSchemaRequest registerSchemaRequest,
                                             String subject,
                                             boolean normalize)
                                      throws IOException,
                                             RestClientException

Throws:: IOException; RestClientException

registerSchema

public RegisterSchemaResponse registerSchema(Map<String,String> requestProperties,
                                             RegisterSchemaRequest registerSchemaRequest,
                                             String subject,
                                             boolean normalize,
                                             String format)
                                      throws IOException,
                                             RestClientException

Throws:: IOException; RestClientException

modifySchemaTags

public RegisterSchemaResponse modifySchemaTags(Map<String,String> requestProperties,
                                               TagSchemaRequest tagSchemaRequest,
                                               String subject,
                                               String version)
                                        throws IOException,
                                               RestClientException

Throws:: IOException; RestClientException

testCompatibility

public List<String> testCompatibility(String schemaString,
                                      String subject,
                                      boolean verbose)
                               throws IOException,
                                      RestClientException

Throws:: IOException; RestClientException

testCompatibility

public List<String> testCompatibility(String schemaString,
                                      String subject,
                                      String version)
                               throws IOException,
                                      RestClientException

Throws:: IOException; RestClientException

testCompatibility

public List<String> testCompatibility(String schemaString,
                                      String schemaType,
                                      List<SchemaReference> references,
                                      String subject,
                                      String version,
                                      boolean verbose)
                               throws IOException,
                                      RestClientException

Throws:: IOException; RestClientException

testCompatibility

public List<String> testCompatibility(RegisterSchemaRequest registerSchemaRequest,
                                      String subject,
                                      String version,
                                      boolean normalize,
                                      boolean verbose)
                               throws IOException,
                                      RestClientException

Throws:: IOException; RestClientException

testCompatibility

public List<String> testCompatibility(Map<String,String> requestProperties,
                                      RegisterSchemaRequest registerSchemaRequest,
                                      String subject,
                                      String version,
                                      boolean normalize,
                                      boolean verbose)
                               throws IOException,
                                      RestClientException

Throws:: IOException; RestClientException

updateCompatibility

public ConfigUpdateRequest updateCompatibility(String compatibility,
                                               String subject)
                                        throws IOException,
                                               RestClientException

Throws:: IOException; RestClientException

updateConfig

public ConfigUpdateRequest updateConfig(ConfigUpdateRequest configUpdateRequest,
                                        String subject)
                                 throws IOException,
                                        RestClientException

Throws:: IOException; RestClientException

updateConfig

public ConfigUpdateRequest updateConfig(Map<String,String> requestProperties,
                                        ConfigUpdateRequest configUpdateRequest,
                                        String subject)
                                 throws IOException,
                                        RestClientException

On success, this api simply echoes the request in the response.

Throws:: IOException; RestClientException

getConfig

public Config getConfig(String subject)
                 throws IOException,
                        RestClientException

Throws:: IOException; RestClientException

getConfig

public Config getConfig(Map<String,String> requestProperties,
                        String subject)
                 throws IOException,
                        RestClientException

Throws:: IOException; RestClientException

getConfig

public Config getConfig(Map<String,String> requestProperties,
                        String subject,
                        boolean defaultToGlobal)
                 throws IOException,
                        RestClientException

Throws:: IOException; RestClientException

deleteConfig

public Config deleteConfig(String subject)
                    throws IOException,
                           RestClientException

Throws:: IOException; RestClientException

deleteConfig

public Config deleteConfig(Map<String,String> requestProperties,
                           String subject)
                    throws IOException,
                           RestClientException

Throws:: IOException; RestClientException

setMode

public ModeUpdateRequest setMode(String mode)
                          throws IOException,
                                 RestClientException

Throws:: IOException; RestClientException

setMode

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

Throws:: IOException; RestClientException

setMode

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

Throws:: IOException; RestClientException

setMode

public ModeUpdateRequest setMode(Map<String,String> requestProperties,
                                 ModeUpdateRequest modeUpdateRequest,
                                 String subject,
                                 boolean force)
                          throws IOException,
                                 RestClientException

On success, this api simply echoes the request in the response.

Throws:: IOException; RestClientException

getMode

public Mode getMode()
             throws IOException,
                    RestClientException

Throws:: IOException; RestClientException

getMode

public Mode getMode(String subject)
             throws IOException,
                    RestClientException

Throws:: IOException; RestClientException

getMode

public Mode getMode(String subject,
                    boolean defaultToGlobal)
             throws IOException,
                    RestClientException

Throws:: IOException; RestClientException

deleteSubjectMode

public Mode deleteSubjectMode(String subject)
                       throws IOException,
                              RestClientException

Throws:: IOException; RestClientException

deleteSubjectMode

public Mode deleteSubjectMode(Map<String,String> requestProperties,
                              String subject)
                       throws IOException,
                              RestClientException

Throws:: IOException; RestClientException

getSchemas

public List<Schema> getSchemas(String subjectPrefix,
                               boolean lookupDeletedSchema,
                               boolean latestOnly)
                        throws IOException,
                               RestClientException

Throws:: IOException; RestClientException

getSchemas

public List<Schema> getSchemas(Map<String,String> requestProperties,
                               String subjectPrefix,
                               boolean lookupDeletedSchema,
                               boolean latestOnly,
                               String ruleType,
                               Integer offset,
                               Integer limit)
                        throws IOException,
                               RestClientException

Throws:: IOException; RestClientException

getSchemas

public List<ExtendedSchema> getSchemas(Map<String,String> requestProperties,
                                       String subjectPrefix,
                                       boolean includeAliases,
                                       boolean lookupDeletedSchema,
                                       boolean latestOnly,
                                       String ruleType,
                                       Integer offset,
                                       Integer limit)
                                throws IOException,
                                       RestClientException

Throws:: IOException; RestClientException

getId

public SchemaString getId(int id)
                   throws IOException,
                          RestClientException

Throws:: IOException; RestClientException

getId

public SchemaString getId(int id,
                          boolean fetchMaxId)
                   throws IOException,
                          RestClientException

Throws:: IOException; RestClientException

getId

public SchemaString getId(int id,
                          String subject)
                   throws IOException,
                          RestClientException

Throws:: IOException; RestClientException

getId

public SchemaString getId(int id,
                          String subject,
                          boolean fetchMaxId)
                   throws IOException,
                          RestClientException

Throws:: IOException; RestClientException

getId

public SchemaString getId(Map<String,String> requestProperties,
                          int id)
                   throws IOException,
                          RestClientException

Throws:: IOException; RestClientException

getId

public SchemaString getId(Map<String,String> requestProperties,
                          int id,
                          String subject)
                   throws IOException,
                          RestClientException

Throws:: IOException; RestClientException

getId

public SchemaString getId(Map<String,String> requestProperties,
                          int id,
                          String subject,
                          boolean fetchMaxId)
                   throws IOException,
                          RestClientException

Throws:: IOException; RestClientException

getId

public SchemaString getId(Map<String,String> requestProperties,
                          int id,
                          String subject,
                          Set<String> findTags,
                          boolean fetchMaxId)
                   throws IOException,
                          RestClientException

Throws:: IOException; RestClientException

getId

public SchemaString getId(Map<String,String> requestProperties,
                          int id,
                          String subject,
                          String format,
                          Set<String> findTags,
                          boolean fetchMaxId)
                   throws IOException,
                          RestClientException

Throws:: IOException; RestClientException

getOnlySchemaById

public String getOnlySchemaById(int id)
                         throws RestClientException,
                                IOException

Throws:: RestClientException; IOException

getOnlySchemaById

public String getOnlySchemaById(Map<String,String> requestProperties,
                                int id,
                                String subject)
                         throws IOException,
                                RestClientException

Throws:: IOException; RestClientException

getSchemaTypes

public List<String> getSchemaTypes()
                            throws IOException,
                                   RestClientException

Throws:: IOException; RestClientException

getSchemaTypes

public List<String> getSchemaTypes(Map<String,String> requestProperties)
                            throws IOException,
                                   RestClientException

Throws:: IOException; RestClientException

getVersion

public Schema getVersion(String subject,
                         int version)
                  throws IOException,
                         RestClientException

Throws:: IOException; RestClientException

getVersion

public Schema getVersion(String subject,
                         int version,
                         boolean lookupDeletedSchema)
                  throws IOException,
                         RestClientException

Throws:: IOException; RestClientException

getVersion

public Schema getVersion(Map<String,String> requestProperties,
                         String subject,
                         int version)
                  throws IOException,
                         RestClientException

Throws:: IOException; RestClientException

getVersion

public Schema getVersion(Map<String,String> requestProperties,
                         String subject,
                         int version,
                         boolean lookupDeletedSchema)
                  throws IOException,
                         RestClientException

Throws:: IOException; RestClientException

getVersion

public Schema getVersion(Map<String,String> requestProperties,
                         String subject,
                         int version,
                         String format,
                         boolean lookupDeletedSchema,
                         Set<String> findTags)
                  throws IOException,
                         RestClientException

Throws:: IOException; RestClientException

getLatestVersion

public Schema getLatestVersion(String subject)
                        throws IOException,
                               RestClientException

Throws:: IOException; RestClientException

getLatestVersion

public Schema getLatestVersion(Map<String,String> requestProperties,
                               String subject)
                        throws IOException,
                               RestClientException

Throws:: IOException; RestClientException

getLatestVersion

public Schema getLatestVersion(Map<String,String> requestProperties,
                               String subject,
                               Set<String> findTags)
                        throws IOException,
                               RestClientException

Throws:: IOException; RestClientException

getLatestVersion

public Schema getLatestVersion(Map<String,String> requestProperties,
                               String subject,
                               String format,
                               Set<String> findTags)
                        throws IOException,
                               RestClientException

Throws:: IOException; RestClientException

getVersionSchemaOnly

public String getVersionSchemaOnly(String subject,
                                   int version)
                            throws IOException,
                                   RestClientException

Throws:: IOException; RestClientException

getLatestVersionSchemaOnly

public String getLatestVersionSchemaOnly(String subject)
                                  throws IOException,
                                         RestClientException

Throws:: IOException; RestClientException

getLatestWithMetadata

public Schema getLatestWithMetadata(String subject,
                                    Map<String,String> metadata,
                                    boolean lookupDeletedSchema)
                             throws IOException,
                                    RestClientException

Throws:: IOException; RestClientException

getLatestWithMetadata

public Schema getLatestWithMetadata(Map<String,String> requestProperties,
                                    String subject,
                                    Map<String,String> metadata,
                                    boolean lookupDeletedSchema)
                             throws IOException,
                                    RestClientException

Throws:: IOException; RestClientException

getLatestWithMetadata

public Schema getLatestWithMetadata(Map<String,String> requestProperties,
                                    String subject,
                                    Map<String,String> metadata,
                                    String format,
                                    boolean lookupDeletedSchema)
                             throws IOException,
                                    RestClientException

Throws:: IOException; RestClientException

getReferencedBy

public List<Integer> getReferencedBy(String subject,
                                     int version)
                              throws IOException,
                                     RestClientException

Throws:: IOException; RestClientException

getReferencedBy

public List<Integer> getReferencedBy(Map<String,String> requestProperties,
                                     String subject,
                                     int version)
                              throws IOException,
                                     RestClientException

Throws:: IOException; RestClientException

getReferencedByWithPagination

public List<Integer> getReferencedByWithPagination(String subject,
                                                   int version,
                                                   int offset,
                                                   int limit)
                                            throws IOException,
                                                   RestClientException

Throws:: IOException; RestClientException

getAllVersions

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

Throws:: IOException; RestClientException

getAllVersions

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

Throws:: IOException; RestClientException

getAllVersions

public List<Integer> getAllVersions(Map<String,String> requestProperties,
                                    String subject,
                                    boolean lookupDeletedSchema)
                             throws IOException,
                                    RestClientException

Throws:: IOException; RestClientException

getAllVersions

public List<Integer> getAllVersions(Map<String,String> requestProperties,
                                    String subject,
                                    boolean lookupDeletedSchema,
                                    boolean lookupDeletedOnlySchema)
                             throws IOException,
                                    RestClientException

Throws:: IOException; RestClientException

getAllVersionsWithPagination

public List<Integer> getAllVersionsWithPagination(Map<String,String> requestProperties,
                                                  String subject,
                                                  boolean lookupDeletedSchema,
                                                  int offset,
                                                  int limit)
                                           throws IOException,
                                                  RestClientException

Throws:: IOException; RestClientException

getDeletedOnlyVersions

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

Throws:: IOException; RestClientException

getAllContexts

public List<String> getAllContexts()
                            throws IOException,
                                   RestClientException

Throws:: IOException; RestClientException

getAllContexts

public List<String> getAllContexts(Map<String,String> requestProperties)
                            throws IOException,
                                   RestClientException

Throws:: IOException; RestClientException

getAllContextsWithPagination

public List<String> getAllContextsWithPagination(int limit,
                                                 int offset)
                                          throws IOException,
                                                 RestClientException

Throws:: IOException; RestClientException

getAllSubjects

public List<String> getAllSubjects()
                            throws IOException,
                                   RestClientException

Throws:: IOException; RestClientException

getAllSubjects

public List<String> getAllSubjects(boolean deletedSubjects)
                            throws IOException,
                                   RestClientException

Throws:: IOException; RestClientException

getAllSubjects

public List<String> getAllSubjects(String subjectPrefix,
                                   boolean deletedSubjects)
                            throws IOException,
                                   RestClientException

Throws:: IOException; RestClientException

getAllSubjects

public List<String> getAllSubjects(Map<String,String> requestProperties)
                            throws IOException,
                                   RestClientException

Throws:: IOException; RestClientException

getAllSubjects

public List<String> getAllSubjects(Map<String,String> requestProperties,
                                   String subjectPrefix,
                                   boolean deletedSubjects)
                            throws IOException,
                                   RestClientException

Throws:: IOException; RestClientException

getAllSubjects

public List<String> getAllSubjects(Map<String,String> requestProperties,
                                   String subjectPrefix,
                                   boolean deletedSubjects,
                                   boolean deletedOnlySubjects)
                            throws IOException,
                                   RestClientException

Throws:: IOException; RestClientException

getAllSubjectsWithPagination

public List<String> getAllSubjectsWithPagination(int offset,
                                                 int limit)
                                          throws IOException,
                                                 RestClientException

Throws:: IOException; RestClientException

getAllSubjectsWithPagination

public List<String> getAllSubjectsWithPagination(Map<String,String> requestProperties,
                                                 int offset,
                                                 int limit)
                                          throws IOException,
                                                 RestClientException

Throws:: IOException; RestClientException

getDeletedOnlySubjects

public List<String> getDeletedOnlySubjects(String subjectPrefix)
                                    throws IOException,
                                           RestClientException

Throws:: IOException; RestClientException

getAllSubjectsById

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

Throws:: IOException; RestClientException

getAllSubjectsById

public List<String> getAllSubjectsById(int id,
                                       String subject)
                                throws IOException,
                                       RestClientException

Throws:: IOException; RestClientException

getAllSubjectsById

public List<String> getAllSubjectsById(int id,
                                       String subject,
                                       boolean deleted)
                                throws IOException,
                                       RestClientException

Throws:: IOException; RestClientException

getAllSubjectsById

public List<String> getAllSubjectsById(Map<String,String> requestProperties,
                                       int id)
                                throws IOException,
                                       RestClientException

Throws:: IOException; RestClientException

getAllSubjectsById

public List<String> getAllSubjectsById(Map<String,String> requestProperties,
                                       int id,
                                       String subject)
                                throws IOException,
                                       RestClientException

Throws:: IOException; RestClientException

getAllSubjectsById

public List<String> getAllSubjectsById(Map<String,String> requestProperties,
                                       int id,
                                       String subject,
                                       boolean lookupDeleted)
                                throws IOException,
                                       RestClientException

Throws:: IOException; RestClientException

getAllSubjectsByIdWithPagination

public List<String> getAllSubjectsByIdWithPagination(Map<String,String> requestProperties,
                                                     int id,
                                                     String subject,
                                                     boolean lookupDeleted,
                                                     int limit,
                                                     int offset)
                                              throws IOException,
                                                     RestClientException

Throws:: IOException; RestClientException

getAllVersionsById

public List<SubjectVersion> getAllVersionsById(int id)
                                        throws IOException,
                                               RestClientException

Throws:: IOException; RestClientException

getAllVersionsById

public List<SubjectVersion> getAllVersionsById(int id,
                                               String subject)
                                        throws IOException,
                                               RestClientException

Throws:: IOException; RestClientException

getAllVersionsById

public List<SubjectVersion> getAllVersionsById(int id,
                                               String subject,
                                               boolean deleted)
                                        throws IOException,
                                               RestClientException

Throws:: IOException; RestClientException

getAllVersionsById

public List<SubjectVersion> getAllVersionsById(Map<String,String> requestProperties,
                                               int id)
                                        throws IOException,
                                               RestClientException

Throws:: IOException; RestClientException

getAllVersionsById

public List<SubjectVersion> getAllVersionsById(Map<String,String> requestProperties,
                                               int id,
                                               String subject)
                                        throws IOException,
                                               RestClientException

Throws:: IOException; RestClientException

getAllVersionsById

public List<SubjectVersion> getAllVersionsById(Map<String,String> requestProperties,
                                               int id,
                                               String subject,
                                               boolean lookupDeleted)
                                        throws IOException,
                                               RestClientException

Throws:: IOException; RestClientException

getAllVersionsByIdWithPagination

public List<SubjectVersion> getAllVersionsByIdWithPagination(Map<String,String> requestProperties,
                                                             int id,
                                                             String subject,
                                                             boolean lookupDeleted,
                                                             int offset,
                                                             int limit)
                                                      throws IOException,
                                                             RestClientException

Throws:: IOException; RestClientException

deleteSchemaVersion

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

Throws:: IOException; RestClientException

deleteSchemaVersion

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

Throws:: IOException; RestClientException

deleteSubject

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

Throws:: IOException; RestClientException

deleteSubject

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

Throws:: IOException; RestClientException

getClusterId

public ServerClusterId getClusterId()
                             throws IOException,
                                    RestClientException

Throws:: IOException; RestClientException

getClusterId

public ServerClusterId getClusterId(Map<String,String> requestProperties)
                             throws IOException,
                                    RestClientException

Throws:: IOException; RestClientException

getSchemaRegistryServerVersion

public SchemaRegistryServerVersion getSchemaRegistryServerVersion()
                                                           throws IOException,
                                                                  RestClientException

Throws:: IOException; RestClientException

getBaseUrls
```
public UrlList getBaseUrls()
```

setBasicAuthCredentialProvider

public void setBasicAuthCredentialProvider(BasicAuthCredentialProvider basicAuthCredentialProvider)

setBearerAuthCredentialProvider

public void setBearerAuthCredentialProvider(BearerAuthCredentialProvider bearerAuthCredentialProvider)

setHttpHeaders

public void setHttpHeaders(Map<String,String> httpHeaders)

setProxy

public void setProxy(String proxyHost,
                     int proxyPort)

close
```
public void close()
           throws IOException
```
Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

Class RestService

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

X_FORWARD_HEADER

DEFAULT_REQUEST_PROPERTIES

Constructor Detail

RestService

RestService

RestService

RestService

RestService

Method Detail

configure

setSslSocketFactory

setHostnameVerifier

setHttpConnectTimeoutMs

setHttpReadTimeoutMs

buildConnection

httpRequest

isRetriable

lookUpSubjectVersion

lookUpSubjectVersion

lookUpSubjectVersion

lookUpSubjectVersion

lookUpSubjectVersion

lookUpSubjectVersion

lookUpSubjectVersion

lookUpSubjectVersion

registerSchema

registerSchema

registerSchema

registerSchema

registerSchema

registerSchema

registerSchema

registerSchema

registerSchema

registerSchema

registerSchema

modifySchemaTags

testCompatibility

testCompatibility

testCompatibility

testCompatibility

testCompatibility

updateCompatibility

updateConfig

updateConfig

getConfig

getConfig

getConfig

deleteConfig

deleteConfig

setMode

setMode

setMode

setMode

getMode

getMode

getMode

deleteSubjectMode

deleteSubjectMode

getSchemas

getSchemas

getSchemas

getId

getId

getId

getId

getId

getId

getId

getId

getId

getOnlySchemaById

getOnlySchemaById

getSchemaTypes