Module org.elasticsearch.server

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

Class GetSampleConfigurationAction

java.lang.Object

org.elasticsearch.action.ActionType<GetSampleConfigurationAction.Response>

org.elasticsearch.action.admin.indices.sampling.GetSampleConfigurationAction

public class GetSampleConfigurationAction
extends ActionType<GetSampleConfigurationAction.Response>

Action type for retrieving sampling configuration for a specific index.

This action allows clients to get the current sampling configuration that has been set on a specific index. This action targets a single index and returns its configuration in a structured format.

The response format matches:

 {
  "index": "logs",
  "configuration": {
      "rate": ".5",
      "if": "ctx?.network?.name == 'Guest'"
  }
 }
  

See Also:

• SamplingConfiguration
• PutSampleConfigurationAction

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetSampleConfigurationAction.Request	Request object for getting the sampling configuration of a specific index.
static class	GetSampleConfigurationAction.Response	Response object containing the sampling configuration for a specific index.

Field Summary

Fields

Modifier and Type	Field	Description
static final GetSampleConfigurationAction	INSTANCE	Singleton instance of the GetSampleConfigurationAction.
static final String	NAME	The name identifier for this action type used in the transport layer.

Method Summary

Methods inherited from class org.elasticsearch.action.ActionType

equals, hashCode, localOnly, name, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

INSTANCE

public static final GetSampleConfigurationAction INSTANCE

Singleton instance of the GetSampleConfigurationAction. This provides a shared reference to the action type throughout the application.

NAME

public static final String NAME

The name identifier for this action type used in the transport layer.

See Also:

• Constant Field Values