co.elastic.clients.elasticsearch.logstash.PipelineSettings Maven / Gradle / Ivy
Show all versions of org.apache.servicemix.bundles.elasticsearch-java
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package co.elastic.clients.elasticsearch.logstash;
import co.elastic.clients.json.JsonpDeserializable;
import co.elastic.clients.json.JsonpDeserializer;
import co.elastic.clients.json.JsonpMapper;
import co.elastic.clients.json.JsonpSerializable;
import co.elastic.clients.json.JsonpUtils;
import co.elastic.clients.json.ObjectBuilderDeserializer;
import co.elastic.clients.json.ObjectDeserializer;
import co.elastic.clients.util.ApiTypeHelper;
import co.elastic.clients.util.ObjectBuilder;
import co.elastic.clients.util.WithJsonObjectBuilderBase;
import jakarta.json.stream.JsonGenerator;
import java.lang.Integer;
import java.lang.String;
import java.util.Objects;
import java.util.function.Function;
import javax.annotation.Nullable;
//----------------------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------------------
//
// This code is generated from the Elasticsearch API specification
// at https://github.com/elastic/elasticsearch-specification
//
// Manual updates to this file will be lost when the code is
// re-generated.
//
// If you find a property that is missing or wrongly typed, please
// open an issue or a PR on the API specification repository.
//
//----------------------------------------------------------------
// typedef: logstash._types.PipelineSettings
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class PipelineSettings implements JsonpSerializable {
private final int pipelineWorkers;
private final int pipelineBatchSize;
private final int pipelineBatchDelay;
private final String queueType;
private final String queueMaxBytes;
private final int queueCheckpointWrites;
// ---------------------------------------------------------------------------------------------
private PipelineSettings(Builder builder) {
this.pipelineWorkers = ApiTypeHelper.requireNonNull(builder.pipelineWorkers, this, "pipelineWorkers", 0);
this.pipelineBatchSize = ApiTypeHelper.requireNonNull(builder.pipelineBatchSize, this, "pipelineBatchSize", 0);
this.pipelineBatchDelay = ApiTypeHelper.requireNonNull(builder.pipelineBatchDelay, this, "pipelineBatchDelay",
0);
this.queueType = ApiTypeHelper.requireNonNull(builder.queueType, this, "queueType");
this.queueMaxBytes = ApiTypeHelper.requireNonNull(builder.queueMaxBytes, this, "queueMaxBytes");
this.queueCheckpointWrites = ApiTypeHelper.requireNonNull(builder.queueCheckpointWrites, this,
"queueCheckpointWrites", 0);
}
public static PipelineSettings of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Required - The number of workers that will, in parallel, execute the filter
* and output stages of the pipeline.
*
* API name: {@code pipeline.workers}
*/
public final int pipelineWorkers() {
return this.pipelineWorkers;
}
/**
* Required - The maximum number of events an individual worker thread will
* collect from inputs before attempting to execute its filters and outputs.
*
* API name: {@code pipeline.batch.size}
*/
public final int pipelineBatchSize() {
return this.pipelineBatchSize;
}
/**
* 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: {@code pipeline.batch.delay}
*/
public final int pipelineBatchDelay() {
return this.pipelineBatchDelay;
}
/**
* Required - The internal queuing model to use for event buffering.
*
* API name: {@code queue.type}
*/
public final String queueType() {
return this.queueType;
}
/**
* Required - The total capacity of the queue
* (queue.type: persisted) in number of bytes.
*
* API name: {@code queue.max_bytes}
*/
public final String queueMaxBytes() {
return this.queueMaxBytes;
}
/**
* Required - The maximum number of written events before forcing a checkpoint
* when persistent queues are enabled (queue.type: persisted).
*
* API name: {@code queue.checkpoint.writes}
*/
public final int queueCheckpointWrites() {
return this.queueCheckpointWrites;
}
/**
* Serialize this object to JSON.
*/
public void serialize(JsonGenerator generator, JsonpMapper mapper) {
generator.writeStartObject();
serializeInternal(generator, mapper);
generator.writeEnd();
}
protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
generator.writeKey("pipeline.workers");
generator.write(this.pipelineWorkers);
generator.writeKey("pipeline.batch.size");
generator.write(this.pipelineBatchSize);
generator.writeKey("pipeline.batch.delay");
generator.write(this.pipelineBatchDelay);
generator.writeKey("queue.type");
generator.write(this.queueType);
generator.writeKey("queue.max_bytes");
generator.write(this.queueMaxBytes);
generator.writeKey("queue.checkpoint.writes");
generator.write(this.queueCheckpointWrites);
}
@Override
public String toString() {
return JsonpUtils.toString(this);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link PipelineSettings}.
*/
public static class Builder extends WithJsonObjectBuilderBase implements ObjectBuilder {
private Integer pipelineWorkers;
private Integer pipelineBatchSize;
private Integer pipelineBatchDelay;
private String queueType;
private String queueMaxBytes;
private Integer queueCheckpointWrites;
/**
* Required - The number of workers that will, in parallel, execute the filter
* and output stages of the pipeline.
*
* API name: {@code pipeline.workers}
*/
public final Builder pipelineWorkers(int value) {
this.pipelineWorkers = value;
return this;
}
/**
* Required - The maximum number of events an individual worker thread will
* collect from inputs before attempting to execute its filters and outputs.
*
* API name: {@code pipeline.batch.size}
*/
public final Builder pipelineBatchSize(int value) {
this.pipelineBatchSize = value;
return this;
}
/**
* 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: {@code pipeline.batch.delay}
*/
public final Builder pipelineBatchDelay(int value) {
this.pipelineBatchDelay = value;
return this;
}
/**
* Required - The internal queuing model to use for event buffering.
*
* API name: {@code queue.type}
*/
public final Builder queueType(String value) {
this.queueType = value;
return this;
}
/**
* Required - The total capacity of the queue
* (queue.type: persisted) in number of bytes.
*
* API name: {@code queue.max_bytes}
*/
public final Builder queueMaxBytes(String value) {
this.queueMaxBytes = value;
return this;
}
/**
* Required - The maximum number of written events before forcing a checkpoint
* when persistent queues are enabled (queue.type: persisted).
*
* API name: {@code queue.checkpoint.writes}
*/
public final Builder queueCheckpointWrites(int value) {
this.queueCheckpointWrites = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link PipelineSettings}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public PipelineSettings build() {
_checkSingleUse();
return new PipelineSettings(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link PipelineSettings}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer.lazy(Builder::new,
PipelineSettings::setupPipelineSettingsDeserializer);
protected static void setupPipelineSettingsDeserializer(ObjectDeserializer op) {
op.add(Builder::pipelineWorkers, JsonpDeserializer.integerDeserializer(), "pipeline.workers");
op.add(Builder::pipelineBatchSize, JsonpDeserializer.integerDeserializer(), "pipeline.batch.size");
op.add(Builder::pipelineBatchDelay, JsonpDeserializer.integerDeserializer(), "pipeline.batch.delay");
op.add(Builder::queueType, JsonpDeserializer.stringDeserializer(), "queue.type");
op.add(Builder::queueMaxBytes, JsonpDeserializer.stringDeserializer(), "queue.max_bytes");
op.add(Builder::queueCheckpointWrites, JsonpDeserializer.integerDeserializer(), "queue.checkpoint.writes");
}
}