Class CatSegmentReplicationDescriptor
Descriptor for SegmentReplication
https://opensearch.org/docs/latest/api-reference/cat/cat-segment-replication/
Inheritance
CatSegmentReplicationDescriptor
Assembly: OpenSearch.Client.dll
Syntax
public class CatSegmentReplicationDescriptor : RequestDescriptorBase<CatSegmentReplicationDescriptor, CatSegmentReplicationRequestParameters, ICatSegmentReplicationRequest>, IDescriptor, ICatSegmentReplicationRequest, IRequest<CatSegmentReplicationRequestParameters>, IRequest
Constructors
|
Edit this page
View Source
CatSegmentReplicationDescriptor()
/_cat/segment_replication
Declaration
public CatSegmentReplicationDescriptor()
|
Edit this page
View Source
CatSegmentReplicationDescriptor(Indices)
/_cat/segment_replication/{index}
Declaration
public CatSegmentReplicationDescriptor(Indices index)
Parameters
| Type |
Name |
Description |
| Indices |
index |
Optional, accepts null
|
Methods
|
Edit this page
View Source
ActiveOnly(bool?)
When true, the response only includes ongoing segment replication events.
Declaration
public CatSegmentReplicationDescriptor ActiveOnly(bool? activeonly = true)
Parameters
| Type |
Name |
Description |
| bool? |
activeonly |
|
Returns
|
Edit this page
View Source
AllIndices()
A shortcut into calling Index(Indices.All)
Declaration
public CatSegmentReplicationDescriptor AllIndices()
Returns
|
Edit this page
View Source
AllowNoIndices(bool?)
Whether to ignore the index if a wildcard index expression resolves to no concrete indexes. This includes the _all string or when no indexes have been specified.
Declaration
public CatSegmentReplicationDescriptor AllowNoIndices(bool? allownoindices = true)
Parameters
| Type |
Name |
Description |
| bool? |
allownoindices |
|
Returns
|
Edit this page
View Source
Bytes(ByteUnit?)
The units used to display byte values.
Declaration
public CatSegmentReplicationDescriptor Bytes(ByteUnit? bytes)
Parameters
Returns
|
Edit this page
View Source
CompletedOnly(bool?)
When true, the response only includes the last-completed segment replication events.
Declaration
public CatSegmentReplicationDescriptor CompletedOnly(bool? completedonly = true)
Parameters
| Type |
Name |
Description |
| bool? |
completedonly |
|
Returns
|
Edit this page
View Source
Detailed(bool?)
When true, the response includes additional metrics for each stage of a segment replication event.
Declaration
public CatSegmentReplicationDescriptor Detailed(bool? detailed = true)
Parameters
| Type |
Name |
Description |
| bool? |
detailed |
|
Returns
|
Edit this page
View Source
ExpandWildcards(ExpandWildcards?)
Specifies the type of index that wildcard expressions can match. Supports comma-separated values.
Declaration
public CatSegmentReplicationDescriptor ExpandWildcards(ExpandWildcards? expandwildcards)
Parameters
Returns
|
Edit this page
View Source
A short version of the Accept header, such as json or yaml.
Declaration
public CatSegmentReplicationDescriptor Format(string format)
Parameters
| Type |
Name |
Description |
| string |
format |
|
Returns
|
Edit this page
View Source
A comma-separated list of column names to display.
Declaration
public CatSegmentReplicationDescriptor Headers(params string[] headers)
Parameters
| Type |
Name |
Description |
| string[] |
headers |
|
Returns
|
Edit this page
View Source
Help(bool?)
Returns help information.
Declaration
public CatSegmentReplicationDescriptor Help(bool? help = true)
Parameters
| Type |
Name |
Description |
| bool? |
help |
|
Returns
|
Edit this page
View Source
IgnoreThrottled(bool?)
Whether specified concrete, expanded, or aliased indexes should be ignored when throttled.
Declaration
public CatSegmentReplicationDescriptor IgnoreThrottled(bool? ignorethrottled = true)
Parameters
| Type |
Name |
Description |
| bool? |
ignorethrottled |
|
Returns
|
Edit this page
View Source
IgnoreUnavailable(bool?)
Whether the specified concrete indexes should be ignored when missing or closed.
Declaration
public CatSegmentReplicationDescriptor IgnoreUnavailable(bool? ignoreunavailable = true)
Parameters
| Type |
Name |
Description |
| bool? |
ignoreunavailable |
|
Returns
|
Edit this page
View Source
Index(Indices)
A comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (*). To target all data streams and indexes, omit this parameter or use * or _all.
Declaration
public CatSegmentReplicationDescriptor Index(Indices index)
Parameters
| Type |
Name |
Description |
| Indices |
index |
|
Returns
|
Edit this page
View Source
Index<TOther>()
a shortcut into calling Index(typeof(TOther))
Declaration
public CatSegmentReplicationDescriptor Index<TOther>() where TOther : class
Returns
Type Parameters
|
Edit this page
View Source
Shards(params string[])
A comma-separated list of shards to display.
Declaration
public CatSegmentReplicationDescriptor Shards(params string[] shards)
Parameters
| Type |
Name |
Description |
| string[] |
shards |
|
Returns
|
Edit this page
View Source
SortByColumns(params string[])
A comma-separated list of column names or column aliases to sort by.
Declaration
public CatSegmentReplicationDescriptor SortByColumns(params string[] sortbycolumns)
Parameters
| Type |
Name |
Description |
| string[] |
sortbycolumns |
|
Returns
|
Edit this page
View Source
Timeout(Time)
Declaration
public CatSegmentReplicationDescriptor Timeout(Time timeout)
Parameters
| Type |
Name |
Description |
| Time |
timeout |
|
Returns
|
Edit this page
View Source
Verbose(bool?)
Enables verbose mode, which displays column headers.
Declaration
public CatSegmentReplicationDescriptor Verbose(bool? verbose = true)
Parameters
| Type |
Name |
Description |
| bool? |
verbose |
|
Returns
Implements
Extension Methods