Class ProcessorsDescriptor

Inheritance
object
DescriptorPromiseBase<ProcessorsDescriptor, IList<IProcessor>>
ProcessorsDescriptor
Implements
Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public class ProcessorsDescriptor : DescriptorPromiseBase<ProcessorsDescriptor, IList<IProcessor>>, IDescriptor, IPromise<IList<IProcessor>>

Constructors

| Edit this page View Source

ProcessorsDescriptor()

Declaration
public ProcessorsDescriptor()

Methods

| Edit this page View Source

Append<T>(Func<AppendProcessorDescriptor<T>, IAppendProcessor>)

Declaration
public ProcessorsDescriptor Append<T>(Func<AppendProcessorDescriptor<T>, IAppendProcessor> selector) where T : class
Parameters
Type Name Description
Func<AppendProcessorDescriptor<T>, IAppendProcessor> selector
Returns
Type Description
ProcessorsDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

Attachment<T>(Func<AttachmentProcessorDescriptor<T>, 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.

Declaration
public ProcessorsDescriptor Attachment<T>(Func<AttachmentProcessorDescriptor<T>, IAttachmentProcessor> selector) where T : class
Parameters
Type Name Description
Func<AttachmentProcessorDescriptor<T>, IAttachmentProcessor> selector
Returns
Type Description
ProcessorsDescriptor
Type Parameters
Name Description
T
Remarks

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

| Edit this page View Source

Bytes<T>(Func<BytesProcessorDescriptor<T>, IBytesProcessor>)

Converts a human readable byte value (e.g. 1kb) to its value in bytes (e.g. 1024). Supported human readable units are "b", "kb", "mb", "gb", "tb", "pb" case insensitive. An error will occur if the field is not a supported format or resultant value exceeds 2^63.

Declaration
public ProcessorsDescriptor Bytes<T>(Func<BytesProcessorDescriptor<T>, IBytesProcessor> selector) where T : class
Parameters
Type Name Description
Func<BytesProcessorDescriptor<T>, IBytesProcessor> selector
Returns
Type Description
ProcessorsDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

Convert<T>(Func<ConvertProcessorDescriptor<T>, IConvertProcessor>)

Converts a field in the currently ingested document to a different type, such as converting a string to an integer. If the field value is an array, all members will be converted.

Declaration
public ProcessorsDescriptor Convert<T>(Func<ConvertProcessorDescriptor<T>, IConvertProcessor> selector) where T : class
Parameters
Type Name Description
Func<ConvertProcessorDescriptor<T>, IConvertProcessor> selector
Returns
Type Description
ProcessorsDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

Csv<T>(Func<CsvProcessorDescriptor<T>, ICsvProcessor>)

Extracts fields from CSV line out of a single text field within a document. Any empty field in CSV will be skipped.

Declaration
public ProcessorsDescriptor Csv<T>(Func<CsvProcessorDescriptor<T>, ICsvProcessor> selector) where T : class
Parameters
Type Name Description
Func<CsvProcessorDescriptor<T>, ICsvProcessor> selector
Returns
Type Description
ProcessorsDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

DateIndexName<T>(Func<DateIndexNameProcessorDescriptor<T>, IDateIndexNameProcessor>)

Point documents to the right time-based index based on a date or timestamp field in a document by using the date math index name support.

Declaration
public ProcessorsDescriptor DateIndexName<T>(Func<DateIndexNameProcessorDescriptor<T>, IDateIndexNameProcessor> selector) where T : class
Parameters
Type Name Description
Func<DateIndexNameProcessorDescriptor<T>, IDateIndexNameProcessor> selector
Returns
Type Description
ProcessorsDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

Date<T>(Func<DateProcessorDescriptor<T>, IDateProcessor>)

Declaration
public ProcessorsDescriptor Date<T>(Func<DateProcessorDescriptor<T>, IDateProcessor> selector) where T : class
Parameters
Type Name Description
Func<DateProcessorDescriptor<T>, IDateProcessor> selector
Returns
Type Description
ProcessorsDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

Dissect<T>(Func<DissectProcessorDescriptor<T>, IDissectProcessor>)

Similar to the Grok Processor, dissect also extracts structured fields out of a single text field within a document. However unlike the Grok Processor, dissect does not use Regular Expressions. This allows dissect’s syntax to be simple and, for some cases faster, than the Grok Processor.

Declaration
public ProcessorsDescriptor Dissect<T>(Func<DissectProcessorDescriptor<T>, IDissectProcessor> selector) where T : class
Parameters
Type Name Description
Func<DissectProcessorDescriptor<T>, IDissectProcessor> selector
Returns
Type Description
ProcessorsDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

DotExpander<T>(Func<DotExpanderProcessorDescriptor<T>, IDotExpanderProcessor>)

Expands a field with dots into an object field. This processor allows fields with dots in the name to be accessible by other processors in the pipeline. Otherwise these fields can’t be accessed by any processor.

Declaration
public ProcessorsDescriptor DotExpander<T>(Func<DotExpanderProcessorDescriptor<T>, IDotExpanderProcessor> selector) where T : class
Parameters
Type Name Description
Func<DotExpanderProcessorDescriptor<T>, IDotExpanderProcessor> selector
Returns
Type Description
ProcessorsDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

Drop(Func<DropProcessorDescriptor, IDropProcessor>)

Drops the document without raising any errors. This is useful to prevent the document from getting indexed based on some condition.

Declaration
public ProcessorsDescriptor Drop(Func<DropProcessorDescriptor, IDropProcessor> selector)
Parameters
Type Name Description
Func<DropProcessorDescriptor, IDropProcessor> selector
Returns
Type Description
ProcessorsDescriptor
| Edit this page View Source

Fail(Func<FailProcessorDescriptor, IFailProcessor>)

Raises an exception. This is useful for when you expect a pipeline to fail and want to relay a specific message to the requester.

Declaration
public ProcessorsDescriptor Fail(Func<FailProcessorDescriptor, IFailProcessor> selector)
Parameters
Type Name Description
Func<FailProcessorDescriptor, IFailProcessor> selector
Returns
Type Description
ProcessorsDescriptor
| Edit this page View Source

Fingerprint<T>(Func<FingerprintProcessorDescriptor<T>, IFingerprintProcessor>)

Declaration
public ProcessorsDescriptor Fingerprint<T>(Func<FingerprintProcessorDescriptor<T>, IFingerprintProcessor> selector) where T : class
Parameters
Type Name Description
Func<FingerprintProcessorDescriptor<T>, IFingerprintProcessor> selector
Returns
Type Description
ProcessorsDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

Foreach<T>(Func<ForeachProcessorDescriptor<T>, IForeachProcessor>)

Declaration
public ProcessorsDescriptor Foreach<T>(Func<ForeachProcessorDescriptor<T>, IForeachProcessor> selector) where T : class
Parameters
Type Name Description
Func<ForeachProcessorDescriptor<T>, IForeachProcessor> selector
Returns
Type Description
ProcessorsDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

GeoIp<T>(Func<GeoIpProcessorDescriptor<T>, IGeoIpProcessor>)

Adds information about the geographical location of IP addresses, based on data from the Maxmind databases. This processor adds this information by default under the geoip field. The geoip processor can resolve both IPv4 and IPv6 addresses.

Declaration
public ProcessorsDescriptor GeoIp<T>(Func<GeoIpProcessorDescriptor<T>, IGeoIpProcessor> selector) where T : class
Parameters
Type Name Description
Func<GeoIpProcessorDescriptor<T>, IGeoIpProcessor> selector
Returns
Type Description
ProcessorsDescriptor
Type Parameters
Name Description
T
Remarks

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

| Edit this page View Source

Grok<T>(Func<GrokProcessorDescriptor<T>, IGrokProcessor>)

Declaration
public ProcessorsDescriptor Grok<T>(Func<GrokProcessorDescriptor<T>, IGrokProcessor> selector) where T : class
Parameters
Type Name Description
Func<GrokProcessorDescriptor<T>, IGrokProcessor> selector
Returns
Type Description
ProcessorsDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

Gsub<T>(Func<GsubProcessorDescriptor<T>, IGsubProcessor>)

Declaration
public ProcessorsDescriptor Gsub<T>(Func<GsubProcessorDescriptor<T>, IGsubProcessor> selector) where T : class
Parameters
Type Name Description
Func<GsubProcessorDescriptor<T>, IGsubProcessor> selector
Returns
Type Description
ProcessorsDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

Join<T>(Func<JoinProcessorDescriptor<T>, IJoinProcessor>)

Joins each element of an array into a single string using a separator character between each element. Throws an error when the field is not an array.

Declaration
public ProcessorsDescriptor Join<T>(Func<JoinProcessorDescriptor<T>, IJoinProcessor> selector) where T : class
Parameters
Type Name Description
Func<JoinProcessorDescriptor<T>, IJoinProcessor> selector
Returns
Type Description
ProcessorsDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

Json<T>(Func<JsonProcessorDescriptor<T>, IJsonProcessor>)

Converts a JSON string into a structured JSON object.

Declaration
public ProcessorsDescriptor Json<T>(Func<JsonProcessorDescriptor<T>, IJsonProcessor> selector) where T : class
Parameters
Type Name Description
Func<JsonProcessorDescriptor<T>, IJsonProcessor> selector
Returns
Type Description
ProcessorsDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

Kv<T>(Func<KeyValueProcessorDescriptor<T>, IKeyValueProcessor>)

Processor to automatically parse messages (or specific event fields) which are of the key=value variety.

Declaration
public ProcessorsDescriptor Kv<T>(Func<KeyValueProcessorDescriptor<T>, IKeyValueProcessor> selector) where T : class
Parameters
Type Name Description
Func<KeyValueProcessorDescriptor<T>, IKeyValueProcessor> selector
Returns
Type Description
ProcessorsDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

Lowercase<T>(Func<LowercaseProcessorDescriptor<T>, ILowercaseProcessor>)

Converts a string to its lowercase equivalent.

Declaration
public ProcessorsDescriptor Lowercase<T>(Func<LowercaseProcessorDescriptor<T>, ILowercaseProcessor> selector) where T : class
Parameters
Type Name Description
Func<LowercaseProcessorDescriptor<T>, ILowercaseProcessor> selector
Returns
Type Description
ProcessorsDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

NetworkCommunityId<T>(Func<NetworkCommunityIdProcessorDescriptor<T>, INetworkCommunityIdProcessor>)

Declaration
public ProcessorsDescriptor NetworkCommunityId<T>(Func<NetworkCommunityIdProcessorDescriptor<T>, INetworkCommunityIdProcessor> selector) where T : class
Parameters
Type Name Description
Func<NetworkCommunityIdProcessorDescriptor<T>, INetworkCommunityIdProcessor> selector
Returns
Type Description
ProcessorsDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

NetworkDirection<T>(Func<NetworkDirectionProcessorDescriptor<T>, INetworkDirectionProcessor>)

Declaration
public ProcessorsDescriptor NetworkDirection<T>(Func<NetworkDirectionProcessorDescriptor<T>, INetworkDirectionProcessor> selector) where T : class
Parameters
Type Name Description
Func<NetworkDirectionProcessorDescriptor<T>, INetworkDirectionProcessor> selector
Returns
Type Description
ProcessorsDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

Pipeline(Func<PipelineProcessorDescriptor, IPipelineProcessor>)

Executes another pipeline.

Declaration
public ProcessorsDescriptor Pipeline(Func<PipelineProcessorDescriptor, IPipelineProcessor> selector)
Parameters
Type Name Description
Func<PipelineProcessorDescriptor, IPipelineProcessor> selector
Returns
Type Description
ProcessorsDescriptor
| Edit this page View Source

Remove<T>(Func<RemoveProcessorDescriptor<T>, IRemoveProcessor>)

Removes existing fields. If one field doesn't exist, an exception will be thrown.

Declaration
public ProcessorsDescriptor Remove<T>(Func<RemoveProcessorDescriptor<T>, IRemoveProcessor> selector) where T : class
Parameters
Type Name Description
Func<RemoveProcessorDescriptor<T>, IRemoveProcessor> selector
Returns
Type Description
ProcessorsDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

Rename<T>(Func<RenameProcessorDescriptor<T>, IRenameProcessor>)

Renames an existing field. If the field doesn't exist or the new name is already used, an exception will be thrown.

Declaration
public ProcessorsDescriptor Rename<T>(Func<RenameProcessorDescriptor<T>, IRenameProcessor> selector) where T : class
Parameters
Type Name Description
Func<RenameProcessorDescriptor<T>, IRenameProcessor> selector
Returns
Type Description
ProcessorsDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

Script(Func<ScriptProcessorDescriptor, IScriptProcessor>)

Allows inline, stored, and file scripts to be executed within ingest pipelines.

Declaration
public ProcessorsDescriptor Script(Func<ScriptProcessorDescriptor, IScriptProcessor> selector)
Parameters
Type Name Description
Func<ScriptProcessorDescriptor, IScriptProcessor> selector
Returns
Type Description
ProcessorsDescriptor
| Edit this page View Source

Set<T>(Func<SetProcessorDescriptor<T>, ISetProcessor>)

Declaration
public ProcessorsDescriptor Set<T>(Func<SetProcessorDescriptor<T>, ISetProcessor> selector) where T : class
Parameters
Type Name Description
Func<SetProcessorDescriptor<T>, ISetProcessor> selector
Returns
Type Description
ProcessorsDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

Sort<T>(Func<SortProcessorDescriptor<T>, ISortProcessor>)

The Sort processor sorts the elements of an array ascending or descending. Homogeneous arrays of numbers will be sorted numerically, while arrays of strings or heterogeneous arrays of strings and numbers will be sorted lexicographically.

Declaration
public ProcessorsDescriptor Sort<T>(Func<SortProcessorDescriptor<T>, ISortProcessor> selector) where T : class
Parameters
Type Name Description
Func<SortProcessorDescriptor<T>, ISortProcessor> selector
Returns
Type Description
ProcessorsDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

Split<T>(Func<SplitProcessorDescriptor<T>, ISplitProcessor>)

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

Declaration
public ProcessorsDescriptor Split<T>(Func<SplitProcessorDescriptor<T>, ISplitProcessor> selector) where T : class
Parameters
Type Name Description
Func<SplitProcessorDescriptor<T>, ISplitProcessor> selector
Returns
Type Description
ProcessorsDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

TextEmbedding<T>(Func<TextEmbeddingProcessorDescriptor<T>, ITextEmbeddingProcessor>)

The text_embedding processor is used to generate vector embeddings from text fields for semantic search.

Declaration
public ProcessorsDescriptor TextEmbedding<T>(Func<TextEmbeddingProcessorDescriptor<T>, ITextEmbeddingProcessor> selector) where T : class
Parameters
Type Name Description
Func<TextEmbeddingProcessorDescriptor<T>, ITextEmbeddingProcessor> selector
Returns
Type Description
ProcessorsDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

Trim<T>(Func<TrimProcessorDescriptor<T>, ITrimProcessor>)

Trims whitespace from field. This only works on leading and trailing whitespace

Declaration
public ProcessorsDescriptor Trim<T>(Func<TrimProcessorDescriptor<T>, ITrimProcessor> selector) where T : class
Parameters
Type Name Description
Func<TrimProcessorDescriptor<T>, ITrimProcessor> selector
Returns
Type Description
ProcessorsDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

Uppercase<T>(Func<UppercaseProcessorDescriptor<T>, IUppercaseProcessor>)

Converts a string to its uppercase equivalent.

Declaration
public ProcessorsDescriptor Uppercase<T>(Func<UppercaseProcessorDescriptor<T>, IUppercaseProcessor> selector) where T : class
Parameters
Type Name Description
Func<UppercaseProcessorDescriptor<T>, IUppercaseProcessor> selector
Returns
Type Description
ProcessorsDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

UriParts<T>(Func<UriPartsProcessorDescriptor<T>, IUriPartsProcessor>)

Declaration
public ProcessorsDescriptor UriParts<T>(Func<UriPartsProcessorDescriptor<T>, IUriPartsProcessor> selector) where T : class
Parameters
Type Name Description
Func<UriPartsProcessorDescriptor<T>, IUriPartsProcessor> selector
Returns
Type Description
ProcessorsDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

UrlDecode<T>(Func<UrlDecodeProcessorDescriptor<T>, IUrlDecodeProcessor>)

URL-decodes a string

Declaration
public ProcessorsDescriptor UrlDecode<T>(Func<UrlDecodeProcessorDescriptor<T>, IUrlDecodeProcessor> selector) where T : class
Parameters
Type Name Description
Func<UrlDecodeProcessorDescriptor<T>, IUrlDecodeProcessor> selector
Returns
Type Description
ProcessorsDescriptor
Type Parameters
Name Description
T
| Edit this page View Source

UserAgent<T>(Func<UserAgentProcessorDescriptor<T>, IUserAgentProcessor>)

The user_agent processor extracts details from the user agent string a browser sends with its web requests. This processor adds this information by default under the user_agent field. The ingest-user-agent plugin ships by default with the regexes.yaml made available by uap-java with an Apache 2.0 license.

Declaration
public ProcessorsDescriptor UserAgent<T>(Func<UserAgentProcessorDescriptor<T>, IUserAgentProcessor> selector) where T : class
Parameters
Type Name Description
Func<UserAgentProcessorDescriptor<T>, IUserAgentProcessor> selector
Returns
Type Description
ProcessorsDescriptor
Type Parameters
Name Description
T
Remarks

Requires the UserAgent Processor Plugin to be installed on the cluster.

Implements

Extension Methods