Class CatSegmentReplicationRequestParameters

Request options for SegmentReplication

<p>https://docs.opensearch.org/latest/api-reference/cat/cat-segment-replication/</p>
Inheritance
object
RequestParameters<CatSegmentReplicationRequestParameters>
CatSegmentReplicationRequestParameters
Implements
Inherited Members
Namespace: OpenSearch.Net.Specification.CatApi
Assembly: OpenSearch.Net.dll
Syntax
public class CatSegmentReplicationRequestParameters : RequestParameters<CatSegmentReplicationRequestParameters>, IRequestParameters

Properties

| Edit this page View Source

ActiveOnly

When true, the response only includes ongoing segment replication events.

Declaration
public bool? ActiveOnly { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

AllowNoIndices

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 bool? AllowNoIndices { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

Bytes

The units used to display byte values.

Declaration
public ByteUnit? Bytes { get; set; }
Property Value
Type Description
ByteUnit?
| Edit this page View Source

CompletedOnly

When true, the response only includes the last-completed segment replication events.

Declaration
public bool? CompletedOnly { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

DefaultHttpMethod

Declaration
public override HttpMethod DefaultHttpMethod { get; }
Property Value
Type Description
HttpMethod
Overrides
| Edit this page View Source

Detailed

When true, the response includes additional metrics for each stage of a segment replication event.

Declaration
public bool? Detailed { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

ExpandWildcards

Specifies the type of index that wildcard expressions can match. Supports comma-separated values.

Declaration
public ExpandWildcards? ExpandWildcards { get; set; }
Property Value
Type Description
ExpandWildcards?
| Edit this page View Source

Format

A short version of the Accept header, such as json or yaml.

Declaration
public CatResponseFormat? Format { get; set; }
Property Value
Type Description
CatResponseFormat?
| Edit this page View Source

Headers

A comma-separated list of column names to display.

Declaration
public string[] Headers { get; set; }
Property Value
Type Description
string[]
| Edit this page View Source

Help

Returns help information.

Declaration
public bool? Help { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

IgnoreThrottled

Whether specified concrete, expanded, or aliased indexes should be ignored when throttled.

Declaration
public bool? IgnoreThrottled { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

IgnoreUnavailable

Whether the specified concrete indexes should be ignored when missing or closed.

Declaration
public bool? IgnoreUnavailable { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

Index

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 string[] Index { get; set; }
Property Value
Type Description
string[]
| Edit this page View Source

OperationName

The OpenSearch REST API operation name this request maps to (for example search or indices.create), used as the OpenTelemetry span name and db.operation tag. null for requests that do not correspond to a named API operation.

Declaration
public override string OperationName { get; }
Property Value
Type Description
string
Overrides
| Edit this page View Source

Shards

A comma-separated list of shards to display.

Declaration
public string[] Shards { get; set; }
Property Value
Type Description
string[]
| Edit this page View Source

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[]
| Edit this page View Source

SupportsBody

Declaration
public override bool SupportsBody { get; }
Property Value
Type Description
bool
Overrides
| Edit this page View Source

Timeout

The operation timeout.

Declaration
public TimeSpan Timeout { get; set; }
Property Value
Type Description
TimeSpan
| Edit this page View Source

Verbose

Enables verbose mode, which displays column headers.

Declaration
public bool? Verbose { get; set; }
Property Value
Type Description
bool?

Implements

Extension Methods