Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions elasticsearch-api/lib/elasticsearch/api/actions/cat/tasks.rb
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,9 @@ module Actions
# Get task information.
# Get information about tasks currently running in the cluster.
# IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the task management API.
# This functionality is Experimental and may be changed or removed
# completely in a future release. Elastic will take a best effort approach
# to fix any issues, but experimental features are not subject to the
# support SLA of official GA features.
# This functionality is in technical preview and may be changed or removed in a future
# release. Elastic will apply best effort to fix any issues, but features in technical
# preview are not subject to the support SLA of official GA features.
#
# @option arguments [Array<String>] :actions The task action names, which are used to limit the response.
# @option arguments [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,9 @@ module Connector
module Actions
# Check in a connector.
# Update the `last_seen` field in the connector and set it to the current timestamp.
# This functionality is Experimental and may be changed or removed
# completely in a future release. Elastic will take a best effort approach
# to fix any issues, but experimental features are not subject to the
# support SLA of official GA features.
# This functionality is in technical preview and may be changed or removed in a future
# release. Elastic will apply best effort to fix any issues, but features in technical
# preview are not subject to the support SLA of official GA features.
#
# @option arguments [String] :connector_id The unique identifier of the connector to be checked in (*Required*)
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,9 @@ module Actions
# Check in a connector sync job and set the `last_seen` field to the current time before updating it in the internal index.
# To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
# This service runs automatically on Elastic Cloud for Elastic managed connectors.
# This functionality is Experimental and may be changed or removed
# completely in a future release. Elastic will take a best effort approach
# to fix any issues, but experimental features are not subject to the
# support SLA of official GA features.
# This functionality is in technical preview and may be changed or removed in a future
# release. Elastic will apply best effort to fix any issues, but features in technical
# preview are not subject to the support SLA of official GA features.
#
# @option arguments [String] :connector_sync_job_id The unique identifier of the connector sync job to be checked in. (*Required*)
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,9 @@ module Actions
# It supports the implementation of services that utilize the connector protocol to communicate with Elasticsearch.
# To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
# This service runs automatically on Elastic Cloud for Elastic managed connectors.
# This functionality is Experimental and may be changed or removed
# completely in a future release. Elastic will take a best effort approach
# to fix any issues, but experimental features are not subject to the
# support SLA of official GA features.
# This functionality is in technical preview and may be changed or removed in a future
# release. Elastic will apply best effort to fix any issues, but features in technical
# preview are not subject to the support SLA of official GA features.
#
# @option arguments [String] :connector_sync_job_id The unique identifier of the connector sync job. (*Required*)
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,9 @@ module Actions
# Set the `error` field for a connector sync job and set its `status` to `error`.
# To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
# This service runs automatically on Elastic Cloud for Elastic managed connectors.
# This functionality is Experimental and may be changed or removed
# completely in a future release. Elastic will take a best effort approach
# to fix any issues, but experimental features are not subject to the
# support SLA of official GA features.
# This functionality is in technical preview and may be changed or removed in a future
# release. Elastic will apply best effort to fix any issues, but features in technical
# preview are not subject to the support SLA of official GA features.
#
# @option arguments [String] :connector_sync_job_id The unique identifier for the connector sync job. (*Required*)
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,9 @@ module Actions
# This API is mainly used by the connector service for updating sync job information.
# To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
# This service runs automatically on Elastic Cloud for Elastic managed connectors.
# This functionality is Experimental and may be changed or removed
# completely in a future release. Elastic will take a best effort approach
# to fix any issues, but experimental features are not subject to the
# support SLA of official GA features.
# This functionality is in technical preview and may be changed or removed in a future
# release. Elastic will apply best effort to fix any issues, but features in technical
# preview are not subject to the support SLA of official GA features.
#
# @option arguments [String] :connector_sync_job_id The unique identifier of the connector sync job. (*Required*)
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,9 @@ module Connector
module Actions
# Activate the connector draft filter.
# Activates the valid draft filtering for a connector.
# This functionality is Experimental and may be changed or removed
# completely in a future release. Elastic will take a best effort approach
# to fix any issues, but experimental features are not subject to the
# support SLA of official GA features.
# This functionality is in technical preview and may be changed or removed in a future
# release. Elastic will apply best effort to fix any issues, but features in technical
# preview are not subject to the support SLA of official GA features.
#
# @option arguments [String] :connector_id The unique identifier of the connector to be updated (*Required*)
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,9 @@ module Actions
# Set the error field for the connector.
# If the error provided in the request body is non-null, the connector’s status is updated to error.
# Otherwise, if the error is reset to null, the connector status is updated to connected.
# This functionality is Experimental and may be changed or removed
# completely in a future release. Elastic will take a best effort approach
# to fix any issues, but experimental features are not subject to the
# support SLA of official GA features.
# This functionality is in technical preview and may be changed or removed in a future
# release. Elastic will apply best effort to fix any issues, but features in technical
# preview are not subject to the support SLA of official GA features.
#
# @option arguments [String] :connector_id The unique identifier of the connector to be updated (*Required*)
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,9 @@ module Actions
# However, you can use this API to override the default behavior.
# To sync data using self-managed connectors, you need to deploy the Elastic connector service on your own infrastructure.
# This service runs automatically on Elastic Cloud for Elastic managed connectors.
# This functionality is Experimental and may be changed or removed
# completely in a future release. Elastic will take a best effort approach
# to fix any issues, but experimental features are not subject to the
# support SLA of official GA features.
# This functionality is in technical preview and may be changed or removed in a future
# release. Elastic will apply best effort to fix any issues, but features in technical
# preview are not subject to the support SLA of official GA features.
#
# @option arguments [String] :connector_id The unique identifier of the connector to be updated. (*Required*)
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,9 @@ module Connector
module Actions
# Update the connector draft filtering validation.
# Update the draft filtering validation info for a connector.
# This functionality is Experimental and may be changed or removed
# completely in a future release. Elastic will take a best effort approach
# to fix any issues, but experimental features are not subject to the
# support SLA of official GA features.
# This functionality is in technical preview and may be changed or removed in a future
# release. Elastic will apply best effort to fix any issues, but features in technical
# preview are not subject to the support SLA of official GA features.
#
# @option arguments [String] :connector_id The unique identifier of the connector to be updated (*Required*)
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,9 @@ module API
module Connector
module Actions
# Update the connector status.
# This functionality is Experimental and may be changed or removed
# completely in a future release. Elastic will take a best effort approach
# to fix any issues, but experimental features are not subject to the
# support SLA of official GA features.
# This functionality is in technical preview and may be changed or removed in a future
# release. Elastic will apply best effort to fix any issues, but features in technical
# preview are not subject to the support SLA of official GA features.
#
# @option arguments [String] :connector_id The unique identifier of the connector to be updated (*Required*)
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,9 @@ module Esql
module Actions
# Get a specific running ES|QL query information.
# Returns an object extended information about a running ES|QL query.
# This functionality is Experimental and may be changed or removed
# completely in a future release. Elastic will take a best effort approach
# to fix any issues, but experimental features are not subject to the
# support SLA of official GA features.
# This functionality is in technical preview and may be changed or removed in a future
# release. Elastic will apply best effort to fix any issues, but features in technical
# preview are not subject to the support SLA of official GA features.
#
# @option arguments [String] :id The query ID (*Required*)
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,9 @@ module Esql
module Actions
# Get running ES|QL queries information.
# Returns an object containing IDs and other information about the running ES|QL queries.
# This functionality is Experimental and may be changed or removed
# completely in a future release. Elastic will take a best effort approach
# to fix any issues, but experimental features are not subject to the
# support SLA of official GA features.
# This functionality is in technical preview and may be changed or removed in a future
# release. Elastic will apply best effort to fix any issues, but features in technical
# preview are not subject to the support SLA of official GA features.
#
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
# when they occur.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,9 @@ module Actions
# Using this API resets all features, both those that are built-in and implemented as plugins.
# To list the features that will be affected, use the get features API.
# IMPORTANT: The features installed on the node you submit this request to are the features that will be reset. Run on the master node if you have any doubts about which plugins are installed on individual nodes.
# This functionality is Experimental and may be changed or removed
# completely in a future release. Elastic will take a best effort approach
# to fix any issues, but experimental features are not subject to the
# support SLA of official GA features.
# This functionality is in technical preview and may be changed or removed in a future
# release. Elastic will apply best effort to fix any issues, but features in technical
# preview are not subject to the support SLA of official GA features.
#
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s.
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,9 @@ module Actions
# Run several Fleet searches with a single API request.
# The API follows the same structure as the multi search API.
# However, similar to the Fleet search API, it supports the `wait_for_checkpoints` parameter.
# This functionality is Experimental and may be changed or removed
# completely in a future release. Elastic will take a best effort approach
# to fix any issues, but experimental features are not subject to the
# support SLA of official GA features.
# This functionality is in technical preview and may be changed or removed in a future
# release. Elastic will apply best effort to fix any issues, but features in technical
# preview are not subject to the support SLA of official GA features.
#
# @option arguments [String] :index A single target to search. If the target is an index alias, it must resolve to a single index.
# @option arguments [Boolean] :allow_no_indices If false, the request returns an error if any wildcard expression, index alias, or _all value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,9 @@ module Actions
# Run a Fleet search.
# The purpose of the Fleet search API is to provide an API where the search will be run only
# after the provided checkpoint has been processed and is visible for searches inside of Elasticsearch.
# This functionality is Experimental and may be changed or removed
# completely in a future release. Elastic will take a best effort approach
# to fix any issues, but experimental features are not subject to the
# support SLA of official GA features.
# This functionality is in technical preview and may be changed or removed in a future
# release. Elastic will apply best effort to fix any issues, but features in technical
# preview are not subject to the support SLA of official GA features.
#
# @option arguments [String] :index A single target to search. If the target is an index alias, it must resolve to a single index. (*Required*)
# @option arguments [Boolean] :allow_no_indices [TODO]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,6 @@ module Indices
module Actions
# Cancel a migration reindex operation.
# Cancel a migration reindex attempt for a data stream or index.
# This functionality is Experimental and may be changed or removed
# completely in a future release. Elastic will take a best effort approach
# to fix any issues, but experimental features are not subject to the
# support SLA of official GA features.
#
# @option arguments [String, Array] :index The index or data stream name (*Required*)
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,6 @@ module Indices
module Actions
# Create an index from a source index.
# Copy the mappings and settings from the source index to a destination index while allowing request settings and mappings to override the source values.
# This functionality is Experimental and may be changed or removed
# completely in a future release. Elastic will take a best effort approach
# to fix any issues, but experimental features are not subject to the
# support SLA of official GA features.
#
# @option arguments [String] :source The source index or data stream name (*Required*)
# @option arguments [String] :dest The destination index or data stream name (*Required*)
Expand Down
Loading