java.lang.Object
- org.opensearch.client.opensearch.ingest.Processor

All Implemented Interfaces:: JsonpSerializable, TaggedUnion<Processor.Kind,java.lang.Object>

@JsonpDeserializable
public class Processor
extends java.lang.Object
implements TaggedUnion<Processor.Kind,java.lang.Object>, JsonpSerializable

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Processor.Builder

static class Processor.Kind
Processor variant kinds.

Field Summary

Fields
Modifier and Type Field Description

static JsonpDeserializer<Processor> _DESERIALIZER

Constructor Summary

Constructors
Constructor Description

Processor(ProcessorVariant value)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.Object`	`_get()`
`Processor.Kind`	`_kind()`	Get the of the kind of variant held by this object.
`AppendProcessor`	`append()`	Get the `append` variant value.
`AttachmentProcessor`	`attachment()`	Get the `attachment` variant value.
`BytesProcessor`	`bytes()`	Get the `bytes` variant value.
`CircleProcessor`	`circle()`	Get the `circle` variant value.
`ConvertProcessor`	`convert()`	Get the `convert` variant value.
`CsvProcessor`	`csv()`	Get the `csv` variant value.
`DateProcessor`	`date()`	Get the `date` variant value.
`DateIndexNameProcessor`	`dateIndexName()`	Get the `date_index_name` variant value.
`DissectProcessor`	`dissect()`	Get the `dissect` variant value.
`DotExpanderProcessor`	`dotExpander()`	Get the `dot_expander` variant value.
`DropProcessor`	`drop()`	Get the `drop` variant value.
`FailProcessor`	`fail()`	Get the `fail` variant value.
`ForeachProcessor`	`foreach()`	Get the `foreach` variant value.
`GeoIpProcessor`	`geoip()`	Get the `geoip` variant value.
`GrokProcessor`	`grok()`	Get the `grok` variant value.
`GsubProcessor`	`gsub()`	Get the `gsub` variant value.
`InferenceProcessor`	`inference()`	Get the `inference` variant value.
`boolean`	`isAppend()`	Is this variant instance of kind `append`?
`boolean`	`isAttachment()`	Is this variant instance of kind `attachment`?
`boolean`	`isBytes()`	Is this variant instance of kind `bytes`?
`boolean`	`isCircle()`	Is this variant instance of kind `circle`?
`boolean`	`isConvert()`	Is this variant instance of kind `convert`?
`boolean`	`isCsv()`	Is this variant instance of kind `csv`?
`boolean`	`isDate()`	Is this variant instance of kind `date`?
`boolean`	`isDateIndexName()`	Is this variant instance of kind `date_index_name`?
`boolean`	`isDissect()`	Is this variant instance of kind `dissect`?
`boolean`	`isDotExpander()`	Is this variant instance of kind `dot_expander`?
`boolean`	`isDrop()`	Is this variant instance of kind `drop`?
`boolean`	`isFail()`	Is this variant instance of kind `fail`?
`boolean`	`isForeach()`	Is this variant instance of kind `foreach`?
`boolean`	`isGeoip()`	Is this variant instance of kind `geoip`?
`boolean`	`isGrok()`	Is this variant instance of kind `grok`?
`boolean`	`isGsub()`	Is this variant instance of kind `gsub`?
`boolean`	`isInference()`	Is this variant instance of kind `inference`?
`boolean`	`isJoin()`	Is this variant instance of kind `join`?
`boolean`	`isJson()`	Is this variant instance of kind `json`?
`boolean`	`isKv()`	Is this variant instance of kind `kv`?
`boolean`	`isLowercase()`	Is this variant instance of kind `lowercase`?
`boolean`	`isPipeline()`	Is this variant instance of kind `pipeline`?
`boolean`	`isRemove()`	Is this variant instance of kind `remove`?
`boolean`	`isRename()`	Is this variant instance of kind `rename`?
`boolean`	`isScript()`	Is this variant instance of kind `script`?
`boolean`	`isSet()`	Is this variant instance of kind `set`?
`boolean`	`isSetSecurityUser()`	Is this variant instance of kind `set_security_user`?
`boolean`	`isSort()`	Is this variant instance of kind `sort`?
`boolean`	`isSplit()`	Is this variant instance of kind `split`?
`boolean`	`isTrim()`	Is this variant instance of kind `trim`?
`boolean`	`isUppercase()`	Is this variant instance of kind `uppercase`?
`boolean`	`isUrldecode()`	Is this variant instance of kind `urldecode`?
`boolean`	`isUserAgent()`	Is this variant instance of kind `user_agent`?
`JoinProcessor`	`join()`	Get the `join` variant value.
`JsonProcessor`	`json()`	Get the `json` variant value.
`KeyValueProcessor`	`kv()`	Get the `kv` variant value.
`LowercaseProcessor`	`lowercase()`	Get the `lowercase` variant value.
`static Processor`	`of(java.util.function.Function<Processor.Builder,ObjectBuilder<Processor>> fn)`
`PipelineProcessor`	`pipeline()`	Get the `pipeline` variant value.
`RemoveProcessor`	`remove()`	Get the `remove` variant value.
`RenameProcessor`	`rename()`	Get the `rename` variant value.
`Script`	`script()`	Get the `script` variant value.
`void`	`serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)`
`SetProcessor`	`set()`	Get the `set` variant value.
`SetSecurityUserProcessor`	`setSecurityUser()`	Get the `set_security_user` variant value.
`protected static void`	`setupProcessorDeserializer(ObjectDeserializer<Processor.Builder> op)`
`SortProcessor`	`sort()`	Get the `sort` variant value.
`SplitProcessor`	`split()`	Get the `split` variant value.
`TrimProcessor`	`trim()`	Get the `trim` variant value.
`UppercaseProcessor`	`uppercase()`	Get the `uppercase` variant value.
`UrlDecodeProcessor`	`urldecode()`	Get the `urldecode` variant value.
`UserAgentProcessor`	`userAgent()`	Get the `user_agent` variant value.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _DESERIALIZER
```
public static final JsonpDeserializer<Processor> _DESERIALIZER
```
- Constructor Detail
  - Processor
```
public Processor(ProcessorVariant value)
```
- Method Detail
  - _kind
```
public final Processor.Kind _kind()
```
    Description copied from interface: TaggedUnion
    
    Get the of the kind of variant held by this object.
    
    Specified by:
    
    _kind in interface TaggedUnion<Processor.Kind,java.lang.Object>
    
    Returns:
    
    the variant kind
  - _get
```
public final java.lang.Object _get()
```
    Specified by:
    
    _get in interface TaggedUnion<Processor.Kind,java.lang.Object>
  - of
```
public static Processor of(java.util.function.Function<Processor.Builder,ObjectBuilder<Processor>> fn)
```
  - isAttachment
```
public boolean isAttachment()
```
    Is this variant instance of kind attachment?
  - attachment
```
public AttachmentProcessor attachment()
```
    Get the attachment variant value.
    
    Throws:
    
    java.lang.IllegalStateException - if the current variant is not of the attachment kind.
  - isAppend
```
public boolean isAppend()
```
    Is this variant instance of kind append?
  - append
```
public AppendProcessor append()
```
    Get the append variant value.
    
    Throws:
    
    java.lang.IllegalStateException - if the current variant is not of the append kind.
  - isCsv
```
public boolean isCsv()
```
    Is this variant instance of kind csv?
  - csv
```
public CsvProcessor csv()
```
    Get the csv variant value.
    
    Throws:
    
    java.lang.IllegalStateException - if the current variant is not of the csv kind.
  - isConvert
```
public boolean isConvert()
```
    Is this variant instance of kind convert?
  - convert
```
public ConvertProcessor convert()
```
    Get the convert variant value.
    
    Throws:
    
    java.lang.IllegalStateException - if the current variant is not of the convert kind.
  - isDate
```
public boolean isDate()
```
    Is this variant instance of kind date?
  - date
```
public DateProcessor date()
```
    Get the date variant value.
    
    Throws:
    
    java.lang.IllegalStateException - if the current variant is not of the date kind.
  - isDateIndexName
```
public boolean isDateIndexName()
```
    Is this variant instance of kind date_index_name?
  - dateIndexName
```
public DateIndexNameProcessor dateIndexName()
```
    Get the date_index_name variant value.
    
    Throws:
    
    java.lang.IllegalStateException - if the current variant is not of the date_index_name kind.
  - isDotExpander
```
public boolean isDotExpander()
```
    Is this variant instance of kind dot_expander?
  - dotExpander
```
public DotExpanderProcessor dotExpander()
```
    Get the dot_expander variant value.
    
    Throws:
    
    java.lang.IllegalStateException - if the current variant is not of the dot_expander kind.
  - isFail
```
public boolean isFail()
```
    Is this variant instance of kind fail?
  - fail
```
public FailProcessor fail()
```
    Get the fail variant value.
    
    Throws:
    
    java.lang.IllegalStateException - if the current variant is not of the fail kind.
  - isForeach
```
public boolean isForeach()
```
    Is this variant instance of kind foreach?
  - foreach
```
public ForeachProcessor foreach()
```
    Get the foreach variant value.
    
    Throws:
    
    java.lang.IllegalStateException - if the current variant is not of the foreach kind.
  - isJson
```
public boolean isJson()
```
    Is this variant instance of kind json?
  - json
```
public JsonProcessor json()
```
    Get the json variant value.
    
    Throws:
    
    java.lang.IllegalStateException - if the current variant is not of the json kind.
  - isUserAgent
```
public boolean isUserAgent()
```
    Is this variant instance of kind user_agent?
  - userAgent
```
public UserAgentProcessor userAgent()
```
    Get the user_agent variant value.
    
    Throws:
    
    java.lang.IllegalStateException - if the current variant is not of the user_agent kind.
  - isKv
```
public boolean isKv()
```
    Is this variant instance of kind kv?
  - kv
```
public KeyValueProcessor kv()
```
    Get the kv variant value.
    
    Throws:
    
    java.lang.IllegalStateException - if the current variant is not of the kv kind.
  - isGeoip
```
public boolean isGeoip()
```
    Is this variant instance of kind geoip?
  - geoip
```
public GeoIpProcessor geoip()
```
    Get the geoip variant value.
    
    Throws:
    
    java.lang.IllegalStateException - if the current variant is not of the geoip kind.
  - isGrok
```
public boolean isGrok()
```
    Is this variant instance of kind grok?
  - grok
```
public GrokProcessor grok()
```
    Get the grok variant value.
    
    Throws:
    
    java.lang.IllegalStateException - if the current variant is not of the grok kind.
  - isGsub
```
public boolean isGsub()
```
    Is this variant instance of kind gsub?
  - gsub
```
public GsubProcessor gsub()
```
    Get the gsub variant value.
    
    Throws:
    
    java.lang.IllegalStateException - if the current variant is not of the gsub kind.
  - isJoin
```
public boolean isJoin()
```
    Is this variant instance of kind join?
  - join
```
public JoinProcessor join()
```
    Get the join variant value.
    
    Throws:
    
    java.lang.IllegalStateException - if the current variant is not of the join kind.
  - isLowercase
```
public boolean isLowercase()
```
    Is this variant instance of kind lowercase?
  - lowercase
```
public LowercaseProcessor lowercase()
```
    Get the lowercase variant value.
    
    Throws:
    
    java.lang.IllegalStateException - if the current variant is not of the lowercase kind.
  - isRemove
```
public boolean isRemove()
```
    Is this variant instance of kind remove?
  - remove
```
public RemoveProcessor remove()
```
    Get the remove variant value.
    
    Throws:
    
    java.lang.IllegalStateException - if the current variant is not of the remove kind.
  - isRename
```
public boolean isRename()
```
    Is this variant instance of kind rename?
  - rename
```
public RenameProcessor rename()
```
    Get the rename variant value.
    
    Throws:
    
    java.lang.IllegalStateException - if the current variant is not of the rename kind.
  - isScript
```
public boolean isScript()
```
    Is this variant instance of kind script?
  - script
```
public Script script()
```
    Get the script variant value.
    
    Throws:
    
    java.lang.IllegalStateException - if the current variant is not of the script kind.
  - isSet
```
public boolean isSet()
```
    Is this variant instance of kind set?
  - set
```
public SetProcessor set()
```
    Get the set variant value.
    
    Throws:
    
    java.lang.IllegalStateException - if the current variant is not of the set kind.
  - isSort
```
public boolean isSort()
```
    Is this variant instance of kind sort?
  - sort
```
public SortProcessor sort()
```
    Get the sort variant value.
    
    Throws:
    
    java.lang.IllegalStateException - if the current variant is not of the sort kind.
  - isSplit
```
public boolean isSplit()
```
    Is this variant instance of kind split?
  - split
```
public SplitProcessor split()
```
    Get the split variant value.
    
    Throws:
    
    java.lang.IllegalStateException - if the current variant is not of the split kind.
  - isTrim
```
public boolean isTrim()
```
    Is this variant instance of kind trim?
  - trim
```
public TrimProcessor trim()
```
    Get the trim variant value.
    
    Throws:
    
    java.lang.IllegalStateException - if the current variant is not of the trim kind.
  - isUppercase
```
public boolean isUppercase()
```
    Is this variant instance of kind uppercase?
  - uppercase
```
public UppercaseProcessor uppercase()
```
    Get the uppercase variant value.
    
    Throws:
    
    java.lang.IllegalStateException - if the current variant is not of the uppercase kind.
  - isUrldecode
```
public boolean isUrldecode()
```
    Is this variant instance of kind urldecode?
  - urldecode
```
public UrlDecodeProcessor urldecode()
```
    Get the urldecode variant value.
    
    Throws:
    
    java.lang.IllegalStateException - if the current variant is not of the urldecode kind.
  - isBytes
```
public boolean isBytes()
```
    Is this variant instance of kind bytes?
  - bytes
```
public BytesProcessor bytes()
```
    Get the bytes variant value.
    
    Throws:
    
    java.lang.IllegalStateException - if the current variant is not of the bytes kind.
  - isDissect
```
public boolean isDissect()
```
    Is this variant instance of kind dissect?
  - dissect
```
public DissectProcessor dissect()
```
    Get the dissect variant value.
    
    Throws:
    
    java.lang.IllegalStateException - if the current variant is not of the dissect kind.
  - isSetSecurityUser
```
public boolean isSetSecurityUser()
```
    Is this variant instance of kind set_security_user?
  - setSecurityUser
```
public SetSecurityUserProcessor setSecurityUser()
```
    Get the set_security_user variant value.
    
    Throws:
    
    java.lang.IllegalStateException - if the current variant is not of the set_security_user kind.
  - isPipeline
```
public boolean isPipeline()
```
    Is this variant instance of kind pipeline?
  - pipeline
```
public PipelineProcessor pipeline()
```
    Get the pipeline variant value.
    
    Throws:
    
    java.lang.IllegalStateException - if the current variant is not of the pipeline kind.
  - isDrop
```
public boolean isDrop()
```
    Is this variant instance of kind drop?
  - drop
```
public DropProcessor drop()
```
    Get the drop variant value.
    
    Throws:
    
    java.lang.IllegalStateException - if the current variant is not of the drop kind.
  - isCircle
```
public boolean isCircle()
```
    Is this variant instance of kind circle?
  - circle
```
public CircleProcessor circle()
```
    Get the circle variant value.
    
    Throws:
    
    java.lang.IllegalStateException - if the current variant is not of the circle kind.
  - isInference
```
public boolean isInference()
```
    Is this variant instance of kind inference?
  - inference
```
public InferenceProcessor inference()
```
    Get the inference variant value.
    
    Throws:
    
    java.lang.IllegalStateException - if the current variant is not of the inference kind.
  - serialize
```
public void serialize(jakarta.json.stream.JsonGenerator generator,
                      JsonpMapper mapper)
```
    Specified by:
    
    serialize in interface JsonpSerializable
  - setupProcessorDeserializer
```
protected static void setupProcessorDeserializer(ObjectDeserializer<Processor.Builder> op)
```

Modifier and Type	Class	Description
`static class`	`Processor.Builder`
`static class`	`Processor.Kind`	`Processor` variant kinds.

Class Processor

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_DESERIALIZER

Constructor Detail

Processor

Method Detail

_kind

_get

of

isAttachment

attachment

isAppend

append

isCsv

csv

isConvert

convert

isDate

date

isDateIndexName

dateIndexName

isDotExpander

dotExpander

isFail

fail

isForeach

foreach

isJson

json

isUserAgent

userAgent

isKv

kv

isGeoip

geoip

isGrok

grok

isGsub

gsub

isJoin

join

isLowercase

lowercase

isRemove

remove

isRename

rename

isScript

script

isSet

set

isSort

sort

isSplit

split

isTrim

trim

isUppercase

uppercase

isUrldecode

urldecode

isBytes

bytes

isDissect

dissect

isSetSecurityUser

setSecurityUser

isPipeline

pipeline

isDrop

drop

isCircle

circle

isInference

inference