Package org.opensearch.client.opensearch.geospatial

Class PutIp2geoDatasourceRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.geospatial.PutIp2geoDatasourceRequest

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<PutIp2geoDatasourceRequest.Builder,PutIp2geoDatasourceRequest>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public final class PutIp2geoDatasourceRequest
extends RequestBase
implements PlainJsonSerializable, ToCopyableBuilder<PutIp2geoDatasourceRequest.Builder,PutIp2geoDatasourceRequest>

Create a specific IP2Geo data source. Default values:

• endpoint: "https://geoip.maps.opensearch.org/v1/geolite2-city/manifest.json"
• update_interval_in_days: 3.

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<PutIp2geoDatasourceRequest>	_DESERIALIZER	Json deserializer for PutIp2geoDatasourceRequest
static final Endpoint<PutIp2geoDatasourceRequest,PutIp2geoDatasourceResponse,ErrorResponse>	_ENDPOINT	Endpoint "geospatial.put_ip2geo_datasource".

Method Summary

Modifier and Type	Method	Description
static PutIp2geoDatasourceRequest.Builder	builder()
final String	endpoint()	URL endpoint for the data source.
boolean	equals(Object o)
int	hashCode()
final String	name()	Required - API name: name
static PutIp2geoDatasourceRequest	of(Function<PutIp2geoDatasourceRequest.Builder,ObjectBuilder<PutIp2geoDatasourceRequest>> fn)
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	setupPutIp2geoDatasourceRequestDeserializer(ObjectDeserializer<PutIp2geoDatasourceRequest.Builder> op)
PutIp2geoDatasourceRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final Integer	updateIntervalInDays()	Update interval in days.

Methods inherited from class org.opensearch.client.opensearch._types.RequestBase

applyQueryParameters, errorTrace, human

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<PutIp2geoDatasourceRequest> _DESERIALIZER

Json deserializer for PutIp2geoDatasourceRequest

_ENDPOINT

public static final Endpoint<PutIp2geoDatasourceRequest,PutIp2geoDatasourceResponse,ErrorResponse> _ENDPOINT

Endpoint "geospatial.put_ip2geo_datasource".

Method Details

of

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

endpoint

@Nullable
public final String endpoint()

URL endpoint for the data source.

API name: endpoint

name

@Nonnull
public final String name()

Required - API name: name

updateIntervalInDays

@Nullable
public final Integer updateIntervalInDays()

Update interval in days.

API name: update_interval_in_days

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)

toBuilder

@Nonnull
public PutIp2geoDatasourceRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<PutIp2geoDatasourceRequest.Builder,PutIp2geoDatasourceRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static PutIp2geoDatasourceRequest.Builder builder()

setupPutIp2geoDatasourceRequestDeserializer

protected static void setupPutIp2geoDatasourceRequestDeserializer(ObjectDeserializer<PutIp2geoDatasourceRequest.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object