Module org.elasticsearch.server

Package org.elasticsearch.action.admin.indices.sampling

Class RestGetSampleConfigurationAction

java.lang.Object

org.elasticsearch.rest.BaseRestHandler

org.elasticsearch.action.admin.indices.sampling.RestGetSampleConfigurationAction

All Implemented Interfaces:

RestHandler

public class RestGetSampleConfigurationAction
extends BaseRestHandler

REST action for getting sampling configurations for indices.

Handles GET requests to /{index}/_sample/config endpoint and delegates to the GetSampleConfigurationAction transport action.

Example usage:

GET /my-index/_sample/config returns { "index": "logs", "configuration": { "rate": "5%", "if": "ctx?.network?.name == 'Guest'" } }

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.rest.BaseRestHandler

BaseRestHandler.RequestBodyChunkConsumer, BaseRestHandler.RestChannelConsumer

Nested classes/interfaces inherited from interface org.elasticsearch.rest.RestHandler

RestHandler.Route

Field Summary

Fields inherited from class org.elasticsearch.rest.BaseRestHandler

MULTI_ALLOW_EXPLICIT_INDEX

Constructor Summary

Constructors

Constructor	Description
RestGetSampleConfigurationAction()

Method Summary

Modifier and Type	Method	Description
String	getName()
BaseRestHandler.RestChannelConsumer	prepareRequest(RestRequest request, NodeClient client)	Prepare the request for execution.
List<RestHandler.Route>	routes()	The list of RestHandler.Routes that this RestHandler is responsible for handling.

Methods inherited from class org.elasticsearch.rest.BaseRestHandler

getUsageCount, handleRequest, responseParams, responseParams, unrecognized

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.rest.RestHandler

allowSystemIndexAccessByDefault, allSupportedParameters, canTripCircuitBreaker, getConcreteRestHandler, getServerlessScope, mediaTypesValid, supportedCapabilities, supportedQueryParameters, supportsContentStream

Constructor Details

RestGetSampleConfigurationAction

public RestGetSampleConfigurationAction()

Method Details

routes

public List<RestHandler.Route> routes()

Description copied from class: BaseRestHandler

The list of RestHandler.Routes that this RestHandler is responsible for handling.

Specified by:

routes in interface RestHandler

Specified by:

routes in class BaseRestHandler

getName

public String getName()

Specified by:

getName in interface RestHandler

Specified by:

getName in class BaseRestHandler

Returns:

the name of this handler. The name should be human readable and should describe the action that will performed when this API is called. This name is used in the response to the RestNodesUsageAction.

prepareRequest

public BaseRestHandler.RestChannelConsumer prepareRequest(RestRequest request,
 NodeClient client)
                                                   throws IOException

Description copied from class: BaseRestHandler

Prepare the request for execution. Implementations should consume all request params before returning the runnable for actual execution. Unconsumed params will immediately terminate execution of the request. However, some params are only used in processing the response; implementations can override BaseRestHandler.responseParams() to indicate such params.

Specified by:

prepareRequest in class BaseRestHandler

Parameters:

request - the request to execute

client - client for executing actions on the local node

Returns:

the action to execute

Throws:

IOException - if an I/O exception occurred parsing the request and preparing for execution