Package org.opensearch.client.opensearch.ingest

Class AttachmentProcessor.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch.ingest.ProcessorBase.AbstractBuilder<AttachmentProcessor.Builder>

org.opensearch.client.opensearch.ingest.AttachmentProcessor.Builder

All Implemented Interfaces:

CopyableBuilder<AttachmentProcessor.Builder,AttachmentProcessor>, MutableBuilder<AttachmentProcessor.Builder,AttachmentProcessor>, ObjectBuilder<AttachmentProcessor>

Enclosing class:

AttachmentProcessor

public static class AttachmentProcessor.Builder
extends ProcessorBase.AbstractBuilder<AttachmentProcessor.Builder>
implements CopyableBuilder<AttachmentProcessor.Builder,AttachmentProcessor>

Builder for AttachmentProcessor.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AttachmentProcessor	build()	Builds a AttachmentProcessor.
AttachmentProcessor.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final AttachmentProcessor.Builder	field(String value)	Required - API name: field
final AttachmentProcessor.Builder	ignoreMissing(Boolean value)	If true and field does not exist, the processor quietly exits without modifying the document.
final AttachmentProcessor.Builder	indexedChars(Long value)	The number of chars being used for extraction to prevent huge fields.
final AttachmentProcessor.Builder	indexedCharsField(String value)	API name: indexed_chars_field
final AttachmentProcessor.Builder	properties(String value, String... values)	Array of properties to select to be stored.
final AttachmentProcessor.Builder	properties(List<String> list)	Array of properties to select to be stored.
final AttachmentProcessor.Builder	resourceName(String value)	Field containing the name of the resource to decode.
protected AttachmentProcessor.Builder	self()
final AttachmentProcessor.Builder	targetField(String value)	API name: target_field

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

description, if_, ignoreFailure, onFailure, onFailure, onFailure, tag

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

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

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public AttachmentProcessor.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<AttachmentProcessor.Builder,AttachmentProcessor>

Returns:

a new builder instance.

self

@Nonnull
protected AttachmentProcessor.Builder self()

Specified by:

self in class ProcessorBase.AbstractBuilder<AttachmentProcessor.Builder>

field

@Nonnull
public final AttachmentProcessor.Builder field(String value)

Required - API name: field

ignoreMissing

@Nonnull
public final AttachmentProcessor.Builder ignoreMissing(@Nullable
 Boolean value)

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

API name: ignore_missing

indexedChars

@Nonnull
public final AttachmentProcessor.Builder indexedChars(@Nullable
 Long value)

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

API name: indexed_chars

indexedCharsField

@Nonnull
public final AttachmentProcessor.Builder indexedCharsField(@Nullable
 String value)

API name: indexed_chars_field

properties

@Nonnull
public final AttachmentProcessor.Builder properties(List<String> list)

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

API name: properties

Adds all elements of list to properties.

properties

@Nonnull
public final AttachmentProcessor.Builder properties(String value,
 String... values)

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

API name: properties

Adds one or more values to properties.

resourceName

@Nonnull
public final AttachmentProcessor.Builder resourceName(@Nullable
 String value)

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

@Nonnull
public final AttachmentProcessor.Builder targetField(@Nullable
 String value)

API name: target_field

build

@Nonnull
public AttachmentProcessor build()

Builds a AttachmentProcessor.

Specified by:

build in interface ObjectBuilder<AttachmentProcessor>

Throws:

NullPointerException - if some of the required fields are null.