Package org.opensearch.client.opensearch.geospatial

Class OpenSearchGeospatialClient

java.lang.Object

org.opensearch.client.ApiClient<OpenSearchTransport,OpenSearchGeospatialClient>

org.opensearch.client.opensearch.geospatial.OpenSearchGeospatialClient

@Generated("org.opensearch.client.codegen.CodeGenerator")
public class OpenSearchGeospatialClient
extends ApiClient<OpenSearchTransport,OpenSearchGeospatialClient>

Client for the geospatial namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

Constructor	Description
OpenSearchGeospatialClient(OpenSearchTransport transport)
OpenSearchGeospatialClient(OpenSearchTransport transport, TransportOptions transportOptions)

Method Summary

Modifier and Type	Method	Description
final DeleteIp2geoDatasourceResponse	deleteIp2geoDatasource(Function<DeleteIp2geoDatasourceRequest.Builder,ObjectBuilder<DeleteIp2geoDatasourceRequest>> fn)	Delete a specific IP2Geo data source.
DeleteIp2geoDatasourceResponse	deleteIp2geoDatasource(DeleteIp2geoDatasourceRequest request)	Delete a specific IP2Geo data source.
final GeojsonUploadPostResponse	geojsonUploadPost(Function<GeojsonUploadPostRequest.Builder,ObjectBuilder<GeojsonUploadPostRequest>> fn)	Use an OpenSearch query to upload GeoJSON, operation will fail if index exists.
GeojsonUploadPostResponse	geojsonUploadPost(GeojsonUploadPostRequest request)	Use an OpenSearch query to upload GeoJSON, operation will fail if index exists.
final GeojsonUploadPutResponse	geojsonUploadPut(Function<GeojsonUploadPutRequest.Builder,ObjectBuilder<GeojsonUploadPutRequest>> fn)	Use an OpenSearch query to upload GeoJSON regardless if index exists.
GeojsonUploadPutResponse	geojsonUploadPut(GeojsonUploadPutRequest request)	Use an OpenSearch query to upload GeoJSON regardless if index exists.
final GetIp2geoDatasourceResponse	getIp2geoDatasource()	Get one or more IP2Geo data sources, defaulting to returning all if no names specified.
final GetIp2geoDatasourceResponse	getIp2geoDatasource(Function<GetIp2geoDatasourceRequest.Builder,ObjectBuilder<GetIp2geoDatasourceRequest>> fn)	Get one or more IP2Geo data sources, defaulting to returning all if no names specified.
GetIp2geoDatasourceResponse	getIp2geoDatasource(GetIp2geoDatasourceRequest request)	Get one or more IP2Geo data sources, defaulting to returning all if no names specified.
final GetUploadStatsResponse	getUploadStats()	Retrieves statistics for all geospatial uploads.
final GetUploadStatsResponse	getUploadStats(Function<GetUploadStatsRequest.Builder,ObjectBuilder<GetUploadStatsRequest>> fn)	Retrieves statistics for all geospatial uploads.
GetUploadStatsResponse	getUploadStats(GetUploadStatsRequest request)	Retrieves statistics for all geospatial uploads.
final PutIp2geoDatasourceResponse	putIp2geoDatasource(Function<PutIp2geoDatasourceRequest.Builder,ObjectBuilder<PutIp2geoDatasourceRequest>> fn)	Create a specific IP2Geo data source.
PutIp2geoDatasourceResponse	putIp2geoDatasource(PutIp2geoDatasourceRequest request)	Create a specific IP2Geo data source.
final PutIp2geoDatasourceSettingsResponse	putIp2geoDatasourceSettings(Function<PutIp2geoDatasourceSettingsRequest.Builder,ObjectBuilder<PutIp2geoDatasourceSettingsRequest>> fn)	Update a specific IP2Geo data source.
PutIp2geoDatasourceSettingsResponse	putIp2geoDatasourceSettings(PutIp2geoDatasourceSettingsRequest request)	Update a specific IP2Geo data source.
OpenSearchGeospatialClient	withTransportOptions(TransportOptions transportOptions)	Creates a new client with some request options

Methods inherited from class org.opensearch.client.ApiClient

_transport, _transportOptions, getDeserializer

Methods inherited from class java.lang.Object

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

Constructor Details

OpenSearchGeospatialClient

public OpenSearchGeospatialClient(OpenSearchTransport transport)

OpenSearchGeospatialClient

public OpenSearchGeospatialClient(OpenSearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public OpenSearchGeospatialClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<OpenSearchTransport,OpenSearchGeospatialClient>

deleteIp2geoDatasource

public DeleteIp2geoDatasourceResponse deleteIp2geoDatasource(DeleteIp2geoDatasourceRequest request)
                                                      throws IOException,
OpenSearchException

Delete a specific IP2Geo data source.

Throws:

IOException

OpenSearchException

deleteIp2geoDatasource

public final DeleteIp2geoDatasourceResponse deleteIp2geoDatasource(Function<DeleteIp2geoDatasourceRequest.Builder,ObjectBuilder<DeleteIp2geoDatasourceRequest>> fn)
                                                            throws IOException,
OpenSearchException

Delete a specific IP2Geo data source.

Parameters:

fn - a function that initializes a builder to create the DeleteIp2geoDatasourceRequest

Throws:

IOException

OpenSearchException

geojsonUploadPost

public GeojsonUploadPostResponse geojsonUploadPost(GeojsonUploadPostRequest request)
                                            throws IOException,
OpenSearchException

Use an OpenSearch query to upload GeoJSON, operation will fail 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).

Throws:

IOException

OpenSearchException

geojsonUploadPost

public final GeojsonUploadPostResponse geojsonUploadPost(Function<GeojsonUploadPostRequest.Builder,ObjectBuilder<GeojsonUploadPostRequest>> fn)
                                                  throws IOException,
OpenSearchException

Use an OpenSearch query to upload GeoJSON, operation will fail 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).

Parameters:

fn - a function that initializes a builder to create the GeojsonUploadPostRequest

Throws:

IOException

OpenSearchException

geojsonUploadPut

public GeojsonUploadPutResponse geojsonUploadPut(GeojsonUploadPutRequest request)
                                          throws IOException,
OpenSearchException

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).

Throws:

IOException

OpenSearchException

geojsonUploadPut

public final GeojsonUploadPutResponse geojsonUploadPut(Function<GeojsonUploadPutRequest.Builder,ObjectBuilder<GeojsonUploadPutRequest>> fn)
                                                throws IOException,
OpenSearchException

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).

Parameters:

fn - a function that initializes a builder to create the GeojsonUploadPutRequest

Throws:

IOException

OpenSearchException

getIp2geoDatasource

public GetIp2geoDatasourceResponse getIp2geoDatasource(GetIp2geoDatasourceRequest request)
                                                throws IOException,
OpenSearchException

Get one or more IP2Geo data sources, defaulting to returning all if no names specified.

Throws:

IOException

OpenSearchException

getIp2geoDatasource

public final GetIp2geoDatasourceResponse getIp2geoDatasource(Function<GetIp2geoDatasourceRequest.Builder,ObjectBuilder<GetIp2geoDatasourceRequest>> fn)
                                                      throws IOException,
OpenSearchException

Get one or more IP2Geo data sources, defaulting to returning all if no names specified.

Parameters:

fn - a function that initializes a builder to create the GetIp2geoDatasourceRequest

Throws:

IOException

OpenSearchException

getIp2geoDatasource

public final GetIp2geoDatasourceResponse getIp2geoDatasource()
                                                      throws IOException,
OpenSearchException

Get one or more IP2Geo data sources, defaulting to returning all if no names specified.

Throws:

IOException

OpenSearchException

getUploadStats

public GetUploadStatsResponse getUploadStats(GetUploadStatsRequest request)
                                      throws IOException,
OpenSearchException

Retrieves statistics for all geospatial uploads.

Throws:

IOException

OpenSearchException

getUploadStats

public final GetUploadStatsResponse getUploadStats(Function<GetUploadStatsRequest.Builder,ObjectBuilder<GetUploadStatsRequest>> fn)
                                            throws IOException,
OpenSearchException

Retrieves statistics for all geospatial uploads.

Parameters:

fn - a function that initializes a builder to create the GetUploadStatsRequest

Throws:

IOException

OpenSearchException

getUploadStats

public final GetUploadStatsResponse getUploadStats()
                                            throws IOException,
OpenSearchException

Retrieves statistics for all geospatial uploads.

Throws:

IOException

OpenSearchException

putIp2geoDatasource

public PutIp2geoDatasourceResponse putIp2geoDatasource(PutIp2geoDatasourceRequest request)
                                                throws IOException,
OpenSearchException

Create a specific IP2Geo data source. Default values:

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

Throws:

IOException

OpenSearchException

putIp2geoDatasource

public final PutIp2geoDatasourceResponse putIp2geoDatasource(Function<PutIp2geoDatasourceRequest.Builder,ObjectBuilder<PutIp2geoDatasourceRequest>> fn)
                                                      throws IOException,
OpenSearchException

Create a specific IP2Geo data source. Default values:

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

Parameters:

fn - a function that initializes a builder to create the PutIp2geoDatasourceRequest

Throws:

IOException

OpenSearchException

putIp2geoDatasourceSettings

public PutIp2geoDatasourceSettingsResponse putIp2geoDatasourceSettings(PutIp2geoDatasourceSettingsRequest request)
                                                                throws IOException,
OpenSearchException

Update a specific IP2Geo data source.

Throws:

IOException

OpenSearchException

putIp2geoDatasourceSettings

public final PutIp2geoDatasourceSettingsResponse putIp2geoDatasourceSettings(Function<PutIp2geoDatasourceSettingsRequest.Builder,ObjectBuilder<PutIp2geoDatasourceSettingsRequest>> fn)
                                                                      throws IOException,
OpenSearchException

Update a specific IP2Geo data source.

Parameters:

fn - a function that initializes a builder to create the PutIp2geoDatasourceSettingsRequest

Throws:

IOException

OpenSearchException