org.apache.pulsar.client.api.schema.GenericObject Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pulsar-client-api Show documentation

There is a newer version: 4.0.0.10

/**
 * 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 org.apache.pulsar.common.schema.SchemaType;

/**
 * This is an abstraction over the logical value that is store into a Message.
 * Pulsar decodes the payload of the Message using the Schema that is configured for the topic.
 */
public interface GenericObject {

    /**
     * Return the schema tyoe.
     *
     * @return the schema type
     * @throws UnsupportedOperationException if this feature is not implemented
     * @see SchemaType#BYTES when the topic has no schema information
     * @see SchemaType#STRING
     * @see SchemaType#AVRO
     * @see SchemaType#PROTOBUF_NATIVE
     * @see SchemaType#JSON
     */
    SchemaType getSchemaType();

    /**
     * Return the internal native representation of the Object,
     * like a AVRO GenericRecord, a String or a byte[].
     *
     * @return the decoded object
     * @throws UnsupportedOperationException if the operation is not supported
     */
    Object getNativeObject();
}