org.apache.kafka.clients.admin.DescribeClusterResult 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.kafka.clients.admin;
import org.apache.kafka.common.KafkaFuture;
import org.apache.kafka.common.Node;
import org.apache.kafka.common.acl.AclOperation;
import org.apache.kafka.common.annotation.InterfaceStability;
import java.util.Collection;
import java.util.Set;
/**
* The result of the {@link KafkaAdminClient#describeCluster()} call.
*
* The API of this class is evolving, see {@link Admin} for details.
*/
@InterfaceStability.Evolving
public class DescribeClusterResult {
private final KafkaFuture> nodes;
private final KafkaFuture controller;
private final KafkaFuture clusterId;
private final KafkaFuture> authorizedOperations;
DescribeClusterResult(KafkaFuture> nodes,
KafkaFuture controller,
KafkaFuture clusterId,
KafkaFuture> authorizedOperations) {
this.nodes = nodes;
this.controller = controller;
this.clusterId = clusterId;
this.authorizedOperations = authorizedOperations;
}
/**
* Returns a future which yields a collection of nodes.
*/
public KafkaFuture> nodes() {
return nodes;
}
/**
* Returns a future which yields the current controller id.
* Note that this may yield null, if the controller ID is not yet known.
*/
public KafkaFuture controller() {
return controller;
}
/**
* Returns a future which yields the current cluster id. The future value will be non-null if the
* broker version is 0.10.1.0 or higher and null otherwise.
*/
public KafkaFuture clusterId() {
return clusterId;
}
/**
* Returns a future which yields authorized operations. The future value will be non-null if the
* broker supplied this information, and null otherwise.
*/
public KafkaFuture> authorizedOperations() {
return authorizedOperations;
}
}