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
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ module Actions
# @option arguments [String] :default_operator The default operator for query string query (AND or OR) Server default: or.
# @option arguments [String] :df The field to use as default where no field prefix is given in the query string
# @option arguments [String, Array<String>] :docvalue_fields A comma-separated list of fields to return as the docvalue representation of a field for each hit
# @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
# @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. Server default: open.
# @option arguments [Boolean] :explain Specify whether to return detailed information about score computation as part of a hit
# @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled
# @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ module Actions
# or `:desc` as a suffix to the column name.
# @option arguments [String, Array<String>] :expand_wildcards The type of index that wildcard patterns can match.
# If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
# It supports comma-separated values, such as `open,hidden`.
# It supports comma-separated values, such as `open,hidden`. Server default: all.
# @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
# If the master node is not available before the timeout expires, the request fails and returns an error.
# To indicated that the request should never timeout, you can set it to `-1`. Server default: 30s.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ module Actions
#
# @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases used to limit the request.
# Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`.
# @option arguments [String, Array<String>] :expand_wildcards The type of index that wildcard patterns can match.
# @option arguments [String, Array<String>] :expand_wildcards The type of index that wildcard patterns can match. Server default: all.
# @option arguments [String] :health The health status used to limit returned indices. By default, the response includes indices of any health status.
# @option arguments [Boolean] :include_unloaded_segments If true, the response includes information from segments that are not loaded into memory.
# @option arguments [Boolean] :pri If true, the response only includes information from primary shards.
Expand Down
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 @@ -32,7 +32,7 @@ module Actions
# The cluster status is controlled by the worst index status.
#
# @option arguments [String, Array] :index Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (`*`) are supported. To target all data streams and indices in a cluster, omit this parameter or use _all or `*`.
# @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
# @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. Server default: all.
# @option arguments [String] :level Can be one of cluster, indices or shards. Controls the details level of the health information returned. Server default: cluster.
# @option arguments [Boolean] :local If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.
# @option arguments [Time] :master_timeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,11 @@ module Actions
# @option arguments [String, Array<String>] :metric Limit the information returned to the specified metrics
# @option arguments [String, Array] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
# @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) Server default: true.
# @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both.
# @option arguments [String, Array<String>] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. Server default: open.
# @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
# @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
# @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
# @option arguments [Time] :master_timeout Specify timeout for connection to master Server default: 30s.
# @option arguments [Time] :master_timeout Timeout for waiting for new cluster state in case it is blocked Server default: 30s.
# @option arguments [Integer] :wait_for_metadata_version Wait for the metadata version to be equal or greater than the specified metadata version
# @option arguments [Time] :wait_for_timeout The maximum time to wait for wait_for_metadata_version before timing out
# @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
# 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 @@ -27,7 +27,7 @@ module Actions
# For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline.
#
# @option arguments [String] :index_uuid The UUID of the index to delete. Use the get dangling indices API to find the UUID. (*Required*)
# @option arguments [Boolean] :accept_data_loss This parameter must be set to true to acknowledge that it will no longer be possible to recove data from the dangling index. (*Required*)
# @option arguments [Boolean] :accept_data_loss This parameter must be set to true to acknowledge that it will no longer be possible to recove data from the dangling index.
# @option arguments [Time] :master_timeout Specify timeout for connection to master Server default: 30s.
# @option arguments [Time] :timeout Explicit operation timeout
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
Expand Down
Loading