io.confluent.kafka.schemaregistry.rest.resources

Class SchemasResource

java.lang.Object

io.confluent.kafka.schemaregistry.rest.resources.SchemasResource

@Path(value="/schemas")
 @Produces(value={"application/vnd.schemaregistry.v1+json","application/vnd.schemaregistry+json; qs=0.9","application/json; qs=0.5"})
 @Consumes(value={"application/vnd.schemaregistry.v1+json","application/vnd.schemaregistry+json","application/json","application/octet-stream"})
public class SchemasResource
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	apiTag

Constructor Summary

Constructors

Constructor and Description
SchemasResource(KafkaSchemaRegistry schemaRegistry)

Method Summary

Modifier and Type	Method and Description
SchemaString	getSchema(Integer id, String subject, String format, List<String> tags, boolean fetchMaxId)
String	getSchemaOnly(Integer id, String subject, String format)
List<ExtendedSchema>	getSchemas(String subjectPrefix, boolean aliases, boolean lookupDeletedSchema, boolean latestOnly, String ruleType, int offset, int limit)
Set<String>	getSchemaTypes()
Set<String>	getSubjects(Integer id, String subject, boolean lookupDeletedSchema, int offset, int limit)
List<SubjectVersion>	getVersions(Integer id, String subject, boolean lookupDeletedSchema, int offset, int limit)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

apiTag

public static final String apiTag

See Also:

Constant Field Values

Constructor Detail

SchemasResource

public SchemasResource(KafkaSchemaRegistry schemaRegistry)

Method Detail

getSchemas

@GET
 @DocumentedName(value="getSchemas")
 @PerformanceMetric(value="schemas.get-schemas")
public List<ExtendedSchema> getSchemas(@DefaultValue(value="") @QueryParam(value="subjectPrefix")
                                                                                                                                  String subjectPrefix,
                                                                                                                                  @DefaultValue(value="false") @QueryParam(value="aliases")
                                                                                                                                  boolean aliases,
                                                                                                                                  @DefaultValue(value="false") @QueryParam(value="deleted")
                                                                                                                                  boolean lookupDeletedSchema,
                                                                                                                                  @DefaultValue(value="false") @QueryParam(value="latestOnly")
                                                                                                                                  boolean latestOnly,
                                                                                                                                  @DefaultValue(value="") @QueryParam(value="ruleType")
                                                                                                                                  String ruleType,
                                                                                                                                  @DefaultValue(value="0") @QueryParam(value="offset")
                                                                                                                                  int offset,
                                                                                                                                  @DefaultValue(value="-1") @QueryParam(value="limit")
                                                                                                                                  int limit)

getSchema

@GET
 @Path(value="/ids/{id}")
 @DocumentedName(value="getSchemasById")
 @PerformanceMetric(value="schemas.ids.get-schema")
public SchemaString getSchema(@PathParam(value="id")
                                                                                                                                                          Integer id,
                                                                                                                                                          @QueryParam(value="subject")
                                                                                                                                                          String subject,
                                                                                                                                                          @DefaultValue(value="") @QueryParam(value="format")
                                                                                                                                                          String format,
                                                                                                                                                          @QueryParam(value="findTags")
                                                                                                                                                          List<String> tags,
                                                                                                                                                          @DefaultValue(value="false") @QueryParam(value="fetchMaxId")
                                                                                                                                                          boolean fetchMaxId)

getSubjects

@GET
 @Path(value="/ids/{id}/subjects")
 @DocumentedName(value="getAllSubjectsById")
 @PerformanceMetric(value="schemas.get-subjects")
public Set<String> getSubjects(@PathParam(value="id")
                                                                                                                                                                      Integer id,
                                                                                                                                                                      @QueryParam(value="subject")
                                                                                                                                                                      String subject,
                                                                                                                                                                      @QueryParam(value="deleted")
                                                                                                                                                                      boolean lookupDeletedSchema,
                                                                                                                                                                      @DefaultValue(value="0") @QueryParam(value="offset")
                                                                                                                                                                      int offset,
                                                                                                                                                                      @DefaultValue(value="-1") @QueryParam(value="limit")
                                                                                                                                                                      int limit)

getVersions

@GET
 @Path(value="/ids/{id}/versions")
 @DocumentedName(value="getAllVersionsById")
 @PerformanceMetric(value="schemas.get-versions")
public List<SubjectVersion> getVersions(@PathParam(value="id")
                                                                                                                                                                               Integer id,
                                                                                                                                                                               @QueryParam(value="subject")
                                                                                                                                                                               String subject,
                                                                                                                                                                               @QueryParam(value="deleted")
                                                                                                                                                                               boolean lookupDeletedSchema,
                                                                                                                                                                               @DefaultValue(value="0") @QueryParam(value="offset")
                                                                                                                                                                               int offset,
                                                                                                                                                                               @DefaultValue(value="-1") @QueryParam(value="limit")
                                                                                                                                                                               int limit)

getSchemaOnly

@GET
 @Path(value="/ids/{id}/schema")
 @DocumentedName(value="getOnlySchemaById")
 @PerformanceMetric(value="schemas.ids.get-schema.only")
public String getSchemaOnly(@PathParam(value="id")
                                                                                                                                                                       Integer id,
                                                                                                                                                                       @QueryParam(value="subject")
                                                                                                                                                                       String subject,
                                                                                                                                                                       @DefaultValue(value="") @QueryParam(value="format")
                                                                                                                                                                       String format)

getSchemaTypes

@GET
 @Path(value="/types")
 @DocumentedName(value="getSchemaTypes")
 @PerformanceMetric(value="schemas.get-types")
public Set<String> getSchemaTypes()