Package org.opensearch.client.opensearch.geospatial

Class GeojsonUploadPutRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.geospatial.GeojsonUploadPutRequest

All Implemented Interfaces:

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

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

Use an OpenSearch query to upload GeoJSON regardless if index exists.

• When type is geo_point, only Point geometry is allowed
• When type is geo_shape, all geometry types are allowed (Point, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection, Envelope).

Nested Class Summary

Nested Classes

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

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<GeojsonUploadPutRequest>	_DESERIALIZER	Json deserializer for GeojsonUploadPutRequest
static final Endpoint<GeojsonUploadPutRequest,GeojsonUploadPutResponse,ErrorResponse>	_ENDPOINT	Endpoint "geospatial.geojson_upload_put".

Method Summary

Modifier and Type	Method	Description
static GeojsonUploadPutRequest.Builder	builder()
final List<GeoJSONData>	data()	Required - Array of GeoJSON features.
boolean	equals(Object o)
final String	field()	Field name for the geospatial data.
int	hashCode()
final String	index()	Required - API name: index
static GeojsonUploadPutRequest	of(Function<GeojsonUploadPutRequest.Builder,ObjectBuilder<GeojsonUploadPutRequest>> 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	setupGeojsonUploadPutRequestDeserializer(ObjectDeserializer<GeojsonUploadPutRequest.Builder> op)
GeojsonUploadPutRequest.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final GeospatialFieldType	type()	Required - Field type for the geospatial data.

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<GeojsonUploadPutRequest> _DESERIALIZER

Json deserializer for GeojsonUploadPutRequest

_ENDPOINT

public static final Endpoint<GeojsonUploadPutRequest,GeojsonUploadPutResponse,ErrorResponse> _ENDPOINT

Endpoint "geospatial.geojson_upload_put".

Method Details

of

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

data

@Nonnull
public final List<GeoJSONData> data()

Required - Array of GeoJSON features.

API name: data

field

@Nullable
public final String field()

Field name for the geospatial data.

API name: field

index

@Nonnull
public final String index()

Required - API name: index

type

@Nonnull
public final GeospatialFieldType type()

Required - Field type for the geospatial data.

API name: type

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 GeojsonUploadPutRequest.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<GeojsonUploadPutRequest.Builder,GeojsonUploadPutRequest>

Returns:

a new builder instance.

builder

@Nonnull
public static GeojsonUploadPutRequest.Builder builder()

setupGeojsonUploadPutRequestDeserializer

protected static void setupGeojsonUploadPutRequestDeserializer(ObjectDeserializer<GeojsonUploadPutRequest.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object