Index (rest 2.3.0 API)

A B C D E F G H I N O P R S T W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

addHeader(String, String) - Method in class org.opensearch.client.RequestOptions.Builder: Add the provided header to the request.
addParameter(String, String) - Method in class org.opensearch.client.Request: Add a query string parameter.
addParameters(Map<String, String>) - Method in class org.opensearch.client.Request: Add query parameters using the provided map of key value pairs.
ANY - Static variable in interface org.opensearch.client.NodeSelector: Selector that matches any node.

B

build() - Method in class org.opensearch.client.RequestOptions.Builder: Build the RequestOptions.
build() - Method in class org.opensearch.client.RestClientBuilder: Creates a new RestClient based on the provided configuration.
builder(String) - Static method in class org.opensearch.client.RestClient: Returns a new RestClientBuilder to help with RestClient creation.
builder(HttpHost...) - Static method in class org.opensearch.client.RestClient: Returns a new RestClientBuilder to help with RestClient creation.
builder(Node...) - Static method in class org.opensearch.client.RestClient: Returns a new RestClientBuilder to help with RestClient creation.
buildResult(HttpContext) - Method in class org.opensearch.client.HeapBufferedAsyncResponseConsumer

C

cancel() - Method in class org.opensearch.client.Cancellable: Cancels the on-going request that is associated with the current instance of Cancellable.
Cancellable - Class in org.opensearch.client: Represents an operation that can be cancelled.
cleanPathPrefix(String) - Static method in class org.opensearch.client.RestClientBuilder: Cleans up the given path prefix to ensure that looks like "/base/path".
close() - Method in class org.opensearch.client.RestClient
ContentCompressingEntity(HttpEntity) - Constructor for class org.opensearch.client.RestClient.ContentCompressingEntity: Creates a RestClient.ContentCompressingEntity instance with the provided HTTP entity.
ContentCompressingEntity(HttpEntity, boolean) - Constructor for class org.opensearch.client.RestClient.ContentCompressingEntity: Creates a RestClient.ContentCompressingEntity instance with the provided HTTP entity.
ContentHttpEntity(HttpEntity) - Constructor for class org.opensearch.client.RestClient.ContentHttpEntity: Creates a RestClient.ContentHttpEntity instance with the provided HTTP entity.
ContentHttpEntity(HttpEntity, boolean) - Constructor for class org.opensearch.client.RestClient.ContentHttpEntity: Creates a RestClient.ContentHttpEntity instance with the provided HTTP entity.
createHttpAsyncResponseConsumer() - Method in interface org.opensearch.client.HttpAsyncResponseConsumerFactory: Creates the HttpAsyncResponseConsumer, called once per request attempt.
createHttpAsyncResponseConsumer() - Method in class org.opensearch.client.HttpAsyncResponseConsumerFactory.HeapBufferedResponseConsumerFactory
customizeHttpClient(HttpAsyncClientBuilder) - Method in interface org.opensearch.client.RestClientBuilder.HttpClientConfigCallback: Allows to customize the CloseableHttpAsyncClient being created and used by the RestClient.
customizeRequestConfig(RequestConfig.Builder) - Method in interface org.opensearch.client.RestClientBuilder.RequestConfigCallback: Allows to customize the RequestConfig that will be used with each request.

D

DEFAULT - Static variable in interface org.opensearch.client.HttpAsyncResponseConsumerFactory: Creates the default type of HttpAsyncResponseConsumer, based on heap buffering with a buffer limit of 100MB.
DEFAULT - Static variable in class org.opensearch.client.RequestOptions: Default request options.
DEFAULT_CONNECT_TIMEOUT_MILLIS - Static variable in class org.opensearch.client.RestClientBuilder: The default connection timout in milliseconds.
DEFAULT_MAX_CONN_PER_ROUTE - Static variable in class org.opensearch.client.RestClientBuilder: The default maximum of connections per route.
DEFAULT_MAX_CONN_TOTAL - Static variable in class org.opensearch.client.RestClientBuilder: The default maximum total connections.
DEFAULT_SOCKET_TIMEOUT_MILLIS - Static variable in class org.opensearch.client.RestClientBuilder: The default socket timeout in milliseconds.

E

equals(Object) - Method in class org.opensearch.client.HasAttributeNodeSelector
equals(Object) - Method in class org.opensearch.client.Node
equals(Object) - Method in class org.opensearch.client.Node.Roles
equals(Object) - Method in class org.opensearch.client.PreferHasAttributeNodeSelector
equals(Object) - Method in class org.opensearch.client.Request
equals(Object) - Method in class org.opensearch.client.RequestOptions

F

FailureListener() - Constructor for class org.opensearch.client.RestClient.FailureListener: Create a RestClient.FailureListener instance.

G

getAttributes() - Method in class org.opensearch.client.Node: Attributes declared on the node.
getBoundHosts() - Method in class org.opensearch.client.Node: Addresses on which the host is listening.
getBufferLimit() - Method in class org.opensearch.client.HeapBufferedAsyncResponseConsumer: Get the limit of the buffer.
getByteBufferAllocator() - Method in class org.opensearch.client.HeapBufferedAsyncResponseConsumer: Returns the instance of ByteBufferAllocator to use for content buffering.
getContent() - Method in class org.opensearch.client.RestClient.ContentCompressingEntity
getContentLength() - Method in class org.opensearch.client.RestClient.ContentCompressingEntity: A gzip entity requires content length in http headers.
getEndpoint() - Method in class org.opensearch.client.Request: The path of the request (without scheme, host, port, or prefix).
getEntity() - Method in class org.opensearch.client.Request: The body of the request.
getEntity() - Method in class org.opensearch.client.Response: Returns the response body available, null otherwise
getHeader(String) - Method in class org.opensearch.client.Response: Returns the value of the first header with a specified name of this message.
getHeaders() - Method in class org.opensearch.client.RequestOptions: Headers to attach to the request.
getHeaders() - Method in class org.opensearch.client.Response: Returns all the response headers
getHost() - Method in class org.opensearch.client.Node: Contact information for the host.
getHost() - Method in class org.opensearch.client.Response: Returns the node that returned this response
getHttpAsyncResponseConsumerFactory() - Method in class org.opensearch.client.RequestOptions: The HttpAsyncResponseConsumerFactory used to create one HttpAsyncResponseConsumer callback per retry.
getMethod() - Method in class org.opensearch.client.Request: The HTTP method.
getName() - Method in class org.opensearch.client.Node: The node.name of the node.
getNodes() - Method in class org.opensearch.client.RestClient: Get the list of nodes that the client knows about.
getOptions() - Method in class org.opensearch.client.Request: Get the portion of an HTTP request to OpenSearch that can be manipulated without changing OpenSearch's behavior.
getParameters() - Method in class org.opensearch.client.Request: Query string parameters.
getRequestConfig() - Method in class org.opensearch.client.RequestOptions: get RequestConfig, which can set socketTimeout, connectTimeout and so on by request
getRequestLine() - Method in class org.opensearch.client.Response: Returns the request line that generated this response
getResponse() - Method in exception org.opensearch.client.ResponseException: Returns the Response that caused this exception to be thrown.
getResponse() - Method in exception org.opensearch.client.WarningFailureException: Returns the Response that caused this exception to be thrown.
getRoles() - Method in class org.opensearch.client.Node: Roles that the OpenSearch process on the host has or null if we don't know what roles the node has.
getStatusLine() - Method in class org.opensearch.client.Response: Returns the status line of the current response
getVersion() - Method in class org.opensearch.client.Node: Version of OpenSearch that the node is running or null if we don't know the version.
getWarnings() - Method in class org.opensearch.client.Response: Returns a list of all warning headers returned in the response.
getWarningsHandler() - Method in class org.opensearch.client.RequestOptions: How this request should handle warnings.

H

HasAttributeNodeSelector - Class in org.opensearch.client: A NodeSelector that selects nodes that have a particular value for an attribute.
HasAttributeNodeSelector(String, String) - Constructor for class org.opensearch.client.HasAttributeNodeSelector: Create a {link HasAttributeNodeSelector} instance using the provided attribute key value pair.
hashCode() - Method in class org.opensearch.client.HasAttributeNodeSelector
hashCode() - Method in class org.opensearch.client.Node
hashCode() - Method in class org.opensearch.client.Node.Roles
hashCode() - Method in class org.opensearch.client.PreferHasAttributeNodeSelector
hashCode() - Method in class org.opensearch.client.Request
hashCode() - Method in class org.opensearch.client.RequestOptions
hasWarnings() - Method in class org.opensearch.client.Response: Returns true if there is at least one warning header returned in the response.
HeapBufferedAsyncResponseConsumer - Class in org.opensearch.client: Default implementation of HttpAsyncResponseConsumer.
HeapBufferedAsyncResponseConsumer(int) - Constructor for class org.opensearch.client.HeapBufferedAsyncResponseConsumer: Creates a new instance of this consumer with the provided buffer limit.
HeapBufferedResponseConsumerFactory(int) - Constructor for class org.opensearch.client.HttpAsyncResponseConsumerFactory.HeapBufferedResponseConsumerFactory: Creates a HttpAsyncResponseConsumerFactory.HeapBufferedResponseConsumerFactory instance with the given buffer limit.
HttpAsyncResponseConsumerFactory - Interface in org.opensearch.client: Factory used to create instances of HttpAsyncResponseConsumer.
HttpAsyncResponseConsumerFactory.HeapBufferedResponseConsumerFactory - Class in org.opensearch.client: Default factory used to create instances of HttpAsyncResponseConsumer.

I

isChunked() - Method in class org.opensearch.client.RestClient.ContentCompressingEntity: A gzip compressing entity doesn't work with chunked encoding with sigv4
isChunked() - Method in class org.opensearch.client.RestClient.ContentHttpEntity: A chunked entity requires transfer-encoding:chunked in http headers which requires isChunked to be true
isClusterManagerEligible() - Method in class org.opensearch.client.Node.Roles: Returns whether or not the node could be elected cluster-manager.
isData() - Method in class org.opensearch.client.Node.Roles: Returns whether or not the node stores data.
isIngest() - Method in class org.opensearch.client.Node.Roles: Returns whether or not the node runs ingest pipelines.
isMasterEligible() - Method in class org.opensearch.client.Node.Roles: Deprecated.
As of 2.2, because supporting inclusive language, replaced by Node.Roles.isClusterManagerEligible()
isRunning() - Method in class org.opensearch.client.RestClient: check client running status

N

Node - Class in org.opensearch.client: Metadata about an HttpHost running OpenSearch.
Node(HttpHost) - Constructor for class org.opensearch.client.Node: Create a Node without any metadata.
Node(HttpHost, Set<HttpHost>, String, String, Node.Roles, Map<String, List<String>>) - Constructor for class org.opensearch.client.Node: Create a Node with metadata.
Node.Roles - Class in org.opensearch.client: Role information about an OpenSearch process.
NodeSelector - Interface in org.opensearch.client: Selects nodes that can receive requests.

O

onContentReceived(ContentDecoder, IOControl) - Method in class org.opensearch.client.HeapBufferedAsyncResponseConsumer
onEntityEnclosed(HttpEntity, ContentType) - Method in class org.opensearch.client.HeapBufferedAsyncResponseConsumer
onFailure(Exception) - Method in interface org.opensearch.client.ResponseListener: Method invoked if the request failed.
onFailure(Node) - Method in class org.opensearch.client.RestClient.FailureListener: Notifies that the node provided as argument has just failed.
onResponseReceived(HttpResponse) - Method in class org.opensearch.client.HeapBufferedAsyncResponseConsumer
onSuccess(Response) - Method in interface org.opensearch.client.ResponseListener: Method invoked if the request yielded a successful response.
org.opensearch.client - package org.opensearch.client: REST client that connects to an OpenSearch cluster.

P

performRequest(Request) - Method in class org.opensearch.client.RestClient: Sends a request to the OpenSearch cluster that the client points to.
performRequestAsync(Request, ResponseListener) - Method in class org.opensearch.client.RestClient: Sends a request to the OpenSearch cluster that the client points to.
PERMISSIVE - Static variable in interface org.opensearch.client.WarningsHandler: The permissive warnings handler.
PreferHasAttributeNodeSelector - Class in org.opensearch.client: Both PreferHasAttributeNodeSelector and HasAttributeNodeSelector will work the same if there is a Node with particular attribute in the attributes, but PreferHasAttributeNodeSelector will select another Nodes even if there is no Node with particular attribute in the attributes.
PreferHasAttributeNodeSelector(String, String) - Constructor for class org.opensearch.client.PreferHasAttributeNodeSelector: Creates a PreferHasAttributeNodeSelector instance with the given key value pair.

R

releaseResources() - Method in class org.opensearch.client.HeapBufferedAsyncResponseConsumer
Request - Class in org.opensearch.client: HTTP Request to OpenSearch.
Request(String, String) - Constructor for class org.opensearch.client.Request: Create the Request.
RequestOptions - Class in org.opensearch.client: The portion of an HTTP request to OpenSearch that can be manipulated without changing OpenSearch's behavior.
RequestOptions.Builder - Class in org.opensearch.client: Builds RequestOptions.
Response - Class in org.opensearch.client: Holds an opensearch response.
ResponseException - Exception in org.opensearch.client: Exception thrown when an opensearch node responds to a request with a status code that indicates an error.
ResponseException(Response) - Constructor for exception org.opensearch.client.ResponseException: Creates a ResponseException containing the given Response.
ResponseListener - Interface in org.opensearch.client: Listener to be provided when calling async performRequest methods provided by RestClient.
RestClient - Class in org.opensearch.client: Client that connects to an OpenSearch cluster through HTTP.
RestClient.ContentCompressingEntity - Class in org.opensearch.client: A gzip compressing entity that also implements getContent().
RestClient.ContentHttpEntity - Class in org.opensearch.client: An entity that lets the caller specify the return value of isChunked().
RestClient.FailureListener - Class in org.opensearch.client: Listener that allows to be notified whenever a failure happens.
RestClientBuilder - Class in org.opensearch.client: Helps creating a new RestClient.
RestClientBuilder.HttpClientConfigCallback - Interface in org.opensearch.client: Callback used to customize the CloseableHttpClient instance used by a RestClient instance.
RestClientBuilder.RequestConfigCallback - Interface in org.opensearch.client: Callback used the default RequestConfig being set to the CloseableHttpClient
Roles(Set<String>) - Constructor for class org.opensearch.client.Node.Roles: Create a Node.Roles instance of the given string set.

S

select(Iterable<Node>) - Method in class org.opensearch.client.HasAttributeNodeSelector
select(Iterable<Node>) - Method in interface org.opensearch.client.NodeSelector: Select the Nodes to which to send requests.
select(Iterable<Node>) - Method in class org.opensearch.client.PreferHasAttributeNodeSelector
setChunkedEnabled(boolean) - Method in class org.opensearch.client.RestClientBuilder: Whether the REST client should use Transfer-Encoding: chunked for requests or not"
setCompressionEnabled(boolean) - Method in class org.opensearch.client.RestClientBuilder: Whether the REST client should compress requests using gzip content encoding and add the "Accept-Encoding: gzip" header to receive compressed responses.
setDefaultHeaders(Header[]) - Method in class org.opensearch.client.RestClientBuilder: Sets the default request headers, which will be sent along with each request.
setEntity(HttpEntity) - Method in class org.opensearch.client.Request: Set the body of the request.
setFailureListener(RestClient.FailureListener) - Method in class org.opensearch.client.RestClientBuilder: Sets the RestClient.FailureListener to be notified for each request failure
setHttpAsyncResponseConsumerFactory(HttpAsyncResponseConsumerFactory) - Method in class org.opensearch.client.RequestOptions.Builder: Set the HttpAsyncResponseConsumerFactory used to create one HttpAsyncResponseConsumer callback per retry.
setHttpClientConfigCallback(RestClientBuilder.HttpClientConfigCallback) - Method in class org.opensearch.client.RestClientBuilder: Sets the RestClientBuilder.HttpClientConfigCallback to be used to customize http client configuration
setJsonEntity(String) - Method in class org.opensearch.client.Request: Set the body of the request to a string.
setNodes(Collection<Node>) - Method in class org.opensearch.client.RestClient: Replaces the nodes with which the client communicates.
setNodeSelector(NodeSelector) - Method in class org.opensearch.client.RestClientBuilder: Sets the NodeSelector to be used for all requests.
setOptions(RequestOptions) - Method in class org.opensearch.client.Request: Set the portion of an HTTP request to OpenSearch that can be manipulated without changing OpenSearch's behavior.
setOptions(RequestOptions.Builder) - Method in class org.opensearch.client.Request: Set the portion of an HTTP request to OpenSearch that can be manipulated without changing OpenSearch's behavior.
setPathPrefix(String) - Method in class org.opensearch.client.RestClientBuilder: Sets the path's prefix for every request used by the http client.
setRequestConfig(RequestConfig) - Method in class org.opensearch.client.RequestOptions.Builder: set RequestConfig, which can set socketTimeout, connectTimeout and so on by request
setRequestConfigCallback(RestClientBuilder.RequestConfigCallback) - Method in class org.opensearch.client.RestClientBuilder: Sets the RestClientBuilder.RequestConfigCallback to be used to customize http client configuration
setStrictDeprecationMode(boolean) - Method in class org.opensearch.client.RestClientBuilder: Whether the REST client should return any response containing at least one warning header as a failure.
setWarningsHandler(WarningsHandler) - Method in class org.opensearch.client.RequestOptions.Builder: How this request should handle warnings.
SKIP_DEDICATED_CLUSTER_MANAGERS - Static variable in interface org.opensearch.client.NodeSelector: Selector that matches any node that has metadata and doesn't have the cluster_manager role OR it has the data data role.
STRICT - Static variable in interface org.opensearch.client.WarningsHandler: The strict warnings handler.

T

toBuilder() - Method in class org.opensearch.client.RequestOptions: Create a builder that contains these options but can be modified.
toString() - Method in class org.opensearch.client.HasAttributeNodeSelector
toString() - Method in class org.opensearch.client.Node.Roles
toString() - Method in class org.opensearch.client.Node
toString() - Method in class org.opensearch.client.PreferHasAttributeNodeSelector
toString() - Method in class org.opensearch.client.Request
toString() - Method in class org.opensearch.client.RequestOptions
toString() - Method in class org.opensearch.client.Response

W

WarningFailureException - Exception in org.opensearch.client: This exception is used to indicate that one or more Response.getWarnings() exist and is typically used when the RestClient is set to fail by setting RestClientBuilder.setStrictDeprecationMode(boolean) to `true`.
WarningFailureException(Response) - Constructor for exception org.opensearch.client.WarningFailureException: Creates a WarningFailureException instance.
WarningsHandler - Interface in org.opensearch.client: Called if there are warnings to determine if those warnings should fail the request.
warningsShouldFailRequest(List<String>) - Method in interface org.opensearch.client.WarningsHandler: Determines whether the given list of warnings should fail the request.

A B C D E F G H I N O P R S T W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form