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 ClassesNested classes/interfaces inherited from class org.opensearch.client.opensearch.ingest.ProcessorBase
ProcessorBase.AbstractBuilder<BuilderT extends ProcessorBase.AbstractBuilder<BuilderT>> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final JsonpDeserializer<AttachmentProcessor> Json deserializer forAttachmentProcessor -
Method Summary
Modifier and TypeMethodDescriptionProcessorvariant kind.static AttachmentProcessor.Builderbuilder()booleanfinal Stringfield()Required - API name:fieldinthashCode()final BooleanIftrueand field does not exist, the processor quietly exits without modifying the document.final LongThe number of chars being used for extraction to prevent huge fields.final StringAPI name:indexed_chars_fieldstatic AttachmentProcessorArray of properties to select to be stored.final StringField containing the name of the resource to decode.protected voidserializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static voidfinal StringAPI name:target_fieldCreate a new builderToCopyableBuilderthat 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, tagMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.opensearch.client.json.PlainJsonSerializable
toJsonStringMethods inherited from interface org.opensearch.client.opensearch.ingest.ProcessorVariant
toProcessorMethods inherited from interface org.opensearch.client.util.ToCopyableBuilder
copy
-
Field Details
-
_DESERIALIZER
Json deserializer forAttachmentProcessor
-
-
Method Details
-
of
public static AttachmentProcessor of(Function<AttachmentProcessor.Builder, ObjectBuilder<AttachmentProcessor>> fn) -
_processorKind
Processorvariant kind.- Specified by:
_processorKindin interfaceProcessorVariant
-
field
Required - API name:field -
ignoreMissing
Iftrueand field does not exist, the processor quietly exits without modifying the document.API name:
ignore_missing -
indexedChars
The number of chars being used for extraction to prevent huge fields. Use-1for no limit.API name:
indexed_chars -
indexedCharsField
API name:indexed_chars_field -
properties
Array of properties to select to be stored. Can becontent,title,name,author,keywords,date,content_type,content_length,language.API name:
properties -
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
API name:target_field -
serializeInternal
- Overrides:
serializeInternalin classProcessorBase
-
toBuilder
Description copied from interface:ToCopyableBuilderCreate a new builderToCopyableBuilderthat is initialised with the current state of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<AttachmentProcessor.Builder,AttachmentProcessor> - Returns:
- a new builder instance.
-
builder
-
setupAttachmentProcessorDeserializer
protected static void setupAttachmentProcessorDeserializer(ObjectDeserializer<AttachmentProcessor.Builder> op) -
hashCode
public int hashCode()- Overrides:
hashCodein classProcessorBase
-
equals
- Overrides:
equalsin classProcessorBase
-