Module org.elasticsearch.server
Package org.elasticsearch.indices
Interface IndicesExpressionGrouper
- All Known Implementing Classes:
RemoteClusterService
public interface IndicesExpressionGrouper
Interface for grouping index expressions, along with IndicesOptions by cluster alias.
Implementations should support the following:
- plain index names
- cluster:index notation
- date math expression, including date math prefixed by a clusterAlias
- wildcards
- multiple index expressions (e.g., logs1,logs2,cluster-a:logs*)
Note: these methods do not resolve index expressions to concrete indices.
-
Method Summary
Modifier and TypeMethodDescriptiondefault Map<String, OriginalIndices> groupIndices(IndicesOptions indicesOptions, String indexExpressionCsv) groupIndices(IndicesOptions indicesOptions, String[] indexExpressions) Same behavior as the other groupIndices, except the incoming multiple index expressions must already be parsed into a String array.
-
Method Details
-
groupIndices
default Map<String,OriginalIndices> groupIndices(IndicesOptions indicesOptions, String indexExpressionCsv) - Parameters:
indicesOptions- IndicesOptions to clarify how the index expression should be parsed/appliedindexExpressionCsv- Multiple index expressions as CSV string (with no spaces), e.g., "logs1,logs2,cluster-a:logs1". A single index expression is also supported.- Returns:
- Map where the key is the cluster alias (for "local" cluster, it is RemoteClusterAware.LOCAL_CLUSTER_GROUP_KEY) and the value for that cluster from the index expression is an OriginalIndices object.
-
groupIndices
Same behavior as the other groupIndices, except the incoming multiple index expressions must already be parsed into a String array.- Parameters:
indicesOptions- IndicesOptions to clarify how the index expressions should be parsed/appliedindexExpressions- Multiple index expressions as string[].- Returns:
- Map where the key is the cluster alias (for "local" cluster, it is RemoteClusterAware.LOCAL_CLUSTER_GROUP_KEY) and the value for that cluster from the index expression is an OriginalIndices object.
-