Package co.elastic.clients.elasticsearch.ingest

Class DatabaseConfiguration

java.lang.Object

co.elastic.clients.elasticsearch.ingest.DatabaseConfiguration

All Implemented Interfaces:

JsonpSerializable, TaggedUnion<DatabaseConfiguration.Kind,Object>

@JsonpDeserializable
public class DatabaseConfiguration
extends Object
implements TaggedUnion<DatabaseConfiguration.Kind,Object>, JsonpSerializable

The configuration necessary to identify which IP geolocation provider to use to download a database, as well as any provider-specific configuration necessary for such downloading. At present, the only supported providers are maxmind and ipinfo, and the maxmind provider requires that an account_id (string) is configured. A provider (either maxmind or ipinfo) must be specified. The web and local providers can be returned as read only configurations.

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DatabaseConfiguration.Builder
static enum	DatabaseConfiguration.Kind	DatabaseConfiguration variant kinds.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<DatabaseConfiguration>	_DESERIALIZER

Method Summary

Modifier and Type	Method	Description
final Object	_get()
final DatabaseConfiguration.Kind	_kind()	Get the of the kind of variant held by this object.
Ipinfo	ipinfo()	Get the ipinfo variant value.
boolean	isIpinfo()	Is this variant instance of kind ipinfo?
boolean	isMaxmind()	Is this variant instance of kind maxmind?
Maxmind	maxmind()	Get the maxmind variant value.
final String	name()	Required - The provider-assigned name of the IP geolocation database to download.
static DatabaseConfiguration	of(Function<DatabaseConfiguration.Builder,ObjectBuilder<DatabaseConfiguration>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupDatabaseConfigurationDeserializer(ObjectDeserializer<DatabaseConfiguration.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<DatabaseConfiguration> _DESERIALIZER

Method Details

_kind

public final DatabaseConfiguration.Kind _kind()

Description copied from interface: TaggedUnion

Get the of the kind of variant held by this object.

Specified by:

_kind in interface TaggedUnion<DatabaseConfiguration.Kind,Object>

Returns:

the variant kind

_get

public final Object _get()

Specified by:

_get in interface TaggedUnion<DatabaseConfiguration.Kind,Object>

of

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

name

public final String name()

Required - The provider-assigned name of the IP geolocation database to download.

API name: name

isMaxmind

public boolean isMaxmind()

Is this variant instance of kind maxmind?

maxmind

public Maxmind maxmind()

Get the maxmind variant value.

Throws:

IllegalStateException - if the current variant is not of the maxmind kind.

isIpinfo

public boolean isIpinfo()

Is this variant instance of kind ipinfo?

ipinfo

public Ipinfo ipinfo()

Get the ipinfo variant value.

Throws:

IllegalStateException - if the current variant is not of the ipinfo kind.

serialize

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

Specified by:

serialize in interface JsonpSerializable

toString

public String toString()

Overrides:

toString in class Object

setupDatabaseConfigurationDeserializer

protected static void setupDatabaseConfigurationDeserializer(ObjectDeserializer<DatabaseConfiguration.Builder> op)