Package org.elasticsearch.indices

Class SystemDataStreamDescriptor

java.lang.Object

org.elasticsearch.indices.SystemDataStreamDescriptor

public class SystemDataStreamDescriptor
extends Object

Describes a DataStream that is reserved for use by a system component. The data stream will be managed by the system and also protected by the system against user modification so that system features are not broken by inadvertent user operations.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SystemDataStreamDescriptor.Type

Constructor Summary

Constructors

Constructor	Description
SystemDataStreamDescriptor(String dataStreamName, String description, SystemDataStreamDescriptor.Type type, ComposableIndexTemplate composableIndexTemplate, Map<String,ComponentTemplate> componentTemplates, List<String> allowedElasticProductOrigins, ExecutorNames executorNames)	Creates a new descriptor for a system data descriptor

Method Summary

Modifier and Type	Method	Description
List<String>	getAllowedElasticProductOrigins()
List<String>	getBackingIndexNames(Metadata metadata)	Retrieve backing indices for this system data stream
String	getBackingIndexPattern()
Map<String,ComponentTemplate>	getComponentTemplates()
ComposableIndexTemplate	getComposableIndexTemplate()
String	getDataStreamName()
String	getDescription()
ExecutorNames	getThreadPoolNames()	Get the names of the thread pools that should be used for operations on this data stream.
boolean	isExternal()

Methods inherited from class java.lang.Object

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

Constructor Details

SystemDataStreamDescriptor

public SystemDataStreamDescriptor(String dataStreamName,
 String description,
 SystemDataStreamDescriptor.Type type,
 ComposableIndexTemplate composableIndexTemplate,
 Map<String,ComponentTemplate> componentTemplates,
 List<String> allowedElasticProductOrigins,
 ExecutorNames executorNames)

Creates a new descriptor for a system data descriptor

Parameters:

dataStreamName - the name of the data stream. Must not be null

description - a brief description of what the data stream is used for. Must not be null

type - the SystemDataStreamDescriptor.Type of the data stream which determines how the data stream can be accessed. Must not be null

composableIndexTemplate - the ComposableIndexTemplate that contains the mappings and settings for the data stream. Must not be null

componentTemplates - a map that contains ComponentTemplate instances corresponding to those references in the ComposableIndexTemplate

allowedElasticProductOrigins - a list of product origin values that are allowed to access this data stream if the type is SystemDataStreamDescriptor.Type.EXTERNAL. Must not be null

executorNames - thread pools that should be used for operations on the system data stream

Method Details

getDataStreamName

public String getDataStreamName()

getBackingIndexNames

public List<String> getBackingIndexNames(Metadata metadata)

Retrieve backing indices for this system data stream

Parameters:

metadata - Metadata in which to look for indices

Returns:

List of names of backing indices

getDescription

public String getDescription()

getComposableIndexTemplate

public ComposableIndexTemplate getComposableIndexTemplate()

isExternal

public boolean isExternal()

getBackingIndexPattern

public String getBackingIndexPattern()

getAllowedElasticProductOrigins

public List<String> getAllowedElasticProductOrigins()

getComponentTemplates

public Map<String,ComponentTemplate> getComponentTemplates()

getThreadPoolNames

public ExecutorNames getThreadPoolNames()

Get the names of the thread pools that should be used for operations on this data stream.

Returns:

Names for get, search, and write executors.