Class CatSegmentReplicationRequest
Request for SegmentReplication
https://opensearch.org/docs/latest/api-reference/cat/cat-segment-replication/
Inheritance
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class CatSegmentReplicationRequest : PlainRequestBase<CatSegmentReplicationRequestParameters>, ICatSegmentReplicationRequest, IRequest<CatSegmentReplicationRequestParameters>, IRequest
Constructors
| Edit this page View SourceCatSegmentReplicationRequest()
/_cat/segment_replication
Declaration
public CatSegmentReplicationRequest()
CatSegmentReplicationRequest(Indices)
/_cat/segment_replication/{index}
Declaration
public CatSegmentReplicationRequest(Indices index)
Parameters
Type | Name | Description |
---|---|---|
Indices | index | Optional, accepts null |
Properties
| Edit this page View SourceActiveOnly
If true
, the response only includes ongoing segment replication events.
Declaration
public bool? ActiveOnly { get; set; }
Property Value
Type | Description |
---|---|
bool? |
AllowNoIndices
Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes _all
string or when no indexes have
been specified).
Declaration
public bool? AllowNoIndices { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Bytes
The unit in which to display byte values.
Declaration
public ByteUnit? Bytes { get; set; }
Property Value
Type | Description |
---|---|
ByteUnit? |
CompletedOnly
If true
, the response only includes latest completed segment replication events.
Declaration
public bool? CompletedOnly { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Detailed
If true
, the response includes detailed information about segment replications.
Declaration
public bool? Detailed { get; set; }
Property Value
Type | Description |
---|---|
bool? |
ExpandWildcards
Whether to expand wildcard expression to concrete indexes that are open, closed or both.
Declaration
public ExpandWildcards? ExpandWildcards { get; set; }
Property Value
Type | Description |
---|---|
ExpandWildcards? |
Format
A short version of the Accept header (for example, json
, yaml
).
Declaration
public string Format { get; set; }
Property Value
Type | Description |
---|---|
string |
Headers
Comma-separated list of column names to display.
Declaration
public string[] Headers { get; set; }
Property Value
Type | Description |
---|---|
string[] |
Help
Return help information.
Declaration
public bool? Help { get; set; }
Property Value
Type | Description |
---|---|
bool? |
IgnoreThrottled
Whether specified concrete, expanded or aliased indexes should be ignored when throttled.
Declaration
public bool? IgnoreThrottled { get; set; }
Property Value
Type | Description |
---|---|
bool? |
IgnoreUnavailable
Whether specified concrete indexes should be ignored when unavailable (missing or closed).
Declaration
public bool? IgnoreUnavailable { get; set; }
Property Value
Type | Description |
---|---|
bool? |
Self
Declaration
protected ICatSegmentReplicationRequest Self { get; }
Property Value
Type | Description |
---|---|
ICatSegmentReplicationRequest |
Shards
Comma-separated list of shards to display.
Declaration
public string[] Shards { get; set; }
Property Value
Type | Description |
---|---|
string[] |
SortByColumns
Comma-separated list of column names or column aliases to sort by.
Declaration
public string[] SortByColumns { get; set; }
Property Value
Type | Description |
---|---|
string[] |
Timeout
Operation timeout.
Declaration
public Time Timeout { get; set; }
Property Value
Type | Description |
---|---|
Time |
Verbose
Verbose mode. Display column headers.
Declaration
public bool? Verbose { get; set; }
Property Value
Type | Description |
---|---|
bool? |