Class FileSystemRepositorySettingsDescriptor

Repository settings for IFileSystemRepository

Inheritance
object
DescriptorBase<FileSystemRepositorySettingsDescriptor, IFileSystemRepositorySettings>
FileSystemRepositorySettingsDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class FileSystemRepositorySettingsDescriptor : DescriptorBase<FileSystemRepositorySettingsDescriptor, IFileSystemRepositorySettings>, IDescriptor, IFileSystemRepositorySettings, IRepositorySettings

Methods

| Edit this page View Source

ChunkSize(string)

Big files can be broken down into chunks during the snapshot process, if needed. The chunk size can be specified in bytes or by using size value notation, i.e. 1g, 10m, 5k. Defaults to null (unlimited chunk size).

Declaration
public FileSystemRepositorySettingsDescriptor ChunkSize(string chunkSize)
Parameters
Type Name Description
string chunkSize
Returns
Type Description
FileSystemRepositorySettingsDescriptor
| Edit this page View Source

Compress(bool?)

Turns on compression of the snapshot files. Defaults to true.

Declaration
public FileSystemRepositorySettingsDescriptor Compress(bool? compress = true)
Parameters
Type Name Description
bool? compress
Returns
Type Description
FileSystemRepositorySettingsDescriptor
| Edit this page View Source

ConcurrentStreams(int?)

Throttles the number of streams (per node) preforming snapshot operation. Defaults to 5

Declaration
public FileSystemRepositorySettingsDescriptor ConcurrentStreams(int? concurrentStreams)
Parameters
Type Name Description
int? concurrentStreams
Returns
Type Description
FileSystemRepositorySettingsDescriptor
| Edit this page View Source

Location(string)

Location of the snapshots. Mandatory.

Declaration
public FileSystemRepositorySettingsDescriptor Location(string location)
Parameters
Type Name Description
string location
Returns
Type Description
FileSystemRepositorySettingsDescriptor
| Edit this page View Source

RestoreBytesPerSecondMaximum(string)

Throttles per node restore rate. Defaults to 20mb per second.

Declaration
public FileSystemRepositorySettingsDescriptor RestoreBytesPerSecondMaximum(string maximumBytesPerSecond)
Parameters
Type Name Description
string maximumBytesPerSecond
Returns
Type Description
FileSystemRepositorySettingsDescriptor
| Edit this page View Source

SnapshotBytesPerSecondMaximum(string)

Throttles per node snapshot rate. Defaults to 20mb per second.

Declaration
public FileSystemRepositorySettingsDescriptor SnapshotBytesPerSecondMaximum(string maximumBytesPerSecond)
Parameters
Type Name Description
string maximumBytesPerSecond
Returns
Type Description
FileSystemRepositorySettingsDescriptor

Implements

Extension Methods