Search Results for

    Show / Hide Table of Contents

    Class LowLevelWlmNamespace

    Wlm APIs.

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

    Inheritance
    object
    NamespacedClientProxy
    LowLevelWlmNamespace
    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.WlmApi
    Assembly: OpenSearch.Net.dll
    Syntax
    public class LowLevelWlmNamespace : NamespacedClientProxy

    Methods

    | Edit this page View Source

    CreateQueryGroupAsync<TResponse>(PostData, CreateQueryGroupRequestParameters, CancellationToken)

    PUT on /_wlm/query_group

    Declaration
    public Task<TResponse> CreateQueryGroupAsync<TResponse>(PostData body, CreateQueryGroupRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    PostData body
    CreateQueryGroupRequestParameters 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 2.17.0 or greater.

    | Edit this page View Source

    CreateQueryGroup<TResponse>(PostData, CreateQueryGroupRequestParameters)

    PUT on /_wlm/query_group

    Declaration
    public TResponse CreateQueryGroup<TResponse>(PostData body, CreateQueryGroupRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    PostData body
    CreateQueryGroupRequestParameters 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 2.17.0 or greater.

    | Edit this page View Source

    DeleteQueryGroupAsync<TResponse>(string, DeleteQueryGroupRequestParameters, CancellationToken)

    DELETE on /_wlm/query_group/{name}

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

    The name of the query group.

    DeleteQueryGroupRequestParameters 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 2.17.0 or greater.

    | Edit this page View Source

    DeleteQueryGroup<TResponse>(string, DeleteQueryGroupRequestParameters)

    DELETE on /_wlm/query_group/{name}

    Declaration
    public TResponse DeleteQueryGroup<TResponse>(string name, DeleteQueryGroupRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string name

    The name of the query group.

    DeleteQueryGroupRequestParameters 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 2.17.0 or greater.

    | Edit this page View Source

    GetQueryGroupAsync<TResponse>(GetQueryGroupRequestParameters, CancellationToken)

    GET on /_wlm/query_group

    Declaration
    public Task<TResponse> GetQueryGroupAsync<TResponse>(GetQueryGroupRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    GetQueryGroupRequestParameters 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 2.17.0 or greater.

    | Edit this page View Source

    GetQueryGroupAsync<TResponse>(string, GetQueryGroupRequestParameters, CancellationToken)

    GET on /_wlm/query_group/{name}

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

    The name of the query group.

    GetQueryGroupRequestParameters 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 2.17.0 or greater.

    | Edit this page View Source

    GetQueryGroup<TResponse>(GetQueryGroupRequestParameters)

    GET on /_wlm/query_group

    Declaration
    public TResponse GetQueryGroup<TResponse>(GetQueryGroupRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    GetQueryGroupRequestParameters 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 2.17.0 or greater.

    | Edit this page View Source

    GetQueryGroup<TResponse>(string, GetQueryGroupRequestParameters)

    GET on /_wlm/query_group/{name}

    Declaration
    public TResponse GetQueryGroup<TResponse>(string name, GetQueryGroupRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string name

    The name of the query group.

    GetQueryGroupRequestParameters 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 2.17.0 or greater.

    | Edit this page View Source

    UpdateQueryGroupAsync<TResponse>(string, PostData, UpdateQueryGroupRequestParameters, CancellationToken)

    PUT on /_wlm/query_group/{name}

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

    The name of the query group.

    PostData body
    UpdateQueryGroupRequestParameters 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 2.17.0 or greater.

    | Edit this page View Source

    UpdateQueryGroup<TResponse>(string, PostData, UpdateQueryGroupRequestParameters)

    PUT on /_wlm/query_group/{name}

    Declaration
    public TResponse UpdateQueryGroup<TResponse>(string name, PostData body, UpdateQueryGroupRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string name

    The name of the query group.

    PostData body
    UpdateQueryGroupRequestParameters 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 2.17.0 or greater.

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Methods
      • CreateQueryGroupAsync<TResponse>(PostData, CreateQueryGroupRequestParameters, CancellationToken)
      • CreateQueryGroup<TResponse>(PostData, CreateQueryGroupRequestParameters)
      • DeleteQueryGroupAsync<TResponse>(string, DeleteQueryGroupRequestParameters, CancellationToken)
      • DeleteQueryGroup<TResponse>(string, DeleteQueryGroupRequestParameters)
      • GetQueryGroupAsync<TResponse>(GetQueryGroupRequestParameters, CancellationToken)
      • GetQueryGroupAsync<TResponse>(string, GetQueryGroupRequestParameters, CancellationToken)
      • GetQueryGroup<TResponse>(GetQueryGroupRequestParameters)
      • GetQueryGroup<TResponse>(string, GetQueryGroupRequestParameters)
      • UpdateQueryGroupAsync<TResponse>(string, PostData, UpdateQueryGroupRequestParameters, CancellationToken)
      • UpdateQueryGroup<TResponse>(string, PostData, UpdateQueryGroupRequestParameters)
    • Extension Methods
    Back to top Generated by DocFX