Class CleanupRepositoryDescriptor
Descriptor for CleanupRepository
https://opensearch.org/docs/latest
Inheritance
RequestDescriptorBase <CleanupRepositoryDescriptor , CleanupRepositoryRequestParameters , ICleanupRepositoryRequest >
CleanupRepositoryDescriptor
Implements
Inherited Members
Namespace: OpenSearch .Client
Assembly: OpenSearch.Client.dll
Syntax
public class CleanupRepositoryDescriptor : RequestDescriptorBase<CleanupRepositoryDescriptor, CleanupRepositoryRequestParameters, ICleanupRepositoryRequest>, IDescriptor, ICleanupRepositoryRequest, IRequest<CleanupRepositoryRequestParameters>, IRequestConstructors
| Edit this page View SourceCleanupRepositoryDescriptor()
Used for serialization purposes, making sure we have a parameterless constructor
Declaration
protected CleanupRepositoryDescriptor()CleanupRepositoryDescriptor(Name)
/_snapshot/{repository}/_cleanup
Declaration
public CleanupRepositoryDescriptor(Name repository)Parameters
| Type | Name | Description |
|---|---|---|
| Name | repository | this parameter is required |
Methods
| Edit this page View SourceClusterManagerTimeout(Time)
The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see Common parameters.
Declaration
public CleanupRepositoryDescriptor ClusterManagerTimeout(Time clustermanagertimeout)Parameters
| Type | Name | Description |
|---|---|---|
| Time | clustermanagertimeout |
Returns
| Type | Description |
|---|---|
| Cleanup |
Remarks
Supported by OpenSearch servers of version 2.0.0 or greater.
MasterTimeout(Time)
Period to wait for a connection to the cluster-manager node.
Declaration
[Obsolete("Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead.")]
public CleanupRepositoryDescriptor MasterTimeout(Time mastertimeout)Parameters
| Type | Name | Description |
|---|---|---|
| Time | mastertimeout |
Returns
| Type | Description |
|---|---|
| Cleanup |
Timeout(Time)
The amount of time to wait for a response.
Declaration
public CleanupRepositoryDescriptor Timeout(Time timeout)Parameters
| Type | Name | Description |
|---|---|---|
| Time | timeout |
Returns
| Type | Description |
|---|---|
| Cleanup |