/* SPDX-License-Identifier: Apache-2.0
*
* The OpenSearch Contributors require contributions made to
* this file be licensed under the Apache-2.0 license or a
* compatible open source license.
*/
/*
* Modifications Copyright OpenSearch Contributors. See
* GitHub history for details.
*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
// ███╗ ██╗ ██████╗ ████████╗██╗ ██████╗███████╗
// ████╗ ██║██╔═══██╗╚══██╔══╝██║██╔════╝██╔════╝
// ██╔██╗ ██║██║ ██║ ██║ ██║██║ █████╗
// ██║╚██╗██║██║ ██║ ██║ ██║██║ ██╔══╝
// ██║ ╚████║╚██████╔╝ ██║ ██║╚██████╗███████╗
// ╚═╝ ╚═══╝ ╚═════╝ ╚═╝ ╚═╝ ╚═════╝╚══════╝
// -----------------------------------------------
//
// This file is automatically generated
// Please do not edit these files manually
// Run the following in the root of the repos:
//
// *NIX : ./build.sh codegen
// Windows : build.bat codegen
//
// -----------------------------------------------
// ReSharper disable RedundantUsingDirective
using System;
using System.Collections.Generic;
using System.Collections.Specialized;
using System.Linq;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using OpenSearch.Net;
using OpenSearch.Net.Specification.CatApi;
using OpenSearch.Net.Specification.ClusterApi;
using OpenSearch.Net.Specification.DanglingIndicesApi;
using OpenSearch.Net.Specification.FeaturesApi;
using OpenSearch.Net.Specification.IndicesApi;
using OpenSearch.Net.Specification.IngestApi;
using OpenSearch.Net.Specification.NodesApi;
using OpenSearch.Net.Specification.SnapshotApi;
using OpenSearch.Net.Specification.TasksApi;
namespace OpenSearch.Net
{
///
///OpenSearch low level client
///
public partial interface IOpenSearchLowLevelClient
{
///Cat APIs
LowLevelCatNamespace Cat
{
get;
}
///Cluster APIs
LowLevelClusterNamespace Cluster
{
get;
}
///Dangling Indices APIs
LowLevelDanglingIndicesNamespace DanglingIndices
{
get;
}
///Features APIs
LowLevelFeaturesNamespace Features
{
get;
}
///Indices APIs
LowLevelIndicesNamespace Indices
{
get;
}
///Ingest APIs
LowLevelIngestNamespace Ingest
{
get;
}
///Nodes APIs
LowLevelNodesNamespace Nodes
{
get;
}
///POST on /_bulk https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/bulk/
///The operation definition and data (action-data pairs), separated by newlines
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse Bulk(PostData body, BulkRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///POST on /_bulk https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/bulk/
///The operation definition and data (action-data pairs), separated by newlines
///Request specific configuration such as querystring parameters & request specific connection settings.
Task BulkAsync(PostData body, BulkRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///POST on /{index}/_bulk https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/bulk/
///Default index for items which don't provide one
///The operation definition and data (action-data pairs), separated by newlines
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse Bulk(string index, PostData body, BulkRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///POST on /{index}/_bulk https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/bulk/
///Default index for items which don't provide one
///The operation definition and data (action-data pairs), separated by newlines
///Request specific configuration such as querystring parameters & request specific connection settings.
Task BulkAsync(string index, PostData body, BulkRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///DELETE on /_search/scroll https://opensearch.org/docs/latest/opensearch/rest-api/scroll/
///A comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse ClearScroll(PostData body, ClearScrollRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///DELETE on /_search/scroll https://opensearch.org/docs/latest/opensearch/rest-api/scroll/
///A comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter
///Request specific configuration such as querystring parameters & request specific connection settings.
Task ClearScrollAsync(PostData body, ClearScrollRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///POST on /_count https://opensearch.org/docs/latest/opensearch/rest-api/count/
///A query to restrict the results specified with the Query DSL (optional)
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse Count(PostData body, CountRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///POST on /_count https://opensearch.org/docs/latest/opensearch/rest-api/count/
///A query to restrict the results specified with the Query DSL (optional)
///Request specific configuration such as querystring parameters & request specific connection settings.
Task CountAsync(PostData body, CountRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///POST on /{index}/_count https://opensearch.org/docs/latest/opensearch/rest-api/count/
///A comma-separated list of indices to restrict the results
///A query to restrict the results specified with the Query DSL (optional)
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse Count(string index, PostData body, CountRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///POST on /{index}/_count https://opensearch.org/docs/latest/opensearch/rest-api/count/
///A comma-separated list of indices to restrict the results
///A query to restrict the results specified with the Query DSL (optional)
///Request specific configuration such as querystring parameters & request specific connection settings.
Task CountAsync(string index, PostData body, CountRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///PUT on /{index}/_create/{id} https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/index-document/
///The name of the index
///Document ID
///The document
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse Create(string index, string id, PostData body, CreateRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///PUT on /{index}/_create/{id} https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/index-document/
///The name of the index
///Document ID
///The document
///Request specific configuration such as querystring parameters & request specific connection settings.
Task CreateAsync(string index, string id, PostData body, CreateRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///DELETE on /{index}/_doc/{id} https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/delete-document/
///The name of the index
///The document ID
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse Delete(string index, string id, DeleteRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///DELETE on /{index}/_doc/{id} https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/delete-document/
///The name of the index
///The document ID
///Request specific configuration such as querystring parameters & request specific connection settings.
Task DeleteAsync(string index, string id, DeleteRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///POST on /{index}/_delete_by_query https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/delete-by-query/
///A comma-separated list of index names to search; use the special string `_all` or Indices.All to perform the operation on all indices
///The search definition using the Query DSL
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse DeleteByQuery(string index, PostData body, DeleteByQueryRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///POST on /{index}/_delete_by_query https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/delete-by-query/
///A comma-separated list of index names to search; use the special string `_all` or Indices.All to perform the operation on all indices
///The search definition using the Query DSL
///Request specific configuration such as querystring parameters & request specific connection settings.
Task DeleteByQueryAsync(string index, PostData body, DeleteByQueryRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///POST on /_delete_by_query/{task_id}/_rethrottle https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/delete-by-query/
///The task id to rethrottle
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse DeleteByQueryRethrottle(string taskId, DeleteByQueryRethrottleRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///POST on /_delete_by_query/{task_id}/_rethrottle https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/delete-by-query/
///The task id to rethrottle
///Request specific configuration such as querystring parameters & request specific connection settings.
Task DeleteByQueryRethrottleAsync(string taskId, DeleteByQueryRethrottleRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///DELETE on /_scripts/{id}
///Script ID
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse DeleteScript(string id, DeleteScriptRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///DELETE on /_scripts/{id}
///Script ID
///Request specific configuration such as querystring parameters & request specific connection settings.
Task DeleteScriptAsync(string id, DeleteScriptRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///HEAD on /{index}/_doc/{id} https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/
///The name of the index
///The document ID
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse DocumentExists(string index, string id, DocumentExistsRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///HEAD on /{index}/_doc/{id} https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/
///The name of the index
///The document ID
///Request specific configuration such as querystring parameters & request specific connection settings.
Task DocumentExistsAsync(string index, string id, DocumentExistsRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///HEAD on /{index}/_source/{id} https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/
///The name of the index
///The document ID
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse SourceExists(string index, string id, SourceExistsRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///HEAD on /{index}/_source/{id} https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/
///The name of the index
///The document ID
///Request specific configuration such as querystring parameters & request specific connection settings.
Task SourceExistsAsync(string index, string id, SourceExistsRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///POST on /{index}/_explain/{id} https://opensearch.org/docs/latest/opensearch/rest-api/explain/
///The name of the index
///The document ID
///The query definition using the Query DSL
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse Explain(string index, string id, PostData body, ExplainRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///POST on /{index}/_explain/{id} https://opensearch.org/docs/latest/opensearch/rest-api/explain/
///The name of the index
///The document ID
///The query definition using the Query DSL
///Request specific configuration such as querystring parameters & request specific connection settings.
Task ExplainAsync(string index, string id, PostData body, ExplainRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///POST on /_field_caps
///An index filter specified with the Query DSL
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse FieldCapabilities(PostData body, FieldCapabilitiesRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///POST on /_field_caps
///An index filter specified with the Query DSL
///Request specific configuration such as querystring parameters & request specific connection settings.
Task FieldCapabilitiesAsync(PostData body, FieldCapabilitiesRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///POST on /{index}/_field_caps
///A comma-separated list of index names; use the special string `_all` or Indices.All to perform the operation on all indices
///An index filter specified with the Query DSL
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse FieldCapabilities(string index, PostData body, FieldCapabilitiesRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///POST on /{index}/_field_caps
///A comma-separated list of index names; use the special string `_all` or Indices.All to perform the operation on all indices
///An index filter specified with the Query DSL
///Request specific configuration such as querystring parameters & request specific connection settings.
Task FieldCapabilitiesAsync(string index, PostData body, FieldCapabilitiesRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///GET on /{index}/_doc/{id} https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/
///The name of the index
///The document ID
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse Get(string index, string id, GetRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///GET on /{index}/_doc/{id} https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/
///The name of the index
///The document ID
///Request specific configuration such as querystring parameters & request specific connection settings.
Task GetAsync(string index, string id, GetRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///GET on /_scripts/{id}
///Script ID
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse GetScript(string id, GetScriptRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///GET on /_scripts/{id}
///Script ID
///Request specific configuration such as querystring parameters & request specific connection settings.
Task GetScriptAsync(string id, GetScriptRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///GET on /_script_context
///Request specific configuration such as querystring parameters & request specific connection settings.
///Note: Experimental within the OpenSearch server, this functionality is Experimental and may be changed or removed completely in a future release. OpenSearch will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features. This functionality is subject to potential breaking changes within a minor version, meaning that your referencing code may break when this library is upgraded.
TResponse GetScriptContext(GetScriptContextRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///GET on /_script_context
///Request specific configuration such as querystring parameters & request specific connection settings.
///Note: Experimental within the OpenSearch server, this functionality is Experimental and may be changed or removed completely in a future release. OpenSearch will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features. This functionality is subject to potential breaking changes within a minor version, meaning that your referencing code may break when this library is upgraded.
Task GetScriptContextAsync(GetScriptContextRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///GET on /_script_language
///Request specific configuration such as querystring parameters & request specific connection settings.
///Note: Experimental within the OpenSearch server, this functionality is Experimental and may be changed or removed completely in a future release. OpenSearch will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features. This functionality is subject to potential breaking changes within a minor version, meaning that your referencing code may break when this library is upgraded.
TResponse GetScriptLanguages(GetScriptLanguagesRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///GET on /_script_language
///Request specific configuration such as querystring parameters & request specific connection settings.
///Note: Experimental within the OpenSearch server, this functionality is Experimental and may be changed or removed completely in a future release. OpenSearch will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features. This functionality is subject to potential breaking changes within a minor version, meaning that your referencing code may break when this library is upgraded.
Task GetScriptLanguagesAsync(GetScriptLanguagesRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///GET on /{index}/_source/{id} https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/
///The name of the index
///The document ID
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse Source(string index, string id, SourceRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///GET on /{index}/_source/{id} https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/get-documents/
///The name of the index
///The document ID
///Request specific configuration such as querystring parameters & request specific connection settings.
Task SourceAsync(string index, string id, SourceRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///PUT on /{index}/_doc/{id} https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/index-document/
///The name of the index
///Document ID
///The document
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse Index(string index, string id, PostData body, IndexRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///PUT on /{index}/_doc/{id} https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/index-document/
///The name of the index
///Document ID
///The document
///Request specific configuration such as querystring parameters & request specific connection settings.
Task IndexAsync(string index, string id, PostData body, IndexRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///POST on /{index}/_doc https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/index-document/
///The name of the index
///The document
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse Index(string index, PostData body, IndexRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///POST on /{index}/_doc https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/index-document/
///The name of the index
///The document
///Request specific configuration such as querystring parameters & request specific connection settings.
Task IndexAsync(string index, PostData body, IndexRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///GET on / https://opensearch.org/docs/latest/opensearch/index/
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse RootNodeInfo(RootNodeInfoRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///GET on / https://opensearch.org/docs/latest/opensearch/index/
///Request specific configuration such as querystring parameters & request specific connection settings.
Task RootNodeInfoAsync(RootNodeInfoRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///POST on /_mget https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/multi-get/
///Document identifiers; can be either `docs` (containing full document information) or `ids` (when index and type is provided in the URL.
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse MultiGet(PostData body, MultiGetRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///POST on /_mget https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/multi-get/
///Document identifiers; can be either `docs` (containing full document information) or `ids` (when index and type is provided in the URL.
///Request specific configuration such as querystring parameters & request specific connection settings.
Task MultiGetAsync(PostData body, MultiGetRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///POST on /{index}/_mget https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/multi-get/
///The name of the index
///Document identifiers; can be either `docs` (containing full document information) or `ids` (when index and type is provided in the URL.
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse MultiGet(string index, PostData body, MultiGetRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///POST on /{index}/_mget https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/multi-get/
///The name of the index
///Document identifiers; can be either `docs` (containing full document information) or `ids` (when index and type is provided in the URL.
///Request specific configuration such as querystring parameters & request specific connection settings.
Task MultiGetAsync(string index, PostData body, MultiGetRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///POST on /_msearch https://opensearch.org/docs/latest/opensearch/rest-api/multi-search/
///The request definitions (metadata-search request definition pairs), separated by newlines
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse MultiSearch(PostData body, MultiSearchRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///POST on /_msearch https://opensearch.org/docs/latest/opensearch/rest-api/multi-search/
///The request definitions (metadata-search request definition pairs), separated by newlines
///Request specific configuration such as querystring parameters & request specific connection settings.
Task MultiSearchAsync(PostData body, MultiSearchRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///POST on /{index}/_msearch https://opensearch.org/docs/latest/opensearch/rest-api/multi-search/
///A comma-separated list of index names to use as default
///The request definitions (metadata-search request definition pairs), separated by newlines
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse MultiSearch(string index, PostData body, MultiSearchRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///POST on /{index}/_msearch https://opensearch.org/docs/latest/opensearch/rest-api/multi-search/
///A comma-separated list of index names to use as default
///The request definitions (metadata-search request definition pairs), separated by newlines
///Request specific configuration such as querystring parameters & request specific connection settings.
Task MultiSearchAsync(string index, PostData body, MultiSearchRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///POST on /_msearch/template https://opensearch.org/docs/latest/opensearch/rest-api/multi-search/
///The request definitions (metadata-search request definition pairs), separated by newlines
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse MultiSearchTemplate(PostData body, MultiSearchTemplateRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///POST on /_msearch/template https://opensearch.org/docs/latest/opensearch/rest-api/multi-search/
///The request definitions (metadata-search request definition pairs), separated by newlines
///Request specific configuration such as querystring parameters & request specific connection settings.
Task MultiSearchTemplateAsync(PostData body, MultiSearchTemplateRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///POST on /{index}/_msearch/template https://opensearch.org/docs/latest/opensearch/rest-api/multi-search/
///A comma-separated list of index names to use as default
///The request definitions (metadata-search request definition pairs), separated by newlines
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse MultiSearchTemplate(string index, PostData body, MultiSearchTemplateRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///POST on /{index}/_msearch/template https://opensearch.org/docs/latest/opensearch/rest-api/multi-search/
///A comma-separated list of index names to use as default
///The request definitions (metadata-search request definition pairs), separated by newlines
///Request specific configuration such as querystring parameters & request specific connection settings.
Task MultiSearchTemplateAsync(string index, PostData body, MultiSearchTemplateRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///POST on /_mtermvectors
///Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation.
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse MultiTermVectors(PostData body, MultiTermVectorsRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///POST on /_mtermvectors
///Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation.
///Request specific configuration such as querystring parameters & request specific connection settings.
Task MultiTermVectorsAsync(PostData body, MultiTermVectorsRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///POST on /{index}/_mtermvectors
///The index in which the document resides.
///Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation.
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse MultiTermVectors(string index, PostData body, MultiTermVectorsRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///POST on /{index}/_mtermvectors
///The index in which the document resides.
///Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation.
///Request specific configuration such as querystring parameters & request specific connection settings.
Task MultiTermVectorsAsync(string index, PostData body, MultiTermVectorsRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///HEAD on / https://opensearch.org/docs/latest/opensearch/index/
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse Ping(PingRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///HEAD on / https://opensearch.org/docs/latest/opensearch/index/
///Request specific configuration such as querystring parameters & request specific connection settings.
Task PingAsync(PingRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///PUT on /_scripts/{id}
///Script ID
///The document
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse PutScript(string id, PostData body, PutScriptRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///PUT on /_scripts/{id}
///Script ID
///The document
///Request specific configuration such as querystring parameters & request specific connection settings.
Task PutScriptAsync(string id, PostData body, PutScriptRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///PUT on /_scripts/{id}/{context}
///Script ID
///Script context
///The document
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse PutScript(string id, string context, PostData body, PutScriptRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///PUT on /_scripts/{id}/{context}
///Script ID
///Script context
///The document
///Request specific configuration such as querystring parameters & request specific connection settings.
Task PutScriptAsync(string id, string context, PostData body, PutScriptRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///POST on /_rank_eval
///The ranking evaluation search definition, including search requests, document ratings and ranking metric definition.
///Request specific configuration such as querystring parameters & request specific connection settings.
///Note: Experimental within the OpenSearch server, this functionality is Experimental and may be changed or removed completely in a future release. OpenSearch will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features. This functionality is subject to potential breaking changes within a minor version, meaning that your referencing code may break when this library is upgraded.
TResponse RankEval(PostData body, RankEvalRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///POST on /_rank_eval
///The ranking evaluation search definition, including search requests, document ratings and ranking metric definition.
///Request specific configuration such as querystring parameters & request specific connection settings.
///Note: Experimental within the OpenSearch server, this functionality is Experimental and may be changed or removed completely in a future release. OpenSearch will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features. This functionality is subject to potential breaking changes within a minor version, meaning that your referencing code may break when this library is upgraded.
Task RankEvalAsync(PostData body, RankEvalRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///POST on /{index}/_rank_eval
///A comma-separated list of index names to search; use the special string `_all` or Indices.All to perform the operation on all indices
///The ranking evaluation search definition, including search requests, document ratings and ranking metric definition.
///Request specific configuration such as querystring parameters & request specific connection settings.
///Note: Experimental within the OpenSearch server, this functionality is Experimental and may be changed or removed completely in a future release. OpenSearch will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features. This functionality is subject to potential breaking changes within a minor version, meaning that your referencing code may break when this library is upgraded.
TResponse RankEval(string index, PostData body, RankEvalRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///POST on /{index}/_rank_eval
///A comma-separated list of index names to search; use the special string `_all` or Indices.All to perform the operation on all indices
///The ranking evaluation search definition, including search requests, document ratings and ranking metric definition.
///Request specific configuration such as querystring parameters & request specific connection settings.
///Note: Experimental within the OpenSearch server, this functionality is Experimental and may be changed or removed completely in a future release. OpenSearch will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features. This functionality is subject to potential breaking changes within a minor version, meaning that your referencing code may break when this library is upgraded.
Task RankEvalAsync(string index, PostData body, RankEvalRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///POST on /_reindex https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/reindex/
///The search definition using the Query DSL and the prototype for the index request.
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse ReindexOnServer(PostData body, ReindexOnServerRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///POST on /_reindex https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/reindex/
///The search definition using the Query DSL and the prototype for the index request.
///Request specific configuration such as querystring parameters & request specific connection settings.
Task ReindexOnServerAsync(PostData body, ReindexOnServerRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///POST on /_reindex/{task_id}/_rethrottle https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/reindex/
///The task id to rethrottle
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse ReindexRethrottle(string taskId, ReindexRethrottleRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///POST on /_reindex/{task_id}/_rethrottle https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/reindex/
///The task id to rethrottle
///Request specific configuration such as querystring parameters & request specific connection settings.
Task ReindexRethrottleAsync(string taskId, ReindexRethrottleRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///POST on /_render/template https://opensearch.org/docs/latest/opensearch/search-template/
///The search definition template and its params
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse RenderSearchTemplate(PostData body, RenderSearchTemplateRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///POST on /_render/template https://opensearch.org/docs/latest/opensearch/search-template/
///The search definition template and its params
///Request specific configuration such as querystring parameters & request specific connection settings.
Task RenderSearchTemplateAsync(PostData body, RenderSearchTemplateRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///POST on /_render/template/{id} https://opensearch.org/docs/latest/opensearch/search-template/
///The id of the stored search template
///The search definition template and its params
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse RenderSearchTemplate(string id, PostData body, RenderSearchTemplateRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///POST on /_render/template/{id} https://opensearch.org/docs/latest/opensearch/search-template/
///The id of the stored search template
///The search definition template and its params
///Request specific configuration such as querystring parameters & request specific connection settings.
Task RenderSearchTemplateAsync(string id, PostData body, RenderSearchTemplateRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///POST on /_scripts/painless/_execute
///The script to execute
///Request specific configuration such as querystring parameters & request specific connection settings.
///Note: Experimental within the OpenSearch server, this functionality is Experimental and may be changed or removed completely in a future release. OpenSearch will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features. This functionality is subject to potential breaking changes within a minor version, meaning that your referencing code may break when this library is upgraded.
TResponse ExecutePainlessScript(PostData body, ExecutePainlessScriptRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///POST on /_scripts/painless/_execute
///The script to execute
///Request specific configuration such as querystring parameters & request specific connection settings.
///Note: Experimental within the OpenSearch server, this functionality is Experimental and may be changed or removed completely in a future release. OpenSearch will take a best effort approach to fix any issues, but experimental features are not subject to the support SLA of official GA features. This functionality is subject to potential breaking changes within a minor version, meaning that your referencing code may break when this library is upgraded.
Task ExecutePainlessScriptAsync(PostData body, ExecutePainlessScriptRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///POST on /_search/scroll https://opensearch.org/docs/latest/opensearch/rest-api/search/#request-body
///The scroll ID if not passed by URL or query parameter.
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse Scroll(PostData body, ScrollRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///POST on /_search/scroll https://opensearch.org/docs/latest/opensearch/rest-api/search/#request-body
///The scroll ID if not passed by URL or query parameter.
///Request specific configuration such as querystring parameters & request specific connection settings.
Task ScrollAsync(PostData body, ScrollRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///POST on /_search https://opensearch.org/docs/latest/opensearch/rest-api/search/
///The search definition using the Query DSL
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse Search(PostData body, SearchRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///POST on /_search https://opensearch.org/docs/latest/opensearch/rest-api/search/
///The search definition using the Query DSL
///Request specific configuration such as querystring parameters & request specific connection settings.
Task SearchAsync(PostData body, SearchRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///POST on /{index}/_search https://opensearch.org/docs/latest/opensearch/rest-api/search/
///A comma-separated list of index names to search; use the special string `_all` or Indices.All to perform the operation on all indices
///The search definition using the Query DSL
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse Search(string index, PostData body, SearchRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///POST on /{index}/_search https://opensearch.org/docs/latest/opensearch/rest-api/search/
///A comma-separated list of index names to search; use the special string `_all` or Indices.All to perform the operation on all indices
///The search definition using the Query DSL
///Request specific configuration such as querystring parameters & request specific connection settings.
Task SearchAsync(string index, PostData body, SearchRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///POST on /_search_shards https://opensearch.org/docs/latest/security-plugin/access-control/cross-cluster-search/
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse SearchShards(SearchShardsRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///POST on /_search_shards https://opensearch.org/docs/latest/security-plugin/access-control/cross-cluster-search/
///Request specific configuration such as querystring parameters & request specific connection settings.
Task SearchShardsAsync(SearchShardsRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///POST on /{index}/_search_shards https://opensearch.org/docs/latest/security-plugin/access-control/cross-cluster-search/
///A comma-separated list of index names to search; use the special string `_all` or Indices.All to perform the operation on all indices
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse SearchShards(string index, SearchShardsRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///POST on /{index}/_search_shards https://opensearch.org/docs/latest/security-plugin/access-control/cross-cluster-search/
///A comma-separated list of index names to search; use the special string `_all` or Indices.All to perform the operation on all indices
///Request specific configuration such as querystring parameters & request specific connection settings.
Task SearchShardsAsync(string index, SearchShardsRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///POST on /_search/template https://opensearch.org/docs/latest/opensearch/search-template/
///The search definition template and its params
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse SearchTemplate(PostData body, SearchTemplateRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///POST on /_search/template https://opensearch.org/docs/latest/opensearch/search-template/
///The search definition template and its params
///Request specific configuration such as querystring parameters & request specific connection settings.
Task SearchTemplateAsync(PostData body, SearchTemplateRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///POST on /{index}/_search/template https://opensearch.org/docs/latest/opensearch/search-template/
///A comma-separated list of index names to search; use the special string `_all` or Indices.All to perform the operation on all indices
///The search definition template and its params
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse SearchTemplate(string index, PostData body, SearchTemplateRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///POST on /{index}/_search/template https://opensearch.org/docs/latest/opensearch/search-template/
///A comma-separated list of index names to search; use the special string `_all` or Indices.All to perform the operation on all indices
///The search definition template and its params
///Request specific configuration such as querystring parameters & request specific connection settings.
Task SearchTemplateAsync(string index, PostData body, SearchTemplateRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///POST on /{index}/_termvectors/{id}
///The index in which the document resides.
///The id of the document, when not specified a doc param should be supplied.
///Define parameters and or supply a document to get termvectors for. See documentation.
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse TermVectors(string index, string id, PostData body, TermVectorsRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///POST on /{index}/_termvectors/{id}
///The index in which the document resides.
///The id of the document, when not specified a doc param should be supplied.
///Define parameters and or supply a document to get termvectors for. See documentation.
///Request specific configuration such as querystring parameters & request specific connection settings.
Task TermVectorsAsync(string index, string id, PostData body, TermVectorsRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///POST on /{index}/_termvectors
///The index in which the document resides.
///Define parameters and or supply a document to get termvectors for. See documentation.
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse TermVectors(string index, PostData body, TermVectorsRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///POST on /{index}/_termvectors
///The index in which the document resides.
///Define parameters and or supply a document to get termvectors for. See documentation.
///Request specific configuration such as querystring parameters & request specific connection settings.
Task TermVectorsAsync(string index, PostData body, TermVectorsRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///POST on /{index}/_update/{id} https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/update-document/
///The name of the index
///Document ID
///The request definition requires either `script` or partial `doc`
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse Update(string index, string id, PostData body, UpdateRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///POST on /{index}/_update/{id} https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/update-document/
///The name of the index
///Document ID
///The request definition requires either `script` or partial `doc`
///Request specific configuration such as querystring parameters & request specific connection settings.
Task UpdateAsync(string index, string id, PostData body, UpdateRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///POST on /{index}/_update_by_query https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/update-by-query/
///A comma-separated list of index names to search; use the special string `_all` or Indices.All to perform the operation on all indices
///The search definition using the Query DSL
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse UpdateByQuery(string index, PostData body, UpdateByQueryRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///POST on /{index}/_update_by_query https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/update-by-query/
///A comma-separated list of index names to search; use the special string `_all` or Indices.All to perform the operation on all indices
///The search definition using the Query DSL
///Request specific configuration such as querystring parameters & request specific connection settings.
Task UpdateByQueryAsync(string index, PostData body, UpdateByQueryRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///POST on /_update_by_query/{task_id}/_rethrottle https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/update-by-query/
///The task id to rethrottle
///Request specific configuration such as querystring parameters & request specific connection settings.
TResponse UpdateByQueryRethrottle(string taskId, UpdateByQueryRethrottleRequestParameters requestParameters = null)
where TResponse : class, IOpenSearchResponse, new();
///POST on /_update_by_query/{task_id}/_rethrottle https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/update-by-query/
///The task id to rethrottle
///Request specific configuration such as querystring parameters & request specific connection settings.
Task UpdateByQueryRethrottleAsync(string taskId, UpdateByQueryRethrottleRequestParameters requestParameters = null, CancellationToken ctx = default)
where TResponse : class, IOpenSearchResponse, new();
///Snapshot APIs
LowLevelSnapshotNamespace Snapshot
{
get;
}
///Tasks APIs
LowLevelTasksNamespace Tasks
{
get;
}
}
}