public interface BucketConfig
Represents a Couchbase Bucket Configuration.
Modifier and Type | Method and Description |
---|---|
boolean |
hasFastForwardMap()
Returns true if the config has a fast forward map that describes what the topology of the cluster will be after the current rebalance operation completes.
|
BucketNodeLocator |
locator()
The type of node locator in use for this bucket.
|
String |
name()
The name of the bucket.
|
List<NodeInfo> |
nodes()
The list of nodes associated with this bucket.
|
String |
password()
The password of the bucket/user.
|
BucketConfig |
password(String password)
Setter to inject the password manually into the config.
|
long |
rev()
Revision number (optional) for that configuration.
|
boolean |
serviceEnabled(ServiceType type)
Check if the service is enabled on the bucket.
|
String |
streamingUri()
The HTTP Streaming URI for this bucket.
|
boolean |
tainted()
Returns true if the config indicates the cluster is undergoing a transition (such as a rebalance operation).
|
BucketType |
type()
The bucket type.
|
String |
uri()
The HTTP Uri for this bucket configuration.
|
String |
useAlternateNetwork()
Non null if alternate addresses should be used, false otherwise.
|
void |
useAlternateNetwork(String useAlternateNetwork)
Setter to set if external networking should be used or not.
|
String |
username()
User authorized for the bucket access.
|
BucketConfig |
username(String username)
Set user authorized for the bucket access.
|
String |
uuid()
Returns the UUID of the bucket, or
null if the bucket does not have a UUID. |
String uuid()
Returns the UUID of the bucket, or null
if the bucket does not have a UUID.
The UUID is an opaque value assigned when the bucket is created. If the bucket is deleted and a new bucket is created with the same name, the new bucket will have a different UUID.
null
.String name()
The name of the bucket.
String username()
User authorized for the bucket access.
BucketConfig username(String username)
Set user authorized for the bucket access.
username
- the user authorized for bucket accessString password()
The password of the bucket/user.
BucketConfig password(String password)
Setter to inject the password manually into the config.
password
- the password of the bucket/user to inject.BucketNodeLocator locator()
The type of node locator in use for this bucket.
String uri()
The HTTP Uri for this bucket configuration.
String streamingUri()
The HTTP Streaming URI for this bucket.
List<NodeInfo> nodes()
The list of nodes associated with this bucket.
boolean tainted()
Returns true if the config indicates the cluster is undergoing a transition (such as a rebalance operation).
long rev()
Revision number (optional) for that configuration.
BucketType type()
The bucket type.
boolean serviceEnabled(ServiceType type)
Check if the service is enabled on the bucket.
type
- the type to check.boolean hasFastForwardMap()
Returns true if the config has a fast forward map that describes what the topology of the cluster will be after the current rebalance operation completes.
String useAlternateNetwork()
Non null if alternate addresses should be used, false otherwise.
@InterfaceAudience.Private void useAlternateNetwork(String useAlternateNetwork)
Setter to set if external networking should be used or not.
useAlternateNetwork
- if an alternate network should be used.Copyright © 2018 Couchbase, Inc.. All rights reserved.