Search Results for

    Show / Hide Table of Contents

    Class SplitProcessorDescriptor<T>

    Splits a field into an array using a separator character. Only works on string fields

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

    Methods

    | Edit this page View Source

    Field(Field)

    The field to split

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

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

    The field to split

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

    IgnoreMissing(bool?)

    If true and Field does not exist or is null, the processor quietly exits without modifying the document. Default is false

    Declaration
    public SplitProcessorDescriptor<T> IgnoreMissing(bool? ignoreMissing = true)
    Parameters
    Type Name Description
    bool? ignoreMissing
    Returns
    Type Description
    SplitProcessorDescriptor<T>
    | Edit this page View Source

    PreserveTrailing(bool?)

    Preserves empty trailing fields, if any.

    Declaration
    public SplitProcessorDescriptor<T> PreserveTrailing(bool? preserveTrailing = true)
    Parameters
    Type Name Description
    bool? preserveTrailing
    Returns
    Type Description
    SplitProcessorDescriptor<T>
    | Edit this page View Source

    Separator(string)

    A regex which matches the separator, eg , or \s+

    Declaration
    public SplitProcessorDescriptor<T> Separator(string separator)
    Parameters
    Type Name Description
    string separator
    Returns
    Type Description
    SplitProcessorDescriptor<T>
    | Edit this page View Source

    TargetField(Field)

    The field to assign the split value to, by default field is updated in-place

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

    TargetField(Expression<Func<T, object>>)

    The field to assign the split value to, by default field is updated in-place

    Declaration
    public SplitProcessorDescriptor<T> TargetField(Expression<Func<T, object>> objectPath)
    Parameters
    Type Name Description
    Expression<Func<T, object>> objectPath
    Returns
    Type Description
    SplitProcessorDescriptor<T>

    Implements

    IDescriptor
    ISplitProcessor
    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>>)
      • IgnoreMissing(bool?)
      • PreserveTrailing(bool?)
      • Separator(string)
      • TargetField(Field)
      • TargetField(Expression<Func<T, object>>)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX