All Classes and Interfaces
Class
Description
Base bytesref class
Superclass for
ObjectParser and ConstructingObjectParser.Base class for parsing serializable content
A listener for action responses or failures.
Base class for responses to action requests.
Stats class encapsulating all of the different circuit breaker stats
Provides a static final field that can be used to check if assertions are enabled.
Base abstraction of an array.
A bounded transport address is a tuple of
TransportAddress, one array that represents
the addresses the transport is bound to, and the other is the published one that represents the address clients
should communicate on.Information about a build of OpenSearch.
The type of build
Abstraction of an array of byte values.
Byte Buffer Stream Input
A bytes array.
A
SizeUnit represents size at a given unit of
granularity and provides utility methods to convert across units.A byte size value
A reference to bytes.
Utilities for sorting Lucene
BytesRefArrayBase Bytes Stream.
StreamInput version of Lucene's ByteArrayDataInput
This is used as a replacement of Lucene ByteArrayDataInput for abstracting byte order changes
in Lucene's APIExpression to evaluate version compatibility allowing for minor and patch version variability.
Interface for an object that can be incremented, breaking after some
configured limit has been reached.
The breaker durability
can be
CircuitBreaker.Durability.TRANSIENT or CircuitBreaker.Durability.PERMANENTThe type of breaker
can be
CircuitBreaker.Type.MEMORY, CircuitBreaker.Type.PARENT, or CircuitBreaker.Type.NOOPInterface for Circuit Breaker services, which provide breakers to classes
that load field data.
Class encapsulating stats about the
CircuitBreakerException thrown when the circuit breaker trips
Collections-related utility methods.
A composite
BytesReference that allows joining multiple bytes references
into one without copying.Compressor interface used for compressing
MediaType and
org.opensearch.repositories.blobstore.BlobStoreRepository implementations.Service Provider Interface for plugins, modules, extensions providing custom
compression algorithms
A registry that wraps a static Map singleton which holds a mapping of unique String names (typically the
compressor header as a string) to registerd
Compressor implementations.Like
ObjectParser but works with objects that have constructors whose arguments are mixed in with its other settings.Reads an object from a parser using some context.
Main stream output for data output
Default
Compressor implementations provided by the
opensearch core libraryException for a default shard operation
Callback for notifying the creator of the
XContentParser that
parsing hit a deprecated field.Expression to evaluate equality of versions.
Extension point to customize the error message for unknown fields.
Helper class for OpenSearch Exceptions
An evaluation expression.
OpenSearch utils to work with
PathFilters a content path
Concrete filter for a content path
Wraps a
StreamInput and delegates to it.A value class representing the basic required properties of an OpenSearch index.
Generic shard snapshot exception
Thrown when snapshot process is failed on a shard level
Main input stream for input data
Like
ConstructingObjectParser but works with objects which have a constructor that matches declared fields.Builder for the Instantiating Object Parser
The Contents of this file were originally moved from
Version.Format string for OpenSearch log messages.
Wraps a map generated by XContentParser's map() method into XContent Parser
Abstracts a Media Type and a format parameter.
Service Provider Interface for plugins, modules, extensions providing
their own Media Types
Parses supported internet media types
A media type object that contains all the information provided on a Content-Type or Accept header
Thrown when
NamedXContentRegistry cannot locate a named object to
parse for a particular nameA
Writeable object identified by its name.Wraps a
StreamInput and associates it with a NamedWriteableRegistryA registry for
Writeable.Reader readers of NamedWriteable.An entry in the registry, made up of a category class and name, and a reader for that category class.
Main registry for serializable content (e.g., field mappers, aggregations)
An entry in the NamedXContentRegistry containing the name of the object and the parser that can parse it.
Class that returns a breaker that use the NoopCircuitBreaker and never breaks
Compressor no compressor implementation.A
CircuitBreaker that doesn't increment or adjust, and all operations are
basically noops.Exception indicating that we were expecting something compressed, which
was not compressed or corrupted so that the compression format could not
be detected.
A listener that ensures that only one of onResponse or onFailure is called.
This exception can be used to wrap a given, not serializable exception
to serialize via
StreamOutput.writeException(Throwable).Exception indicating that we were expecting some
XContent but could
not detect its type.A declarative, stateless parser that turns XContent into setter calls.
Functional interface for instantiating and parsing named objects.
Main parser interface
Defines how to consume a parsed undefined field
Supported Value Types for Parsable Objects
This class provides helpers for
ObjectParser that allow dealing with
classes outside of the xcontent dependencies.Helper class to navigate nested objects using dot notation
A core library base class for all opensearch exceptions.
This is the list of Exceptions OpenSearch can throw over the wire or save into a corruption marker.
Registry of ExceptionHandlers
Unchecked exception that is translated into a
400 BAD REQUEST error when it bubbles out over HTTP.Thrown when an execution is rejected
An exception that is meant to be "unwrapped" when sent back to the user
as an error because its is
cause, if non-null is
always more useful to the user than the exception itself.Streaming output data
A page based bytes reference, internally holding the bytes in a paged
data structure.
Holds a field that can be found in a request while parsing and its different
variants, which may be deprecated.
Common fields shared throughout the project
Marks the constructor that should be used by InstantiatingObjectParser if multiple constructors with the same
number of arguments exist.
Exception that can be used when parsing queries with a given
XContentParser.Node reporting service
Information interface.
Different resource stats are defined.
Defines the different types of resource stats.
Thread resource usage information for particular resource stats type.
Defines resource stats information.
Information about resource usage
OpenSearch REST status
A String implementations which allows clearing the underlying char array.
Represents a single semver range that allows for specifying which
org.opensearch.Versions satisfy the range.A range operator.
Allows for shard level components to be injected with the shard id.
An exception indicating that a failure occurred performing an operation on the shard.
A stream from this node to another node.
A stream from another node to this node.
String utility class.
A generic exception that can be thrown by a task when it's cancelled by the task manager API
Task id that consists of node id and id of the task on the node
Task resource usage information with minimal information about the task
Builder for
TaskResourceInfoResource information about a currently running task.
Task resource usage information
Task thread execution information.
Both
String and BytesReference representation of the text.Resource consumption information about a particular execution of thread.
Expression to evaluate version compatibility allowing patch version variability.
An interface allowing to transfer an object to "XContent" using an
XContentBuilder.Delegates mapped parameters to base Params class
Mapped parameter base class
Base parameters class
An interface allowing to transfer an object to "XContent" using an
XContentBuilder.An interface allowing to transfer an object to "XContent" using an
XContentBuilder.A transport address used for IP socket address (wraps
InetSocketAddress).Message over the transport interface
Response over the transport interface
Empty transport response
OpenSearch Version Class
A
NamedWriteable that has a minimum version associated with it.Implementers can be written to a StreamOutput and read from a StreamInput.
Reference to a method that can read some object from a stream.
A WriteableRegistry registers
Writeable.Writer methods for writing data types over a
StreamOutput channel and Writeable.Reader methods for reading data from a
StreamInput channel.Reference to a method that can write some object to a
StreamOutput.A generic abstraction on top of handling content, inspired by JSON and pull parsing.
A utility to build XContent (ie json).
Interface for transforming complex objects into their "raw" equivalents for human-readable fields
The writer interface for the serializable content builder
This interface provides a way for non-JDK classes to plug in a way to serialize to xcontent.
Base class to generate serializable content
Core XContent Helper Utilities
Simple data structure representing the line and column number of a position
in some XContent e.g.
Thrown when one of the XContent parsers cannot parse something.
Interface for pull - parsing
XContent see XContentType for supported types.Supported numeric types
Supported serializable tokens
A set of static methods to get
XContentParser.Token from XContentParser
while checking for their types and throw ParsingException if needed.Wrapper for a XContentParser that makes a single object/array look like a complete document.