io.nats.client

Class ConsumeOptions.Builder

java.lang.Object

io.nats.client.BaseConsumeOptions.Builder<ConsumeOptions.Builder,ConsumeOptions>

io.nats.client.ConsumeOptions.Builder

Enclosing class:

ConsumeOptions

public static class ConsumeOptions.Builder
extends BaseConsumeOptions.Builder<ConsumeOptions.Builder,ConsumeOptions>

Field Summary

Fields inherited from class io.nats.client.BaseConsumeOptions.Builder

bytes, expiresIn, group, messages, minAckPending, minPending, raiseStatusWarnings, thresholdPercent

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ConsumeOptions.Builder	batchBytes(long batchBytes) Set the initial batch size in bytes and remove any previously set batch message constraint.
ConsumeOptions.Builder	batchSize(int batchSize) Set the initial batch size in messages and remove any previously set batchBytes(long) constraint.
ConsumeOptions	build() Build the ConsumeOptions.
protected ConsumeOptions.Builder	getThis()

Methods inherited from class io.nats.client.BaseConsumeOptions.Builder

bytes, expiresIn, group, json, jsonValue, messages, minAckPending, minPending, raiseStatusWarnings, raiseStatusWarnings, thresholdPercent

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

getThis

protected ConsumeOptions.Builder getThis()

Specified by:

getThis in class BaseConsumeOptions.Builder<ConsumeOptions.Builder,ConsumeOptions>

batchSize

public ConsumeOptions.Builder batchSize(int batchSize)

Set the initial batch size in messages and remove any previously set batchBytes(long) constraint.

Less than 1 means default of when bytes are not specified. When bytes are specified, the batch messages size is set to prioritize the batch byte amount.

Parameters:

batchSize - the batch size in messages.

Returns:

the builder

batchBytes

public ConsumeOptions.Builder batchBytes(long batchBytes)

Set the initial batch size in bytes and remove any previously set batch message constraint. Less than 1 removes any previously set batch byte constraint.

When setting bytes to non-zero, the batch messages size is set to prioritize the batch byte size.

Also, it is important to set the byte size greater than your largest message payload, plus some amount to account for overhead, otherwise the consume process will stall if there are no messages that fit the criteria.

Parameters:

batchBytes - the batch size in bytes.

Returns:

the builder

See Also:

Message.consumeByteCount()

build

public ConsumeOptions build()

Build the ConsumeOptions.

Specified by:

build in class BaseConsumeOptions.Builder<ConsumeOptions.Builder,ConsumeOptions>

Returns:

a ConsumeOptions instance