Search Results for

    Show / Hide Table of Contents

    Class LowLevelObservabilityNamespace

    Observability APIs.

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

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

    Methods

    | Edit this page View Source

    CreateObjectAsync<TResponse>(PostData, CreateObjectRequestParameters, CancellationToken)

    POST on /_plugins/_observability/object

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

    The core observability object containing visualization and query data.

    CreateObjectRequestParameters 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

    CreateObject<TResponse>(PostData, CreateObjectRequestParameters)

    POST on /_plugins/_observability/object

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

    The core observability object containing visualization and query data.

    CreateObjectRequestParameters 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

    DeleteObjectAsync<TResponse>(string, DeleteObjectRequestParameters, CancellationToken)

    DELETE on /_plugins/_observability/object/{object_id}

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

    The ID of the observability object to delete.

    DeleteObjectRequestParameters 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

    DeleteObject<TResponse>(string, DeleteObjectRequestParameters)

    DELETE on /_plugins/_observability/object/{object_id}

    Declaration
    public TResponse DeleteObject<TResponse>(string objectId, DeleteObjectRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string objectId

    The ID of the observability object to delete.

    DeleteObjectRequestParameters 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

    DeleteObjectsAsync<TResponse>(DeleteObjectsRequestParameters, CancellationToken)

    DELETE on /_plugins/_observability/object

    Declaration
    public Task<TResponse> DeleteObjectsAsync<TResponse>(DeleteObjectsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    DeleteObjectsRequestParameters 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

    DeleteObjects<TResponse>(DeleteObjectsRequestParameters)

    DELETE on /_plugins/_observability/object

    Declaration
    public TResponse DeleteObjects<TResponse>(DeleteObjectsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    DeleteObjectsRequestParameters 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

    GetLocalstatsAsync<TResponse>(GetLocalstatsRequestParameters, CancellationToken)

    GET on /_plugins/_observability/_local/stats

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

    | Edit this page View Source

    GetLocalstats<TResponse>(GetLocalstatsRequestParameters)

    GET on /_plugins/_observability/_local/stats

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

    | Edit this page View Source

    GetObjectAsync<TResponse>(string, GetObjectRequestParameters, CancellationToken)

    GET on /_plugins/_observability/object/{object_id}

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

    The ID of the observability object to retrieve.

    GetObjectRequestParameters 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

    GetObject<TResponse>(string, GetObjectRequestParameters)

    GET on /_plugins/_observability/object/{object_id}

    Declaration
    public TResponse GetObject<TResponse>(string objectId, GetObjectRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string objectId

    The ID of the observability object to retrieve.

    GetObjectRequestParameters 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

    ListObjectsAsync<TResponse>(ListObjectsRequestParameters, CancellationToken)

    GET on /_plugins/_observability/object

    Declaration
    public Task<TResponse> ListObjectsAsync<TResponse>(ListObjectsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    ListObjectsRequestParameters 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

    ListObjects<TResponse>(ListObjectsRequestParameters)

    GET on /_plugins/_observability/object

    Declaration
    public TResponse ListObjects<TResponse>(ListObjectsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    ListObjectsRequestParameters 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

    UpdateObjectAsync<TResponse>(string, PostData, UpdateObjectRequestParameters, CancellationToken)

    PUT on /_plugins/_observability/object/{object_id}

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

    The ID of the observability object to update.

    PostData body

    The core observability object containing visualization and query data.

    UpdateObjectRequestParameters 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

    UpdateObject<TResponse>(string, PostData, UpdateObjectRequestParameters)

    PUT on /_plugins/_observability/object/{object_id}

    Declaration
    public TResponse UpdateObject<TResponse>(string objectId, PostData body, UpdateObjectRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()
    Parameters
    Type Name Description
    string objectId

    The ID of the observability object to update.

    PostData body

    The core observability object containing visualization and query data.

    UpdateObjectRequestParameters 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
      • CreateObjectAsync<TResponse>(PostData, CreateObjectRequestParameters, CancellationToken)
      • CreateObject<TResponse>(PostData, CreateObjectRequestParameters)
      • DeleteObjectAsync<TResponse>(string, DeleteObjectRequestParameters, CancellationToken)
      • DeleteObject<TResponse>(string, DeleteObjectRequestParameters)
      • DeleteObjectsAsync<TResponse>(DeleteObjectsRequestParameters, CancellationToken)
      • DeleteObjects<TResponse>(DeleteObjectsRequestParameters)
      • GetLocalstatsAsync<TResponse>(GetLocalstatsRequestParameters, CancellationToken)
      • GetLocalstats<TResponse>(GetLocalstatsRequestParameters)
      • GetObjectAsync<TResponse>(string, GetObjectRequestParameters, CancellationToken)
      • GetObject<TResponse>(string, GetObjectRequestParameters)
      • ListObjectsAsync<TResponse>(ListObjectsRequestParameters, CancellationToken)
      • ListObjects<TResponse>(ListObjectsRequestParameters)
      • UpdateObjectAsync<TResponse>(string, PostData, UpdateObjectRequestParameters, CancellationToken)
      • UpdateObject<TResponse>(string, PostData, UpdateObjectRequestParameters)
    • Extension Methods
    Back to top Generated by DocFX