com.couchbase.client.core.config

Interface ClusterConfig

All Known Implementing Classes:

DefaultClusterConfig

public interface ClusterConfig

Represents a Couchbase Cluster Configuration.

Depending on what buckets are used, a ClusterConfig has 0 to N BucketConfigs associated with it.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
BucketConfig	bucketConfig(String bucketName) Returns the BucketConfig for the given bucket name.
Map<String,BucketConfig>	bucketConfigs()
void	deleteBucketConfig(String bucketName)
boolean	hasBucket(String bucketName) True if there is a bucket config with the given name, false otherwise.
void	setBucketConfig(String bucketName, BucketConfig config) Set a bucket config for the given bucket name.

Method Detail

bucketConfig

BucketConfig bucketConfig(String bucketName)

Returns the BucketConfig for the given bucket name.

Parameters:

bucketName - name of the bucket.

Returns:

a config, if set.

setBucketConfig

void setBucketConfig(String bucketName,
                     BucketConfig config)

Set a bucket config for the given bucket name.

Parameters:

bucketName - the name of the bucket.

config - the configuration associated with the bucket.

deleteBucketConfig

void deleteBucketConfig(String bucketName)

hasBucket

boolean hasBucket(String bucketName)

True if there is a bucket config with the given name, false otherwise.

Parameters:

bucketName - name of the bucket.

Returns:

true if bucket is there.

bucketConfigs

Map<String,BucketConfig> bucketConfigs()