Search Results for

    Show / Hide Table of Contents

    Class SetProcessorDescriptor<T>

    Sets one field and associates it with the specified value. If the field already exists, its value will be replaced with the provided one.

    Inheritance
    object
    DescriptorBase<SetProcessorDescriptor<T>, ISetProcessor>
    ProcessorDescriptorBase<SetProcessorDescriptor<T>, ISetProcessor>
    SetProcessorDescriptor<T>
    Implements
    IDescriptor
    ISetProcessor
    IProcessor
    Inherited Members
    ProcessorDescriptorBase<SetProcessorDescriptor<T>, ISetProcessor>.Name
    ProcessorDescriptorBase<SetProcessorDescriptor<T>, ISetProcessor>.Description(string)
    ProcessorDescriptorBase<SetProcessorDescriptor<T>, ISetProcessor>.OnFailure(IEnumerable<IProcessor>)
    ProcessorDescriptorBase<SetProcessorDescriptor<T>, ISetProcessor>.OnFailure(Func<ProcessorsDescriptor, IPromise<IList<IProcessor>>>)
    ProcessorDescriptorBase<SetProcessorDescriptor<T>, ISetProcessor>.If(string)
    ProcessorDescriptorBase<SetProcessorDescriptor<T>, ISetProcessor>.Tag(string)
    ProcessorDescriptorBase<SetProcessorDescriptor<T>, ISetProcessor>.IgnoreFailure(bool?)
    DescriptorBase<SetProcessorDescriptor<T>, ISetProcessor>.Self
    DescriptorBase<SetProcessorDescriptor<T>, ISetProcessor>.Assign<TValue>(TValue, Action<ISetProcessor, 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
    public class SetProcessorDescriptor<T> : ProcessorDescriptorBase<SetProcessorDescriptor<T>, ISetProcessor>, IDescriptor, ISetProcessor, IProcessor where T : class
    Type Parameters
    Name Description
    T

    Properties

    | Edit this page View Source

    Name

    Declaration
    protected override string Name { get; }
    Property Value
    Type Description
    string
    Overrides
    ProcessorDescriptorBase<SetProcessorDescriptor<T>, ISetProcessor>.Name

    Methods

    | Edit this page View Source

    Field(Field)

    The field to insert, upsert, or update. Supports template snippets.

    Declaration
    public SetProcessorDescriptor<T> Field(Field field)
    Parameters
    Type Name Description
    Field field
    Returns
    Type Description
    SetProcessorDescriptor<T>
    | Edit this page View Source

    Field<TValue>(Expression<Func<T, TValue>>)

    The field to insert, upsert, or update. Supports template snippets.

    Declaration
    public SetProcessorDescriptor<T> Field<TValue>(Expression<Func<T, TValue>> objectPath)
    Parameters
    Type Name Description
    Expression<Func<T, TValue>> objectPath
    Returns
    Type Description
    SetProcessorDescriptor<T>
    Type Parameters
    Name Description
    TValue
    | Edit this page View Source

    IgnoreEmptyValue(bool?)

    If true and value is a template snippet that evaluates to null or the empty string, the processor quietly exits without modifying the document. Defaults to false.

    Declaration
    public SetProcessorDescriptor<T> IgnoreEmptyValue(bool? ignoreEmptyValue = true)
    Parameters
    Type Name Description
    bool? ignoreEmptyValue
    Returns
    Type Description
    SetProcessorDescriptor<T>
    | Edit this page View Source

    Override(bool?)

    If processor will update fields with pre-existing non-null-valued field. When set to false, such fields will not be touched. Default is true

    Declaration
    public SetProcessorDescriptor<T> Override(bool? @override = true)
    Parameters
    Type Name Description
    bool? override
    Returns
    Type Description
    SetProcessorDescriptor<T>
    | Edit this page View Source

    Value<TValue>(TValue)

    The value to be set for the field. Supports template snippets.

    Declaration
    public SetProcessorDescriptor<T> Value<TValue>(TValue value)
    Parameters
    Type Name Description
    TValue value
    Returns
    Type Description
    SetProcessorDescriptor<T>
    Type Parameters
    Name Description
    TValue

    Implements

    IDescriptor
    ISetProcessor
    IProcessor

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Properties
      • Name
    • Methods
      • Field(Field)
      • Field<TValue>(Expression<Func<T, TValue>>)
      • IgnoreEmptyValue(bool?)
      • Override(bool?)
      • Value<TValue>(TValue)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX