Package org.opensearch.ratelimitting.admissioncontrol

Class AdmissionControlSettings

java.lang.Object

org.opensearch.ratelimitting.admissioncontrol.AdmissionControlSettings

public final class AdmissionControlSettings
extends Object

Settings related to admission control.

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AdmissionControlSettings.Defaults	Default parameters for the AdmissionControlSettings

Field Summary

Fields

Modifier and Type	Field	Description
static final Setting<AdmissionControlMode>	ADMISSION_CONTROL_TRANSPORT_LAYER_MODE	Feature level setting to operate in shadow-mode or in enforced-mode.

Constructor Summary

Constructors

Constructor	Description
AdmissionControlSettings(ClusterSettings clusterSettings, Settings settings)

Method Summary

Modifier and Type	Method	Description
AdmissionControlMode	getAdmissionControlTransportLayerMode()
Boolean	isTransportLayerAdmissionControlEnabled()
Boolean	isTransportLayerAdmissionControlEnforced()

Methods inherited from class java.lang.Object

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

Field Details

ADMISSION_CONTROL_TRANSPORT_LAYER_MODE

public static final Setting<AdmissionControlMode> ADMISSION_CONTROL_TRANSPORT_LAYER_MODE

Feature level setting to operate in shadow-mode or in enforced-mode. If enforced field is set rejection will be performed, otherwise only rejection metrics will be populated.

Constructor Details

AdmissionControlSettings

public AdmissionControlSettings(ClusterSettings clusterSettings,
 Settings settings)

Parameters:

clusterSettings - clusterSettings Instance

settings - settings instance

Method Details

getAdmissionControlTransportLayerMode

public AdmissionControlMode getAdmissionControlTransportLayerMode()

Returns:

return the default mode of the admissionControl

isTransportLayerAdmissionControlEnforced

public Boolean isTransportLayerAdmissionControlEnforced()

Returns:

true based on the admission control feature is enforced else false

isTransportLayerAdmissionControlEnabled

public Boolean isTransportLayerAdmissionControlEnabled()

Returns:

true based on the admission control feature is enabled else false