Package io.confluent.kafka.schemaregistry.rest.resources

Class SchemasResource

java.lang.Object

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

@Path("/schemas")
@Produces({"application/vnd.schemaregistry.v1+json","application/vnd.schemaregistry+json; qs=0.9","application/json; qs=0.5"})
@Consumes({"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	Description
static final String	apiTag

Constructor Summary

Constructors

Constructor	Description
SchemasResource(SchemaRegistry schemaRegistry)

Method Summary

Modifier and Type	Method	Description
List<ContextId>	getIdsByGuid(String guid)
SchemaString	getSchema(Integer id, String subject, String format, String referenceFormat, List<String> tags, boolean fetchMaxId)
SchemaString	getSchemaByGuid(String guid, String format)
String	getSchemaOnly(Integer id, String subject, String format)
List<ExtendedSchema>	getSchemas(String subjectPrefix, boolean aliases, boolean lookupDeletedSchema, boolean latestOnly, String ruleType, String resourceType, List<String> associationTypes, LifecyclePolicy lifecycle, 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 Details

apiTag

public static final String apiTag

See Also:

• Constant Field Values

Constructor Details

SchemasResource

@Inject
public SchemasResource(SchemaRegistry schemaRegistry)

Method Details

getSchemas

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

getSchema

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

getSubjects

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

getVersions

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

getSchemaOnly

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

getSchemaByGuid

@GET
@Path("/guids/{guid}")
@DocumentedName("getSchemaByGuid")
@PerformanceMetric("schemas.guids.get-schema")
public SchemaString getSchemaByGuid(@PathParam("guid")
 String guid,
 @DefaultValue("") @QueryParam("format")
 String format)

getIdsByGuid

@GET
@Path("/guids/{guid}/ids")
@DocumentedName("getAllIdsByGuid")
@PerformanceMetric("schemas.guids.get-ids")
public List<ContextId> getIdsByGuid(@PathParam("guid")
 String guid)

getSchemaTypes

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