Search Results for

    Show / Hide Table of Contents

    Class UpdateResponse<TDocument>

    Inheritance
    object
    ResponseBase
    WriteResponseBase
    UpdateResponse<TDocument>
    Implements
    IUpdateResponse<TDocument>
    IResponse
    IOpenSearchResponse
    Inherited Members
    WriteResponseBase.Id
    WriteResponseBase.Index
    WriteResponseBase.PrimaryTerm
    WriteResponseBase.Result
    WriteResponseBase.SequenceNumber
    WriteResponseBase.Shards
    WriteResponseBase.Type
    WriteResponseBase.Version
    ResponseBase.ApiCall
    ResponseBase.DebugInformation
    ResponseBase.OriginalException
    ResponseBase.ServerError
    ResponseBase.DebugIsValid(StringBuilder)
    ResponseBase.ToString()
    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
    [DataContract]
    public class UpdateResponse<TDocument> : WriteResponseBase, IUpdateResponse<TDocument>, IResponse, IOpenSearchResponse where TDocument : class
    Type Parameters
    Name Description
    TDocument

    Properties

    | Edit this page View Source

    Get

    Declaration
    [DataMember(Name = "get")]
    public IInlineGet<TDocument> Get { get; }
    Property Value
    Type Description
    IInlineGet<TDocument>
    | Edit this page View Source

    IsValid

    Checks if a response is functionally valid or not. This is a OpenSearch.Client abstraction to have a single property to check whether there was something wrong with a request.

    For instance, an OpenSearch bulk response always returns 200 and individual bulk items may fail, IsValid will be false in that case.

    You can also configure the client to always throw an OpenSearchClientException using ThrowExceptions if the response is not valid

    Declaration
    public override bool IsValid { get; }
    Property Value
    Type Description
    bool
    Overrides
    ResponseBase.IsValid

    Implements

    IUpdateResponse<TDocument>
    IResponse
    IOpenSearchResponse

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Properties
      • Get
      • IsValid
    • Implements
    • Extension Methods
    Back to top Generated by DocFX