Package org.opensearch.client.opensearch.ingest

Class CsvProcessor

java.lang.Object

org.opensearch.client.opensearch.ingest.ProcessorBase

org.opensearch.client.opensearch.ingest.CsvProcessor

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

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

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<CsvProcessor>	_DESERIALIZER	Json deserializer for CsvProcessor

Method Summary

Modifier and Type	Method	Description
Processor.Kind	_processorKind()	Processor variant kind.
static CsvProcessor.Builder	builder()
final JsonData	emptyValue()	Value used to fill empty fields.
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.
static CsvProcessor	of(Function<CsvProcessor.Builder,ObjectBuilder<CsvProcessor>> fn)
final String	quote()	Quote used in CSV, has to be single character string.
final String	separator()	Separator used in CSV, has to be single character string.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupCsvProcessorDeserializer(ObjectDeserializer<CsvProcessor.Builder> op)
final List<String>	targetFields()	Required - API name: target_fields
CsvProcessor.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final Boolean	trim()	Trim white spaces in unquoted fields.

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<CsvProcessor> _DESERIALIZER

Json deserializer for CsvProcessor

Method Details

of

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

_processorKind

public Processor.Kind _processorKind()

Processor variant kind.

Specified by:

_processorKind in interface ProcessorVariant

emptyValue

@Nullable
public final JsonData emptyValue()

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 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

quote

@Nullable
public final String quote()

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

API name: quote

separator

@Nullable
public final String separator()

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

API name: separator

targetFields

@Nonnull
public final List<String> targetFields()

Required - API name: target_fields

trim

@Nullable
public final Boolean trim()

Trim white spaces in unquoted fields.

API name: trim

serializeInternal

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

Overrides:

serializeInternal in class ProcessorBase

toBuilder

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

Returns:

a new builder instance.

builder

@Nonnull
public static CsvProcessor.Builder builder()

setupCsvProcessorDeserializer

protected static void setupCsvProcessorDeserializer(ObjectDeserializer<CsvProcessor.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class ProcessorBase

equals

public boolean equals(Object o)

Overrides:

equals in class ProcessorBase