Package co.elastic.clients.elasticsearch.indices

Class IndexTemplateWithRollover.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch.indices.IndexTemplateWithRollover.Builder

All Implemented Interfaces:

WithJson<IndexTemplateWithRollover.Builder>, ObjectBuilder<IndexTemplateWithRollover>

Enclosing class:

IndexTemplateWithRollover

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

Builder for IndexTemplateWithRollover.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final IndexTemplateWithRollover.Builder	allowAutoCreate(Boolean value)	API name: allow_auto_create
IndexTemplateWithRollover	build()	Builds a IndexTemplateWithRollover.
final IndexTemplateWithRollover.Builder	composedOf(String value, String... values)	Required - An ordered list of component template names.
final IndexTemplateWithRollover.Builder	composedOf(List<String> list)	Required - An ordered list of component template names.
final IndexTemplateWithRollover.Builder	createdDate(DateTime value)	Date and time when the index template was created.
final IndexTemplateWithRollover.Builder	createdDateMillis(Long value)	Date and time when the index template was created, in milliseconds since the epoch.
final IndexTemplateWithRollover.Builder	dataStream(IndexTemplateDataStreamConfiguration value)	If this object is included, the template is used to create data streams and their backing indices.
final IndexTemplateWithRollover.Builder	dataStream(Function<IndexTemplateDataStreamConfiguration.Builder,ObjectBuilder<IndexTemplateDataStreamConfiguration>> fn)	If this object is included, the template is used to create data streams and their backing indices.
final IndexTemplateWithRollover.Builder	deprecated(Boolean value)	Marks this index template as deprecated.
final IndexTemplateWithRollover.Builder	ignoreMissingComponentTemplates(String value, String... values)	A list of component template names that are allowed to be absent.
final IndexTemplateWithRollover.Builder	ignoreMissingComponentTemplates(List<String> list)	A list of component template names that are allowed to be absent.
final IndexTemplateWithRollover.Builder	indexPatterns(String value, String... values)	Required - Array of wildcard (*) expressions used to match the names of data streams and indices during creation.
final IndexTemplateWithRollover.Builder	indexPatterns(List<String> list)	Required - Array of wildcard (*) expressions used to match the names of data streams and indices during creation.
final IndexTemplateWithRollover.Builder	meta(String key, JsonData value)	Optional user metadata about the index template.
final IndexTemplateWithRollover.Builder	meta(Map<String,JsonData> map)	Optional user metadata about the index template.
final IndexTemplateWithRollover.Builder	modifiedDate(DateTime value)	Date and time when the index template was last modified.
final IndexTemplateWithRollover.Builder	modifiedDateMillis(Long value)	Date and time when the index template was last modified, in milliseconds since the epoch.
final IndexTemplateWithRollover.Builder	priority(Long value)	Priority to determine index template precedence when a new data stream or index is created.
protected IndexTemplateWithRollover.Builder	self()
final IndexTemplateWithRollover.Builder	template(IndexTemplateSummaryWithRollover value)	Template to be applied.
final IndexTemplateWithRollover.Builder	template(Function<IndexTemplateSummaryWithRollover.Builder,ObjectBuilder<IndexTemplateSummaryWithRollover>> fn)	Template to be applied.
final IndexTemplateWithRollover.Builder	version(Long value)	Version number used to manage index templates externally.

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

template

public final IndexTemplateWithRollover.Builder template(@Nullable
 IndexTemplateSummaryWithRollover value)

Template to be applied. It may optionally include an aliases, mappings, or settings configuration.

API name: template

template

public final IndexTemplateWithRollover.Builder template(Function<IndexTemplateSummaryWithRollover.Builder,ObjectBuilder<IndexTemplateSummaryWithRollover>> fn)

Template to be applied. It may optionally include an aliases, mappings, or settings configuration.

API name: template

indexPatterns

public final IndexTemplateWithRollover.Builder indexPatterns(List<String> list)

Required - Array of wildcard (*) expressions used to match the names of data streams and indices during creation.

API name: index_patterns

Adds all elements of list to indexPatterns.

indexPatterns

public final IndexTemplateWithRollover.Builder indexPatterns(String value,
 String... values)

Required - Array of wildcard (*) expressions used to match the names of data streams and indices during creation.

API name: index_patterns

Adds one or more values to indexPatterns.

composedOf

public final IndexTemplateWithRollover.Builder composedOf(List<String> list)

Required - An ordered list of component template names. Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence.

API name: composed_of

Adds all elements of list to composedOf.

composedOf

public final IndexTemplateWithRollover.Builder composedOf(String value,
 String... values)

Required - An ordered list of component template names. Component templates are merged in the order specified, meaning that the last component template specified has the highest precedence.

API name: composed_of

Adds one or more values to composedOf.

version

public final IndexTemplateWithRollover.Builder version(@Nullable
 Long value)

Version number used to manage index templates externally. This number is not automatically generated by Elasticsearch.

API name: version

priority

public final IndexTemplateWithRollover.Builder priority(@Nullable
 Long value)

Priority to determine index template precedence when a new data stream or index is created. The index template with the highest priority is chosen. If no priority is specified the template is treated as though it is of priority 0 (lowest priority). This number is not automatically generated by Elasticsearch.

API name: priority

meta

public final IndexTemplateWithRollover.Builder meta(Map<String,JsonData> map)

Optional user metadata about the index template. May have any contents. This map is not automatically generated by Elasticsearch.

API name: _meta

Adds all entries of map to meta.

meta

public final IndexTemplateWithRollover.Builder meta(String key,
 JsonData value)

Optional user metadata about the index template. May have any contents. This map is not automatically generated by Elasticsearch.

API name: _meta

Adds an entry to meta.

allowAutoCreate

public final IndexTemplateWithRollover.Builder allowAutoCreate(@Nullable
 Boolean value)

API name: allow_auto_create

dataStream

public final IndexTemplateWithRollover.Builder dataStream(@Nullable
 IndexTemplateDataStreamConfiguration value)

If this object is included, the template is used to create data streams and their backing indices. Supports an empty object. Data streams require a matching index template with a data_stream object.

API name: data_stream

dataStream

public final IndexTemplateWithRollover.Builder dataStream(Function<IndexTemplateDataStreamConfiguration.Builder,ObjectBuilder<IndexTemplateDataStreamConfiguration>> fn)

If this object is included, the template is used to create data streams and their backing indices. Supports an empty object. Data streams require a matching index template with a data_stream object.

API name: data_stream

deprecated

public final IndexTemplateWithRollover.Builder deprecated(@Nullable
 Boolean value)

Marks this index template as deprecated. When creating or updating a non-deprecated index template that uses deprecated components, Elasticsearch will emit a deprecation warning.

API name: deprecated

ignoreMissingComponentTemplates

public final IndexTemplateWithRollover.Builder ignoreMissingComponentTemplates(List<String> list)

A list of component template names that are allowed to be absent.

API name: ignore_missing_component_templates

Adds all elements of list to ignoreMissingComponentTemplates.

ignoreMissingComponentTemplates

public final IndexTemplateWithRollover.Builder ignoreMissingComponentTemplates(String value,
 String... values)

A list of component template names that are allowed to be absent.

API name: ignore_missing_component_templates

Adds one or more values to ignoreMissingComponentTemplates.

createdDate

public final IndexTemplateWithRollover.Builder createdDate(@Nullable
 DateTime value)

Date and time when the index template was created. Only returned if the human query parameter is true.

API name: created_date

createdDateMillis

public final IndexTemplateWithRollover.Builder createdDateMillis(@Nullable
 Long value)

Date and time when the index template was created, in milliseconds since the epoch.

API name: created_date_millis

modifiedDate

public final IndexTemplateWithRollover.Builder modifiedDate(@Nullable
 DateTime value)

Date and time when the index template was last modified. Only returned if the human query parameter is true.

API name: modified_date

modifiedDateMillis

public final IndexTemplateWithRollover.Builder modifiedDateMillis(@Nullable
 Long value)

Date and time when the index template was last modified, in milliseconds since the epoch.

API name: modified_date_millis

self

protected IndexTemplateWithRollover.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<IndexTemplateWithRollover.Builder>

build

public IndexTemplateWithRollover build()

Builds a IndexTemplateWithRollover.

Specified by:

build in interface ObjectBuilder<IndexTemplateWithRollover>

Throws:

NullPointerException - if some of the required fields are null.