Class ShrinkIndexRequest

Request for Shrink

https://opensearch.org/docs/latest/api-reference/index-apis/shrink-index/

Inheritance
object
RequestBase<ShrinkIndexRequestParameters>
PlainRequestBase<ShrinkIndexRequestParameters>
ShrinkIndexRequest
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class ShrinkIndexRequest : PlainRequestBase<ShrinkIndexRequestParameters>, IShrinkIndexRequest, IRequest<ShrinkIndexRequestParameters>, IRequest

Constructors

| Edit this page View Source

ShrinkIndexRequest()

Used for serialization purposes, making sure we have a parameterless constructor

Declaration
protected ShrinkIndexRequest()
| Edit this page View Source

ShrinkIndexRequest(IndexName, IndexName)

/{index}/_shrink/{target}

Declaration
public ShrinkIndexRequest(IndexName index, IndexName target)
Parameters
Type Name Description
IndexName index

this parameter is required
IndexName target

this parameter is required

Properties

| Edit this page View Source

Aliases

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

ClusterManagerTimeout

Operation timeout for connection to cluster-manager node.

Declaration
public Time ClusterManagerTimeout { get; set; }
Property Value
Type Description
Time
Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

MasterTimeout

Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.

Declaration
[Obsolete("Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead.")]
public Time MasterTimeout { get; set; }
Property Value
Type Description
Time
| Edit this page View Source

Self

Declaration
protected IShrinkIndexRequest Self { get; }
Property Value
Type Description
IShrinkIndexRequest
| Edit this page View Source

Settings

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

TaskExecutionTimeout

Explicit task execution timeout, only useful when wait_for_completion is false, defaults to 1h.

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

Timeout

Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

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

WaitForActiveShards

The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (number_of_replicas+1).

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

WaitForCompletion

Should this request wait until the operation has completed before returning.

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

Supported by OpenSearch servers of version 2.7.0 or greater.

Implements

Extension Methods