Package co.elastic.clients.elasticsearch.logstash

Class PipelineSettings

java.lang.Object

co.elastic.clients.elasticsearch.logstash.PipelineSettings

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class PipelineSettings
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PipelineSettings.Builder	Builder for PipelineSettings.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<PipelineSettings>	_DESERIALIZER	Json deserializer for PipelineSettings

Method Summary

Modifier and Type	Method	Description
static PipelineSettings	of(Function<PipelineSettings.Builder,ObjectBuilder<PipelineSettings>> fn)
final int	pipelineBatchDelay()	Required - When creating pipeline event batches, how long in milliseconds to wait for each event before dispatching an undersized batch to pipeline workers.
final int	pipelineBatchSize()	Required - The maximum number of events an individual worker thread will collect from inputs before attempting to execute its filters and outputs.
final int	pipelineWorkers()	Required - The number of workers that will, in parallel, execute the filter and output stages of the pipeline.
final int	queueCheckpointWrites()	Required - The maximum number of written events before forcing a checkpoint when persistent queues are enabled (queue.type: persisted).
final int	queueMaxBytesNumber()	Required - The total capacity of the queue (queue.type: persisted) in number of bytes.
final String	queueMaxBytesUnits()	Required - The total capacity of the queue (queue.type: persisted) in terms of units of bytes.
final String	queueType()	Required - The internal queuing model to use for event buffering.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupPipelineSettingsDeserializer(ObjectDeserializer<PipelineSettings.Builder> op)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

_DESERIALIZER

public static final JsonpDeserializer<PipelineSettings> _DESERIALIZER

Json deserializer for PipelineSettings

Method Details

of

public static PipelineSettings of(Function<PipelineSettings.Builder,ObjectBuilder<PipelineSettings>> fn)

pipelineWorkers

public final int pipelineWorkers()

Required - The number of workers that will, in parallel, execute the filter and output stages of the pipeline.

API name: pipeline.workers

pipelineBatchSize

public final int pipelineBatchSize()

Required - The maximum number of events an individual worker thread will collect from inputs before attempting to execute its filters and outputs.

API name: pipeline.batch.size

pipelineBatchDelay

public final int pipelineBatchDelay()

Required - When creating pipeline event batches, how long in milliseconds to wait for each event before dispatching an undersized batch to pipeline workers.

API name: pipeline.batch.delay

queueType

public final String queueType()

Required - The internal queuing model to use for event buffering.

API name: queue.type

queueMaxBytesNumber

public final int queueMaxBytesNumber()

Required - The total capacity of the queue (queue.type: persisted) in number of bytes.

API name: queue.max_bytes.number

queueMaxBytesUnits

public final String queueMaxBytesUnits()

Required - The total capacity of the queue (queue.type: persisted) in terms of units of bytes.

API name: queue.max_bytes.units

queueCheckpointWrites

public final int queueCheckpointWrites()

Required - The maximum number of written events before forcing a checkpoint when persistent queues are enabled (queue.type: persisted).

API name: queue.checkpoint.writes

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toString

public String toString()

Overrides:

toString in class Object

setupPipelineSettingsDeserializer

protected static void setupPipelineSettingsDeserializer(ObjectDeserializer<PipelineSettings.Builder> op)