Class GetRepositoryDescriptor
Descriptor for GetRepository
https://opensearch.org/docs/latest/api-reference/snapshots/get-snapshot-repository/
Inheritance
RequestDescriptorBase <GetRepositoryDescriptor , GetRepositoryRequestParameters , IGetRepositoryRequest >
GetRepositoryDescriptor
Inherited Members
Namespace: OpenSearch .Client
Assembly: OpenSearch.Client.dll
Syntax
public class GetRepositoryDescriptor : RequestDescriptorBase<GetRepositoryDescriptor, GetRepositoryRequestParameters, IGetRepositoryRequest>, IDescriptor, IGetRepositoryRequest, IRequest<GetRepositoryRequestParameters>, IRequestConstructors
| Edit this page View SourceGetRepositoryDescriptor()
/_snapshot
Declaration
public GetRepositoryDescriptor()GetRepositoryDescriptor(Names)
/_snapshot/{repository}
Declaration
public GetRepositoryDescriptor(Names repository)Parameters
| Type | Name | Description |
|---|---|---|
| Names | repository | Optional, accepts null |
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 GetRepositoryDescriptor ClusterManagerTimeout(Time clustermanagertimeout)Parameters
| Type | Name | Description |
|---|---|---|
| Time | clustermanagertimeout |
Returns
| Type | Description |
|---|---|
| Get |
Remarks
Supported by OpenSearch servers of version 2.0.0 or greater.
Local(bool?)
Whether to get information from the local node.
Declaration
public GetRepositoryDescriptor Local(bool? local = true)Parameters
| Type | Name | Description |
|---|---|---|
| bool? | local |
Returns
| Type | Description |
|---|---|
| Get |
MasterTimeout(Time)
Explicit operation timeout for connection to cluster-manager node.
Declaration
[Obsolete("Deprecated as of: 2.0.0, reason: To promote inclusive language, use `cluster_manager_timeout` instead.")]
public GetRepositoryDescriptor MasterTimeout(Time mastertimeout)Parameters
| Type | Name | Description |
|---|---|---|
| Time | mastertimeout |
Returns
| Type | Description |
|---|---|
| Get |
RepositoryName(Names)
A comma-separated list of repository names.
Declaration
public GetRepositoryDescriptor RepositoryName(Names repository)Parameters
| Type | Name | Description |
|---|---|---|
| Names | repository |
Returns
| Type | Description |
|---|---|
| Get |