Package org.opensearch.client.opensearch.geospatial

Class OpenSearchGeospatialAsyncClient

java.lang.Object

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

org.opensearch.client.opensearch.geospatial.OpenSearchGeospatialAsyncClient

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

Client for the geospatial namespace.

Field Summary

Fields inherited from class org.opensearch.client.ApiClient

transport, transportOptions

Constructor Summary

Constructors

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

Method Summary

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

OpenSearchGeospatialAsyncClient

public OpenSearchGeospatialAsyncClient(OpenSearchTransport transport)

OpenSearchGeospatialAsyncClient

public OpenSearchGeospatialAsyncClient(OpenSearchTransport transport,
 @Nullable
 TransportOptions transportOptions)

Method Details

withTransportOptions

public OpenSearchGeospatialAsyncClient withTransportOptions(@Nullable
 TransportOptions transportOptions)

Description copied from class: ApiClient

Creates a new client with some request options

Specified by:

withTransportOptions in class ApiClient<OpenSearchTransport,OpenSearchGeospatialAsyncClient>

deleteIp2geoDatasource

public CompletableFuture<DeleteIp2geoDatasourceResponse> deleteIp2geoDatasource(DeleteIp2geoDatasourceRequest request)
                                                                         throws IOException,
OpenSearchException

Delete a specific IP2Geo data source.

Throws:

IOException

OpenSearchException

deleteIp2geoDatasource

public final CompletableFuture<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 CompletableFuture<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 CompletableFuture<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 CompletableFuture<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 CompletableFuture<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 CompletableFuture<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 CompletableFuture<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 CompletableFuture<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 CompletableFuture<GetUploadStatsResponse> getUploadStats(GetUploadStatsRequest request)
                                                         throws IOException,
OpenSearchException

Retrieves statistics for all geospatial uploads.

Throws:

IOException

OpenSearchException

getUploadStats

public final CompletableFuture<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 CompletableFuture<GetUploadStatsResponse> getUploadStats()
                                                               throws IOException,
OpenSearchException

Retrieves statistics for all geospatial uploads.

Throws:

IOException

OpenSearchException

putIp2geoDatasource

public CompletableFuture<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 CompletableFuture<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 CompletableFuture<PutIp2geoDatasourceSettingsResponse> putIp2geoDatasourceSettings(PutIp2geoDatasourceSettingsRequest request)
                                                                                   throws IOException,
OpenSearchException

Update a specific IP2Geo data source.

Throws:

IOException

OpenSearchException

putIp2geoDatasourceSettings

public final CompletableFuture<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