Class CatSegmentReplicationRequestParameters

Request options for SegmentReplication

https://opensearch.org/docs/latest/api-reference/cat/cat-segment-replication/

Inheritance

object

RequestParameters<CatSegmentReplicationRequestParameters>

CatSegmentReplicationRequestParameters

Implements

IRequestParameters

Inherited Members

RequestParameters<CatSegmentReplicationRequestParameters>.CustomResponseBuilder

RequestParameters<CatSegmentReplicationRequestParameters>.QueryString

RequestParameters<CatSegmentReplicationRequestParameters>.RequestConfiguration

RequestParameters<CatSegmentReplicationRequestParameters>.ContainsQueryString(string)

RequestParameters<CatSegmentReplicationRequestParameters>.GetQueryStringValue<TOut>(string)

RequestParameters<CatSegmentReplicationRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)

RequestParameters<CatSegmentReplicationRequestParameters>.SetQueryString(string, object)

RequestParameters<CatSegmentReplicationRequestParameters>.Q<TOut>(string)

RequestParameters<CatSegmentReplicationRequestParameters>.Q(string, object)

RequestParameters<CatSegmentReplicationRequestParameters>.SetAcceptHeader(string)

RequestParameters<CatSegmentReplicationRequestParameters>.AcceptHeaderFromFormat(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Net.Specification.CatApi

Assembly: OpenSearch.Net.dll

Syntax

public class CatSegmentReplicationRequestParameters : RequestParameters<CatSegmentReplicationRequestParameters>, IRequestParameters

Properties

ActiveOnly

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

Declaration

public bool? ActiveOnly { get; set; }

Property Value

Type	Description
bool?

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?

Bytes

The units used to display byte values.

Declaration

public ByteUnit? Bytes { get; set; }

Property Value

Type	Description
ByteUnit?

CompletedOnly

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

Declaration

public bool? CompletedOnly { get; set; }

Property Value

Type	Description
bool?

DefaultHttpMethod

Declaration

public override HttpMethod DefaultHttpMethod { get; }

Property Value

Type	Description
HttpMethod

Overrides

RequestParameters<CatSegmentReplicationRequestParameters>.DefaultHttpMethod

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?

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?

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?

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 the specified concrete indexes should be ignored when missing or closed.

Declaration

public bool? IgnoreUnavailable { get; set; }

Property Value

Type	Description
bool?

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[]

Shards

A comma-separated list of shards to display.

Declaration

public string[] Shards { get; set; }

Property Value

Type	Description
string[]

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[]

SupportsBody

Declaration

public override bool SupportsBody { get; }

Property Value

Type	Description
bool

Overrides

RequestParameters<CatSegmentReplicationRequestParameters>.SupportsBody

Timeout

The operation timeout.

Declaration

public TimeSpan Timeout { get; set; }

Property Value

Type	Description
TimeSpan

Verbose

Enables verbose mode, which displays column headers.

Declaration

public bool? Verbose { get; set; }

Property Value

Type	Description
bool?

Implements

IRequestParameters

Extension Methods

SuffixExtensions.Suffix(object, string)