Search Results for

    Show / Hide Table of Contents

    Class BulkResponseItemBase

    An item within a bulk response

    Inheritance
    object
    BulkResponseItemBase
    BulkCreateResponseItem
    BulkDeleteResponseItem
    BulkIndexResponseItem
    BulkUpdateResponseItem
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: OpenSearch.Client
    Assembly: OpenSearch.Client.dll
    Syntax
    public abstract class BulkResponseItemBase

    Properties

    | Edit this page View Source

    Error

    The error associated with the bulk operation

    Declaration
    [DataMember(Name = "error")]
    public Error Error { get; }
    Property Value
    Type Description
    Error
    | Edit this page View Source

    Id

    The id of the document for the bulk operation

    Declaration
    [DataMember(Name = "_id")]
    public string Id { get; }
    Property Value
    Type Description
    string
    | Edit this page View Source

    Index

    The index against which the bulk operation ran

    Declaration
    [DataMember(Name = "_index")]
    public string Index { get; }
    Property Value
    Type Description
    string
    | Edit this page View Source

    IsValid

    Specifies whether this particular bulk operation succeeded or not

    Declaration
    public bool IsValid { get; }
    Property Value
    Type Description
    bool
    | Edit this page View Source

    Operation

    The type of bulk operation

    Declaration
    public abstract string Operation { get; }
    Property Value
    Type Description
    string
    | Edit this page View Source

    PrimaryTerm

    Declaration
    [DataMember(Name = "_primary_term")]
    public long PrimaryTerm { get; }
    Property Value
    Type Description
    long
    | Edit this page View Source

    Result

    The result of the bulk operation

    Declaration
    [DataMember(Name = "result")]
    public string Result { get; }
    Property Value
    Type Description
    string
    | Edit this page View Source

    SequenceNumber

    Declaration
    [DataMember(Name = "_seq_no")]
    public long SequenceNumber { get; }
    Property Value
    Type Description
    long
    | Edit this page View Source

    Shards

    The shards associated with the bulk operation

    Declaration
    [DataMember(Name = "_shards")]
    public ShardStatistics Shards { get; }
    Property Value
    Type Description
    ShardStatistics
    | Edit this page View Source

    Status

    The status of the bulk operation

    Declaration
    [DataMember(Name = "status")]
    public int Status { get; }
    Property Value
    Type Description
    int
    | Edit this page View Source

    Type

    The type against which the bulk operation ran

    Declaration
    [DataMember(Name = "_type")]
    public string Type { get; }
    Property Value
    Type Description
    string
    Remarks

    Deprecated as of OpenSearch 2.0

    | Edit this page View Source

    Version

    The version of the document

    Declaration
    [DataMember(Name = "_version")]
    public long Version { get; }
    Property Value
    Type Description
    long

    Methods

    | Edit this page View Source

    GetResponse<TDocument>()

    Deserialize the OpenSearch.Client.BulkResponseItemBase.Get property as a GetResponse<TDocument>() type, where TDocument is the document type.

    Declaration
    public GetResponse<TDocument> GetResponse<TDocument>() where TDocument : class
    Returns
    Type Description
    GetResponse<TDocument>
    Type Parameters
    Name Description
    TDocument
    | Edit this page View Source

    ToString()

    Declaration
    public override string ToString()
    Returns
    Type Description
    string
    Overrides
    object.ToString()

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Properties
      • Error
      • Id
      • Index
      • IsValid
      • Operation
      • PrimaryTerm
      • Result
      • SequenceNumber
      • Shards
      • Status
      • Type
      • Version
    • Methods
      • GetResponse<TDocument>()
      • ToString()
    • Extension Methods
    Back to top Generated by DocFX