Interface IAttachmentProcessor

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.

Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public interface IAttachmentProcessor : IProcessor
Remarks

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

Properties

| Edit this page View Source

Field

The field to get the base64 encoded field from.

Declaration
[DataMember(Name = "field")]
Field Field { get; set; }
Property Value
Type Description
Field
| Edit this page View Source

IgnoreMissing

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

Declaration
[DataMember(Name = "ignore_missing")]
bool? IgnoreMissing { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

IndexedCharacters

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

Declaration
[DataMember(Name = "indexed_chars")]
long? IndexedCharacters { get; set; }
Property Value
Type Description
long?
| Edit this page View Source

IndexedCharactersField

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

Declaration
[DataMember(Name = "indexed_chars_field")]
Field IndexedCharactersField { get; set; }
Property Value
Type Description
Field
| Edit this page View Source

Properties

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

Declaration
[DataMember(Name = "properties")]
IEnumerable<string> Properties { get; set; }
Property Value
Type Description
IEnumerable<string>
| Edit this page View Source

ResourceName

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
[DataMember(Name = "resource_name")]
Field ResourceName { get; set; }
Property Value
Type Description
Field
| Edit this page View Source

TargetField

The field that will hold the attachment information.

Declaration
[DataMember(Name = "target_field")]
Field TargetField { get; set; }
Property Value
Type Description
Field

Extension Methods