Search Results for

    Show / Hide Table of Contents

    Class LowLevelNotificationsNamespace

    Notifications APIs.

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

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

    Methods

    | Edit this page View Source

    CreateConfigAsync<TResponse>(PostData, CreateConfigRequestParameters, CancellationToken)

    POST on /_plugins/_notifications/configs

    https://opensearch.org/docs/latest/observing-your-data/notifications/api/#create-channel-configuration

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

    | Edit this page View Source

    CreateConfig<TResponse>(PostData, CreateConfigRequestParameters)

    POST on /_plugins/_notifications/configs

    https://opensearch.org/docs/latest/observing-your-data/notifications/api/#create-channel-configuration

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

    | Edit this page View Source

    DeleteConfigAsync<TResponse>(string, DeleteConfigRequestParameters, CancellationToken)

    DELETE on /_plugins/_notifications/configs/{config_id}

    https://opensearch.org/docs/latest/observing-your-data/notifications/api/#delete-channel-configuration

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

    The ID of the channel configuration to delete.

    DeleteConfigRequestParameters 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.0.0 or greater.

    | Edit this page View Source

    DeleteConfig<TResponse>(string, DeleteConfigRequestParameters)

    DELETE on /_plugins/_notifications/configs/{config_id}

    https://opensearch.org/docs/latest/observing-your-data/notifications/api/#delete-channel-configuration

    Declaration
    public TResponse DeleteConfig<TResponse>(string configId, DeleteConfigRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string configId

    The ID of the channel configuration to delete.

    DeleteConfigRequestParameters 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.0.0 or greater.

    | Edit this page View Source

    DeleteConfigsAsync<TResponse>(DeleteConfigsRequestParameters, CancellationToken)

    DELETE on /_plugins/_notifications/configs

    https://opensearch.org/docs/latest/observing-your-data/notifications/api/#delete-channel-configuration

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

    | Edit this page View Source

    DeleteConfigs<TResponse>(DeleteConfigsRequestParameters)

    DELETE on /_plugins/_notifications/configs

    https://opensearch.org/docs/latest/observing-your-data/notifications/api/#delete-channel-configuration

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

    | Edit this page View Source

    GetConfigAsync<TResponse>(string, GetConfigRequestParameters, CancellationToken)

    GET on /_plugins/_notifications/configs/{config_id}

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

    | Edit this page View Source

    GetConfig<TResponse>(string, GetConfigRequestParameters)

    GET on /_plugins/_notifications/configs/{config_id}

    Declaration
    public TResponse GetConfig<TResponse>(string configId, GetConfigRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string configId
    GetConfigRequestParameters 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.0.0 or greater.

    | Edit this page View Source

    GetConfigsAsync<TResponse>(PostData, GetConfigsRequestParameters, CancellationToken)

    GET on /_plugins/_notifications/configs

    https://opensearch.org/docs/latest/observing-your-data/notifications/api/#list-all-notification-configurations

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

    | Edit this page View Source

    GetConfigs<TResponse>(PostData, GetConfigsRequestParameters)

    GET on /_plugins/_notifications/configs

    https://opensearch.org/docs/latest/observing-your-data/notifications/api/#list-all-notification-configurations

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

    | Edit this page View Source

    ListChannelsAsync<TResponse>(ListChannelsRequestParameters, CancellationToken)

    GET on /_plugins/_notifications/channels

    https://opensearch.org/docs/latest/observing-your-data/notifications/api/#list-all-notification-channels

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

    | Edit this page View Source

    ListChannels<TResponse>(ListChannelsRequestParameters)

    GET on /_plugins/_notifications/channels

    https://opensearch.org/docs/latest/observing-your-data/notifications/api/#list-all-notification-channels

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

    | Edit this page View Source

    ListFeaturesAsync<TResponse>(ListFeaturesRequestParameters, CancellationToken)

    GET on /_plugins/_notifications/features

    https://opensearch.org/docs/latest/observing-your-data/notifications/api/#list-supported-channel-configurations

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

    | Edit this page View Source

    ListFeatures<TResponse>(ListFeaturesRequestParameters)

    GET on /_plugins/_notifications/features

    https://opensearch.org/docs/latest/observing-your-data/notifications/api/#list-supported-channel-configurations

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

    | Edit this page View Source

    SendTestAsync<TResponse>(string, SendTestRequestParameters, CancellationToken)

    POST on /_plugins/_notifications/feature/test/{config_id}

    https://opensearch.org/docs/latest/observing-your-data/notifications/api/#send-test-notification

    Declaration
    [Obsolete("Deprecated in version 2.3.0: Use the POST method instead.")]
    public Task<TResponse> SendTestAsync<TResponse>(string configId, SendTestRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string configId
    SendTestRequestParameters 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.0.0 or greater.

    | Edit this page View Source

    SendTest<TResponse>(string, SendTestRequestParameters)

    POST on /_plugins/_notifications/feature/test/{config_id}

    https://opensearch.org/docs/latest/observing-your-data/notifications/api/#send-test-notification

    Declaration
    [Obsolete("Deprecated in version 2.3.0: Use the POST method instead.")]
    public TResponse SendTest<TResponse>(string configId, SendTestRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string configId
    SendTestRequestParameters 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.0.0 or greater.

    | Edit this page View Source

    UpdateConfigAsync<TResponse>(string, PostData, UpdateConfigRequestParameters, CancellationToken)

    PUT on /_plugins/_notifications/configs/{config_id}

    https://opensearch.org/docs/latest/observing-your-data/notifications/api/#update-channel-configuration

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

    | Edit this page View Source

    UpdateConfig<TResponse>(string, PostData, UpdateConfigRequestParameters)

    PUT on /_plugins/_notifications/configs/{config_id}

    https://opensearch.org/docs/latest/observing-your-data/notifications/api/#update-channel-configuration

    Declaration
    public TResponse UpdateConfig<TResponse>(string configId, PostData body, UpdateConfigRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string configId
    PostData body
    UpdateConfigRequestParameters 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.0.0 or greater.

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Methods
      • CreateConfigAsync<TResponse>(PostData, CreateConfigRequestParameters, CancellationToken)
      • CreateConfig<TResponse>(PostData, CreateConfigRequestParameters)
      • DeleteConfigAsync<TResponse>(string, DeleteConfigRequestParameters, CancellationToken)
      • DeleteConfig<TResponse>(string, DeleteConfigRequestParameters)
      • DeleteConfigsAsync<TResponse>(DeleteConfigsRequestParameters, CancellationToken)
      • DeleteConfigs<TResponse>(DeleteConfigsRequestParameters)
      • GetConfigAsync<TResponse>(string, GetConfigRequestParameters, CancellationToken)
      • GetConfig<TResponse>(string, GetConfigRequestParameters)
      • GetConfigsAsync<TResponse>(PostData, GetConfigsRequestParameters, CancellationToken)
      • GetConfigs<TResponse>(PostData, GetConfigsRequestParameters)
      • ListChannelsAsync<TResponse>(ListChannelsRequestParameters, CancellationToken)
      • ListChannels<TResponse>(ListChannelsRequestParameters)
      • ListFeaturesAsync<TResponse>(ListFeaturesRequestParameters, CancellationToken)
      • ListFeatures<TResponse>(ListFeaturesRequestParameters)
      • SendTestAsync<TResponse>(string, SendTestRequestParameters, CancellationToken)
      • SendTest<TResponse>(string, SendTestRequestParameters)
      • UpdateConfigAsync<TResponse>(string, PostData, UpdateConfigRequestParameters, CancellationToken)
      • UpdateConfig<TResponse>(string, PostData, UpdateConfigRequestParameters)
    • Extension Methods
    Back to top Generated by DocFX