Interface BucketSettings
-
- All Known Implementing Classes:
DefaultBucketSettings
,DefaultBucketSettings.Builder
@Committed @Public public interface BucketSettings
BucketSettings
represent changeable properties for aBucket
.- Since:
- 2.0
- Author:
- Michael Nitschinger
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description CompressionMode
compressionMode()
The different compression modes for the bucket.Map<String,Object>
customSettings()
A map of map of advanced settings that are not covered by the native methods of the object but still need to be set when configuring a bucket.EjectionMethod
ejectionMethod()
The ejection method available for the bucket.boolean
enableFlush()
If flush is enabled.boolean
indexReplicas()
If replicas are indexed.String
name()
The name of the bucket.String
password()
The password of the bucket.int
port()
The optional proxy port.int
quota()
The bucket quota.JsonObject
raw()
A raw representation of the bucket settings when acquired from the server.int
replicas()
Number of replicas.BucketType
type()
The type of the bucket.
-
-
-
Method Detail
-
name
String name()
The name of the bucket.- Returns:
- name of the bucket.
-
type
BucketType type()
The type of the bucket.- Returns:
- type of the bucket.
-
quota
int quota()
The bucket quota.- Returns:
- bucket quota.
-
port
int port()
The optional proxy port.- Returns:
- proxy port.
-
password
String password()
The password of the bucket.- Returns:
- password.
-
replicas
int replicas()
Number of replicas.- Returns:
- number of replicas.
-
indexReplicas
boolean indexReplicas()
If replicas are indexed.- Returns:
- indexing replicas.
-
enableFlush
boolean enableFlush()
If flush is enabled.- Returns:
- flush enabled.
-
compressionMode
CompressionMode compressionMode()
The different compression modes for the bucket.- Returns:
- the compression mode selected.
-
ejectionMethod
EjectionMethod ejectionMethod()
The ejection method available for the bucket.- Returns:
- the ejection method selected.
-
customSettings
Map<String,Object> customSettings()
A map of map of advanced settings that are not covered by the native methods of the object but still need to be set when configuring a bucket. To get a full raw representation of an existing bucket's configuration, seeraw()
instead.- Returns:
- the map of custom advanced settings to use when configuring the bucket.
-
raw
JsonObject raw()
A raw representation of the bucket settings when acquired from the server. This can be used to get any missing information about the bucket that isn't covered by native methods. To configure a bucket and add settings that are not covered by native methods either, you should instead seecustomSettings()
.- Returns:
- the raw representation of the whole bucket settings, as returned by the server, or
an empty
JsonObject
if not applicable.
-
-