/* 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.Linq;
using System.Text;
using System.Linq.Expressions;
using OpenSearch.Net;
using OpenSearch.Net.Utf8Json;
using OpenSearch.Net.Specification.CatApi;
// ReSharper disable RedundantBaseConstructorCall
// ReSharper disable UnusedTypeParameter
// ReSharper disable PartialMethodWithSinglePart
// ReSharper disable RedundantNameQualifier
namespace OpenSearch.Client.Specification.CatApi
{
///Descriptor for Aliases https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-aliases/
public partial class CatAliasesDescriptor : RequestDescriptorBase, ICatAliasesRequest
{
internal override ApiUrls ApiUrls => ApiUrlsLookups.CatAliases;
////_cat/aliases
public CatAliasesDescriptor(): base()
{
}
////_cat/aliases/{name}
///Optional, accepts null
public CatAliasesDescriptor(Names name): base(r => r.Optional("name", name))
{
}
// values part of the url path
Names ICatAliasesRequest.Name => Self.RouteValues.Get("name");
///A comma-separated list of alias names to return
public CatAliasesDescriptor Name(Names name) => Assign(name, (a, v) => a.RouteValues.Optional("name", v));
// Request parameters
///Whether to expand wildcard expression to concrete indices that are open, closed or both.
public CatAliasesDescriptor ExpandWildcards(ExpandWildcards? expandwildcards) => Qs("expand_wildcards", expandwildcards);
///a short version of the Accept header, e.g. json, yaml
public CatAliasesDescriptor Format(string format) => Qs("format", format);
///Comma-separated list of column names to display
public CatAliasesDescriptor Headers(params string[] headers) => Qs("h", headers);
///Return help information
public CatAliasesDescriptor Help(bool? help = true) => Qs("help", help);
///Return local information, do not retrieve the state from cluster_manager node (default: false)
public CatAliasesDescriptor Local(bool? local = true) => Qs("local", local);
///Comma-separated list of column names or column aliases to sort by
public CatAliasesDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns);
///Verbose mode. Display column headers
public CatAliasesDescriptor Verbose(bool? verbose = true) => Qs("v", verbose);
}
///Descriptor for Allocation https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-allocation/
public partial class CatAllocationDescriptor : RequestDescriptorBase, ICatAllocationRequest
{
internal override ApiUrls ApiUrls => ApiUrlsLookups.CatAllocation;
////_cat/allocation
public CatAllocationDescriptor(): base()
{
}
////_cat/allocation/{node_id}
///Optional, accepts null
public CatAllocationDescriptor(NodeIds nodeId): base(r => r.Optional("node_id", nodeId))
{
}
// values part of the url path
NodeIds ICatAllocationRequest.NodeId => Self.RouteValues.Get("node_id");
///A comma-separated list of node IDs or names to limit the returned information
public CatAllocationDescriptor NodeId(NodeIds nodeId) => Assign(nodeId, (a, v) => a.RouteValues.Optional("node_id", v));
// Request parameters
///The unit in which to display byte values
public CatAllocationDescriptor Bytes(Bytes? bytes) => Qs("bytes", bytes);
///a short version of the Accept header, e.g. json, yaml
public CatAllocationDescriptor Format(string format) => Qs("format", format);
///Comma-separated list of column names to display
public CatAllocationDescriptor Headers(params string[] headers) => Qs("h", headers);
///Return help information
public CatAllocationDescriptor Help(bool? help = true) => Qs("help", help);
///Return local information, do not retrieve the state from cluster_manager node (default: false)
public CatAllocationDescriptor Local(bool? local = true) => Qs("local", local);
///Explicit operation timeout for connection to master node
///Deprecated as of OpenSearch 2.0, use instead
public CatAllocationDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout);
///Explicit operation timeout for connection to cluster_manager node
///Introduced in OpenSearch 2.0 instead of
public CatAllocationDescriptor ClusterManagerTimeout(Time timeout) => Qs("cluster_manager_timeout", timeout);
///Comma-separated list of column names or column aliases to sort by
public CatAllocationDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns);
///Verbose mode. Display column headers
public CatAllocationDescriptor Verbose(bool? verbose = true) => Qs("v", verbose);
}
///Descriptor for Count https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-count/
public partial class CatCountDescriptor : RequestDescriptorBase, ICatCountRequest
{
internal override ApiUrls ApiUrls => ApiUrlsLookups.CatCount;
////_cat/count
public CatCountDescriptor(): base()
{
}
////_cat/count/{index}
///Optional, accepts null
public CatCountDescriptor(Indices index): base(r => r.Optional("index", index))
{
}
// values part of the url path
Indices ICatCountRequest.Index => Self.RouteValues.Get("index");
///A comma-separated list of index names to limit the returned information
public CatCountDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v));
///a shortcut into calling Index(typeof(TOther))
public CatCountDescriptor Index()
where TOther : class => Assign(typeof(TOther), (a, v) => a.RouteValues.Optional("index", (Indices)v));
///A shortcut into calling Index(Indices.All)
public CatCountDescriptor AllIndices() => Index(Indices.All);
// Request parameters
///a short version of the Accept header, e.g. json, yaml
public CatCountDescriptor Format(string format) => Qs("format", format);
///Comma-separated list of column names to display
public CatCountDescriptor Headers(params string[] headers) => Qs("h", headers);
///Return help information
public CatCountDescriptor Help(bool? help = true) => Qs("help", help);
///Comma-separated list of column names or column aliases to sort by
public CatCountDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns);
///Verbose mode. Display column headers
public CatCountDescriptor Verbose(bool? verbose = true) => Qs("v", verbose);
}
///Descriptor for Fielddata https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-field-data/
public partial class CatFielddataDescriptor : RequestDescriptorBase, ICatFielddataRequest
{
internal override ApiUrls ApiUrls => ApiUrlsLookups.CatFielddata;
////_cat/fielddata
public CatFielddataDescriptor(): base()
{
}
////_cat/fielddata/{fields}
///Optional, accepts null
public CatFielddataDescriptor(Fields fields): base(r => r.Optional("fields", fields))
{
}
// values part of the url path
Fields ICatFielddataRequest.Fields => Self.RouteValues.Get("fields");
///A comma-separated list of fields to return the fielddata size
public CatFielddataDescriptor Fields(Fields fields) => Assign(fields, (a, v) => a.RouteValues.Optional("fields", v));
///A comma-separated list of fields to return the fielddata size
public CatFielddataDescriptor Fields(params Expression>[] fields) => Assign(fields, (a, v) => a.RouteValues.Optional("fields", (Fields)v));
// Request parameters
///The unit in which to display byte values
public CatFielddataDescriptor Bytes(Bytes? bytes) => Qs("bytes", bytes);
///a short version of the Accept header, e.g. json, yaml
public CatFielddataDescriptor Format(string format) => Qs("format", format);
///Comma-separated list of column names to display
public CatFielddataDescriptor Headers(params string[] headers) => Qs("h", headers);
///Return help information
public CatFielddataDescriptor Help(bool? help = true) => Qs("help", help);
///Comma-separated list of column names or column aliases to sort by
public CatFielddataDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns);
///Verbose mode. Display column headers
public CatFielddataDescriptor Verbose(bool? verbose = true) => Qs("v", verbose);
}
///Descriptor for Health https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-health/
public partial class CatHealthDescriptor : RequestDescriptorBase, ICatHealthRequest
{
internal override ApiUrls ApiUrls => ApiUrlsLookups.CatHealth;
// values part of the url path
// Request parameters
///a short version of the Accept header, e.g. json, yaml
public CatHealthDescriptor Format(string format) => Qs("format", format);
///Comma-separated list of column names to display
public CatHealthDescriptor Headers(params string[] headers) => Qs("h", headers);
///Return help information
public CatHealthDescriptor Help(bool? help = true) => Qs("help", help);
///Set to false to disable timestamping
public CatHealthDescriptor IncludeTimestamp(bool? includetimestamp = true) => Qs("ts", includetimestamp);
///Comma-separated list of column names or column aliases to sort by
public CatHealthDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns);
///Verbose mode. Display column headers
public CatHealthDescriptor Verbose(bool? verbose = true) => Qs("v", verbose);
}
///Descriptor for Help https://opensearch.org/docs/latest/opensearch/rest-api/cat/index/
public partial class CatHelpDescriptor : RequestDescriptorBase, ICatHelpRequest
{
internal override ApiUrls ApiUrls => ApiUrlsLookups.CatHelp;
// values part of the url path
// Request parameters
///Return help information
public CatHelpDescriptor Help(bool? help = true) => Qs("help", help);
///Comma-separated list of column names or column aliases to sort by
public CatHelpDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns);
}
///Descriptor for Indices https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-indices/
public partial class CatIndicesDescriptor : RequestDescriptorBase, ICatIndicesRequest
{
internal override ApiUrls ApiUrls => ApiUrlsLookups.CatIndices;
////_cat/indices
public CatIndicesDescriptor(): base()
{
}
////_cat/indices/{index}
///Optional, accepts null
public CatIndicesDescriptor(Indices index): base(r => r.Optional("index", index))
{
}
// values part of the url path
Indices ICatIndicesRequest.Index => Self.RouteValues.Get("index");
///A comma-separated list of index names to limit the returned information
public CatIndicesDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v));
///a shortcut into calling Index(typeof(TOther))
public CatIndicesDescriptor Index()
where TOther : class => Assign(typeof(TOther), (a, v) => a.RouteValues.Optional("index", (Indices)v));
///A shortcut into calling Index(Indices.All)
public CatIndicesDescriptor AllIndices() => Index(Indices.All);
// Request parameters
///The unit in which to display byte values
public CatIndicesDescriptor Bytes(Bytes? bytes) => Qs("bytes", bytes);
///Whether to expand wildcard expression to concrete indices that are open, closed or both.
public CatIndicesDescriptor ExpandWildcards(ExpandWildcards? expandwildcards) => Qs("expand_wildcards", expandwildcards);
///a short version of the Accept header, e.g. json, yaml
public CatIndicesDescriptor Format(string format) => Qs("format", format);
///Comma-separated list of column names to display
public CatIndicesDescriptor Headers(params string[] headers) => Qs("h", headers);
///A health status ("green", "yellow", or "red" to filter only indices matching the specified health status
public CatIndicesDescriptor Health(Health? health) => Qs("health", health);
///Return help information
public CatIndicesDescriptor Help(bool? help = true) => Qs("help", help);
///If set to true segment stats will include stats for segments that are not currently loaded into memory
public CatIndicesDescriptor IncludeUnloadedSegments(bool? includeunloadedsegments = true) => Qs("include_unloaded_segments", includeunloadedsegments);
///Return local information, do not retrieve the state from cluster_manager node (default: false)
public CatIndicesDescriptor Local(bool? local = true) => Qs("local", local);
///Explicit operation timeout for connection to master node
///Deprecated as of OpenSearch 2.0, use instead
public CatIndicesDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout);
///Explicit operation timeout for connection to cluster_manager node
///Introduced in OpenSearch 2.0 instead of
public CatIndicesDescriptor ClusterManagerTimeout(Time timeout) => Qs("cluster_manager_timeout", timeout);
///Set to true to return stats only for primary shards
public CatIndicesDescriptor Pri(bool? pri = true) => Qs("pri", pri);
///Comma-separated list of column names or column aliases to sort by
public CatIndicesDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns);
///Verbose mode. Display column headers
public CatIndicesDescriptor Verbose(bool? verbose = true) => Qs("v", verbose);
}
///Descriptor for Master https://opensearch.org/docs/1.2/opensearch/rest-api/cat/cat-master/
///Deprecated as of OpenSearch 2.0, use instead
public partial class CatMasterDescriptor : RequestDescriptorBase, ICatMasterRequest
{
internal override ApiUrls ApiUrls => ApiUrlsLookups.CatMaster;
// values part of the url path
// Request parameters
///a short version of the Accept header, e.g. json, yaml
public CatMasterDescriptor Format(string format) => Qs("format", format);
///Comma-separated list of column names to display
public CatMasterDescriptor Headers(params string[] headers) => Qs("h", headers);
///Return help information
public CatMasterDescriptor Help(bool? help = true) => Qs("help", help);
///Return local information, do not retrieve the state from cluster_manager node (default: false)
public CatMasterDescriptor Local(bool? local = true) => Qs("local", local);
///Explicit operation timeout for connection to master node
public CatMasterDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout);
///Comma-separated list of column names or column aliases to sort by
public CatMasterDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns);
///Verbose mode. Display column headers
public CatMasterDescriptor Verbose(bool? verbose = true) => Qs("v", verbose);
}
///Descriptor for Master https://opensearch.org/docs/1.2/opensearch/rest-api/cat/cat-master/
///Introduced in OpenSearch 2.0 instead of
public partial class CatClusterManagerDescriptor : RequestDescriptorBase, ICatClusterManagerRequest
{
internal override ApiUrls ApiUrls => ApiUrlsLookups.CatClusterManager;
// values part of the url path
// Request parameters
///a short version of the Accept header, e.g. json, yaml
public CatClusterManagerDescriptor Format(string format) => Qs("format", format);
///Comma-separated list of column names to display
public CatClusterManagerDescriptor Headers(params string[] headers) => Qs("h", headers);
///Return help information
public CatClusterManagerDescriptor Help(bool? help = true) => Qs("help", help);
///Return local information, do not retrieve the state from cluster_manager node (default: false)
public CatClusterManagerDescriptor Local(bool? local = true) => Qs("local", local);
///Explicit operation timeout for connection to cluster_manager node
public CatClusterManagerDescriptor ClusterManagerTimeout(Time timeout) => Qs("cluster_manager_timeout", timeout);
///Comma-separated list of column names or column aliases to sort by
public CatClusterManagerDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns);
///Verbose mode. Display column headers
public CatClusterManagerDescriptor Verbose(bool? verbose = true) => Qs("v", verbose);
}
///Descriptor for NodeAttributes https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-nodeattrs/
public partial class CatNodeAttributesDescriptor : RequestDescriptorBase, ICatNodeAttributesRequest
{
internal override ApiUrls ApiUrls => ApiUrlsLookups.CatNodeAttributes;
// values part of the url path
// Request parameters
///a short version of the Accept header, e.g. json, yaml
public CatNodeAttributesDescriptor Format(string format) => Qs("format", format);
///Comma-separated list of column names to display
public CatNodeAttributesDescriptor Headers(params string[] headers) => Qs("h", headers);
///Return help information
public CatNodeAttributesDescriptor Help(bool? help = true) => Qs("help", help);
///Return local information, do not retrieve the state from cluster_manager node (default: false)
public CatNodeAttributesDescriptor Local(bool? local = true) => Qs("local", local);
///Explicit operation timeout for connection to master node
///Deprecated as of OpenSearch 2.0, use instead
public CatNodeAttributesDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout);
///Explicit operation timeout for connection to cluster_manager node
///Introduced in OpenSearch 2.0 instead of
public CatNodeAttributesDescriptor ClusterManagerTimeout(Time timeout) => Qs("cluster_manager_timeout", timeout);
///Comma-separated list of column names or column aliases to sort by
public CatNodeAttributesDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns);
///Verbose mode. Display column headers
public CatNodeAttributesDescriptor Verbose(bool? verbose = true) => Qs("v", verbose);
}
///Descriptor for Nodes https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-nodes/
public partial class CatNodesDescriptor : RequestDescriptorBase, ICatNodesRequest
{
internal override ApiUrls ApiUrls => ApiUrlsLookups.CatNodes;
// values part of the url path
// Request parameters
///The unit in which to display byte values
public CatNodesDescriptor Bytes(Bytes? bytes) => Qs("bytes", bytes);
///a short version of the Accept header, e.g. json, yaml
public CatNodesDescriptor Format(string format) => Qs("format", format);
///Return the full node ID instead of the shortened version (default: false)
public CatNodesDescriptor FullId(bool? fullid = true) => Qs("full_id", fullid);
///Comma-separated list of column names to display
public CatNodesDescriptor Headers(params string[] headers) => Qs("h", headers);
///Return help information
public CatNodesDescriptor Help(bool? help = true) => Qs("help", help);
///Explicit operation timeout for connection to master node
///Deprecated as of OpenSearch 2.0, use instead
public CatNodesDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout);
///Explicit operation timeout for connection to cluster_manager node
///Introduced in OpenSearch 2.0 instead of
public CatNodesDescriptor ClusterManagerTimeout(Time timeout) => Qs("cluster_manager_timeout", timeout);
///Comma-separated list of column names or column aliases to sort by
public CatNodesDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns);
///Verbose mode. Display column headers
public CatNodesDescriptor Verbose(bool? verbose = true) => Qs("v", verbose);
}
///Descriptor for PendingTasks https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-pending-tasks/
public partial class CatPendingTasksDescriptor : RequestDescriptorBase, ICatPendingTasksRequest
{
internal override ApiUrls ApiUrls => ApiUrlsLookups.CatPendingTasks;
// values part of the url path
// Request parameters
///a short version of the Accept header, e.g. json, yaml
public CatPendingTasksDescriptor Format(string format) => Qs("format", format);
///Comma-separated list of column names to display
public CatPendingTasksDescriptor Headers(params string[] headers) => Qs("h", headers);
///Return help information
public CatPendingTasksDescriptor Help(bool? help = true) => Qs("help", help);
///Return local information, do not retrieve the state from cluster_manager node (default: false)
public CatPendingTasksDescriptor Local(bool? local = true) => Qs("local", local);
///Explicit operation timeout for connection to master node
///Deprecated as of OpenSearch 2.0, use instead
public CatPendingTasksDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout);
///Explicit operation timeout for connection to cluster_manager node
///Introduced in OpenSearch 2.0 instead of
public CatPendingTasksDescriptor ClusterManagerTimeout(Time timeout) => Qs("cluster_manager_timeout", timeout);
///Comma-separated list of column names or column aliases to sort by
public CatPendingTasksDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns);
///Verbose mode. Display column headers
public CatPendingTasksDescriptor Verbose(bool? verbose = true) => Qs("v", verbose);
}
///Descriptor for Plugins https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-plugins/
public partial class CatPluginsDescriptor : RequestDescriptorBase, ICatPluginsRequest
{
internal override ApiUrls ApiUrls => ApiUrlsLookups.CatPlugins;
// values part of the url path
// Request parameters
///a short version of the Accept header, e.g. json, yaml
public CatPluginsDescriptor Format(string format) => Qs("format", format);
///Comma-separated list of column names to display
public CatPluginsDescriptor Headers(params string[] headers) => Qs("h", headers);
///Return help information
public CatPluginsDescriptor Help(bool? help = true) => Qs("help", help);
///Include bootstrap plugins in the response
public CatPluginsDescriptor IncludeBootstrap(bool? includebootstrap = true) => Qs("include_bootstrap", includebootstrap);
///Return local information, do not retrieve the state from cluster_manager node (default: false)
public CatPluginsDescriptor Local(bool? local = true) => Qs("local", local);
///Explicit operation timeout for connection to master node
///Deprecated as of OpenSearch 2.0, use instead
public CatPluginsDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout);
///Explicit operation timeout for connection to cluster_manager node
///Introduced in OpenSearch 2.0 instead of
public CatPluginsDescriptor ClusterManagerTimeout(Time timeout) => Qs("cluster_manager_timeout", timeout);
///Comma-separated list of column names or column aliases to sort by
public CatPluginsDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns);
///Verbose mode. Display column headers
public CatPluginsDescriptor Verbose(bool? verbose = true) => Qs("v", verbose);
}
///Descriptor for Recovery https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-recovery/
public partial class CatRecoveryDescriptor : RequestDescriptorBase, ICatRecoveryRequest
{
internal override ApiUrls ApiUrls => ApiUrlsLookups.CatRecovery;
////_cat/recovery
public CatRecoveryDescriptor(): base()
{
}
////_cat/recovery/{index}
///Optional, accepts null
public CatRecoveryDescriptor(Indices index): base(r => r.Optional("index", index))
{
}
// values part of the url path
Indices ICatRecoveryRequest.Index => Self.RouteValues.Get("index");
///Comma-separated list or wildcard expression of index names to limit the returned information
public CatRecoveryDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v));
///a shortcut into calling Index(typeof(TOther))
public CatRecoveryDescriptor Index()
where TOther : class => Assign(typeof(TOther), (a, v) => a.RouteValues.Optional("index", (Indices)v));
///A shortcut into calling Index(Indices.All)
public CatRecoveryDescriptor AllIndices() => Index(Indices.All);
// Request parameters
///If `true`, the response only includes ongoing shard recoveries
public CatRecoveryDescriptor ActiveOnly(bool? activeonly = true) => Qs("active_only", activeonly);
///The unit in which to display byte values
public CatRecoveryDescriptor Bytes(Bytes? bytes) => Qs("bytes", bytes);
///If `true`, the response includes detailed information about shard recoveries
public CatRecoveryDescriptor Detailed(bool? detailed = true) => Qs("detailed", detailed);
///a short version of the Accept header, e.g. json, yaml
public CatRecoveryDescriptor Format(string format) => Qs("format", format);
///Comma-separated list of column names to display
public CatRecoveryDescriptor Headers(params string[] headers) => Qs("h", headers);
///Return help information
public CatRecoveryDescriptor Help(bool? help = true) => Qs("help", help);
///Comma-separated list of column names or column aliases to sort by
public CatRecoveryDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns);
///Verbose mode. Display column headers
public CatRecoveryDescriptor Verbose(bool? verbose = true) => Qs("v", verbose);
}
///Descriptor for Repositories https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-repositories/
public partial class CatRepositoriesDescriptor : RequestDescriptorBase, ICatRepositoriesRequest
{
internal override ApiUrls ApiUrls => ApiUrlsLookups.CatRepositories;
// values part of the url path
// Request parameters
///a short version of the Accept header, e.g. json, yaml
public CatRepositoriesDescriptor Format(string format) => Qs("format", format);
///Comma-separated list of column names to display
public CatRepositoriesDescriptor Headers(params string[] headers) => Qs("h", headers);
///Return help information
public CatRepositoriesDescriptor Help(bool? help = true) => Qs("help", help);
///Return local information, do not retrieve the state from cluster_manager node
public CatRepositoriesDescriptor Local(bool? local = true) => Qs("local", local);
///Explicit operation timeout for connection to master node
///Deprecated as of OpenSearch 2.0, use instead
public CatRepositoriesDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout);
///Explicit operation timeout for connection to cluster_manager node
///Introduced in OpenSearch 2.0 instead of
public CatRepositoriesDescriptor ClusterManagerTimeout(Time timeout) => Qs("cluster_manager_timeout", timeout);
///Comma-separated list of column names or column aliases to sort by
public CatRepositoriesDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns);
///Verbose mode. Display column headers
public CatRepositoriesDescriptor Verbose(bool? verbose = true) => Qs("v", verbose);
}
///Descriptor for Segments https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-segments/
public partial class CatSegmentsDescriptor : RequestDescriptorBase, ICatSegmentsRequest
{
internal override ApiUrls ApiUrls => ApiUrlsLookups.CatSegments;
////_cat/segments
public CatSegmentsDescriptor(): base()
{
}
////_cat/segments/{index}
///Optional, accepts null
public CatSegmentsDescriptor(Indices index): base(r => r.Optional("index", index))
{
}
// values part of the url path
Indices ICatSegmentsRequest.Index => Self.RouteValues.Get("index");
///A comma-separated list of index names to limit the returned information
public CatSegmentsDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v));
///a shortcut into calling Index(typeof(TOther))
public CatSegmentsDescriptor Index()
where TOther : class => Assign(typeof(TOther), (a, v) => a.RouteValues.Optional("index", (Indices)v));
///A shortcut into calling Index(Indices.All)
public CatSegmentsDescriptor AllIndices() => Index(Indices.All);
// Request parameters
///The unit in which to display byte values
public CatSegmentsDescriptor Bytes(Bytes? bytes) => Qs("bytes", bytes);
///a short version of the Accept header, e.g. json, yaml
public CatSegmentsDescriptor Format(string format) => Qs("format", format);
///Comma-separated list of column names to display
public CatSegmentsDescriptor Headers(params string[] headers) => Qs("h", headers);
///Return help information
public CatSegmentsDescriptor Help(bool? help = true) => Qs("help", help);
///Comma-separated list of column names or column aliases to sort by
public CatSegmentsDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns);
///Verbose mode. Display column headers
public CatSegmentsDescriptor Verbose(bool? verbose = true) => Qs("v", verbose);
}
///Descriptor for Shards https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-shards/
public partial class CatShardsDescriptor : RequestDescriptorBase, ICatShardsRequest
{
internal override ApiUrls ApiUrls => ApiUrlsLookups.CatShards;
////_cat/shards
public CatShardsDescriptor(): base()
{
}
////_cat/shards/{index}
///Optional, accepts null
public CatShardsDescriptor(Indices index): base(r => r.Optional("index", index))
{
}
// values part of the url path
Indices ICatShardsRequest.Index => Self.RouteValues.Get("index");
///A comma-separated list of index names to limit the returned information
public CatShardsDescriptor Index(Indices index) => Assign(index, (a, v) => a.RouteValues.Optional("index", v));
///a shortcut into calling Index(typeof(TOther))
public CatShardsDescriptor Index()
where TOther : class => Assign(typeof(TOther), (a, v) => a.RouteValues.Optional("index", (Indices)v));
///A shortcut into calling Index(Indices.All)
public CatShardsDescriptor AllIndices() => Index(Indices.All);
// Request parameters
///The unit in which to display byte values
public CatShardsDescriptor Bytes(Bytes? bytes) => Qs("bytes", bytes);
///a short version of the Accept header, e.g. json, yaml
public CatShardsDescriptor Format(string format) => Qs("format", format);
///Comma-separated list of column names to display
public CatShardsDescriptor Headers(params string[] headers) => Qs("h", headers);
///Return help information
public CatShardsDescriptor Help(bool? help = true) => Qs("help", help);
///Return local information, do not retrieve the state from cluster_manager node (default: false)
public CatShardsDescriptor Local(bool? local = true) => Qs("local", local);
///Explicit operation timeout for connection to master node
///Deprecated as of OpenSearch 2.0, use instead
public CatShardsDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout);
///Explicit operation timeout for connection to cluster_manager node
///Introduced in OpenSearch 2.0 instead of
public CatShardsDescriptor ClusterManagerTimeout(Time timeout) => Qs("cluster_manager_timeout", timeout);
///Comma-separated list of column names or column aliases to sort by
public CatShardsDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns);
///Verbose mode. Display column headers
public CatShardsDescriptor Verbose(bool? verbose = true) => Qs("v", verbose);
}
///Descriptor for Snapshots https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-snapshots/
public partial class CatSnapshotsDescriptor : RequestDescriptorBase, ICatSnapshotsRequest
{
internal override ApiUrls ApiUrls => ApiUrlsLookups.CatSnapshots;
////_cat/snapshots
public CatSnapshotsDescriptor(): base()
{
}
////_cat/snapshots/{repository}
///Optional, accepts null
public CatSnapshotsDescriptor(Names repository): base(r => r.Optional("repository", repository))
{
}
// values part of the url path
Names ICatSnapshotsRequest.RepositoryName => Self.RouteValues.Get("repository");
///Name of repository from which to fetch the snapshot information
public CatSnapshotsDescriptor RepositoryName(Names repository) => Assign(repository, (a, v) => a.RouteValues.Optional("repository", v));
// Request parameters
///a short version of the Accept header, e.g. json, yaml
public CatSnapshotsDescriptor Format(string format) => Qs("format", format);
///Comma-separated list of column names to display
public CatSnapshotsDescriptor Headers(params string[] headers) => Qs("h", headers);
///Return help information
public CatSnapshotsDescriptor Help(bool? help = true) => Qs("help", help);
///Set to true to ignore unavailable snapshots
public CatSnapshotsDescriptor IgnoreUnavailable(bool? ignoreunavailable = true) => Qs("ignore_unavailable", ignoreunavailable);
///Explicit operation timeout for connection to master node
///Deprecated as of OpenSearch 2.0, use instead
public CatSnapshotsDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout);
///Explicit operation timeout for connection to cluster_manager node
///Introduced in OpenSearch 2.0 instead of
public CatSnapshotsDescriptor ClusterManagerTimeout(Time timeout) => Qs("cluster_manager_timeout", timeout);
///Comma-separated list of column names or column aliases to sort by
public CatSnapshotsDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns);
///Verbose mode. Display column headers
public CatSnapshotsDescriptor Verbose(bool? verbose = true) => Qs("v", verbose);
}
///Descriptor for Tasks https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-tasks/
public partial class CatTasksDescriptor : RequestDescriptorBase, ICatTasksRequest
{
internal override ApiUrls ApiUrls => ApiUrlsLookups.CatTasks;
// values part of the url path
// Request parameters
///A comma-separated list of actions that should be returned. Leave empty to return all.
public CatTasksDescriptor Actions(params string[] actions) => Qs("actions", actions);
///Return detailed task information (default: false)
public CatTasksDescriptor Detailed(bool? detailed = true) => Qs("detailed", detailed);
///a short version of the Accept header, e.g. json, yaml
public CatTasksDescriptor Format(string format) => Qs("format", format);
///Comma-separated list of column names to display
public CatTasksDescriptor Headers(params string[] headers) => Qs("h", headers);
///Return help information
public CatTasksDescriptor Help(bool? help = true) => Qs("help", help);
///A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes
public CatTasksDescriptor Nodes(params string[] nodes) => Qs("nodes", nodes);
///Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all.
public CatTasksDescriptor ParentTaskId(string parenttaskid) => Qs("parent_task_id", parenttaskid);
///Comma-separated list of column names or column aliases to sort by
public CatTasksDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns);
///Verbose mode. Display column headers
public CatTasksDescriptor Verbose(bool? verbose = true) => Qs("v", verbose);
}
///Descriptor for Templates https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-templates/
public partial class CatTemplatesDescriptor : RequestDescriptorBase, ICatTemplatesRequest
{
internal override ApiUrls ApiUrls => ApiUrlsLookups.CatTemplates;
////_cat/templates
public CatTemplatesDescriptor(): base()
{
}
////_cat/templates/{name}
///Optional, accepts null
public CatTemplatesDescriptor(Name name): base(r => r.Optional("name", name))
{
}
// values part of the url path
Name ICatTemplatesRequest.Name => Self.RouteValues.Get("name");
///A pattern that returned template names must match
public CatTemplatesDescriptor Name(Name name) => Assign(name, (a, v) => a.RouteValues.Optional("name", v));
// Request parameters
///a short version of the Accept header, e.g. json, yaml
public CatTemplatesDescriptor Format(string format) => Qs("format", format);
///Comma-separated list of column names to display
public CatTemplatesDescriptor Headers(params string[] headers) => Qs("h", headers);
///Return help information
public CatTemplatesDescriptor Help(bool? help = true) => Qs("help", help);
///Return local information, do not retrieve the state from cluster_manager node (default: false)
public CatTemplatesDescriptor Local(bool? local = true) => Qs("local", local);
///Explicit operation timeout for connection to master node
///Deprecated as of OpenSearch 2.0, use instead
public CatTemplatesDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout);
///Explicit operation timeout for connection to cluster_manager node
///Introduced in OpenSearch 2.0 instead of
public CatTemplatesDescriptor ClusterManagerTimeout(Time timeout) => Qs("cluster_manager_timeout", timeout);
///Comma-separated list of column names or column aliases to sort by
public CatTemplatesDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns);
///Verbose mode. Display column headers
public CatTemplatesDescriptor Verbose(bool? verbose = true) => Qs("v", verbose);
}
///Descriptor for ThreadPool https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-thread-pool/
public partial class CatThreadPoolDescriptor : RequestDescriptorBase, ICatThreadPoolRequest
{
internal override ApiUrls ApiUrls => ApiUrlsLookups.CatThreadPool;
////_cat/thread_pool
public CatThreadPoolDescriptor(): base()
{
}
////_cat/thread_pool/{thread_pool_patterns}
///Optional, accepts null
public CatThreadPoolDescriptor(Names threadPoolPatterns): base(r => r.Optional("thread_pool_patterns", threadPoolPatterns))
{
}
// values part of the url path
Names ICatThreadPoolRequest.ThreadPoolPatterns => Self.RouteValues.Get("thread_pool_patterns");
///A comma-separated list of regular-expressions to filter the thread pools in the output
public CatThreadPoolDescriptor ThreadPoolPatterns(Names threadPoolPatterns) => Assign(threadPoolPatterns, (a, v) => a.RouteValues.Optional("thread_pool_patterns", v));
// Request parameters
///a short version of the Accept header, e.g. json, yaml
public CatThreadPoolDescriptor Format(string format) => Qs("format", format);
///Comma-separated list of column names to display
public CatThreadPoolDescriptor Headers(params string[] headers) => Qs("h", headers);
///Return help information
public CatThreadPoolDescriptor Help(bool? help = true) => Qs("help", help);
///Return local information, do not retrieve the state from cluster_manager node (default: false)
public CatThreadPoolDescriptor Local(bool? local = true) => Qs("local", local);
///Explicit operation timeout for connection to master node
///Deprecated as of OpenSearch 2.0, use instead
public CatThreadPoolDescriptor MasterTimeout(Time mastertimeout) => Qs("master_timeout", mastertimeout);
///Explicit operation timeout for connection to cluster_manager node
///Introduced in OpenSearch 2.0 instead of
public CatThreadPoolDescriptor ClusterManagerTimeout(Time timeout) => Qs("cluster_manager_timeout", timeout);
///Comma-separated list of column names or column aliases to sort by
public CatThreadPoolDescriptor SortByColumns(params string[] sortbycolumns) => Qs("s", sortbycolumns);
///Verbose mode. Display column headers
public CatThreadPoolDescriptor Verbose(bool? verbose = true) => Qs("v", verbose);
}
}