All Classes
Class
Description
AbstractResultResponse<T extends org.elasticsearch.common.xcontent.ToXContent>
Abstract class that provides a list of results and their count.
AccuracyMetric is a metric that answers the following two questions:
1.A request to explicitly acknowledge a watch.
The response from an 'ack watch' request.
A request to explicitly activate a watch.
Response from an 'activate watch' request.
An expression that evaluates to
true if-and-only-if all its children
evaluate to true.Analysis configuration options that describe which fields are
analyzed and which functions are used to detect anomalies.
Analysis limits for autodetect.
Statistics for the data frame analysis
A request to analyze text
Helper class to build custom analyzer definitions
Anomaly Cause POJO.
Anomaly Record POJO.
An expression that evaluates to
true if at least one of its children
evaluate to true.API key information
Represents an application specific privilege.
Represents privileges over resources that are scoped under an application.
A response of an async search request.
Area under the curve (AUC) of the receiver operating characteristic (ROC).
Area under the curve (AUC) of the receiver operating characteristic (ROC).
Empty request object required to make the authenticate call.
The response for the authenticate call.
Represents a response to a request that is broadcast to a collection of shards.
Represents the results of a collection of shards on which a request was executed against.
Bucket Result POJO
A simple calendar object for scheduled (special) events.
cancel tasks response that contains
- task failures
- node failures
- tasks
Configuration for the categorization analyzer.
Simple store of either a name of a built-in analyzer element or a custom definition.
A wrapper for the
RestHighLevelClient that provides methods for
accessing the Elastic ccr related methodsSimple model of an X.509 certificate
Request object to change the password of a user of a native realm or a built-in user.
The description of how searches should be chunked.
Evaluation of classification results.
The request used to clear the API key cache.
The request used to clear the cache for native application privileges stored in an index.
The response object that will be returned when clearing the privileges cache
Request for clearing the cache of one or more realms
Response for a clear realm cache request.
The request used to clear the cache for native roles stored in an index.
The response object that will be returned when clearing the roles cache
The response object that will be returned when clearing a security cache
The request used to clear the service account token cache.
A request to close an index.
Request to close Machine Learning Jobs
Response indicating if the Job(s) closed or not
A wrapper for the
RestHighLevelClient that provides methods for accessing the Cluster API.A request to check for the existence of component templates
A request to check for the existence of index templates
Expression of role mapper expressions which can be combined by operators like AND, OR
A Connection links exactly two
Vertex objects.An identifier (implements hashcode and equals) that represents a
unique key for a
ConnectionEncapsulates a request to _count API against one, several or all indices.
A response to _count API request.
Encapsulates _shards section of count api response.
Request to create API key
Response for create API key
A request to create an index.
A response for a create index action.
Request to create a service account token
Response for creating a service account token.
Request to create a new OAuth2 token from the Elasticsearch cluster.
Response when creating a new OAuth2 token in the Elasticsearch cluster.
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 the ML job.
Enum of the acceptable data formats.
The datafeed configuration object.
Datafeed State POJO
Datafeed Statistics POJO
A datafeed update contains partial properties to update a
DatafeedConfig.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.A grouping via a date histogram aggregation referencing a timefield
Interval can be specified in 2 ways:
fixed_interval fixed intervals like 1h, 1m, 1d
calendar_interval calendar aware intervals like 1M, 1Y, ...
The configuration object containing the delayed data check settings.
Request class for removing an event from an existing calendar
Request class for removing Machine Learning Jobs from an existing calendar
Request to delete a Machine Learning Calendar
Request to delete a Machine Learning Datafeed via its ID
Request to delete a data frame analytics config
Request to delete expired model snapshots and forecasts
A response acknowledging the deletion of expired data
A request to delete a machine learning filter
POJO for a delete forecast request
Request to delete a Machine Learning Job via its ID
Response object that contains the acknowledgement or the task id
depending on whether the delete job action was requested to wait for completion.
Request to delete a Machine Learning Model Snapshot Job via its Job and Snapshot IDs
A request to delete application privileges
Response for application privileges deletion
Request object to delete a role mapping.
Response when deleting a role mapping.
A request delete a role from the security index
Response for a role being deleted from the native realm
Request to delete a service account token
Response for a service account token deletion
Request to delete a data frame analytics config
Request to delete a transform
A request to delete a user from the native realm.
Response for a user being deleted from the native realm
A delete watch request to delete an watch by name (id)
Information about deprecated items
Configuration containing the destination index for the
TransformConfigDefines the fields and functions used in the analysis.
Request object to disable a native realm or built-in user.
client side counterpart of server side
ElasticsearchException
It wraps the same content but it is not throwable.Request object to enable a native realm or built-in user.
A wrapper for the
RestHighLevelClient that provides methods for
accessing the Elastic enrich related methodsA wrapper for the
RestHighLevelClient that provides methods for
accessing the Elastic EQL related functionsRequest to estimate the model memory an analysis config is likely to need given supplied field cardinalities.
Defines an evaluation
Defines an evaluation metric
The result of an evaluation metric
A negating expression.
An execute watch request to execute a watch by id or inline
Request to explain the following about a data frame analytics job:
field selection: which fields are included or are not in the analysis
memory estimation: how much memory the job is estimated to require
The request object used by the Explain Lifecycle API.
The response object returned by the Explain Lifecycle API.
A representation of a single role-mapping.
A wrapper for the
RestHighLevelClient that provides methods for accessing the Snapshot API.An expression that evaluates to
true if a field (map element) matches
the provided values.Request object to flush a given Machine Learning job.
Response object containing flush acknowledgement and additional data
Pojo for forecasting an existing and open Machine Learning Job
Forecast response object
A class to hold statistics about forecasts.
Represents a forget follower request.
Request for the _freeze index API
PreProcessor for frequency encoding a set of categorical values for a given field.
Response obtained from the get aliases API.
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.
Request class for get auto follow pattern api.
Response class for license get basic status API
A request to retrieve buckets of a given job
A response containing the requested buckets
Request object to retrieve the privilege that are builtin to the Elasticsearch cluster.
Get builtin privileges response
Get the Scheduled Events for a Calendar
Contains a
List of the found ScheduledEvent objects and the total count foundA request to retrieve categories of a given job
A response containing the requested categories
A request to read the content of component templates
A request to read the content of index templates
Request object to get
DatafeedConfig objects with the matching datafeedIds.Contains a
List of the found DatafeedConfig objects and the total count foundRequest object to get
DatafeedStats by their respective datafeedIds
_all explicitly gets all the datafeeds' statistics in the cluster
An empty request (no datafeedIds) implicitly gets all the datafeeds' statistics in the clusterContains a
List of the found DatafeedStats objects and the total count foundRequest to get data frame analytics stats
A
TimedRequest to get the list of features available to be included in snapshots in the cluster.Request the mappings of specific fields
Response object for
GetFieldMappingsRequest APIA request to retrieve
MlFiltersA request to retrieve information about an index.
A client side response for a get index action.
A request to read the content of index templates
A request to retrieve influencers of a given job
A response containing the requested influencers
Request object to get
JobStats by their respective jobIds
_all explicitly gets all the jobs' statistics in the cluster
An empty request (no jobIds) implicitly gets all the jobs' statistics in the clusterA request to retrieve information about model snapshots for a given job
A response containing the requested snapshots
A request to retrieve overall buckets of set of jobs
A response containing the requested overall buckets
Request object to get application privilege(s)
Get application privileges response
A request to retrieve records of a given job
A response containing the requested records
Request object to get role mappings
Get role mappings response
Request object to retrieve roles from the native roles store
Response when requesting one or more roles.
Request to fetch rollup jobs.
Response from rollup's get jobs api.
The Rollup specialization of stats for the AsyncTwoPhaseIndexer.
Status of the rollup job.
Request to retrieve credentials of a service account
Response when requesting credentials of a service account.
Request to retrieve information of service accounts
Response when requesting one or more service accounts.
Request object to retrieve the X.509 certificates that are used to encrypt communications in an Elasticsearch cluster.
Response object when retrieving the X.509 certificates that are used to encrypt communications in an Elasticsearch cluster.
Response class for license get trial status API
A request object for the
SecurityClient.getUserPrivileges(RequestOptions) API.The response for the
SecurityClient.getUserPrivileges(RequestOptions) API.Request object to retrieve users from the native realm
Response when requesting zero or more users.
The request to get the watch by name (id)
Represents generic global cluster privileges that can be scoped by categories
and then further by operations.
Represents global privileges.
Request to create a new API Key on behalf of another user.
Holds the criteria required to guide the exploration of connected terms which
can be returned as a graph.
Graph 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.
Class describing how to group data
Request to determine whether the current user has a list of privileges.
Response when checking whether the current user has a defined set of privileges.
The configuration object for the histograms in the rollup config
{
"groups": [
"histogram": {
"fields" : [ "foo", "bar" ],
"interval" : 123
}
]
}
A grouping via a histogram aggregation referencing a numeric field
A Hop represents one of potentially many stages in a graph exploration.
Calculates the pseudo Huber loss function.
IndexerState represents the internal state of the indexer.
A request to check for the existence of index templates
A wrapper for the
RestHighLevelClient that provides methods for accessing the Indices API.Represents privileges over indices.
For building inference pipeline aggregations
NOTE: This extends AbstractPipelineAggregationBuilder for compatibility
with
SearchSourceBuilder.aggregation(PipelineAggregationBuilder) but it
doesn't support any "server" side things like InferencePipelineAggregationBuilder.doWriteTo(StreamOutput)
or InferencePipelineAggregationBuilder.createInternal(Map)Collection of helper methods.
Influence field name and list of influence field values/score pairs
A wrapper for the
RestHighLevelClient that provides methods for accessing the Ingest API.Request for invalidating API key(s) so that it can no longer be used
Request to invalidate a OAuth2 token within the Elasticsearch cluster.
Response when invalidating one or multiple OAuth2 access tokens and refresh tokens.
This class represents a configured and created Job.
Jobs whether running or complete are in one of these states.
Class containing the statistics for a Machine Learning job.
POJO for updating an existing Machine Learning
JobShallow, fully connected, feed forward NN modeled after and ported from https://github.com/google/cld3
Represents a single layer in the compressed Lang Net
Class describing how to compute latest doc for every unique key
A wrapper for the
RestHighLevelClient that provides methods for
accessing the Elastic License-related methodsStatus of an X-Pack license.
interface for index lifecycle management actions
A
TimedRequest to get the current status of index lifecycle management.The current status of index lifecycle management.
Represents the lifecycle of an index from creation to deletion.
Machine Learning API client wrapper for the
RestHighLevelClientRepresents the privilege to "manage" certain applications.
Calculates the mean squared error between two known numerical fields.
Calculates the mean squared error between two known numerical fields.
The configuration object for the metrics portion of a rollup job config
{
"metrics": [
{
"field": "foo",
"metrics": [ "min", "max", "sum"]
},
{
"field": "bar",
"metrics": [ "max" ]
}
]
}
A wrapper for the
RestHighLevelClient that provides methods for
accessing the Elastic License-related methodsAn MlFilter Object
A filter contains a list of strings.
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 categorization for a job.
The status of the memory monitored by the ResourceMonitor.
ModelSnapshot Result POJO
Multi-PreProcessor for chaining together multiple processors
Calculates the multiclass confusion matrix.
Simple interface for XContent Objects that are named.
PreProcessor for n-gram encoding a string
A Pojo class containing an Elastic Node's attributes
A Pojo class containing an Elastic Node's attributes
Base class for responses that are node responses.
A utility class to parse the Nodes Header returned by
RestActions.buildNodesHeader(XContentBuilder, ToXContent.Params, BaseNodesResponse).PreProcessor for one hot encoding a set of categorical values for a given field.
Request to open a Machine Learning Job
Response indicating if the Machine Learning Job is now opened or not
Enum representing the different modes that Index Lifecycle Service can operate in.
Enum representing logical comparisons on doubles
Evaluation of outlier detection results.
Overall Bucket Result POJO
Paging parameters for GET requests
This class parses the superset of all possible fields that may be written by
InferenceResults.
Results from the
string_stats aggregation.Results of the
top_metrics aggregation.The metrics belonging to the document with the "top" sort key.
Request class for pause auto follow pattern api.
Represents set of
LifecycleActions which should be executed at a
particular point in the lifecycle of an index.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
Class describing how to pivot data via
GroupConfig and AggregationConfig objectsRequest to add a ScheduledEvent to a Machine Learning calendar
Response to adding ScheduledEvent(s) to a Machine Learning calendar
Request to post data to a Machine Learning job
Class for incrementally building a bulk document request in
XContentType.JSON formatResponse object when posting data to a Machine Learning Job
PrecisionMetric 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 XDescribes a pre-processor for a defined machine learning model
Request to preview a MachineLearning Datafeed
Response containing a datafeed preview in JSON format
Common utilities used for XPack protocol classes
Request class for adding Machine Learning Jobs to an existing calendar
Request to create a new Machine Learning calendar
A request to create an component template.
A request to create an index template.
Request to create a new Machine Learning Datafeed given a
DatafeedConfig configurationResponse containing the newly created
DatafeedConfigRequest to create a new Machine Learning MlFilter given a
MlFilter configurationResponse containing the newly created
MlFilterA request to create an index template.
Request to create a new Machine Learning Job given a
Job configurationResponse containing the newly created
JobPut a mapping definition into one or more indices.
Request object for creating/updating application privileges.
Response when creating/updating one or more application privileges to the
security index.
Request object to create or update a role mapping.
Response when adding/updating a role mapping.
Request object to create or update a role.
Response when adding a role to the native roles store.
Request object to create or update a user in the native realm.
Response when adding a user to the native realm.
This request class contains the data needed to create a watch along with the name of the watch.
Quantiles Result POJO
Object for encapsulating the desired Query for a DataFrameAnalysis
Object for encapsulating the desired Query for a Transform
RecallMetric 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 XEnumeration of values that control the refresh policy for a request that
supports specifying a refresh policy.
Evaluation of regression results.
Request for the _reload_search_analyzers API
The response object that will be returned when reloading analyzers
This class encapsulates all remote cluster information to be rendered on
_remote/info requests.The request object used by the Remote cluster info API.
A response to _remote/info API request.
This class represents the response of the Feature State Reset API.
A class representing the status of an attempt to reset a feature's state.
Request to delete a Machine Learning Job via its ID
Response object that contains the acknowledgement or the task id
depending on whether the reset job action was requested to wait for completion.
Request class to resize an index
The response from a
ResizeRequest callHigh level REST client that wraps an instance of the low level
RestClient and allows to build requests and read responses.Contains common attributes for results.
Request class for resume auto follow pattern api.
A request changing throttling of a task.
A request to revert to a specific model snapshot for a given job
A response containing the reverted model snapshot
Represents an aggregation of privileges.
Canonical cluster privilege names.
Canonical index privilege names.
Implementations of this interface represent an expression used for user role mapping
that can later be resolved to a boolean value.
Parses the JSON (XContent) based boolean expression DSL into a tree of
RoleMapperExpression objects.Represents the rollup capabilities of a non-rollup index.
Request class to swap index under an alias upon satisfying conditions
Response object for
RolloverRequest APIA wrapper for the
RestHighLevelClient that provides methods for
accessing the Elastic Rollup-related methodsRepresents 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.
Calculates R-Squared between two known numerical fields.
A
LifecycleAction that will convert the index into a searchable snapshot.A wrapper for the
RestHighLevelClient that provides methods for accessing searchable snapshots APIs.A wrapper for the
RestHighLevelClient that provides methods for accessing the Security APIs.Base class for security responses that are node responses.
Information about a service account.
A
LifecycleAction which sets the index's priority.Sets ML into upgrade_mode
Abstract request object to enable or disable a built-in or native user.
Helper class for min, max, avg and total statistics for a quantity
A request to simulate matching a provided index name and an optional new index template against the existing index templates.
A wrapper for the
RestHighLevelClient that provides methods for accessing the Snapshot API.Class encapsulating all options for a
TransformConfig gathering dataRequest to start a Datafeed
Response indicating if the Machine Learning Datafeed is now started or not
Response indicating if the Machine Learning Datafeed is now started or not
Request to stop Machine Learning Datafeeds
Response indicating if the Machine Learning Datafeed is now stopped or not
Response indicating if the Machine Learning Data Frame Analytics is now stopped or not
Builds the
string_stats aggregation request.A request to track asynchronously the progress of a search against one or more indices.
Description for the flush/synced results for a particular index.
Encapsulates the number of total successful and failed shard copies
Description of a failed shard copy for an index.
PreProcessor for target mean encoding a set of categorical values for a given field.
Client side counterpart of server side version.
client side version of a
TaskIdclient side counterpart of server side
client side counterpart of server side
TaskOperationFailureA wrapper for the
RestHighLevelClient that provides methods for accessing the Tasks API.A role name that uses a dynamic template.
The configuration object for the histograms in the rollup config
{
"groups": [
"terms": {
"fields" : [ "foo", "bar" ]
}
]
}
Stores the determined text format.
Text Structure API client wrapper for the
RestHighLevelClientA base request for any requests that supply timeouts.
Stats that give more insight into timing of various operations performed as part of anomaly detection job.
Builds the Top Metrics aggregation request.
This class holds the mutable configuration items for a transform
Holds state of the cursors:
indexer_position: the position of the indexer querying the source
bucket_position: the position used for identifying changes
Request for the _unfreeze index API
Requests an update to a
DatafeedConfig with the passed DatafeedUpdate
settingsUpdates an existing
MlFilter configurationA request to update information about an existing model snapshot for a given job
A response acknowledging the update of information for an existing model snapshot for a given job
A user to be utilized with security APIs.
Represents an "index" privilege in the
GetUserPrivilegesResponse.Defines a validation layer for Requests.
Encapsulates an accumulation of validation errors
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.A
LifecycleAction which waits for snapshot to be taken (by configured SLM policy).A request to explicitly acknowledge a watch.
The response from an 'ack watch' request.
Encapsulates the xcontent source
A wrapper for the
RestHighLevelClient that provides methods for
accessing the Elastic Licensed X-Pack APIs that are shipped with the
default distribution of Elasticsearch.Fetch information about X-Pack from the cluster.
Response object from calling the xpack usage api.