co.elastic.clients.elasticsearch.ingest.GeoIpProcessor 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.
*/
package co.elastic.clients.elasticsearch.ingest;
import co.elastic.clients.json.JsonpDeserializable;
import co.elastic.clients.json.JsonpDeserializer;
import co.elastic.clients.json.JsonpMapper;
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 jakarta.json.stream.JsonGenerator;
import java.lang.Boolean;
import java.lang.String;
import java.util.List;
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: ingest._types.GeoIpProcessor
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class GeoIpProcessor extends ProcessorBase implements ProcessorVariant {
@Nullable
private final String databaseFile;
private final String field;
@Nullable
private final Boolean firstOnly;
@Nullable
private final Boolean ignoreMissing;
private final List properties;
@Nullable
private final String targetField;
@Nullable
private final Boolean downloadDatabaseOnPipelineCreation;
// ---------------------------------------------------------------------------------------------
private GeoIpProcessor(Builder builder) {
super(builder);
this.databaseFile = builder.databaseFile;
this.field = ApiTypeHelper.requireNonNull(builder.field, this, "field");
this.firstOnly = builder.firstOnly;
this.ignoreMissing = builder.ignoreMissing;
this.properties = ApiTypeHelper.unmodifiable(builder.properties);
this.targetField = builder.targetField;
this.downloadDatabaseOnPipelineCreation = builder.downloadDatabaseOnPipelineCreation;
}
public static GeoIpProcessor of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Processor variant kind.
*/
@Override
public Processor.Kind _processorKind() {
return Processor.Kind.Geoip;
}
/**
* The database filename referring to a database the module ships with
* (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom
* database in the ingest-geoip config directory.
*
* API name: {@code database_file}
*/
@Nullable
public final String databaseFile() {
return this.databaseFile;
}
/**
* Required - The field to get the ip address from for the geographical lookup.
*
* API name: {@code field}
*/
public final String field() {
return this.field;
}
/**
* If true, only the first found geoip data will be returned, even
* if the field contains an array.
*
* API name: {@code first_only}
*/
@Nullable
public final Boolean firstOnly() {
return this.firstOnly;
}
/**
* If true and field does not exist, the processor
* quietly exits without modifying the document.
*
* API name: {@code ignore_missing}
*/
@Nullable
public final Boolean ignoreMissing() {
return this.ignoreMissing;
}
/**
* Controls what properties are added to the target_field based on
* the geoip lookup.
*
* API name: {@code properties}
*/
public final List properties() {
return this.properties;
}
/**
* The field that will hold the geographical information looked up from the
* MaxMind database.
*
* API name: {@code target_field}
*/
@Nullable
public final String targetField() {
return this.targetField;
}
/**
* If true (and if
* ingest.geoip.downloader.eager.download is false),
* the missing database is downloaded when the pipeline is created. Else, the
* download is triggered by when the pipeline is used as the
* default_pipeline or final_pipeline in an index.
*
* API name: {@code download_database_on_pipeline_creation}
*/
@Nullable
public final Boolean downloadDatabaseOnPipelineCreation() {
return this.downloadDatabaseOnPipelineCreation;
}
protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
super.serializeInternal(generator, mapper);
if (this.databaseFile != null) {
generator.writeKey("database_file");
generator.write(this.databaseFile);
}
generator.writeKey("field");
generator.write(this.field);
if (this.firstOnly != null) {
generator.writeKey("first_only");
generator.write(this.firstOnly);
}
if (this.ignoreMissing != null) {
generator.writeKey("ignore_missing");
generator.write(this.ignoreMissing);
}
if (ApiTypeHelper.isDefined(this.properties)) {
generator.writeKey("properties");
generator.writeStartArray();
for (String item0 : this.properties) {
generator.write(item0);
}
generator.writeEnd();
}
if (this.targetField != null) {
generator.writeKey("target_field");
generator.write(this.targetField);
}
if (this.downloadDatabaseOnPipelineCreation != null) {
generator.writeKey("download_database_on_pipeline_creation");
generator.write(this.downloadDatabaseOnPipelineCreation);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link GeoIpProcessor}.
*/
public static class Builder extends ProcessorBase.AbstractBuilder
implements
ObjectBuilder {
@Nullable
private String databaseFile;
private String field;
@Nullable
private Boolean firstOnly;
@Nullable
private Boolean ignoreMissing;
@Nullable
private List properties;
@Nullable
private String targetField;
@Nullable
private Boolean downloadDatabaseOnPipelineCreation;
/**
* The database filename referring to a database the module ships with
* (GeoLite2-City.mmdb, GeoLite2-Country.mmdb, or GeoLite2-ASN.mmdb) or a custom
* database in the ingest-geoip config directory.
*
* API name: {@code database_file}
*/
public final Builder databaseFile(@Nullable String value) {
this.databaseFile = value;
return this;
}
/**
* Required - The field to get the ip address from for the geographical lookup.
*
* API name: {@code field}
*/
public final Builder field(String value) {
this.field = value;
return this;
}
/**
* If true, only the first found geoip data will be returned, even
* if the field contains an array.
*
* API name: {@code first_only}
*/
public final Builder firstOnly(@Nullable Boolean value) {
this.firstOnly = value;
return this;
}
/**
* If true and field does not exist, the processor
* quietly exits without modifying the document.
*
* API name: {@code ignore_missing}
*/
public final Builder ignoreMissing(@Nullable Boolean value) {
this.ignoreMissing = value;
return this;
}
/**
* Controls what properties are added to the target_field based on
* the geoip lookup.
*
* API name: {@code properties}
*
* Adds all elements of list to properties.
*/
public final Builder properties(List list) {
this.properties = _listAddAll(this.properties, list);
return this;
}
/**
* Controls what properties are added to the target_field based on
* the geoip lookup.
*
* API name: {@code properties}
*
* Adds one or more values to properties.
*/
public final Builder properties(String value, String... values) {
this.properties = _listAdd(this.properties, value, values);
return this;
}
/**
* The field that will hold the geographical information looked up from the
* MaxMind database.
*
* API name: {@code target_field}
*/
public final Builder targetField(@Nullable String value) {
this.targetField = value;
return this;
}
/**
* If true (and if
* ingest.geoip.downloader.eager.download is false),
* the missing database is downloaded when the pipeline is created. Else, the
* download is triggered by when the pipeline is used as the
* default_pipeline or final_pipeline in an index.
*
* API name: {@code download_database_on_pipeline_creation}
*/
public final Builder downloadDatabaseOnPipelineCreation(@Nullable Boolean value) {
this.downloadDatabaseOnPipelineCreation = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link GeoIpProcessor}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public GeoIpProcessor build() {
_checkSingleUse();
return new GeoIpProcessor(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link GeoIpProcessor}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer.lazy(Builder::new,
GeoIpProcessor::setupGeoIpProcessorDeserializer);
protected static void setupGeoIpProcessorDeserializer(ObjectDeserializer op) {
ProcessorBase.setupProcessorBaseDeserializer(op);
op.add(Builder::databaseFile, JsonpDeserializer.stringDeserializer(), "database_file");
op.add(Builder::field, JsonpDeserializer.stringDeserializer(), "field");
op.add(Builder::firstOnly, JsonpDeserializer.booleanDeserializer(), "first_only");
op.add(Builder::ignoreMissing, JsonpDeserializer.booleanDeserializer(), "ignore_missing");
op.add(Builder::properties, JsonpDeserializer.arrayDeserializer(JsonpDeserializer.stringDeserializer()),
"properties");
op.add(Builder::targetField, JsonpDeserializer.stringDeserializer(), "target_field");
op.add(Builder::downloadDatabaseOnPipelineCreation, JsonpDeserializer.booleanDeserializer(),
"download_database_on_pipeline_creation");
}
}