Search Results for

    Show / Hide Table of Contents

    Interface IDeleteByQueryRequest

    Delete documents that match a given query

    Inherited Members
    IRequest<DeleteByQueryRequestParameters>.RequestParameters
    IRequest.ContentType
    IRequest.HttpMethod
    IRequest.RouteValues
    IRequest.GetUrl(IConnectionSettingsValues)
    Namespace: OpenSearch.Client
    Assembly: OpenSearch.Client.dll
    Syntax
    public interface IDeleteByQueryRequest : IRequest<DeleteByQueryRequestParameters>, IRequest

    Properties

    | Edit this page View Source

    Index

    Declaration
    [IgnoreDataMember]
    Indices Index { get; }
    Property Value
    Type Description
    Indices
    | Edit this page View Source

    MaximumDocuments

    Limit the number of processed documents

    Declaration
    [DataMember(Name = "max_docs")]
    long? MaximumDocuments { get; set; }
    Property Value
    Type Description
    long?
    | Edit this page View Source

    Query

    The query to use to select documents for deletion

    Declaration
    [DataMember(Name = "query")]
    QueryContainer Query { get; set; }
    Property Value
    Type Description
    QueryContainer
    | Edit this page View Source

    Slice

    Parallelize the deleting process. This parallelization can improve efficiency and provide a convenient way to break the request down into smaller parts.

    Declaration
    [DataMember(Name = "slice")]
    ISlicedScroll Slice { get; set; }
    Property Value
    Type Description
    ISlicedScroll

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Properties
      • Index
      • MaximumDocuments
      • Query
      • Slice
    • Extension Methods
    Back to top Generated by DocFX