com.github.nickrm.jflux.domain

Class RetentionPolicy.Builder

java.lang.Object

com.github.nickrm.jflux.domain.RetentionPolicy.Builder

Enclosing class:

RetentionPolicy

public static final class RetentionPolicy.Builder
extends Object

Used to create instances of RetentionPolicy.

Constructor Summary

Constructors

Constructor and Description
Builder(String name, Duration duration) Initializes a new instance setting the required fields.

Method Summary

Modifier and Type	Method and Description
RetentionPolicy	build() Constructs a retention policy instance from the values set in this builder.
RetentionPolicy.Builder	duration(Duration duration) Sets the RetentionPolicy.duration for the retention policy.
RetentionPolicy.Builder	isDefault(boolean isDefault) Sets a value indicating whether this retention policy should be the default retention policy.
RetentionPolicy.Builder	replication(int replication) Sets the replication factor for the retention policy.
RetentionPolicy.Builder	shardDuration(Duration shardDuration) Sets the shard duration for the retention policy.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder(String name,
               Duration duration)

Initializes a new instance setting the required fields.

The fields specified in this constructor are mandatory, the rest are optional and if not set will fall back to default values.

Parameters:

name - name of the retention policy

duration - duration of the retention policy

See Also:

RetentionPolicy.duration

Method Detail

duration

public RetentionPolicy.Builder duration(Duration duration)

Sets the RetentionPolicy.duration for the retention policy.

Parameters:

duration - the retention policy duration

Returns:

this builder

replication

public RetentionPolicy.Builder replication(int replication)

Sets the replication factor for the retention policy.

Parameters:

replication - number of replicas, must be positive

Returns:

this builder

shardDuration

public RetentionPolicy.Builder shardDuration(Duration shardDuration)

Sets the shard duration for the retention policy.

Parameters:

shardDuration - the shard duration to use, must not be null or negative

Returns:

this builder

isDefault

public RetentionPolicy.Builder isDefault(boolean isDefault)

Sets a value indicating whether this retention policy should be the default retention policy.

If not set, this value defaults to false.

Parameters:

isDefault - whether the retention policy is the default one

Returns:

this builder

build

public RetentionPolicy build()

Constructs a retention policy instance from the values set in this builder.

Returns:

the new retention policy instance

Throws:

IllegalStateException - if any of the values set in this builder are illegal