Class SourceOnlyRepositoryDescriptor

A source repository enables you to create minimal, source-only snapshots that take up to 50% less space on disk. Source only snapshots contain stored fields and index metadata. They do not include index or doc values structures and are not searchable when restored. After restoring a source-only snapshot, you must reindex the data into a new index.

Inheritance
object
DescriptorBase<SourceOnlyRepositoryDescriptor, ISourceOnlyRepository>
SourceOnlyRepositoryDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class SourceOnlyRepositoryDescriptor : DescriptorBase<SourceOnlyRepositoryDescriptor, ISourceOnlyRepository>, IDescriptor, ISourceOnlyRepository, IRepositoryWithSettings, ISnapshotRepository

Methods

| Edit this page View Source

Azure(Func<AzureRepositoryDescriptor, IAzureRepository>)

A snapshot repository that stores snapshots in an Azure storage account

Requires the repository-azure plugin to be installed on the cluster
Declaration
public SourceOnlyRepositoryDescriptor Azure(Func<AzureRepositoryDescriptor, IAzureRepository> selector = null)
Parameters
Type Name Description
Func<AzureRepositoryDescriptor, IAzureRepository> selector
Returns
Type Description
SourceOnlyRepositoryDescriptor
| Edit this page View Source

Custom(IRepositoryWithSettings)

Register a custom repository

Declaration
public SourceOnlyRepositoryDescriptor Custom(IRepositoryWithSettings repository)
Parameters
Type Name Description
IRepositoryWithSettings repository
Returns
Type Description
SourceOnlyRepositoryDescriptor
| Edit this page View Source

FileSystem(Func<FileSystemRepositoryDescriptor, IFileSystemRepository>)

A snapshot repository that uses a shared file system to store snapshot data. The path specified in the location parameter should point to the same location in the shared filesystem and be accessible on all data and cluster_manager nodes.

Declaration
public SourceOnlyRepositoryDescriptor FileSystem(Func<FileSystemRepositoryDescriptor, IFileSystemRepository> selector)
Parameters
Type Name Description
Func<FileSystemRepositoryDescriptor, IFileSystemRepository> selector
Returns
Type Description
SourceOnlyRepositoryDescriptor
| Edit this page View Source

Hdfs(Func<HdfsRepositoryDescriptor, IHdfsRepository>)

A snapshot repository that stores snapshot data within a Hadoop HDFS filesystem

Requires the repository-hdfs plugin to be installed on the cluster
Declaration
public SourceOnlyRepositoryDescriptor Hdfs(Func<HdfsRepositoryDescriptor, IHdfsRepository> selector)
Parameters
Type Name Description
Func<HdfsRepositoryDescriptor, IHdfsRepository> selector
Returns
Type Description
SourceOnlyRepositoryDescriptor
| Edit this page View Source

ReadOnlyUrl(Func<ReadOnlyUrlRepositoryDescriptor, IReadOnlyUrlRepository>)

A snapshot repository that can be used as an alternative read-only way to access data created by the IFileSystemRepository. The URL specified in the url parameter should point to the root of the shared filesystem repository.

Declaration
public SourceOnlyRepositoryDescriptor ReadOnlyUrl(Func<ReadOnlyUrlRepositoryDescriptor, IReadOnlyUrlRepository> selector)
Parameters
Type Name Description
Func<ReadOnlyUrlRepositoryDescriptor, IReadOnlyUrlRepository> selector
Returns
Type Description
SourceOnlyRepositoryDescriptor
| Edit this page View Source

S3(Func<S3RepositoryDescriptor, IS3Repository>)

A snapshot repository that stores snapshots in an Amazon S3 bucket

Requires the repository-s3 plugin to be installed on the cluster
Declaration
public SourceOnlyRepositoryDescriptor S3(Func<S3RepositoryDescriptor, IS3Repository> selector)
Parameters
Type Name Description
Func<S3RepositoryDescriptor, IS3Repository> selector
Returns
Type Description
SourceOnlyRepositoryDescriptor

Implements

Extension Methods