org.apache.pulsar.client.api.schema.SchemaDefinitionBuilder Maven / Gradle / Ivy
/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.pulsar.client.api.schema;
import java.util.Map;
import org.apache.pulsar.common.classification.InterfaceAudience;
import org.apache.pulsar.common.classification.InterfaceStability;
/**
* Builder to build schema definition {@link SchemaDefinition}.
*/
@InterfaceAudience.Public
@InterfaceStability.Stable
public interface SchemaDefinitionBuilder {
/**
* Set schema whether always allow null or not.
*
* @param alwaysAllowNull definition null or not
* @return schema definition builder
*/
SchemaDefinitionBuilder withAlwaysAllowNull(boolean alwaysAllowNull);
/**
* Set schema use JRS310 conversion or not.
*
* Before Avro 1.9 the Joda time library was used for handling the logical date(time) values.
* But since the introduction of Java8 the Java Specification Request (JSR) 310 has been included,
* which greatly improves the handling of date and time natively. To keep forwarding compatibility,
* default is use Joda time conversion.
*
*
JSR310 conversion is recommended here. Joda time conversion is has been marked deprecated.
* In future versions, joda time conversion may be removed
*
* @param jsr310ConversionEnabled use JRS310 conversion or not, default is false for keep forwarding compatibility
* @return schema definition builder
*/
SchemaDefinitionBuilder withJSR310ConversionEnabled(boolean jsr310ConversionEnabled);
/**
* Set schema info properties.
*
* @param properties schema info properties
* @return schema definition builder
*/
SchemaDefinitionBuilder withProperties(Map properties);
/**
* Set schema info properties.
*
* @param key property key
* @param value property value
*
* @return schema definition builder
*/
SchemaDefinitionBuilder addProperty(String key, String value);
/**
* Set schema of pojo definition.
*
* @param pojo pojo schema definition
*
* @return schema definition builder
*/
SchemaDefinitionBuilder withPojo(Class pojo);
/**
* Set schema of json definition.
*
* @param jsonDefinition json schema definition
*
* @return schema definition builder
*/
SchemaDefinitionBuilder withJsonDef(String jsonDefinition);
/**
* Set schema whether decode by schema version.
*
* @param supportSchemaVersioning decode by version
*
* @return schema definition builder
*/
SchemaDefinitionBuilder withSupportSchemaVersioning(boolean supportSchemaVersioning);
/**
* Set schema reader for deserialization of object data.
*
* @param reader reader for object data
*
* @return schema definition builder
*/
SchemaDefinitionBuilder withSchemaReader(SchemaReader reader);
/**
* Set schema writer for serialization of objects.
*
* @param writer writer for objects
*
* @return schema definition builder
*/
SchemaDefinitionBuilder withSchemaWriter(SchemaWriter writer);
/**
* Build the schema definition.
*
* @return the schema definition.
*/
SchemaDefinition build();
}