org.apache.pulsar.client.admin

Interface Schemas

public interface Schemas

Admin interface on interacting with schemas.

Method Summary

Modifier and Type	Method and Description
void	createSchema(String topic, PostSchemaPayload schemaPayload) Create a schema for a given topic.
void	createSchema(String topic, SchemaInfo schemaInfo) Create a schema for a given topic with the provided schema info.
CompletableFuture<Void>	createSchemaAsync(String topic, PostSchemaPayload schemaPayload) Create a schema for a given topic asynchronously.
CompletableFuture<Void>	createSchemaAsync(String topic, SchemaInfo schemaInfo) Create a schema for a given topic with the provided schema info asynchronously.
void	deleteSchema(String topic) Delete the schema associated with a given topic.
CompletableFuture<Void>	deleteSchemaAsync(String topic) Delete the schema associated with a given topic asynchronously.
List<SchemaInfo>	getAllSchemas(String topic) Get all version schemas topic.
CompletableFuture<List<SchemaInfo>>	getAllSchemasAsync(String topic) Get all version schemas topic asynchronously.
SchemaInfo	getSchemaInfo(String topic) Retrieve the latest schema of a topic.
SchemaInfo	getSchemaInfo(String topic, long version) Retrieve the schema of a topic at a given version.
CompletableFuture<SchemaInfo>	getSchemaInfoAsync(String topic) Retrieve the latest schema of a topic asynchronously.
CompletableFuture<SchemaInfo>	getSchemaInfoAsync(String topic, long version) Retrieve the schema of a topic at a given version asynchronously.
SchemaInfoWithVersion	getSchemaInfoWithVersion(String topic) Retrieve the latest schema with verison of a topic.
CompletableFuture<SchemaInfoWithVersion>	getSchemaInfoWithVersionAsync(String topic) Retrieve the latest schema with verison of a topic asynchronously.
Long	getVersionBySchema(String topic, PostSchemaPayload schemaPayload) Find schema version topic.
Long	getVersionBySchema(String topic, SchemaInfo schemaInfo) Find schema version topic.
CompletableFuture<Long>	getVersionBySchemaAsync(String topic, PostSchemaPayload schemaPayload) Find schema version topic asynchronously.
CompletableFuture<Long>	getVersionBySchemaAsync(String topic, SchemaInfo schemaInfo) Find schema version topic asynchronously.
IsCompatibilityResponse	testCompatibility(String topic, PostSchemaPayload schemaPayload) Judge schema compatibility topic.
IsCompatibilityResponse	testCompatibility(String topic, SchemaInfo schemaInfo) Judge schema compatibility topic.
CompletableFuture<IsCompatibilityResponse>	testCompatibilityAsync(String topic, PostSchemaPayload schemaPayload) Judge schema compatibility topic asynchronously.
CompletableFuture<IsCompatibilityResponse>	testCompatibilityAsync(String topic, SchemaInfo schemaInfo) Judge schema compatibility topic asynchronously.

Method Detail

getSchemaInfo

SchemaInfo getSchemaInfo(String topic)
                  throws PulsarAdminException

Retrieve the latest schema of a topic.

Parameters:

topic - topic name, in fully qualified format

Returns:

latest schema

Throws:

PulsarAdminException

getSchemaInfoAsync

CompletableFuture<SchemaInfo> getSchemaInfoAsync(String topic)

Retrieve the latest schema of a topic asynchronously.

Parameters:

topic - topic name, in fully qualified format

Returns:

latest schema

getSchemaInfoWithVersion

SchemaInfoWithVersion getSchemaInfoWithVersion(String topic)
                                        throws PulsarAdminException

Retrieve the latest schema with verison of a topic.

Parameters:

topic - topic name, in fully qualified format

Returns:

latest schema with version

Throws:

PulsarAdminException

getSchemaInfoWithVersionAsync

CompletableFuture<SchemaInfoWithVersion> getSchemaInfoWithVersionAsync(String topic)

Retrieve the latest schema with verison of a topic asynchronously.

Parameters:

topic - topic name, in fully qualified format

Returns:

latest schema with version

getSchemaInfo

SchemaInfo getSchemaInfo(String topic,
                         long version)
                  throws PulsarAdminException

Retrieve the schema of a topic at a given version.

Parameters:

topic - topic name, in fully qualified format

version - schema version

Returns:

the schema info at a given version

Throws:

PulsarAdminException

getSchemaInfoAsync

CompletableFuture<SchemaInfo> getSchemaInfoAsync(String topic,
                                                 long version)

Retrieve the schema of a topic at a given version asynchronously.

Parameters:

topic - topic name, in fully qualified format

version - schema version

Returns:

the schema info at a given version

deleteSchema

void deleteSchema(String topic)
           throws PulsarAdminException

Delete the schema associated with a given topic.

Parameters:

topic - topic name, in fully qualified format

Throws:

PulsarAdminException

deleteSchemaAsync

CompletableFuture<Void> deleteSchemaAsync(String topic)

Delete the schema associated with a given topic asynchronously.

Parameters:

topic - topic name, in fully qualified format

createSchema

void createSchema(String topic,
                  SchemaInfo schemaInfo)
           throws PulsarAdminException

Create a schema for a given topic with the provided schema info.

Parameters:

topic - topic name, in fully qualified fomrat

schemaInfo - schema info

Throws:

PulsarAdminException

createSchemaAsync

CompletableFuture<Void> createSchemaAsync(String topic,
                                          SchemaInfo schemaInfo)

Create a schema for a given topic with the provided schema info asynchronously.

Parameters:

topic - topic name, in fully qualified fomrat

schemaInfo - schema info

createSchema

void createSchema(String topic,
                  PostSchemaPayload schemaPayload)
           throws PulsarAdminException

Create a schema for a given topic.

Parameters:

topic - topic name, in fully qualified format

schemaPayload - schema payload

Throws:

PulsarAdminException

createSchemaAsync

CompletableFuture<Void> createSchemaAsync(String topic,
                                          PostSchemaPayload schemaPayload)

Create a schema for a given topic asynchronously.

Parameters:

topic - topic name, in fully qualified format

schemaPayload - schema payload

testCompatibility

IsCompatibilityResponse testCompatibility(String topic,
                                          PostSchemaPayload schemaPayload)
                                   throws PulsarAdminException

Judge schema compatibility topic.

Parameters:

topic - topic name, in fully qualified format

schemaPayload - schema payload

Throws:

PulsarAdminException

testCompatibilityAsync

CompletableFuture<IsCompatibilityResponse> testCompatibilityAsync(String topic,
                                                                  PostSchemaPayload schemaPayload)

Judge schema compatibility topic asynchronously.

Parameters:

topic - topic name, in fully qualified format

schemaPayload - schema payload

getVersionBySchema

Long getVersionBySchema(String topic,
                        PostSchemaPayload schemaPayload)
                 throws PulsarAdminException

Find schema version topic.

Parameters:

topic - topic name, in fully qualified format

schemaPayload - schema payload

Throws:

PulsarAdminException

getVersionBySchemaAsync

CompletableFuture<Long> getVersionBySchemaAsync(String topic,
                                                PostSchemaPayload schemaPayload)

Find schema version topic asynchronously.

Parameters:

topic - topic name, in fully qualified format

schemaPayload - schema payload

testCompatibility

IsCompatibilityResponse testCompatibility(String topic,
                                          SchemaInfo schemaInfo)
                                   throws PulsarAdminException

Judge schema compatibility topic.

Parameters:

topic - topic name, in fully qualified format

schemaInfo - schema info

Throws:

PulsarAdminException

testCompatibilityAsync

CompletableFuture<IsCompatibilityResponse> testCompatibilityAsync(String topic,
                                                                  SchemaInfo schemaInfo)

Judge schema compatibility topic asynchronously.

Parameters:

topic - topic name, in fully qualified format

schemaInfo - schema info

getVersionBySchema

Long getVersionBySchema(String topic,
                        SchemaInfo schemaInfo)
                 throws PulsarAdminException

Find schema version topic.

Parameters:

topic - topic name, in fully qualified format

schemaInfo - schema info

Throws:

PulsarAdminException

getVersionBySchemaAsync

CompletableFuture<Long> getVersionBySchemaAsync(String topic,
                                                SchemaInfo schemaInfo)

Find schema version topic asynchronously.

Parameters:

topic - topic name, in fully qualified format

schemaInfo - schema info

getAllSchemas

List<SchemaInfo> getAllSchemas(String topic)
                        throws PulsarAdminException

Get all version schemas topic.

Parameters:

topic - topic name, in fully qualified format

Throws:

PulsarAdminException

getAllSchemasAsync

CompletableFuture<List<SchemaInfo>> getAllSchemasAsync(String topic)

Get all version schemas topic asynchronously.

Parameters:

topic - topic name, in fully qualified format