All Classes and Interfaces

Class
Description
 
 
The action to perform on aliases.
An action to perform.
 
 
Builder for Action.
Builder for Action.
Action variant kinds.
 
Builder for ActionAlias.
 
Builder for ActionAllocation.
Builders for Action variants.
The close action configuration.
Builder for ActionClose.
The delete action configuration.
Builder for ActionDelete.
 
Builder for ActionForceMerge.
 
Builder for ActionGroup.
 
Builder for ActionIndexPriority.
The open action configuration.
Builder for ActionOpen.
The read-only action configuration.
Builder for ActionReadOnly.
The read-write action configuration.
Builder for ActionReadWrite.
 
Builder for ActionReplicaCount.
 
Builder for ActionRetry.
 
Builder for ActionRollover.
 
Builder for ActionSnapshot.
 
 
 
Builder for ActionTimeout.
Base interface for Action variants.
 
Builder for AdaptiveSelection.
The configuration for adding an alias.
Builder for AddAction.
Adds a block to an index.
Builder for AddBlockRequest.
 
Builder for AddBlockResponse.
Add features to an existing feature set in the default feature store.
 
Add features to an existing feature set in the default feature store.
 
 
Builder for AdditionalConfig.
Adds a policy to an index.
Builder for AddPolicyRequest.
 
Builder for AddPolicyResponse.
 
 
 
 
 
Aggregate variant kinds.
 
 
Builders for Aggregate variants.
 
Base interface for Aggregate variants.
 
 
Aggregation variant kinds.
 
 
 
Builders for Aggregation variants.
 
Builder for AggregationProfile.
 
 
 
 
Builder for AggregationRange.
Base interface for Aggregation variants.
 
Builder for AlgorithmOperations.
The index alias configuration.
Builder for Alias.
The configuration for an index alias.
Builder for AliasDefinition.
 
Builder for AliasesRecord.
Shows information about aliases currently configured to indexes, including filter and routing information.
Builder for AliasesRequest.
 
Builder for AliasesResponse.
 
Builder for AllField.
The statistics for all indexes.
Builder for AllIndicesStats.
 
Builder for AllocationDecision.
 
Explains how shards are allocated in the current cluster and provides an explanation for why unassigned shards can't be allocated to a node.
 
 
Builder for AllocationRecord.
Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using.
Builder for AllocationRequest.
 
Builder for AllocationResponse.
 
Builder for AllocationStore.
Lists all active CAT point-in-time segments.
 
The detailed analysis results.
Builder for AnalyzeDetail.
 
 
Analyzer variant kinds.
Builders for Analyzer variants.
The analyzer results.
Builder for AnalyzerDetail.
Performs the analysis process on a text and return the tokens breakdown of the text.
Builder for AnalyzeRequest.
 
Builder for AnalyzeResponse.
Base interface for Analyzer variants.
The basic token information.
Builder for AnalyzeToken.
 
 
Apache HttpClient 5 based client transport.
A gzip compressing entity that also implements getContent().
An entity that lets the caller specify the return value of isChunked().
Listener that allows to be notified whenever a failure happens.
 
Callback used the default ConnectionConfig being set to the CloseableHttpClient.
Callback used to customize the CloseableHttpClient instance used by a RestClient instance.
Callback used the default RequestConfig being set to the CloseableHttpClient
 
Utility functions for API model types
 
 
Builder for AppendProcessor.
 
 
 
Builder for AttachmentProcessor.
 
Builder for AuditConfig.
 
Builder for AuditLogsConfig.
Returns or updates authentication information for the currently authenticated user.
Builder for AuthinfoRequest.
 
Builder for AuthinfoResponse.
Returns the authorization token for the current user.
Builder for AuthtokenRequest.
 
Builder for AuthtokenResponse.
 
 
 
Builder for AverageAggregation.
 
 
Builder for AvgAggregate.
 
Implementation of the OpenSearchTransport interface that sends signed requests using the AWS v2 SDK HTTP clients, to connect to an AWS OpenSearch service using IAM authentication.
 
 
 
 
The base information about a node.
 
 
Builder for BinaryProperty.
 
Generic HTTP request / response body.
 
 
Builder for BooleanProperty.
An API response that has boolean value according to the HTTP status code.
 
Builder for BoolQuery.
 
Builder for BoostingQuery.
 
 
Builder for BoxPlotAggregate.
 
Builder for BoxplotAggregation.
 
Builder for Breaker.
 
 
 
 
 
Aggregation buckets.
 
Buckets variant kinds.
 
 
 
Buckets path can be expressed in different ways, and an aggregation may accept some or all of these forms depending on its type.
 
BucketsPath variant kinds.
An object deserializer based on a builder object deserializer and a build function.
 
 
The type of storage implementation.
 
Builder for BulkByScrollFailure.
The status of a bulk by scroll task.
 
 
Builders for BulkByScrollTaskStatusOrException variants.
 
 
BulkOperation variant kinds.
 
 
Builders for BulkOperation variants.
Base interface for BulkOperation variants.
Allows to perform multiple index/update/delete operations in a single request.
Builder for BulkRequest.
 
Builder for BulkResponse.
 
Builder for BulkResponseItem.
 
Builder for ByteBuffer.
 
Builder for ByteNumberProperty.
 
 
Builder for BytesProcessor.
Aggregate cache statistics across all nodes.
Builder for CacheAllStats.
 
Builder for CacheIndicesStats.
 
Builder for CacheItemStats.
 
Builder for CacheShardStats.
 
Builder for CacheStat.
 
 
Builder for CacheStats.
Builder for CacheStats.
 
 
Retrieves cache statistics for all feature stores.
Builder for CacheStatsRequest.
 
Builder for CacheStatsResponse.
 
Cancels a task, if it can be cancelled through an API.
Builder for CancelRequest.
 
Builder for CancelResponse.
 
 
 
 
 
 
Builder for CertificatesDetail.
 
Builder for CertificatesPerNode.
 
Builder for CertificateTypes.
 
Builder for CgroupCpuAcctStats.
 
Builder for CgroupCpuStat.
 
Builder for CgroupCpuStats.
 
Builder for CgroupMemoryStats.
 
Builder for CgroupStats.
Changes the password for the current user.
 
Updates the managed index policy to a new policy.
Builder for ChangePolicyRequest.
 
 
Builder for Channel.
 
 
CharFilter variant kinds.
 
 
Builders for CharFilter variants.
 
 
CharFilterDefinition variant kinds.
Builders for CharFilterDefinition variants.
Base interface for CharFilterDefinition variants.
The character filter results.
Builder for CharFilterDetail.
 
Builder for CharFilterTypes.
 
Builder for CharGroupTokenizer.
 
Builder for ChildrenAggregate.
 
Builder for ChildrenAggregation.
 
 
Builder for ChiSquareHeuristic.
 
Builder for CircleProcessor.
 
Builder for CjkAnalyzer.
Removes any stale data from a snapshot repository.
 
 
Clears all or specific caches for one or more indexes.
Clears the store caches.
Builder for ClearCacheRequest.
Builder for ClearCacheRequest.
 
 
Builder for ClearCacheResponse.
Builder for ClearCacheResponse.
Explicitly clears the search context for a scroll.
Builder for ClearScrollRequest.
 
Builder for ClearScrollResponse.
 
Builder for ClientConfig.
Clones an index.
Builder for CloneIndexRequest.
 
Builder for CloneIndexResponse.
Creates a clone of all or part of a snapshot in the same repository as the original snapshot.
 
Closes an index.
Builder for CloseIndexRequest.
 
Builder for CloseIndexResponse.
The result of a close index operation.
Builder for CloseIndexResult.
The result of closing shards in an index.
Builder for CloseShardResult.
 
Builder for ClusterFileSystem.
Controls the amount of detail included in the cluster health response.
 
Builder for ClusterIndices.
 
 
 
Builder for ClusterInfo.
 
Builder for ClusterIngest.
 
Builder for ClusterJvm.
 
Builder for ClusterJvmMemory.
 
Builder for ClusterJvmVersion.
 
Returns information about the cluster-manager node.
 
 
Builder for ClusterNetworkTypes.
 
Builder for ClusterNodeCount.
 
Builder for ClusterNodes.
 
 
 
 
 
Builder for ClusterProcess.
 
Builder for ClusterProcessCpu.
 
 
Builder for ClusterProcessor.
 
 
ClusterRemoteInfo variant kinds.
Builders for ClusterRemoteInfo variants.
Base interface for ClusterRemoteInfo variants.
 
 
 
 
Builder for ClusterShardMetrics.
 
 
 
Builder for ClusterStateQueue.
 
Builder for ClusterStateStats.
 
Builder for ClusterStatistics.
Returns a high-level overview of cluster statistics.
Builder for ClusterStatsRequest.
 
 
 
Builder for Collector.
 
Builder for ColumnMeta.
 
 
Builder for CombinedFieldsQuery.
 
 
Builder for Command.
 
 
 
Builder for CommandCancelAction.
 
Builder for CommandMoveAction.
 
 
Builder for CommonTermsQuery.
 
Builder for CompactNodeInfo.
 
Builder for CompletionContext.
 
Builder for CompletionProperty.
 
Builder for CompletionStats.
 
 
 
Builder for CompletionSuggester.
 
 
Builder for ComplianceConfig.
 
Builder for ComponentTemplate.
 
 
 
Builder for CompositeAggregate.
 
 
 
Builder for CompositeBucket.
 
 
 
 
 
 
 
 
 
Checks whether or not an upgrade can be performed and which security resources can be updated.
 
Assists the cluster operator with upgrading missing default values and stale default definitions.
 
 
 
 
Builder for ConstantScoreQuery.
 
Text or location that we want similar documents for or a lookup to a document's field for the text.
Builder for Context.
 
Context variant kinds.
Builders for Context variants.
 
Builder for ContextMethod.
 
Builder for ContextMethodParam.
 
Builder for ConvertProcessor.
 
The geographical bounds specified using coordinate values.
Builder for CoordsGeoBounds.
 
 
 
 
Builder for CountRecord.
Provides quick access to the document count of the entire cluster or of an individual index.
Returns number of documents matching a query.
Builder for CountRequest.
Builder for CountRequest.
 
 
Builder for CountResponse.
Builder for CountResponse.
Creates or replaces the specified action group.
 
Creates or replaces APIs permitted for users on the allow list.
 
Creates a standalone connector.
 
Creates a controller.
 
Creates or updates a data stream.
 
Creates the default feature store.
 
Create or update a feature in the default feature store.
 
Create or update a feature set in the default feature store.
 
Creates an index with optional settings and mappings.
Builder for CreateIndexRequest.
 
Builder for CreateIndexResponse.
Create a memory.
Builder for CreateMemoryRequest.
 
Create a message.
 
Create a model from an existing feature set in the default feature store.
 
Registers model metadata.
 
Create or update a model in the default feature store.
Builder for CreateModelRequest.
 
Builder for CreateModelResponse.
 
Builder for CreateOperation.
Creates point in time context.
Builder for CreatePitRequest.
 
Builder for CreatePitResponse.
Creates a snapshot repository.
 
Creates a new document in the index.
Builder for CreateRequest.
 
Builder for CreateResponse.
Creates or replaces the specified role mapping.
 
Creates or replaces the specified role.
Builder for CreateRoleRequest.
 
Builder for CreateRoleResponse.
Creates a snapshot within an existing repository.
 
Creates a new feature store with the specified name.
Builder for CreateStoreRequest.
 
Builder for CreateStoreResponse.
Creates or replaces the specified tenant.
Builder for CreateTenantRequest.
 
Creates or replaces the multi-tenancy configuration.
 
Creates or replaces the specified user.
 
Creates or replaces the specified user.
Builder for CreateUserRequest.
 
Builder for CreateUserResponse.
 
Builder for Credential.
 
Builder for CsvProcessor.
 
 
 
 
Builder for CurrentNode.
 
Builder for CustomAnalyzer.
 
Builder for CustomNormalizer.
 
Builder for DanglingIndex.
 
Builder for Database.
 
Builder for DataPathStats.
 
Builder for DataSource.
 
 
Builder for DataStream.
The configuration for a data stream's backing index.
Builder for DataStreamIndex.
Provides statistics on operations happening in a data stream.
 
The statistics for a data stream.
Builder for DataStreamStats.
 
Builder for DataStreamTimestamp.
The timestamp field configuration for a data stream.
 
 
 
Builder for DateHistogramBucket.
 
 
Builder for DateNanosProperty.
 
Builder for DateProcessor.
 
Builder for DateProperty.
 
Builder for DateRangeAggregate.
 
 
Builder for DateRangeExpression.
 
Builder for DateRangeProperty.
 
Builder for DecayFunction.
 
 
 
Builder for DecayPlacement.
 
An enumeration of the states during decommissioning.
 
 
 
 
Deletes the specified action group.
 
Delete an agent.
Builder for DeleteAgentRequest.
 
Builder for DeleteAgentResponse.
Deletes an alias.
Builder for DeleteAliasRequest.
 
Builder for DeleteAliasResponse.
Deletes all active point in time searches.
 
Deletes documents matching the provided query.
 
Changes the number of requests per second for a particular Delete By Query operation.
 
Deletes a component template.
 
Deletes a standalone connector.
 
Deletes a controller.
 
Deletes the specified dangling index.
 
Deletes a data stream.
 
Recommissions a decommissioned zone.
 
Deletes the default feature store.
 
Deletes all distinguished names in the specified cluster or node allowlist.
 
 
Builder for DeletedPit.
Deletes a specified experiment.
 
Delete a feature from the default feature store.
 
Delete a feature set from the default feature store.
 
Deletes an index.
Builder for DeleteIndexRequest.
 
Builder for DeleteIndexResponse.
Deletes an index template.
 
Delete a specific IP2Geo data source.
 
Deletes a specified judgment.
 
Delete a memory.
Builder for DeleteMemoryRequest.
 
Deletes a model group.
 
Used to delete a particular model in the cluster.
Delete a model from the default feature store.
Deletes a model.
Builder for DeleteModelRequest.
Builder for DeleteModelRequest.
Builder for DeleteModelRequest.
 
 
 
Builder for DeleteModelResponse.
Builder for DeleteModelResponse.
Builder for DeleteModelResponse.
 
Builder for DeleteOperation.
Deletes an ingest pipeline.
 
Deletes one or more point in time searches based on the IDs passed.
Builder for DeletePitRequest.
 
Builder for DeletePitResponse.
Deletes a policy.
Builder for DeletePolicyRequest.
The base response for write operations.
Deletes a query set.
 
Deletes a snapshot repository.
 
Removes a document from the index.
Builder for DeleteRequest.
 
Builder for DeleteResponse.
Deletes the specified role mapping.
 
Deletes the specified role.
Builder for DeleteRoleRequest.
 
Builder for DeleteRoleResponse.
Deletes a script.
Builder for DeleteScriptRequest.
 
Deletes a specified search configuration.
 
Deletes the specified search pipeline.
 
Deletes a snapshot.
 
Deletes a feature store with the specified name.
Builder for DeleteStoreRequest.
 
Builder for DeleteStoreResponse.
Deletes a task.
Builder for DeleteTaskRequest.
 
Builder for DeleteTaskResponse.
Deletes an index template.
 
Deletes the specified tenant.
Builder for DeleteTenantRequest.
 
Delete the specified user.
 
Deletes the specified internal user.
Builder for DeleteUserRequest.
 
Builder for DeleteUserResponse.
Clears any cluster voting configuration exclusions.
Delete weighted shard routing weights.
 
 
 
 
Deploys a model.
Builder for DeployModelRequest.
 
Builder for DeployModelResponse.
 
Builder for DerivativeAggregate.
 
 
Builder for Destination.
 
 
 
 
Base class for dictionary responses, i.e.
 
 
Builder for DirectGenerator.
 
Builder for Discovery.
 
Builder for DiskUsage.
 
Builder for DisMaxQuery.
 
Builder for DissectProcessor.
 
 
 
Builder for DistinguishedNames.
 
The document-level statistics.
Builder for DocStats.
The item level HTTP response status code during indexing.
Builder for DocStatus.
 
Builder for Document.
 
Builder for DocumentRating.
 
Builder for DocumentSimulation.
 
 
 
 
 
Builder for DoubleRangeProperty.
Result of a terms aggregation when the field is some kind of decimal number like a float, double, or distance.
 
Builder for DoubleTermsBucket.
 
Builder for DropProcessor.
 
Builder for DutchAnalyzer.
 
Builder for DynamicConfig.
 
 
Builder for DynamicOptions.
 
Builder for DynamicTemplate.
 
 
 
Builder for EdgeNGramTokenizer.
 
Builder for ElisionTokenFilter.
An empty object with no properties.
Builder for EmptyObject.
 
 
An endpoint links requests and responses to HTTP protocol encoding.
An endpoint wrapper that adds attributes to the JSON mapper used to deserialize its response.
 
Builder for ErrorCause.
 
Builder for ErrorNotification.
 
 
The response returned by OpenSearch when request execution did not succeed.
Builder for ErrorResponse.
 
Builder for EwmaModelSettings.
 
Execute an agent.
Builder for ExecuteAgentRequest.
 
Returns information about whether a particular alias exists.
Builder for ExistsAliasRequest.
Returns information about whether a particular component template exist.
Returns information about whether a particular index template exists.
Checks for the existence of a policy.
Builder for ExistsPolicyRequest.
 
 
Builder for ExistsQuery.
Returns information about whether a document exists in an index.
Returns information about whether a particular index exists.
Builder for ExistsRequest.
Builder for ExistsRequest.
Returns information about whether a document source exists in an index.
Builder for ExistsSourceRequest.
Returns information about whether a particular index template exists.
 
The detailed token information.
Builder for ExplainAnalyzeToken.
 
Builder for ExplainPolicy.
Retrieves the currently applied policy on the specified indexes.
 
Returns information about why a specific matches (or doesn't match) a query.
Builder for ExplainRequest.
 
Builder for ExplainResponse.
 
Builder for Explanation.
 
Builder for ExtendedBounds.
 
Builder for ExtendedMemoryStats.
 
 
 
 
 
 
Utilities for union types whose discriminant is not directly part of the structure, either as an enclosing property name or as an inner property.
A deserializer for externally-tagged unions.
 
 
Builder for FailedIndex.
 
Builder for FailProcessor.
 
Builder for FetchProfile.
 
 
Builder for FetchProfileDebug.
 
Builder for FieldAliasProperty.
 
Builder for FieldAndFormat.
 
Builder for FieldCapability.
Returns the information about the capabilities of fields among multiple indexes.
Builder for FieldCapsRequest.
 
Builder for FieldCapsResponse.
 
Builder for FieldCollapse.
The frequency filter configuration for field data.
 
Builder for FielddataRecord.
Shows how much heap memory is currently being used by field data on every data node in the cluster.
Builder for FielddataRequest.
 
Builder for FielddataResponse.
The statistics about field data memory usage.
Builder for FielddataStats.
A date range limit, represented either as a DateMath expression or a number expressed according to the target field's precision.
 
FieldDateMath variant kinds.
 
Builder for FieldLookup.
 
Builder for FieldMapping.
The memory usage statistics for a field.
Builder for FieldMemoryUsage.
 
Builder for FieldNamesField.
The memory usage statistics for a field.
Builder for FieldSizeUsage.
 
Builder for FieldSort.
 
 
Builder for FieldStatistics.
 
 
FieldSuggester variant kinds.
Builders for FieldSuggester variants.
Base interface for FieldSuggester variants.
 
 
Builder for FieldTypes.
 
Builder for FieldTypesMappings.
 
 
 
 
 
 
The details of a recovered file.
Builder for FileDetails.
 
Builder for FileSystem.
 
Builder for FileSystemTotal.
 
Builder for Filter.
 
Builder for FilterAggregate.
 
 
Builder for FiltersAggregate.
 
Builder for FiltersAggregation.
 
Builder for FiltersBucket.
 
Builder for FingerprintAnalyzer.
 
 
Builder for FlatObjectProperty.
 
Builder for FloatNumberProperty.
 
Builder for FloatRangeProperty.
Flushes the Security plugin's user, authentication, and authorization cache.
Builder for FlushCacheRequest.
 
Builder for FlushCacheResponse.
Performs the flush operation on one or more indexes.
Builder for FlushRequest.
 
Builder for FlushResponse.
The statistics about flush operations.
Builder for FlushStats.
Performs the force merge operation on one or more indexes.
Builder for ForcemergeRequest.
 
Builder for ForcemergeResponse.
 
Builder for ForeachProcessor.
 
 
 
 
 
The function name.
 
 
FunctionScore variant kinds.
Builders for FunctionScore variants.
 
 
Builder for FunctionScoreQuery.
Base interface for FunctionScore variants.
 
Builder for FuzzyQuery.
 
 
Builder for GarbageCollector.
 
Generates a On-Behalf-Of token for the current user.
 
Generates authorization token for the given user.
Generates an authorization token for the specified user.
 
An endpoint with a raw, unparsed response body.
The request that takes care of serializing its body (content) into the OutputStream
 
Builder for GeoBoundingBoxQuery.
A geo-bounding box.
 
GeoBounds variant kinds.
 
Builder for GeoBoundsAggregate.
 
Builders for GeoBounds variants.
 
 
 
 
 
Builder for GeoDistanceQuery.
 
Builder for GeoDistanceSort.
 
 
 
 
 
Builder for GeoHashGridBucket.
The geographical location specified using a geohash.
Builder for GeoHashLocation.
The level of geohash precision, which can be expressed as a geohash length between 1 and 12 or as a distance measure, such as "1km" or "10m".
 
GeoHashPrecision variant kinds.
 
Builder for GeoIpProcessor.
 
Builder for GeoJSONData.
 
Use an OpenSearch query to upload GeoJSON, operation will fail if index exists.
 
Use an OpenSearch query to upload GeoJSON regardless if index exists.
 
A latitude/longitude as a two-dimensional point.
 
GeoLocation variant kinds.
Builders for GeoLocation variants.
 
 
Builder for GeoPointProperty.
 
Builder for GeoPolygonPoints.
 
Builder for GeoPolygonQuery.
 
Builder for GeoShape.
 
Builder for GeoShapeProperty.
 
Builder for GeoShapeQuery.
 
Builder for GeoShapeQueryField.
 
 
 
 
 
 
Builder for GeoTileGridBucket.
 
Returns account information for the current user.
 
Retrieves one action group.
 
Retrieves all action groups.
 
Get an agent.
Builder for GetAgentRequest.
 
Builder for GetAgentResponse.
Returns an alias.
Builder for GetAliasRequest.
 
Builder for GetAliasResponse.
Retrieves the cluster security certificates.
 
Get all memories.
 
Get all messages in a memory.
 
Retrieves the current list of allowed APIs accessible to a normal user.
Builder for GetAllowlistRequest.
 
Lists all active point in time searches.
Builder for GetAllPitsRequest.
 
Builder for GetAllPitsResponse.
Get tools.
Builder for GetAllToolsRequest.
 
Builder for GetAllToolsResponse.
Retrieves the audit configuration.
 
Retrieves the cluster security certificates.
 
Returns cluster settings.
 
Returns one or more component templates.
 
Returns the current Security plugin configuration in a JSON format.
 
Retrieves a standalone connector.
Builder for GetConnectorRequest.
 
Retrieves a controller.
 
Retrieves the current values for dynamic security settings for OpenSearch Dashboards.
 
Returns data streams.
 
Retrieves the decommission status for all zones.
 
Retrieves all node distinguished names.
 
Retrieves all node distinguished names.
 
Gets experiments.
 
Get a feature from the default feature store.
Builder for GetFeatureRequest.
 
Builder for GetFeatureResponse.
Get a feature set from the default feature store.
 
Returns mapping for one or more fields.
 
Returns information about one or more indexes.
Builder for GetIndexRequest.
 
Builder for GetIndexResponse.
Returns an index template.
 
Returns settings for one or more indexes.
 
Get one or more IP2Geo data sources, defaulting to returning all if no names specified.
 
Gets judgments.
Builder for GetJudgmentsRequest.
 
Returns mappings for one or more indexes.
Builder for GetMappingRequest.
 
Builder for GetMappingResponse.
Get a memory.
Builder for GetMemoryRequest.
 
Builder for GetMemoryResponse.
Get a message.
Builder for GetMessageRequest.
 
Builder for GetMessageResponse.
Get a message traces.
 
Retrieves a model group.
 
Used to retrieve information about models present in the cluster.
Get a model from the default feature store.
Retrieves a model.
Builder for GetModelRequest.
Builder for GetModelRequest.
Builder for GetModelRequest.
 
 
 
Builder for GetModelResponse.
Builder for GetModelResponse.
Builder for GetModelResponse.
Retrieves the specified node's security certificates.
 
Gets stats by node.
Builder for GetNodeStatsRequest.
 
Retrieves the evaluated REST API permissions for the currently logged in user.
 
Returns an ingest pipeline.
Builder for GetPipelineRequest.
 
Builder for GetPipelineResponse.
Retrieves the policies.
Builder for GetPoliciesRequest.
 
Builder for GetPoliciesResponse.
Retrieves a specific policy.
Builder for GetPolicyRequest.
 
Builder for GetPolicyResponse.
Get a profile models.
 
Get a profile.
Builder for GetProfileRequest.
 
Builder for GetProfileResponse.
Get a profile tasks.
 
Lists the current query sets available.
Builder for GetQuerySetsRequest.
 
Returns information about a snapshot repository.
 
Returns a document.
Builder for GetRequest.
 
Builder for GetResponse.
 
 
Builder for GetResult.
Retrieves the specified role mapping.
 
Retrieves all role mappings.
 
Retrieves one role.
Builder for GetRoleRequest.
 
Builder for GetRoleResponse.
Retrieves all roles.
Builder for GetRolesRequest.
 
Builder for GetRolesResponse.
Returns all script contexts.
 
Returns available script types, languages and contexts.
 
Returns a script.
Builder for GetScriptRequest.
 
Builder for GetScriptResponse.
Gets the search configurations.
 
Retrieves information about a specified search pipeline.
 
Returns information about a snapshot.
Builder for GetSnapshotRequest.
 
Builder for GetSnapshotResponse.
Returns the source of a document.
Builder for GetSourceRequest.
 
Builder for GetSourceResponse.
Retrieves information about the SSL configuration.
Builder for GetSslinfoRequest.
 
Builder for GetSslinfoResponse.
Use this API to retrieve the ingestion state for a given index.
Builder for GetStateRequest.
 
Builder for GetStateResponse.
The statistics about get operations.
Builder for GetStats.
Get stats.
Gets stats.
Builder for GetStatsRequest.
Builder for GetStatsRequest.
 
 
Builder for GetStatsResponse.
Builder for GetStatsResponse.
Checks if a store exists.
Builder for GetStoreRequest.
 
Builder for GetStoreResponse.
Retrieves a task.
Builder for GetTaskRequest.
 
Builder for GetTaskResponse.
Returns information about a task.
Builder for GetTasksRequest.
 
Builder for GetTasksResponse.
Returns an index template.
Builder for GetTemplateRequest.
 
Builder for GetTemplateResponse.
Retrieves the multi-tenancy configuration.
 
Retrieves the specified tenant.
Builder for GetTenantRequest.
 
Builder for GetTenantResponse.
Retrieves all tenants.
Builder for GetTenantsRequest.
 
Builder for GetTenantsResponse.
Get tools.
Builder for GetToolRequest.
 
Builder for GetToolResponse.
Retrieves statistics for all geospatial uploads.
 
Retrieve one user.
 
Retrieve information about the specified internal user.
Builder for GetUserRequest.
 
Builder for GetUserResponse.
Retrieve all internal users.
 
Retrieve all internal users.
Builder for GetUsersRequest.
 
Builder for GetUsersResponse.
Fetches weighted shard routing weights.
 
 
Builder for GlobalAggregate.
 
Builder for GlobalAggregation.
 
 
Builder for GraphMergeStats.
 
Builder for GraphRefreshStats.
 
Builder for GraphStats.
 
Builder for GrokProcessor.
 
 
Builder for GsubProcessor.
 
Builder for Guardrails.
 
 
 
Builder for HasChildQuery.
 
Builder for HasParentQuery.
 
Builder for HdrMethod.
 
 
 
Builder for Headers.
 
Builder for HealthRecord.
Returns a concise representation of the cluster health.
Returns basic information about the health of the cluster.
Checks to see if the Security plugin is running.
Builder for HealthRequest.
Builder for HealthRequest.
Builder for HealthRequest.
 
 
 
Builder for HealthResponse.
Builder for HealthResponse.
Builder for HealthResponse.
 
Default implementation of AsyncEntityConsumer.
Default implementation of AsyncResponseConsumer.
 
Builder for HelpRecord.
Returns help for the Cat APIs.
 
Builder for HelpResponse.
 
Builder for Highlight.
 
 
 
 
 
 
 
 
HighlighterType variant kinds.
 
Builder for HighlightField.
 
Builder for HistogramAggregate.
 
 
Builder for HistogramBucket.
 
Builder for HistogramOrder.
 
Builder for HistogramProperty.
 
Builder for Hit.
 
Builder for HitsMetadata.
 
 
 
 
 
 
Builder for HotThread.
Returns information about hot threads on each node in the cluster.
Builder for HotThreadsRequest.
 
Builder for HotThreadsResponse.
 
Builder for HtmlStripCharFilter.
 
Builder for Http.
Factory used to create instances of AsyncResponseConsumer.
Default factory used to create instances of AsyncResponseConsumer.
The AsyncEntityProducer implementation for HttpEntity
The producer of the HttpUriRequestBase instances associated with a particular HttpHost
 
Builder for HunspellTokenFilter.
 
Builder for HybridQuery.
 
 
 
 
Builder for IcuAnalyzer.
 
 
 
 
 
 
 
 
 
 
 
 
Builder for IcuTokenizer.
 
 
 
Builder for IdsQuery.
Imports the specified dangling index.
 
 
Builder for IncludeState.
The alias configuration for an index.
Builder for IndexAliases.
The type of check to perform when starting an index.
 
Builder for IndexField.
 
Builder for IndexHealthStats.
 
The configuration for indexing backpressure.
 
Builder for IndexingPressure.
Builder for IndexingPressure.
Builder for IndexingPressure.
 
The memory-related settings for indexing backpressure.
 
 
The configuration for indexing slow log.
Builder for IndexingSlowlog.
The threshold configuration for indexing slow log.
The statistics about indexing operations.
Builder for IndexingStats.
The mapping configuration for an index.
Builder for IndexMappingRecord.
 
 
Builder for IndexOperation.
 
 
Builder for IndexPermission.
Creates or updates a document in an index.
Builder for IndexRequest.
 
Builder for IndexResponse.
The routing configuration for index operations.
Builder for IndexRouting.
The configuration for shard allocation.
The disk-based allocation settings.
The inclusion rules for shard allocation.
The configuration for initial shard recovery.
The options for shard allocation control.
The configuration for shard rebalancing.
The options for shard rebalancing control.
The segment information for an index.
Builder for IndexSegment.
The configuration for segment sorting.
Builder for IndexSegmentSort.
The block settings that control index operations.
Builder for IndexSettingBlocks.
The configuration settings for an index.
Builder for IndexSettings.
The text analysis configuration.
The configuration for text analysis.
The configuration for highlighting.
The indexing-related settings for an index.
The index lifecycle management configuration.
The configuration for the lifecycle step execution.
The mapping configuration for the index.
 
 
 
 
 
 
The configuration for segment merging.
Builder for IndexSettingsMerge.
The configuration for log byte size merge policy.
The policy configuration for segment merging.
 
Builders for IndexSettingsMergePolicy variants.
The type of merge policy.
The configuration for merge scheduling.
The configuration for tiered merge policy.
The configuration for query caching.
The query cache settings.
The configuration for query string parsing.
The configuration for search operations.
Builder for IndexSettingsSearch.
The configuration for concurrent search operations.
The configuration for concurrent segment search.
 
The configuration for similarity algorithms.
The BM25 similarity algorithm configuration.
The divergence from independence (DFI) similarity algorithm configuration.
The divergence from randomness (DFR) similarity algorithm configuration.
The information-based similarity algorithm configuration.
The LM Dirichlet similarity algorithm configuration.
The LM Jelinek-Mercer similarity algorithm configuration.
The scripted TF/IDF similarity algorithm configuration.
The star tree indexing configuration.
The default settings for star tree indexing.
The field-specific settings for star tree indexing.
The field-specific settings for star tree indexing.
 
Builder for IndexSettingsStore.
The filesystem storage configuration.
The type of file system lock.
The hybrid storage type configuration.
The memory-mapped storage configuration.
The NIO storage configuration.
 
Builder for IndexShardStats.
 
 
The state configuration of an index.
Builder for IndexState.
 
Builder for IndexStats.
The base statistics for an index.
 
The configuration for an index template.
Builder for IndexTemplate.
The data stream configuration for an index template.
The configuration for an index template item.
Builder for IndexTemplateItem.
 
The summary configuration for an index template.
The versioning information for the index.
Builder for IndexVersioning.
The type of block to add to an index.
The status of a block operation on an index.
Builder for IndicesBlockStatus.
 
Builder for IndicesRecord.
Lists information related to indexes, that is, how much disk space they are using, how many shards they have, their health status, and so on.
Builder for IndicesRequest.
 
Builder for IndicesResponse.
The base response for index operations.
 
The shard store information for indices.
Builder for IndicesShardStores.
The statistics for specific indexes.
Builder for IndicesStats.
The type of statistics to retrieve.
Provides statistics on operations happening in an index.
Builder for IndicesStatsRequest.
 
The validation results for an index query.
 
Builder for IndicesVersions.
 
Builder for InferenceResults.
Returns basic information about the cluster.
Builder for InfoRequest.
 
Builder for InfoResponse.
 
 
Builder for Ingest.
Builder for Ingest.
The pull-based ingestion settings controlling how data is read from streaming sources.
Builder for IngestionSource.
 
 
Determines where to start reading from the stream.
 
Builder for IngestionSourcePoll.
 
 
 
Builder for IngestTotal.
 
Builder for InlineGet.
 
Builder for InlineScript.
 
Builder for InnerHits.
 
Builder for InnerHitsResult.
 
 
 
 
Intervals variant kinds.
 
Builder for IntervalsAllOf.
 
Builder for IntervalsAnyOf.
Builders for Intervals variants.
 
 
IntervalsFilter variant kinds.
Builders for IntervalsFilter variants.
Base interface for IntervalsFilter variants.
 
Builder for IntervalsFuzzy.
 
Builder for IntervalsMatch.
 
Builder for IntervalsPrefix.
 
 
IntervalsQuery variant kinds.
Builders for IntervalsQuery variants.
Base interface for IntervalsQuery variants.
Base interface for Intervals variants.
 
Builder for IntervalsWildcard.
 
Builder for IoStatDevice.
 
Builder for IoStats.
 
Builder for IpProperty.
 
Builder for IpRangeAggregate.
 
Builder for IpRangeAggregation.
 
 
Builder for IpRangeBucket.
 
Builder for IpRangeProperty.
 
Builder for IsmTemplate.
A JSONP generator implementation on top of Jackson.
Translate a Jackson location to a JSONP location.
 
A JSONP parser implementation on top of Jackson.
A partial implementation of JSONP's SPI on top of Jackson.
 
Builder for JoinProcessor.
 
Builder for JoinProperty.
 
A raw JSON value.
An endpoint with a JSON response body.
Base interface for enumerations in API types.
 
Indicates that a class has a JsonpDeserializer as a static field.
 
Base class for JsonpDeserializer implementations that accept a set of JSON events known at instanciation time.
A JsonpMapper combines a JSON-P provider and object serialization/deserialization based on JSON-P events.
 
 
 
 
 
Builder for JsonProcessor.
 
An object that is its own JsonP serializer
 
 
 
Builder for Jvm.
 
Builder for JvmClasses.
 
Builder for JvmMemoryStats.
 
Builder for JvmThreads.
 
 
 
 
Builder for KeyedProcessor.
 
Builder for KeyValueProcessor.
 
Builder for KeywordAnalyzer.
 
 
Builder for KeywordProperty.
 
Builder for KeywordTokenizer.
 
Builder for KnnMethod.
 
Builder for KnnQuery.
 
 
KnnQueryRescore variant kinds.
Builders for KnnQueryRescore variants.
 
Provides information about the current status of the k-NN plugin.
Builder for KnnStatsRequest.
 
Builder for KnnStatsResponse.
 
Builder for KnnVectorMethod.
 
Builder for KnnVectorProperty.
 
Builder for KStemTokenFilter.
 
Builder for KuromojiAnalyzer.
 
 
 
 
 
 
Builder for KuromojiTokenizer.
 
 
Builder for LanguageAnalyzer.
 
Builder for LanguageContext.
 
 
Builder for LastGcStats.
The geographical location specified using latitude and longitude.
Builder for LatLonGeoLocation.
 
Builder for LengthTokenFilter.
 
Builder for LetterTokenizer.
Specifies the level of detail of the returned information.
 
Text that we want similar documents for or a lookup to a document's field for the text.
 
Like variant kinds.
Builders for Like variants.
 
Builder for LikeDocument.
 
 
 
 
Returns all dangling indexes.
 
Returns a list of tasks.
Builder for ListRequest.
 
Builder for ListResponse.
Lists all available feature stores.
Builder for ListStoresRequest.
 
Builder for ListStoresResponse.
 
Builder for LLM.
Deploys a model.
Builder for LoadModelRequest.
 
Builder for LoadModelResponse.
 
Builder for LongNumberProperty.
 
Builder for LongRangeProperty.
Result of the rare_terms aggregation when the field is some kind of whole number like a integer, long, or a date.
 
Builder for LongRareTermsBucket.
Result of a terms aggregation when the field is some kind of whole number like a integer, long, or a date.
Builder for LongTermsAggregate.
 
Builder for LongTermsBucket.
 
 
LongTermsBucketKey variant kinds.
 
 
Builder for LowercaseNormalizer.
 
Builder for LowercaseProcessor.
 
 
Builder for LowercaseTokenizer.
 
Provides information about the current status of the LTR plugin.
Builder for LtrStatsRequest.
 
Builder for LtrStatsResponse.
The component managing the data stream or index.
 
 
Builder for MappingCharFilter.
 
Builder for MasterRecord.
Returns information about the cluster-manager node.
Builder for MasterRequest.
 
Builder for MasterResponse.
 
Builder for MatchAllQuery.
 
 
Builder for MatchNoneQuery.
 
 
 
Builder for MatchPhraseQuery.
 
Builder for MatchQuery.
 
 
 
 
 
 
Builder for MatrixStatsFields.
 
Builder for MaxAggregate.
 
Builder for MaxAggregation.
 
 
 
 
Builder for Memory.
 
Builder for MemoryStats.
 
 
The statistics about merge operations.
Builder for MergesStats.
 
Builder for Message.
 
 
 
 
 
Allows to get multiple documents in one request.
Builder for MgetRequest.
 
Builder for MgetResponse.
Migrates the security configuration from v6 to v7.
Builder for MigrateRequest.
 
Builder for MigrateResponse.
 
Builder for MinAggregate.
 
Builder for MinAggregation.
 
 
 
Builder for MissingAggregate.
 
Builder for MissingAggregation.
 
Thrown by ObjectBuilder.build() when a required property is missing.
 
 
Builder for ModelConfig.
 
 
Builder for ModelProfile.
 
Builder for ModelStats.
 
Builder for MoreLikeThisQuery.
 
 
 
 
Builders for MovingAverageAggregation variants.
Base interface for MovingAverageAggregation variants.
 
 
Allows to execute several search operations in one request.
Builder for MsearchRequest.
 
Builder for MsearchResponse.
Allows to execute several search template operations in one request.
 
Returns multiple termvectors in one request.
Builder for MtermvectorsRequest.
 
 
 
 
 
 
Builder for MultiGetError.
 
Builder for MultiGetOperation.
 
 
 
Builders for MultiGetResponseItem variants.
 
Builder for MultiMatchQuery.
 
 
Builder for MultisearchBody.
Contains parameters used to limit or change the subsequent search body request.
Builder for MultisearchHeader.
 
Builder for MultiSearchItem.
 
 
 
Builders for MultiSearchResponseItem variants.
 
 
 
Builder for MultiTermLookup.
 
Builder for MultiTermsAggregate.
 
 
Builder for MultiTermsBucket.
 
 
 
 
Builder for Murmur3HashProperty.
 
 
A deserializer that delegates to another deserializer provided as a JSON mapper attribute.
Marks a class a being serialized as nd-json (e.g.
 
Builder for NestedAggregate.
 
Builder for NestedAggregation.
 
Builder for NestedIdentity.
 
Builder for NestedProperty.
 
Builder for NestedQuery.
 
Builder for NestedSortValue.
 
Builder for NeuralQuery.
 
 
Builder for NGramTokenFilter.
 
Builder for NGramTokenizer.
 
Metadata about an HttpHost running OpenSearch.
Builder for Node.
Role information about an OpenSearch process.
 
 
Builder for NodeAttributes.
 
Returns information about custom node attributes.
Builder for NodeattrsRequest.
 
Builder for NodeattrsResponse.
 
Builder for NodeBufferPool.
 
Builder for NodeDetails.
 
Builder for NodeDiskUsage.
 
Builder for NodeIndexShardStats.
 
Builder for NodeIndicesStats.
 
Builder for NodeInfo.
The action-related configuration settings.
Builder for NodeInfoAction.
The aggregation configuration.
Builder for NodeInfoAggregation.
The bootstrap configuration settings for the node.
Builder for NodeInfoBootstrap.
The client node configuration.
Builder for NodeInfoClient.
The node discovery configuration.
Builder for NodeInfoDiscovery.
Provides HTTP connection information for the node.
Builder for NodeInfoHttp.
The ingest pipeline configuration.
Builder for NodeInfoIngest.
The ingest processor download configuration.
The ingest processor configuration details.
Builder for NodeInfoIngestInfo.
The ingest processor configuration.
Provides JVM memory settings and statistics.
Builder for NodeInfoJvmMemory.
Provides memory information for the node.
Builder for NodeInfoMemory.
Provides network-related information for the node.
Builder for NodeInfoNetwork.
Describes a network interface on the node.
Provides CPU information for the node.
Builder for NodeInfoOSCPU.
The filesystem path configurations for the node.
Builder for NodeInfoPath.
The repository configuration information.
Specifies allowed repository URLs.
The script execution configuration.
Builder for NodeInfoScript.
The search operation configuration.
Builder for NodeInfoSearch.
The search pipeline processor configuration.
The search pipeline configuration.
The remote search connection configuration.
The configuration settings for the node.
Builder for NodeInfoSettings.
Provides cluster-level settings information.
The cluster election strategy configuration.
Controls deprecation notice indexing behavior.
The HTTP server configuration.
The HTTP server type configuration.
 
Builders for NodeInfoSettingsHttpType variants.
The HTTP server type configuration details.
The index-level settings configuration.
The hybrid store configuration.
The index store configuration.
The memory-mapped store configuration.
The ingest processor configurations.
The network configuration settings.
The node-specific configuration settings.
The transport layer configuration settings.
The transport layer type configuration.
 
Builders for NodeInfoSettingsTransportType variants.
The detailed transport type configuration.
The transport layer information.
Builder for NodeInfoTransport.
Provides JVM-specific information for the node.
Builder for NodeJvmInfo.
Provides operating system information for the node.
 
Builder for NodePackagingType.
Provides process-related information for the node.
Builder for NodeProcessInfo.
 
Builder for NodeReloadResult.
 
Selects nodes that can receive requests.
The information about a shard on a node.
Builder for NodeShard.
The nodes metrics to retrieve.
Returns information about nodes in the cluster.
Builder for NodesInfoRequest.
The response containing node information.
Builder for NodesInfoResponse.
 
Builder for NodesRecord.
Returns basic statistics about the performance of cluster nodes.
Builder for NodesRequest.
 
Builder for NodesResponse.
Provides base response structure for node-related operations.
 
 
 
Returns statistical information about nodes in the cluster.
Builder for NodesStatsRequest.
The response containing node statistics.
Builder for NodesStatsResponse.
 
The statistics about node operations.
Builder for NodeStatistics.
 
 
Builder for NodeStats.
Builder for NodeStats.
Cache statistics for a node.
 
Builder for NodeStatsDetails.
Builder for NodeStatsDetails.
 
Returns low-level information about REST actions usage on nodes.
Builder for NodesUsageRequest.
The response containing node usage information.
Builder for NodesUsageResponse.
The thread pool configuration details.
Builder for NodeThreadPoolInfo.
 
Builder for NodeUsage.
 
Builder for NoriAnalyzer.
 
 
 
Builder for NoriTokenizer.
 
 
 
 
 
Normalizer variant kinds.
Builders for Normalizer variants.
Base interface for Normalizer variants.
 
 
The configuration for numeric field data.
Builder for NumericFielddata.
The format for numeric field data.
Base interface for all object builders.
 
An object deserializer based on an ObjectBuilder.
 
A field deserializer parses a value and calls the setter on the target object.
Field deserializer for objects (and boxed primitives)
 
Builder for ObjectProperty.
Opens an index.
Builder for OpenRequest.
 
Builder for OpenResponse.
Client for the namespace.
Client for the namespace.
Client for the cat namespace.
Client for the cat namespace.
Client for the cat namespace.
Client for the cat namespace.
Client for the namespace.
Client for the namespace.
Exception thrown by API client methods when OpenSearch could not accept or process a request.
Client for the cluster namespace.
Client for the cluster namespace.
Client for the dangling_indices namespace.
Client for the dangling_indices namespace.
Exception thrown by API client methods when OpenSearch could not accept or process a request.
Client for the generic HTTP requests.
Generic client options
Client for the geospatial namespace.
Client for the geospatial namespace.
Client for the indices namespace.
Client for the indices namespace.
Client for the indices namespace.
Client for the indices namespace.
Client for the ingest namespace.
Client for the ingest namespace.
Client for the ingestion namespace.
Client for the ingestion namespace.
Client for the ism namespace.
Client for the ism namespace.
Client for the knn namespace.
Client for the knn namespace.
Client for the ltr namespace.
Client for the ltr namespace.
Client for the ml namespace.
Client for the ml namespace.
Client for the nodes namespace.
Client for the nodes namespace.
Client for the nodes namespace.
Client for the nodes namespace.
Serializes and captures an OpenSearch request body, and then provides access to it in convenient forms for HTTP requests.
Client for the search_pipeline namespace.
Client for the search_pipeline namespace.
Client for the search_relevance namespace.
Client for the search_relevance namespace.
Client for the security namespace.
Client for the security namespace.
Client for the snapshot namespace.
Client for the snapshot namespace.
Client for the tasks namespace.
Client for the tasks namespace.
A transport layer that implements OpenSearch specificities.
The version information for OpenSearch.
 
Builder for OperatingSystem.
 
 
 
 
 
 
Builder for Output.
The configuration for overlapping index templates.
Builder for Overlapping.
 
 
Builder for Owner.
 
 
Builder for ParentAggregate.
 
Builder for ParentAggregation.
 
Builder for ParentIdQuery.
Updates the individual attributes of an action group.
 
Creates, updates, or deletes multiple action groups in a single request.
 
Updates the current list of APIs accessible for users on the allow list.
 
Updates the specified fields in the audit configuration.
 
Updates the existing security configuration using the REST API.
 
Updates the distinguished cluster name for the specified cluster.
 
Bulk updates specified node distinguished names.
 
 
Builder for PatchOperation.
Updates the individual attributes of a role mapping.
 
Creates or updates multiple role mappings in a single request.
 
Updates the individual attributes of a role.
Builder for PatchRoleRequest.
 
Builder for PatchRoleResponse.
Creates, updates, or deletes multiple roles in a single call.
Builder for PatchRolesRequest.
 
Builder for PatchRolesResponse.
Adds, deletes, or modifies a single tenant.
Builder for PatchTenantRequest.
 
Builder for PatchTenantResponse.
Adds, deletes, or modifies multiple tenants in a single request.
Builder for PatchTenantsRequest.
 
Updates individual attributes for an internal user.
Builder for PatchUserRequest.
 
Builder for PatchUserResponse.
Creates, updates, or deletes multiple internal users in a single request.
Builder for PatchUsersRequest.
 
Builder for PatchUsersResponse.
 
 
 
Builder for PatternAnalyzer.
 
 
 
 
Builder for PatternTokenizer.
Use this API to pause ingestion for a given index.
Builder for PauseRequest.
 
Builder for PauseResponse.
 
Builder for PendingTask.
 
Builder for PendingTasksRecord.
Returns a concise representation of the cluster's pending tasks.
Returns a list of pending cluster-level tasks, such as index creation, mapping updates, or new allocations.
Builder for PendingTasksRequest.
Builder for PendingTasksRequest.
 
 
 
 
 
 
Percentiles variant kinds.
 
 
 
 
 
 
Builder for PercolateQuery.
 
Builder for PercolatorProperty.
 
 
 
 
PhaseResultsProcessor variant kinds.
Builders for PhaseResultsProcessor variants.
Base interface for PhaseResultsProcessor variants.
The time taken by different phases of the search.
Builder for PhaseTook.
 
Builder for PhoneAnalyzer.
 
 
 
Builder for PhoneSearchAnalyzer.
 
 
 
 
 
Builder for PhoneticTokenFilter.
 
 
 
 
 
Builder for PhraseSuggester.
 
 
Builder for PhraseSuggestOption.
Returns whether the cluster is running.
Builder for PingRequest.
 
Builder for PinnedDoc.
 
 
PinnedQuery variant kinds.
Base interface for PinnedQuery variants.
 
Builder for Pipeline.
 
 
 
Builder for PipelineProcessor.
 
Builder for PipelineSimulation.
 
Builder for Pit.
 
Builder for PitDetail.
Lists one or several CAT point-in-time segments.
Builder for PitSegmentsRequest.
 
Builder for PitSegmentsResponse.
Base interface to set JSON properties
 
 
Builder for PluginsRecord.
Returns information about the names, components, and versions of the installed plugins.
Builder for PluginsRequest.
 
Builder for PluginsResponse.
 
Builder for PluginStats.
The policy defines how an index is managed throughout its lifetime.
Builder for Policy.
 
Builder for PolicyEnvelope.
 
Builder for PolicyWithMetadata.
 
 
Builder for Pool.
 
Retrieves the current values for dynamic security settings for OpenSearch Dashboards.
 
Creates a new query set by sampling queries from the user behavior data.
 
Updates the cluster voting configuration by excluding certain node IDs or names.
 
 
Builder for PredictionResult.
 
Builder for PredictRequestStats.
 
Builder for PrefixQuery.
 
Builder for PressureMemory.
 
Builder for Process.
 
Builder for ProcessCpuStats.
 
Builder for ProcessMemoryStats.
 
 
 
Builder for Processor.
Processor variant kinds.
 
 
Builders for Processor variants.
Returns a list of built-in grok patterns.
 
Base interface for Processor variants.
 
Builder for Profile.
 
 
Property variant kinds.
 
 
Builders for Property variants.
Base interface for Property variants.
 
Creates or updates an alias.
Builder for PutAliasRequest.
 
Builder for PutAliasResponse.
Updates the cluster settings.
 
Creates or updates a component template.
 
Decommissions a cluster zone based on awareness.
 
Creates an experiment.
 
Creates or updates an index template.
 
Updates the index settings.
 
Create a specific IP2Geo data source.
 
Update a specific IP2Geo data source.
 
Creates a judgment.
Builder for PutJudgmentsRequest.
 
Updates the index mappings.
Builder for PutMappingRequest.
 
Builder for PutMappingResponse.
Creates or updates an ingest pipeline.
Builder for PutPipelineRequest.
 
Builder for PutPipelineResponse.
Creates or updates policies.
Builder for PutPoliciesRequest.
 
Builder for PutPoliciesResponse.
Creates or updates a policy.
Builder for PutPolicyRequest.
 
Builder for PutPolicyResponse.
Creates a new query set by uploading manually.
Builder for PutQuerySetsRequest.
 
Creates or updates a script.
Builder for PutScriptRequest.
 
Builder for PutScriptResponse.
Creates a search configuration.
 
Creates or replaces the specified search pipeline.
 
Creates or updates an index template.
Builder for PutTemplateRequest.
 
Builder for PutTemplateResponse.
Updates weighted shard routing weights.
 
Represents an operation that accepts 4 input arguments and returns no result.
Represents a function that accepts 4 arguments and produces a result.
 
 
Query variant kinds.
 
 
 
Builder for QueryBreakdown.
Builders for Query variants.
The statistics about query cache usage.
Builder for QueryCacheStats.
 
Builder for QueryProfile.
 
Builder for QueryStringQuery.
Base interface for Query variants.
 
Builder for RandomScoreFunction.
 
Builder for RangeAggregate.
 
 
 
Builder for RangeAggregation.
 
Builder for RangeBucket.
 
 
 
Builder for RangeQuery.
 
Builder for RankEvalHit.
 
Builder for RankEvalHitItem.
 
Builder for RankEvalMetric.
 
 
 
 
 
 
 
 
 
 
 
Builder for RankEvalQuery.
Allows to evaluate the quality of ranked search results over a set of typical search queries.
Builder for RankEvalRequest.
 
Builder for RankEvalRequestItem.
 
Builder for RankEvalResponse.
 
 
 
 
 
 
 
Builder for RankFeatureProperty.
 
Builder for RankFeatureQuery.
 
 
 
Builder for RateAggregate.
 
Builder for RateAggregation.
 
Builder for RateLimiter.
 
The byte-level recovery statistics.
Builder for RecoveryBytes.
The file-level recovery statistics.
Builder for RecoveryFiles.
The index recovery status.
Builder for RecoveryIndexStatus.
The source or target of a recovery operation.
Builder for RecoveryOrigin.
 
Builder for RecoveryRecord.
Returns all completed and ongoing index and shard recoveries.
Returns information about ongoing index shard recoveries.
Builder for RecoveryRequest.
Builder for RecoveryRequest.
 
 
Builder for RecoveryResponse.
Builder for RecoveryResponse.
The status at the start of recovery.
Builder for RecoveryStartStatus.
The statistics about recovery operations.
Builder for RecoveryStats.
The status of recovery operations.
Builder for RecoveryStatus.
 
Performs the refresh operation in one or more indexes.
Builder for RefreshRequest.
 
Builder for RefreshResponse.
Refreshes search analyzers in real time.
 
 
The statistics about refresh operations.
Builder for RefreshStats.
 
Builder for RegexpQuery.
Register an agent.
 
Registers a model group.
 
Registers model metadata.
 
Registers a model.
 
 
Builder for ReindexNode.
Allows to copy documents from one index to another, optionally filtering the source documents by a query, changing the destination index settings, or fetching the documents from a remote cluster.
Builder for ReindexRequest.
 
Builder for ReindexResponse.
Changes the number of requests per second for a particular reindex operation.
 
 
Builder for ReindexStatus.
 
Builder for ReindexTask.
Reloads the HTTP communication certificates.
 
Reloads secure settings.
The response containing secure settings reload results.
Reloads the transport communication certificates.
 
Returns the information about configured remote clusters.
Builder for RemoteInfoRequest.
 
Builder for RemoteInfoResponse.
 
Builder for RemoteSource.
Any statistics related to downloads to the remote segment store.
The statistics related to remote segment store operations.
 
Builder for RemoteStoreStats.
Builder for RemoteStoreStats.
The statistics related to remote translog operations.
The statistics related to uploads to the remote translog store.
The total amount of data uploaded to the remote translog store.
The number of syncs to the remote translog store.
The amount of data, in bytes, uploaded or downloaded to/from the remote segment store.
Statistics related to segment store upload backpressure.
The amount of lag during upload between the remote segment store and the local store.
Any statistics related to uploads to the remote segment store.
 
 
 
 
The configuration for removing an alias.
Builder for RemoveAction.
 
The configuration for removing an index.
Builder for RemoveIndexAction.
Removes a policy from an index.
Builder for RemovePolicyRequest.
 
 
Builder for RemoveProcessor.
 
 
Builder for RenameProcessor.
Allows to use the Mustache language to pre-render a search definition.
 
 
 
Builder for RepositoriesRecord.
Returns information about all snapshot repositories for a cluster.
Builder for RepositoriesRequest.
 
The name of the repository to store the snapshot.
Builder for Repository.
The settings for the snapshot repository.
Builder for RepositorySettings.
Generic HTTP request to OpenSearch
 
 
The statistics about request cache operations.
Builder for RequestCacheStats.
 
 
Builder for RequestItem.
Builder for RequestItem.
 
 
RequestProcessor variant kinds.
Builders for RequestProcessor variants.
Base interface for RequestProcessor variants.
Helper class to construct requests instances
A new builder for requests with JSON body
The statistics about request operations.
Builder for RequestStats.
 
Builder for RerankContext.
 
 
Builder for RerouteDecision.
 
Builder for RerouteExplanation.
 
Builder for RerouteParameters.
Allows to manually change the allocation of individual shards in the cluster.
Builder for RerouteRequest.
 
Builder for RerouteResponse.
 
Builder for Rescore.
 
Builder for RescoreContext.
 
Builder for RescoreQuery.
 
Builder for ReservedSize.
 
 
Builder for ResetSettings.
The resolved information for an index alias.
The resolved information for a data stream.
The resolved information for an index.
Builder for ResolveIndexItem.
Returns information about any matching indexes, aliases, and data streams.
Builder for ResolveIndexRequest.
 
Any statistics about CPU and memory usage.
Builder for ResourceStat.
The statistics about resource usage.
Builder for ResourceStats.
Generic HTTP response from OpenSearch
Exception thrown when an opensearch node responds to a request with a status code that indicates an error.
 
 
ResponseProcessor variant kinds.
Builders for ResponseProcessor variants.
Base interface for ResponseProcessor variants.
Deprecated.
 
Deprecated.
Restores a snapshot.
 
 
Use this API to resume ingestion for the given index.
Builder for ResumeRequest.
 
Builder for ResumeResponse.
The retention lease configuration.
Builder for RetentionLease.
The retry statistics for bulk and search operations.
Builder for Retries.
 
Retries the failed action for an index.
Builder for RetryIndexRequest.
 
Builder for RetryIndexResponse.
 
 
 
Builder for ReverseTokenFilter.
 
Builder for Role.
 
Builder for RoleMapping.
The conditions that trigger an index rollover.
Builder for RolloverConditions.
Updates an alias to point to a new index when the existing index is considered to be too large or too old.
Builder for RolloverRequest.
 
Builder for RolloverResponse.
 
Builder for RoutingField.
 
Builder for Rows.
 
Builder for RuntimeField.
 
 
Builder for SamplerAggregate.
 
Builder for SamplerAggregation.
 
 
 
Builder for ScoreCombination.
 
 
 
 
Builder for ScoreNormalization.
 
 
 
 
 
Builder for ScoreSort.
 
 
Script variant kinds.
 
 
Builders for Script variants.
 
Builder for ScriptCacheStats.
 
Builder for ScriptContextStats.
 
Builder for ScriptedHeuristic.
 
 
The configuration for a script field.
Builder for ScriptField.
 
 
ScriptLanguage variant kinds.
 
Builder for ScriptQuery.
 
Builder for ScriptScoreFunction.
 
Builder for ScriptScoreQuery.
 
Builder for ScriptSort.
 
Allows an arbitrary script to be executed and a result to be returned.
 
 
Builder for ScriptStats.
 
 
Allows to retrieve a large numbers of results from a single search request.
Builder for ScrollRequest.
 
Builder for ScrollResponse.
 
Search for feature sets in a feature store.
 
Search for features in a feature store.
 
The configuration for search idle behavior.
Builder for SearchIdle.
Use an OpenSearch query to search for models in the index.
Search for models in a feature store.
Builder for SearchModelsRequest.
Builder for SearchModelsRequest.
 
 
 
 
Builder for SearchProfile.
Returns results matching a query.
Builder for SearchRequest.
 
Builder for SearchResponse.
 
 
 
Returns information about the indexes and shards that a search request would be executed against.
Builder for SearchShardsRequest.
 
The configuration for search slow log.
Builder for SearchSlowlog.
The threshold configuration for search slow log.
The statistics about search operations.
Builder for SearchStats.
Allows to use the Mustache language to pre-render a search definition.
 
 
The detailed information about a segment.
Builder for Segment.
 
Returns information about active and last-completed segment replication events on each replica shard, including related shard-level metrics.
 
 
The handling of missing values in segment sorting.
The sort mode for segments.
The sort order for segments.
 
Builder for SegmentsRecord.
Provides low-level information about the segments in the shards of an index.
Provides low-level information about segments in a Lucene index.
Builder for SegmentsRequest.
Builder for SegmentsRequest.
 
 
Builder for SegmentsResponse.
Builder for SegmentsResponse.
The statistics about segments.
Builder for SegmentsStats.
 
 
Builder for SetProcessor.
 
 
 
 
 
The commit information for a shard.
Builder for ShardCommit.
 
Builder for ShardFailure.
The size information for shard files.
Builder for ShardFileSizeInfo.
 
Builder for ShardHealthStats.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Builder for ShardIngestionState.
The retention lease details.
Builder for ShardLease.
The path information for a shard.
Builder for ShardPath.
 
Builder for ShardProfile.
The recovery status of a shard.
Builder for ShardRecovery.
 
 
The retention lease information for a shard.
The routing information for a shard.
Builder for ShardRouting.
The state of shard routing.
 
 
 
 
 
 
 
 
 
 
 
 
 
The routing information for a shard segment.
Builder for ShardSegmentRouting.
The sequence number information for a shard.
Builder for ShardSequenceNumber.
The base response for operations involving shards.
 
 
Builder for ShardsRecord.
Lists the states of all primary and replica shards and how they are distributed.
Builder for ShardsRequest.
 
Builder for ShardsResponse.
The segment information for a shard.
Builder for ShardsSegment.
 
Builder for ShardStatistics.
The store information for a shard.
Builder for ShardStore.
The allocation type of the shard store.
The exception information for a shard store.
Builder for ShardStoreException.
 
Builder for ShardStoreIndex.
Provides store information for shard copies of indexes.
Builder for ShardStoresRequest.
 
Builder for ShardStoresResponse.
The status of shard stores.
The wrapper containing store information for a shard.
Builder for ShardStoreWrapper.
 
 
 
 
 
Builder for ShingleTokenFilter.
 
Builder for ShortNumberProperty.
Allow to shrink an existing index into a new index with fewer primary shards.
Builder for ShrinkRequest.
 
Builder for ShrinkResponse.
 
 
 
 
 
 
 
 
 
 
 
Builder for SimpleAnalyzer.
 
 
 
 
 
Query flags can be either a single flag or a combination of flags (e.g.
 
SimpleQueryStringFlags variant kinds.
 
 
Simulate matching the given index name against the index templates in the system.
 
Simulates an ingest pipeline with example documents.
Builder for SimulateRequest.
 
Builder for SimulateResponse.
Simulate resolving the given template name or body.
 
 
 
 
 
 
Builder for SizeField.
The configuration for a sliced scroll request.
Builder for SlicedScroll.
The slice configuration used to parallelize a process.
 
Slices variant kinds.
 
The threshold levels for slow log.
 
Builder for SmartcnAnalyzer.
 
 
Builder for SmartcnTokenizer.
 
 
SmoothingModel variant kinds.
Builders for SmoothingModel variants.
Base interface for SmoothingModel variants.
 
Builder for SnapshotIndexStats.
 
Builder for SnapshotInfo.
 
Builder for SnapshotRestore.
 
 
Builder for SnapshotShardsStats.
 
 
 
 
 
Builder for SnapshotsRecord.
Lists all of the snapshots stored in a specific repository.
Builder for SnapshotsRequest.
 
Builder for SnapshotsResponse.
 
Builder for SnapshotStats.
 
Builder for SnapshotStatus.
Returns information about the status of a snapshot.
 
 
Builder for SnowballAnalyzer.
 
 
Builder for SnowballTokenFilter.
The configuration for soft deletes.
Builder for SoftDeletes.
The retention configuration for soft deletes.
 
 
 
SortOptions variant kinds.
Builders for SortOptions variants.
Base interface for SortOptions variants.
The direction of the sort order.
 
Builder for SortProcessor.
 
 
Builder for Source.
Defines how to fetch a source.
 
SourceConfig variant kinds.
Builders for SourceConfig variants.
Defines how to fetch a source.
 
SourceConfigParam variant kinds.
 
Builder for SourceField.
 
Builder for SourceFilter.
 
Builder for SpanContainingQuery.
 
 
Builder for SpanFirstQuery.
Can only be used as a clause in a span_near query.
Builder for SpanGapQuery.
 
Builder for SpanMultiTermQuery.
 
Builder for SpanNearQuery.
 
Builder for SpanNotQuery.
 
Builder for SpanOrQuery.
 
 
SpanQuery variant kinds.
Builders for SpanQuery variants.
Base interface for SpanQuery variants.
 
Builder for SpanTermQuery.
 
Builder for SpanWithinQuery.
 
Builder for SplitProcessor.
Allows you to split an existing index into a new index with more primary shards.
Builder for SplitRequest.
 
Builder for SplitResponse.
 
 
Builder for StandardAnalyzer.
 
 
 
Builder for StandardTokenizer.
Returns comprehensive information about the state of the cluster.
Builder for StateRequest.
 
Builder for StateResponse.
The list of actions to perform and transitions to enter a new state.
Builder for States.
 
Builder for Stats.
 
Builder for StatsAggregate.
 
 
 
Builder for StatsAggregation.
 
 
The status.
Task status information can vary wildly from task to task.
Builder for Status.
 
 
Builder for StemmerTokenFilter.
 
Builder for StopAnalyzer.
 
Builder for StopTokenFilter.
 
 
StorageType variant kinds.
 
Builder for StoreDetails.
The definition of a stored script.
Builder for StoredScript.
 
Builder for StoredScriptId.
 
Builder for StoreStat.
 
Builder for StoreStats.
 
Result of the rare_terms aggregation when the field is a string.
 
Result of a terms aggregation when the field is a string.
 
Builder for StringTermsBucket.
 
 
 
 
 
Builder for SuggestBase.
 
Builder for SuggestContext.
 
Builder for Suggester.
 
 
 
Builder for SuggestFuzziness.
 
Builders for Suggest variants.
 
 
 
Builder for SumAggregate.
 
Builder for SumAggregation.
 
 
 
 
Builder for SynonymTokenFilter.
 
 
 
Builder for Task.
 
Builder for TaskExecutingNode.
The details of a task failure.
Builder for TaskFailure.
 
Builder for TaskGroup.
 
Builder for TaskInfo.
 
 
 
 
TaskInfos variant kinds.
 
 
 
Builder for TaskResponse.
 
Builder for TasksRecord.
Lists the progress of all tasks currently running on the cluster.
Builder for TasksRequest.
 
Builder for TasksResponse.
 
Builder for TDigest.
 
 
The configuration for an index template simulation.
Builder for Template.
 
Builder for TemplateConfig.
The mapping configuration for a template.
Builder for TemplateMapping.
 
Builder for TemplatesRecord.
Lists the names, patterns, order numbers, and version numbers of index templates.
Builder for TemplatesRequest.
 
Builder for TemplatesResponse.
 
Builder for Tenant.
Retrieves the names of current tenants.
Builder for TenantInfoRequest.
 
Builder for TenantInfoResponse.
 
Builder for TenantPermission.
 
Builder for Term.
 
 
Builder for TermQuery.
 
 
 
Builder for TermsAggregation.
 
 
 
 
 
 
TermsExclude variant kinds.
 
 
TermsInclude variant kinds.
Builders for TermsInclude variants.
 
Builder for TermsLookup.
 
Builder for TermsPartition.
 
Builder for TermsQuery.
 
 
TermsQueryField variant kinds.
Builders for TermsQueryField variants.
 
 
Builder for TermsSetQuery.
 
 
 
Builder for TermSuggester.
 
Builder for TermSuggestOption.
 
Builder for TermVector.
 
Returns information and statistics about terms in the fields of a particular document.
Builder for TermvectorsRequest.
 
Builder for TermvectorsResponse.
 
Builder for TestPopulation.
 
 
Builder for TextIndexPrefixes.
 
Builder for TextProperty.
 
 
Builder for ThreadCount.
The information about thread usage.
Builder for ThreadInfo.
 
Builder for ThreadPoolRecord.
Returns cluster-wide thread pool statistics per node.
Builder for ThreadPoolRequest.
 
Builder for ThreadPoolResponse.
 
Whenever durations need to be specified, e.g.
 
 
Builders for Time variants.
Specifies the time units, for example, 5d or 7h.
 
 
Builder for Token.
 
 
Builder for TokenCountProperty.
The token filter or tokenizer results.
Builder for TokenDetail.
 
 
TokenFilter variant kinds.
 
 
Builders for TokenFilter variants.
 
 
TokenFilterDefinition variant kinds.
Builders for TokenFilterDefinition variants.
Base interface for TokenFilterDefinition variants.
 
 
Tokenizer variant kinds.
 
 
Builders for Tokenizer variants.
 
 
TokenizerDefinition variant kinds.
Builders for TokenizerDefinition variants.
Base interface for TokenizerDefinition variants.
 
Builder for Tool.
 
Builder for ToolAttributes.
 
Builder for ToolItems.
 
Builder for TopHitsAggregate.
 
Builder for TopHitsAggregation.
The geographical bounds specified using upper-left and lower-right points.
The geographical bounds specified using upper-right and lower-left points.
 
Builder for TotalHits.
 
The number of hits matching the query.
 
TrackHits variant kinds.
Create and train a model that can be used for initializing k-NN native library indexes during indexing.
Builder for TrainModelRequest.
 
Builder for TrainModelResponse.
A transition into a new state.
Builder for Transition.
The translog configuration.
Builder for Translog.
The durability settings for the translog.
The retention configuration for the translog.
Builder for TranslogRetention.
The statistics about translog operations.
Builder for TranslogStats.
The transaction log recovery status.
Builder for TranslogStatus.
 
The transport layer that allows ApiClients to send requests.
Builder for Transport.
 
 
Container for all application-specific or request-specific options, including headers, query parameters and warning handlers.
 
 
 
 
Builder for TransportUsageStats.
Represents an operation that accepts 3 input arguments and returns no result.
Represents a function that accepts 3 arguments and produces a result.
 
Builder for TrimProcessor.
 
Builder for TrimTokenFilter.
 
 
Builder for TruncateTokenFilter.
 
Builder for TTestAggregate.
 
Builder for TTestAggregation.
 
 
Builder for TypeFieldMappings.
 
Builder for TypeMapping.
 
Builder for TypeQuery.
 
 
 
 
Builder for UndeployModelNode.
Undeploys a model.
 
 
 
 
 
 
Builder for UniqueTokenFilter.
 
Builder for UnloadModelNode.
Unloads a model.
Builder for UnloadModelRequest.
 
Builder for UnloadModelResponse.
Result of a rare_terms aggregation when the field is unmapped.
 
Result of a terms aggregation when the field is unmapped.
 
Builder for UnratedDocument.
 
Updates index aliases.
 
Updates the audit configuration.
 
Performs an update on every document in the index without changing the source, for example to pick up a mapping change.
 
 
Changes the number of requests per second for a particular Update By Query operation.
 
Updates the settings for an existing security configuration.
 
Updates a standalone connector.
 
Updates a controller.
 
Adds or updates the specified distinguished names in the cluster or node allowlist.
 
Update a feature in the default feature store.
 
Update a feature set in the default feature store.
 
Update a memory.
Builder for UpdateMemoryRequest.
 
Update a message.
 
Updates a model group.
 
Updates a model.
Builder for UpdateModelRequest.
 
Builder for UpdateModelResponse.
 
Builder for UpdateOperation.
 
Builder for UpdateOperationData.
Updates a document with a script or partial document.
Builder for UpdateRequest.
 
Builder for UpdateResponse.
 
Builder for UpdateStats.
Uploads model chunk.
Builder for UploadChunkRequest.
 
Builder for UploadChunkResponse.
Registers a model.
Builder for UploadModelRequest.
 
Builder for UploadModelResponse.
 
Builder for UploadStatsMetric.
 
Builder for UploadStatsTotal.
 
Builder for UppercaseProcessor.
 
 
Builder for UrlDecodeProcessor.
 
Builder for UsageStats.
 
Builder for User.
 
Builder for UserAgentProcessor.
 
 
Builder for UserTenants.
Allows a user to validate a potentially expensive query without executing it.
 
Checks whether the v6 security configuration is valid and ready to be migrated to v7.
Builder for ValidateRequest.
 
Builder for ValidateResponse.
 
Builder for ValueCountAggregate.
 
 
Builder for Values.
 
 
 
 
The index verification status.
Builder for VerifyIndex.
Verifies a repository.
 
This class represents a SemVer version, with an optional patch revision.
 
Builder for VersionProperty.
 
 
Waits until the specified number of shards is active before returning a response.
 
WaitForActiveShards variant kinds.
Waits until all currently queued events with the given priority are processed.
Waits until the specified number of nodes (N) is available.
 
WaitForNodes variant kinds.
The statistics about index warmer operations.
Builder for WarmerStats.
Preloads native library files into memory, reducing initial search latency for specified indexes.
Builder for WarmupRequest.
 
Builder for WarmupResponse.
This exception is used to indicate that one or more Response.getWarnings() exist and is typically used when the ApacheHttpClient5Transport is set to fail by passing `true` to `strictDeprecationMode`.
Called if there are warnings to determine if those warnings should fail the request.
 
 
 
 
 
 
Builder for WhitespaceAnalyzer.
 
Builder for WhitespaceTokenizer.
Gets the identity information for the user currently logged in.
 
Gets the identity information for the user currently logged in.
Builder for WhoAmIRequest.
 
Builder for WhoAmIResponse.
 
Builder for WildcardProperty.
 
Builder for WildcardQuery.
The geographical bounds specified using Well-Known Text (WKT) format.
Builder for WktGeoBounds.
 
 
 
Builder for WrapperQuery.
 
 
The base response for write operations.
 
The Cartesian coordinates specified using x and y values.
A two-dimensional Cartesian point specified by x and y coordinates.
 
XyLocation variant kinds.
Builders for XyLocation variants.
 
Builder for XyPointProperty.
 
Builder for XyShape.
 
Builder for XyShapeProperty.
 
Builder for XyShapeQuery.
 
Builder for XyShapeQueryField.