org.apache.pulsar.client.admin.Bookies Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulsar-client-admin-api Show documentation
The newest version!
/*
 * 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.admin;

import java.util.concurrent.CompletableFuture;
import org.apache.pulsar.common.policies.data.BookieInfo;
import org.apache.pulsar.common.policies.data.BookiesClusterInfo;
import org.apache.pulsar.common.policies.data.BookiesRackConfiguration;

/**
 * Admin interface for bookies rack placement management.
 */
public interface Bookies {

    /**
     * Gets the rack placement information for all the bookies in the cluster.
     */
    BookiesRackConfiguration getBookiesRackInfo() throws PulsarAdminException;

    /**
     * Gets the rack placement information for all the bookies in the cluster asynchronously.
     */
    CompletableFuture getBookiesRackInfoAsync();

    /**
     * Gets discovery information for all the bookies in the cluster.
     */
    BookiesClusterInfo getBookies() throws PulsarAdminException;

    /**
     * Gets discovery information for all the bookies in the cluster asynchronously.
     */
    CompletableFuture getBookiesAsync();

    /**
     * Gets the rack placement information for a specific bookie in the cluster.
     */
    BookieInfo getBookieRackInfo(String bookieAddress) throws PulsarAdminException;

    /**
     * Gets the rack placement information for a specific bookie in the cluster asynchronously.
     */
    CompletableFuture getBookieRackInfoAsync(String bookieAddress);

    /**
     * Remove rack placement information for a specific bookie in the cluster.
     */
    void deleteBookieRackInfo(String bookieAddress) throws PulsarAdminException;

    /**
     * Remove rack placement information for a specific bookie in the cluster asynchronously.
     */
    CompletableFuture deleteBookieRackInfoAsync(String bookieAddress);

    /**
     * Updates the rack placement information for a specific bookie in the cluster.
     */
    void updateBookieRackInfo(String bookieAddress, String group, BookieInfo bookieInfo) throws PulsarAdminException;

    /**
     * Updates the rack placement information for a specific bookie in the cluster asynchronously.
     */
    CompletableFuture updateBookieRackInfoAsync(String bookieAddress, String group, BookieInfo bookieInfo);
}