org.apache.pulsar.common.schema.SchemaType 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.common.schema;
import org.apache.pulsar.common.classification.InterfaceAudience;
import org.apache.pulsar.common.classification.InterfaceStability;
/**
* Types of supported schema for Pulsar messages.
*
* Ideally we should have just one single set of enum definitions
* for schema type. but we have 3 locations of defining schema types.
*
*
when you are adding a new schema type that whose
* schema info is required to be recorded in schema registry,
* add corresponding schema type into `pulsar-common/src/main/proto/PulsarApi.proto`
* and `pulsar-broker/src/main/proto/SchemaRegistryFormat.proto`.
*/
@InterfaceAudience.Public
@InterfaceStability.Stable
public enum SchemaType {
/**
* No schema defined.
*/
NONE(0),
/**
* Simple String encoding with UTF-8.
*/
STRING(1),
/**
* JSON object encoding and validation.
*/
JSON(2),
/**
* Protobuf message encoding and decoding.
*/
PROTOBUF(3),
/**
* Serialize and deserialize via avro.
*/
AVRO(4),
/**
* boolean schema defined.
* @since 2.3.0
*/
BOOLEAN(5),
/**
* A 8-byte integer.
*/
INT8(6),
/**
* A 16-byte integer.
*/
INT16(7),
/**
* A 32-byte integer.
*/
INT32(8),
/**
* A 64-byte integer.
*/
INT64(9),
/**
* A float number.
*/
FLOAT(10),
/**
* A double number.
*/
DOUBLE(11),
/**
* Date.
* @since 2.4.0
*/
DATE(12),
/**
* Time.
* @since 2.4.0
*/
TIME(13),
/**
* Timestamp.
* @since 2.4.0
*/
TIMESTAMP(14),
/**
* A Schema that contains Key Schema and Value Schema.
*/
KEY_VALUE(15),
/**
* Instant.
*/
INSTANT(16),
/**
* LocalDate.
*/
LOCAL_DATE(17),
/**
* LocalTime.
*/
LOCAL_TIME(18),
/**
* LocalDateTime.
*/
LOCAL_DATE_TIME(19),
/**
* Protobuf native schema base on Descriptor.
*/
PROTOBUF_NATIVE(20),
//
// Schemas that don't have schema info. the value should be negative.
//
/**
* A bytes array.
*/
BYTES(-1),
/**
* Auto Detect Schema Type.
*/
@Deprecated
AUTO(-2),
/**
* Auto Consume Type.
*/
AUTO_CONSUME(-3),
/**
* Auto Publish Type.
*/
AUTO_PUBLISH(-4);
int value;
SchemaType(int value) {
this.value = value;
}
public int getValue() {
return this.value;
}
public static SchemaType valueOf(int value) {
switch (value) {
case 0: return NONE;
case 1: return STRING;
case 2: return JSON;
case 3: return PROTOBUF;
case 4: return AVRO;
case 5: return BOOLEAN;
case 6: return INT8;
case 7: return INT16;
case 8: return INT32;
case 9: return INT64;
case 10: return FLOAT;
case 11: return DOUBLE;
case 12: return DATE;
case 13: return TIME;
case 14: return TIMESTAMP;
case 15: return KEY_VALUE;
case 16: return INSTANT;
case 17: return LOCAL_DATE;
case 18: return LOCAL_TIME;
case 19: return LOCAL_DATE_TIME;
case 20: return PROTOBUF_NATIVE;
case -1: return BYTES;
case -2: return AUTO;
case -3: return AUTO_CONSUME;
case -4: return AUTO_PUBLISH;
default: return NONE;
}
}
public boolean isPrimitive() {
return isPrimitiveType(this);
}
public boolean isStruct() {
return isStructType(this);
}
public static boolean isPrimitiveType(SchemaType type) {
switch (type) {
case STRING:
case BOOLEAN:
case INT8:
case INT16:
case INT32:
case INT64:
case FLOAT:
case DOUBLE:
case DATE:
case TIME:
case TIMESTAMP:
case BYTES:
case INSTANT:
case LOCAL_DATE:
case LOCAL_TIME:
case LOCAL_DATE_TIME:
case NONE:
return true;
default:
return false;
}
}
public static boolean isStructType(SchemaType type) {
switch (type) {
case AVRO:
case JSON:
case PROTOBUF:
case PROTOBUF_NATIVE:
return true;
default:
return false;
}
}
}