Search Results for

    Show / Hide Table of Contents

    Class BulkUpdateDescriptor<TDocument, TPartialDocument>

    Inheritance
    object
    DescriptorBase<BulkUpdateDescriptor<TDocument, TPartialDocument>, IBulkUpdateOperation<TDocument, TPartialDocument>>
    BulkOperationDescriptorBase<BulkUpdateDescriptor<TDocument, TPartialDocument>, IBulkUpdateOperation<TDocument, TPartialDocument>>
    BulkUpdateDescriptor<TDocument, TPartialDocument>
    Implements
    IDescriptor
    IBulkUpdateOperation<TDocument, TPartialDocument>
    IBulkOperation
    Inherited Members
    BulkOperationDescriptorBase<BulkUpdateDescriptor<TDocument, TPartialDocument>, IBulkUpdateOperation<TDocument, TPartialDocument>>.BulkOperationClrType
    BulkOperationDescriptorBase<BulkUpdateDescriptor<TDocument, TPartialDocument>, IBulkUpdateOperation<TDocument, TPartialDocument>>.BulkOperationType
    BulkOperationDescriptorBase<BulkUpdateDescriptor<TDocument, TPartialDocument>, IBulkUpdateOperation<TDocument, TPartialDocument>>.GetBulkOperationBody()
    BulkOperationDescriptorBase<BulkUpdateDescriptor<TDocument, TPartialDocument>, IBulkUpdateOperation<TDocument, TPartialDocument>>.GetIdForOperation(Inferrer)
    BulkOperationDescriptorBase<BulkUpdateDescriptor<TDocument, TPartialDocument>, IBulkUpdateOperation<TDocument, TPartialDocument>>.GetRoutingForOperation(Inferrer)
    BulkOperationDescriptorBase<BulkUpdateDescriptor<TDocument, TPartialDocument>, IBulkUpdateOperation<TDocument, TPartialDocument>>.Index(IndexName)
    BulkOperationDescriptorBase<BulkUpdateDescriptor<TDocument, TPartialDocument>, IBulkUpdateOperation<TDocument, TPartialDocument>>.Index<T>()
    BulkOperationDescriptorBase<BulkUpdateDescriptor<TDocument, TPartialDocument>, IBulkUpdateOperation<TDocument, TPartialDocument>>.Id(Id)
    BulkOperationDescriptorBase<BulkUpdateDescriptor<TDocument, TPartialDocument>, IBulkUpdateOperation<TDocument, TPartialDocument>>.Version(long?)
    BulkOperationDescriptorBase<BulkUpdateDescriptor<TDocument, TPartialDocument>, IBulkUpdateOperation<TDocument, TPartialDocument>>.VersionType(VersionType?)
    BulkOperationDescriptorBase<BulkUpdateDescriptor<TDocument, TPartialDocument>, IBulkUpdateOperation<TDocument, TPartialDocument>>.Routing(Routing)
    DescriptorBase<BulkUpdateDescriptor<TDocument, TPartialDocument>, IBulkUpdateOperation<TDocument, TPartialDocument>>.Self
    DescriptorBase<BulkUpdateDescriptor<TDocument, TPartialDocument>, IBulkUpdateOperation<TDocument, TPartialDocument>>.Assign<TValue>(TValue, Action<IBulkUpdateOperation<TDocument, TPartialDocument>, TValue>)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: OpenSearch.Client
    Assembly: OpenSearch.Client.dll
    Syntax
    [DataContract]
    public class BulkUpdateDescriptor<TDocument, TPartialDocument> : BulkOperationDescriptorBase<BulkUpdateDescriptor<TDocument, TPartialDocument>, IBulkUpdateOperation<TDocument, TPartialDocument>>, IDescriptor, IBulkUpdateOperation<TDocument, TPartialDocument>, IBulkOperation where TDocument : class where TPartialDocument : class
    Type Parameters
    Name Description
    TDocument
    TPartialDocument

    Properties

    | Edit this page View Source

    BulkOperationClrType

    Declaration
    protected override Type BulkOperationClrType { get; }
    Property Value
    Type Description
    Type
    Overrides
    BulkOperationDescriptorBase<BulkUpdateDescriptor<TDocument, TPartialDocument>, IBulkUpdateOperation<TDocument, TPartialDocument>>.BulkOperationClrType
    | Edit this page View Source

    BulkOperationType

    Declaration
    protected override string BulkOperationType { get; }
    Property Value
    Type Description
    string
    Overrides
    BulkOperationDescriptorBase<BulkUpdateDescriptor<TDocument, TPartialDocument>, IBulkUpdateOperation<TDocument, TPartialDocument>>.BulkOperationType

    Methods

    | Edit this page View Source

    Doc(TPartialDocument)

    The partial update document to be merged on to the existing object.

    Declaration
    public BulkUpdateDescriptor<TDocument, TPartialDocument> Doc(TPartialDocument @object)
    Parameters
    Type Name Description
    TPartialDocument object
    Returns
    Type Description
    BulkUpdateDescriptor<TDocument, TPartialDocument>
    | Edit this page View Source

    DocAsUpsert(bool?)

    Instead of sending a partial doc with Doc(TPartialDocument) plus an upsert doc with Upsert(TDocument), setting DocAsUpsert(bool?) to true will use the contents of doc as the upsert value.

    Declaration
    public BulkUpdateDescriptor<TDocument, TPartialDocument> DocAsUpsert(bool? partialDocumentAsUpsert = true)
    Parameters
    Type Name Description
    bool? partialDocumentAsUpsert
    Returns
    Type Description
    BulkUpdateDescriptor<TDocument, TPartialDocument>
    | Edit this page View Source

    GetBulkOperationBody()

    Declaration
    protected override object GetBulkOperationBody()
    Returns
    Type Description
    object
    Overrides
    BulkOperationDescriptorBase<BulkUpdateDescriptor<TDocument, TPartialDocument>, IBulkUpdateOperation<TDocument, TPartialDocument>>.GetBulkOperationBody()
    | Edit this page View Source

    GetIdForOperation(Inferrer)

    Declaration
    protected override Id GetIdForOperation(Inferrer inferrer)
    Parameters
    Type Name Description
    Inferrer inferrer
    Returns
    Type Description
    Id
    Overrides
    BulkOperationDescriptorBase<BulkUpdateDescriptor<TDocument, TPartialDocument>, IBulkUpdateOperation<TDocument, TPartialDocument>>.GetIdForOperation(Inferrer)
    | Edit this page View Source

    GetRoutingForOperation(Inferrer)

    Declaration
    protected override Routing GetRoutingForOperation(Inferrer inferrer)
    Parameters
    Type Name Description
    Inferrer inferrer
    Returns
    Type Description
    Routing
    Overrides
    BulkOperationDescriptorBase<BulkUpdateDescriptor<TDocument, TPartialDocument>, IBulkUpdateOperation<TDocument, TPartialDocument>>.GetRoutingForOperation(Inferrer)
    | Edit this page View Source

    IdFrom(TDocument, bool)

    Infers the id of the object to update from the provided

    object . See Doc(TPartialDocument) to apply a partial object merge.
    Declaration
    public BulkUpdateDescriptor<TDocument, TPartialDocument> IdFrom(TDocument @object, bool useAsUpsert = false)
    Parameters
    Type Name Description
    TDocument object
    bool useAsUpsert
    Returns
    Type Description
    BulkUpdateDescriptor<TDocument, TPartialDocument>
    | Edit this page View Source

    IfPrimaryTerm(long?)

    Operations can be made conditional and only be performed if the last modification to the document was assigned the primary term.

    Declaration
    public BulkUpdateDescriptor<TDocument, TPartialDocument> IfPrimaryTerm(long? primaryTerm)
    Parameters
    Type Name Description
    long? primaryTerm
    Returns
    Type Description
    BulkUpdateDescriptor<TDocument, TPartialDocument>
    | Edit this page View Source

    IfSequenceNumber(long?)

    Operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number.

    Declaration
    public BulkUpdateDescriptor<TDocument, TPartialDocument> IfSequenceNumber(long? seqNo)
    Parameters
    Type Name Description
    long? seqNo
    Returns
    Type Description
    BulkUpdateDescriptor<TDocument, TPartialDocument>
    | Edit this page View Source

    RetriesOnConflict(int?)

    How many times an update should be retried in the case of a version conflict.

    Declaration
    public BulkUpdateDescriptor<TDocument, TPartialDocument> RetriesOnConflict(int? retriesOnConflict)
    Parameters
    Type Name Description
    int? retriesOnConflict
    Returns
    Type Description
    BulkUpdateDescriptor<TDocument, TPartialDocument>
    | Edit this page View Source

    Script(Func<ScriptDescriptor, IScript>)

    A script to specify the update.

    Declaration
    public BulkUpdateDescriptor<TDocument, TPartialDocument> Script(Func<ScriptDescriptor, IScript> scriptSelector)
    Parameters
    Type Name Description
    Func<ScriptDescriptor, IScript> scriptSelector
    Returns
    Type Description
    BulkUpdateDescriptor<TDocument, TPartialDocument>
    | Edit this page View Source

    ScriptedUpsert(bool?)

    If you would like your script to run regardless of whether the document exists or not — i.e. the script handles initializing the document instead of the upsert element — then set scripted_upsert to true

    Declaration
    public BulkUpdateDescriptor<TDocument, TPartialDocument> ScriptedUpsert(bool? scriptedUpsert = true)
    Parameters
    Type Name Description
    bool? scriptedUpsert
    Returns
    Type Description
    BulkUpdateDescriptor<TDocument, TPartialDocument>
    | Edit this page View Source

    Source(Union<bool, ISourceFilter>)

    True or false to return the _source field or not, or a list of fields to return.

    Declaration
    public BulkUpdateDescriptor<TDocument, TPartialDocument> Source(Union<bool, ISourceFilter> source)
    Parameters
    Type Name Description
    Union<bool, ISourceFilter> source
    Returns
    Type Description
    BulkUpdateDescriptor<TDocument, TPartialDocument>
    | Edit this page View Source

    Upsert(TDocument)

    A document to upsert when the specified document to be updated is not found

    Declaration
    public BulkUpdateDescriptor<TDocument, TPartialDocument> Upsert(TDocument @object)
    Parameters
    Type Name Description
    TDocument object
    Returns
    Type Description
    BulkUpdateDescriptor<TDocument, TPartialDocument>

    Implements

    IDescriptor
    IBulkUpdateOperation<TDocument, TPartialDocument>
    IBulkOperation

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Properties
      • BulkOperationClrType
      • BulkOperationType
    • Methods
      • Doc(TPartialDocument)
      • DocAsUpsert(bool?)
      • GetBulkOperationBody()
      • GetIdForOperation(Inferrer)
      • GetRoutingForOperation(Inferrer)
      • IdFrom(TDocument, bool)
      • IfPrimaryTerm(long?)
      • IfSequenceNumber(long?)
      • RetriesOnConflict(int?)
      • Script(Func<ScriptDescriptor, IScript>)
      • ScriptedUpsert(bool?)
      • Source(Union<bool, ISourceFilter>)
      • Upsert(TDocument)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX