Package org.opensearch.client.opensearch.ingest

Class CsvProcessor.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

org.opensearch.client.opensearch.ingest.CsvProcessor.Builder

All Implemented Interfaces:

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

Enclosing class:

CsvProcessor

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

Builder for CsvProcessor.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CsvProcessor	build()	Builds a CsvProcessor.
CsvProcessor.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final CsvProcessor.Builder	emptyValue(JsonData value)	Value used to fill empty fields.
final CsvProcessor.Builder	field(String value)	Required - API name: field
final CsvProcessor.Builder	ignoreMissing(Boolean value)	If true and field does not exist, the processor quietly exits without modifying the document.
final CsvProcessor.Builder	quote(String value)	Quote used in CSV, has to be single character string.
protected CsvProcessor.Builder	self()
final CsvProcessor.Builder	separator(String value)	Separator used in CSV, has to be single character string.
final CsvProcessor.Builder	targetFields(String value, String... values)	Required - API name: target_fields
final CsvProcessor.Builder	targetFields(List<String> list)	Required - API name: target_fields
final CsvProcessor.Builder	trim(Boolean value)	Trim white spaces in unquoted fields.

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 CsvProcessor.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<CsvProcessor.Builder,CsvProcessor>

Returns:

a new builder instance.

self

@Nonnull
protected CsvProcessor.Builder self()

Specified by:

self in class ProcessorBase.AbstractBuilder<CsvProcessor.Builder>

emptyValue

@Nonnull
public final CsvProcessor.Builder emptyValue(@Nullable
 JsonData value)

Value used to fill empty fields. Empty fields are skipped if this is not provided. An empty field is one with no value (2 consecutive separators) or empty quotes ("").

API name: empty_value

field

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

Required - API name: field

ignoreMissing

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

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

API name: ignore_missing

quote

@Nonnull
public final CsvProcessor.Builder quote(@Nullable
 String value)

Quote used in CSV, has to be single character string.

API name: quote

separator

@Nonnull
public final CsvProcessor.Builder separator(@Nullable
 String value)

Separator used in CSV, has to be single character string.

API name: separator

targetFields

@Nonnull
public final CsvProcessor.Builder targetFields(List<String> list)

Required - API name: target_fields

Adds all elements of list to targetFields.

targetFields

@Nonnull
public final CsvProcessor.Builder targetFields(String value,
 String... values)

Required - API name: target_fields

Adds one or more values to targetFields.

trim

@Nonnull
public final CsvProcessor.Builder trim(@Nullable
 Boolean value)

Trim white spaces in unquoted fields.

API name: trim

build

@Nonnull
public CsvProcessor build()

Builds a CsvProcessor.

Specified by:

build in interface ObjectBuilder<CsvProcessor>

Throws:

NullPointerException - if some of the required fields are null.