Package io.camunda.zeebe.logstreams.impl.log

Class LogStreamBuilderImpl

java.lang.Object

io.camunda.zeebe.logstreams.impl.log.LogStreamBuilderImpl

All Implemented Interfaces:

LogStreamBuilder

public final class LogStreamBuilderImpl
extends Object
implements LogStreamBuilder

Constructor Summary

Constructors

Constructor	Description
LogStreamBuilderImpl()

Method Summary

Modifier and Type	Method	Description
LogStream	build()	Returns a future which, when completed, contains a log stream that can be read from/written to.
LogStreamBuilder	withClock(InstantSource clock)	Clock used to assign record timestamps
LogStreamBuilder	withLogName(String logName)	The log stream name - primarily used for contextualizing as well, e.g. loggers, actor name, etc.
LogStreamBuilder	withLogStorage(LogStorage logStorage)	The underlying log storage to read from/write to.
LogStreamBuilder	withMaxFragmentSize(int maxFragmentSize)	The maximum fragment size read from the shared write buffer; this should be aligned with the maximum underlying storage block size.
LogStreamBuilder	withMeterRegistry(io.micrometer.core.instrument.MeterRegistry meterRegistry)	Sets the meter registry to collect metrics on.
LogStreamBuilder	withPartitionId(int partitionId)	The partition ID - primarily used for contextualizing the different log stream components
LogStreamBuilder	withRequestLimit(com.netflix.concurrency.limits.Limit requestLimit)
LogStreamBuilder	withWriteRateLimit(RateLimit writeRateLimit)

Methods inherited from class java.lang.Object

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

Constructor Details

LogStreamBuilderImpl

public LogStreamBuilderImpl()

Method Details

withMaxFragmentSize

public LogStreamBuilder withMaxFragmentSize(int maxFragmentSize)

Description copied from interface: LogStreamBuilder

The maximum fragment size read from the shared write buffer; this should be aligned with the maximum underlying storage block size.

Specified by:

withMaxFragmentSize in interface LogStreamBuilder

Parameters:

maxFragmentSize - the maximum fragment size in bytes

Returns:

this builder

withLogStorage

public LogStreamBuilder withLogStorage(LogStorage logStorage)

Description copied from interface: LogStreamBuilder

The underlying log storage to read from/write to.

Specified by:

withLogStorage in interface LogStreamBuilder

Parameters:

logStorage - the underlying log storage

Returns:

this builder

withPartitionId

public LogStreamBuilder withPartitionId(int partitionId)

Description copied from interface: LogStreamBuilder

The partition ID - primarily used for contextualizing the different log stream components

Specified by:

withPartitionId in interface LogStreamBuilder

Parameters:

partitionId - the log stream's partition ID

Returns:

this builder

withLogName

public LogStreamBuilder withLogName(String logName)

Description copied from interface: LogStreamBuilder

The log stream name - primarily used for contextualizing as well, e.g. loggers, actor name, etc.

Specified by:

withLogName in interface LogStreamBuilder

Parameters:

logName - the current log name

Returns:

this builder

withClock

public LogStreamBuilder withClock(InstantSource clock)

Description copied from interface: LogStreamBuilder

Clock used to assign record timestamps

Specified by:

withClock in interface LogStreamBuilder

withRequestLimit

public LogStreamBuilder withRequestLimit(com.netflix.concurrency.limits.Limit requestLimit)

Specified by:

withRequestLimit in interface LogStreamBuilder

withWriteRateLimit

public LogStreamBuilder withWriteRateLimit(RateLimit writeRateLimit)

Specified by:

withWriteRateLimit in interface LogStreamBuilder

withMeterRegistry

public LogStreamBuilder withMeterRegistry(io.micrometer.core.instrument.MeterRegistry meterRegistry)

Description copied from interface: LogStreamBuilder

Sets the meter registry to collect metrics on.

Specified by:

withMeterRegistry in interface LogStreamBuilder

Parameters:

meterRegistry - the new meter registry to collect metrics on

Returns:

this builder

build

public LogStream build()

Description copied from interface: LogStreamBuilder

Returns a future which, when completed, contains a log stream that can be read from/written to.

Specified by:

build in interface LogStreamBuilder

Returns:

a future which on complete contains the log stream