Class ShrinkIndexDescriptor
Descriptor for Shrink
https://opensearch.org/docs/latest/opensearch/rest-api/index-apis/shrink-index/
Inheritance
ShrinkIndexDescriptor
Assembly: OpenSearch.Client.dll
Syntax
public class ShrinkIndexDescriptor : RequestDescriptorBase<ShrinkIndexDescriptor, ShrinkIndexRequestParameters, IShrinkIndexRequest>, IDescriptor, IShrinkIndexRequest, IRequest<ShrinkIndexRequestParameters>, IRequest
Constructors
|
Edit this page
View Source
ShrinkIndexDescriptor()
Used for serialization purposes, making sure we have a parameterless constructor
Declaration
protected ShrinkIndexDescriptor()
|
Edit this page
View Source
ShrinkIndexDescriptor(IndexName, IndexName)
/{index}/_shrink/{target}
Declaration
public ShrinkIndexDescriptor(IndexName index, IndexName target)
Parameters
Type |
Name |
Description |
IndexName |
index |
this parameter is required
|
IndexName |
target |
this parameter is required
|
Methods
|
Edit this page
View Source
Aliases(Func<AliasesDescriptor, IPromise<IAliases>>)
Declaration
public ShrinkIndexDescriptor Aliases(Func<AliasesDescriptor, IPromise<IAliases>> selector)
Parameters
Returns
|
Edit this page
View Source
ClusterManagerTimeout(Time)
Specify timeout for connection to cluster_manager node
Declaration
public ShrinkIndexDescriptor ClusterManagerTimeout(Time timeout)
Parameters
Type |
Name |
Description |
Time |
timeout |
|
Returns
|
Edit this page
View Source
Index(IndexName)
The name of the source index to shrink
Declaration
public ShrinkIndexDescriptor Index(IndexName index)
Parameters
Returns
|
Edit this page
View Source
Index<TOther>()
a shortcut into calling Index(typeof(TOther))
Declaration
public ShrinkIndexDescriptor Index<TOther>() where TOther : class
Returns
Type Parameters
|
Edit this page
View Source
MasterTimeout(Time)
Specify timeout for connection to master node
Declaration
public ShrinkIndexDescriptor MasterTimeout(Time mastertimeout)
Parameters
Type |
Name |
Description |
Time |
mastertimeout |
|
Returns
|
Edit this page
View Source
Settings(Func<IndexSettingsDescriptor, IPromise<IIndexSettings>>)
Declaration
public ShrinkIndexDescriptor Settings(Func<IndexSettingsDescriptor, IPromise<IIndexSettings>> selector)
Parameters
Returns
|
Edit this page
View Source
Timeout(Time)
Explicit operation timeout
Declaration
public ShrinkIndexDescriptor Timeout(Time timeout)
Parameters
Type |
Name |
Description |
Time |
timeout |
|
Returns
|
Edit this page
View Source
WaitForActiveShards(string)
Set the number of active shards to wait for on the shrunken index before the operation returns.
Declaration
public ShrinkIndexDescriptor WaitForActiveShards(string waitforactiveshards)
Parameters
Type |
Name |
Description |
string |
waitforactiveshards |
|
Returns
Implements
Extension Methods