Class DataStream
java.lang.Object
org.elasticsearch.cluster.AbstractDiffable<DataStream>
org.elasticsearch.cluster.metadata.DataStream
- All Implemented Interfaces:
Diffable<DataStream>
,Writeable
,org.elasticsearch.xcontent.ToXContent
,org.elasticsearch.xcontent.ToXContentObject
public final class DataStream
extends AbstractDiffable<DataStream>
implements org.elasticsearch.xcontent.ToXContentObject
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params
Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
static final DateFormatter
static final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ParseField
static final Version
The version when data stream metadata, hidden and replicated data streams, and dates in backing index names was introduced.static final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ParseField
static Comparator<org.apache.lucene.index.LeafReader>
static final org.elasticsearch.xcontent.ParseField
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
-
Constructor Summary
ConstructorDescriptionDataStream
(String name, DataStream.TimestampField timeStampField, List<Index> indices, long generation, Map<String, Object> metadata, boolean hidden, boolean replicated, boolean system) -
Method Summary
Modifier and TypeMethodDescriptionaddBackingIndex
(Metadata clusterMetadata, Index index) Adds the specified index as a backing index and returns a newDataStream
instance with the new combination of backing indices.boolean
static DataStream
fromXContent
(org.elasticsearch.xcontent.XContentParser parser) static String
getDefaultBackingIndexName
(String dataStreamName, long generation) Generates the name of the index that conforms to the default naming convention for backing indices on data streams given the specified data stream name and generation and the current system time.static String
getDefaultBackingIndexName
(String dataStreamName, long generation, long epochMillis) Generates the name of the index that conforms to the default naming convention for backing indices on data streams given the specified data stream name, generation, and time.static String
getDefaultBackingIndexName
(String dataStreamName, long generation, long epochMillis, Version minNodeVersion) static String
getDefaultBackingIndexName
(String dataStreamName, long generation, Version minNodeVersion) long
static String
getLegacyDefaultBackingIndexName
(String dataStreamName, long generation) getName()
int
hashCode()
boolean
isHidden()
boolean
Determines whether this data stream is replicated from elsewhere, for example a remote cluster.boolean
isSystem()
nextWriteIndexAndGeneration
(Metadata clusterMetadata, Version minNodeVersion) Performs a dummy rollover on aDataStream
instance and returns the tuple of the next write index name and next generation that thisDataStream
should roll over to usingrollover(Index, long)
.static Diff<DataStream>
removeBackingIndex
(Index index) Removes the specified backing index and returns a newDataStream
instance with the remaining backing indices.replaceBackingIndex
(Index existingBackingIndex, Index newBackingIndex) Replaces the specified backing index with a new index and returns a newDataStream
instance with the modified backing indices.Performs a rollover on aDataStream
instance and returns a new instance containing the updated list of backing indices and incremented generation.snapshot
(Collection<String> indicesInSnapshot) Reconciles this data stream with a list of indices available in a snapshot.org.elasticsearch.xcontent.XContentBuilder
toXContent
(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) unsafeNextWriteIndexAndGeneration
(Metadata clusterMetadata, Version minNodeVersion) LikenextWriteIndexAndGeneration(Metadata, Version)
, but does no validation, use with care only.unsafeRollover
(Index writeIndex, long generation) Likerollover(Index, long)
, but does no validation, use with care only.void
writeTo
(StreamOutput out) Write this into the StreamOutput.Methods inherited from class org.elasticsearch.cluster.AbstractDiffable
diff, readDiffFrom
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Field Details
-
BACKING_INDEX_PREFIX
- See Also:
-
DATE_FORMATTER
-
TIMESERIES_LEAF_READERS_SORTER
-
NEW_FEATURES_VERSION
The version when data stream metadata, hidden and replicated data streams, and dates in backing index names was introduced. -
NAME_FIELD
public static final org.elasticsearch.xcontent.ParseField NAME_FIELD -
TIMESTAMP_FIELD_FIELD
public static final org.elasticsearch.xcontent.ParseField TIMESTAMP_FIELD_FIELD -
INDICES_FIELD
public static final org.elasticsearch.xcontent.ParseField INDICES_FIELD -
GENERATION_FIELD
public static final org.elasticsearch.xcontent.ParseField GENERATION_FIELD -
METADATA_FIELD
public static final org.elasticsearch.xcontent.ParseField METADATA_FIELD -
HIDDEN_FIELD
public static final org.elasticsearch.xcontent.ParseField HIDDEN_FIELD -
REPLICATED_FIELD
public static final org.elasticsearch.xcontent.ParseField REPLICATED_FIELD -
SYSTEM_FIELD
public static final org.elasticsearch.xcontent.ParseField SYSTEM_FIELD
-
-
Constructor Details
-
DataStream
-
DataStream
- Throws:
IOException
-
-
Method Details
-
getName
-
getTimeStampField
-
getIndices
-
getGeneration
public long getGeneration() -
getWriteIndex
-
getMetadata
-
isHidden
public boolean isHidden() -
isReplicated
public boolean isReplicated()Determines whether this data stream is replicated from elsewhere, for example a remote cluster.- Returns:
- Whether this data stream is replicated.
-
isSystem
public boolean isSystem() -
rollover
Performs a rollover on aDataStream
instance and returns a new instance containing the updated list of backing indices and incremented generation.- Parameters:
writeIndex
- new write indexgeneration
- new generation- Returns:
- new
DataStream
instance with the rollover operation applied
-
unsafeRollover
Likerollover(Index, long)
, but does no validation, use with care only. -
nextWriteIndexAndGeneration
public org.elasticsearch.core.Tuple<String,Long> nextWriteIndexAndGeneration(Metadata clusterMetadata, Version minNodeVersion) Performs a dummy rollover on aDataStream
instance and returns the tuple of the next write index name and next generation that thisDataStream
should roll over to usingrollover(Index, long)
.- Parameters:
clusterMetadata
- Cluster metadata- Returns:
- new
DataStream
instance with the dummy rollover operation applied
-
unsafeNextWriteIndexAndGeneration
public org.elasticsearch.core.Tuple<String,Long> unsafeNextWriteIndexAndGeneration(Metadata clusterMetadata, Version minNodeVersion) LikenextWriteIndexAndGeneration(Metadata, Version)
, but does no validation, use with care only. -
removeBackingIndex
Removes the specified backing index and returns a newDataStream
instance with the remaining backing indices.- Parameters:
index
- the backing index to remove- Returns:
- new
DataStream
instance with the remaining backing indices - Throws:
IllegalArgumentException
- ifindex
is not a backing index or is the current write index of the data stream
-
replaceBackingIndex
Replaces the specified backing index with a new index and returns a newDataStream
instance with the modified backing indices. AnIllegalArgumentException
is thrown if the index to be replaced is not a backing index for this data stream or if it is theDataStream
's write index.- Parameters:
existingBackingIndex
- the backing index to be replacednewBackingIndex
- the new index that will be part of theDataStream
- Returns:
- new
DataStream
instance with backing indices that contain replacement index instead of the specified existing index.
-
addBackingIndex
Adds the specified index as a backing index and returns a newDataStream
instance with the new combination of backing indices.- Parameters:
index
- index to add to the data stream- Returns:
- new
DataStream
instance with the added backing index - Throws:
IllegalArgumentException
- ifindex
is ineligible to be a backing index for the data stream
-
promoteDataStream
-
snapshot
Reconciles this data stream with a list of indices available in a snapshot. Allows snapshots to store accurate data stream definitions that do not reference backing indices not contained in the snapshot.- Parameters:
indicesInSnapshot
- List of indices in the snapshot- Returns:
- Reconciled
DataStream
instance ornull
if no reconciled version of this data stream could be built from the given indices
-
getDefaultBackingIndexName
Generates the name of the index that conforms to the default naming convention for backing indices on data streams given the specified data stream name and generation and the current system time.- Parameters:
dataStreamName
- name of the data streamgeneration
- generation of the data stream- Returns:
- backing index name
-
getDefaultBackingIndexName
-
getDefaultBackingIndexName
public static String getDefaultBackingIndexName(String dataStreamName, long generation, long epochMillis) Generates the name of the index that conforms to the default naming convention for backing indices on data streams given the specified data stream name, generation, and time.- Parameters:
dataStreamName
- name of the data streamgeneration
- generation of the data streamepochMillis
- creation time for the backing index- Returns:
- backing index name
-
getDefaultBackingIndexName
-
getLegacyDefaultBackingIndexName
-
readDiffFrom
- Throws:
IOException
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput.- Specified by:
writeTo
in interfaceWriteable
- Throws:
IOException
-
fromXContent
public static DataStream fromXContent(org.elasticsearch.xcontent.XContentParser parser) throws IOException - Throws:
IOException
-
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContent
in interfaceorg.elasticsearch.xcontent.ToXContent
- Throws:
IOException
-
equals
-
hashCode
public int hashCode()
-