Search Results for

    Show / Hide Table of Contents

    Class LowLevelReplicationNamespace

    Replication APIs.

    Not intended to be instantiated directly. Use the Replication property on IOpenSearchLowLevelClient.

    Inheritance
    object
    NamespacedClientProxy
    LowLevelReplicationNamespace
    Inherited Members
    NamespacedClientProxy.DoRequest<TResponse>(HttpMethod, string, PostData, IRequestParameters)
    NamespacedClientProxy.DoRequestAsync<TResponse>(HttpMethod, string, CancellationToken, PostData, IRequestParameters)
    NamespacedClientProxy.Url(FormattableString)
    NamespacedClientProxy.RequestParams<TRequestParams>(TRequestParams, string)
    NamespacedClientProxy.RequestParams<TRequestParams>(TRequestParams)
    NamespacedClientProxy.ContentType
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: OpenSearch.Net.Specification.ReplicationApi
    Assembly: OpenSearch.Net.dll
    Syntax
    public class LowLevelReplicationNamespace : NamespacedClientProxy

    Methods

    | Edit this page View Source

    AutofollowStatsAsync<TResponse>(AutofollowStatsRequestParameters, CancellationToken)

    GET on /_plugins/_replication/autofollow_stats

    https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#get-auto-follow-stats

    Declaration
    public Task<TResponse> AutofollowStatsAsync<TResponse>(AutofollowStatsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    AutofollowStatsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 1.1.0 or greater.

    | Edit this page View Source

    AutofollowStats<TResponse>(AutofollowStatsRequestParameters)

    GET on /_plugins/_replication/autofollow_stats

    https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#get-auto-follow-stats

    Declaration
    public TResponse AutofollowStats<TResponse>(AutofollowStatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    AutofollowStatsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 1.1.0 or greater.

    | Edit this page View Source

    CreateRuleAsync<TResponse>(PostData, CreateReplicationRuleRequestParameters, CancellationToken)

    POST on /_plugins/_replication/_autofollow

    https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#create-replication-rule

    Declaration
    public Task<TResponse> CreateRuleAsync<TResponse>(PostData body, CreateReplicationRuleRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    PostData body
    CreateReplicationRuleRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 1.1.0 or greater.

    | Edit this page View Source

    CreateRule<TResponse>(PostData, CreateReplicationRuleRequestParameters)

    POST on /_plugins/_replication/_autofollow

    https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#create-replication-rule

    Declaration
    public TResponse CreateRule<TResponse>(PostData body, CreateReplicationRuleRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    PostData body
    CreateReplicationRuleRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 1.1.0 or greater.

    | Edit this page View Source

    DeleteRuleAsync<TResponse>(PostData, DeleteReplicationRuleRequestParameters, CancellationToken)

    DELETE on /_plugins/_replication/_autofollow

    https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#delete-replication-rule

    Declaration
    public Task<TResponse> DeleteRuleAsync<TResponse>(PostData body, DeleteReplicationRuleRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    PostData body
    DeleteReplicationRuleRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 1.1.0 or greater.

    | Edit this page View Source

    DeleteRule<TResponse>(PostData, DeleteReplicationRuleRequestParameters)

    DELETE on /_plugins/_replication/_autofollow

    https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#delete-replication-rule

    Declaration
    public TResponse DeleteRule<TResponse>(PostData body, DeleteReplicationRuleRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    PostData body
    DeleteReplicationRuleRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 1.1.0 or greater.

    | Edit this page View Source

    FollowerStatsAsync<TResponse>(FollowerStatsRequestParameters, CancellationToken)

    GET on /_plugins/_replication/follower_stats

    https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#get-follower-cluster-stats

    Declaration
    public Task<TResponse> FollowerStatsAsync<TResponse>(FollowerStatsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    FollowerStatsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 1.1.0 or greater.

    | Edit this page View Source

    FollowerStats<TResponse>(FollowerStatsRequestParameters)

    GET on /_plugins/_replication/follower_stats

    https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#get-follower-cluster-stats

    Declaration
    public TResponse FollowerStats<TResponse>(FollowerStatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    FollowerStatsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 1.1.0 or greater.

    | Edit this page View Source

    LeaderStatsAsync<TResponse>(LeaderStatsRequestParameters, CancellationToken)

    GET on /_plugins/_replication/leader_stats

    https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#get-leader-cluster-stats

    Declaration
    public Task<TResponse> LeaderStatsAsync<TResponse>(LeaderStatsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    LeaderStatsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 1.1.0 or greater.

    | Edit this page View Source

    LeaderStats<TResponse>(LeaderStatsRequestParameters)

    GET on /_plugins/_replication/leader_stats

    https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#get-leader-cluster-stats

    Declaration
    public TResponse LeaderStats<TResponse>(LeaderStatsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    LeaderStatsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 1.1.0 or greater.

    | Edit this page View Source

    PauseAsync<TResponse>(string, PostData, PauseRequestParameters, CancellationToken)

    POST on /_plugins/_replication/{index}/_pause

    https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#pause-replication

    Declaration
    public Task<TResponse> PauseAsync<TResponse>(string index, PostData body, PauseRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string index

    The name of the data stream, index, or index alias to perform bulk actions on.

    PostData body
    PauseRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 1.1.0 or greater.

    | Edit this page View Source

    Pause<TResponse>(string, PostData, PauseRequestParameters)

    POST on /_plugins/_replication/{index}/_pause

    https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#pause-replication

    Declaration
    public TResponse Pause<TResponse>(string index, PostData body, PauseRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string index

    The name of the data stream, index, or index alias to perform bulk actions on.

    PostData body
    PauseRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 1.1.0 or greater.

    | Edit this page View Source

    ResumeAsync<TResponse>(string, PostData, ResumeRequestParameters, CancellationToken)

    POST on /_plugins/_replication/{index}/_resume

    https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#resume-replication

    Declaration
    public Task<TResponse> ResumeAsync<TResponse>(string index, PostData body, ResumeRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string index

    The name of the data stream, index, or index alias to perform bulk actions on.

    PostData body
    ResumeRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 1.1.0 or greater.

    | Edit this page View Source

    Resume<TResponse>(string, PostData, ResumeRequestParameters)

    POST on /_plugins/_replication/{index}/_resume

    https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#resume-replication

    Declaration
    public TResponse Resume<TResponse>(string index, PostData body, ResumeRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string index

    The name of the data stream, index, or index alias to perform bulk actions on.

    PostData body
    ResumeRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 1.1.0 or greater.

    | Edit this page View Source

    StartAsync<TResponse>(string, PostData, StartRequestParameters, CancellationToken)

    PUT on /_plugins/_replication/{index}/_start

    https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#start-replication

    Declaration
    public Task<TResponse> StartAsync<TResponse>(string index, PostData body, StartRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string index

    The name of the data stream, index, or index alias to perform bulk actions on.

    PostData body
    StartRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 1.1.0 or greater.

    | Edit this page View Source

    Start<TResponse>(string, PostData, StartRequestParameters)

    PUT on /_plugins/_replication/{index}/_start

    https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#start-replication

    Declaration
    public TResponse Start<TResponse>(string index, PostData body, StartRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string index

    The name of the data stream, index, or index alias to perform bulk actions on.

    PostData body
    StartRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 1.1.0 or greater.

    | Edit this page View Source

    StatusAsync<TResponse>(string, StatusRequestParameters, CancellationToken)

    GET on /_plugins/_replication/{index}/_status

    https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#get-replication-status

    Declaration
    public Task<TResponse> StatusAsync<TResponse>(string index, StatusRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string index

    The name of the data stream, index, or index alias to perform bulk actions on.

    StatusRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 1.1.0 or greater.

    | Edit this page View Source

    Status<TResponse>(string, StatusRequestParameters)

    GET on /_plugins/_replication/{index}/_status

    https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#get-replication-status

    Declaration
    public TResponse Status<TResponse>(string index, StatusRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string index

    The name of the data stream, index, or index alias to perform bulk actions on.

    StatusRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 1.1.0 or greater.

    | Edit this page View Source

    StopAsync<TResponse>(string, PostData, StopRequestParameters, CancellationToken)

    POST on /_plugins/_replication/{index}/_stop

    https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#stop-replication

    Declaration
    public Task<TResponse> StopAsync<TResponse>(string index, PostData body, StopRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string index

    The name of the data stream, index, or index alias to perform bulk actions on.

    PostData body
    StopRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 1.1.0 or greater.

    | Edit this page View Source

    Stop<TResponse>(string, PostData, StopRequestParameters)

    POST on /_plugins/_replication/{index}/_stop

    https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#stop-replication

    Declaration
    public TResponse Stop<TResponse>(string index, PostData body, StopRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string index

    The name of the data stream, index, or index alias to perform bulk actions on.

    PostData body
    StopRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 1.1.0 or greater.

    | Edit this page View Source

    UpdateSettingsAsync<TResponse>(string, PostData, UpdateSettingsRequestParameters, CancellationToken)

    PUT on /_plugins/_replication/{index}/_update

    https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#update-settings

    Declaration
    public Task<TResponse> UpdateSettingsAsync<TResponse>(string index, PostData body, UpdateSettingsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string index

    The name of the data stream, index, or index alias to perform bulk actions on.

    PostData body
    UpdateSettingsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    CancellationToken ctx
    Returns
    Type Description
    Task<TResponse>
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 1.1.0 or greater.

    | Edit this page View Source

    UpdateSettings<TResponse>(string, PostData, UpdateSettingsRequestParameters)

    PUT on /_plugins/_replication/{index}/_update

    https://opensearch.org/docs/latest/tuning-your-cluster/replication-plugin/api/#update-settings

    Declaration
    public TResponse UpdateSettings<TResponse>(string index, PostData body, UpdateSettingsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string index

    The name of the data stream, index, or index alias to perform bulk actions on.

    PostData body
    UpdateSettingsRequestParameters requestParameters

    Request specific configuration such as querystring parameters & request specific connection settings.

    Returns
    Type Description
    TResponse
    Type Parameters
    Name Description
    TResponse
    Remarks

    Supported by OpenSearch servers of version 1.1.0 or greater.

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Methods
      • AutofollowStatsAsync<TResponse>(AutofollowStatsRequestParameters, CancellationToken)
      • AutofollowStats<TResponse>(AutofollowStatsRequestParameters)
      • CreateRuleAsync<TResponse>(PostData, CreateReplicationRuleRequestParameters, CancellationToken)
      • CreateRule<TResponse>(PostData, CreateReplicationRuleRequestParameters)
      • DeleteRuleAsync<TResponse>(PostData, DeleteReplicationRuleRequestParameters, CancellationToken)
      • DeleteRule<TResponse>(PostData, DeleteReplicationRuleRequestParameters)
      • FollowerStatsAsync<TResponse>(FollowerStatsRequestParameters, CancellationToken)
      • FollowerStats<TResponse>(FollowerStatsRequestParameters)
      • LeaderStatsAsync<TResponse>(LeaderStatsRequestParameters, CancellationToken)
      • LeaderStats<TResponse>(LeaderStatsRequestParameters)
      • PauseAsync<TResponse>(string, PostData, PauseRequestParameters, CancellationToken)
      • Pause<TResponse>(string, PostData, PauseRequestParameters)
      • ResumeAsync<TResponse>(string, PostData, ResumeRequestParameters, CancellationToken)
      • Resume<TResponse>(string, PostData, ResumeRequestParameters)
      • StartAsync<TResponse>(string, PostData, StartRequestParameters, CancellationToken)
      • Start<TResponse>(string, PostData, StartRequestParameters)
      • StatusAsync<TResponse>(string, StatusRequestParameters, CancellationToken)
      • Status<TResponse>(string, StatusRequestParameters)
      • StopAsync<TResponse>(string, PostData, StopRequestParameters, CancellationToken)
      • Stop<TResponse>(string, PostData, StopRequestParameters)
      • UpdateSettingsAsync<TResponse>(string, PostData, UpdateSettingsRequestParameters, CancellationToken)
      • UpdateSettings<TResponse>(string, PostData, UpdateSettingsRequestParameters)
    • Extension Methods
    Back to top Generated by DocFX