Class CatSegmentReplicationDescriptor

Descriptor for SegmentReplication

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

Inheritance

object

RequestBase<CatSegmentReplicationRequestParameters>

RequestDescriptorBase<CatSegmentReplicationDescriptor, CatSegmentReplicationRequestParameters, ICatSegmentReplicationRequest>

CatSegmentReplicationDescriptor

Implements

IDescriptor

ICatSegmentReplicationRequest

IRequest<CatSegmentReplicationRequestParameters>

IRequest

Inherited Members

RequestDescriptorBase<CatSegmentReplicationDescriptor, CatSegmentReplicationRequestParameters, ICatSegmentReplicationRequest>.Self

RequestDescriptorBase<CatSegmentReplicationDescriptor, CatSegmentReplicationRequestParameters, ICatSegmentReplicationRequest>.Assign<TValue>(TValue, Action<ICatSegmentReplicationRequest, TValue>)

RequestDescriptorBase<CatSegmentReplicationDescriptor, CatSegmentReplicationRequestParameters, ICatSegmentReplicationRequest>.Qs(string, object)

RequestDescriptorBase<CatSegmentReplicationDescriptor, CatSegmentReplicationRequestParameters, ICatSegmentReplicationRequest>.RequestConfiguration(Func<RequestConfigurationDescriptor, IRequestConfiguration>)

RequestDescriptorBase<CatSegmentReplicationDescriptor, CatSegmentReplicationRequestParameters, ICatSegmentReplicationRequest>.ErrorTrace(bool?)

RequestDescriptorBase<CatSegmentReplicationDescriptor, CatSegmentReplicationRequestParameters, ICatSegmentReplicationRequest>.FilterPath(params string[])

RequestDescriptorBase<CatSegmentReplicationDescriptor, CatSegmentReplicationRequestParameters, ICatSegmentReplicationRequest>.FilterPath(IEnumerable<string>)

RequestDescriptorBase<CatSegmentReplicationDescriptor, CatSegmentReplicationRequestParameters, ICatSegmentReplicationRequest>.Human(bool?)

RequestDescriptorBase<CatSegmentReplicationDescriptor, CatSegmentReplicationRequestParameters, ICatSegmentReplicationRequest>.Pretty(bool?)

RequestDescriptorBase<CatSegmentReplicationDescriptor, CatSegmentReplicationRequestParameters, ICatSegmentReplicationRequest>.SourceQueryString(string)

RequestBase<CatSegmentReplicationRequestParameters>.HttpMethod

RequestBase<CatSegmentReplicationRequestParameters>.RequestState

RequestBase<CatSegmentReplicationRequestParameters>.ContentType

RequestBase<CatSegmentReplicationRequestParameters>.ResolveUrl(RouteValues, IConnectionSettingsValues)

RequestBase<CatSegmentReplicationRequestParameters>.RequestDefaults(CatSegmentReplicationRequestParameters)

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

RequestBase<CatSegmentReplicationRequestParameters>.Q(string, object)

RequestBase<CatSegmentReplicationRequestParameters>.SetAcceptHeader(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Client

Assembly: OpenSearch.Client.dll

Syntax

public class CatSegmentReplicationDescriptor : RequestDescriptorBase<CatSegmentReplicationDescriptor, CatSegmentReplicationRequestParameters, ICatSegmentReplicationRequest>, IDescriptor, ICatSegmentReplicationRequest, IRequest<CatSegmentReplicationRequestParameters>, IRequest

Constructors

CatSegmentReplicationDescriptor()

/_cat/segment_replication

Declaration

public CatSegmentReplicationDescriptor()

CatSegmentReplicationDescriptor(Indices)

/_cat/segment_replication/{index}

Declaration

public CatSegmentReplicationDescriptor(Indices index)

Parameters

Type	Name	Description
Indices	index	Optional, accepts null

Methods

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

Type	Description
CatSegmentReplicationDescriptor

AllIndices()

A shortcut into calling Index(Indices.All)

Declaration

public CatSegmentReplicationDescriptor AllIndices()

Returns

Type	Description
CatSegmentReplicationDescriptor

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

Type	Description
CatSegmentReplicationDescriptor

Bytes(ByteUnit?)

The units used to display byte values.

Declaration

public CatSegmentReplicationDescriptor Bytes(ByteUnit? bytes)

Parameters

Type	Name	Description
ByteUnit?	bytes

Returns

Type	Description
CatSegmentReplicationDescriptor

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

Type	Description
CatSegmentReplicationDescriptor

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

Type	Description
CatSegmentReplicationDescriptor

ExpandWildcards(ExpandWildcards?)

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

Declaration

public CatSegmentReplicationDescriptor ExpandWildcards(ExpandWildcards? expandwildcards)

Parameters

Type	Name	Description
ExpandWildcards?	expandwildcards

Returns

Type	Description
CatSegmentReplicationDescriptor

Format(string)

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

Type	Description
CatSegmentReplicationDescriptor

Headers(params string[])

A comma-separated list of column names to display.

Declaration

public CatSegmentReplicationDescriptor Headers(params string[] headers)

Parameters

Type	Name	Description
string[]	headers

Returns

Type	Description
CatSegmentReplicationDescriptor

Help(bool?)

Returns help information.

Declaration

public CatSegmentReplicationDescriptor Help(bool? help = true)

Parameters

Type	Name	Description
bool?	help

Returns

Type	Description
CatSegmentReplicationDescriptor

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

Type	Description
CatSegmentReplicationDescriptor

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

Type	Description
CatSegmentReplicationDescriptor

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

Type	Description
CatSegmentReplicationDescriptor

Index<TOther>()

a shortcut into calling Index(typeof(TOther))

Declaration

public CatSegmentReplicationDescriptor Index<TOther>() where TOther : class

Returns

Type	Description
CatSegmentReplicationDescriptor

Type Parameters

Name	Description
TOther

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

Type	Description
CatSegmentReplicationDescriptor

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

Type	Description
CatSegmentReplicationDescriptor

Timeout(Time)

The operation timeout.

Declaration

public CatSegmentReplicationDescriptor Timeout(Time timeout)

Parameters

Type	Name	Description
Time	timeout

Returns

Type	Description
CatSegmentReplicationDescriptor

Verbose(bool?)

Enables verbose mode, which displays column headers.

Declaration

public CatSegmentReplicationDescriptor Verbose(bool? verbose = true)

Parameters

Type	Name	Description
bool?	verbose

Returns

Type	Description
CatSegmentReplicationDescriptor

Implements

IDescriptor

ICatSegmentReplicationRequest

IRequest<TParameters>

IRequest

Extension Methods

SuffixExtensions.Suffix(object, string)