Couchbase .NET SDK | 3.7.2
Search Results for

    Show / Hide Table of Contents

    Class DocumentFragment<TDocument>

    Represents one more fragments of a document that is returned by the sub-document API.

    Inheritance
    object
    OperationResult
    DocumentFragment<TDocument>
    Implements
    IDocumentFragment<TDocument>
    IOperationResult<TDocument>
    IDocumentFragment
    IOperationResult
    IResult
    ITypeSerializerProvider
    Inherited Members
    OperationResult.Success
    OperationResult.Message
    OperationResult.Token
    OperationResult.Cas
    OperationResult.Status
    OperationResult.Durability
    OperationResult.Exception
    OperationResult.ShouldRetry()
    OperationResult.IsNmv()
    OperationResult.Id
    OperationResult.OpCode
    OperationResult.ToString()
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Couchbase.Core.IO.Operations.SubDocument
    Assembly: Couchbase.NetClient.dll
    Syntax
    [Obsolete("This class is not required and will be removed in a future release.")]
    public class DocumentFragment<TDocument> : OperationResult, IDocumentFragment<TDocument>, IOperationResult<TDocument>, IDocumentFragment, IOperationResult, IResult, ITypeSerializerProvider
    Type Parameters
    Name Description
    TDocument

    The document

    Constructors

    | Edit this page View Source

    DocumentFragment(ITypeSerializerProvider)

    Declaration
    public DocumentFragment(ITypeSerializerProvider sourceTypeSerializerProvider)
    Parameters
    Type Name Description
    ITypeSerializerProvider sourceTypeSerializerProvider

    Properties

    | Edit this page View Source

    Expiry

    The time-to-live or TTL for the document before it's evicted from disk in milliseconds.

    Declaration
    public uint Expiry { get; set; }
    Property Value
    Type Description
    uint
    Remarks

    Setting this to zero or less will give the document infinite lifetime

    | Edit this page View Source

    Serializer

    Gets the ITypeSerializer related to the object.

    Declaration
    public ITypeSerializer Serializer { get; }
    Property Value
    Type Description
    ITypeSerializer

    Methods

    | Edit this page View Source

    Content(int)

    The value if it exists for a specific index.

    Declaration
    public object Content(int index)
    Parameters
    Type Name Description
    int index

    The ordinal of the operation to retrieve the value from.

    Returns
    Type Description
    object

    An object representing the result of a operation.

    Remarks

    If no value exists, the default value for the Type will be returned.

    | Edit this page View Source

    Content(string)

    The value if it exists for a specific path.

    Declaration
    public object Content(string path)
    Parameters
    Type Name Description
    string path

    The path of the operation to retrieve the value from.

    Returns
    Type Description
    object

    An object representing the result of a operation.

    Remarks

    If no value exists, the default value (null) for the object will be returned.

    | Edit this page View Source

    Content<TContent>(int)

    The value if it exists for a specific index.

    Declaration
    public TContent Content<TContent>(int index)
    Parameters
    Type Name Description
    int index

    The ordinal of the operation to retrieve the value from.

    Returns
    Type Description
    TContent

    An object of type Type representing the value of the operation.

    Type Parameters
    Name Description
    TContent

    The Type to cast the value to.

    Remarks

    If no value exists, the default value for the Type will be returned.

    | Edit this page View Source

    Content<TContent>(string)

    The value if it exists for a specific path.

    Declaration
    public TContent Content<TContent>(string path)
    Parameters
    Type Name Description
    string path

    The path of the operation to retrieve the value from.

    Returns
    Type Description
    TContent

    An object of type Type representing the value of the operation.

    Type Parameters
    Name Description
    TContent

    The Type to cast the value to.

    Remarks

    If no value exists, the default value for the Type will be returned.

    | Edit this page View Source

    Count()

    The count of the sub-document operations chained togather.

    Declaration
    public int Count()
    Returns
    Type Description
    int

    An int that is the count of the total operations chained togather.

    | Edit this page View Source

    Exists(string)

    Checks whether the given path is part of this result set, eg. an operation targeted it, and the operation executed successfully.

    Declaration
    public bool Exists(string path)
    Parameters
    Type Name Description
    string path

    The path for the sub-document operation.

    Returns
    Type Description
    bool

    true if that path is part of the successful result set, false in any other case.

    | Edit this page View Source

    OpStatus(int)

    Gets the ResponseStatus for a specific operation at it's index.

    Declaration
    public ResponseStatus OpStatus(int index)
    Parameters
    Type Name Description
    int index

    The ordinal of the operation.

    Returns
    Type Description
    ResponseStatus

    The ResponseStatus that the server returned.

    | Edit this page View Source

    OpStatus(string)

    Gets the ResponseStatus for a specific operation at it's path.

    Declaration
    public ResponseStatus OpStatus(string path)
    Parameters
    Type Name Description
    string path

    The path of the operation.

    Returns
    Type Description
    ResponseStatus

    The ResponseStatus that the server returned.

    Implements

    IDocumentFragment<TDocument>
    IOperationResult<T>
    IDocumentFragment
    IOperationResult
    IResult
    ITypeSerializerProvider
    • Edit this page
    • View Source
    In this article
    Back to top © 2025 Couchbase, Inc.