Class LowLevelGeospatialNamespace

Geospatial APIs.

Not intended to be instantiated directly. Use the Geospatial property on IOpenSearchLowLevelClient.

Inheritance

object

NamespacedClientProxy

LowLevelGeospatialNamespace

Inherited Members

NamespacedClientProxy.DoRequest<TResponse>(HttpMethod, string, PostData, IRequestParameters)

NamespacedClientProxy.DoRequestAsync<TResponse>(HttpMethod, string, CancellationToken, PostData, IRequestParameters)

NamespacedClientProxy.Url(FormattableString)

NamespacedClientProxy.RequestParams<TRequestParams>(TRequestParams, string)

NamespacedClientProxy.RequestParams<TRequestParams>(TRequestParams)

NamespacedClientProxy.ContentType

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Net.Specification.GeospatialApi

Assembly: OpenSearch.Net.dll

Syntax

public class LowLevelGeospatialNamespace : NamespacedClientProxy

Methods

| Edit this page View Source

DeleteIp2geoDatasourceAsync<TResponse>(string, DeleteIp2geoDatasourceRequestParameters, CancellationToken)

DELETE on /_plugins/geospatial/ip2geo/datasource/{name}

https://docs.opensearch.org/docs/latest/ingest-pipelines/processors/ip2geo/#deleting-the-ip2geo-data-source

Declaration

public Task<TResponse> DeleteIp2geoDatasourceAsync<TResponse>(string name, DeleteIp2geoDatasourceRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name
DeleteIp2geoDatasourceRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.11.0 or greater.

| Edit this page View Source

DeleteIp2geoDatasource<TResponse>(string, DeleteIp2geoDatasourceRequestParameters)

DELETE on /_plugins/geospatial/ip2geo/datasource/{name}

https://docs.opensearch.org/docs/latest/ingest-pipelines/processors/ip2geo/#deleting-the-ip2geo-data-source

Declaration

public TResponse DeleteIp2geoDatasource<TResponse>(string name, DeleteIp2geoDatasourceRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name
DeleteIp2geoDatasourceRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.11.0 or greater.

| Edit this page View Source

GeojsonUploadPostAsync<TResponse>(PostData, GeojsonUploadPostRequestParameters, CancellationToken)

POST on /_plugins/geospatial/geojson/_upload

Declaration

public Task<TResponse> GeojsonUploadPostAsync<TResponse>(PostData body, GeojsonUploadPostRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
GeojsonUploadPostRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.11.0 or greater.

| Edit this page View Source

GeojsonUploadPost<TResponse>(PostData, GeojsonUploadPostRequestParameters)

POST on /_plugins/geospatial/geojson/_upload

Declaration

public TResponse GeojsonUploadPost<TResponse>(PostData body, GeojsonUploadPostRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
GeojsonUploadPostRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.11.0 or greater.

| Edit this page View Source

GeojsonUploadPutAsync<TResponse>(PostData, GeojsonUploadPutRequestParameters, CancellationToken)

PUT on /_plugins/geospatial/geojson/_upload

Declaration

public Task<TResponse> GeojsonUploadPutAsync<TResponse>(PostData body, GeojsonUploadPutRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
GeojsonUploadPutRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.11.0 or greater.

| Edit this page View Source

GeojsonUploadPut<TResponse>(PostData, GeojsonUploadPutRequestParameters)

PUT on /_plugins/geospatial/geojson/_upload

Declaration

public TResponse GeojsonUploadPut<TResponse>(PostData body, GeojsonUploadPutRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
GeojsonUploadPutRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.11.0 or greater.

| Edit this page View Source

GetIp2geoDatasourceAsync<TResponse>(GetIp2geoDatasourceRequestParameters, CancellationToken)

GET on /_plugins/geospatial/ip2geo/datasource

https://docs.opensearch.org/docs/latest/ingest-pipelines/processors/ip2geo/#sending-a-get-request

Declaration

public Task<TResponse> GetIp2geoDatasourceAsync<TResponse>(GetIp2geoDatasourceRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetIp2geoDatasourceRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.11.0 or greater.

| Edit this page View Source

GetIp2geoDatasourceAsync<TResponse>(string, GetIp2geoDatasourceRequestParameters, CancellationToken)

GET on /_plugins/geospatial/ip2geo/datasource/{name}

https://docs.opensearch.org/docs/latest/ingest-pipelines/processors/ip2geo/#sending-a-get-request

Declaration

public Task<TResponse> GetIp2geoDatasourceAsync<TResponse>(string name, GetIp2geoDatasourceRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name
GetIp2geoDatasourceRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.11.0 or greater.

| Edit this page View Source

GetIp2geoDatasource<TResponse>(GetIp2geoDatasourceRequestParameters)

GET on /_plugins/geospatial/ip2geo/datasource

https://docs.opensearch.org/docs/latest/ingest-pipelines/processors/ip2geo/#sending-a-get-request

Declaration

public TResponse GetIp2geoDatasource<TResponse>(GetIp2geoDatasourceRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetIp2geoDatasourceRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.11.0 or greater.

| Edit this page View Source

GetIp2geoDatasource<TResponse>(string, GetIp2geoDatasourceRequestParameters)

GET on /_plugins/geospatial/ip2geo/datasource/{name}

https://docs.opensearch.org/docs/latest/ingest-pipelines/processors/ip2geo/#sending-a-get-request

Declaration

public TResponse GetIp2geoDatasource<TResponse>(string name, GetIp2geoDatasourceRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name
GetIp2geoDatasourceRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.11.0 or greater.

| Edit this page View Source

GetUploadStatsAsync<TResponse>(GetUploadStatsRequestParameters, CancellationToken)

GET on /_plugins/geospatial/_upload/stats

Declaration

public Task<TResponse> GetUploadStatsAsync<TResponse>(GetUploadStatsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetUploadStatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.11.0 or greater.

| Edit this page View Source

GetUploadStats<TResponse>(GetUploadStatsRequestParameters)

GET on /_plugins/geospatial/_upload/stats

Declaration

public TResponse GetUploadStats<TResponse>(GetUploadStatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetUploadStatsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.11.0 or greater.

| Edit this page View Source

PutIp2geoDatasourceAsync<TResponse>(string, PostData, PutIp2geoDatasourceRequestParameters, CancellationToken)

PUT on /_plugins/geospatial/ip2geo/datasource/{name}

https://docs.opensearch.org/docs/latest/ingest-pipelines/processors/ip2geo/#data-source-options

Declaration

public Task<TResponse> PutIp2geoDatasourceAsync<TResponse>(string name, PostData body, PutIp2geoDatasourceRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name
PostData	body
PutIp2geoDatasourceRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.11.0 or greater.

| Edit this page View Source

PutIp2geoDatasourceSettingsAsync<TResponse>(string, PostData, PutIp2geoDatasourceSettingsRequestParameters, CancellationToken)

PUT on /_plugins/geospatial/ip2geo/datasource/{name}/_settings

https://docs.opensearch.org/docs/latest/ingest-pipelines/processors/ip2geo/#updating-an-ip2geo-data-source

Declaration

public Task<TResponse> PutIp2geoDatasourceSettingsAsync<TResponse>(string name, PostData body, PutIp2geoDatasourceSettingsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name
PostData	body
PutIp2geoDatasourceSettingsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.11.0 or greater.

| Edit this page View Source

PutIp2geoDatasourceSettings<TResponse>(string, PostData, PutIp2geoDatasourceSettingsRequestParameters)

PUT on /_plugins/geospatial/ip2geo/datasource/{name}/_settings

https://docs.opensearch.org/docs/latest/ingest-pipelines/processors/ip2geo/#updating-an-ip2geo-data-source

Declaration

public TResponse PutIp2geoDatasourceSettings<TResponse>(string name, PostData body, PutIp2geoDatasourceSettingsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name
PostData	body
PutIp2geoDatasourceSettingsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.11.0 or greater.

| Edit this page View Source

PutIp2geoDatasource<TResponse>(string, PostData, PutIp2geoDatasourceRequestParameters)

PUT on /_plugins/geospatial/ip2geo/datasource/{name}

https://docs.opensearch.org/docs/latest/ingest-pipelines/processors/ip2geo/#data-source-options

Declaration

public TResponse PutIp2geoDatasource<TResponse>(string name, PostData body, PutIp2geoDatasourceRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	name
PostData	body
PutIp2geoDatasourceRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.11.0 or greater.

Extension Methods

SuffixExtensions.Suffix(object, string)