Module org.elasticsearch.server

Package org.elasticsearch.indices.system

Interface SystemResourceDescriptor

All Superinterfaces:

IndexMatcher

All Known Implementing Classes:

SystemDataStreamDescriptor, SystemIndexDescriptor

public interface SystemResourceDescriptor
extends IndexMatcher

Method Summary

Modifier and Type	Method	Description
List<String>	getAllowedElasticProductOrigins()	Requests from these products, if made with the proper security credentials, are allowed non-deprecated access to this descriptor's indices.
String	getDescription()
String	getOrigin()	Get an origin string suitable for use in an OriginSettingClient.
ExecutorNames	getThreadPoolNames()
boolean	isAutomaticallyManaged()
boolean	isExternal()

Methods inherited from interface org.elasticsearch.indices.IndexMatcher

getMatchingIndices

Method Details

getDescription

String getDescription()

Returns:

A short description of the purpose of this system resource.

isAutomaticallyManaged

boolean isAutomaticallyManaged()

getOrigin

String getOrigin()

Get an origin string suitable for use in an OriginSettingClient. See SystemIndexDescriptor.Builder.setOrigin(String) for more information.

Returns:

an origin string to use for sub-requests

isExternal

boolean isExternal()

getAllowedElasticProductOrigins

List<String> getAllowedElasticProductOrigins()

Requests from these products, if made with the proper security credentials, are allowed non-deprecated access to this descriptor's indices. (Product names may be specified in requests with the Task.X_ELASTIC_PRODUCT_ORIGIN_HTTP_HEADER).

Returns:

A list of product names.

getThreadPoolNames

ExecutorNames getThreadPoolNames()

Returns:

The names of thread pools that should be used for operations on this system index.