Package co.elastic.clients.elasticsearch.indices.put_data_stream_mappings

Class UpdatedDataStreamMappings.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<UpdatedDataStreamMappings.Builder>

co.elastic.clients.elasticsearch.indices.put_data_stream_mappings.UpdatedDataStreamMappings.Builder

All Implemented Interfaces:

WithJson<UpdatedDataStreamMappings.Builder>, ObjectBuilder<UpdatedDataStreamMappings>

Enclosing class:

UpdatedDataStreamMappings

public static class UpdatedDataStreamMappings.Builder
extends WithJsonObjectBuilderBase<UpdatedDataStreamMappings.Builder>
implements ObjectBuilder<UpdatedDataStreamMappings>

Builder for UpdatedDataStreamMappings.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final UpdatedDataStreamMappings.Builder	appliedToDataStream(boolean value)	Required - If the mappings were successfully applied to the data stream (or would have been, if running in dry_run mode), it is true.
UpdatedDataStreamMappings	build()	Builds a UpdatedDataStreamMappings.
final UpdatedDataStreamMappings.Builder	effectiveMappings(TypeMapping value)	The mappings that are effective on this data stream, taking into account the mappings from the matching index template and the mappings specific to this data stream.
final UpdatedDataStreamMappings.Builder	effectiveMappings(Function<TypeMapping.Builder,ObjectBuilder<TypeMapping>> fn)	The mappings that are effective on this data stream, taking into account the mappings from the matching index template and the mappings specific to this data stream.
final UpdatedDataStreamMappings.Builder	error(String value)	A message explaining why the mappings could not be applied to the data stream.
final UpdatedDataStreamMappings.Builder	mappings(TypeMapping value)	The mappings that are specfic to this data stream that will override any mappings from the matching index template.
final UpdatedDataStreamMappings.Builder	mappings(Function<TypeMapping.Builder,ObjectBuilder<TypeMapping>> fn)	The mappings that are specfic to this data stream that will override any mappings from the matching index template.
final UpdatedDataStreamMappings.Builder	name(String value)	Required - The data stream name.
protected UpdatedDataStreamMappings.Builder	self()

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

name

public final UpdatedDataStreamMappings.Builder name(String value)

Required - The data stream name.

API name: name

appliedToDataStream

public final UpdatedDataStreamMappings.Builder appliedToDataStream(boolean value)

Required - If the mappings were successfully applied to the data stream (or would have been, if running in dry_run mode), it is true. If an error occurred, it is false.

API name: applied_to_data_stream

error

public final UpdatedDataStreamMappings.Builder error(@Nullable
 String value)

A message explaining why the mappings could not be applied to the data stream.

API name: error

mappings

public final UpdatedDataStreamMappings.Builder mappings(@Nullable
 TypeMapping value)

The mappings that are specfic to this data stream that will override any mappings from the matching index template.

API name: mappings

mappings

public final UpdatedDataStreamMappings.Builder mappings(Function<TypeMapping.Builder,ObjectBuilder<TypeMapping>> fn)

The mappings that are specfic to this data stream that will override any mappings from the matching index template.

API name: mappings

effectiveMappings

public final UpdatedDataStreamMappings.Builder effectiveMappings(@Nullable
 TypeMapping value)

The mappings that are effective on this data stream, taking into account the mappings from the matching index template and the mappings specific to this data stream.

API name: effective_mappings

effectiveMappings

public final UpdatedDataStreamMappings.Builder effectiveMappings(Function<TypeMapping.Builder,ObjectBuilder<TypeMapping>> fn)

The mappings that are effective on this data stream, taking into account the mappings from the matching index template and the mappings specific to this data stream.

API name: effective_mappings

self

protected UpdatedDataStreamMappings.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<UpdatedDataStreamMappings.Builder>

build

public UpdatedDataStreamMappings build()

Builds a UpdatedDataStreamMappings.

Specified by:

build in interface ObjectBuilder<UpdatedDataStreamMappings>

Throws:

NullPointerException - if some of the required fields are null.