Module org.elasticsearch.server

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

Class TransportGetSampleConfigurationAction

java.lang.Object

org.elasticsearch.action.support.TransportAction<GetSampleConfigurationAction.Request,GetSampleConfigurationAction.Response>

org.elasticsearch.action.support.local.TransportLocalClusterStateAction<GetSampleConfigurationAction.Request,GetSampleConfigurationAction.Response>

org.elasticsearch.action.support.local.TransportLocalProjectMetadataAction<GetSampleConfigurationAction.Request,GetSampleConfigurationAction.Response>

org.elasticsearch.action.admin.indices.sampling.TransportGetSampleConfigurationAction

public class TransportGetSampleConfigurationAction
extends TransportLocalProjectMetadataAction<GetSampleConfigurationAction.Request,GetSampleConfigurationAction.Response>

Transport action for retrieving sampling configuration for an index.

This action retrieves the sampling configuration from the project metadata's custom sampling metadata. If no configuration exists for the specified index, a response with null configuration is returned.

Field Summary

Fields inherited from class org.elasticsearch.action.support.local.TransportLocalClusterStateAction

clusterService, executor

Fields inherited from class org.elasticsearch.action.support.TransportAction

actionName, taskManager

Constructor Summary

Constructors

Constructor	Description
TransportGetSampleConfigurationAction(ActionFilters actionFilters, TransportService transportService, ClusterService clusterService, ProjectResolver projectResolver, IndexNameExpressionResolver indexNameExpressionResolver)	Constructs a new TransportGetSampleConfigurationAction.

Method Summary

Modifier and Type	Method	Description
protected ClusterBlockException	checkBlock(GetSampleConfigurationAction.Request request, ProjectState state)	Checks for cluster blocks that would prevent this operation from executing.
protected void	localClusterStateOperation(Task task, GetSampleConfigurationAction.Request request, ProjectState state, ActionListener<GetSampleConfigurationAction.Response> listener)	Executes the get sampling configuration operation against the local cluster state.

Methods inherited from class org.elasticsearch.action.support.local.TransportLocalProjectMetadataAction

checkBlock, localClusterStateOperation

Methods inherited from class org.elasticsearch.action.support.local.TransportLocalClusterStateAction

doExecute

Methods inherited from class org.elasticsearch.action.support.TransportAction

execute, executeDirect, localOnly

Methods inherited from class java.lang.Object

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

Constructor Details

TransportGetSampleConfigurationAction

@Inject
public TransportGetSampleConfigurationAction(ActionFilters actionFilters,
 TransportService transportService,
 ClusterService clusterService,
 ProjectResolver projectResolver,
 IndexNameExpressionResolver indexNameExpressionResolver)

Constructs a new TransportGetSampleConfigurationAction.

Parameters:

actionFilters - the action filters to apply

transportService - the transport service

clusterService - the cluster service

projectResolver - the project resolver

indexNameExpressionResolver - the index name expression resolver for resolving index names

Method Details

localClusterStateOperation

protected void localClusterStateOperation(Task task,
 GetSampleConfigurationAction.Request request,
 ProjectState state,
 ActionListener<GetSampleConfigurationAction.Response> listener)

Executes the get sampling configuration operation against the local cluster state.

Retrieves the sampling configuration for the specified index from the project metadata. Returns null configuration if no sampling metadata exists or if no configuration is set for the index.

Specified by:

localClusterStateOperation in class TransportLocalProjectMetadataAction<GetSampleConfigurationAction.Request,GetSampleConfigurationAction.Response>

Parameters:

task - the task executing this operation

request - the get sampling configuration request containing the index name

state - the current project state

listener - the listener to notify with the response or failure

checkBlock

protected ClusterBlockException checkBlock(GetSampleConfigurationAction.Request request,
 ProjectState state)

Checks for cluster blocks that would prevent this operation from executing.

Specified by:

checkBlock in class TransportLocalProjectMetadataAction<GetSampleConfigurationAction.Request,GetSampleConfigurationAction.Response>

Parameters:

request - the get sampling configuration request

state - the current project state

Returns:

a cluster block exception if the operation is blocked, null otherwise