Search Results for

    Show / Hide Table of Contents

    Class AttachmentProcessorDescriptor<T>

    The ingest attachment plugin lets OpenSearch extract file attachments in common formats (such as PPT, XLS, and PDF) by using the Apache text extraction library Tika. You can use the ingest attachment plugin as a replacement for the mapper attachment plugin.

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

    Requires the Ingest Attachment Processor Plugin to be installed on the cluster.

    Properties

    | Edit this page View Source

    Name

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

    Methods

    | Edit this page View Source

    Field(Field)

    The field to get the base64 encoded field from.

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

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

    The field to get the base64 encoded field from.

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

    IgnoreMissing(bool?)

    If true and field does not exist, the processor quietly exits without modifying the document.

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

    IndexedCharacters(long?)

    The number of chars being used for extraction to prevent huge fields. Use -1 for no limit. Defaults to 100000.

    Declaration
    public AttachmentProcessorDescriptor<T> IndexedCharacters(long? indexedCharacters)
    Parameters
    Type Name Description
    long? indexedCharacters
    Returns
    Type Description
    AttachmentProcessorDescriptor<T>
    | Edit this page View Source

    IndexedCharactersField(Field)

    Field name from which you can overwrite the number of chars being used for extraction.

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

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

    Field name from which you can overwrite the number of chars being used for extraction.

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

    Properties(IEnumerable<string>)

    Properties to select to be stored. Can be content, title, name, author, keywords, date, content_type, content_length, language. Defaults to all.

    Declaration
    public AttachmentProcessorDescriptor<T> Properties(IEnumerable<string> properties)
    Parameters
    Type Name Description
    IEnumerable<string> properties
    Returns
    Type Description
    AttachmentProcessorDescriptor<T>
    | Edit this page View Source

    Properties(params string[])

    Properties to select to be stored. Can be content, title, name, author, keywords, date, content_type, content_length, language. Defaults to all.

    Declaration
    public AttachmentProcessorDescriptor<T> Properties(params string[] properties)
    Parameters
    Type Name Description
    string[] properties
    Returns
    Type Description
    AttachmentProcessorDescriptor<T>
    | Edit this page View Source

    ResourceName(Field)

    The field containing the name of the resource to decode. If specified, the processor passes this resource name to the underlying Tika library to enable 'Resource Name Based Detection'.

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

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

    The field that will hold the attachment information.

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

    TargetField(Field)

    The field that will hold the attachment information.

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

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

    The field that will hold the attachment information.

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

    Implements

    IDescriptor
    IAttachmentProcessor
    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?)
      • IndexedCharacters(long?)
      • IndexedCharactersField(Field)
      • IndexedCharactersField<TValue>(Expression<Func<T, TValue>>)
      • Properties(IEnumerable<string>)
      • Properties(params string[])
      • ResourceName(Field)
      • ResourceName<TValue>(Expression<Func<T, TValue>>)
      • TargetField(Field)
      • TargetField<TValue>(Expression<Func<T, TValue>>)
    • Implements
    • Extension Methods
    Back to top Generated by DocFX