Package org.elasticsearch.indices
Class SystemDataStreamDescriptor
java.lang.Object
org.elasticsearch.indices.SystemDataStreamDescriptor
public class SystemDataStreamDescriptor
extends java.lang.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(java.lang.String dataStreamName, java.lang.String description, SystemDataStreamDescriptor.Type type, ComposableIndexTemplate composableIndexTemplate, java.util.Map<java.lang.String,ComponentTemplate> componentTemplates, java.util.List<java.lang.String> allowedElasticProductOrigins)
Creates a new descriptor for a system data descriptor -
Method Summary
Modifier and Type Method Description java.util.List<java.lang.String>
getAllowedElasticProductOrigins()
java.lang.String
getBackingIndexPattern()
java.util.Map<java.lang.String,ComponentTemplate>
getComponentTemplates()
ComposableIndexTemplate
getComposableIndexTemplate()
java.lang.String
getDataStreamName()
java.lang.String
getDescription()
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(java.lang.String dataStreamName, java.lang.String description, SystemDataStreamDescriptor.Type type, ComposableIndexTemplate composableIndexTemplate, java.util.Map<java.lang.String,ComponentTemplate> componentTemplates, java.util.List<java.lang.String> allowedElasticProductOrigins)Creates a new descriptor for a system data descriptor- Parameters:
dataStreamName
- the name of the data stream. Must not benull
description
- a brief description of what the data stream is used for. Must not benull
type
- theSystemDataStreamDescriptor.Type
of the data stream which determines how the data stream can be accessed. Must not benull
composableIndexTemplate
- theComposableIndexTemplate
that contains the mappings and settings for the data stream. Must not benull
componentTemplates
- a map that containsComponentTemplate
instances corresponding to those references in theComposableIndexTemplate
allowedElasticProductOrigins
- a list of product origin values that are allowed to access this data stream if the type isSystemDataStreamDescriptor.Type.EXTERNAL
. Must not benull
-
-
Method Details
-
getDataStreamName
public java.lang.String getDataStreamName() -
getDescription
public java.lang.String getDescription() -
getComposableIndexTemplate
-
isExternal
public boolean isExternal() -
getBackingIndexPattern
public java.lang.String getBackingIndexPattern() -
getAllowedElasticProductOrigins
public java.util.List<java.lang.String> getAllowedElasticProductOrigins() -
getComponentTemplates
-