Package org.opensearch.client.opensearch.ingest

Class AttachmentProcessor

java.lang.Object

org.opensearch.client.opensearch.ingest.ProcessorBase

org.opensearch.client.opensearch.ingest.AttachmentProcessor

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ProcessorVariant, ToCopyableBuilder<AttachmentProcessor.Builder,AttachmentProcessor>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class AttachmentProcessor
extends ProcessorBase
implements ProcessorVariant, ToCopyableBuilder<AttachmentProcessor.Builder,AttachmentProcessor>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AttachmentProcessor.Builder	Builder for AttachmentProcessor.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch.ingest.ProcessorBase

ProcessorBase.AbstractBuilder<BuilderT extends ProcessorBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<AttachmentProcessor>	_DESERIALIZER	Json deserializer for AttachmentProcessor

Method Summary

Modifier and Type	Method	Description
Processor.Kind	_processorKind()	Processor variant kind.
static AttachmentProcessor.Builder	builder()
boolean	equals(Object o)
final String	field()	Required - API name: field
int	hashCode()
final Boolean	ignoreMissing()	If true and field does not exist, the processor quietly exits without modifying the document.
final Long	indexedChars()	The number of chars being used for extraction to prevent huge fields.
final String	indexedCharsField()	API name: indexed_chars_field
static AttachmentProcessor	of(Function<AttachmentProcessor.Builder,ObjectBuilder<AttachmentProcessor>> fn)
final List<String>	properties()	Array of properties to select to be stored.
final String	resourceName()	Field containing the name of the resource to decode.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupAttachmentProcessorDeserializer(ObjectDeserializer<AttachmentProcessor.Builder> op)
final String	targetField()	API name: target_field
AttachmentProcessor.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch.ingest.ProcessorBase

description, if_, ignoreFailure, onFailure, serialize, setupProcessorBaseDeserializer, tag

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.opensearch.ingest.ProcessorVariant

toProcessor

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<AttachmentProcessor> _DESERIALIZER

Json deserializer for AttachmentProcessor

Method Details

of

public static AttachmentProcessor of(Function<AttachmentProcessor.Builder,ObjectBuilder<AttachmentProcessor>> fn)

_processorKind

public Processor.Kind _processorKind()

Processor variant kind.

Specified by:

_processorKind in interface ProcessorVariant

field

@Nonnull
public final String field()

Required - API name: field

ignoreMissing

@Nullable
public final Boolean ignoreMissing()

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

API name: ignore_missing

indexedChars

@Nullable
public final Long indexedChars()

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

API name: indexed_chars

indexedCharsField

@Nullable
public final String indexedCharsField()

API name: indexed_chars_field

properties

@Nonnull
public final List<String> properties()

Array of properties to select to be stored. Can be content, title, name, author, keywords, date, content_type, content_length, language.

API name: properties

resourceName

@Nullable
public final String resourceName()

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.

API name: resource_name

targetField

@Nullable
public final String targetField()

API name: target_field

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Overrides:

serializeInternal in class ProcessorBase

toBuilder

@Nonnull
public AttachmentProcessor.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<AttachmentProcessor.Builder,AttachmentProcessor>

Returns:

a new builder instance.

builder

@Nonnull
public static AttachmentProcessor.Builder builder()

setupAttachmentProcessorDeserializer

protected static void setupAttachmentProcessorDeserializer(ObjectDeserializer<AttachmentProcessor.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class ProcessorBase

equals

public boolean equals(Object o)

Overrides:

equals in class ProcessorBase