程序包 org.apache.pulsar.client.admin

接口 Schemas

public interface Schemas

Admin interface on interacting with schemas.

方法概要

修饰符和类型	方法	说明
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.
void	deleteSchema(String topic, boolean force)	Delete the schema associated with a given topic.
CompletableFuture<Void>	deleteSchemaAsync(String topic)	Delete the schema associated with a given topic asynchronously.
CompletableFuture<Void>	deleteSchemaAsync(String topic, boolean force)	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.

方法详细资料

getSchemaInfo

SchemaInfo getSchemaInfo(String topic)
                  throws PulsarAdminException

Retrieve the latest schema of a topic.

参数:

topic - topic name, in fully qualified format

返回:

latest schema

抛出:

PulsarAdminException

getSchemaInfoAsync

CompletableFuture<SchemaInfo> getSchemaInfoAsync(String topic)

Retrieve the latest schema of a topic asynchronously.

参数:

topic - topic name, in fully qualified format

返回:

latest schema

getSchemaInfoWithVersion

SchemaInfoWithVersion getSchemaInfoWithVersion(String topic)
                                        throws PulsarAdminException

Retrieve the latest schema with verison of a topic.

参数:

topic - topic name, in fully qualified format

返回:

latest schema with version

抛出:

PulsarAdminException

getSchemaInfoWithVersionAsync

CompletableFuture<SchemaInfoWithVersion> getSchemaInfoWithVersionAsync(String topic)

Retrieve the latest schema with verison of a topic asynchronously.

参数:

topic - topic name, in fully qualified format

返回:

latest schema with version

getSchemaInfo

SchemaInfo getSchemaInfo(String topic,
 long version)
                  throws PulsarAdminException

Retrieve the schema of a topic at a given version.

参数:

topic - topic name, in fully qualified format

version - schema version

返回:

the schema info at a given version

抛出:

PulsarAdminException

getSchemaInfoAsync

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

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

参数:

topic - topic name, in fully qualified format

version - schema version

返回:

the schema info at a given version

deleteSchema

void deleteSchema(String topic)
           throws PulsarAdminException

Delete the schema associated with a given topic.

参数:

topic - topic name, in fully qualified format

抛出:

PulsarAdminException

deleteSchemaAsync

CompletableFuture<Void> deleteSchemaAsync(String topic)

Delete the schema associated with a given topic asynchronously.

参数:

topic - topic name, in fully qualified format

deleteSchema

void deleteSchema(String topic,
 boolean force)
           throws PulsarAdminException

Delete the schema associated with a given topic.

参数:

topic - topic name, in fully qualified format

force - whether to delete schema completely. If true, delete all resources (including metastore and ledger), otherwise only do a mark deletion and not remove any resources indeed

抛出:

PulsarAdminException

deleteSchemaAsync

CompletableFuture<Void> deleteSchemaAsync(String topic,
 boolean force)

Delete the schema associated with a given topic asynchronously.

参数:

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.

参数:

topic - topic name, in fully qualified fomrat

schemaInfo - schema info

抛出:

PulsarAdminException

createSchemaAsync

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

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

参数:

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.

参数:

topic - topic name, in fully qualified format

schemaPayload - schema payload

抛出:

PulsarAdminException

createSchemaAsync

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

Create a schema for a given topic asynchronously.

参数:

topic - topic name, in fully qualified format

schemaPayload - schema payload

testCompatibility

IsCompatibilityResponse testCompatibility(String topic,
 PostSchemaPayload schemaPayload)
                                   throws PulsarAdminException

Judge schema compatibility topic.

参数:

topic - topic name, in fully qualified format

schemaPayload - schema payload

抛出:

PulsarAdminException

testCompatibilityAsync

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

Judge schema compatibility topic asynchronously.

参数:

topic - topic name, in fully qualified format

schemaPayload - schema payload

getVersionBySchema

Long getVersionBySchema(String topic,
 PostSchemaPayload schemaPayload)
                 throws PulsarAdminException

Find schema version topic.

参数:

topic - topic name, in fully qualified format

schemaPayload - schema payload

抛出:

PulsarAdminException

getVersionBySchemaAsync

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

Find schema version topic asynchronously.

参数:

topic - topic name, in fully qualified format

schemaPayload - schema payload

testCompatibility

IsCompatibilityResponse testCompatibility(String topic,
 SchemaInfo schemaInfo)
                                   throws PulsarAdminException

Judge schema compatibility topic.

参数:

topic - topic name, in fully qualified format

schemaInfo - schema info

抛出:

PulsarAdminException

testCompatibilityAsync

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

Judge schema compatibility topic asynchronously.

参数:

topic - topic name, in fully qualified format

schemaInfo - schema info

getVersionBySchema

Long getVersionBySchema(String topic,
 SchemaInfo schemaInfo)
                 throws PulsarAdminException

Find schema version topic.

参数:

topic - topic name, in fully qualified format

schemaInfo - schema info

抛出:

PulsarAdminException

getVersionBySchemaAsync

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

Find schema version topic asynchronously.

参数:

topic - topic name, in fully qualified format

schemaInfo - schema info

getAllSchemas

List<SchemaInfo> getAllSchemas(String topic)
                        throws PulsarAdminException

Get all version schemas topic.

参数:

topic - topic name, in fully qualified format

抛出:

PulsarAdminException

getAllSchemasAsync

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

Get all version schemas topic asynchronously.

参数:

topic - topic name, in fully qualified format