Package co.elastic.clients.elasticsearch.ingest

Class RedactProcessor.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>

co.elastic.clients.elasticsearch.ingest.ProcessorBase.AbstractBuilder<RedactProcessor.Builder>

co.elastic.clients.elasticsearch.ingest.RedactProcessor.Builder

All Implemented Interfaces:

WithJson<RedactProcessor.Builder>, ObjectBuilder<RedactProcessor>

Enclosing class:

RedactProcessor

public static class RedactProcessor.Builder
extends ProcessorBase.AbstractBuilder<RedactProcessor.Builder>
implements ObjectBuilder<RedactProcessor>

Builder for RedactProcessor.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RedactProcessor	build()	Builds a RedactProcessor.
final RedactProcessor.Builder	field(String value)	Required - The field to be redacted
final RedactProcessor.Builder	ignoreMissing(Boolean value)	If true and field does not exist or is null, the processor quietly exits without modifying the document.
final RedactProcessor.Builder	patternDefinitions(String key, String value)	API name: pattern_definitions
final RedactProcessor.Builder	patternDefinitions(Map<String,String> map)	API name: pattern_definitions
final RedactProcessor.Builder	patterns(String value, String... values)	Required - A list of grok expressions to match and redact named captures with
final RedactProcessor.Builder	patterns(List<String> list)	Required - A list of grok expressions to match and redact named captures with
final RedactProcessor.Builder	prefix(String value)	Start a redacted section with this token
protected RedactProcessor.Builder	self()
final RedactProcessor.Builder	skipIfUnlicensed(Boolean value)	If true and the current license does not support running redact processors, then the processor quietly exits without modifying the document
final RedactProcessor.Builder	suffix(String value)	End a redacted section with this token
final RedactProcessor.Builder	traceRedact(Boolean value)	If true then ingest metadata _ingest._redact._is_redacted is set to true if the document has been redacted

Methods inherited from class co.elastic.clients.elasticsearch.ingest.ProcessorBase.AbstractBuilder

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

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

field

public final RedactProcessor.Builder field(String value)

Required - The field to be redacted

API name: field

patterns

public final RedactProcessor.Builder patterns(List<String> list)

Required - A list of grok expressions to match and redact named captures with

API name: patterns

Adds all elements of list to patterns.

patterns

public final RedactProcessor.Builder patterns(String value,
 String... values)

Required - A list of grok expressions to match and redact named captures with

API name: patterns

Adds one or more values to patterns.

patternDefinitions

public final RedactProcessor.Builder patternDefinitions(Map<String,String> map)

API name: pattern_definitions

Adds all entries of map to patternDefinitions.

patternDefinitions

public final RedactProcessor.Builder patternDefinitions(String key,
 String value)

API name: pattern_definitions

Adds an entry to patternDefinitions.

prefix

public final RedactProcessor.Builder prefix(@Nullable
 String value)

Start a redacted section with this token

API name: prefix

suffix

public final RedactProcessor.Builder suffix(@Nullable
 String value)

End a redacted section with this token

API name: suffix

ignoreMissing

public final RedactProcessor.Builder ignoreMissing(@Nullable
 Boolean value)

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

API name: ignore_missing

skipIfUnlicensed

public final RedactProcessor.Builder skipIfUnlicensed(@Nullable
 Boolean value)

If true and the current license does not support running redact processors, then the processor quietly exits without modifying the document

API name: skip_if_unlicensed

traceRedact

public final RedactProcessor.Builder traceRedact(@Nullable
 Boolean value)

If true then ingest metadata _ingest._redact._is_redacted is set to true if the document has been redacted

API name: trace_redact

self

protected RedactProcessor.Builder self()

Specified by:

self in class ProcessorBase.AbstractBuilder<RedactProcessor.Builder>

build

public RedactProcessor build()

Builds a RedactProcessor.

Specified by:

build in interface ObjectBuilder<RedactProcessor>

Throws:

NullPointerException - if some of the required fields are null.