Search Results for

    Show / Hide Table of Contents

    Class CreateRepositoryDescriptor

    Creates a snapshot repository

    Inheritance
    object
    RequestBase<CreateRepositoryRequestParameters>
    RequestDescriptorBase<CreateRepositoryDescriptor, CreateRepositoryRequestParameters, ICreateRepositoryRequest>
    CreateRepositoryDescriptor
    Implements
    IDescriptor
    ICreateRepositoryRequest
    IRequest<CreateRepositoryRequestParameters>
    IRequest
    Inherited Members
    RequestDescriptorBase<CreateRepositoryDescriptor, CreateRepositoryRequestParameters, ICreateRepositoryRequest>.Self
    RequestDescriptorBase<CreateRepositoryDescriptor, CreateRepositoryRequestParameters, ICreateRepositoryRequest>.Assign<TValue>(TValue, Action<ICreateRepositoryRequest, TValue>)
    RequestDescriptorBase<CreateRepositoryDescriptor, CreateRepositoryRequestParameters, ICreateRepositoryRequest>.Qs(string, object)
    RequestDescriptorBase<CreateRepositoryDescriptor, CreateRepositoryRequestParameters, ICreateRepositoryRequest>.RequestConfiguration(Func<RequestConfigurationDescriptor, IRequestConfiguration>)
    RequestDescriptorBase<CreateRepositoryDescriptor, CreateRepositoryRequestParameters, ICreateRepositoryRequest>.ErrorTrace(bool?)
    RequestDescriptorBase<CreateRepositoryDescriptor, CreateRepositoryRequestParameters, ICreateRepositoryRequest>.FilterPath(params string[])
    RequestDescriptorBase<CreateRepositoryDescriptor, CreateRepositoryRequestParameters, ICreateRepositoryRequest>.FilterPath(IEnumerable<string>)
    RequestDescriptorBase<CreateRepositoryDescriptor, CreateRepositoryRequestParameters, ICreateRepositoryRequest>.Human(bool?)
    RequestDescriptorBase<CreateRepositoryDescriptor, CreateRepositoryRequestParameters, ICreateRepositoryRequest>.Pretty(bool?)
    RequestDescriptorBase<CreateRepositoryDescriptor, CreateRepositoryRequestParameters, ICreateRepositoryRequest>.SourceQueryString(string)
    RequestBase<CreateRepositoryRequestParameters>.HttpMethod
    RequestBase<CreateRepositoryRequestParameters>.RequestState
    RequestBase<CreateRepositoryRequestParameters>.ContentType
    RequestBase<CreateRepositoryRequestParameters>.ResolveUrl(RouteValues, IConnectionSettingsValues)
    RequestBase<CreateRepositoryRequestParameters>.RequestDefaults(CreateRepositoryRequestParameters)
    RequestBase<CreateRepositoryRequestParameters>.Q<TOut>(string)
    RequestBase<CreateRepositoryRequestParameters>.Q(string, object)
    RequestBase<CreateRepositoryRequestParameters>.SetAcceptHeader(string)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: OpenSearch.Client
    Assembly: OpenSearch.Client.dll
    Syntax
    public class CreateRepositoryDescriptor : RequestDescriptorBase<CreateRepositoryDescriptor, CreateRepositoryRequestParameters, ICreateRepositoryRequest>, IDescriptor, ICreateRepositoryRequest, IRequest<CreateRepositoryRequestParameters>, IRequest

    Constructors

    | Edit this page View Source

    CreateRepositoryDescriptor()

    Used for serialization purposes, making sure we have a parameterless constructor

    Declaration
    protected CreateRepositoryDescriptor()
    | Edit this page View Source

    CreateRepositoryDescriptor(Name)

    /_snapshot/{repository}

    Declaration
    public CreateRepositoryDescriptor(Name repository)
    Parameters
    Type Name Description
    Name repository

    this parameter is required

    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 CreateRepositoryDescriptor Azure(Func<AzureRepositoryDescriptor, IAzureRepository> selector = null)
    Parameters
    Type Name Description
    Func<AzureRepositoryDescriptor, IAzureRepository> selector
    Returns
    Type Description
    CreateRepositoryDescriptor
    | Edit this page View Source

    ClusterManagerTimeout(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 CreateRepositoryDescriptor ClusterManagerTimeout(Time clustermanagertimeout)
    Parameters
    Type Name Description
    Time clustermanagertimeout
    Returns
    Type Description
    CreateRepositoryDescriptor
    Remarks

    Supported by OpenSearch servers of version 2.0.0 or greater.

    | Edit this page View Source

    Custom(ISnapshotRepository)

    Register a custom repository

    Declaration
    public CreateRepositoryDescriptor Custom(ISnapshotRepository repository)
    Parameters
    Type Name Description
    ISnapshotRepository repository
    Returns
    Type Description
    CreateRepositoryDescriptor
    | 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 CreateRepositoryDescriptor FileSystem(Func<FileSystemRepositoryDescriptor, IFileSystemRepository> selector)
    Parameters
    Type Name Description
    Func<FileSystemRepositoryDescriptor, IFileSystemRepository> selector
    Returns
    Type Description
    CreateRepositoryDescriptor
    | 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 CreateRepositoryDescriptor Hdfs(Func<HdfsRepositoryDescriptor, IHdfsRepository> selector)
    Parameters
    Type Name Description
    Func<HdfsRepositoryDescriptor, IHdfsRepository> selector
    Returns
    Type Description
    CreateRepositoryDescriptor
    | Edit this page View Source

    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 CreateRepositoryDescriptor MasterTimeout(Time mastertimeout)
    Parameters
    Type Name Description
    Time mastertimeout
    Returns
    Type Description
    CreateRepositoryDescriptor
    | 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 CreateRepositoryDescriptor ReadOnlyUrl(Func<ReadOnlyUrlRepositoryDescriptor, IReadOnlyUrlRepository> selector)
    Parameters
    Type Name Description
    Func<ReadOnlyUrlRepositoryDescriptor, IReadOnlyUrlRepository> selector
    Returns
    Type Description
    CreateRepositoryDescriptor
    | 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 CreateRepositoryDescriptor S3(Func<S3RepositoryDescriptor, IS3Repository> selector)
    Parameters
    Type Name Description
    Func<S3RepositoryDescriptor, IS3Repository> selector
    Returns
    Type Description
    CreateRepositoryDescriptor
    | Edit this page View Source

    SourceOnly(Func<SourceOnlyRepositoryDescriptor, ISourceOnlyRepository>)

    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.

    Declaration
    public CreateRepositoryDescriptor SourceOnly(Func<SourceOnlyRepositoryDescriptor, ISourceOnlyRepository> selector)
    Parameters
    Type Name Description
    Func<SourceOnlyRepositoryDescriptor, ISourceOnlyRepository> selector
    Returns
    Type Description
    CreateRepositoryDescriptor
    | Edit this page View Source

    Timeout(Time)

    The amount of time to wait for a response.

    Declaration
    public CreateRepositoryDescriptor Timeout(Time timeout)
    Parameters
    Type Name Description
    Time timeout
    Returns
    Type Description
    CreateRepositoryDescriptor
    | Edit this page View Source

    Verify(bool?)

    When true, verifies the creation of the snapshot repository.

    Declaration
    public CreateRepositoryDescriptor Verify(bool? verify = true)
    Parameters
    Type Name Description
    bool? verify
    Returns
    Type Description
    CreateRepositoryDescriptor

    Implements

    IDescriptor
    ICreateRepositoryRequest
    IRequest<TParameters>
    IRequest

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Constructors
      • CreateRepositoryDescriptor()
      • CreateRepositoryDescriptor(Name)
    • Methods
      • Azure(Func<AzureRepositoryDescriptor, IAzureRepository>)
      • ClusterManagerTimeout(Time)
      • Custom(ISnapshotRepository)
      • FileSystem(Func<FileSystemRepositoryDescriptor, IFileSystemRepository>)
      • Hdfs(Func<HdfsRepositoryDescriptor, IHdfsRepository>)
      • MasterTimeout(Time)
      • ReadOnlyUrl(Func<ReadOnlyUrlRepositoryDescriptor, IReadOnlyUrlRepository>)
      • S3(Func<S3RepositoryDescriptor, IS3Repository>)
      • SourceOnly(Func<SourceOnlyRepositoryDescriptor, ISourceOnlyRepository>)
      • Timeout(Time)
      • Verify(bool?)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX