org.apache.pulsar.client.api.TopicConsumerBuilder 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;

/**
 * {@link TopicConsumerBuilder} is used to configure topic specific options to override those set at the
 * {@link ConsumerBuilder} level.
 *
 * @see ConsumerBuilder#topicConfiguration(String)
 *
 * @param  the type of the value in the {@link ConsumerBuilder}
 */
public interface TopicConsumerBuilder {
    /**
     * Configure the priority level of this topic.
     *
     * @see ConsumerBuilder#priorityLevel(int)
     *
     * @param priorityLevel the priority of this topic
     * @return the {@link TopicConsumerBuilder} instance
     */
    TopicConsumerBuilder priorityLevel(int priorityLevel);

    /**
     * Complete the configuration of the topic specific options and return control back to the
     * {@link ConsumerBuilder} instance.
     *
     * @return the {@link ConsumerBuilder} instance
     */
    ConsumerBuilder build();
}