co.elastic.clients.elasticsearch.ingest.PutPipelineRequest Maven / Gradle / Ivy
/*
* 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.
*/
//----------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------
package co.elastic.clients.elasticsearch.ingest;
import co.elastic.clients.elasticsearch._types.ErrorResponse;
import co.elastic.clients.elasticsearch._types.RequestBase;
import co.elastic.clients.elasticsearch._types.Time;
import co.elastic.clients.json.JsonData;
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.ObjectBuilderDeserializer;
import co.elastic.clients.json.ObjectDeserializer;
import co.elastic.clients.transport.Endpoint;
import co.elastic.clients.transport.endpoints.SimpleEndpoint;
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.Long;
import java.lang.String;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.function.Function;
import javax.annotation.Nullable;
// typedef: ingest.put_pipeline.Request
/**
* Creates or updates a pipeline.
*
* @see API
* specification
*/
@JsonpDeserializable
public class PutPipelineRequest extends RequestBase implements JsonpSerializable {
private final Map meta;
@Nullable
private final String description;
private final String id;
@Nullable
private final Time masterTimeout;
private final List onFailure;
private final List processors;
@Nullable
private final Time timeout;
@Nullable
private final Long version;
// ---------------------------------------------------------------------------------------------
private PutPipelineRequest(Builder builder) {
this.meta = ApiTypeHelper.unmodifiable(builder.meta);
this.description = builder.description;
this.id = ApiTypeHelper.requireNonNull(builder.id, this, "id");
this.masterTimeout = builder.masterTimeout;
this.onFailure = ApiTypeHelper.unmodifiable(builder.onFailure);
this.processors = ApiTypeHelper.unmodifiable(builder.processors);
this.timeout = builder.timeout;
this.version = builder.version;
}
public static PutPipelineRequest of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Optional metadata about the ingest pipeline. May have any contents. This map
* is not automatically generated by Elasticsearch.
*
* API name: {@code _meta}
*/
public final Map meta() {
return this.meta;
}
/**
* Description of the ingest pipeline.
*
* API name: {@code description}
*/
@Nullable
public final String description() {
return this.description;
}
/**
* Required - ID of the ingest pipeline to create or update.
*
* API name: {@code id}
*/
public final String id() {
return this.id;
}
/**
* Period to wait for a connection to the master node. If no response is
* received before the timeout expires, the request fails and returns an error.
*
* API name: {@code master_timeout}
*/
@Nullable
public final Time masterTimeout() {
return this.masterTimeout;
}
/**
* Processors to run immediately after a processor failure. Each processor
* supports a processor-level on_failure value. If a processor
* without an on_failure value fails, Elasticsearch uses this
* pipeline-level parameter as a fallback. The processors in this parameter run
* sequentially in the order specified. Elasticsearch will not attempt to run
* the pipeline's remaining processors.
*
* API name: {@code on_failure}
*/
public final List onFailure() {
return this.onFailure;
}
/**
* Processors used to perform transformations on documents before indexing.
* Processors run sequentially in the order specified.
*
* API name: {@code processors}
*/
public final List processors() {
return this.processors;
}
/**
* Period to wait for a response. If no response is received before the timeout
* expires, the request fails and returns an error.
*
* API name: {@code timeout}
*/
@Nullable
public final Time timeout() {
return this.timeout;
}
/**
* Version number used by external systems to track ingest pipelines. This
* parameter is intended for external systems only. Elasticsearch does not use
* or validate pipeline version numbers.
*
* API name: {@code version}
*/
@Nullable
public final Long version() {
return this.version;
}
/**
* 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) {
if (ApiTypeHelper.isDefined(this.meta)) {
generator.writeKey("_meta");
generator.writeStartObject();
for (Map.Entry item0 : this.meta.entrySet()) {
generator.writeKey(item0.getKey());
item0.getValue().serialize(generator, mapper);
}
generator.writeEnd();
}
if (this.description != null) {
generator.writeKey("description");
generator.write(this.description);
}
if (ApiTypeHelper.isDefined(this.onFailure)) {
generator.writeKey("on_failure");
generator.writeStartArray();
for (Processor item0 : this.onFailure) {
item0.serialize(generator, mapper);
}
generator.writeEnd();
}
if (ApiTypeHelper.isDefined(this.processors)) {
generator.writeKey("processors");
generator.writeStartArray();
for (Processor item0 : this.processors) {
item0.serialize(generator, mapper);
}
generator.writeEnd();
}
if (this.version != null) {
generator.writeKey("version");
generator.write(this.version);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link PutPipelineRequest}.
*/
public static class Builder extends WithJsonObjectBuilderBase
implements
ObjectBuilder {
@Nullable
private Map meta;
@Nullable
private String description;
private String id;
@Nullable
private Time masterTimeout;
@Nullable
private List onFailure;
@Nullable
private List processors;
@Nullable
private Time timeout;
@Nullable
private Long version;
/**
* Optional metadata about the ingest pipeline. May have any contents. This map
* is not automatically generated by Elasticsearch.
*
* API name: {@code _meta}
*
* Adds all entries of map to meta.
*/
public final Builder meta(Map map) {
this.meta = _mapPutAll(this.meta, map);
return this;
}
/**
* Optional metadata about the ingest pipeline. May have any contents. This map
* is not automatically generated by Elasticsearch.
*
* API name: {@code _meta}
*
* Adds an entry to meta.
*/
public final Builder meta(String key, JsonData value) {
this.meta = _mapPut(this.meta, key, value);
return this;
}
/**
* Description of the ingest pipeline.
*
* API name: {@code description}
*/
public final Builder description(@Nullable String value) {
this.description = value;
return this;
}
/**
* Required - ID of the ingest pipeline to create or update.
*
* API name: {@code id}
*/
public final Builder id(String value) {
this.id = value;
return this;
}
/**
* Period to wait for a connection to the master node. If no response is
* received before the timeout expires, the request fails and returns an error.
*
* API name: {@code master_timeout}
*/
public final Builder masterTimeout(@Nullable Time value) {
this.masterTimeout = value;
return this;
}
/**
* Period to wait for a connection to the master node. If no response is
* received before the timeout expires, the request fails and returns an error.
*
* API name: {@code master_timeout}
*/
public final Builder masterTimeout(Function> fn) {
return this.masterTimeout(fn.apply(new Time.Builder()).build());
}
/**
* Processors to run immediately after a processor failure. Each processor
* supports a processor-level on_failure value. If a processor
* without an on_failure value fails, Elasticsearch uses this
* pipeline-level parameter as a fallback. The processors in this parameter run
* sequentially in the order specified. Elasticsearch will not attempt to run
* the pipeline's remaining processors.
*
* API name: {@code on_failure}
*
* Adds all elements of list to onFailure.
*/
public final Builder onFailure(List list) {
this.onFailure = _listAddAll(this.onFailure, list);
return this;
}
/**
* Processors to run immediately after a processor failure. Each processor
* supports a processor-level on_failure value. If a processor
* without an on_failure value fails, Elasticsearch uses this
* pipeline-level parameter as a fallback. The processors in this parameter run
* sequentially in the order specified. Elasticsearch will not attempt to run
* the pipeline's remaining processors.
*
* API name: {@code on_failure}
*
* Adds one or more values to onFailure.
*/
public final Builder onFailure(Processor value, Processor... values) {
this.onFailure = _listAdd(this.onFailure, value, values);
return this;
}
/**
* Processors to run immediately after a processor failure. Each processor
* supports a processor-level on_failure value. If a processor
* without an on_failure value fails, Elasticsearch uses this
* pipeline-level parameter as a fallback. The processors in this parameter run
* sequentially in the order specified. Elasticsearch will not attempt to run
* the pipeline's remaining processors.
*
* API name: {@code on_failure}
*
* Adds a value to onFailure using a builder lambda.
*/
public final Builder onFailure(Function> fn) {
return onFailure(fn.apply(new Processor.Builder()).build());
}
/**
* Processors used to perform transformations on documents before indexing.
* Processors run sequentially in the order specified.
*
* API name: {@code processors}
*
* Adds all elements of list to processors.
*/
public final Builder processors(List list) {
this.processors = _listAddAll(this.processors, list);
return this;
}
/**
* Processors used to perform transformations on documents before indexing.
* Processors run sequentially in the order specified.
*
* API name: {@code processors}
*
* Adds one or more values to processors.
*/
public final Builder processors(Processor value, Processor... values) {
this.processors = _listAdd(this.processors, value, values);
return this;
}
/**
* Processors used to perform transformations on documents before indexing.
* Processors run sequentially in the order specified.
*
* API name: {@code processors}
*
* Adds a value to processors using a builder lambda.
*/
public final Builder processors(Function> fn) {
return processors(fn.apply(new Processor.Builder()).build());
}
/**
* Period to wait for a response. If no response is received before the timeout
* expires, the request fails and returns an error.
*
* API name: {@code timeout}
*/
public final Builder timeout(@Nullable Time value) {
this.timeout = value;
return this;
}
/**
* Period to wait for a response. If no response is received before the timeout
* expires, the request fails and returns an error.
*
* API name: {@code timeout}
*/
public final Builder timeout(Function> fn) {
return this.timeout(fn.apply(new Time.Builder()).build());
}
/**
* Version number used by external systems to track ingest pipelines. This
* parameter is intended for external systems only. Elasticsearch does not use
* or validate pipeline version numbers.
*
* API name: {@code version}
*/
public final Builder version(@Nullable Long value) {
this.version = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link PutPipelineRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public PutPipelineRequest build() {
_checkSingleUse();
return new PutPipelineRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link PutPipelineRequest}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, PutPipelineRequest::setupPutPipelineRequestDeserializer);
protected static void setupPutPipelineRequestDeserializer(ObjectDeserializer op) {
op.add(Builder::meta, JsonpDeserializer.stringMapDeserializer(JsonData._DESERIALIZER), "_meta");
op.add(Builder::description, JsonpDeserializer.stringDeserializer(), "description");
op.add(Builder::onFailure, JsonpDeserializer.arrayDeserializer(Processor._DESERIALIZER), "on_failure");
op.add(Builder::processors, JsonpDeserializer.arrayDeserializer(Processor._DESERIALIZER), "processors");
op.add(Builder::version, JsonpDeserializer.longDeserializer(), "version");
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code ingest.put_pipeline}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/ingest.put_pipeline",
// Request method
request -> {
return "PUT";
},
// Request path
request -> {
final int _id = 1 << 0;
int propsSet = 0;
propsSet |= _id;
if (propsSet == (_id)) {
StringBuilder buf = new StringBuilder();
buf.append("/_ingest");
buf.append("/pipeline");
buf.append("/");
SimpleEndpoint.pathEncode(request.id, buf);
return buf.toString();
}
throw SimpleEndpoint.noPathTemplateFound("path");
},
// Request parameters
request -> {
Map params = new HashMap<>();
if (request.masterTimeout != null) {
params.put("master_timeout", request.masterTimeout._toJsonString());
}
if (request.timeout != null) {
params.put("timeout", request.timeout._toJsonString());
}
return params;
}, SimpleEndpoint.emptyMap(), true, PutPipelineResponse._DESERIALIZER);
}