Class CatPluginsRequest
Request for Plugins
https://opensearch.org/docs/latest/api-reference/cat/cat-plugins/
Inheritance
CatPluginsRequest
Inherited Members
Namespace: OpenSearch .Client
Assembly: OpenSearch.Client.dll
Syntax
public class CatPluginsRequest : PlainRequestBase<CatPluginsRequestParameters>, ICatPluginsRequest, IRequest<CatPluginsRequestParameters>, IRequest
Properties
| Edit this page View SourceClusterManagerTimeout
The amount of time allowed to establish a connection to the cluster manager node.
Declaration
public Time ClusterManagerTimeout { get; set; }
Property Value
Type | Description |
---|---|
Time |
Remarks
Supported by OpenSearch servers of version 2.0.0 or greater.
Format
A short version of the Accept
header, such as json
or yaml
.
Declaration
public string Format { get; set; }
Property Value
Type | Description |
---|---|
string |
Headers
A comma-separated list of column names to display.
Declaration
public string[] Headers { get; set; }
Property Value
Type | Description |
---|---|
string[] |
Help
Returns help information.
Declaration
public bool? Help { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Local
Returns local information but does not retrieve the state from the cluster manager node.
Declaration
public bool? Local { get; set; }
Property Value
Type | Description |
---|---|
bool? |
MasterTimeout
The amount of time allowed to establish a connection to the cluster manager node.
Declaration
[Obsolete("Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead.")]
public Time MasterTimeout { get; set; }
Property Value
Type | Description |
---|---|
Time |
Self
Declaration
protected ICatPluginsRequest Self { get; }
Property Value
Type | Description |
---|---|
ICat |
SortByColumns
A comma-separated list of column names or column aliases to sort by.
Declaration
public string[] SortByColumns { get; set; }
Property Value
Type | Description |
---|---|
string[] |
Verbose
Enables verbose mode, which displays column headers.
Declaration
public bool? Verbose { get; set; }
Property Value
Type | Description |
---|---|
bool? |