Package com.couchbase.client.java.bucket

Interface BucketInfo

All Known Implementing Classes:
DefaultBucketInfo
@Committed
@Public
public interface BucketInfo
Provides information about a Bucket. Selected bucket properties are available through explicit getters, the full (raw JSON) response from the server is accessible through the raw() method. Note that the response is subject to change across server versions and therefore should be properly checked before being used.
Since:
2.0
Author:
Michael Nitschinger

  • Method Summary

    Modifier and Type Method Description
    String name()
    The name of the bucket.
    int nodeCount()
    The number of nodes on the bucket.
    List<InetAddress> nodeList()
    Returns a list of nodes that is interacting with the bucket.
    JsonObject raw()
    Raw JSON server response for advanced analysis.
    int replicaCount()
    The number of replicas configured.
    BucketType type()
    The type of the bucket.

  • Method Details

    • name

      String name()
      The name of the bucket.
      Returns:
      the bucket name.

    • type

      BucketType type()
      The type of the bucket.
      Returns:
      the bucket type.

    • nodeCount

      int nodeCount()
      The number of nodes on the bucket.
      Returns:
      number of nodes.

    • replicaCount

      int replicaCount()
      The number of replicas configured.
      Returns:
      number of replicas configured.

    • raw

      JsonObject raw()
      Raw JSON server response for advanced analysis.
      Returns:
      the raw JSON bucket info.

    • nodeList

      List<InetAddress> nodeList()
      Returns a list of nodes that is interacting with the bucket.
      Returns:
      the list of nodes.