All Classes and Interfaces
Class
Description
Area under the curve (AUC) of the receiver operating characteristic (ROC).
AbstractAuditMessageFactory interface provides means for creating audit messages.AbstractTransportGetResourcesAction<Resource extends org.elasticsearch.xcontent.ToXContent & Writeable,Request extends AbstractGetResourcesRequest,Response extends AbstractGetResourcesResponse<Resource>>
Abstract transport class for collecting common logic in gathering Resource objects from indices
Accuracy is a metric that answers the following two questions:
1.This action acks a watch in memory, and the index
A ack watch request to ack a watch by name (id)
A ack watch action request builder.
This class contains the status of the watch.
Acknowledged is a Action.Result.StoppedResult with a status of Action.Result.Status.ACKNOWLEDGED for actions that
have been throttled.ConditionFailed is a Action.Result.StoppedResult with a status of Action.Result.Status.FAILURE for actions that have been skipped
because the action's condition failed (either expected or unexpected).Failure is a Action.Result.StoppedResult with a status of Action.Result.Status.FAILURE for actiosn that have failed unexpectedly
(e.g., an exception was thrown in a place that wouldn't expect one, like transformation or an HTTP request).Throttled is a Action.Result.StoppedResult with a status of Action.Result.Status.THROTTLED for actions that have been throttled.A
NamedClusterPrivilege that can be used to define an access to cluster level actions.Parses xcontent to a concrete action of the same type.
This action acks a watch in memory, and the index
A ack watch request to ack a watch by name (id)
A activate watch action request builder.
This class contains the status of the watch.
An expression that evaluates to
true if-and-only-if all its children
evaluate to true.Represents the state of an index's shards allocation, including a user friendly message describing the current state.
Checks whether all shards have been correctly routed in response to an update to the allocation rules for an index.
Autodetect analysis configuration options describes which fields are
analysed and the functions to use.
Analysis limits for autodetect.
Statistics for the data frame analysis
Items to track.
Anomaly Cause POJO.
Methods for handling index naming related functions
Anomaly Record POJO.
The user object for the anonymous user.
An expression that evaluates to
true if at least one of its children
evaluate to true.API key information
Built in user for APM server internals.
A permission that is based on privileges for application (non elasticsearch) capabilities
An application privilege has an application name (e.g.
An
ApplicationPrivilegeDescriptor is a representation of a stored ApplicationPrivilege.Interface implemented by all Requests that manage application privileges
Performs an action which must be performed asynchronously because it may take time to complete.
A class that contains all information related to a submitted async execution.
Service that is capable of retrieving and cleaning up AsyncTasks regardless of their state.
This is an abstract AsyncActionStep that wraps the performed action listener, checking to see
if the action fails due to a snapshot being in progress.
A response of an async search request.
A response of an async search status request.
A task that supports asynchronous execution and provides information necessary for safe temporary storage of results
A service that exposes the CRUD operations for the async task-specific index.
A service that runs a periodic cleanup over the async execution index.
An abstract class that builds an index incrementally.
A step which will be called periodically, waiting for some condition to become true.
Area under the curve (AUC) of the receiver operating characteristic (ROC).
Area under the curve (AUC) of the receiver operating characteristic (ROC).
A class from reading/writing
Authentication objects to/from a
ThreadContext under a specified keyA AuthenticationFailureHandler is responsible for the handling of a request that has failed authentication.
Represents the result of an authentication attempt.
Interface for a token that is used for authentication.
An AuthorizationEngine is responsible for making the core decisions about whether a request
should be authorized or not.
Interface for objects that contains the information needed to authorize a request
Represents the result of authorization.
Implementation of authorization info that is used in cases where we were not able to resolve
the authorization info
An extension of
AuthorizationEngine.AuthorizationResult that is specific to index requests.A class that encapsulates information about the request that is being authorized including
the actual transport request, the authentication, and the action being invoked.
Custom metadata that contains auto follow patterns and what leader indices an auto follow pattern has already followed.
BCrypt implements OpenBSD-style Blowfish password hashing using
the scheme described in "A Future-Adaptable Password Scheme" by
Niels Provos and David Mazieres.
Built in user for beats internals.
Parameters used by both
Classification and Regression analyses.This step changes its
BranchingStep.getNextStepKey() depending on the
outcome of a defined predicate.Bucket Result POJO
A utility class to facilitate iterating over (and modifying) a
Cache.Interface in ES Security for objects that can contribute to a cache-key
This interface allows a
Realm to indicate that it supports caching user credentials
and expose the ability to clear the cache for a given String identifier or all of the cacheA simple calendar object for scheduled (special) events.
Configuration for the categorization analyzer.
The status of categorization for a job.
The categorizer state does not need to be understood on the Java side.
Simple model of an X.509 certificate that is known to X-Pack
Request to change a user's password.
Request to change a user's password.
Some actions cannot be executed on a data stream's write index (eg.
This step is used prior to running a shrink step in order to ensure that the index being shrunk
has a copy of each shard allocated on one particular node (the node used by the require
parameter) and that the shards are not relocating.
This step checks whether the new shrunken index's shards count is a factor of the source index's shards count.
The description of how searches should be chunked.
Evaluation of classification results.
Deletes the index identified by the shrink index name stored in the lifecycle state of the managed index (if any was generated)
Deletes the snapshot designated by the repository and snapshot name present in the lifecycle execution state.
The action for clearing the cache used by native roles that are stored in an index.
The request used to clear the cache for native roles stored in an index.
Request builder for the
ClearRolesCacheRequestThe response object that will be returned when clearing the cache of native roles
Utility class to help with the execution of requests made using a
Client such that they
have the origin as a transient and listeners have the appropriate context upon invocationInvokes a close step on a single index.
A permission that is based on privileges for cluster wide actions, with the optional ability to inspect the request object
Base for implementing cluster action based
ClusterPermission.PermissionCheck.Evaluates whether the cluster actions (optionally for a given request)
is permitted by this permission.
This interface represents a privilege that is used to control access to cluster level actions.
Translates cluster privilege names into concrete implementations
Updates the cluster state, similar to
ClusterStateUpdateTask.Checks whether a condition has been met based on the cluster state.
This step wraps an
ClusterStateWaitStep in order to be able to manipulate what the next step will be, depending on the result of
the wrapped ClusterStateWaitStep.Parses xcontent to a concrete condition of the same type.
A ConfigurableClusterPrivilege is a form of
ClusterPrivilege that can be configured by an Elasticsearch security administrator
within a RoleDescriptor.Categories exist for to segment privileges for the purposes of rendering to XContent.
Static utility class for working with
ConfigurableClusterPrivilege instancesThe
ManageApplicationPrivileges privilege is a ConfigurableClusterPrivilege that grants the
ability to execute actions related to the management of application privileges (Get, Put, Delete) for a subset
of applications (identified by a wildcard-aware application-name).A Connection links exactly two
Vertex objects.An identifier (implements hashcode and equals) that represents a
unique key for a
ConnectionExtracted feature that has a continuous weight value
Copies the execution state data from one index to another, typically after a
new index has been created.
Copy the provided settings from the source to the target index.
An accumulator for simple counts where statistical measures
are not of interest.
Helper class to create simple usage stat counters based on longs
Internally this is a map mapping from String to a long, which is the counter
Calling toNestedMap() will create a nested map, where each dot of the key name will nest deeper
The main reason for this class is that the stats producer should not be worried about how the map is actually nested
ActionType for the creation of an API key
Request class used for the creation of an API key.
Request builder for populating a
CreateApiKeyRequestResponse for the successful creation of an api key
Creates a snapshot of the managed index into the configured repository and snapshot name.
ActionType for creating a new token
Represents a request to create a token based on the provided information.
Request builder used to populate a
CreateTokenRequestResponse containing the token string that was generated from a token creation request.
THIS CLASS IS A FORK OF
CronExpression
FROM THE QUARTZ PROJECT
Provides a parser and evaluator for unix-like cron expressions.Service that provides cryptographic methods based on a shared system key
This is a pre-processor that embeds text into a numerical vector.
Job processed record counts.
Describes the format of the data used in the job and how it should
be interpreted by autodetect.
Enum of the acceptable data formats.
Datafeed configuration options.
A datafeed update contains partial properties to update a
DatafeedConfig.Summarizes information about the fields that is necessary for analysis to generate
the parameters needed for the process configuration.
The
DataTierAllocationDecider is a custom allocation decider that behaves similar to the
FilterAllocationDecider, however it
is specific to the _tier setting for both the cluster and index level.Checks whether all shards have been correctly routed in response to updating the allocation rules for an index in order
to migrate the index to a new tier.
DataTiersFeatureSetUsage represents the xpack usage for data tiers.DataTiersFeatureSetUsage.TierSpecificStats represents statistics about nodes in a single
tier, for example, how many nodes there are, the index count, shard
count, etc.The configuration object for the histograms in the rollup config
{
"groups": [
"date_histogram": {
"field" : "foo",
"interval" : "1d",
"delay": "30d",
"time_zone" : "EST"
}
]
}
CalendarInterval is a
DateHistogramGroupConfig that uses calendar-aware intervals for rolling up data.FixedInterval is a
DateHistogramGroupConfig that uses a fixed time interval for rolling up data.Interval can be specified in 2 ways:
fixed_interval fixed intervals like 1h, 1m, 1d
calendar_interval calendar aware intervals like 1M, 1Y, ...
This class implements
TimestampConverter using the DateTimeFormatter
of the Java 8 time API for parsing timestamps and other classes of that API for converting
timestamps to epoch times.The default implementation of a
AuthenticationFailureHandler.Settings related to "Delegated Authorization" (aka Lookup Realms)
ActionType for delegating PKI authentication
The request object for
TransportDelegatePkiAuthenticationAction containing the certificate chain for the target subject
distinguished name to be granted an access token.The response object for
TransportDelegatePkiAuthenticationAction containing the issued access token.A
LifecycleAction which deletes the index.Service that is capable of retrieving and cleaning up AsyncTasks regardless of their state.
ActionType for deleting application privileges.
A request to delete an application privilege.
Builder for
DeletePrivilegesRequestResponse when deleting application privileges.
ActionType for deleting a role from the security index
ActionType for deleting a role-mapping from the
org.elasticsearch.xpack.security.authc.support.mapper.NativeRoleMappingStore
A request delete a role-mapping from the org.elasticsearch.xpack.security.authc.support.mapper.NativeRoleMappingStore
A builder for requests to delete a role-mapping from the
org.elasticsearch.xpack.security.authc.support.mapper.NativeRoleMappingStore
Response for a role-mapping being deleted from the
org.elasticsearch.xpack.security.authc.support.mapper.NativeRoleMappingStore
A request delete a role from the security index
A builder for requests to delete a role from the security index
Response for a role being deleted from the security index
Deletes a single index.
ActionType for deleting a native user.
A request to delete a native user.
Response when deleting a native user.
This action deletes an watch from in memory, the scheduler and the index
A delete watch request to delete an watch by name (id)
A delete document action request builder.
Information about deprecated items
Defines the fields to be used in the analysis.
Discrete extracted value with a static weight of 1.0
This class helps in evaluating the query field if it is template,
validating the query and checking if the query type is allowed to be used in DLS role query.
Stores document level permissions in the form queries that match all the accessible documents.
The document level permissions may be limited by another set of queries in that case the limited queries are used as an additional filter.
The document level permissions may be limited by another set of queries in that case the limited queries are used as an additional filter.
This is a cache for
BitSet instances that are used with the DocumentSubsetReader.A reader that only exposes documents via
DocumentSubsetReader.getLiveDocs() that matches with the provided role query.Static methods to create Elasticsearch index mappings for the autodetect
persisted objects/documents and configurations
The reserved
elastic superuser.Represents an enrich policy including its configuration.
Utility class similar to org.elasticsearch.xpack.core.watcher.common.stats.Counters, but it is using Enum instead
of string to identify the counter.
Exposes EQL async action names for RBACEngine
Signals that an error was encountered during the execution of a policy on an index.
Defines an evaluation
Encapsulates fields needed by evaluation.
EvaluationMetric class represents a metric to evaluate.The result of an evaluation metric
Encapsulates parameters needed by evaluation.
A negating expression.
Collection of methods to aid in creating and checking for exceptions.
Action used to manually invoke a create snapshot request for a given
snapshot lifecycle policy regardless of schedule.
This action executes a watch, either ignoring the schedule and condition or just the schedule and can execute a subset of the actions,
optionally persisting the history entry
A request to execute a watch by id
A execute watch action request builder.
This class contains the WatchHistory generated by running the watch
Class for tracking the set of Ids returned from some
function a satisfy the required Ids as defined by an
expression that may contain wildcards.
A simple matcher with one purpose to test whether an id
matches a expression that may contain wildcards.
The request object used by the Explain Lifecycle API.
The response object returned by the Explain Lifecycle API.
Utility for calculating current value of exponentially-weighted moving average per fixed-sized time window.
Represents the "model" object to be evaluated within a
RoleMapperExpression.Parses the JSON (XContent) based boolean expression DSL into a tree of
RoleMapperExpression objects.A representation of a single role-mapping for use in NativeRoleMappingStore.
Collects common utility methods needed by various
DataExtractor implementationsA collection of messy feature extractors
Extracted feature values from the text
Allows checking a field's cardinality against given lower and upper bounds
An expression that evaluates to
true if a field (map element) matches
the provided values.Stores patterns to fields which access is granted or denied to and maintains an automaton that can be used to check if permission is
allowed for a specific field.
A service for managing the caching of
FieldPermissions as these may often need to be combined or created and internally they
use an Automaton, which can be costly to create once you account for minimizationRepresents the definition of a
FieldPermissions.A collection of parse fields commonly used by stats objects
A
FilterLeafReader that exposes only a subset
of fields from the underlying wrapped reader.Deprecated.
This class exists for backwards compatibility with 7.12 only
and should not be used for other purposes.
Simple class to parse and store a flush ID.
A
LifecycleAction which force-merges the index.Invokes a force merge on a single index.
Model Forecast POJO.
Model ForecastRequestStats POJO.
A class to hold statistics about forecasts.
Represents a forget follower request.
A
LifecycleAction which freezes the index.Freezes an index.
PreProcessor for frequency encoding a set of categorical values for a given field.
This is a stand-alone read-only engine that maintains an index reader that is opened lazily on calls to
Engine.SearcherSupplier.acquireSearcher(String).Generates a snapshot name for the given index and records it in the index metadata along with the provided snapshot repository.
Generates a unique index name prefixing the original index name with the configured
prefix, concatenated with a random UUID.
This interface provides a way for spatial aggs to easily provide appropriately formatted geoJSON geometry to describe their
aggregated results.
ActionType for retrieving API key(s)
Request for get API key
Response for get API keys.
The result contains information about the API keys that were found.
The result contains information about the API keys that were found.
A request class to get a status update of the async search request
ActionType for retrieving builtin privileges from security
Request to retrieve built-in (cluster/index) privileges.
Response containing one or more application privileges retrieved from the security index
ActionType to obtain information about X.509 (SSL/TLS) certificates that are being used by X-Pack.
Internal only action to get the current running state of a datafeed
This action returns summarized bucket results over multiple jobs.
ActionType for retrieving one or more application privileges from the security index
Request to retrieve one or more application privileges.
Builder for
GetPrivilegesRequestResponse containing one or more application privileges retrieved from the security index
ActionType to retrieve one or more role-mappings from X-Pack security
see org.elasticsearch.xpack.security.authc.support.mapper.NativeRoleMappingStore
Request to retrieve role-mappings from X-Pack security
see org.elasticsearch.xpack.security.authc.support.mapper.NativeRoleMappingStore
Builder for a request to retrieve role-mappings from X-Pack security
see org.elasticsearch.xpack.security.authc.support.mapper.NativeRoleMappingStore
Response to
get role-mappings API.ActionType to retrieve a role from the security index
Request to retrieve roles from the security index
Builder for requests to retrieve a role from the security index
A response for the
Get Roles API that holds the retrieved role descriptors.Request for retrieving service account credentials that are local to each node.
Unlike index-backed service account tokens, file-backed tokens are local to the node.
This class represents the action of retriving the stats for snapshot lifecycle management.
ActionType that lists the set of privileges held by a user.
A request for checking a user's privileges
Request builder for checking a user's privileges
Response for a
GetUserPrivilegesRequestThis is modelled on
RoleDescriptor.IndicesPrivileges, with support for multiple DLS and FLS field sets.ActionType for retrieving a user from the security index
Request to retrieve a native user.
Response containing a User retrieved from the security index
This action gets an watch by name
The request to get the watch by name (id)
A delete document action request builder.
ActionType for the creation of an API key on behalf of another user
This returns the
CreateApiKeyResponse because the REST output is intended to be identical to the CreateApiKeyAction.Request class used for the creation of an API key on behalf of another user.
Fields related to the end user authentication
Holds the criteria required to guide the exploration of connected terms which
can be returned as a graph.
Creates a new
GraphExploreRequestBuilderGraph explore response holds a graph of
Vertex and Connection objects
(nodes and edges in common graph parlance).The configuration object for the groups section in the rollup config.
A lookup that allows expanding expressions that may consist of job
IDs, job group names, wildcard patterns or a comma separated combination
of the aforementioned to the matching job IDs.
This action is testing whether a user has the specified
privilegesA request for checking a user's privileges
Request builder for checking a user's privileges
Response for a
HasPrivilegesRequestThe configuration object for the histograms in the rollup config
{
"groups": [
"histogram": {
"fields" : [ "foo", "bar" ],
"interval" : 123
}
]
}
A Hop represents one of potentially many stages in a graph exploration.
Calculates the pseudo Huber loss function.
A wrapper to elasticsearch clients that exposes all ILM related APIs
This class holds the runtime statistics of a job.
IndexerState represents the internal state of the indexer.
Describes an index template to be loaded from a resource file for use with an
IndexTemplateRegistry.Abstracts the logic of managing versioned index templates and lifecycle policies for plugins that require such things.
Encapsulates the field and document permissions per concrete index based on the current request.
Encapsulates the field and document permissions for an index.
A permission that is based on privileges for index related actions executed
on specific indices
InferenceConfigUpdate.Builder<T extends InferenceConfigUpdate.Builder<T,U>,U extends InferenceConfigUpdate>
Class containing the index constants so that the index version, name, and prefix are available to a wider audience.
Collection of helper methods.
Influence field name and list of influence field values/score pairs
Initializes the
LifecycleExecutionState for an index.Exception thrown when a problem is encountered while initialising an ILM policy for an index.
A collection of utilities related to intervals
ActionType for invalidating API key
Request for invalidating API key(s) so that it can no longer be used
Response for invalidation of one or more API keys result.
The result contains information about: API key ids that were actually invalidated API key ids that were not invalidated in this request because they were already invalidated how many errors were encountered while invalidating API keys and the error details
The result contains information about: API key ids that were actually invalidated API key ids that were not invalidated in this request because they were already invalidated how many errors were encountered while invalidating API keys and the error details
ActionType for invalidating one or more tokens
Request for invalidating a token so that it can no longer be used
Request builder that is used to populate a
InvalidateTokenRequestResponse for a invalidation of one or multiple tokens.
An internal action that isolates a datafeed.
This action listener wraps another listener and provides a framework for iteration over a List while calling an asynchronous function
for each.
Result object to hold the result of 1 iteration of iterative indexing.
This class represents a configured and created Job.
Jobs whether running or complete are in one of these states.
Kerberos Realm settings
Built in user for the kibana server
Deprecated.
use KibanaSystemUser
Represents a single layer in the compressed Lang Net
This class captures serialization of feature importance for
classification and regression prior to version 7.10.
To be used in conjunction with a lenient parser.
Data structure for license.
Decouples operation mode of a license from the license type value.
An AllocatedPersistentTask which automatically tracks as a licensed feature usage.
A base class for checking licensed features against the license.
A Momentary feature is one that is tracked at the moment the license is checked.
A Persistent feature is one that is tracked starting when the license is checked, and later may be untracked.
Service responsible for managing
LicensesMetadata.Contains metadata about registered licenses
Marker interface for callbacks that are invoked when the license state changes.
Status of an X-Pack license.
Responsible for verifying signed licenses
Executes an action on an index related to its lifecycle.
Contains information about the execution of a lifecycle policy for a single
index, and serializes/deserializes this information to and from custom
index metadata.
Represents the lifecycle of an index from creation to deletion.
Describes an index lifecycle policy to be loaded from a resource file for use with an
IndexTemplateRegistry.A utility class used for index lifecycle policies
Class encapsulating settings related to Index Lifecycle Management X-Pack Plugin
A
The effective permissions returned on
Role limited by another role.The effective permissions returned on
LimitedRole.authorize(String, Set, Map, FieldPermissionsCache) call would be limited by the
provided role.Very similar to
LoggingDeprecationHandler main differences are:
1.Built in user for logstash internals.
Named cluster privilege for managing API keys owned by the current authenticated user.
Calculates the mean squared error between two known numerical fields.
Calculates the mean squared error between two known numerical fields.
Log and audit message strings
The configuration object for the metrics portion of a rollup job config
{
"metrics": [
{
"field": "foo",
"metrics": [ "min", "max", "sum"]
},
{
"field": "bar",
"metrics": [ "max" ]
}
]
}
A
LifecycleAction which enables or disables the automatic migration of data between
DataTiers.Helps long-valued
BucketedSort.ExtraData track "empty" slots.Utils to create an ML index with alias ready for rollover with a 6-digit suffix
Describes the indices where ML is storing various stats about the users jobs.
Another String utilities class.
Custom
Metadata implementation for storing a map of model aliases that point to model IDsModel Plot POJO.
Provide access to the C++ model size stats for the Java process.
Where will we get the memory requirement from when assigning this job to
a node? There are three possibilities:
1.
The status of the memory monitored by the ResourceMonitor.
ModelSnapshot Result POJO
The model state does not need to be understood on the Java side.
A monitoring bulk request holds one or more
MonitoringBulkDocs.Base class for all monitoring documents.
MonitoringDoc.Node represents the node of the cluster from which the monitoring document
has been collected.MonitoringIndex represents the receivable index from any request.Enumerates the different ways that nodes can use their local storage to accelerate searches of a snapshot.
Restores the snapshot created for the designated index via the ILM policy to an index named using the provided prefix appended to the
designated index name.
A PartialStepKey is like a
Step.StepKey, however, the action and step name are optional.Multi-PreProcessor for chaining together multiple processors
MulticlassConfusionMatrix is a metric that answers the question:
"How many documents belonging to class X were classified as Y by the classifier?"
for all the possible class pairs {X, Y}.Merges terms and stats from multiple TermEnum classes
This does a merge sort, by term text.
Utility class for evaluating Mustache templates at runtime.
A
ClusterPrivilege that has a name.Simple interface for XContent Objects that are named.
Expands an expression into the set of matching names.
PreProcessor for n-gram encoding a string
This provides an array of
FeatureValue for the given nGram size and dimensionId
Each feature value contains the average occurrence of an nGram and its "id".A Pojo class containing an Elastic Node's attributes
Internal terms enum request executed directly against a specific node, querying potentially many
shards in one request
A logger that doesn't log anything.
Used by ensemble to pass into sub-models.
PreProcessor for one hot encoding a set of categorical values for a given field.
ActionType for initiating an authentication process using OpenID Connect
Represents a request for authentication using OpenID Connect
Request builder for populating a
OpenIdConnectAuthenticateRequestRepresents a request to prepare an OAuth 2.0 authorization request
Request builder for populating a
OpenIdConnectPrepareAuthenticationRequestA response object that contains the OpenID Connect Authentication Request as a URL and the state and nonce values that were
generated for this request.
The OIDC realm offers a number of settings that rely on claim values that are populated by the OP in the ID Token or the User Info
response.
Enum representing the different modes that Index Lifecycle Service can operate in.
File based watcher for license
License.OperationMode
Watches for changes in licenseModePath, use
OperationModeFileWatcher.getCurrentOperationMode() to access the latest mode
In case of failure to read a valid operation mode from licenseModePath,
the operation mode will default to PLATINUMEnum representing logical comparisons on doubles
Evaluation of outlier detection results.
Overall Bucket Result POJO
Helper class collecting options for pagination in a search
This throttler throttles the action based on its last successful execution time.
Represents set of
LifecycleActions which should be executed at a
particular point in the lifecycle of an index.We cache the currently executing ILM phase in the index metadata so the ILM execution for managed indices is not irrecoverably
interrupted by a concurrent update policy that, say, would remove the current execution phase altogether.
This is essentially a marker that a phase has ended, and we need to check
the age of an index before proceeding to the next phase.
This class contains information about the current phase being executed by Index
Lifecycle Management on the specific index.
A class that describes a phase and its progress as a percentage
A query that will promote selected documents (identified by ID) above matches produced by an "organic" query.
A single item to be used for a
PinnedQueryBuilder.Precision is a metric that answers the question:
"What fraction of documents classified as X actually belongs to X?"
for any given class X
equation: precision(X) = TP(X) / (TP(X) + FP(X))
where: TP(X) - number of true positives wrt X
FP(X) - number of false positives wrt XThe type of the prediction field.
Describes a pre-processor for a defined machine learning model
This processor should take a set of fields and return the modified set of fields.
Common utilities used for XPack protocol classes
Register license request builder
ActionType for putting (adding/updating) one or more application privileges.
Request object to put a one or more application privileges.
Request builder for
PutPrivilegesRequestResponse when adding one or more application privileges to the security index.
ActionType for adding a role to the security index
ActionType for adding a role to the security index
Request object for adding/updating a role-mapping to the native store
see org.elasticsearch.xpack.security.authc.support.mapper.NativeRoleMappingStore
Builder for requests to add/update a role-mapping to the native store
see org.elasticsearch.xpack.security.authc.support.mapper.NativeRoleMappingStore
Response when adding/updating a role-mapping.
Request object for adding a role to the security index
Builder for requests to add a role to the administrative index
Response when adding a role, includes a boolean for whether the role was
created or updated.
ActionType for putting (adding/updating) a native user.
Request object to put a native user.
Response when adding a user to the security index.
This action puts an watch into the watch index and adds it to the scheduler
This request class contains the data needed to create a watch along with the name of the watch.
Quantiles Result POJO
Response for search API keys.
The result contains information about the API keys that were found.
The result contains information about the API keys that were found.
Generic wrapper class for a page of query results and the total number of
query results.
QueryPage.count() is the total number of results but that value may not be equal to the actual length of the QueryPage.results() list if from & take or some cursor was used in the database query.
QueryPage.count() is the total number of results but that value may not be equal to the actual length of the QueryPage.results() list if from & take or some cursor was used in the database query.
A
LifecycleAction which sets the index to be read-only.Marks an index as read-only, by setting a
IndexMetadata.APIBlock.WRITE block on the index.An authentication mechanism to which the default authentication org.elasticsearch.xpack.security.authc.AuthenticationService
delegates the authentication process.
A factory interface to construct a security realm.
Recall is a metric that answers the question:
"What fraction of documents belonging to X have been predicted as X by the classifier?"
for any given class X
equation: recall(X) = TP(X) / (TP(X) + FN(X))
where: TP(X) - number of true positives wrt X
FN(X) - number of false negatives wrt XInterface for classes that write arrays of strings to the
Ml data frame analytics processes.
Evaluation of regression results.
Derived from: https://github.com/google/cld3/blob/master/src/relevant_script_feature.cc
This extracts an array of
FeatureValue from the given text.Request for reloading index search analyzers
The response object that will be returned when reloading analyzers
Checks remote clusters for license compatibility with a specified licensed feature.
Encapsulates a remote cluster license check.
Encapsulates the license info of a remote cluster.
Built in user for remote monitoring: collection as well as indexing.
This step replaces a data stream backing index with the target index, as part of the data stream's backing indices.
Defines the field names that we use for our results.
Stores a collection of index names separated into "local" and "remote".
Builder class for ResolvedIndices that allows for the building of a list of indices
without the need to construct new objects and merging them together
A generic structure to encapsulate resource to privileges map.
A generic structure to encapsulate resources to
ResourcePrivileges.A REST handler to obtain information about TLS/SSL (X.509) certificates
A try-with-resource compatible object for configuring a thread
Thread.getContextClassLoader().An implementation of
TrustConfig that constructs a RestrictedTrustManager.An X509 trust manager that only trusts connections from a restricted set of predefined network entities (nodes, clients, etc).
A wrapper for concrete result objects plus meta information.
A config update that sets the results field only.
A holder for a Role that contains user-readable information about the Role
without containing the actual Role object.
A class representing permissions for a group of indices mapped to
privileges, field permissions, and a query.
Implementations of this interface represent an expression over a simple object that resolves to
a boolean value.
The result of attempting to retrieve roles from a roles provider.
Represents the rollup capabilities of a non-rollup index.
A
LifecycleAction which rolls over the index.Unconditionally rolls over an index using the Rollover API.
This class holds the configuration details of a
RollupAction job, such as the groupings, metrics, what
index to rollup and where to roll them to.The configuration object for the histograms in the rollup config
{
"groups": [
"date_histogram": {
"field" : "foo",
"calendar_interval" : "1d",
"time_zone" : "EST"
}
]
}
CalendarInterval is a
RollupActionDateHistogramGroupConfig that uses calendar-aware intervals for rolling up data.FixedInterval is a
RollupActionDateHistogramGroupConfig that uses a fixed time interval for rolling up data.The configuration object for the groups section in the rollup config.
A
LifecycleAction which calls RollupAction on an indexThe Rollup specialization of stats for the AsyncTwoPhaseIndexer.
This class is the main wrapper object that is serialized into the PersistentTask's cluster state.
Represents the Rollup capabilities for a specific job on a single rollup index
This class holds the configuration details of a rollup job, such as the groupings, metrics, what
index to rollup and where to roll them to.
This class is essentially just a wrapper around the IndexerState and the
indexer's current position.
Rolls up index using a
RollupActionConfigThis class contains the high-level logic that drives the rollup job.
Calculates R-Squared between two known numerical fields.
A permissions that is based on a general privilege that contains patterns of users that this
user can execute a request as
Deprecated.
This class exists for backwards compatibility with 7.11 and 7.12 only and should not be used for other purposes.
ActionType for authenticating using SAML assertions
Represents a request to authenticate using SAML assertions.
Request builder used to populate a
SamlAuthenticateRequestThe response from converting a SAML assertion into a security token.
ActionType for completing SAML LogoutResponse
Represents a request to complete SAML LogoutResponse
ActionType to perform IdP-initiated logout for a SAML-SSO user
Represents a request to invalidate a SAML session using a
LogoutRequest.Request builder used to populate a
SamlInvalidateSessionRequestResponse to an IdP-initiated SAML
<LogoutRequest>ActionType for initiating a logout process for a SAML-SSO user
Represents a request to prepare a SAML
<LogoutRequest>.Request builder used to populate a
SamlLogoutRequestResponse containing a SAML
<LogoutRequest> for the current userActionType for initiating an authentication process using SAML assertions
Represents a request to prepare a SAML
<AuthnRequest>.Request builder used to populate a
SamlPrepareAuthenticationRequestResponse containing a SAML
<AuthnRequest> for a specific realm.The SAML realm offers a number of settings that rely on attributes that are populate by the Identity Provider in the SAML Response.
Response containing a SAML SP metadata for a specific realm as XML.
These are the custom script codes that match up to the appropriate id row for the CLD3 weights and quantiles
See https://github.com/google/cld3/blob/master/src/script_span/generated_ulscript.h
Derived from https://github.com/google/cld3/blob/master/src/script_detector.h
We take advantage of Java codepoints to determine the specific script value we care about
This is the lone discrete feature.
A
LifecycleAction that will convert the index into a searchable snapshot, by taking a snapshot of the index, creating a
searchable snapshot and the corresponding "searchable snapshot index", deleting the original index and swapping its aliases to the
newly created searchable snapshot backed index.An interface for status response of the stored or running async search
Some Elasticsearch APIs need to be provided with 2 sets of credentials.
A wrapper to elasticsearch clients that exposes all Security related APIs
A lightweight utility that can find the current user and authentication information for the local thread.
An SPI extension point allowing to plug in custom functionality in x-pack authentication module.
This interface provides access to components (clients and services) that may be used
within custom realms and role providers.
An IndexReader wrapper implementation that is used for field and document level security.
Implementation of a transport that extends the
Netty4Transport to add SSL and IP FilteringHelper class that helps to evaluate the query source template.
This
Step evaluates whether force_merge was successful by checking the segment count.This action is for setting the enabled flag on a native or reserved user
The request that allows to set a user as enabled or disabled
Request builder for setting a user as enabled or disabled
A
LifecycleAction which sets the index's priority.Allocates all shards in a single index to one node.
Ported from https://github.com/elastic/ml-cpp/blob/master/include/maths/CTreeShapFeatureImportance.h Path struct
A
LifecycleAction which shrinks the index.Following shrinking an index and deleting the original index, this step creates an alias with the same name as the original index which
points to the new shrunken index to allow clients to continue to use the original index name without being aware that it has shrunk.
Shrinks an index, using a prefix prepended to the original index name for the name of the shrunken index.
Verifies that an index was created through a shrink operation, rather than created some other way.
Checks whether all shards in a shrunken index have been successfully allocated.
This is a pared down bounded input stream.
A utility class for fields that need to support autocomplete via
MappedFieldType.getTerms(boolean, String, org.elasticsearch.index.query.SearchExecutionContext, String)
but can't return a raw Lucene TermsEnum.A simple object that allows a `message` field to be transferred to `XContent`.
Represents the record of a Snapshot Lifecycle Management action, so that it
can be indexed in a history index or recorded to a log in a structured way
Records Snapshot Lifecycle Management actions as represented by
SnapshotHistoryItem into an index
for the purposes of querying and alerting.Holds information about Snapshots kicked off by Snapshot Lifecycle Management in the cluster state, so that this information can be
presented to the user.
Custom cluster state metadata that stores all the snapshot lifecycle
policies and their associated metadata
A
SnapshotLifecyclePolicy is a policy for the cluster including a schedule of when a
snapshot should be triggered, what the snapshot should be named, what repository it should go
to, and the configuration for the snapshot itself.The
SnapshotLifecyclePolicyItem class is a special wrapper almost exactly like the
SnapshotLifecyclePolicyMetadata, however, it elides the headers to ensure that they
are not leaked to the user since they may contain sensitive information.SnapshotLifecyclePolicyMetadata encapsulates a SnapshotLifecyclePolicy as well as
the additional meta information link headers used for execution, version (a monotonically
incrementing number), and last modified dateSnapshotLifecycleStats contains metrics and stats about snapshot lifecycle policy execution - how
many snapshots were taken, deleted, how many failures, etc.
Manages the index template and associated ILM policy for the Snapshot
Lifecycle Management history index.
X-pack uses various libraries that establish socket connections.
Validation of source indexes and destination index.
This is a filter snapshot repository that only snapshots the minimal required information
that is needed to recreate the index.
Items to track.
Exposes SQL async action names for the RBAC engine
The client authentication mode that is used for SSL servers
Represents the configuration for an SSLContext
Ensures that the files backing an
SSLConfiguration are monitored for changes and the underlying key/trust material is reloaded
and the SSLContext has existing sessions invalidated to force the use of the new key/trust materialProvides access to
SSLEngine and SSLSocketFactory objects based on a provided configuration.Helper class to collect min, max, avg and total statistics for a quantity
Represents one part of the execution of a
LifecycleAction.Internal class for temporary storage of eql search results
To be used in conjunction with a strict parser.
This class acts as a facade / encapsulation around the expression and testing of string-based patterns within Elasticsearch security.
A request to track asynchronously the progress of a search against one or more indices.
This step swaps all the aliases from the source index to the restored index and deletes the source index.
Internal user that is applied to all requests made elasticsearch itself
Helper to build
RestTable display attributesPreProcessor for target mean encoding a set of categorical values for a given field.
Representation of a Mustache template for expressing one or more roles names in a
ExpressionRoleMapping.Handling versioned templates for time-based indices in x-pack
Signals that the policy for an index has been fully executed.
A request to gather terms for a given field matching a string prefix
The response of the _terms_enum action.
The configuration object for the histograms in the rollup config
{
"groups": [
"terms": {
"fields" : [ "foo", "bar" ]
}
]
}
Stores the determined file format.
Represents the lifecycle of an index from creation to deletion.
A converter that enables conversions of textual timestamps to epoch seconds
or milliseconds according to a given pattern.
Stats that give more insight into timing of various operations performed as part of anomaly detection job.
Bootstrap check to ensure that if we are starting up with a production license in the local clusterstate TLS is enabled
The result of attempting to invalidate one or multiple tokens.
Parameters used by machine learning for controlling X Content serialisation.
Checkpoint document to store the checkpoint of a transform
The fields:
timestamp the timestamp when this document has been created
checkpoint the checkpoint number, incremented for every checkpoint, if -1 this is a non persisted checkpoint
indices a map of the indices from the source including all checkpoints of all indices matching the source pattern, shard level
time_upper_bound for time-based indices this holds the upper time boundary of this checkpoint
Holds information about checkpointing regarding
- the current checkpoint
- the in progress checkpoint
- the current state of the source
Builder for collecting checkpointing information for the purpose of _stats
Checkpoint stats data for 1 checkpoint
This is the user-facing side of TransformCheckpoint, containing only the stats to be exposed.
This class holds the configuration details of a data frame transform
Specifies all the possible transform functions.
This class holds the mutable configuration items for a data frame transform
Used as a wrapper for the objects returned from the stats endpoint.
A wrapper for grouping transform state and stats when persisting to an index.
Yet Another String utilities class.
Indices clear cache action.
Helper class that defines groups of types
Converts a CCR following index into a normal, standalone index, once the index is ready to be safely separated.
Copies the lifecycle reference date to a new index created by rolling over an alias.
Updates the lifecycle policy for the rollup index for the original/currently managed index
Updates the settings for an index.
In 7.8 update transform has been changed from ordinary request/response objects to tasks request/response.
An authenticated user
Interface for requests that involve user operations
Where a realm users an authentication method that does not have in-built support for X-Pack
roles, it may delegate to an implementation of this class the
responsibility for determining the set roles that an authenticated user should have.This class parse the given string into a DN and return its normalized format.
A specialised predicate for fields that might be a DistinguishedName (e.g "dn" or "groups").
A representation of a user for whom roles should be mapped.
Deprecated.
This class exists for backwards compatibility with 7.14 only
and should not be used for other purposes.
Represents the verification mode to be used for SSL connections.
A vertex in a graph response represents a single term (a field and value pair)
which appears in one or more documents found as part of the graph exploration.
An identifier (implements hashcode and equals) that represents a
unique key for a
VertexA request to identify terms from a choice of field as part of a
Hop.After we performed the index rollover we wait for the the configured number of shards for the rolled over index (ie.
This step waits for one of the data tiers to be available in the cluster.
A step that waits until the managed index is no longer a leader index.
Waits for at least one rollover condition to be satisfied, using the Rollover API's dry_run option.
A
LifecycleAction which waits for snapshot to be taken (by configured SLM policy).A step that waits for snapshot to be taken by SLM that includes the index in question to ensure we have backup
before we delete the index.
Encapsulates the state of the watcher plugin.
This ActionType gets the stats for the watcher plugin
The Request to get the watcher stats
Watcher stats request builder.
A xcontent parser that is used by watcher.
A representation class of a watch id, its execution time and a random UUID
This class exists to be able to store several events from the same possible execution time and the same watch
in the triggered store index or the history store
One 'specialty' of this class is the handling of the underscore in the value.
An encapsulation of the configuration options for X.509 Key Pair support in X-Pack security.
XContentObjectTransformer<T extends org.elasticsearch.xcontent.ToXContentObject>
This is a utility class that allows simple one-to-one transformations between an ToXContentObject type
to and from other supported objects.
Encapsulates the xcontent source
Information about the built version of x-pack that is running.
Fetch information about X-Pack from the cluster.
A holder for the current state of the license for all xpack features.
internal user that manages xpack security.
A container for xpack setting constants.
Response object from calling the xpack usage api.
XPack internal user that manages xpack.