org.apache.pulsar.client.api.TableViewBuilder 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;
import java.util.Map;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.TimeUnit;
import org.apache.pulsar.common.classification.InterfaceAudience;
import org.apache.pulsar.common.classification.InterfaceStability;
/**
* {@link TableViewBuilder} is used to configure and create instances of {@link TableView}.
*
* @see PulsarClient#newTableViewBuilder(Schema) ()
*
* @since 2.10.0
*/
@InterfaceAudience.Public
@InterfaceStability.Evolving
public interface TableViewBuilder {
/**
* Load the configuration from provided config map.
*
* Example:
*
*
{@code
* Map config = new HashMap<>();
* config.put("topicName", "test-topic");
* config.put("autoUpdatePartitionsSeconds", "300");
*
* TableViewBuilder builder = ...;
* builder = builder.loadConf(config);
*
* TableView tableView = builder.create();
* }
*
* @param config configuration to load
* @return the {@link TableViewBuilder} instance
*/
TableViewBuilder loadConf(Map config);
/**
* Finalize the creation of the {@link TableView} instance.
*
* This method will block until the tableView is created successfully or an exception is thrown.
*
* @return the {@link TableView} instance
* @throws PulsarClientException
* if the tableView creation fails
*/
TableView create() throws PulsarClientException;
/**
* Finalize the creation of the {@link TableView} instance in asynchronous mode.
*
* This method will return a {@link CompletableFuture} that can be used to access the instance when it's ready.
*
* @return the {@link TableView} instance
*/
CompletableFuture> createAsync();
/**
* Set the topic name of the {@link TableView}.
*
* @param topic the name of the topic to create the {@link TableView}
* @return the {@link TableViewBuilder} builder instance
*/
TableViewBuilder topic(String topic);
/**
* Set the interval of updating partitions (default: 1 minute).
* @param interval the interval of updating partitions
* @param unit the time unit of the interval
* @return the {@link TableViewBuilder} builder instance
*/
TableViewBuilder autoUpdatePartitionsInterval(int interval, TimeUnit unit);
/**
* Set the subscription name of the {@link TableView}.
*
* @param subscriptionName the name of the subscription to the topic
* @return the {@link TableViewBuilder} builder instance
*/
TableViewBuilder subscriptionName(String subscriptionName);
/**
* Set the {@link CryptoKeyReader} to decrypt the message payloads.
*
* @param cryptoKeyReader CryptoKeyReader object
* @return the {@link TableViewBuilder} builder instance
*/
TableViewBuilder cryptoKeyReader(CryptoKeyReader cryptoKeyReader);
/**
* Set the default implementation of {@link CryptoKeyReader}.
*
* Configure the key reader to be used to decrypt message payloads.
*
* @param privateKey the private key that is always used to decrypt message payloads.
* @return the {@link TableViewBuilder} builder instance
*/
TableViewBuilder defaultCryptoKeyReader(String privateKey);
/**
* Set the default implementation of {@link CryptoKeyReader}.
*
* Configure the key reader to be used to decrypt message payloads.
*
* @param privateKeys the map of private key names and their URIs
* used to decrypt message payloads.
* @return the {@link TableViewBuilder} builder instance
*/
TableViewBuilder defaultCryptoKeyReader(Map privateKeys);
/**
* Set the {@link ConsumerCryptoFailureAction} to specify.
*
* @param action the action to take when the decoding fails
* @return the {@link TableViewBuilder} builder instance
*/
TableViewBuilder cryptoFailureAction(ConsumerCryptoFailureAction action);
}