diff --git a/.buildkite/pipeline.yml b/.buildkite/pipeline.yml index 5696edca12..d0cf267dfa 100644 --- a/.buildkite/pipeline.yml +++ b/.buildkite/pipeline.yml @@ -1,89 +1,37 @@ steps: - - label: ":yaml: YAML test suite :ruby: {{ matrix.ruby_source}}:{{ matrix.ruby }} :phone: Transport {{ matrix.transport }}" + - label: >- + :yaml: YAML test suite :ruby: {{ matrix.ruby_source}}:{{ matrix.ruby }} + :phone: Transport {{ matrix.transport }} agents: - provider: "gcp" + provider: gcp matrix: setup: ruby: - - "3.4" - - "3.3" - - "3.2" - - "3.1" + - '3.4' + - '3.3' + - '3.2' ruby_source: - - "ruby" + - ruby transport: - - "8.3" + - '8.4' adjustments: - with: # JRuby tests - ruby: "9.4" - ruby_source: "jruby" - transport: "8.3" - # Test for different versions of transport - - with: - ruby: "3.4" - ruby_source: "ruby" - transport: "main" - - with: - ruby: "3.4" - ruby_source: "ruby" - transport: "8.2" + ruby: '9.4' + ruby_source: jruby + transport: '8.4' + - with: # Test for main branch of transport + ruby: '3.4' + ruby_source: ruby + transport: main env: - RUBY_VERSION: "{{ matrix.ruby }}" - STACK_VERSION: 9.0.0-SNAPSHOT - ES_YAML_TESTS_BRANCH: main - TRANSPORT_VERSION: "{{ matrix.transport }}" - RUBY_SOURCE: "{{ matrix.ruby_source }}" - TEST_SUITE: "platinum" + RUBY_VERSION: '{{ matrix.ruby }}' + STACK_VERSION: 9.0.5-SNAPSHOT + ES_YAML_TESTS_BRANCH: '9.0' + TRANSPORT_VERSION: '{{ matrix.transport }}' + RUBY_SOURCE: '{{ matrix.ruby_source }}' + TEST_SUITE: platinum DEBUG: true command: ./.buildkite/run-yaml-tests.sh - artifact_paths: "elasticsearch-api/tmp/*" - - label: "Create :elasticsearch: Serverless projects" - key: "create-serverless" - agents: - image: docker.elastic.co/appex-qa/qaf:latest - env: - EC_PROJECT_PREFIX: ruby - EC_REGISTER_BACKEND: buildkite - EC_REGION: aws-eu-west-1 - EC_ENV: qa - commands: - - mkdir ~/.elastic - - touch ~/.elastic/cloud.json - - echo "{\"api_key\":{\"qa\":\"$(vault read -field=qa secret/ci/elastic-elasticsearch-ruby/cloud-access)\"}}" > ~/.elastic/cloud.json - - ./.buildkite/create-serverless.sh - - label: "Run :elasticsearch: Serverless :rspec: Tests :ruby:" - key: run-serverless-tests - depends_on: - - step: create-serverless - soft_fail: - - exit_status: 1 - agents: - provider: "gcp" - env: - RUBY_VERSION: "3.4" - RUBY_SOURCE: "ruby" - TEST_SUITE: serverless - ES_YAML_TESTS_BRANCH: main - QUIET: false - command: ./.buildkite/run-yaml-tests.sh - artifact_paths: "elasticsearch-api/tmp/*" - - label: "Destroy :elasticsearch: Serverless projects" - depends_on: - - step: run-serverless-tests - allow_failure: true - agents: - image: docker.elastic.co/appex-qa/qaf:latest - env: - EC_REGISTER_BACKEND: buildkite - EC_ENV: qa - EC_REGION: aws-eu-west-1 - commands: - - mkdir ~/.elastic - - touch ~/.elastic/cloud.json - - export EC_PROJECT_NAME=`buildkite-agent meta-data get "EC_PROJECT_NAME"` - - echo "{\"api_key\":{\"qa\":\"$(vault read -field=qa secret/ci/elastic-elasticsearch-ruby/cloud-access)\"}}" > ~/.elastic/cloud.json - - qaf elastic-cloud projects delete - - wait: ~ - continue_on_failure: true - - label: "Log Results" + artifact_paths: elasticsearch-api/tmp/* + - label: Log Results command: ./.buildkite/log-results.sh diff --git a/.github/make.sh b/.github/make.sh index a3ce02170d..b36c4cea5b 100755 --- a/.github/make.sh +++ b/.github/make.sh @@ -128,6 +128,7 @@ docker run \ -u "$(id -u)" \ --env "RUBY_VERSION=${RUBY_VERSION}" \ --env "WORKFLOW=${WORKFLOW}" \ + --env "CLIENTS_GITHUB_TOKEN=${CLIENTS_GITHUB_TOKEN}" \ --name test-runner \ --volume "${repo}:/usr/src/app" \ --rm \ diff --git a/.github/workflows/main.yml b/.github/workflows/9.0.yml similarity index 85% rename from .github/workflows/main.yml rename to .github/workflows/9.0.yml index c72072a437..23577f5188 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/9.0.yml @@ -1,20 +1,20 @@ -name: main +name: 9.0 on: push: branches: - - main + - 9.0 pull_request: branches: - - main + - 9.0 jobs: - test-main: + tests: env: TEST_ES_SERVER: http://localhost:9250 PORT: 9250 strategy: fail-fast: false matrix: - ruby: ['3.1', '3.2', '3.3', '3.4', 'jruby-9.3', 'jruby-9.4'] + ruby: ['3.1', '3.2', '3.3', '3.4', 'jruby-9.3', 'jruby-9.4', 'jruby-10.0'] runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 @@ -26,7 +26,7 @@ jobs: sudo sysctl -w vm.max_map_count=262144 - uses: elastic/elastic-github-actions/elasticsearch@master with: - stack-version: 9.0.0-SNAPSHOT + stack-version: 9.0.5-SNAPSHOT - uses: ruby/setup-ruby@v1 with: ruby-version: ${{ matrix.ruby }} @@ -39,4 +39,4 @@ jobs: - name: elasticsearch run: cd elasticsearch && bundle exec rake test:all - name: elasticsearch-api - run: rake es:download_artifacts[9.0.0-SNAPSHOT] && cd elasticsearch-api && bundle exec rake test:all + run: rake es:download_artifacts[9.0.5-SNAPSHOT] && cd elasticsearch-api && bundle exec rake test:all diff --git a/.github/workflows/otel.yml b/.github/workflows/otel.yml index fd17c34acb..6be79e1cd4 100644 --- a/.github/workflows/otel.yml +++ b/.github/workflows/otel.yml @@ -2,10 +2,10 @@ name: opentelemetry on: push: branches: - - main + - 9.0 pull_request: branches: - - main + - 9.0 jobs: test-otel: name: 'Test Open Telemetry' @@ -28,7 +28,7 @@ jobs: sudo sysctl -w vm.max_map_count=262144 - uses: elastic/elastic-github-actions/elasticsearch@master with: - stack-version: 9.0.0-SNAPSHOT + stack-version: 9.0.5-SNAPSHOT - uses: ruby/setup-ruby@v1 with: ruby-version: ${{ matrix.ruby }} @@ -41,4 +41,4 @@ jobs: - name: elasticsearch run: cd elasticsearch && bundle exec rake test:all - name: elasticsearch-api - run: rake es:download_artifacts[9.0.0-SNAPSHOT] && cd elasticsearch-api && bundle exec rake test:all + run: rake es:download_artifacts[9.0.5-SNAPSHOT] && cd elasticsearch-api && bundle exec rake test:all diff --git a/.gitignore b/.gitignore index eda31fc818..b6ec5bd32e 100644 --- a/.gitignore +++ b/.gitignore @@ -16,4 +16,5 @@ profile/**/data/*.json parsed_alternative_report.json .byebug_history build/ -*.gem \ No newline at end of file +*.gem +elastic-client-generator-ruby \ No newline at end of file diff --git a/CHANGELOG-9.x.md b/CHANGELOG-9.x.md deleted file mode 100644 index ef1d09842f..0000000000 --- a/CHANGELOG-9.x.md +++ /dev/null @@ -1,24 +0,0 @@ -# CHANGELOG 9.x - -## Gem - -The size of both `elasticsearch` and `elasticsearch-api` gems will be smaller, since some unnecessary files that were being included in the gem have been removed. - -The required Ruby version is set to `2.6` to keep compatiblity wit JRuby 9.3. However, we only test the code against currently supported Ruby versions. - -## Elasticsearch Serverless - -The CI build now runs tests to ensure compatibility with Elasticsearch Serverless. You can use this gem for your Serverless deployments. - -## Elasticsearch API - -### Development - -#### Testing - -The gem migrated away from the Elasticsearch REST API tests and test runner in CI. We now run the [Elasticsearch Client tests](https://github.com/elastic/elasticsearch-clients-tests/) with the [Elasticsearch Tests Runner](https://github.com/elastic/es-test-runner-ruby). This gives us more control on what we're testing and makes the Buildkite build way faster in Pull Requests and scheduled builds. - -#### Rake tasks - -* Some old rake tasks that were not being used have been removed. The rest were streamlined, the `es` namespace has been streamlined to make it easier to run Elasticsearch with Docker during development. The `docker` namespace was merged into `es`. -* Elasticsearch's REST API Spec tests can still be ran with `rake test:deprecated:rest_api` and setting the corresponding value for the environment variable `TEST_SUITE` ('platinum' or 'free'). diff --git a/CHANGELOG.md b/CHANGELOG.md index ac3416994b..9d7b1b2b49 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,778 +1,80 @@ -*See the full release notes on the official documentation website: https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/release_notes.html* +**See the full release notes on the official documentation website: https://www.elastic.co/docs/release-notes/elasticsearch/clients/ruby** -## 8.17.0 Release notes +# 9.0.5 -### Client -* Tested versions of Ruby for 8.17.0: Ruby (MRI) 3.1, 3.2 and 3.3. JRuby 9.3 and JRuby 9.4. +- Fixes [2758](https://github.com/elastic/elasticsearch-ruby/issues/2758) - `msearch`, `bulk` and other NDJSON endpoints overriding headers for `content-type` and `accept`. [Pull Request](https://github.com/elastic/elasticsearch-ruby/pull/2759) -### API +# 9.0.4 -#### API changes -* `async_search.submit` - Removes `keep_alive` parameter. Adds: - * `ccs_minimize_roundtrips` (Boolean): When doing a cross-cluster search, setting it to true may improve overall search latency, particularly when searching clusters with a large number of shards. However, when set to true, the progress of searches on the remote clusters will not be received until the search finishes on all clusters. - * `rest_total_hits_as_int` (Boolean): Indicates whether hits.total should be rendered as an integer or an object in the rest search response. -* `open_point_in_time` - Adds `allow_partial_search_results` (Boolean) parameter: Specify whether to tolerate shards missing when creating the point-in-time, or otherwise throw an exception (default: false). +- Source code documentation and code has been updated to support common parameters and common cat parameters in APIs that support it (`error_trace`, `filter_path`, `human`, `pretty`). The API reference documentation can be generated with `rake doc`. +- New API: `inference.put_custom` +# 9.0.3 -## 8.16.0 Release notes +- Adds `ccr` alias for `cross_cluster_replication` and `slm` alias for `snapshot_lifecycle_management`. +- Tested for JRuby 10.0.0. +- General updates in source code docs. -### Client -* Tested versions of Ruby for 8.16.0: Ruby (MRI) 3.1, 3.2 and 3.3. JRuby 9.3 and JRuby 9.4. +# 9.0.2 -### API +- Udpates setting 'Accept' and 'Content-Type' headers as to not duplicate or overwrite set headers [#2666](https://github.com/elastic/elasticsearch-ruby/pull/2666). -#### API changes +# 9.0.1 -* `capabilities` - Adds `local_only` boolean parameter: True if only the node being called should be considered. -* `cluster.stats`- Removes `flat_settings` parameter, adds `include_remotes` boolean parameter: Include remote cluster data into the response (default: false) -* `indices.get_data_stream` - Adds `verbose` boolean parameter: Whether the maximum timestamp for each data stream should be calculated and returned (default: false). Adds `master_timeout` (see below). -* `query_rules.delete_ruleset` - Accepts `ignore: 404` common parameter. +- The request headers were updated for Elasticsearch v9: `compatible-with=9` [#2660](https://github.com/elastic/elasticsearch-ruby/pull/2660). -##### Timeout parameters: +# 9.0.0 -These parameters have been added to several APIs: +Ruby 3.2 and up are tested and supported for 9.0. Older versions of Ruby have reached their end of life. We follow Ruby’s own maintenance policy and officially support all currently maintained versions per [Ruby Maintenance Branches](https://www.ruby-lang.org/en/downloads/branches/). The required Ruby version is set to `2.6` to keep compatiblity wit JRuby 9.3. However, we only test the code against currently supported Ruby versions. -* `master_timeout` timeout for processing on master node. -* `timeout` timeout for acknowledgement of update from all nodes in cluster parameters. +## Gem -Added in: +The size of both `elasticsearch` and `elasticsearch-api` gems is smaller than in previous versions. Some unnecessary files that were being included in the gem have now been removed. There has also been a lot of old code cleanup for the `9.x` branch. -* `indices.create_data_stream` - both. -* `indices.delete_data_stream` - `master_timeout`. -* `indices.get_data_lifecycle` - `master_timeout`. -* `indices.get_data_stream` - `master_timeout`. -* `indices.migrate_to_data_stream` - both. -* `indices.promote_data_stream` - `master_timeout`. -* `search_shards` - `master_timeout`. +## Elasticsearch Serverless -#### APIs Promoted from Experimental to Stable: +With the release of `9.0`, the [Elasticsearch Serverless](https://github.com/elastic/elasticsearch-serverless-ruby) client has been discontinued. You can use this client to build your Elasticsearch Serverless Ruby applications. The Elasticsearch Serverless API is fully supported. The CI build for Elasticsearch Ruby runs tests to ensure compatibility with Elasticsearch Serverless. -* `indices.delete_data_lifecycle` -* `indices.explain_data_lifecycle` -* `indices.get_data_lifecycle` -* `indices.put_data_lifecycle` -* `security.create_cross_cluster_api_key` -* `security.update_cross_cluster_api_key` +## Elasticsearch API -#### New APIs +* The source code is now generated from [`elasticsearch-specification`](https://github.com/elastic/elasticsearch-specification/), so the API documentation is much more detailed and extensive. The value `Elasticsearch::ES_SPECIFICATION_COMMIT` is updated with the commit hash of elasticsearch-specification in which the code is based every time it's generated. +* The API code has been updated for compatibility with Elasticsearch API v 9.0. +* `indices.get_field_mapping` - `:fields` is a required parameter. +* `knn_search` - This API has been removed. It was only ever experimental and was deprecated in v`8.4`. It isn't supported in 9.0, and only works when the header `compatible-with=8` is set. The search API should be used for all knn queries. +* The functions in `utils.rb` that had names starting with double underscore have been renamed to remove these (e.g. `__listify` to `listify`). +* **Namespaces clean up**: The API namespaces are now generated dynamically based on the elasticsearch-specification. As such, some deprecated namespace files have been removed from the codebase: + * The `rollup` namespace was removed. The rollup feature was never GA-ed, it has been deprecated since `8.11.0` in favor of downsampling. + * The `data_frame_deprecated`, `remote` namespace files have been removed, no APIs were available. + * The `shutdown` namespace was removed. It is designed for indirect use by ECE/ESS and ECK. Direct use is not supported. -* `ingest.delete_ip_location_database` - Deletes an ip location database configuration. -* `ingest.get_ip_location_database` - Returns the specified ip location database configuration. -* `ingest.put_ip_location_database` - Puts the configuration for a ip location database to be downloaded. +## Scroll APIs need to send scroll_id in request body +Sending the `scroll_id` as a parameter has been deprecated since version 7.0.0. It needs to be specified in the request body for `clear_scroll` and `scroll`. -#### New Experimental APIs +**Impact**
-* `inference.stream_inference` - Perform streaming inference. -* `query_rules.test` - Tests a query ruleset to identify the rules that would match input criteria. +Client code using `clear_scroll` or `scroll` APIs and the deprecated `scroll_id` as a parameter needs to be updated. +**Action**
-## 8.15.0 Release notes - -### Client -* Tested versions of Ruby for 8.15.0: Ruby (MRI) 3.0, 3.1, 3.2 and 3.3. JRuby 9.3 and JRuby 9.4. - -#### API changes - -* `snapshot.delete` - Adds `wait_for_completion` Boolean parameter, should this request wait until the operation has completed before returning. -* `cluster.allocation_explain` - `body` is no longer a required parameter. -* `connector.put` - (experimental API) `body` and `connector_id` no longer required parameters. -* `machine_learning.update_trained_model_deployment` has been promoted to stable from Beta. Adds Integer parameter `number_of_allocations`, updates the model deployment to this number of allocations. - -##### `master_timeout` and `timeout` parameters - -These parameters have been added to several APIs: - -* `master_timeout` timeout for processing on master node. -* `timeout` timeout for acknowledgement of update from all nodes in cluster parameters. - -The APIs: - -* `autoscaling.delete_autoscaling_policy` - both. -* `autoscaling.get_autoscaling_capacity`- `master_timeout`. -* `get_autoscaling_policy` - `master_timeout`. -* `put_autoscaling_policy` - both. -* `enrich.delete_policy` - `master_timeout`. -* `enrich.execute_policy` - `master_timeout`. -* `enrich.get_policy` - `master_timeout`. -* `enrich.put_policy` - `master_timeout`. -* `enrich.stats` - `master_timeout`. -* `features.reset_features` - `master_timeout`. -* `license.delete` - both. -* `license.post` - both. -* `license.post_start_basic` - both. -* `license.post_start_trial` - both. -* `security.get_settings` - `master_timeout`. -* `security.update_settings` - both. -* `shutdown.get_node` - `master_timeout`. -* `snapshot_lifecycle_management.start` - both. -* `snapshot_lifecycle_management.stop` - both. -* `watcher.get_settings` - `master_timeout`. -* `watcher.start` - `master_timeout`. -* `watcher.stop` - `master_timeout`. -* `watcher.update_settings` - both. - -##### Inference APIs have been renamed: - -* `inference.delete_model` => `inference.delete`. Also adds two new parameters: - * `dry_run` (Boolean), if true the endpoint will not be deleted and a list of ingest processors which reference this endpoint will be returned. - * `force` (Boolean), if true the endpoint will be forcefully stopped (regardless of whether or not it is referenced by any ingest processors or semantic text fields). -* `inference.get_model` => `inference.get` -* `inference.put_model` => `inference.put` - -##### Query Rules parameters consolidated - -Changes in `query_ruleset` and `query_rules` APIs, these have been combined into the `query_rules` namespace: - -* `query_rules.delete_ruleset` - Renamed from `query_ruleset.delete`, promoted from experimental to stable. -* `query_rules.delete_rule` - Deletes an individual query rule within a ruleset. -* `query_rules.get_rule` - Returns the details about an individual query rule within a ruleset. -* `query_rules.get_ruleset` - Renamed from `query_ruleset.get`, promoted from experimental to stable. -* `query_rules.list_rulesets` - Renamed from `query_ruleset.list`, promoted from experimental to stable. -* `query_rules.put_rule` - Creates or updates a query rule within a ruleset. -* `query_rules.put_ruleset` - Renamed from `query_ruleset.put_ruleset`, promoted from experimental to stable. - -#### New APIs: - -* `ingest.delete_geoip_database` - Deletes a geoip database configuration. -* `ingest.get_geoip_database` - Returns geoip database configuration. -* `ingest.put_geoip_database` - Puts the configuration for a geoip database to be downloaded. -* `security.bulk_delete_role` - Bulk delete roles in the native realm. -* `security.bulk_put_role` - Bulk adds and updates roles in the native realm. -* `security.query_role` - Retrieves information for Roles using a subset of query DSL. -* `transform.get_node_stats` - Retrieves transform usage information for transform nodes. - -#### New Experimental APIs: - -* `connector.sync_job_claim` - Claims a connector sync job. -* `connector.update_features` - Updates the connector features in the connector document. - -### Development - -- Added a build using [es-test-runner-ruby](https://github.com/elastic/es-test-runner-ruby) and [Elasticsearch Clients Tests](https://github.com/elastic/elasticsearch-clients-tests) which will replace the Elasticsearch YAML test runner. - -## 8.14.0 Release notes - -### Client -* Tested versions of Ruby for 8.14.0: Ruby (MRI) 3.0, 3.1, 3.2 and 3.3. JRuby 9.3 and JRuby 9.4. - -### API - -API changes: - -- All Connector APIs have been migrated to one common namespace `connector`: - - `connector_secret.delete` -> `connector.secret_delete` - - `connector_secret.get` -> `connector.secret_get` - - `connector_secret.post` -> `connector.secret_post` - - `connector_secret.put` -> `connector.secret_put` - - `connector_sync_job.cancel` -> `connector.sync_job_cancel` - - `connector_sync_job.check_in` -> `connector.sync_job_check_in` - - `connector_sync_job.delete` -> `connector.sync_job_delete` - - `connector_sync_job.error` -> `connector.sync_job_error` - - `connector_sync_job.get` -> `connector.sync_job_get` - - `connector_sync_job.post` -> `connector.sync_job_post` - - `connector_sync_job.update_stats` -> `connector.sync_job_update_stats` - -- `connector.delete` - Adds Boolean parameter `:delete_sync_jobs`: Determines whether associated sync jobs are also deleted. -- `cross_cluster_replication.delete_auto_follow_pattern`, `cross_cluster_replication.follow`, `cross_cluster_replication.follow_info`, `cross_cluster_replication.get_auto_follow_pattern`, `cross_cluster_replication.pause_auto_follow_pattern`, `cross_cluster_replication.pause_follow`, `cross_cluster_replication.put_auto_follow_pattern`, `cross_cluster_replication.resume_auto_follow_pattern`, `cross_cluster_replication.resume_follow`, `cross_cluster_replication.stats`, `cross_cluster_replication.unfollow` - Add Time parameter `:master_timeout`: Explicit operation timeout for connection to master node. -- `cross_cluster_replication.follow_stats`, `cross_cluster_replication.forget_follower`, `cross_cluster_replication.stats` - Add Time parameter `:timeout`: Explicit operation timeout. -- `indices/rollover` - Adds Boolean parameter `:target_failure` If set to true, the rollover action will be applied on the failure store of the data stream. -- `inference.get_model` - Parameter `inference_id` no longer required. -- `search_application.search` - Adds Boolean parameter `:typed_keys`: Specify whether aggregation and suggester names should be prefixed by their respective types in the response. -- `security.get_api_key`, `security.query_api_keys` - Add Boolean parameter `:with_profile_uid`: flag to also retrieve the API Key's owner profile uid, if it exists. - -New APIs: - -- `profiling.topn_functions` - Extracts a list of topN functions from Universal Profiling. -- `text_structure.find_field_structure` - Finds the structure of a text field in an index. -- `text_structure/find_message_structure`- Finds the structure of a list of messages. The messages must contain data that is suitable to be ingested into Elasticsearch. - -APIs Migrated from experimental to stable: - -- `esql.async_query` -- `esql.query` - -New Experimental APIs: - -- `connector.update_active_filtering` - Activates the draft filtering rules if they are in a validated state. -- `connector.update_filtering_validation` - Updates the validation info of the draft filtering rules. - -## 8.13.0 Release notes - -### Client -* Tested versions of Ruby for 8.13.0: Ruby (MRI) 3.0, 3.1, 3.2 and 3.3. JRuby 9.3 and JRuby 9.4. - -### Experimental ES|QL Helper - -This version provides a new experimental Helper for the ES|QL `query` API. Please check out [the documentation](https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/Helpers.html#esql-helper) and [open an issue](https://github.com/elastic/elasticsearch-ruby/issues/new/choose) if you encounter any problems or have any feedback. - -### API - -API Changes: - -* `async_search.status` - adds Time `:keep_alive` parameter: Specify the time interval in which the results (partial or final) for this search will be available. -* `bulk` - adds boolean `:require_data_stream` parameter: When true, requires the destination to be a data stream (existing or to-be-created). Default is false. -* `connector.list` - Adds the following parameters: - * `:index_name` (List): A comma-separated list of connector index names to fetch connector documents for. - * `:connector_name` (List): A comma-separated list of connector names to fetch connector documents for. - * `:service_type` (List): A comma-separated list of connector service types to fetch connector documents for. - * `:query` (String): A search string for querying connectors, filtering results by matching against connector names, descriptions, and index names. -* `esql.query` - adds boolean `:drop_null_columns` parameter: Should entirely null columns be removed from the results? Their name and type will be returning in a new `all_columns` section. -* `field_caps` - Adds `:include_empty_fields` boolean parameter: Include empty fields in result. -* `index` - adds boolean `:require_data_stream` parameter: When true, requires the destination to be a data stream (existing or to-be-created). Default is false. -* `indices.rollover` - adds boolean `:lazy` parameter: If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write. Only allowed on data streams. -* connector_sync_job.list - adds List `:job_type` parameter: A comma-separated list of job types. -* `inference.delete_model`, `inference.get_model`, `inference.inference`, `inference.put_model`: renames `:model_id` parameter to `:inference_id`. -* `termvector` will show a warning since it's been deprecated. Please use the plural version, `termvectors`. - -New APIs: - -* `indices.resolve_cluster` - Resolves the specified index expressions to return information about each cluster, including the local cluster, if included. -* `profiling.flamegraph` - Extracts a UI-optimized structure to render flamegraphs from Universal Profiling. -* `profiling.stacktraces` - Extracts raw stacktrace information from Universal Profiling. -* `security.query_user` - Retrieves information for Users using a subset of query DSL -* `text_structure.test_grok_pattern` - Tests a Grok pattern on some text. - -APIs Migrated from experimental to stable: - -* `synonyms.delete_synonym` -* `synonyms.delete_synonym_rule` -* `synonyms.get_synonym` -* `synonyms.get_synonym_rule` -* `synonyms.get_synonyms_sets` -* `synonyms.put_synonym` -* `synonyms.put_synonym_rule` - -New Experimental APIs: - -* `connector.update_api_key_id` - Updates the API key id and/or API key secret id fields in the connector document. -* `connector.update_index_name` - Updates the index name of the connector. -* `connector.update_native` - Updates the is_native flag of the connector. -* `connector.update_service_type` - Updates the service type of the connector. -* `connector.update_status` - Updates the status of the connector. -* `esql.async_query` - Executes an ESQL request asynchronously -* `esql.async_query_get` - Retrieves the results of a previously submitted async query request given its ID. - -New Experimental namespace `connector_secret`: - -* `connector_secret.delete` - Deletes a connector secret. -* `connector_secret.get` - Retrieves a secret stored by Connectors. -* `connector_secret.post` - Creates a secret for a Connector. -* `connector_secret.put` - Creates or updates a secret for a Connector. - -### Development - -* Migrated from `byebug` to `debug`. -* Added extra testing for OpenTelemetry. - -## 8.12.0 Release notes - -### Client - -* Tested versions of Ruby for 8.12.0: Ruby (MRI) 3.0, 3.1, 3.2 and 3.3. JRuby 9.3 and JRuby 9.4. - -### API - -API Changes: - -* `bulk` - Adds boolean `:list_executed_pipelines` parameter: Sets `list_executed_pipelines` for all incoming documents. Defaults to unset (false). -* `indices.put_settings` - Adds boolean `:reopen` parameter: Whether to close and reopen the index to apply non-dynamic settings. If set to `true` the indices to which the settings are being applied will be closed temporarily and then reopened in order to apply the changes. The default is `false`. -* `open_point_in_time` - Adds Hash `:body` parameter: an index_filter specified with the Query DSL. -* `security.get_api_key` - Adds boolean `:active_only` parameter: flag to limit response to only active (not invalidated or expired) API keys. - -#### New APIs - -New API for [Universal profiling](https://www.elastic.co/guide/en/observability/8.12/universal-profiling.html): - -* `profiling.status` - Returns basic information about the status of Universal Profiling. - - -New experimental API: - -* `simulate.ingest` - Simulates running ingest with example documents. See: https://www.elastic.co/guide/en/elasticsearch/reference/8.12/simulate-ingest-api.html - -##### Connectors API - -Version 8.12 introduces the experimental [Connectors API](https://www.elastic.co/guide/en/elasticsearch/reference/8.12/connector-apis.html). Use the following APIs to manage connectors: - -* `connector.post` - Creates a connector. See [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/8.12/create-connector-api.html) -* `connector.put` - Creates or updates a connector. See [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/8.12/create-connector-api.html) -* `connector.delete` - Deletes a connector. See [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/8.12/delete-connector-api.html) -* `connector.get` - Returns the details about a connector. See [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/8.12/get-connector-api.html) -* `connector.list` - Lists all connectors. See [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/8.12/list-connector-api.html) -* `connector.check_in` - Updates the last_seen timestamp in the connector document. See [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/8.12/check-in-connector-api.html) -* `connector.update_configuration` - Updates the connector configuration. See [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/8.12/update-connector-configuration-api.html) -* `connector.update_error` - Updates the error field in the connector document. See [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/8.12/update-connector-error-api.html) -* `connector.update_filtering` - Updates the filtering field in the connector document. See [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/8.12/update-connector-filtering-api.html) -* `connector.last_sync` - Updates the stats of last sync in the connector document. See [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/8.12/update-connector-last-sync-api.html) -* `connector.update_name` - Updates the name and/or description fields in the connector document. See [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/8.12/update-connector-name-description-api.html) -* `connector.update_pipeline` - Updates the pipeline field in the connector document. See [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/8.12/update-connector-pipeline-api.html) -* `connector.update_scheduling` - Updates the scheduling field in the connector document. See [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/8.12/update-connector-scheduling-api.html) - -Use the following APIs to manage sync jobs: - -* `connector_sync_job.cancel` - Cancels a connector sync job. See [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/8.12/cancel-connector-sync-job-api.html) -* `connector_sync_job.check_in` - Checks in a connector sync job (refreshes 'last_seen'). See [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/8.12/check-in-connector-sync-job-api.html) -* `connector_sync_job.delete` - Deletes a connector sync job. See [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/8.12/delete-connector-sync-job-api.html) -* `connector_sync_job.error` - Sets an error for a connector sync job. See [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/8.12/set-connector-sync-job-error-api.html) -* `connector_sync_job.get` - Returns the details about a connector sync job. See [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/8.12/get-connector-sync-job-api.html) -* `connector_sync_job.list` - Lists all connector sync jobs. See [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/8.12/list-connector-sync-jobs-api.html) -* `connector_sync_job.post` - Creates a connector sync job. See [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/8.12/create-connector-sync-job-api.html) -* `connector_sync_job.update_stats` - Updates the stats fields in the connector sync job document. See [documentation](https://www.elastic.co/guide/en/elasticsearch/reference/8.12/set-connector-sync-job-stats-api.html) - - - -## 8.11.0 Release notes - -### Client - -* Tested versions of Ruby for 8.11.0: Ruby (MRI) 3.0, 3.1 and 3.2. JRuby 9.3 and JRuby 9.4. -* Adds native support for *Open Telemetry*. See Open Telemetry for documentation. -* Improved documentation, now you can find more examples in Ruby in the [REST API reference](https://www.elastic.co/guide/en/elasticsearch/reference/8.11/rest-apis.html). - -### API - -New Experimental APIs: -- `esql.query` - Executes an ESQL request. -- `inference.delete_model` - Delete model in the Inference API. -- `inference.get_model` - Get a model in the Inference API. -- `inference.inference` - Perform inference on a model. -- `inference.put_model` - Configure a model for use in the Inference API. - -## 8.10.0 Release notes - -### Client -* Tested versions of Ruby for 8.10.0: Ruby (MRI) 3.0, 3.1 and 3.2. JRuby 9.3 and JRuby 9.4. - -### API - -#### New Experimental APIs, for internal use: -- `fleet.delete_secret` -- `fleet.get_secret` -- `fleet.post_secret` - -#### New stable APIs: -- `security.get_settings` - Retrieve settings for the security system indices -- `security.update_settings` - Update settings for the security system indices - -#### New Experimental API: -- `query_ruleset.list` List query rulesets. - -#### API Changes: -- `indices.reload_search_analyzers` - Adds parameter `resource` changed resource to reload analyzers from if applicable - -Promoted from Experimental to Beta: -- `security.create_cross_cluster_api_key` -- `security.update_cross_cluster_api_key` - -#### Synonyms namespace update: - -All synonym related APIs have been moved to the `synonyms` namespace and some of the endpoints have been renamed, as well as their parameters: -- `synonyms.delete` => `synonyms.delete_synonym` - requires `id`, the id of the synonyms set to be deleted. -- `synonyms.get` => `synonyms.get_synonym` - requires `id`, the name of the synonyms set to be retrieved. -- `synonyms_set.get_synonyms_sets` => `synonyms.get_synonyms_sets` -- `synonyms.put` => `synonyms.put_synonym` - requires `id` of the synonyms set to be created or updated. -- `synonym_rule.put` => `synonyms.put_synonym_rule` - Parameters changed to `set_id` (the id of the synonym set to be updated with the synonym rule) and `rule_id` (the id of the synonym rule to be updated or created). -- New Experimental API `synonyms.delete_synonym_rule` - Deletes a synonym rule in a synonym set -- New Experimental API `synonyms.get_synonym_rule` - Retrieves a synonym rule from a synonym set - -## 8.9.0 Release notes - -### Client - -* Tested versions of Ruby for 8.9.0: Ruby (MRI) 3.0, 3.1 and 3.2. JRuby 9.3 and JRuby 9.4. -* Updated product validation. The code for the product validation was refactored in a few ways: - * Just check header, does not check the version of the server. - * Warns only once when there's a general server error. - * Removes the call to '/' (client.info) when doing the first request, checking on the first actual request from the client. -* Fixes User-Agent code. In the migration to 8.x, the user agent code was extracted into transport, since we're now using that library in other projects. So for the Elasticsearch Client, the user-agent would be reported as the one defined in elastic-transport. This release fixes the issue and brings back the user agent in the format that was being used in 7.x - -### Helpers - -This release introduces two new Helpers in the client: - -* BulkHelper - This helper provides a better developer experience when using the Bulk API. At its simplest, you can send it a collection of hashes in an array, and it will bulk ingest them into {es}. -* ScrollHelper - This helper provides an easy way to get results from a Scroll. - -See [Helpers](https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/Helpers.html) to read more about them. - -### API - -#### New APIs - -* `cluster.info` - Returns different information about the cluster. - -#### New Experimental APIs and namespaces: - -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. - -* New namespace: `query_ruleset` - * `query_ruleset.delete` - Deletes a query ruleset. - * `query_ruleset.get` - Returns the details about a query ruleset. - * `query_ruleset.put` - Creates or updates a query ruleset. -* New API: `search_application.render_query` Renders a query for given search application search parameters. -* New API: `security.create_cross_cluster_api_key` - Creates a cross-cluster API key for API key based remote cluster access. -* New API: `security.upate_cross_cluster_api_key` - Updates attributes of an existing cross-cluster API key. -* New namespace: `synonyms` - * `synonyms.delete`- Deletes a synonym set - * `synonyms.get` - Retrieves a synonym set - * `synonyms.put` - Creates or updates a synonyms set -* New namespace: `synonym_rule` - * `synonym_rule.put` - Creates or updates a synonym rule in a synonym set -* New namespace: `synonyms` - * `synonyms_set.get` - Retrieves a summary of all defined synonym sets - -## 8.8.0 Release notes - -- Tested versions of Ruby for 8.8.0: Ruby (MRI) 3.0, 3.1 and **3.2**. JRuby 9.3 and JRuby 9.4. - -### API - -- Updates development dependency `minitest-reporters` to `>= 1.6` to include showing failures at the end of the test run. - -#### New APIs - -- `watcher.get_settings` - Retrieve settings for the watcher system index. -- `watcher.update_settings` - Update settings for the watcher system index. - -#### New Experimental APIs - -- `indices.delete_data_lifecycle`- Deletes the data lifecycle of the selected data streams -- `indices.explain_data_lifecycle` - Retrieves information about the index's current DLM lifecycle, such as any potential encountered error, time since creation etc. -- `indices.get_data_lifecycle` - Returns the data lifecycle of the selected data streams. -- `indices.put_data_lifecycle` - Updates the data lifecycle of the selected data streams. -- `search_application.delete` - Deletes a search application. -- `search_application.delete_behavioral_analytics` - Delete a behavioral analytics collection. -- `search_application.get` - Returns the details about a search application. -- `search_application.get_behavioral_analytics` - Returns the existing behavioral analytics collections. -- `search_application.list` - Returns the existing search applications. -- `search_application.post_behavioral_analytics_event` - Creates a behavioral analytics event for existing collection. -- `search_application.put` - Creates or updates a search application. -- `search_application.put_behavioral_analytics` - Creates a behavioral analytics collection. -- `search_application.search` - Perform a search against a search application. - -#### API Changes - -- `clear_scroll` now works with the argument `ignore: 404`. [Issue on GitHub](https://github.com/elastic/elasticsearch-ruby/issues/2067). -- The code generator was updated to fix a bug for `ignore: 404`. APIs that were supposed to support this wouldn't parse the parameters correctly. The support it now: `security.get_role`, `watcher.delete_watch` -- `cluster.get_component_template`, `indices.get_data_stream`, `indices.get_index_template`, `indices.simulate_index_template`, `indices.simulate_template` - Add `include_defaults` (Boolean) parameter: Return all default configurations for the component template (default: false). -- `machine_learning.put_trained_model` - Adds `wait_for_completion` (Boolean) parameter: Whether to wait for all child operations(e.g. model download) to complete, before returning or not (default: false). -- `machine_learning.start_trained_model_deployment` - Adds `deployiment_id` (String) parameter: The Id of the new deployment. Defaults to the model_id if not set. -- `search` - Adds `include_named_queries_score` (Boolean) parameter: Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false). -- `transform.delete_transform` - Adds `delete_dest_index` (Boolean) parameter: When `true`, the destination index is deleted together with the transform. The default value is `false`, meaning that the destination index will not be deleted. - -## 8.7.1 Release notes - -### API Bugfix - -- Updates `logstash.get_pipeline`, fixed in the specification `id` is not a required parameter, so removes raising `ArgumentError` when id is not present. - -## 8.7.0 Release notes - -- Tested versions of Ruby for 8.7.0: Ruby (MRI) 2.7, 3.0, 3.1 and **3.2**. JRuby 9.3 and JRuby 9.4. Ruby 2.7's end of life is coming in a few days, so this'll probably be the last release to test for Ruby 2.7. - -### New APIs - -- `health_report` - Returns the health of the cluster. -- `transform.schedule_now_transform` - Schedules now a transform. - -### API Changes - -- `transform.get_transform_stats` - Adds `timeout` (Time) parameter. Controls the time to wait for the stats. -- `transform.start_transform` - Adds `from` (String) parameter. Restricts the set of transformed entities to those changed after this time. -- `ml.delete_job`, `ml.reset_job` - Add `delete_user_annotations` (Boolean) parameter. Should annotations added by the user be deleted. -- `ml.clear_trained_model_deployment_cache`, `ml.infer_trained_model`, `ml.put_trained_model_definition_part`, `ml.put_trained_model_vocabulary`, `ml.start_trained_model_deployment`, `ml.stop_trained_model_deployment` - These APIs are no longer in Beta. - -## 8.6.0 Release notes - -- Tested versions of Ruby for 8.6.0: Ruby (MRI) 2.7, 3.0, 3.1 and **3.2**. JRuby 9.3 and **JRuby 9.4**. - -### New APIs - -- `update_trained_model_deployment` - Updates certain properties of trained model deployment (This functionality is in Beta and is subject to change). - -### API Changes - -- `cluster.reroute` - `:metric` parameter adds `none` as an option. -- `ml.start_trained_model_deployment` - New parameter `:priority` (String), the deployment priority - - -## 8.5.2 Release notes - -### API Bugfix - -Fixes `security.create_service_token` API, uses `POST` when token name isn't present. -Thanks [@carlosdelest](https://github.com/carlosdelest) for reporting in [#1961](https://github.com/elastic/elasticsearch-ruby/pull/1961). - -## 8.5.1 Release notes - -### Bugfix - -Fixes bug when instantiating client with `api_key`: When passing in `api_key` and `transport_options` that don't include headers to the client, the `api_key` code would overwrite the arguments passed in for `transport_options`. This was fixed in [this Pull Request](https://github.com/elastic/elasticsearch-ruby/pull/1941/files). -Thanks [svdasein](https://github.com/svdasein) for reporting in [#1940](https://github.com/elastic/elasticsearch-ruby/issues/1940). - -## 8.5.0 Release notes - -- Tested versions of Ruby for 8.5.0: Ruby (MRI) 2.7, 3.0 and 3.1, JRuby 9.3. - -### Client - -With the latest release of `elastic-transport` - `v8.1.0` - this gem now supports Faraday v2. Elasticsearch Ruby has an open dependency on `elastic-transport` (`'elastic-transport', '~> 8'`), so when you upgrade your gems, `8.1.0` will be installed. This supports both Faraday v1 and Faraday v2. The main change on dependencies when using Faraday v2 is all adapters, except for the default `net_http` one, have been moved out of Faraday into separate gems. This means if you're not using the default adapter and you migrate to Faraday v2, you'll need to add the adapter gems to your Gemfile. - -These are the gems required for the different adapters with Faraday 2, instead of the libraries on which they were based: -``` -# HTTPCLient -gem 'faraday-httpclient' - -# NetHTTPPersistent -gem 'faraday-net_http_persistent' - -# Patron -gem 'faraday-patron' - -# Typhoeus -gem 'faraday-typhoeus' +If you are using the `clear_scroll` or `scroll` APIs, and sending the `scroll_id` as a parameter, you need to update your code to send the `scroll_id` as part of the request body: +```ruby +# Before: +client.clear_scroll(scroll_id: scroll_id) +# Now: +client.clear_scroll(body: { scroll_id: scroll_id }) + +# Before: +client.scroll(scroll_id: scroll_id) +# Now: +client.scroll(body: { scroll_id: scroll_id }) ``` -Things should work fine if you migrate to Faraday 2 as long as you include the adapter (unless you're using the default one `net-http`), but worst case scenario, you can always lock the version of Faraday in your project to 1.x: -`gem 'faraday', '~> 1'` - -Be aware if migrating to Faraday v2 that it requires at least Ruby `2.6`, unlike Faraday v1 which requires `2.4`. - -*Troubleshooting* - -If you see a message like: -`:adapter is not registered on Faraday::Adapter (Faraday::Error)` -Then you probably need to include the adapter library in your gemfile and require it. - -Please [submit an issue](https://github.com/elastic/elasticsearch-ruby/issues) if you encounter any problems. - -### API - -#### New APIs - -- `machine_learning.clear_trained_model_deployment_cache` - Clear the cached results from a trained model deployment (Beta). -- `security.bulk_update_api_keys` - Updates the attributes of multiple existing API keys. - -#### API Changes - -- `rollup.rollup` renamed to `indices.downsample`. The method now receives the `index` to downsample (Required) and instead of `rollup_index`, use target_index as the index to store downsampled data. - -- `security.get_api_key` and `security.query_api_keys` add `:with_limited_by` flag to show the limited-by role descriptors of API Keys. -- `security.get_user` adds `:with_profile_uid` flag to retrieve profile uid (if exists) associated to the user. -- `security.get_user_profile` now retrieves user profiles for given unique ID(s). `:uid` is now a list of comma-separated list of unique identifier for user profiles. -- `text_structure.find_structure` adds `:ecs_compatibility`, optional parameter to specify the compatibility mode with ECS Grok patterns - may be either 'v1' or 'disabled'. - -Machine learning APIs promoted from *Experimental* to *Beta*: - -- `machine_learning.clear_trained_model_deployment_cache.rb` -- `machine_learning.infer_trained_model.rb` -- `machine_learning.put_trained_model_definition_part.rb` -- `machine_learning.put_trained_model_vocabulary.rb` -- `machine_learning.start_trained_model_deployment.rb` -- `machine_learning.stop_trained_model_deployment.rb` - -Security usef profile APIs promoted from *Experimental* to *Stable*: - -- `security/activate_user_profile` -- `security/disable_user_profile` -- `security/enable_user_profile` -- `security/get_user_profile` -- `security/has_privileges_user_profile` -- `security/suggest_user_profile` -- `security/update_user_profile_data` - - -## 8.4.0 Release Notes - -- Tested versions of Ruby for 8.4.0: Ruby (MRI) 2.7, 3.0 and 3.1, JRuby 9.3. - -### API - -#### New APIs - -* `security.update_api_key` - Updates attributes of an existing API key. [Documentation](https://www.elastic.co/guide/en/elasticsearch/reference/8.4/security-api-update-api-key.html). - -#### API Changes +## Testing -* `get` - Adds new parameter `force_synthetic_source` (Boolean) Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index. -* `machine_learning.start_trained_model_deployment` - Adds new parameter `cache_size` (String) A byte-size value for configuring the inference cache size. For example, 20mb. -* `mget` - Adds new parameter `force_synthetic_source` (Boolean) Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index. -* `search` - Adds new parameter `force_synthetic_source` (Boolean) Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index. -* `snapshot.get` - Adds new parameters: - * `sort` (String) Allows setting a sort order for the result. Defaults to start_time (options: start_time, duration, name, repository, index_count, shard_count, failed_shard_count). - * `size` (Integer) Maximum number of snapshots to return. Defaults to 0 which means return all that match without limit. - * `order` (String) Sort order (options: asc, desc). - * `from_sort_value` (String) Value of the current sort column at which to start retrieval. - * `after` (String) Offset identifier to start pagination from as returned by the 'next' field in the response body. - * `offset` (Integer) Numeric offset to start pagination based on the snapshots matching the request. Defaults to 0. - * `slm_policy_filter` (String) Filter snapshots by a comma-separated list of SLM policy names that snapshots belong to. Accepts wildcards. Use the special pattern '_none' to match snapshots without an SLM policy. +The gem `elasticsearch-api` migrated away from the Elasticsearch REST API tests and test runner in CI. We now run the [Elasticsearch Client tests](https://github.com/elastic/elasticsearch-clients-tests/) with the [Elasticsearch Tests Runner](https://github.com/elastic/es-test-runner-ruby). This gives us more control on what we're testing and makes the Buildkite build way faster in Pull Requests and scheduled builds. -## 8.3.0 Release Notes - -- Tested versions of Ruby for 8.3.0: Ruby (MRI) 2.7, 3.0 and 3.1, JRuby 9.3. - -### API - -- Added build hash to auto generated code. The code generator obtains the git hash from the Elasticsearch specification and adds it as a comment in the code. This allows us to track the version for each generated class. -- Updated for compatibility with Elasticsearch 8.3's API. - -#### API Changes - -* `cluster.delete_voting_config_exclusions`, `cluster.post_voting_config_exclusions` - Add new parameter `master_timeout` (Time) Timeout for submitting request to master. -* `machine_learning.infer_trained_model_deployment` is renamed to `machine_learning.infer_trained_model`. The url `/_ml/trained_models/{model_id}/deployment/_infer` is deprecated since 8.3, use `/_ml/trained_models/{model_id}/_infer` instead. -* `machine_learning.preview_datafeed` - Adds new parameters: - * `start` (String) The start time from where the datafeed preview should begin - * `end` (String) The end time when the datafeed preview should stop -* `machine_learning.start_trained_model_deployment` - Adds new parameters: - * `number_of_allocations` (Integer) The number of model allocations on each node where the model is deployed. - * `threads_per_allocation` (Integer) The number of threads used by each model allocation during inference. - * `queue_capacity` (Integer) Controls how many inference requests are allowed in the queue at a time. -* `search_mvt` - Adds new parameter: `with_labels` (Boolean) If true, the hits and aggs layers will contain additional point features with suggested label positions for the original features -* `snapshot.get` - Adds new parameter: `index_names` (Boolean) Whether to include the name of each index in the snapshot. Defaults to true. - -#### New Experimental APIs -* `security.has_privileges_user_profile` Determines whether the users associated with the specified profile IDs have all the requested privileges - -## 8.2.2 Release notes - -- Updates dependency on `elastic-transport` to `~> 8.0` - -## 8.2.1 Release notes - -No release, no changes on the client. - -## 8.2.0 - -- Tested versions of Ruby for 8.2.0: Ruby (MRI) 2.7, 3.0 and 3.1, JRuby 9.3. - -### API - -Updated for compatibility with Elasticsearch 8.2's API. - -#### New parameters: - -* `field_caps` - - `filters` An optional set of filters: can include +metadata,-metadata,-nested,-multifield,-parent - - `types` Only return results for fields that have one of the types in the list - -#### New APIs: - -- `cat.component_templates` - Returns information about existing component_templates templates. -- `ml.get_memory_stats` - Returns information on how ML is using memory. - -#### New Experimental APIs: - -- `security.activate_user_profile` - Creates or updates the user profile on behalf of another user. -- `security.disable_user_profile` - Disables a user profile so it's not visible in user profile searches. -- `security.enable_user_profile` - Enables a user profile so it's visible in user profile searches. -- `security.get_user_profile` - Retrieves a user profile for the given unique ID. -- `security.suggest_user_profiles` - Get suggestions for user profiles that match specified search criteria. -- `security.update_user_profile_data` - Update application specific data for the user profile of the given unique ID. - -## 8.1.2, 8.0.1 - -### API - -- Fixes an issue with the generated API code. When updating the code generator for 8.x, the order of `arguments.clone` in the generated code was changed. This would make it so that we would modify the parameters passed in before cloning them, which is undesired. Issue: [#1727](https://github.com/elastic/elasticsearch-ruby/issues/1727). - -## 8.1.1 - -No release, no changes on the client. - -## 8.1.0 - -- Tested versions of Ruby for 8.1.0: Ruby (MRI) 2.6, 2.7, 3.0 and 3.1, JRuby 9.3. - -### API - -Updated for compatibility with Elasticsearch 8.1's API. - -#### New parameters: -- `indices.forcemerge` - `wait_for_completion` Should the request wait until the force merge is completed. -- `indices.get` - `features` Return only information on specified index features (options: aliases, mappings, settings). -- `ingest.put_pipeline` `if_version` (Integer), required version for optimistic concurrency control for pipeline updates. -- `ml.delete_trained_model` - `timeout` controls the amount of time to wait for the model to be deleted. `force` (Boolean) true if the model should be forcefully deleted. -- `ml.stop_trained_model_deployment` - `allow_no_match` whether to ignore if a wildcard expression matches no deployments. (This includes `_all` string or when no deployments have been specified). `force` true if the deployment should be forcefully stopped. Adds `body` parameter, the stop deployment parameters. -- `nodes.hot_threads` - `sort` the sort order for 'cpu' type (default: total) (options: cpu, total) - -#### Updated parameters: -- `indices.get_index_template` - `name` is now a String, a pattern that returned template names must match. -- `knn_search` - `index` removes option to use empty string to perform the operation on all indices. -- `ml.close_job`, `ml.get_job_stats`, `ml.get_jobs`, `ml.get_overall_buckets` - Remove `allow_no_jobs` parameter. -- `ml.get_datafeed_stats`, `ml.get_datafeeds` - Remove `allow_no_datafeeds` parameter. -- `nodes.hot_threads` - `type` parameter adds `mem` option. -- `nodes.info` - `metric` updated to use `_all` to retrieve all metrics and `_none` to retrieve the node identity without any additional metrics. (options: settings, os, process, jvm, thread_pool, transport, http, plugins, ingest, indices, aggregations, _all, _none). `index_metric` option `shards` changes to `shard_stats`. -- `open_point_in_time` - `keep_alive` is now a required parameter. -- `search_mvt` - `grid_type` parameter adds `centroid` option in addition to `grid` and `point`. - -- New experimental APIs, designed for internal use by the fleet server project: `fleet.search`, `fleet.msearch`. - -#### New APIs -- OpenID Connect Authentication: `security.oidc_authenticate`, `security.oidc_logout`, `security.oidc_prepare_authentication`. -- `transform.reset_transform`. - - -## 8.0.0 - -First release for the `8.x` branch with a few major changes. - -- Tested versions of Ruby for 8.0.0: Ruby (MRI) 2.6, 2.7, 3.0 and 3.1, JRuby 9.3. - -### Client - -#### Elastic Transport - -The code for the dependency `elasticsearch-transport` has been promoted to [its own repository](https://github.com/elastic/elastic-transport-ruby/) and the project and gem have been renamed to [`elastic-transport`](https://rubygems.org/gems/elastic-transport). This gem now powers [`elasticsearch`](https://rubygems.org/gems/elasticsearch) and [`elastic-enterprise-search`](https://rubygems.org/gems/elastic-enterprise-search). The `elasticsearch-transport` gem won't be maintained after the last release in the `7.x` branch, in favour of `elastic-transport`. - -This will allow us to better address maintainance in both clients and the library itself. - -### API - -The `elasticsearch-api` library has been generated based on the Elasticsearch 8.0.0 REST specification. - -#### X-Pack Deprecation - -X-Pack has been deprecated. The `elasticsearch-xpack` gem will no longer be maintained after the last release in the `7.x` branch. The "X-Pack" integration library codebase was merged into `elasticsearch-api`. All the functionality is available from `elasticsearch-api`. The `xpack` namespace was removed for accessing any APIs other than `_xpack` (`client.xpack.info`) and `_xpack/usage` (`client.xpack.usage`). But APIs which were previously available through the `xpack` namespace e.g.: `client.xpack.machine_learning` are now only available directly: `client.machine_learning`. - -#### Parameter checking was removed - -The code in `elasticsearch-api` will no longer validate all the parameters sent. It will only validate the required parameters such as those needed to build the path for the request. But other API parameters are going to be validated by Elasticsearch. This provides better forwards and backwards compatibility in the client. - -#### Response object - -In previous versions of the client, calling an API endpoint would return the JSON body of the response. With `8.0`, we are returning a new Response object `Elasticsearch::API::Response`. It still behaves like a Hash to maintain backwards compatibility, but adds the `status` and `headers` methods from the `Elastic::Transport:Transport::Response` object: - -```ruby -elastic_ruby(main)> response = client.info -=> #"instance", - "cluster_name"=>"elasticsearch-8-0-0-SNAPSHOT-rest-test", - "cluster_uuid"=>"oIfRARuYRGuVYybjxQJ87w", - "version"=> - {"number"=>"8.0.0-SNAPSHOT", - "build_flavor"=>"default", - "build_type"=>"docker", - "build_hash"=>"7e23c54eb31cc101d1a4811b9ab9c4fd33ed6a8d", - "build_date"=>"2021-11-04T00:21:32.464485627Z", - "build_snapshot"=>true, - "lucene_version"=>"9.0.0", - "minimum_wire_compatibility_version"=>"7.16.0", - "minimum_index_compatibility_version"=>"7.0.0"}, - "tagline"=>"You Know, for Search"}, - @headers={"X-elastic-product"=>"Elasticsearch", "content-type"=>"application/json", "content-length"=>"567"}, - @status=200>> -elastic_ruby(main)> response.status -=> 200 -elastic_ruby(main)> response.headers -=> {"X-elastic-product"=>"Elasticsearch", "content-type"=>"application/json", "content-length"=>"567"} -elastic_ruby(main)> response['name'] -=> "instance" -elastic_ruby(main)> response['tagline'] -=> "You Know, for Search" -``` +## Fixes -Please [let us know if you find any issues](https://github.com/elastic/elasticsearch-ruby/issues). +* Some old rake tasks that were not being used have been removed. The rest were streamlined, the `es` namespace has been streamlined to make it easier to run Elasticsearch with Docker during development. The `docker` task namespace was merged into `es`. +* Elasticsearch's REST API Spec tests can still be ran with `rake test:deprecated:rest_api` and setting the corresponding value for the environment variable `TEST_SUITE` ('platinum' or 'free'). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4c7bbf1cc6..aeaa7b0b62 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -16,12 +16,12 @@ This will run `bundle install` in all subprojects. You can run the client code right away in a Interactive Ruby Shell by running the following command from the project's root directory: ``` -$ ./elasticsearch/bin/elastic_ruby_console +$ rake console # calls ./elasticsearch/bin/elastic_ruby_console [1] elastic_ruby(main)> client = Elasticsearch::Client.new(host: 'http://elastic:changeme@localhost:9200/', log: true) [2] elastic_ruby(main)> client.info ``` -This will use either `irb` or `pry` and load the `elasticsearch` and `elasticsearch-api` gems into the shell. +This will use either `irb` or `pry` and load the `elasticsearch` and `elasticsearch-api` gems into the shell. # Tests @@ -31,8 +31,8 @@ To run the tests, you need to start a testing cluster on port 9200. We suggest u rake docker:start[VERSION] ``` -E.g.: `rake docker:start[8.0-SNAPSHOT]`. -To start the container with Platinum, pass it in as a parameter: `rake docker:start[7.x-SNAPSHOT,platinum]`. +E.g.: `rake docker:start[9.0.0-SNAPSHOT]`. +To start the container with Platinum, pass it in as a parameter: `rake docker:start[8.x-SNAPSHOT,platinum]`. There's another rake task that will read the STACK_VERSION value from `.buildkite/pipeline.yml` and run that version of Elasticsearch: `rake es:up`. @@ -42,6 +42,12 @@ max virtual memory areas vm.max_map_count [65530] likely too low, increase to at ``` Check [this link](https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html#_set_vm_max_map_count_to_at_least_262144) for instructions on how to fix it. +You can also use [start-local](https://github.com/elastic/start-local), which can run Elasticsearch and Kibana locally for development/testing. You only need to run Elasticsearch (`-esonly`) for development purposes, and you can specify a version with the `-v` parameter: + +```bash +curl -fsSL https://elastic.co/start-local | sh -s -- -esonly -v 9.0.0 +``` + As mentioned, the tests will atempt to run against `http://localhost:9200` by default. We provide the Docker task for the test cluster and recommend using it. But you can provide a different test server of your own. If you're using a different host or port, set the `TEST_ES_SERVER` environment variable with the server information. E.g.: ``` @@ -51,12 +57,20 @@ $ TEST_ES_SERVER='http://localhost:9250/' be rake test:client To run all the tests in all the subprojects, use the Rake task: ``` -time rake test:client +rake test:client ``` -# Elasticsearch Rest API YAML Test Runner +# Elasticsearch Rest API Tests + +The integration tests on this project run the [Elasticsearch Client tests](https://github.com/elastic/elasticsearch-clients-tests/) with the [Elasticsearch Tests Runner](https://github.com/elastic/es-test-runner-ruby/) library. This runs in CI against an Elasticsearch cluster in Docker. The [Elasticsearch's REST API Spec tests](https://github.com/elastic/elasticsearch/tree/main/rest-api-spec/src/main/resources/rest-api-spec/test#test-suite) can still be ran following [these instructions](https://github.com/elastic/elasticsearch-ruby/tree/main/elasticsearch-api/api-spec-testing#readme). + +You can run the yaml API tests with: + +``` +rake test:yaml +``` -See the API Spec tests [README](https://github.com/elastic/elasticsearch-ruby/tree/main/elasticsearch-api/api-spec-testing#readme). +Check `rake -T` for more test tasks. # Contributing diff --git a/Gemfile b/Gemfile index c618282910..a2263210df 100644 --- a/Gemfile +++ b/Gemfile @@ -38,5 +38,5 @@ end group :development, :test do gem 'debug' unless defined?(JRUBY_VERSION) gem 'rspec' - gem 'rubocop', '>= 1.51' unless defined?(JRUBY_VERSION) && Gem::Version.new(JRUBY_VERSION) <= Gem::Version.new('9.4') + gem 'rubocop', '>= 1.51' unless defined?(JRUBY_VERSION) end diff --git a/README.md b/README.md index 8e87f0340e..939ecf6e0a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # Elasticsearch -[![7.17](https://github.com/elastic/elasticsearch-ruby/actions/workflows/7.17.yml/badge.svg?branch=7.17)](https://github.com/elastic/elasticsearch-ruby/actions/workflows/7.17.yml) [![8.16](https://github.com/elastic/elasticsearch-ruby/actions/workflows/8.16.yml/badge.svg?branch=8.16)](https://github.com/elastic/elasticsearch-ruby/actions/workflows/8.16.yml) [![8.17](https://github.com/elastic/elasticsearch-ruby/actions/workflows/8.17.yml/badge.svg?branch=8.17)](https://github.com/elastic/elasticsearch-ruby/actions/workflows/8.17.yml) [![main](https://github.com/elastic/elasticsearch-ruby/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/elastic/elasticsearch-ruby/actions/workflows/main.yml) [![Build status](https://badge.buildkite.com/e50e66eb71bf6566a6479c8a29b25458f6781ee8e52cee8d96.svg)](https://buildkite.com/elastic/elasticsearch-ruby) +[![8.17](https://github.com/elastic/elasticsearch-ruby/actions/workflows/8.17.yml/badge.svg?branch=8.17)](https://github.com/elastic/elasticsearch-ruby/actions/workflows/8.17.yml) [![8.18](https://github.com/elastic/elasticsearch-ruby/actions/workflows/8.18.yml/badge.svg?branch=8.18)](https://github.com/elastic/elasticsearch-ruby/actions/workflows/8.18.yml) [![9.0](https://github.com/elastic/elasticsearch-ruby/actions/workflows/9.0.yml/badge.svg?branch=9.0)](https://github.com/elastic/elasticsearch-ruby/actions/workflows/9.0.yml) [![main](https://github.com/elastic/elasticsearch-ruby/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/elastic/elasticsearch-ruby/actions/workflows/main.yml) [![Build status](https://badge.buildkite.com/e50e66eb71bf6566a6479c8a29b25458f6781ee8e52cee8d96.svg)](https://buildkite.com/elastic/elasticsearch-ruby) **[Download the latest version of Elasticsearch](https://www.elastic.co/downloads/elasticsearch)** or @@ -79,8 +79,8 @@ Elasticsearch language clients are only backwards compatible with default distri | Gem Version | | Elasticsearch Version | Supported | |-------------|---|------------------------|-----------| -| 7.x | → | 7.x | 7.17 | | 8.x | → | 8.x | 8.x | +| 9.x | → | 9.x | 9.x | | main | → | main | | ## Try Elasticsearch and Kibana locally diff --git a/docs/basic-config.asciidoc b/docs/basic-config.asciidoc deleted file mode 100644 index d0edd7ec76..0000000000 --- a/docs/basic-config.asciidoc +++ /dev/null @@ -1,37 +0,0 @@ -[[basic-config]] -=== Basic configuration - -The table below contains the most important initialization parameters that you -can use. - - -[cols="<,<,<"] -|=== - -| **Parameter** | **Data type** | **Description** -| `adapter` | Symbol | A specific adapter for Faraday (for example, `:patron`). -| `api_key` | String, Hash | For API key Authentication. Either the base64 encoding of `id` and `api_key` joined by a colon as a string, or a hash with the `id` and `api_key` values. -| `compression` | Boolean | Whether to compress requests. Gzip compression is used. Defaults to `false`. Responses are automatically inflated if they are compressed. If a custom transport object is used, it must handle the request compression and response inflation. -| `enable_meta_header` | Boolean | Whether to enable sending the meta data header to Cloud. Defaults to `true`. -| `hosts` | String, Array | Single host passed as a string or hash, or multiple hosts passed as an array; `host` or `url` keys are also valid. -| `log` | Boolean | Whether to use the default logger. Disabled by default. -| `logger` | Object | An instance of a Logger-compatible object. -| `opaque_id_prefix` | String | Sets a prefix for X-Opaque-Id when initializing the client. This is prepended to the id you set before each request if you're using X-Opaque-Id. -| `opentelemetry_tracer_provider` | `OpenTelemetry::Trace::TracerProvider` | An explicit TracerProvider to use instead of the global one with OpenTelemetry. This enables better dependency injection and simplifies testing. -| `randomize_hosts` | Boolean | Whether to shuffle connections on initialization and reload. Defaults to `false`. -| `reload_connections` | Boolean, Number | Whether to reload connections after X requests. Defaults to `false`. -| `reload_on_failure` | Boolean | Whether to reload connections after failure. Defaults to `false`. -| `request_timeout` | Integer | The request timeout to be passed to transport in options. -| `resurrect_after` | Integer | Specifies after how many seconds a dead connection should be tried again. -| `retry_on_failure` | Boolean, Number | Whether to retry X times when request fails before raising and exception. Defaults to `false`. -| `retry_on_status` | Array, Number | Specifies which status code needs to be returned to retry. -| `selector` | Constant | An instance of selector strategy implemented with {Elastic::Transport::Transport::Connections::Selector::Base}. -| `send_get_body_as` | String | Specifies the HTTP method to use for GET requests with a body. Defaults to `GET`. -| `serializer_class` | Constant | Specifies a serializer class to use. It is initialized by the transport and passed the transport instance. -| `sniffer_timeout` | Integer | Specifies the timeout for reloading connections in seconds. Defaults to `1`. -| `trace` | Boolean | Whether to use the default tracer. Disabled by default. -| `tracer` | Object | Specifies an instance of a Logger-compatible object. -| `transport` | Object | Specifies a transport instance. -| `transport_class` | Constant | Specifies a transport class to use. It is initialized by the client and passed hosts and all arguments. -| `transport_options` | Hash | Specifies the options to be passed to the `Faraday::Connection` constructor. -|=== diff --git a/docs/config.asciidoc b/docs/config.asciidoc deleted file mode 100644 index c9897f8313..0000000000 --- a/docs/config.asciidoc +++ /dev/null @@ -1,9 +0,0 @@ -[[ruby-config]] -== Configuration - -This page contains information about how to configure the Ruby client tailored -to your needs. Almost every aspect of the client is configurable. However, in -most cases you only need to set a couple of parameters. - -* <> -* <> \ No newline at end of file diff --git a/docs/docset.yml b/docs/docset.yml new file mode 100644 index 0000000000..fb1b1471b7 --- /dev/null +++ b/docs/docset.yml @@ -0,0 +1,490 @@ +project: 'Ruby client' +exclude: + - examples/** +cross_links: + - docs-content + - ecs + - ecs-logging-ruby +toc: + - toc: reference + - toc: release-notes +subs: + ref: "https://www.elastic.co/guide/en/elasticsearch/reference/current" + ref-bare: "https://www.elastic.co/guide/en/elasticsearch/reference" + ref-8x: "https://www.elastic.co/guide/en/elasticsearch/reference/8.1" + ref-80: "https://www.elastic.co/guide/en/elasticsearch/reference/8.0" + ref-7x: "https://www.elastic.co/guide/en/elasticsearch/reference/7.17" + ref-70: "https://www.elastic.co/guide/en/elasticsearch/reference/7.0" + ref-60: "https://www.elastic.co/guide/en/elasticsearch/reference/6.0" + ref-64: "https://www.elastic.co/guide/en/elasticsearch/reference/6.4" + xpack-ref: "https://www.elastic.co/guide/en/x-pack/6.2" + logstash-ref: "https://www.elastic.co/guide/en/logstash/current" + kibana-ref: "https://www.elastic.co/guide/en/kibana/current" + kibana-ref-all: "https://www.elastic.co/guide/en/kibana" + beats-ref-root: "https://www.elastic.co/guide/en/beats" + beats-ref: "https://www.elastic.co/guide/en/beats/libbeat/current" + beats-ref-60: "https://www.elastic.co/guide/en/beats/libbeat/6.0" + beats-ref-63: "https://www.elastic.co/guide/en/beats/libbeat/6.3" + beats-devguide: "https://www.elastic.co/guide/en/beats/devguide/current" + auditbeat-ref: "https://www.elastic.co/guide/en/beats/auditbeat/current" + packetbeat-ref: "https://www.elastic.co/guide/en/beats/packetbeat/current" + metricbeat-ref: "https://www.elastic.co/guide/en/beats/metricbeat/current" + filebeat-ref: "https://www.elastic.co/guide/en/beats/filebeat/current" + functionbeat-ref: "https://www.elastic.co/guide/en/beats/functionbeat/current" + winlogbeat-ref: "https://www.elastic.co/guide/en/beats/winlogbeat/current" + heartbeat-ref: "https://www.elastic.co/guide/en/beats/heartbeat/current" + journalbeat-ref: "https://www.elastic.co/guide/en/beats/journalbeat/current" + ingest-guide: "https://www.elastic.co/guide/en/ingest/current" + fleet-guide: "https://www.elastic.co/guide/en/fleet/current" + apm-guide-ref: "https://www.elastic.co/guide/en/apm/guide/current" + apm-guide-7x: "https://www.elastic.co/guide/en/apm/guide/7.17" + apm-app-ref: "https://www.elastic.co/guide/en/kibana/current" + apm-agents-ref: "https://www.elastic.co/guide/en/apm/agent" + apm-android-ref: "https://www.elastic.co/guide/en/apm/agent/android/current" + apm-py-ref: "https://www.elastic.co/guide/en/apm/agent/python/current" + apm-py-ref-3x: "https://www.elastic.co/guide/en/apm/agent/python/3.x" + apm-node-ref-index: "https://www.elastic.co/guide/en/apm/agent/nodejs" + apm-node-ref: "https://www.elastic.co/guide/en/apm/agent/nodejs/current" + apm-node-ref-1x: "https://www.elastic.co/guide/en/apm/agent/nodejs/1.x" + apm-rum-ref: "https://www.elastic.co/guide/en/apm/agent/rum-js/current" + apm-ruby-ref: "https://www.elastic.co/guide/en/apm/agent/ruby/current" + apm-java-ref: "https://www.elastic.co/guide/en/apm/agent/java/current" + apm-go-ref: "https://www.elastic.co/guide/en/apm/agent/go/current" + apm-dotnet-ref: "https://www.elastic.co/guide/en/apm/agent/dotnet/current" + apm-php-ref: "https://www.elastic.co/guide/en/apm/agent/php/current" + apm-ios-ref: "https://www.elastic.co/guide/en/apm/agent/swift/current" + apm-lambda-ref: "https://www.elastic.co/guide/en/apm/lambda/current" + apm-attacher-ref: "https://www.elastic.co/guide/en/apm/attacher/current" + docker-logging-ref: "https://www.elastic.co/guide/en/beats/loggingplugin/current" + esf-ref: "https://www.elastic.co/guide/en/esf/current" + kinesis-firehose-ref: "https://www.elastic.co/guide/en/kinesis/%7B%7Bkinesis_version%7D%7D" + estc-welcome-current: "https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current" + estc-welcome: "https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current" + estc-welcome-all: "https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions" + hadoop-ref: "https://www.elastic.co/guide/en/elasticsearch/hadoop/current" + stack-ref: "https://www.elastic.co/guide/en/elastic-stack/current" + stack-ref-67: "https://www.elastic.co/guide/en/elastic-stack/6.7" + stack-ref-68: "https://www.elastic.co/guide/en/elastic-stack/6.8" + stack-ref-70: "https://www.elastic.co/guide/en/elastic-stack/7.0" + stack-ref-80: "https://www.elastic.co/guide/en/elastic-stack/8.0" + stack-ov: "https://www.elastic.co/guide/en/elastic-stack-overview/current" + stack-gs: "https://www.elastic.co/guide/en/elastic-stack-get-started/current" + stack-gs-current: "https://www.elastic.co/guide/en/elastic-stack-get-started/current" + javaclient: "https://www.elastic.co/guide/en/elasticsearch/client/java-api/current" + java-api-client: "https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current" + java-rest: "https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current" + jsclient: "https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current" + jsclient-current: "https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current" + es-ruby-client: "https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current" + es-dotnet-client: "https://www.elastic.co/guide/en/elasticsearch/client/net-api/current" + es-php-client: "https://www.elastic.co/guide/en/elasticsearch/client/php-api/current" + es-python-client: "https://www.elastic.co/guide/en/elasticsearch/client/python-api/current" + defguide: "https://www.elastic.co/guide/en/elasticsearch/guide/2.x" + painless: "https://www.elastic.co/guide/en/elasticsearch/painless/current" + plugins: "https://www.elastic.co/guide/en/elasticsearch/plugins/current" + plugins-8x: "https://www.elastic.co/guide/en/elasticsearch/plugins/8.1" + plugins-7x: "https://www.elastic.co/guide/en/elasticsearch/plugins/7.17" + plugins-6x: "https://www.elastic.co/guide/en/elasticsearch/plugins/6.8" + glossary: "https://www.elastic.co/guide/en/elastic-stack-glossary/current" + upgrade_guide: "https://www.elastic.co/products/upgrade_guide" + blog-ref: "https://www.elastic.co/blog/" + curator-ref: "https://www.elastic.co/guide/en/elasticsearch/client/curator/current" + curator-ref-current: "https://www.elastic.co/guide/en/elasticsearch/client/curator/current" + metrics-ref: "https://www.elastic.co/guide/en/metrics/current" + metrics-guide: "https://www.elastic.co/guide/en/metrics/guide/current" + logs-ref: "https://www.elastic.co/guide/en/logs/current" + logs-guide: "https://www.elastic.co/guide/en/logs/guide/current" + uptime-guide: "https://www.elastic.co/guide/en/uptime/current" + observability-guide: "https://www.elastic.co/guide/en/observability/current" + observability-guide-all: "https://www.elastic.co/guide/en/observability" + siem-guide: "https://www.elastic.co/guide/en/siem/guide/current" + security-guide: "https://www.elastic.co/guide/en/security/current" + security-guide-all: "https://www.elastic.co/guide/en/security" + endpoint-guide: "https://www.elastic.co/guide/en/endpoint/current" + sql-odbc: "https://www.elastic.co/guide/en/elasticsearch/sql-odbc/current" + ecs-ref: "https://www.elastic.co/guide/en/ecs/current" + ecs-logging-ref: "https://www.elastic.co/guide/en/ecs-logging/overview/current" + ecs-logging-go-logrus-ref: "https://www.elastic.co/guide/en/ecs-logging/go-logrus/current" + ecs-logging-go-zap-ref: "https://www.elastic.co/guide/en/ecs-logging/go-zap/current" + ecs-logging-go-zerolog-ref: "https://www.elastic.co/guide/en/ecs-logging/go-zap/current" + ecs-logging-java-ref: "https://www.elastic.co/guide/en/ecs-logging/java/current" + ecs-logging-dotnet-ref: "https://www.elastic.co/guide/en/ecs-logging/dotnet/current" + ecs-logging-nodejs-ref: "https://www.elastic.co/guide/en/ecs-logging/nodejs/current" + ecs-logging-php-ref: "https://www.elastic.co/guide/en/ecs-logging/php/current" + ecs-logging-python-ref: "https://www.elastic.co/guide/en/ecs-logging/python/current" + ecs-logging-ruby-ref: "https://www.elastic.co/guide/en/ecs-logging/ruby/current" + ml-docs: "https://www.elastic.co/guide/en/machine-learning/current" + eland-docs: "https://www.elastic.co/guide/en/elasticsearch/client/eland/current" + eql-ref: "https://eql.readthedocs.io/en/latest/query-guide" + extendtrial: "https://www.elastic.co/trialextension" + wikipedia: "https://en.wikipedia.org/wiki" + forum: "https://discuss.elastic.co/" + xpack-forum: "https://discuss.elastic.co/c/50-x-pack" + security-forum: "https://discuss.elastic.co/c/x-pack/shield" + watcher-forum: "https://discuss.elastic.co/c/x-pack/watcher" + monitoring-forum: "https://discuss.elastic.co/c/x-pack/marvel" + graph-forum: "https://discuss.elastic.co/c/x-pack/graph" + apm-forum: "https://discuss.elastic.co/c/apm" + enterprise-search-ref: "https://www.elastic.co/guide/en/enterprise-search/current" + app-search-ref: "https://www.elastic.co/guide/en/app-search/current" + workplace-search-ref: "https://www.elastic.co/guide/en/workplace-search/current" + enterprise-search-node-ref: "https://www.elastic.co/guide/en/enterprise-search-clients/enterprise-search-node/current" + enterprise-search-php-ref: "https://www.elastic.co/guide/en/enterprise-search-clients/php/current" + enterprise-search-python-ref: "https://www.elastic.co/guide/en/enterprise-search-clients/python/current" + enterprise-search-ruby-ref: "https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current" + elastic-maps-service: "https://maps.elastic.co/" + integrations-docs: "https://docs.elastic.co/en/integrations" + integrations-devguide: "https://www.elastic.co/guide/en/integrations-developer/current" + time-units: "https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#time-units" + byte-units: "https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#byte-units" + apm-py-ref-v: "https://www.elastic.co/guide/en/apm/agent/python/current" + apm-node-ref-v: "https://www.elastic.co/guide/en/apm/agent/nodejs/current" + apm-rum-ref-v: "https://www.elastic.co/guide/en/apm/agent/rum-js/current" + apm-ruby-ref-v: "https://www.elastic.co/guide/en/apm/agent/ruby/current" + apm-java-ref-v: "https://www.elastic.co/guide/en/apm/agent/java/current" + apm-go-ref-v: "https://www.elastic.co/guide/en/apm/agent/go/current" + apm-ios-ref-v: "https://www.elastic.co/guide/en/apm/agent/swift/current" + apm-dotnet-ref-v: "https://www.elastic.co/guide/en/apm/agent/dotnet/current" + apm-php-ref-v: "https://www.elastic.co/guide/en/apm/agent/php/current" + ecloud: "Elastic Cloud" + esf: "Elastic Serverless Forwarder" + ess: "Elasticsearch Service" + ece: "Elastic Cloud Enterprise" + eck: "Elastic Cloud on Kubernetes" + serverless-full: "Elastic Cloud Serverless" + serverless-short: "Serverless" + es-serverless: "Elasticsearch Serverless" + es3: "Elasticsearch Serverless" + obs-serverless: "Elastic Observability Serverless" + sec-serverless: "Elastic Security Serverless" + serverless-docs: "https://docs.elastic.co/serverless" + cloud: "https://www.elastic.co/guide/en/cloud/current" + ess-utm-params: "?page=docs&placement=docs-body" + ess-baymax: "?page=docs&placement=docs-body" + ess-trial: "https://cloud.elastic.co/registration?page=docs&placement=docs-body" + ess-product: "https://www.elastic.co/cloud/elasticsearch-service?page=docs&placement=docs-body" + ess-console: "https://cloud.elastic.co/?page=docs&placement=docs-body" + ess-console-name: "Elasticsearch Service Console" + ess-deployments: "https://cloud.elastic.co/deployments?page=docs&placement=docs-body" + ece-ref: "https://www.elastic.co/guide/en/cloud-enterprise/current" + eck-ref: "https://www.elastic.co/guide/en/cloud-on-k8s/current" + ess-leadin: "You can run Elasticsearch on your own hardware or use our hosted Elasticsearch Service that is available on AWS, GCP, and Azure. https://cloud.elastic.co/registration{ess-utm-params}[Try the Elasticsearch Service for free]." + ess-leadin-short: "Our hosted Elasticsearch Service is available on AWS, GCP, and Azure, and you can https://cloud.elastic.co/registration{ess-utm-params}[try it for free]." + ess-icon: "image:https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg[link=\"https://cloud.elastic.co/registration%7Bess-utm-params%7D/", title=\"Supported on Elasticsearch Service\"]" + ece-icon: "image:https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud_ece.svg[link=\"https://cloud.elastic.co/registration%7Bess-utm-params%7D/", title=\"Supported on Elastic Cloud Enterprise\"]" + cloud-only: "This feature is designed for indirect use by https://cloud.elastic.co/registration{ess-utm-params}[Elasticsearch Service], https://www.elastic.co/guide/en/cloud-enterprise/{ece-version-link}[Elastic Cloud Enterprise], and https://www.elastic.co/guide/en/cloud-on-k8s/current[Elastic Cloud on Kubernetes]. Direct use is not supported." + ess-setting-change: "image:https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg[link=\"{ess-trial}\", title=\"Supported on {ess}\"] indicates a change to a supported https://www.elastic.co/guide/en/cloud/current/ec-add-user-settings.html[user setting] for Elasticsearch Service." + ess-skip-section: "If you use Elasticsearch Service, skip this section. Elasticsearch Service handles these changes for you." + api-cloud: "https://www.elastic.co/docs/api/doc/cloud" + api-ece: "https://www.elastic.co/docs/api/doc/cloud-enterprise" + api-kibana-serverless: "https://www.elastic.co/docs/api/doc/serverless" + es-feature-flag: "This feature is in development and not yet available for use. This documentation is provided for informational purposes only." + es-ref-dir: "'{{elasticsearch-root}}/docs/reference'" + apm-app: "APM app" + uptime-app: "Uptime app" + synthetics-app: "Synthetics app" + logs-app: "Logs app" + metrics-app: "Metrics app" + infrastructure-app: "Infrastructure app" + siem-app: "SIEM app" + security-app: "Elastic Security app" + ml-app: "Machine Learning" + dev-tools-app: "Dev Tools" + ingest-manager-app: "Ingest Manager" + stack-manage-app: "Stack Management" + stack-monitor-app: "Stack Monitoring" + alerts-ui: "Alerts and Actions" + rules-ui: "Rules" + rac-ui: "Rules and Connectors" + connectors-ui: "Connectors" + connectors-feature: "Actions and Connectors" + stack-rules-feature: "Stack Rules" + user-experience: "User Experience" + ems: "Elastic Maps Service" + ems-init: "EMS" + hosted-ems: "Elastic Maps Server" + ipm-app: "Index Pattern Management" + ingest-pipelines: "ingest pipelines" + ingest-pipelines-app: "Ingest Pipelines" + ingest-pipelines-cap: "Ingest pipelines" + ls-pipelines: "Logstash pipelines" + ls-pipelines-app: "Logstash Pipelines" + maint-windows: "maintenance windows" + maint-windows-app: "Maintenance Windows" + maint-windows-cap: "Maintenance windows" + custom-roles-app: "Custom Roles" + data-source: "data view" + data-sources: "data views" + data-source-caps: "Data View" + data-sources-caps: "Data Views" + data-source-cap: "Data view" + data-sources-cap: "Data views" + project-settings: "Project settings" + manage-app: "Management" + index-manage-app: "Index Management" + data-views-app: "Data Views" + rules-app: "Rules" + saved-objects-app: "Saved Objects" + tags-app: "Tags" + api-keys-app: "API keys" + transforms-app: "Transforms" + connectors-app: "Connectors" + files-app: "Files" + reports-app: "Reports" + maps-app: "Maps" + alerts-app: "Alerts" + crawler: "Enterprise Search web crawler" + ents: "Enterprise Search" + app-search-crawler: "App Search web crawler" + agent: "Elastic Agent" + agents: "Elastic Agents" + fleet: "Fleet" + fleet-server: "Fleet Server" + integrations-server: "Integrations Server" + ingest-manager: "Ingest Manager" + ingest-management: "ingest management" + package-manager: "Elastic Package Manager" + integrations: "Integrations" + package-registry: "Elastic Package Registry" + artifact-registry: "Elastic Artifact Registry" + aws: "AWS" + stack: "Elastic Stack" + xpack: "X-Pack" + es: "Elasticsearch" + kib: "Kibana" + esms: "Elastic Stack Monitoring Service" + esms-init: "ESMS" + ls: "Logstash" + beats: "Beats" + auditbeat: "Auditbeat" + filebeat: "Filebeat" + heartbeat: "Heartbeat" + metricbeat: "Metricbeat" + packetbeat: "Packetbeat" + winlogbeat: "Winlogbeat" + functionbeat: "Functionbeat" + journalbeat: "Journalbeat" + es-sql: "Elasticsearch SQL" + esql: "ES|QL" + elastic-agent: "Elastic Agent" + k8s: "Kubernetes" + log-driver-long: "Elastic Logging Plugin for Docker" + security: "X-Pack security" + security-features: "security features" + operator-feature: "operator privileges feature" + es-security-features: "Elasticsearch security features" + stack-security-features: "Elastic Stack security features" + endpoint-sec: "Endpoint Security" + endpoint-cloud-sec: "Endpoint and Cloud Security" + elastic-defend: "Elastic Defend" + elastic-sec: "Elastic Security" + elastic-endpoint: "Elastic Endpoint" + swimlane: "Swimlane" + sn: "ServiceNow" + sn-itsm: "ServiceNow ITSM" + sn-itom: "ServiceNow ITOM" + sn-sir: "ServiceNow SecOps" + jira: "Jira" + ibm-r: "IBM Resilient" + webhook: "Webhook" + webhook-cm: "Webhook - Case Management" + opsgenie: "Opsgenie" + bedrock: "Amazon Bedrock" + gemini: "Google Gemini" + hive: "TheHive" + monitoring: "X-Pack monitoring" + monitor-features: "monitoring features" + stack-monitor-features: "Elastic Stack monitoring features" + watcher: "Watcher" + alert-features: "alerting features" + reporting: "X-Pack reporting" + report-features: "reporting features" + graph: "X-Pack graph" + graph-features: "graph analytics features" + searchprofiler: "Search Profiler" + xpackml: "X-Pack machine learning" + ml: "machine learning" + ml-cap: "Machine learning" + ml-init: "ML" + ml-features: "machine learning features" + stack-ml-features: "Elastic Stack machine learning features" + ccr: "cross-cluster replication" + ccr-cap: "Cross-cluster replication" + ccr-init: "CCR" + ccs: "cross-cluster search" + ccs-cap: "Cross-cluster search" + ccs-init: "CCS" + ilm: "index lifecycle management" + ilm-cap: "Index lifecycle management" + ilm-init: "ILM" + dlm: "data lifecycle management" + dlm-cap: "Data lifecycle management" + dlm-init: "DLM" + search-snap: "searchable snapshot" + search-snaps: "searchable snapshots" + search-snaps-cap: "Searchable snapshots" + slm: "snapshot lifecycle management" + slm-cap: "Snapshot lifecycle management" + slm-init: "SLM" + rollup-features: "data rollup features" + ipm: "index pattern management" + ipm-cap: "Index pattern" + rollup: "rollup" + rollup-cap: "Rollup" + rollups: "rollups" + rollups-cap: "Rollups" + rollup-job: "rollup job" + rollup-jobs: "rollup jobs" + rollup-jobs-cap: "Rollup jobs" + dfeed: "datafeed" + dfeeds: "datafeeds" + dfeed-cap: "Datafeed" + dfeeds-cap: "Datafeeds" + ml-jobs: "machine learning jobs" + ml-jobs-cap: "Machine learning jobs" + anomaly-detect: "anomaly detection" + anomaly-detect-cap: "Anomaly detection" + anomaly-job: "anomaly detection job" + anomaly-jobs: "anomaly detection jobs" + anomaly-jobs-cap: "Anomaly detection jobs" + dataframe: "data frame" + dataframes: "data frames" + dataframe-cap: "Data frame" + dataframes-cap: "Data frames" + watcher-transform: "payload transform" + watcher-transforms: "payload transforms" + watcher-transform-cap: "Payload transform" + watcher-transforms-cap: "Payload transforms" + transform: "transform" + transforms: "transforms" + transform-cap: "Transform" + transforms-cap: "Transforms" + dataframe-transform: "transform" + dataframe-transform-cap: "Transform" + dataframe-transforms: "transforms" + dataframe-transforms-cap: "Transforms" + dfanalytics-cap: "Data frame analytics" + dfanalytics: "data frame analytics" + dataframe-analytics-config: "'{dataframe} analytics config'" + dfanalytics-job: "'{dataframe} analytics job'" + dfanalytics-jobs: "'{dataframe} analytics jobs'" + dfanalytics-jobs-cap: "'{dataframe-cap} analytics jobs'" + cdataframe: "continuous data frame" + cdataframes: "continuous data frames" + cdataframe-cap: "Continuous data frame" + cdataframes-cap: "Continuous data frames" + cdataframe-transform: "continuous transform" + cdataframe-transforms: "continuous transforms" + cdataframe-transforms-cap: "Continuous transforms" + ctransform: "continuous transform" + ctransform-cap: "Continuous transform" + ctransforms: "continuous transforms" + ctransforms-cap: "Continuous transforms" + oldetection: "outlier detection" + oldetection-cap: "Outlier detection" + olscore: "outlier score" + olscores: "outlier scores" + fiscore: "feature influence score" + evaluatedf-api: "evaluate {dataframe} analytics API" + evaluatedf-api-cap: "Evaluate {dataframe} analytics API" + binarysc: "binary soft classification" + binarysc-cap: "Binary soft classification" + regression: "regression" + regression-cap: "Regression" + reganalysis: "regression analysis" + reganalysis-cap: "Regression analysis" + depvar: "dependent variable" + feature-var: "feature variable" + feature-vars: "feature variables" + feature-vars-cap: "Feature variables" + classification: "classification" + classification-cap: "Classification" + classanalysis: "classification analysis" + classanalysis-cap: "Classification analysis" + infer-cap: "Inference" + infer: "inference" + lang-ident-cap: "Language identification" + lang-ident: "language identification" + data-viz: "Data Visualizer" + file-data-viz: "File Data Visualizer" + feat-imp: "feature importance" + feat-imp-cap: "Feature importance" + nlp: "natural language processing" + nlp-cap: "Natural language processing" + apm-agent: "APM agent" + apm-go-agent: "Elastic APM Go agent" + apm-go-agents: "Elastic APM Go agents" + apm-ios-agent: "Elastic APM iOS agent" + apm-ios-agents: "Elastic APM iOS agents" + apm-java-agent: "Elastic APM Java agent" + apm-java-agents: "Elastic APM Java agents" + apm-dotnet-agent: "Elastic APM .NET agent" + apm-dotnet-agents: "Elastic APM .NET agents" + apm-node-agent: "Elastic APM Node.js agent" + apm-node-agents: "Elastic APM Node.js agents" + apm-php-agent: "Elastic APM PHP agent" + apm-php-agents: "Elastic APM PHP agents" + apm-py-agent: "Elastic APM Python agent" + apm-py-agents: "Elastic APM Python agents" + apm-ruby-agent: "Elastic APM Ruby agent" + apm-ruby-agents: "Elastic APM Ruby agents" + apm-rum-agent: "Elastic APM Real User Monitoring (RUM) JavaScript agent" + apm-rum-agents: "Elastic APM RUM JavaScript agents" + apm-lambda-ext: "Elastic APM AWS Lambda extension" + project-monitors: "project monitors" + project-monitors-cap: "Project monitors" + private-location: "Private Location" + private-locations: "Private Locations" + pwd: "YOUR_PASSWORD" + esh: "ES-Hadoop" + default-dist: "default distribution" + oss-dist: "OSS-only distribution" + observability: "Observability" + api-request-title: "Request" + api-prereq-title: "Prerequisites" + api-description-title: "Description" + api-path-parms-title: "Path parameters" + api-query-parms-title: "Query parameters" + api-request-body-title: "Request body" + api-response-codes-title: "Response codes" + api-response-body-title: "Response body" + api-example-title: "Example" + api-examples-title: "Examples" + api-definitions-title: "Properties" + multi-arg: "†footnoteref:[multi-arg,This parameter accepts multiple arguments.]" + multi-arg-ref: "†footnoteref:[multi-arg]" + yes-icon: "image:https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png[Yes,20,15]" + no-icon: "image:https://doc-icons.s3.us-east-2.amazonaws.com/icon-no.png[No,20,15]" + es-repo: "https://github.com/elastic/elasticsearch/" + es-issue: "https://github.com/elastic/elasticsearch/issues/" + es-pull: "https://github.com/elastic/elasticsearch/pull/" + es-commit: "https://github.com/elastic/elasticsearch/commit/" + kib-repo: "https://github.com/elastic/kibana/" + kib-issue: "https://github.com/elastic/kibana/issues/" + kibana-issue: "'{kib-repo}issues/'" + kib-pull: "https://github.com/elastic/kibana/pull/" + kibana-pull: "'{kib-repo}pull/'" + kib-commit: "https://github.com/elastic/kibana/commit/" + ml-repo: "https://github.com/elastic/ml-cpp/" + ml-issue: "https://github.com/elastic/ml-cpp/issues/" + ml-pull: "https://github.com/elastic/ml-cpp/pull/" + ml-commit: "https://github.com/elastic/ml-cpp/commit/" + apm-repo: "https://github.com/elastic/apm-server/" + apm-issue: "https://github.com/elastic/apm-server/issues/" + apm-pull: "https://github.com/elastic/apm-server/pull/" + kibana-blob: "https://github.com/elastic/kibana/blob/current/" + apm-get-started-ref: "https://www.elastic.co/guide/en/apm/get-started/current" + apm-server-ref: "https://www.elastic.co/guide/en/apm/server/current" + apm-server-ref-v: "https://www.elastic.co/guide/en/apm/server/current" + apm-server-ref-m: "https://www.elastic.co/guide/en/apm/server/master" + apm-server-ref-62: "https://www.elastic.co/guide/en/apm/server/6.2" + apm-server-ref-64: "https://www.elastic.co/guide/en/apm/server/6.4" + apm-server-ref-70: "https://www.elastic.co/guide/en/apm/server/7.0" + apm-overview-ref-v: "https://www.elastic.co/guide/en/apm/get-started/current" + apm-overview-ref-70: "https://www.elastic.co/guide/en/apm/get-started/7.0" + apm-overview-ref-m: "https://www.elastic.co/guide/en/apm/get-started/master" + infra-guide: "https://www.elastic.co/guide/en/infrastructure/guide/current" + a-data-source: "a data view" + icon-bug: "pass:[]" + icon-checkInCircleFilled: "pass:[]" + icon-warningFilled: "pass:[]" diff --git a/docs/dsl.asciidoc b/docs/dsl.asciidoc deleted file mode 100644 index 922624a4fa..0000000000 --- a/docs/dsl.asciidoc +++ /dev/null @@ -1,6 +0,0 @@ -[[dsl]] -=== Elasticsearch DSL - -The https://github.com/elastic/elasticsearch-dsl-ruby[elasticsearch-dsl] gem provides a Ruby API for the https://www.elasticsearch.com/guide/en/elasticsearch/reference/current/query-dsl.html[Elasticsearch Query DSL]. The library allows to programmatically build complex search definitions for {es} in Ruby, which are translated to Hashes, and ultimately, JSON, the language of {es}. - -See https://github.com/elastic/elasticsearch-dsl-ruby#elasticsearchdsl[the README] for more information. diff --git a/docs/ecs.asciidoc b/docs/ecs.asciidoc deleted file mode 100644 index 218708038b..0000000000 --- a/docs/ecs.asciidoc +++ /dev/null @@ -1,34 +0,0 @@ -[[ecs]] -=== Elastic Common Schema (ECS) - -The https://www.elastic.co/guide/en/ecs/current/ecs-reference.html[Elastic Common Schema (ECS)] is an open source format that defines a common set of fields to be used when storing event data like logs in Elasticsearch. - -You can use the library https://github.com/elastic/ecs-logging-ruby[ecs-logging] which is a set of libraries that enables you to transform your application logs to structured logs that comply with the ECS format. - -Add this line to your application's Gemfile: - -[source,ruby] ------------------------------------- -gem 'ecs-logging' ------------------------------------- - -Then execute `bundle install`. Or install from the command line yourself: - -[source,ruby] ------------------------------------- -$ gem install ecs-logging ------------------------------------- - -Then configure the client to use the logger: -[source,ruby] ------------------------------------- -require 'ecs_logging/logger' -require 'elasticsearch' - -logger = EcsLogging::Logger.new($stdout) -client = Elasticsearch::Client.new(logger: logger) -> client.info -{"@timestamp":"2022-07-12T05:31:18.590Z","log.level":"INFO","message":"GET http://localhost:9200/ [status:200, request:0.009s, query:n/a]","ecs.version":"1.4.0"}... ------------------------------------- - -See https://www.elastic.co/guide/en/ecs-logging/ruby/current/index.html[ECS Logging Ruby Reference] for more information on how to configure the logger. diff --git a/docs/examples/apm/screenshot.jpg b/docs/examples/apm/screenshot.jpg deleted file mode 100644 index 6ba778dfb5..0000000000 Binary files a/docs/examples/apm/screenshot.jpg and /dev/null differ diff --git a/docs/getting-started.asciidoc b/docs/getting-started.asciidoc deleted file mode 100644 index a4500847b4..0000000000 --- a/docs/getting-started.asciidoc +++ /dev/null @@ -1,141 +0,0 @@ -[[getting-started-ruby]] -== Getting started - -This page guides you through the installation process of the Ruby client, shows -you how to instantiate the client, and how to perform basic Elasticsearch -operations with it. - -[discrete] -=== Requirements - -A currently maintained version of Ruby (3.0+) or JRuby (9.3+). - -[discrete] -=== Installation - -To install the latest version of the client, run the following command: - -[source,shell] --------------------------- -gem install elasticsearch --------------------------- - -Refer to the <> page to learn more. - - -[discrete] -=== Connecting - -You can connect to the Elastic Cloud using an API key and the Elasticsearch -endpoint. - -[source,rb] ----- -client = Elasticsearch::Client.new( - cloud_id: '', - api_key: '' -) ----- - -Your Elasticsearch endpoint can be found on the **My deployment** page of your -deployment: - -image::images/es_endpoint.jpg[alt="Finding Elasticsearch endpoint",align="center"] - -You can generate an API key on the **Management** page under Security. - -image::images/create_api_key.png[alt="Create API key",align="center"] - -For other connection options, refer to the <> section. - - -[discrete] -=== Operations - -Time to use Elasticsearch! This section walks you through the basic, and most -important, operations of Elasticsearch. For more operations and more advanced -examples, refer to the <> page. - - -[discrete] -==== Creating an index - -This is how you create the `my_index` index: - -[source,rb] ----- -client.indices.create(index: 'my_index') ----- - - -[discrete] -==== Indexing documents - -This is a simple way of indexing a document: - -[source,rb] ----- -document = { name: 'elasticsearch-ruby' } -response = client.index(index: 'my_index', body: document) -# You can get the indexed document id with: -response['_id'] -=> "PlgIDYkBWS9Ngdx5IMy-" -id = response['_id'] ----- - - -[discrete] -==== Getting documents - -You can get documents by using the following code: - -[source,rb] ----- -client.get(index: 'my_index', id: id) ----- - - -[discrete] -==== Searching documents - -This is how you can create a single match query with the Ruby client: - -[source,rb] ----- -client.search(index: 'my_index', body: { query: { match_all: {} } }) ----- - - -[discrete] -==== Updating documents - -This is how you can update a document, for example to add a new field: - -[source,rb] ----- -client.update(index: 'my_index', id: id, body: { doc: { language: 'Ruby' } }) ----- - - -[discrete] -==== Deleting documents - -[source,rb] ----- -client.delete(index: 'my_index', id: id) ----- - - -[discrete] -==== Deleting an index - -[source,rb] ----- -client.indices.delete(index: 'my_index') ----- - - -[discrete] -== Further reading - -* Use <> for a more confortable experience with the APIs. \ No newline at end of file diff --git a/docs/helpers/index.asciidoc b/docs/helpers/index.asciidoc deleted file mode 100644 index 1e475886cd..0000000000 --- a/docs/helpers/index.asciidoc +++ /dev/null @@ -1,10 +0,0 @@ -[[client-helpers]] -== Client helpers - -The Ruby client includes the following helpers: - -* <> -* <> - -include::bulk-scroll.asciidoc[] -include::esql.asciidoc[] \ No newline at end of file diff --git a/docs/index.asciidoc b/docs/index.asciidoc deleted file mode 100644 index b83dd47058..0000000000 --- a/docs/index.asciidoc +++ /dev/null @@ -1,32 +0,0 @@ -= Elasticsearch Ruby Client - -:doctype: book - -include::{asciidoc-dir}/../../shared/versions/stack/{source_branch}.asciidoc[] -include::{asciidoc-dir}/../../shared/attributes.asciidoc[] - -:es-docs: https://www.elastic.co/guide/en/elasticsearch/reference/{branch} - -include::overview.asciidoc[] - -include::getting-started.asciidoc[] - -include::installation.asciidoc[] - -include::connecting.asciidoc[] - -include::config.asciidoc[] - -include::basic-config.asciidoc[] - -include::advanced-config.asciidoc[] - -include::integrations.asciidoc[] - -include::examples.asciidoc[] - -include::troubleshooting.asciidoc[] - -include::helpers/index.asciidoc[] - -include::release_notes/index.asciidoc[] diff --git a/docs/installation.asciidoc b/docs/installation.asciidoc deleted file mode 100644 index 15ce2f60a8..0000000000 --- a/docs/installation.asciidoc +++ /dev/null @@ -1,61 +0,0 @@ -[[ruby-install]] -== Installation - -Install the Rubygem for the latest {es} version by using the following command: - -[source,sh] ------------------------------------- -gem install elasticsearch ------------------------------------- - - -Or add the `elasticsearch` Ruby gem to your Gemfile: - -[source,ruby] ------------------------------------- -gem 'elasticsearch' ------------------------------------- - - - -You can install the Ruby gem for a specific {es} version by using the following -command: - -[source,sh] ------------------------------------- -gem install elasticsearch -v 7.0.0 ------------------------------------- - - -Or you can add a specific version of {es} to your Gemfile: - -[source,ruby] ------------------------------------- -gem 'elasticsearch', '~> 7.0' ------------------------------------- - - -[discrete] -=== {es} and Ruby Version Compatibility - -The {es} client is compatible with currently maintained Ruby versions. We follow -Ruby’s own maintenance policy and officially support all currently maintained -versions per -https://www.ruby-lang.org/en/downloads/branches/[Ruby Maintenance Branches]. - -Language clients are forward compatible; meaning that clients support -communicating with greater or equal minor versions of {es} without breaking. It -does not mean that the client automatically supports new features of newer {es} -versions; it is only possible after a release of a new client version. For -example, a 8.12 client version won't automatically support the new features of -the 8.13 version of {es}, the 8.13 client version is required for that. -{es} language clients are only backwards compatible with default distributions -and without guarantees made. - -|=== -| Gem Version | | {es} Version | Supported - -| 7.x | → | 7.x | 7.17 -| 8.x | → | 8.x | 8.x -| main | → | main | -|=== \ No newline at end of file diff --git a/docs/integrations.asciidoc b/docs/integrations.asciidoc deleted file mode 100644 index c758d17201..0000000000 --- a/docs/integrations.asciidoc +++ /dev/null @@ -1,30 +0,0 @@ -[[integrations]] -== Integrations - -The Rubygems listed on this page make it easier to operate with {es} by using -the Ruby client. - -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> - -include::transport.asciidoc[] - -include::api.asciidoc[] - -include::open-telemetry.asciidoc[] - -include::ecs.asciidoc[] - -include::model.asciidoc[] - -include::rails.asciidoc[] - -include::persistence.asciidoc[] - -include::dsl.asciidoc[] diff --git a/docs/open-telemetry.asciidoc b/docs/open-telemetry.asciidoc deleted file mode 100644 index 87fd86206b..0000000000 --- a/docs/open-telemetry.asciidoc +++ /dev/null @@ -1,94 +0,0 @@ -[[opentelemetry]] -=== Using OpenTelemetry - -You can use https://opentelemetry.io/[OpenTelemetry] to monitor the performance and behavior of your {es} requests through the Ruby Client. -The Ruby Client comes with built-in OpenTelemetry instrumentation that emits https://www.elastic.co/guide/en/apm/guide/current/apm-distributed-tracing.html[distributed tracing spans] by default. -With that, applications https://opentelemetry.io/docs/instrumentation/ruby/manual/[instrumented with OpenTelemetry] or using the https://opentelemetry.io/docs/instrumentation/ruby/automatic/[OpenTelemetry Ruby SDK] are inherently enriched with additional spans that contain insightful information about the execution of the {es} requests. - -The native instrumentation in the Ruby Client follows the https://opentelemetry.io/docs/specs/semconv/database/elasticsearch/[OpenTelemetry Semantic Conventions for {es}]. In particular, the instrumentation in the client covers the logical layer of {es} requests. A single span per request is created that is processed by the service through the Ruby Client. The following image shows a trace that records the handling of two different {es} requests: a `ping` request and a `search` request. - -[role="screenshot"] -image::images/otel-waterfall-without-http.png[alt="Distributed trace with Elasticsearch spans",align="center"] - -Usually, OpenTelemetry auto-instrumentation modules come with instrumentation support for HTTP-level communication. In this case, in addition to the logical {es} client requests, spans will be captured for the physical HTTP requests emitted by the client. The following image shows a trace with both, {es} spans (in blue) and the corresponding HTTP-level spans (in red): - -[role="screenshot"] -image::images/otel-waterfall-with-http.png[alt="Distributed trace with Elasticsearch spans",align="center"] - -Advanced Ruby Client behavior such as nodes round-robin and request retries are revealed through the combination of logical {es} spans and the physical HTTP spans. The following example shows a `search` request in a scenario with two nodes: - -[role="screenshot"] -image::images/otel-waterfall-retry.png[alt="Distributed trace with Elasticsearch spans",align="center"] - -The first node is unavailable and results in an HTTP error, while the retry to the second node succeeds. Both HTTP requests are subsumed by the logical {es} request span (in blue). - -[discrete] -==== Setup the OpenTelemetry instrumentation - -When using the https://opentelemetry.io/docs/instrumentation/ruby/manual[OpenTelemetry Ruby SDK manually] or using the https://opentelemetry.io/docs/instrumentation/ruby/automatic/[OpenTelemetry Ruby Auto-Instrumentations], the Ruby Client's OpenTelemetry instrumentation is enabled by default and uses the global OpenTelemetry SDK with the global tracer provider. You can provide a tracer provider via the Ruby Client configuration option `opentelemetry_tracer_provider` when instantiating the client. This is sometimes useful for testing or other specific use cases. - -[source,ruby] ------------------------------------- -client = Elasticsearch::Client.new( - cloud_id: '', - api_key: '', - opentelemetry_tracer_provider: tracer_provider -) ------------------------------------- - -[discrete] -==== Configuring the OpenTelemetry instrumentation - -You can configure the OpenTelemetry instrumentation through Environment Variables. -The following configuration options are available. - -[discrete] -[[opentelemetry-config-enable]] -===== Enable / Disable the OpenTelemetry instrumentation - -With this configuration option you can enable (default) or disable the built-in OpenTelemetry instrumentation. - -**Default:** `true` - -|============ -| Environment Variable | `OTEL_RUBY_INSTRUMENTATION_ELASTICSEARCH_ENABLED` -|============ - -[discrete] -===== Capture search request bodies - -Per default, the built-in OpenTelemetry instrumentation does not capture request bodies due to data privacy considerations. You can use this option to enable capturing of search queries from the request bodies of {es} search requests in case you wish to gather this information regardless. The options are to capture the raw search query, sanitize the query with a default list of sensitive keys, or not capture it at all. - -**Default:** `omit` - -**Valid Options:** `omit`, `sanitize`, `raw` - -|============ -| Environment Variable | `OTEL_RUBY_INSTRUMENTATION_ELASTICSEARCH_CAPTURE_SEARCH_QUERY` -|============ - -[discrete] -===== Sanitize the {es} search request body - -You can configure the list of keys whose values are redacted when the search query is captured. Values must be comma-separated. -Note in v8.3.0 and v8.3.1, the environment variable `OTEL_INSTRUMENTATION_ELASTICSEARCH_CAPTURE_SEARCH_QUERY` was available -but is now deprecated in favor of the environment variable including `RUBY`. - -**Default:** `nil` - -|============ -| Environment Variable | `OTEL_RUBY_INSTRUMENTATION_ELASTICSEARCH_SEARCH_QUERY_SANITIZE_KEYS` -|============ - -Example: - -```bash -OTEL_RUBY_INSTRUMENTATION_ELASTICSEARCH_SEARCH_QUERY_SANITIZE_KEYS='sensitive-key,other-sensitive-key' -``` - -[discrete] -==== Overhead - -The OpenTelemetry instrumentation (as any other monitoring approach) may come with a slight overhead on CPU, memory, and/or latency. The overhead may only occur when the instrumentation is enabled (default) and an OpenTelemetry SDK is active in the target application. When the instrumentation is disabled or no OpenTelemetry SDK is active within the target application, monitoring overhead is not expected when using the client. - -Even in cases where the instrumentation is enabled and is actively used (by an OpenTelemetry SDK), the overhead is minimal and negligible in the vast majority of cases. In edge cases where there is a noticeable overhead, the <> to eliminate any potential impact on performance. \ No newline at end of file diff --git a/docs/overview.asciidoc b/docs/overview.asciidoc deleted file mode 100644 index 108094e23b..0000000000 --- a/docs/overview.asciidoc +++ /dev/null @@ -1,38 +0,0 @@ -[[ruby_client]] -== Overview - -The `elasticsearch` http://rubygems.org/gems/elasticsearch[Rubygem] provides a low-level client for communicating with an {es} cluster, fully compatible with other official clients. - -More documentation is hosted in https://github.com/elastic/elasticsearch-ruby[Github] and http://rubydoc.info/gems/elasticsearch[RubyDoc]. - -Refer to the <> page for a step-by-step quick start with -the Ruby client. - -[discrete] -=== Features - -* Pluggable logging and tracing -* Pluggable connection selection strategies (round-robin, random, custom) -* Pluggable transport implementation, customizable and extendable -* Pluggable serializer implementation -* Request retries and dead connections handling -* Node reloading (based on cluster state) on errors or on demand -* Modular API implementation -* 100% REST API coverage - - -[discrete] -[[transport-api]] -=== Transport and API - -The `elasticsearch` gem combines two separate Rubygems: - -* https://github.com/elastic/elastic-transport-ruby/[`elastic-transport`] - provides an HTTP Ruby client for connecting to the {es} cluster. Refer to the documentation: <> - -* https://github.com/elastic/elasticsearch-ruby/tree/main/elasticsearch-api[`elasticsearch-api`] - provides a Ruby API for the {es} RESTful API. - -Please consult their respective documentation for configuration options and technical details. - -Notably, the documentation and comprehensive examples for all the API methods are contained in the source, and available online at http://rubydoc.info/gems/elasticsearch-api/Elasticsearch/API/Actions[Rubydoc]. - -Keep in mind, that for optimal performance, you should use an HTTP library which supports persistent ("keep-alive") HTTP connections. diff --git a/docs/rails.asciidoc b/docs/rails.asciidoc deleted file mode 100644 index d1c84e1b86..0000000000 --- a/docs/rails.asciidoc +++ /dev/null @@ -1,24 +0,0 @@ -[[ruby_on_rails]] -=== Ruby On Rails - -The `elasticsearch-rails` http://rubygems.org/gems/elasticsearch-rails[Rubygem] -provides features suitable for Ruby on Rails applications. - - -[discrete] -==== Features - -* Rake tasks for importing data from application models -* Integration with Rails' instrumentation framework -* Templates for generating example Rails application - - -[discrete] -==== Example applications - -You can generate a fully working example Ruby on Rails application with -templates provides. - -Please refer to the -https://github.com/elastic/elasticsearch-rails/tree/master/elasticsearch-rails[documentation] -for more information. diff --git a/docs/helpers/bulk-scroll.asciidoc b/docs/reference/Helpers.md similarity index 78% rename from docs/helpers/bulk-scroll.asciidoc rename to docs/reference/Helpers.md index 8d638bab65..67c7be3393 100644 --- a/docs/helpers/bulk-scroll.asciidoc +++ b/docs/reference/Helpers.md @@ -1,98 +1,93 @@ -[[Helpers]] -=== Bulk and Scroll helpers +--- +mapped_pages: + - https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/Helpers.html +--- -The {es} Ruby client includes Bulk and Scroll helpers for working with results more efficiently. +# Bulk and Scroll helpers [Helpers] -[discrete] -==== Bulk helper +The {{es}} Ruby client includes Bulk and Scroll helpers for working with results more efficiently. -The Bulk API in Elasticsearch allows you to perform multiple indexing or deletion operations through a single API call, resulting in reduced overhead and improved indexing speed. The actions are specified in the request body using a newline delimited JSON (NDJSON) structure. In the Elasticsearch Ruby client, the `bulk` method supports several data structures as a parameter. You can use the Bulk API in an idiomatic way without concerns about payload formatting. Refer to <> for more information. +## Bulk helper [_bulk_helper] -The BulkHelper provides a better developer experience when using the Bulk API. At its simplest, you can send it a collection of hashes in an array, and it will bulk ingest them into {es}. +The Bulk API in Elasticsearch allows you to perform multiple indexing or deletion operations through a single API call, resulting in reduced overhead and improved indexing speed. The actions are specified in the request body using a newline delimited JSON (NDJSON) structure. In the Elasticsearch Ruby client, the `bulk` method supports several data structures as a parameter. You can use the Bulk API in an idiomatic way without concerns about payload formatting. Refer to [Bulk requests](/reference/examples.md#ex-bulk) for more information. + +The BulkHelper provides a better developer experience when using the Bulk API. At its simplest, you can send it a collection of hashes in an array, and it will bulk ingest them into {{es}}. To use the BulkHelper, require it in your code: -[source,ruby] ----- +```ruby require 'elasticsearch/helpers/bulk_helper' ----- +``` Instantiate a BulkHelper with a client, and an index: -[source,ruby] ----- + +```ruby client = Elasticsearch::Client.new bulk_helper = Elasticsearch::Helpers::BulkHelper.new(client, index) ----- +``` This helper works on the index you pass in during initialization, but you can change the index at any time in your code: -[source,ruby] ----- +```ruby bulk_helper.index = 'new_index' ----- +``` If you want to index a collection of documents, use the `ingest` method: -[source,ruby] ----- +```ruby documents = [ { name: 'document1', date: '2024-05-16' }, { name: 'document2', date: '2023-12-19' }, { name: 'document3', date: '2024-07-07' } ] bulk_helper.ingest(documents) ----- +``` -If you're ingesting a large set of data and want to separate the documents into smaller pieces before sending them to {es}, use the `slice` parameter. +If you’re ingesting a large set of data and want to separate the documents into smaller pieces before sending them to {{es}}, use the `slice` parameter. -[source,ruby] ----- +```ruby bulk_helper.ingest(documents, { slice: 2 }) ----- +``` This way the data will be sent in two different bulk requests. You can also include the parameters you would send to the Bulk API either in the query parameters or in the request body. The method signature is `ingest(docs, params = {}, body = {}, &block)`. Additionally, the method can be called with a block, that will provide access to the response object received from calling the Bulk API and the documents sent in the request: -[source,ruby] ----- +```ruby helper.ingest(documents) { |_, docs| puts "Ingested #{docs.count} documents" } ----- +``` You can update and delete documents with the BulkHelper too. To delete a set of documents, you can send an array of document ids: -[source,ruby] ----- +```ruby ids = ['shm0I4gB6LpJd9ljO9mY', 'sxm0I4gB6LpJd9ljO9mY', 'tBm0I4gB6LpJd9ljO9mY', 'tRm0I4gB6LpJd9ljO9mY', 'thm0I4gB6LpJd9ljO9mY', 'txm0I4gB6LpJd9ljO9mY', 'uBm0I4gB6LpJd9ljO9mY', 'uRm0I4gB6LpJd9ljO9mY', 'uhm0I4gB6LpJd9ljO9mY', 'uxm0I4gB6LpJd9ljO9mY'] helper.delete(ids) ----- +``` To update documents, you can send the array of documents with their respective ids: -[source,ruby] ----- + +```ruby documents = [ {name: 'updated name 1', id: 'AxkFJYgB6LpJd9ljOtr7'}, {name: 'updated name 2', id: 'BBkFJYgB6LpJd9ljOtr7'} ] helper.update(documents) ----- +``` -[discrete] -===== Ingest a JSON file + +### Ingest a JSON file [_ingest_a_json_file] `BulkHelper` also provides a helper to ingest data straight from a JSON file. By giving a file path as an input, the helper will parse and ingest the documents in the file: -[source,ruby] ----- +```ruby file_path = './data.json' helper.ingest_json(file_path) ----- +``` In cases where the array of data you want to ingest is not necessarily in the root of the JSON file, you can provide the keys to access the data, for example given the following JSON file: -[source,json] ----- +```json { "field": "value", "status": 200, @@ -107,56 +102,50 @@ In cases where the array of data you want to ingest is not necessarily in the ro ] } } ----- +``` The following is an example of the Ruby code to ingest the documents in the JSON above: -[source,ruby] ----- +```ruby bulk_helper.ingest_json(file_path, { keys: ['data', 'items'] }) ----- +``` + -[discrete] -==== Scroll helper +## Scroll helper [_scroll_helper] This helper provides an easy way to get results from a Scroll. To use the ScrollHelper, require it in your code: -[source,ruby] ----- +```ruby require 'elasticsearch/helpers/scroll_helper' ----- +``` Instantiate a ScrollHelper with a client, an index, and a body (with the scroll API parameters) which will be used in every following scroll request: -[source,ruby] ----- +```ruby client = Elasticsearch::Client.new scroll_helper = Elasticsearch::Helpers::ScrollHelper.new(client, index, body) ----- +``` There are two ways to get the results from a scroll using the helper. 1. You can iterate over a scroll using the methods in `Enumerable` such as `each` and `map`: -+ --- -[source,ruby] ----- -scroll_helper.each do |item| - puts item -end ----- --- + + ```ruby + scroll_helper.each do |item| + puts item + end + ``` + 2. You can fetch results by page, with the `results` function: -+ --- -[source,ruby] ----- -my_documents = [] -while !(documents = scroll_helper.results).empty? - my_documents << documents -end -scroll_helper.clear ----- --- + + ```ruby + my_documents = [] + while !(documents = scroll_helper.results).empty? + my_documents << documents + end + scroll_helper.clear + ``` + + diff --git a/docs/model.asciidoc b/docs/reference/activemodel_activerecord.md similarity index 55% rename from docs/model.asciidoc rename to docs/reference/activemodel_activerecord.md index 8f4da31f7c..8a143def32 100644 --- a/docs/model.asciidoc +++ b/docs/reference/activemodel_activerecord.md @@ -1,16 +1,16 @@ -[[activemodel_activerecord]] -=== ActiveModel / ActiveRecord +--- +mapped_pages: + - https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/activemodel_activerecord.html +--- -The `elasticsearch-model` http://rubygems.org/gems/elasticsearch-model[Rubygem] -provides integration with Ruby domain objects ("models"), commonly found for -example, in Ruby on Rails applications. +# ActiveModel / ActiveRecord [activemodel_activerecord] -It uses the `elasticsearch` Rubygem as the client communicating with the {es} -cluster. +The `elasticsearch-model` [Rubygem](http://rubygems.org/gems/elasticsearch-model) provides integration with Ruby domain objects ("models"), commonly found for example, in Ruby on Rails applications. +It uses the `elasticsearch` Rubygem as the client communicating with the {{es}} cluster. -[discrete] -==== Features + +## Features [_features_2] * ActiveModel integration with adapters for ActiveRecord and Mongoid * Enumerable-based wrapper for search results @@ -18,44 +18,38 @@ cluster. * Convenience model methods such as `search`, `mapping`, `import`, etc * Support for Kaminari and WillPaginate pagination * Extension implemented via proxy object to shield model namespace from collisions -* Convenience methods for (re)creating the index, setting up mappings, indexing documents, ... +* Convenience methods for (re)creating the index, setting up mappings, indexing documents, …​ -[discrete] -==== Usage +## Usage [_usage] Add the library to your Gemfile: -[source,ruby] ------------------------------------- +```ruby gem 'elasticsearch-rails' ------------------------------------- +``` Include the extension module in your model class: -[source,ruby] ------------------------------------- +```ruby class Article < ActiveRecord::Base include Elasticsearch::Model end ------------------------------------- +``` Import some data and perform a search: -[source,ruby] ------------------------------------- +```ruby Article.import response = Article.search 'fox dog' response.took # => 3 ------------------------------------- +``` -It is possible to either return results as model instances, or decorated -documents from {es}, with the `records` and `results` methods, respectively: +It is possible to either return results as model instances, or decorated documents from {{es}}, with the `records` and `results` methods, respectively: -[source,ruby] ------------------------------------- +```ruby response.records.first # Article Load (0.4ms) SELECT "articles".* FROM "articles" WHERE ... => #
@@ -65,8 +59,7 @@ response.results.first._score response.results.first._source.title # => "Quick brown fox" ------------------------------------- +``` + +Consult the [documentation](https://github.com/elastic/elasticsearch-rails/tree/master/elasticsearch-model) for more information. -Consult the -https://github.com/elastic/elasticsearch-rails/tree/master/elasticsearch-model[documentation] -for more information. diff --git a/docs/advanced-config.asciidoc b/docs/reference/advanced-config.md similarity index 55% rename from docs/advanced-config.asciidoc rename to docs/reference/advanced-config.md index 916a8f84c3..a05d51340c 100644 --- a/docs/advanced-config.asciidoc +++ b/docs/reference/advanced-config.md @@ -1,14 +1,16 @@ -[[advanced-config]] -=== Advanced configuration +--- +mapped_pages: + - https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/advanced-config.html +--- -The client supports many configurations options for setting up and managing -connections, configuring logging, customizing the transport library, and so on. +# Advanced configuration [advanced-config] -[discrete] -[[setting-hosts]] -==== Setting hosts +The client supports many configurations options for setting up and managing connections, configuring logging, customizing the transport library, and so on. -To connect to a specific {es} host: + +## Setting hosts [setting-hosts] + +To connect to a specific {{es}} host: ```ruby Elasticsearch::Client.new(host: 'search.myserver.com') @@ -32,12 +34,12 @@ Instead of strings, you can pass host information as an array of Hashes: Elasticsearch::Client.new(hosts: [ { host: 'myhost1', port: 8080 }, { host: 'myhost2', port: 8080 } ]) ``` -NOTE: When specifying multiple hosts, you might want to enable the -`retry_on_failure` or `retry_on_status` options to perform a failed request on -another node (refer to <>). +::::{note} +When specifying multiple hosts, you might want to enable the `retry_on_failure` or `retry_on_status` options to perform a failed request on another node (refer to [Retrying on Failures](#retry-failures)). +:::: + -Common URL parts – scheme, HTTP authentication credentials, URL prefixes, and so -on – are handled automatically: +Common URL parts – scheme, HTTP authentication credentials, URL prefixes, and so on – are handled automatically: ```ruby Elasticsearch::Client.new(url: 'https://username:password@api.server.org:4430/search') @@ -51,37 +53,25 @@ Elasticsearch::Client.new(urls: 'http://localhost:9200,http://localhost:9201') Another way to configure URLs is to export the `ELASTICSEARCH_URL` variable. -The client is automatically going to use a round-robin algorithm across the -hosts (unless you select or implement a different <>). +The client is automatically going to use a round-robin algorithm across the hosts (unless you select or implement a different [Connection Selector](#connection-selector)). -[discrete] -[[default-port]] -==== Default port +## Default port [default-port] -The default port is `9200`. Specify a port for your host(s) if they differ from -this default. +The default port is `9200`. Specify a port for your host(s) if they differ from this default. -If you are using Elastic Cloud, the default port is port `9243`. You must supply -your username and password separately, and optionally a port. Refer to -<>. +If you are using Elastic Cloud, the default port is port `9243`. You must supply your username and password separately, and optionally a port. Refer to [Elastic Cloud](/reference/connecting.md#auth-ec). -[discrete] -[[logging]] -==== Logging +## Logging [logging] -To log requests and responses to standard output with the default logger (an -instance of Ruby's `::Logger` class), set the log argument to true: +To log requests and responses to standard output with the default logger (an instance of Ruby’s `::Logger` class), set the log argument to true: ```ruby Elasticsearch::Client.new(log: true) ``` -You can also use https://github.com/elastic/ecs-logging-ruby[`ecs-logging`] -which is a set of libraries that enables you to transform your application logs -to structured logs that comply with the -https://www.elastic.co/guide/en/ecs/current/ecs-reference.html[Elastic Common Schema]. See <>. +You can also use [`ecs-logging`](https://github.com/elastic/ecs-logging-ruby) which is a set of libraries that enables you to transform your application logs to structured logs that comply with the [Elastic Common Schema](ecs://docs/reference/index.md). See [Elastic Common Schema (ECS)](/reference/ecs.md). To trace requests and responses in the Curl format, set the `trace` argument: @@ -91,11 +81,10 @@ Elasticsearch::Client.new(trace: true) You can customize the default logger or tracer: -[source,ruby] ------------------------------------- +```ruby client.transport.logger.formatter = proc { |s, d, p, m| "#{s}: #{m}\n" } client.transport.logger.level = Logger::INFO ------------------------------------- +``` Or, you can use a custom `::Logger` instance: @@ -105,8 +94,7 @@ Elasticsearch::Client.new(logger: Logger.new(STDERR)) You can pass the client any conforming logger implementation: -[source,ruby] ------------------------------------- +```ruby require 'logging' # https://github.com/TwP/logging/ log = Logging.logger['elasticsearch'] @@ -114,60 +102,42 @@ log.add_appenders Logging.appenders.stdout log.level = :info client = Elasticsearch::Client.new(logger: log) ------------------------------------- +``` -[discrete] -[[apm-integration]] -==== APM integration +## APM integration [apm-integration] -This client integrates seamlessly with Elastic APM via the Elastic APM Agent. It -automatically captures client requests if you are using the agent on your code. -If you're using `elastic-apm` v3.8.0 or up, you can set -`capture_elasticsearch_queries` to `true` in `config/elastic_apm.yml` to also -capture the body from requests in {es}. Refer to -https://github.com/elastic/elasticsearch-ruby/tree/main/docs/examples/apm[this example]. +This client integrates seamlessly with Elastic APM via the Elastic APM Agent. It automatically captures client requests if you are using the agent on your code. If you’re using `elastic-apm` v3.8.0 or up, you can set `capture_elasticsearch_queries` to `true` in `config/elastic_apm.yml` to also capture the body from requests in {{es}}. Refer to [this example](https://github.com/elastic/elasticsearch-ruby/tree/main/docs/examples/apm). -[discrete] -[[custom-http-headers]] -==== Custom HTTP Headers +## Custom HTTP Headers [custom-http-headers] -You can set a custom HTTP header on the client's initializer: +You can set a custom HTTP header on the client’s initializer: -[source,ruby] ------------------------------------- +```ruby client = Elasticsearch::Client.new( transport_options: { headers: {user_agent: "My App"} } ) ------------------------------------- +``` -You can also pass in `headers` as a parameter to any of the API Endpoints to set -custom headers for the request: +You can also pass in `headers` as a parameter to any of the API Endpoints to set custom headers for the request: ```ruby client.search(index: 'myindex', q: 'title:test', headers: {user_agent: "My App"}) ``` -[discrete] -[[x-opaque-id]] -==== Identifying running tasks with X-Opaque-Id +## Identifying running tasks with X-Opaque-Id [x-opaque-id] -The X-Opaque-Id header allows to track certain calls, or associate certain tasks -with the client that started them (refer to -https://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html#_identifying_running_tasks[the documentation]). -To use this feature, you need to set an id for `opaque_id` on the client on each -request. Example: +The X-Opaque-Id header allows to track certain calls, or associate certain tasks with the client that started them (refer to [the documentation](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks)). To use this feature, you need to set an id for `opaque_id` on the client on each request. Example: -[source,ruby] ------------------------------------- +```ruby client = Elasticsearch::Client.new client.search(index: 'myindex', q: 'title:test', opaque_id: '123456') ------------------------------------- +``` The search request includes the following HTTP Header: @@ -175,15 +145,12 @@ The search request includes the following HTTP Header: X-Opaque-Id: 123456 ``` -You can also set a prefix for X-Opaque-Id when initializing the client. This is -prepended to the id you set before each request if you're using X-Opaque-Id. -Example: +You can also set a prefix for X-Opaque-Id when initializing the client. This is prepended to the id you set before each request if you’re using X-Opaque-Id. Example: -[source,ruby] ------------------------------------- +```ruby client = Elasticsearch::Client.new(opaque_id_prefix: 'eu-west1_') client.search(index: 'myindex', q: 'title:test', opaque_id: '123456') ------------------------------------- +``` The request includes the following HTTP Header: @@ -192,12 +159,9 @@ X-Opaque-Id: eu-west1_123456 ``` -[discrete] -[[setting-timeouts]] -==== Setting Timeouts +## Setting Timeouts [setting-timeouts] -For many operations in {es}, the default timeouts of HTTP libraries are too low. -To increase the timeout, you can use the `request_timeout` parameter: +For many operations in {{es}}, the default timeouts of HTTP libraries are too low. To increase the timeout, you can use the `request_timeout` parameter: ```ruby Elasticsearch::Client.new(request_timeout: 5*60) @@ -206,42 +170,30 @@ Elasticsearch::Client.new(request_timeout: 5*60) You can also use the `transport_options` argument documented below. -[discrete] -[[randomizing-hosts]] -==== Randomizing Hosts +## Randomizing Hosts [randomizing-hosts] -If you pass multiple hosts to the client, it rotates across them in a -round-robin fashion by default. When the same client would be running in -multiple processes (for example, in a Ruby web server such as Thin), it might -keep connecting to the same nodes "at once". To prevent this, you can randomize -the hosts collection on initialization and reloading: +If you pass multiple hosts to the client, it rotates across them in a round-robin fashion by default. When the same client would be running in multiple processes (for example, in a Ruby web server such as Thin), it might keep connecting to the same nodes "at once". To prevent this, you can randomize the hosts collection on initialization and reloading: ```ruby Elasticsearch::Client.new(hosts: ['localhost:9200', 'localhost:9201'], randomize_hosts: true) ``` -[discrete] -[[retry-failures]] -==== Retrying on Failures +## Retrying on Failures [retry-failures] -When the client is initialized with multiple hosts, it makes sense to retry a -failed request on a different host: +When the client is initialized with multiple hosts, it makes sense to retry a failed request on a different host: ```ruby Elasticsearch::Client.new(hosts: ['localhost:9200', 'localhost:9201'], retry_on_failure: true) ``` -By default, the client does not retry the request. You can specify how many -times to retry before it raises an exception by passing a number to -`retry_on_failure`: +By default, the client does not retry the request. You can specify how many times to retry before it raises an exception by passing a number to `retry_on_failure`: ```ruby Elasticsearch::Client.new(hosts: ['localhost:9200', 'localhost:9201'], retry_on_failure: 5) ``` -You can also use `retry_on_status` to retry when specific status codes are -returned: +You can also use `retry_on_status` to retry when specific status codes are returned: ```ruby Elasticsearch::Client.new(hosts: ['localhost:9200', 'localhost:9201'], retry_on_status: [502, 503]) @@ -259,23 +211,18 @@ You can also set a `delay_on_retry` value in milliseconds. This will add a delay Elasticsearch::Client.new(hosts: ['localhost:9200', 'localhost:9201'], retry_on_failure: 5, delay_on_retry: 1000) ``` -[discrete] -[[reload-hosts]] -==== Reloading Hosts -{es} dynamically discovers new nodes in the cluster by default. You can leverage -this in the client, and periodically check for new nodes to spread the load. +## Reloading Hosts [reload-hosts] -To retrieve and use the information from the -https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-info.html[Nodes Info API] -on every 10,000th request: +{{es}} dynamically discovers new nodes in the cluster by default. You can leverage this in the client, and periodically check for new nodes to spread the load. + +To retrieve and use the information from the [Nodes Info API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-nodes-info) on every 10,000th request: ```ruby Elasticsearch::Client.new(hosts: ['localhost:9200', 'localhost:9201'], reload_connections: true) ``` -You can pass a specific number of requests after which reloading should be -performed: +You can pass a specific number of requests after which reloading should be performed: ```ruby Elasticsearch::Client.new(hosts: ['localhost:9200', 'localhost:9201'], reload_connections: 1_000) @@ -287,38 +234,34 @@ To reload connections on failures, use: Elasticsearch::Client.new(hosts: ['localhost:9200', 'localhost:9201'], reload_on_failure: true) ``` -The reloading timeouts if not finished under 1 second by default. To change the -setting: +The reloading timeouts if not finished under 1 second by default. To change the setting: ```ruby Elasticsearch::Client.new(hosts: ['localhost:9200', 'localhost:9201'], sniffer_timeout: 3) ``` -NOTE: When using reloading hosts ("sniffing") together with authentication, pass -the scheme, user and password with the host info – or, for more clarity, in the -`http` options: +::::{note} +When using reloading hosts ("sniffing") together with authentication, pass the scheme, user and password with the host info – or, for more clarity, in the `http` options: +:::: + -[source,ruby] ------------------------------------- +```ruby Elasticsearch::Client.new( host: 'localhost:9200', http: { scheme: 'https', user: 'U', password: 'P' }, reload_connections: true, reload_on_failure: true ) ------------------------------------- +``` -[discrete] -[[connection-selector]] -==== Connection Selector +## Connection Selector [connection-selector] By default, the client rotates the connections in a round-robin fashion, using the `Elastic::Transport::Transport::Connections::Selector::RoundRobin` strategy. -You can implement your own strategy to customize the behaviour. For example, let's have a "rack aware" strategy, which prefers the nodes with a specific attribute. The strategy uses the other nodes, only when these are unavailable: +You can implement your own strategy to customize the behaviour. For example, let’s have a "rack aware" strategy, which prefers the nodes with a specific attribute. The strategy uses the other nodes, only when these are unavailable: -[source,ruby] ------------------------------------- +```ruby class RackIdSelector include Elastic::Transport::Transport::Connections::Selector::Base @@ -331,24 +274,19 @@ class RackIdSelector end Elasticsearch::Client.new hosts: ['x1.search.org', 'x2.search.org'], selector_class: RackIdSelector ------------------------------------- +``` -[discrete] -[[serializer-implementations]] -==== Serializer Implementations +## Serializer Implementations [serializer-implementations] -By default, the https://rubygems.org/gems/multi_json[MultiJSON] library is used as the serializer implementation, and it picks up the "right" adapter based on gems available. +By default, the [MultiJSON](https://rubygems.org/gems/multi_json) library is used as the serializer implementation, and it picks up the "right" adapter based on gems available. The serialization component is pluggable, though, so you can write your own by including the `Elastic::Transport::Transport::Serializer::Base` module, implementing the required contract, and passing it to the client as the `serializer_class` or `serializer` parameter. -[discrete] -[[exception-handling]] -==== Exception Handling +## Exception Handling [exception-handling] -The library defines a -https://github.com/elastic/elastic-transport-ruby/blob/main/lib/elastic/transport/transport/errors.rb[number of exception classes] for various client and server errors, as well as unsuccessful HTTP responses, making it possible to rescue specific exceptions with desired granularity. +The library defines a [number of exception classes](https://github.com/elastic/elastic-transport-ruby/blob/main/lib/elastic/transport/transport/errors.rb) for various client and server errors, as well as unsuccessful HTTP responses, making it possible to rescue specific exceptions with desired granularity. The highest-level exception is `Elastic::Transport::Transport::Error` and is raised for any generic client or server errors. @@ -357,3 +295,4 @@ The highest-level exception is `Elastic::Transport::Transport::Error` and is rai As an example for response-specific errors, a 404 response status raises an `Elastic::Transport::Transport::Errors::NotFound` exception. Finally, `Elastic::Transport::Transport::SnifferTimeoutError` is raised when connection reloading ("sniffing") times out. + diff --git a/docs/api.asciidoc b/docs/reference/api.md similarity index 68% rename from docs/api.asciidoc rename to docs/reference/api.md index 85386c8122..261413b45c 100644 --- a/docs/api.asciidoc +++ b/docs/reference/api.md @@ -1,52 +1,49 @@ -[[api]] -=== Elasticsearch API +--- +mapped_pages: + - https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/api.html +--- -The `elasticsearch-api` library provides a Ruby implementation of the https://www.elastic.co/elastic-stack/[Elasticsearch] REST API. +# Elasticsearch API [api] -[discrete] -[[api-install]] -==== Installation +The `elasticsearch-api` library provides a Ruby implementation of the [Elasticsearch](https://www.elastic.co/elastic-stack/) REST API. -Install the package from https://rubygems.org[Rubygems]: -[source,bash] ----------------------------- +## Installation [api-install] + +Install the package from [Rubygems](https://rubygems.org): + +```bash gem install elasticsearch-api ----------------------------- +``` -To use an unreleased version, either add it to your `Gemfile` for https://bundler.io/[Bundler]: +To use an unreleased version, either add it to your `Gemfile` for [Bundler](https://bundler.io/): -[source,bash] ----------------------------- +```bash gem 'elasticsearch-api', git: 'git://github.com/elasticsearch/elasticsearch-ruby.git' ----------------------------- +``` or install it from a source code checkout: -[source,bash] ----------------------------- +```bash git clone https://github.com/elasticsearch/elasticsearch-ruby.git cd elasticsearch-ruby/elasticsearch-api bundle install rake install ----------------------------- +``` + + +## Example usage [api-example-usage] -[discrete] -[[api-example-usage]] -==== Example usage +The library is designed as a group of standalone Ruby modules, which can be mixed into a class providing connection to Elasticsearch — an Elasticsearch client. -The library is designed as a group of standalone Ruby modules, which can be mixed into a class -providing connection to Elasticsearch -- an Elasticsearch client. -[discrete] -===== Usage with the `elasticsearch` gem +### Usage with the `elasticsearch` gem [_usage_with_the_elasticsearch_gem] -**When you use the client from the https://github.com/elasticsearch/elasticsearch-ruby[`elasticsearch-ruby`] client, the library modules have been already included**, so you just call the API methods. +**When you use the client from the [`elasticsearch-ruby`](https://github.com/elasticsearch/elasticsearch-ruby) client, the library modules have been already included**, so you just call the API methods. The response will be an `Elasticsearch::API::Response` object which wraps an `Elasticsearch::Transport::Transport::Response` object. It provides `body`, `status` and `headers` methods, but you can treat is as a hash and access the keys directly. -[source,rb] ----------------------------- +```rb require 'elasticsearch' client = Elasticsearch::Client.new @@ -91,22 +88,21 @@ client.search(index: 'myindex', body: { query: { match: { title: 'test' } } }) "content-encoding"=>"gzip", "content-length"=>"188"}, @status=200>> ----------------------------- +``` -Full documentation and examples are included as RDoc annotations in the source code and available online at . +Full documentation and examples are included as RDoc annotations in the source code and available online at [http://rubydoc.info/gems/elasticsearch-api](http://rubydoc.info/gems/elasticsearch-api). -[discrete] -===== Usage with a custom client -When you want to mix the library with your own client, it must conform to the following _contract_: +### Usage with a custom client [_usage_with_a_custom_client] + +When you want to mix the library with your own client, it must conform to the following *contract*: * It responds to a `perform_request(method, path, params, body, headers)` method, * the method returns an object with `status`, `body` and `headers` methods. -A simple client could look like this (_with a dependency on `active_support` to parse the query params_): +A simple client could look like this (*with a dependency on `active_support` to parse the query params*): -[source,rb] ----------------------------- +```rb require 'multi_json' require 'faraday' require 'elasticsearch/api' @@ -151,17 +147,14 @@ p client.cluster.health p client.index(index: 'myindex', id: 'custom', body: { title: "Indexing from my client" }) # --> PUT myindex/mytype/custom {} {:title=>"Indexing from my client"} # => "{"ok":true, ... }" ----------------------------- +``` + -[discrete] -===== Using JSON Builders +### Using JSON Builders [_using_json_builders] -Instead of passing the `:body` argument as a Ruby _Hash_, you can pass it as a _String_, potentially -taking advantage of JSON builders such as https://github.com/rails/jbuilder[JBuilder] or -https://github.com/bsiggelkow/jsonify[Jsonify]: +Instead of passing the `:body` argument as a Ruby *Hash*, you can pass it as a *String*, potentially taking advantage of JSON builders such as [JBuilder](https://github.com/rails/jbuilder) or [Jsonify](https://github.com/bsiggelkow/jsonify): -[source,rb] ----------------------------- +```rb require 'jbuilder' query = Jbuilder.encode do |json| @@ -181,16 +174,14 @@ client.search(index: 'myindex', body: query) # 2013-06-25 09:56:05 +0200: > {"query":{"match":{"title":{"query":"test 1","operator":"and"}}}} # ... # => {"took"=>21, ..., "hits"=>{"total"=>1, "hits"=>[{ "_source"=>{"title"=>"Test 1", ...}}]}} ----------------------------- +``` -[discrete] -===== Using Hash Wrappers -For a more comfortable access to response properties, you may wrap it in one of the _Hash_ "object access" -wrappers, such as https://github.com/intridea/hashie[`Hashie::Mash`]: +### Using Hash Wrappers [_using_hash_wrappers] -[source,rb] ----------------------------- +For a more comfortable access to response properties, you may wrap it in one of the *Hash* "object access" wrappers, such as [`Hashie::Mash`](https://github.com/intridea/hashie): + +```rb require 'hashie' response = client.search( @@ -205,16 +196,15 @@ mash = Hashie::Mash.new(response) mash.hits.hits.first._source.title # => 'Test' ----------------------------- +``` + -[discrete] -===== Using a Custom JSON Serializer +### Using a Custom JSON Serializer [_using_a_custom_json_serializer] -The library uses the https://rubygems.org/gems/multi_json/[MultiJson] gem by default but allows you to set a custom JSON library, provided it uses the standard `load/dump` interface: +The library uses the [MultiJson](https://rubygems.org/gems/multi_json/) gem by default but allows you to set a custom JSON library, provided it uses the standard `load/dump` interface: -[source,rb] ----------------------------- +```rb Elasticsearch::API.settings[:serializer] = JrJackson::Json Elasticsearch::API.serializer.dump({foo: 'bar'}) # => {"foo":"bar"} ----------------------------- +``` diff --git a/docs/reference/basic-config.md b/docs/reference/basic-config.md new file mode 100644 index 0000000000..f7bd47df7a --- /dev/null +++ b/docs/reference/basic-config.md @@ -0,0 +1,37 @@ +--- +mapped_pages: + - https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/basic-config.html +--- + +# Basic configuration [basic-config] + +The table below contains the most important initialization parameters that you can use. + +| | | | +| --- | --- | --- | +| **Parameter** | **Data type** | **Description** | +| `adapter` | Symbol | A specific adapter for Faraday (for example, `:patron`). | +| `api_key` | String, Hash | For API key Authentication. Either the base64 encoding of `id` and `api_key` joined by a colon as a string, or a hash with the `id` and `api_key` values. | +| `compression` | Boolean | Whether to compress requests. Gzip compression is used. Defaults to `false`. Responses are automatically inflated if they are compressed. If a custom transport object is used, it must handle the request compression and response inflation. | +| `enable_meta_header` | Boolean | Whether to enable sending the meta data header to Cloud. Defaults to `true`. | +| `hosts` | String, Array | Single host passed as a string or hash, or multiple hosts passed as an array; `host` or `url` keys are also valid. | +| `log` | Boolean | Whether to use the default logger. Disabled by default. | +| `logger` | Object | An instance of a Logger-compatible object. | +| `opaque_id_prefix` | String | Sets a prefix for X-Opaque-Id when initializing the client. This is prepended to the id you set before each request if you’re using X-Opaque-Id. | +| `opentelemetry_tracer_provider` | `OpenTelemetry::Trace::TracerProvider` | An explicit TracerProvider to use instead of the global one with OpenTelemetry. This enables better dependency injection and simplifies testing. | +| `randomize_hosts` | Boolean | Whether to shuffle connections on initialization and reload. Defaults to `false`. | +| `reload_connections` | Boolean, Number | Whether to reload connections after X requests. Defaults to `false`. | +| `reload_on_failure` | Boolean | Whether to reload connections after failure. Defaults to `false`. | +| `request_timeout` | Integer | The request timeout to be passed to transport in options. | +| `resurrect_after` | Integer | Specifies after how many seconds a dead connection should be tried again. | +| `retry_on_failure` | Boolean, Number | Whether to retry X times when request fails before raising and exception. Defaults to `false`. | +| `retry_on_status` | Array, Number | Specifies which status code needs to be returned to retry. | +| `selector` | Constant | An instance of selector strategy implemented with {Elastic::Transport::Transport::Connections::Selector::Base}. | +| `send_get_body_as` | String | Specifies the HTTP method to use for GET requests with a body. Defaults to `GET`. | +| `serializer_class` | Constant | Specifies a serializer class to use. It is initialized by the transport and passed the transport instance. | +| `sniffer_timeout` | Integer | Specifies the timeout for reloading connections in seconds. Defaults to `1`. | +| `trace` | Boolean | Whether to use the default tracer. Disabled by default. | +| `tracer` | Object | Specifies an instance of a Logger-compatible object. | +| `transport` | Object | Specifies a transport instance. | +| `transport_class` | Constant | Specifies a transport class to use. It is initialized by the client and passed hosts and all arguments. | +| `transport_options` | Hash | Specifies the options to be passed to the `Faraday::Connection` constructor. | diff --git a/docs/reference/client-helpers.md b/docs/reference/client-helpers.md new file mode 100644 index 0000000000..72220c37b7 --- /dev/null +++ b/docs/reference/client-helpers.md @@ -0,0 +1,14 @@ +--- +mapped_pages: + - https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/client-helpers.html +--- + +# Client helpers [client-helpers] + +The Ruby client includes the following helpers: + +* [Bulk and Scroll helpers](/reference/Helpers.md) +* [ES|QL](/reference/esql.md) + + + diff --git a/docs/reference/configuration.md b/docs/reference/configuration.md new file mode 100644 index 0000000000..fdebc05c75 --- /dev/null +++ b/docs/reference/configuration.md @@ -0,0 +1,14 @@ +--- +mapped_pages: + - https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/ruby-config.html +--- + +# Configuration [ruby-config] + +This page contains information about how to configure the Ruby client tailored to your needs. Almost every aspect of the client is configurable. However, in most cases you only need to set a couple of parameters. + +* [Basic configuration](/reference/basic-config.md) +* [Advanced configuration](/reference/advanced-config.md) + + + diff --git a/docs/connecting.asciidoc b/docs/reference/connecting.md similarity index 57% rename from docs/connecting.asciidoc rename to docs/reference/connecting.md index 80e2acba63..8a75793639 100644 --- a/docs/connecting.asciidoc +++ b/docs/reference/connecting.md @@ -1,34 +1,28 @@ -[[connecting]] -== Connecting +--- +mapped_pages: + - https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/connecting.html +--- -This page contains the information you need to connect and use the Client with -{es}. +# Connecting [connecting] -**On this page** +This page contains the information you need to connect and use the Client with {{es}}. -* <> -* <> -* <> -* <> +## Authentication [client-auth] -[discrete] -[[client-auth]] -=== Authentication +This document contains code snippets to show you how to connect to various {{es}} providers. -This document contains code snippets to show you how to connect to various {es} providers. -[discrete] -[[auth-ec]] -==== Elastic Cloud +### Elastic Cloud [auth-ec] -If you are using https://www.elastic.co/cloud[Elastic Cloud], the client offers an easy way to connect to it. You need the Cloud ID that you can find in the cloud console, then your username and password. +If you are using [Elastic Cloud](https://www.elastic.co/cloud), the client offers an easy way to connect to it. You need the Cloud ID that you can find in the cloud console, then your username and password. -image::images/cloud_id.png["Cloud ID"] +:::{image} ../images/cloud_id.png +:alt: Cloud ID +::: Once you have collected the Cloud ID you can use the client to connect to your Elastic Cloud instance, as follows: -[source,ruby] ------------------------------------- +```ruby require 'elasticsearch' client = Elasticsearch::Client.new( @@ -36,55 +30,56 @@ client = Elasticsearch::Client.new( user: '', password: '', ) ------------------------------------- +``` You can also connect to the Cloud by using API Key authentication. You can generate an `API key` in the `Management` page under the section `Security`. -image::images/cloud_api_key.png["API key"] +:::{image} ../images/cloud_api_key.png +:alt: API key +::: When you click on `Create API key` you can choose a name and set the other options (eg. restrict privileges, expire after time, etc). -image::images/api_key_name.png["Choose an API name"] +:::{image} ../images/api_key_name.png +:alt: Choose an API name +::: -After this step you will get the `API key` in the API keys page. +After this step you will get the `API key` in the API keys page. -image::images/cloud_api_key.png["API key"] +:::{image} ../images/cloud_api_key.png +:alt: API key +::: **IMPORTANT**: you need to copy and store the `API key` in a secure place, since you will not be able to view it again in Elastic Cloud. -Once you have collected the `Cloud ID` and the `API key` you can use the client -to connect to your Elastic Cloud instance, as follows: +Once you have collected the `Cloud ID` and the `API key` you can use the client to connect to your Elastic Cloud instance, as follows: -[source,ruby] ------------------------------------- +```ruby client = Elasticsearch::Client.new( cloud_id: '', api_key: '' ) ------------------------------------- +``` If you create the API Key through the dev console or the REST API, you may get instead a pair of `id` and `APIKey` values. The client also accepts a Hash for the `api_key` parameter, so you can pass in these values and it will encode the API Key internally: -[source,ruby] ------------------------------------- +```ruby client = Elasticsearch::Client.new( cloud_id: '', api_key: {id: '', api_key: ''} ) ------------------------------------- +``` -[discrete] -[[connect-self-managed]] -=== Connecting to a self-managed cluster -{es} 8.0 offers security by default, that means authentication and TLS are enabled. +## Connecting to a self-managed cluster [connect-self-managed] -To connect to the {es} cluster you’ll need to configure the Ruby {es} client to use HTTPS with the generated CA certificate in order to make requests successfully. +{{es}} 8.0 offers security by default, that means authentication and TLS are enabled. -If you’re just getting started with {es} we recommend reading the documentation on configuring and starting {es} to ensure your cluster is running as expected. +To connect to the {{es}} cluster you’ll need to configure the Ruby {{es}} client to use HTTPS with the generated CA certificate in order to make requests successfully. -When you start {es} for the first time you’ll see a distinct block like the one below in the output from {es} (you may have to scroll up if it’s been a while): +If you’re just getting started with {{es}} we recommend reading the documentation on configuring and starting {{es}} to ensure your cluster is running as expected. +When you start {{es}} for the first time you’ll see a distinct block like the one below in the output from {{es}} (you may have to scroll up if it’s been a while): ```sh ---------------------------------------------------------------- @@ -105,31 +100,25 @@ Note down the `elastic` user password and HTTP CA fingerprint for the next secti Depending on the circumstances there are two options for verifying the HTTPS connection, either verifying with the CA certificate itself or via the HTTP CA certificate fingerprint. -[discrete] -[[ca-certificates]] -==== Verifying HTTPS with CA certificates +### Verifying HTTPS with CA certificates [ca-certificates] -The generated root CA certificate can be found in the `certs` directory in your {es} config location (`$ES_CONF_PATH/certs/http_ca.crt`). If you're running {es} in Docker there is https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html[additional documentation for retrieving the CA certificate]. +The generated root CA certificate can be found in the `certs` directory in your {{es}} config location (`$ES_CONF_PATH/certs/http_ca.crt`). If you’re running {{es}} in Docker there is [additional documentation for retrieving the CA certificate](docs-content://deploy-manage/deploy/self-managed/install-elasticsearch-with-docker.md). Once you have the `http_ca.crt` file somewhere accessible pass the path to the client via `ca_certs`: -[source,ruby] ------------------------------------- +```ruby client = Elasticsearch::Client.new( host: "https://elastic/#{ELASTIC_PASSWORD}@localhost:9200", transport_options: { ssl: { ca_path: CERT_DIR } } ) ------------------------------------- +``` -[discrete] -[[ca-fingerprint]] -==== Verifying HTTPS with certificate fingerprints +### Verifying HTTPS with certificate fingerprints [ca-fingerprint] -This method of verifying the HTTPS connection takes advantage of the certificate fingerprint value noted down earlier. Take this SHA256 fingerprint value and pass it to the Ruby {es} client via `ca_fingerprint`: +This method of verifying the HTTPS connection takes advantage of the certificate fingerprint value noted down earlier. Take this SHA256 fingerprint value and pass it to the Ruby {{es}} client via `ca_fingerprint`: -[source,ruby] ------------------------------------- +```ruby # Colons and uppercase/lowercase don't matter when using # the 'ca_fingerprint' parameter CERT_FINGERPRINT = '64F2593F...' @@ -142,77 +131,65 @@ client = Elasticsearch::Client.new( transport_options: { ssl: { verify: false } }, ca_fingerprint: CERT_FINGERPRINT ) ------------------------------------- +``` The verification will be run once per connection. - The certificate fingerprint can be calculated using `openssl x509` with the certificate file: -[source,sh] ----- +```sh openssl x509 -fingerprint -sha256 -noout -in /path/to/http_ca.crt ----- +``` -If you don't have access to the generated CA file from {es} you can use the following script to output the root CA fingerprint of the {es} instance with `openssl s_client`: +If you don’t have access to the generated CA file from {{es}} you can use the following script to output the root CA fingerprint of the {{es}} instance with `openssl s_client`: -[source,sh] ----- +```sh # Replace the values of 'localhost' and '9200' to the # corresponding host and port values for the cluster. openssl s_client -connect localhost:9200 -servername localhost -showcerts /dev/null \ | openssl x509 -fingerprint -sha256 -noout -in /dev/stdin ----- +``` The output of `openssl x509` will look something like this: -[source,sh] ----- +```sh SHA256 Fingerprint=A5:2D:D9:35:11:E8:C6:04:5E:21:F1:66:54:B7:7C:9E:E0:F3:4A:EA:26:D9:F4:03:20:B5:31:C4:74:67:62:28 ----- - +``` +### API Key authentication [auth-api-key] -[discrete] -[[auth-api-key]] -==== API Key authentication +You can also use [ApiKey](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key) authentication. -You can also use https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html[ApiKey] authentication. +::::{note} +If you provide both basic authentication credentials and the ApiKey configuration, the ApiKey takes precedence. +:::: -NOTE: If you provide both basic authentication credentials and the ApiKey configuration, the ApiKey takes precedence. -[source,ruby] ------------------------------------- +```ruby Elasticsearch::Client.new( host: host, transport_options: transport_options, api_key: credentials ) ------------------------------------- +``` -Where credentials is either the base64 encoding of `id` and `api_key` joined by -a colon or a hash with the `id` and `api_key`: +Where credentials is either the base64 encoding of `id` and `api_key` joined by a colon or a hash with the `id` and `api_key`: -[source,ruby] ------------------------------------- +```ruby Elasticsearch::Client.new( host: host, transport_options: transport_options, api_key: {id: 'my_id', api_key: 'my_api_key'} ) ------------------------------------- +``` -[discrete] -[[auth-basic]] -==== Basic authentication +### Basic authentication [auth-basic] -You can pass the authentication credentials, scheme and port in the host -configuration hash: +You can pass the authentication credentials, scheme and port in the host configuration hash: -[source,ruby] ------------------------------------- +```ruby client = Elasticsearch::Client.new( hosts: [ @@ -225,36 +202,31 @@ client = Elasticsearch::Client.new( } ] ) ------------------------------------- +``` Or use the common URL format: -[source,ruby] ------------------------------------- +```ruby client = Elasticsearch::Client.new(url: 'https://username:password@localhost:9200/') ------------------------------------- +``` -To pass a custom certificate for SSL peer verification to Faraday-based clients, -use the `transport_options` option: +To pass a custom certificate for SSL peer verification to Faraday-based clients, use the `transport_options` option: -[source,ruby] ------------------------------------- +```ruby Elasticsearch::Client.new( url: 'https://username:password@localhost:9200/', transport_options: { ssl: { ca_file: '/path/to/http_ca.crt' } } ) ------------------------------------- +``` + -[discrete] -[[client-usage]] -=== Usage +## Usage [client-usage] The following snippet shows an example of using the Ruby client: -[source,ruby] ------------------------------------- +```ruby require 'elasticsearch' client = Elasticsearch::Client.new log: true @@ -266,20 +238,17 @@ client.index(index: 'my-index', id: 1, body: { title: 'Test' }) client.indices.refresh(index: 'my-index') client.search(index: 'my-index', body: { query: { match: { title: 'test' } } }) ------------------------------------- +``` + +## Using the Client in a Function-as-a-Service Environment [client-faas] -[discrete] -[[client-faas]] -=== Using the Client in a Function-as-a-Service Environment +This section illustrates the best practices for leveraging the {{es}} client in a Function-as-a-Service (FaaS) environment. The most influential optimization is to initialize the client outside of the function, the global scope. This practice does not only improve performance but also enables background functionality as – for example – sniffing. The following examples provide a skeleton for the best practices. -This section illustrates the best practices for leveraging the {es} client in a Function-as-a-Service (FaaS) environment. The most influential optimization is to initialize the client outside of the function, the global scope. This practice does not only improve performance but also enables background functionality as – for example – sniffing. The following examples provide a skeleton for the best practices. -[discrete] -==== GCP Cloud Functions +### GCP Cloud Functions [_gcp_cloud_functions] -[source,ruby] ------------------------------------- +```ruby require 'functions_framework' require 'elasticsearch' @@ -304,13 +273,12 @@ FunctionsFramework.http "hello_world" do |request| } ) end ------------------------------------- +``` -[discrete] -==== AWS Lambda -[source,ruby] ------------------------------------- +### AWS Lambda [_aws_lambda] + +```ruby require 'elasticsearch' def client @@ -336,17 +304,16 @@ def lambda_handler(event:, context:) } ) end ------------------------------------- +``` Resources used to assess these recommendations: -* https://cloud.google.com/functions/docs/bestpractices/tips#use_global_variables_to_reuse_objects_in_future_invocations[GCP Cloud Functions: Tips & Tricks] -* https://docs.aws.amazon.com/lambda/latest/dg/best-practices.html[Best practices for working with AWS Lambda functions] +* [GCP Cloud Functions: Tips & Tricks](https://cloud.google.com/functions/docs/bestpractices/tips#use_global_variables_to_reuse_objects_in_future_invocations) +* [Best practices for working with AWS Lambda functions](https://docs.aws.amazon.com/lambda/latest/dg/best-practices.md) + -[discrete] -[[client-comp]] -=== Enabling the Compatibility Mode +## Enabling the Compatibility Mode [client-comp] The Elasticsearch server version 8.0 is introducing a new compatibility mode that allows you a smoother upgrade experience from 7 to 8. In a nutshell, you can use the latest 7.x Elasticsearch client with an 8.x Elasticsearch server, giving more room to coordinate the upgrade of your codebase to the next major version. -If you want to leverage this functionality, please make sure that you are using the latest 7.x client and set the environment variable `ELASTIC_CLIENT_APIVERSIONING` to `true`. The client is handling the rest internally. For every 8.0 and beyond client, you're all set! The compatibility mode is enabled by default. +If you want to leverage this functionality, please make sure that you are using the latest 7.x client and set the environment variable `ELASTIC_CLIENT_APIVERSIONING` to `true`. The client is handling the rest internally. For every 8.0 and beyond client, you’re all set! The compatibility mode is enabled by default. diff --git a/docs/reference/dsl.md b/docs/reference/dsl.md new file mode 100644 index 0000000000..af686223d1 --- /dev/null +++ b/docs/reference/dsl.md @@ -0,0 +1,11 @@ +--- +mapped_pages: + - https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/dsl.html +--- + +# Elasticsearch DSL [dsl] + +The [elasticsearch-dsl](https://github.com/elastic/elasticsearch-dsl-ruby) gem provides a Ruby API for the [Elasticsearch Query DSL](https://www.elasticsearch.com/guide/en/elasticsearch/reference/current/query-dsl.md). The library allows to programmatically build complex search definitions for {{es}} in Ruby, which are translated to Hashes, and ultimately, JSON, the language of {{es}}. + +See [the README](https://github.com/elastic/elasticsearch-dsl-ruby#elasticsearchdsl) for more information. + diff --git a/docs/reference/ecs.md b/docs/reference/ecs.md new file mode 100644 index 0000000000..65100ebe4a --- /dev/null +++ b/docs/reference/ecs.md @@ -0,0 +1,37 @@ +--- +mapped_pages: + - https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/ecs.html +--- + +# Elastic Common Schema (ECS) [ecs] + +The [Elastic Common Schema (ECS)][Elastic Common Schema (ECS)](ecs://docs/reference/index.md)) is an open source format that defines a common set of fields to be used when storing event data like logs in Elasticsearch. + +You can use the library [ecs-logging](https://github.com/elastic/ecs-logging-ruby) which is a set of libraries that enables you to transform your application logs to structured logs that comply with the ECS format. + +Add this line to your application’s Gemfile: + +```ruby +gem 'ecs-logging' +``` + +Then execute `bundle install`. Or install from the command line yourself: + +```ruby +$ gem install ecs-logging +``` + +Then configure the client to use the logger: + +```ruby +require 'ecs_logging/logger' +require 'elasticsearch' + +logger = EcsLogging::Logger.new($stdout) +client = Elasticsearch::Client.new(logger: logger) +> client.info +{"@timestamp":"2022-07-12T05:31:18.590Z","log.level":"INFO","message":"GET http://localhost:9200/ [status:200, request:0.009s, query:n/a]","ecs.version":"1.4.0"}... +``` + +See [ECS Logging Ruby Reference](ecs-logging-ruby://docs/reference/index.md) for more information on how to configure the logger. + diff --git a/docs/helpers/esql.asciidoc b/docs/reference/esql.md similarity index 72% rename from docs/helpers/esql.asciidoc rename to docs/reference/esql.md index 9a310911b5..6fea4bcdd9 100644 --- a/docs/helpers/esql.asciidoc +++ b/docs/reference/esql.md @@ -1,36 +1,29 @@ -[[esql]] -=== ES|QL in the Ruby client -++++ -ES|QL -++++ +--- +navigation_title: "ES|QL" +mapped_pages: + - https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/esql.html +--- -This page helps you understand and use {ref}/esql.html[ES|QL] in the -Ruby client. +# ES|QL in the Ruby client [esql] + + +This page helps you understand and use [ES|QL](docs-content://explore-analyze/query-filter/languages/esql.md) in the Ruby client. There are two ways to use ES|QL in the Ruby client: -* Use the Elasticsearch {es-docs}/esql-apis.html[ES|QL API] directly: This -is the most flexible approach, but it's also the most complex because you must handle -results in their raw form. You can choose the precise format of results, -such as JSON, CSV, or text. -* Use the Ruby ES|QL helper: The helper maps the raw response to an object that's -more readily usable by your application. +* Use the Elasticsearch [ES|QL API](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-esql) directly: This is the most flexible approach, but it’s also the most complex because you must handle results in their raw form. You can choose the precise format of results, such as JSON, CSV, or text. +* Use the Ruby ES|QL helper: The helper maps the raw response to an object that’s more readily usable by your application. -[discrete] -[[esql-how-to]] -==== ES|QL API +## ES|QL API [esql-how-to] -The {es-docs}/esql-query-api.html[ES|QL query API] allows you to specify how -results should be returned. You can choose a -{es-docs}/esql-rest.html#esql-rest-format[response format] such as CSV, text, or -JSON, then fine-tune it with parameters like column separators and locale. +The [ES|QL query API](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-esql) allows you to specify how results should be returned. You can choose a [response format](docs-content://explore-analyze/query-filter/languages/esql-rest.md#esql-rest-format) such as CSV, text, or JSON, then fine-tune it with parameters like column separators and locale. By default, the `query` API returns a Hash response with `columns` and `values`: -[[esql-query]] -[source,ruby] ----- +$$$esql-query$$$ + +```ruby query = <>, the helper returns -the following: +The helper returns an array of hashes with the columns as keys and the respective values. Using the [preceding example](#esql-query), the helper returns the following: -[source,ruby] ----- +```ruby response = Elasticsearch::Helpers::ESQLHelper.query(client, query) puts response @@ -87,15 +73,11 @@ puts response {"duration_ms"=>1.2, "message"=>"Disconnected", "event.duration"=>1232382, "client.ip"=>"172.21.0.5", "@timestamp"=>"2023-10-23T13:33:34.937Z"} {"duration_ms"=>0.7, "message"=>"Connection error", "event.duration"=>725448, "client.ip"=>"172.21.3.15", "@timestamp"=>"2023-10-23T13:51:54.732Z"} {"duration_ms"=>8.3, "message"=>"Connection error", "event.duration"=>8268153, "client.ip"=>"172.21.3.15", "@timestamp"=>"2023-10-23T13:52:55.015Z"} ----- +``` -Additionally, you can transform the data in the response by passing in a Hash -of `column => Proc` values. You could use this for example to convert -'@timestamp' into a DateTime object. Pass in a Hash to `query` as a `parser` -defining a `Proc` for each value you'd like to parse: +Additionally, you can transform the data in the response by passing in a Hash of `column => Proc` values. You could use this for example to convert *@timestamp* into a DateTime object. Pass in a Hash to `query` as a `parser` defining a `Proc` for each value you’d like to parse: -[source,ruby] ----- +```ruby require 'elasticsearch/helpers/esql_helper' parser = { @@ -104,12 +86,11 @@ parser = { response = Elasticsearch::Helpers::ESQLHelper.query(client, query, parser: parser) response.first['@timestamp'] # ----- +``` You can pass in as many Procs as there are columns in the response. For example: -[source,ruby] ----- +```ruby parser = { '@timestamp' => Proc.new { |t| DateTime.parse(t) }, 'client.ip' => Proc.new { |i| IPAddr.new(i) }, @@ -125,4 +106,5 @@ puts response {"duration_ms"=>1.2, "message"=>"Disconnected", "event.duration"=>"1232382", "client.ip"=>#, "@timestamp"=>#} {"duration_ms"=>0.7, "message"=>"Connection error", "event.duration"=>"725448", "client.ip"=>#, "@timestamp"=>#} {"duration_ms"=>8.3, "message"=>"Connection error", "event.duration"=>"8268153", "client.ip"=>#, "@timestamp"=>#} ----- +``` + diff --git a/docs/examples.asciidoc b/docs/reference/examples.md similarity index 82% rename from docs/examples.asciidoc rename to docs/reference/examples.md index 22e9619505..75e850cfbc 100644 --- a/docs/examples.asciidoc +++ b/docs/reference/examples.md @@ -1,26 +1,26 @@ -[[examples]] -== Examples +--- +mapped_pages: + - https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/examples.html +--- -Below you can find examples of how to use the most frequently called APIs with -the Ruby client. +# Examples [examples] -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> +Below you can find examples of how to use the most frequently called APIs with the Ruby client. +* [Indexing a document](#ex-index) +* [Getting a document](#ex-get) +* [Updating a document](#ex-update) +* [Deleting a document](#ex-delete) +* [Bulk requests](#ex-bulk) +* [Searching for a document](#ex-search) +* [Multi search](#ex-multisearch) +* [Scrolling](#ex-scroll) +* [Reindexing](#ex-reindex) -[discrete] -[[ex-index]] -=== Indexing a document -Let's index a document with the following fields: `name`, `author`, -`release_date`, and `page_count`: +## Indexing a document [ex-index] + +Let’s index a document with the following fields: `name`, `author`, `release_date`, and `page_count`: ```ruby body = { @@ -34,9 +34,7 @@ client.index(index: 'books', body: body) ``` -[discrete] -[[ex-get]] -=== Getting a document +## Getting a document [ex-get] You can get a document by ID: @@ -46,9 +44,7 @@ client.get(index: 'books', id: id) ``` -[discrete] -[[ex-update]] -=== Updating a document +## Updating a document [ex-update] Assume you have the following document: @@ -65,9 +61,7 @@ client.update(index: 'books', id: id, body: { doc: { page_count: 225 } }) ``` -[discrete] -[[ex-delete]] -=== Deleting a document +## Deleting a document [ex-delete] You can delete a document by ID: @@ -77,13 +71,9 @@ client.delete(index: 'books', id: id) ``` -[discrete] -[[ex-bulk]] -=== Bulk requests +## Bulk requests [ex-bulk] -The `bulk` operation of the client supports various different formats of the -payload: array of strings, header/data pairs, or the combined format where data -is passed along with the header in a single item in a custom `:data` key. +The `bulk` operation of the client supports various different formats of the payload: array of strings, header/data pairs, or the combined format where data is passed along with the header in a single item in a custom `:data` key. Index several documents in one request: @@ -109,8 +99,7 @@ body = [ client.bulk(body: body) ``` -As mentioned, you can perform several operations in a single request with the -combined format passing data in the `:data` option: +As mentioned, you can perform several operations in a single request with the combined format passing data in the `:data` option: ```ruby body = [ @@ -122,17 +111,13 @@ client.bulk(body: body) ``` -[discrete] -[[ex-search]] -=== Searching for a document +## Searching for a document [ex-search] -This example uses the same data that is used in the -https://www.elastic.co/guide/en/elasticsearch/reference/current/find-structure.html#find-structure-example-nld-json[Find structure API documentation]. +This example uses the same data that is used in the [Find structure API documentation](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-text-structure-find-structure). First, bulk index it: -[source,ruby] ----- +```ruby body = [ { index: { _index: 'books', data: { name: 'Leviathan Wakes', author: 'James S.A. Corey', release_date: '2011-06-02', page_count: 561 } } }, { index: { _index: 'books', data: { name: 'Hyperion', author: 'Dan Simmons', release_date: '1989-05-26', page_count: 482 } } }, @@ -160,10 +145,9 @@ body = [ { index: { _index: 'books', data: { name: 'The Moon is a Harsh Mistress', author: 'Robert A. Heinlein', release_date: '1966-04-01', page_count: 288 } } } ] client.bulk(body: body) ----- +``` -The `field` parameter is a common parameter, so it can be passed in directly in -the following way: +The `field` parameter is a common parameter, so it can be passed in directly in the following way: ```ruby client.search(index: 'books', q: 'dune') @@ -178,10 +162,10 @@ response['hits']['hits'].count # => 15 ``` -[discrete] -[[ex-multisearch]] -=== Multi search +## Multi search [ex-multisearch] + The following example shows how to perform a multisearch API call on `books` index: + ```ruby body = [ {}, @@ -192,12 +176,10 @@ body = [ client.msearch(index:'books', body: body) ``` -[discrete] -[[ex-scroll]] -=== Scrolling -Submit a search API request that includes an argument for the scroll query -parameter, save the search ID, then print out the book names you found: +## Scrolling [ex-scroll] + +Submit a search API request that includes an argument for the scroll query parameter, save the search ID, then print out the book names you found: ```ruby # Search request with a scroll argument: @@ -214,13 +196,11 @@ end ``` -[discrete] -[[ex-reindex]] -=== Reindexing +## Reindexing [ex-reindex] -The following example shows how to reindex the `books` index into a new index -called `books-reindexed`: +The following example shows how to reindex the `books` index into a new index called `books-reindexed`: ```ruby client.reindex(body: {source: { index: 'books'}, dest: {index: 'books-reindexed' } }) ``` + diff --git a/docs/reference/getting-started.md b/docs/reference/getting-started.md new file mode 100644 index 0000000000..41920656aa --- /dev/null +++ b/docs/reference/getting-started.md @@ -0,0 +1,125 @@ +--- +mapped_pages: + - https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/getting-started-ruby.html + - https://www.elastic.co/guide/en/serverless/current/elasticsearch-ruby-client-getting-started.html +--- + +# Getting started [getting-started-ruby] + +This page guides you through the installation process of the Ruby client, shows you how to instantiate the client, and how to perform basic Elasticsearch operations with it. + + +### Requirements [_requirements] + +A currently maintained version of Ruby (3.0+) or JRuby (9.3+). + + +### Installation [_installation] + +To install the latest version of the client, run the following command: + +```shell +gem install elasticsearch +``` + +Refer to the [*Installation*](/reference/installation.md) page to learn more. + + +### Connecting [_connecting] + +You can connect to the Elastic Cloud using an API key and the Elasticsearch endpoint. + +```rb +client = Elasticsearch::Client.new( + cloud_id: '', + api_key: '' +) +``` + +Your Elasticsearch endpoint can be found on the **My deployment** page of your deployment: + +:::{image} ../images/es_endpoint.jpg +:alt: Finding Elasticsearch endpoint +::: + +You can generate an API key on the **Management** page under Security. + +:::{image} ../images/create_api_key.png +:alt: Create API key +::: + +For other connection options, refer to the [*Connecting*](/reference/connecting.md) section. + + +### Operations [_operations] + +Time to use Elasticsearch! This section walks you through the basic, and most important, operations of Elasticsearch. For more operations and more advanced examples, refer to the [*Examples*](/reference/examples.md) page. + + +#### Creating an index [_creating_an_index] + +This is how you create the `my_index` index: + +```rb +client.indices.create(index: 'my_index') +``` + + +#### Indexing documents [_indexing_documents] + +This is a simple way of indexing a document: + +```rb +document = { name: 'elasticsearch-ruby' } +response = client.index(index: 'my_index', body: document) +# You can get the indexed document id with: +response['_id'] +=> "PlgIDYkBWS9Ngdx5IMy-" +id = response['_id'] +``` + + +#### Getting documents [_getting_documents] + +You can get documents by using the following code: + +```rb +client.get(index: 'my_index', id: id) +``` + + +#### Searching documents [_searching_documents] + +This is how you can create a single match query with the Ruby client: + +```rb +client.search(index: 'my_index', body: { query: { match_all: {} } }) +``` + + +#### Updating documents [_updating_documents] + +This is how you can update a document, for example to add a new field: + +```rb +client.update(index: 'my_index', id: id, body: { doc: { language: 'Ruby' } }) +``` + + +#### Deleting documents [_deleting_documents] + +```rb +client.delete(index: 'my_index', id: id) +``` + + +#### Deleting an index [_deleting_an_index] + +```rb +client.indices.delete(index: 'my_index') +``` + + +## Further reading [_further_reading] + +* Use [Bulk and Scroll helpers](/reference/Helpers.md) for a more confortable experience with the APIs. diff --git a/docs/reference/index.md b/docs/reference/index.md new file mode 100644 index 0000000000..088cd04b9b --- /dev/null +++ b/docs/reference/index.md @@ -0,0 +1,40 @@ +--- +mapped_pages: + https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/index.html + - https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/ruby_client.html +--- + +# Ruby [ruby_client] + +The `elasticsearch` [Rubygem](http://rubygems.org/gems/elasticsearch) provides a low-level client for communicating with an {{es}} cluster, fully compatible with other official clients. + +More documentation is hosted in [Github](https://github.com/elastic/elasticsearch-ruby) and [RubyDoc](http://rubydoc.info/gems/elasticsearch). + +Refer to the [*Getting started*](/reference/getting-started.md) page for a step-by-step quick start with the Ruby client. + + +## Features [_features] + +* Pluggable logging and tracing +* Pluggable connection selection strategies (round-robin, random, custom) +* Pluggable transport implementation, customizable and extendable +* Pluggable serializer implementation +* Request retries and dead connections handling +* Node reloading (based on cluster state) on errors or on demand +* Modular API implementation +* 100% REST API coverage + + +## Transport and API [transport-api] + +The `elasticsearch` gem combines two separate Rubygems: + +* [`elastic-transport`](https://github.com/elastic/elastic-transport-ruby/) - provides an HTTP Ruby client for connecting to the {{es}} cluster. Refer to the documentation: [Transport](/reference/transport.md) +* [`elasticsearch-api`](https://github.com/elastic/elasticsearch-ruby/tree/main/elasticsearch-api) - provides a Ruby API for the {{es}} RESTful API. + +Please consult their respective documentation for configuration options and technical details. + +Notably, the documentation and comprehensive examples for all the API methods are contained in the source, and available online at [Rubydoc](http://rubydoc.info/gems/elasticsearch-api/Elasticsearch/API/Actions). + +Keep in mind, that for optimal performance, you should use an HTTP library which supports persistent ("keep-alive") HTTP connections. + diff --git a/docs/reference/installation.md b/docs/reference/installation.md new file mode 100644 index 0000000000..73048cfa0d --- /dev/null +++ b/docs/reference/installation.md @@ -0,0 +1,44 @@ +--- +mapped_pages: + - https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/ruby-install.html +--- + +# Installation [ruby-install] + +Install the Rubygem for the latest {{es}} version by using the following command: + +```sh +gem install elasticsearch +``` + +Or add the `elasticsearch` Ruby gem to your Gemfile: + +```ruby +gem 'elasticsearch' +``` + +You can install the Ruby gem for a specific {{es}} version by using the following command: + +```sh +gem install elasticsearch -v 7.0.0 +``` + +Or you can add a specific version of {{es}} to your Gemfile: + +```ruby +gem 'elasticsearch', '~> 7.0' +``` + + +## {{es}} and Ruby version compatibility [_es_and_ruby_version_compatibility] + +The {{es}} client is compatible with currently maintained Ruby versions. We follow Ruby’s own maintenance policy and officially support all currently maintained versions per [Ruby Maintenance Branches](https://www.ruby-lang.org/en/downloads/branches/). + +Language clients are forward compatible; meaning that clients support communicating with greater or equal minor versions of {{es}} without breaking. It does not mean that the client automatically supports new features of newer {{es}} versions; it is only possible after a release of a new client version. For example, a 8.12 client version won’t automatically support the new features of the 8.13 version of {{es}}, the 8.13 client version is required for that. {{es}} language clients are only backwards compatible with default distributions and without guarantees made. + +| Gem Version | | {{es}} Version | Supported | +| --- | --- | --- | --- | +| 7.x | → | 7.x | 7.17 | +| 8.x | → | 8.x | 8.x | +| main | → | main | | + diff --git a/docs/reference/integrations.md b/docs/reference/integrations.md new file mode 100644 index 0000000000..2b54bab453 --- /dev/null +++ b/docs/reference/integrations.md @@ -0,0 +1,26 @@ +--- +mapped_pages: + - https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/integrations.html +--- + +# Integrations [integrations] + +The Rubygems listed on this page make it easier to operate with {{es}} by using the Ruby client. + +* [Transport](/reference/transport.md) +* [Elasticsearch API](/reference/api.md) +* [Using OpenTelemetry](/reference/opentelemetry.md) +* [Elastic Common Schema (ECS)](/reference/ecs.md) +* [ActiveModel / ActiveRecord](/reference/activemodel_activerecord.md) +* [Ruby On Rails](/reference/ruby_on_rails.md) +* [Persistence](/reference/persistence.md) +* [Elasticsearch DSL](/reference/dsl.md) + + + + + + + + + diff --git a/docs/reference/opentelemetry.md b/docs/reference/opentelemetry.md new file mode 100644 index 0000000000..ccc4863a8c --- /dev/null +++ b/docs/reference/opentelemetry.md @@ -0,0 +1,97 @@ +--- +mapped_pages: + - https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/opentelemetry.html +--- + +# Using OpenTelemetry [opentelemetry] + +You can use [OpenTelemetry](https://opentelemetry.io/) to monitor the performance and behavior of your {{es}} requests through the Ruby Client. The Ruby Client comes with built-in OpenTelemetry instrumentation that emits [distributed tracing spans](docs-content://solutions/observability/apps/traces-2.md) by default. With that, applications [instrumented with OpenTelemetry](https://opentelemetry.io/docs/instrumentation/ruby/manual/) or using the [OpenTelemetry Ruby SDK](https://opentelemetry.io/docs/instrumentation/ruby/automatic/) are inherently enriched with additional spans that contain insightful information about the execution of the {{es}} requests. + +The native instrumentation in the Ruby Client follows the [OpenTelemetry Semantic Conventions for {{es}}](https://opentelemetry.io/docs/specs/semconv/database/elasticsearch/). In particular, the instrumentation in the client covers the logical layer of {{es}} requests. A single span per request is created that is processed by the service through the Ruby Client. The following image shows a trace that records the handling of two different {{es}} requests: a `ping` request and a `search` request. + +:::{image} ../images/otel-waterfall-without-http.png +:alt: Distributed trace with Elasticsearch spans +:class: screenshot +::: + +Usually, OpenTelemetry auto-instrumentation modules come with instrumentation support for HTTP-level communication. In this case, in addition to the logical {{es}} client requests, spans will be captured for the physical HTTP requests emitted by the client. The following image shows a trace with both, {{es}} spans (in blue) and the corresponding HTTP-level spans (in red): + +:::{image} ../images/otel-waterfall-with-http.png +:alt: Distributed trace with Elasticsearch spans +:class: screenshot +::: + +Advanced Ruby Client behavior such as nodes round-robin and request retries are revealed through the combination of logical {{es}} spans and the physical HTTP spans. The following example shows a `search` request in a scenario with two nodes: + +:::{image} ../images/otel-waterfall-retry.png +:alt: Distributed trace with Elasticsearch spans +:class: screenshot +::: + +The first node is unavailable and results in an HTTP error, while the retry to the second node succeeds. Both HTTP requests are subsumed by the logical {{es}} request span (in blue). + + +## Setup the OpenTelemetry instrumentation [_setup_the_opentelemetry_instrumentation] + +When using the [OpenTelemetry Ruby SDK manually](https://opentelemetry.io/docs/instrumentation/ruby/manual) or using the [OpenTelemetry Ruby Auto-Instrumentations](https://opentelemetry.io/docs/instrumentation/ruby/automatic/), the Ruby Client’s OpenTelemetry instrumentation is enabled by default and uses the global OpenTelemetry SDK with the global tracer provider. You can provide a tracer provider via the Ruby Client configuration option `opentelemetry_tracer_provider` when instantiating the client. This is sometimes useful for testing or other specific use cases. + +```ruby +client = Elasticsearch::Client.new( + cloud_id: '', + api_key: '', + opentelemetry_tracer_provider: tracer_provider +) +``` + + +## Configuring the OpenTelemetry instrumentation [_configuring_the_opentelemetry_instrumentation] + +You can configure the OpenTelemetry instrumentation through Environment Variables. The following configuration options are available. + + +### Enable / Disable the OpenTelemetry instrumentation [opentelemetry-config-enable] + +With this configuration option you can enable (default) or disable the built-in OpenTelemetry instrumentation. + +**Default:** `true` + +| | | +| --- | --- | +| Environment Variable | `OTEL_RUBY_INSTRUMENTATION_ELASTICSEARCH_ENABLED` | + + +### Capture search request bodies [_capture_search_request_bodies] + +Per default, the built-in OpenTelemetry instrumentation does not capture request bodies due to data privacy considerations. You can use this option to enable capturing of search queries from the request bodies of {{es}} search requests in case you wish to gather this information regardless. The options are to capture the raw search query, sanitize the query with a default list of sensitive keys, or not capture it at all. + +**Default:** `omit` + +**Valid Options:** `omit`, `sanitize`, `raw` + +| | | +| --- | --- | +| Environment Variable | `OTEL_RUBY_INSTRUMENTATION_ELASTICSEARCH_CAPTURE_SEARCH_QUERY` | + + +### Sanitize the {{es}} search request body [_sanitize_the_es_search_request_body] + +You can configure the list of keys whose values are redacted when the search query is captured. Values must be comma-separated. Note in v8.3.0 and v8.3.1, the environment variable `OTEL_INSTRUMENTATION_ELASTICSEARCH_CAPTURE_SEARCH_QUERY` was available but is now deprecated in favor of the environment variable including `RUBY`. + +**Default:** `nil` + +| | | +| --- | --- | +| Environment Variable | `OTEL_RUBY_INSTRUMENTATION_ELASTICSEARCH_SEARCH_QUERY_SANITIZE_KEYS` | + +Example: + +```bash +OTEL_RUBY_INSTRUMENTATION_ELASTICSEARCH_SEARCH_QUERY_SANITIZE_KEYS='sensitive-key,other-sensitive-key' +``` + + +## Overhead [_overhead] + +The OpenTelemetry instrumentation (as any other monitoring approach) may come with a slight overhead on CPU, memory, and/or latency. The overhead may only occur when the instrumentation is enabled (default) and an OpenTelemetry SDK is active in the target application. When the instrumentation is disabled or no OpenTelemetry SDK is active within the target application, monitoring overhead is not expected when using the client. + +Even in cases where the instrumentation is enabled and is actively used (by an OpenTelemetry SDK), the overhead is minimal and negligible in the vast majority of cases. In edge cases where there is a noticeable overhead, the [instrumentation can be explicitly disabled](#opentelemetry-config-enable) to eliminate any potential impact on performance. diff --git a/docs/persistence.asciidoc b/docs/reference/persistence.md similarity index 56% rename from docs/persistence.asciidoc rename to docs/reference/persistence.md index 8567a723cf..2bb497a96b 100644 --- a/docs/persistence.asciidoc +++ b/docs/reference/persistence.md @@ -1,42 +1,37 @@ -[[persistence]] -=== Persistence +--- +mapped_pages: + - https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/persistence.html +--- -The `elasticsearch-persistence` -http://rubygems.org/gems/elasticsearch-persistence[Rubygem] provides persistence -layer for Ruby domain objects. +# Persistence [persistence] -It supports the repository design patterns. Versions before 6.0 also supported -the _active record_ design pattern. +The `elasticsearch-persistence` [Rubygem](http://rubygems.org/gems/elasticsearch-persistence) provides persistence layer for Ruby domain objects. +It supports the repository design patterns. Versions before 6.0 also supported the *active record* design pattern. -[discrete] -==== Repository -The `Elasticsearch::Persistence::Repository` module provides an implementation -of the repository pattern and allows to save, delete, find and search objects -stored in {es}, as well as configure mappings and settings for the index. +## Repository [_repository] +The `Elasticsearch::Persistence::Repository` module provides an implementation of the repository pattern and allows to save, delete, find and search objects stored in {{es}}, as well as configure mappings and settings for the index. -[discrete] -===== Features -* Access to the {es} client +### Features [_features_4] + +* Access to the {{es}} client * Setting the index name, document type, and object class for deserialization * Composing mappings and settings for the index * Creating, deleting or refreshing the index * Finding or searching for documents * Providing access both to domain objects and hits for search results -* Providing access to the {es} response for search results +* Providing access to the {{es}} response for search results * Defining the methods for serialization and deserialization -[discrete] -===== Usage +### Usage [_usage_2] -Let's have a simple plain old Ruby object (PORO): +Let’s have a simple plain old Ruby object (PORO): -[source,ruby] ------------------------------------- +```ruby class Note attr_reader :attributes @@ -48,69 +43,58 @@ class Note @attributes end end ------------------------------------- +``` Create a default, "dumb" repository, as a first step: -[source,ruby] ------------------------------------- +```ruby require 'elasticsearch/persistence' class MyRepository; include Elasticsearch::Persistence::Repository; end repository = MyRepository.new ------------------------------------- +``` Save a `Note` instance into the repository: -[source,ruby] ------------------------------------- +```ruby note = Note.new id: 1, text: 'Test' repository.save(note) # PUT http://localhost:9200/repository/_doc/1 [status:201, request:0.210s, query:n/a] # > {"id":1,"text":"Test"} # < {"_index":"repository","_type":"note","_id":"1","_version":1,"created":true} ------------------------------------- +``` Find it: -[source,ruby] ------------------------------------- +```ruby n = repository.find(1) # GET http://localhost:9200/repository/_doc/1 [status:200, request:0.003s, query:n/a] # < {"_index":"repository","_type":"note","_id":"1","_version":2,"found":true, "_source" : {"id":1,"text":"Test"}} => 1, "text"=>"Test"}> ------------------------------------- +``` Search for it: -[source,ruby] ------------------------------------- +```ruby repository.search(query: { match: { text: 'test' } }).first # GET http://localhost:9200/repository/_search [status:200, request:0.005s, query:0.002s] # > {"query":{"match":{"text":"test"}}} # < {"took":2, ... "hits":{"total":1, ... "hits":[{ ... "_source" : {"id":1,"text":"Test"}}]}} => 1, "text"=>"Test"}> ------------------------------------- +``` Delete it: -[source,ruby] ------------------------------------- +```ruby repository.delete(note) # DELETE http://localhost:9200/repository/_doc/1 [status:200, request:0.014s, query:n/a] # < {"found":true,"_index":"repository","_type":"note","_id":"1","_version":3} => {"found"=>true, "_index"=>"repository", "_type"=>"note", "_id"=>"1", "_version"=>2} ------------------------------------- +``` + +The repository module provides a number of features and facilities to configure and customize the behaviour, as well as support for extending your own, custom repository class. -The repository module provides a number of features and facilities to configure -and customize the behaviour, as well as support for extending your own, custom -repository class. +Please refer to the [documentation](https://github.com/elastic/elasticsearch-rails/tree/master/elasticsearch-persistence#the-repository-pattern) for more information. -Please refer to the -https://github.com/elastic/elasticsearch-rails/tree/master/elasticsearch-persistence#the-repository-pattern[documentation] -for more information. +Also, check out the [example application](https://github.com/elastic/elasticsearch-rails/tree/master/elasticsearch-persistence#example-application) which demonstrates the usage patterns of the *repository* approach to persistence. -Also, check out the -https://github.com/elastic/elasticsearch-rails/tree/master/elasticsearch-persistence#example-application[example application] -which demonstrates the usage patterns of the _repository_ approach to -persistence. diff --git a/docs/reference/ruby_on_rails.md b/docs/reference/ruby_on_rails.md new file mode 100644 index 0000000000..500fcbb762 --- /dev/null +++ b/docs/reference/ruby_on_rails.md @@ -0,0 +1,23 @@ +--- +mapped_pages: + - https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/ruby_on_rails.html +--- + +# Ruby On Rails [ruby_on_rails] + +The `elasticsearch-rails` [Rubygem](http://rubygems.org/gems/elasticsearch-rails) provides features suitable for Ruby on Rails applications. + + +## Features [_features_3] + +* Rake tasks for importing data from application models +* Integration with Rails' instrumentation framework +* Templates for generating example Rails application + + +## Example applications [_example_applications] + +You can generate a fully working example Ruby on Rails application with templates provides. + +Please refer to the [documentation](https://github.com/elastic/elasticsearch-rails/tree/master/elasticsearch-rails) for more information. + diff --git a/docs/reference/toc.yml b/docs/reference/toc.yml new file mode 100644 index 0000000000..be3fc7f854 --- /dev/null +++ b/docs/reference/toc.yml @@ -0,0 +1,24 @@ +toc: + - file: index.md + - file: getting-started.md + - file: installation.md + - file: connecting.md + - file: configuration.md + children: + - file: basic-config.md + - file: advanced-config.md + - file: integrations.md + children: + - file: transport.md + - file: api.md + - file: opentelemetry.md + - file: ecs.md + - file: activemodel_activerecord.md + - file: ruby_on_rails.md + - file: persistence.md + - file: dsl.md + - file: examples.md + - file: client-helpers.md + children: + - file: Helpers.md + - file: esql.md \ No newline at end of file diff --git a/docs/transport.asciidoc b/docs/reference/transport.md similarity index 57% rename from docs/transport.asciidoc rename to docs/reference/transport.md index b9199b19ed..24cecadde4 100644 --- a/docs/transport.asciidoc +++ b/docs/reference/transport.md @@ -1,26 +1,35 @@ -[[transport]] -=== Transport +--- +mapped_pages: + - https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/transport.html +--- -The `elastic-transport` library provides a low-level Ruby client for connecting to an {es} cluster. It currently powers the https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/index.html[Elasticsearch Ruby] and the https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current/index.html[Enterprise Search Ruby] clients. +# Transport [transport] + +The `elastic-transport` library provides a low-level Ruby client for connecting to an {{es}} cluster. It powers the [Elasticsearch Ruby](/reference/index.md) client. When available, it handles connecting to multiple nodes in the cluster, rotating across connections, logging and tracing requests and responses, maintaining failed connections, discovering nodes in the cluster, and provides an abstraction for data serialization and transport. -It does not handle calling the {es} or Enterprise Search APIs. +It does not handle calling the {{es}} APIs. -This library uses https://github.com/lostisland/faraday[Faraday] by default as the HTTP transport implementation. We test it with Faraday versions 1.x and 2.x. +This library uses [Faraday](https://github.com/lostisland/faraday) by default as the HTTP transport implementation. We test it with Faraday versions 1.x and 2.x. -For optimal performance, use a HTTP library which supports persistent ("keep-alive") connections, such as https://github.com/toland/patron[patron] or https://github.com/typhoeus/typhoeus[Typhoeus]. Require the library (`require 'patron'`) in your code for Faraday 1.x or the adapter (`require 'faraday/patron'`) for Faraday 2.x, and it will be automatically used. +For optimal performance, use a HTTP library which supports persistent ("keep-alive") connections, such as [patron](https://github.com/toland/patron) or [Typhoeus](https://github.com/typhoeus/typhoeus). Require the library (`require 'patron'`) in your code for Faraday 1.x or the adapter (`require 'faraday/patron'`) for Faraday 2.x, and it will be automatically used. Currently these libraries are supported: -* https://github.com/toland/patron[Patron] -* https://github.com/typhoeus/typhoeus[Typhoeus] -* https://rubygems.org/gems/httpclient[HTTPClient] -* https://rubygems.org/gems/net-http-persistent[Net::HTTP::Persistent] +* [Patron](https://github.com/toland/patron) +* [Typhoeus](https://github.com/typhoeus/typhoeus) +* [HTTPClient](https://rubygems.org/gems/httpclient) +* [Net::HTTP::Persistent](https://rubygems.org/gems/net-http-persistent) +* [Excon](https://github.com/excon/faraday-excon) +* [Async::HTTP](https://github.com/socketry/async-http-faraday) + +::::{note} +If using [Typhoeus](https://github.com/typhoeus/typhoeus), v1.4.0 or up is needed, since older versions are not compatible with Faraday 1.0. +:::: -NOTE: Use https://github.com/typhoeus/typhoeus[Typhoeus] v1.4.0 or up since older versions are not compatible with Faraday 1.0. -You can customize Faraday and implement your own HTTP transport. For detailed information, see the example configurations and more information <>. +You can customize Faraday and implement your own HTTP transport. For detailed information, see the example configurations and more information [below](#transport-implementations). Features overview: @@ -31,87 +40,74 @@ Features overview: * Request retries and dead connections handling * Node reloading (based on cluster state) on errors or on demand -Refer to <> to read about more configuration options. +Refer to [Advanced Configuration](/reference/advanced-config.md) to read about more configuration options. + -[discrete] -[[transport-install]] -==== Installation +## Installation [transport-install] -Install the package from https://rubygems.org/[Rubygems]: +Install the package from [Rubygems](https://rubygems.org/): -[source,bash] ----------------------------- +```bash gem install elastic-transport ----------------------------- +``` -To use an unreleased version, either add it to your `Gemfile` for -http://gembundler.com/[Bundler]: +To use an unreleased version, either add it to your `Gemfile` for [Bundler](http://gembundler.com/): -[source,bash] ----------------------------- +```bash gem 'elastic-transport', git: 'git@github.com:elastic/elastic-transport-ruby.git' ----------------------------- +``` or install it from a source code checkout: -[source,bash] ----------------------------- +```bash git clone https://github.com/elastic/elastic-transport-ruby.git cd elastic-transport bundle install rake install ----------------------------- +``` -[discrete] -[[transport-example-usage]] -==== Example usage -In the simplest form, connect to {es} running on http://localhost:9200 without any configuration: +## Example usage [transport-example-usage] -[source,rb] ----------------------------- +In the simplest form, connect to {{es}} running on [http://localhost:9200](http://localhost:9200) without any configuration: + +```rb require 'elastic/transport' client = Elastic::Transport::Client.new response = client.perform_request('GET', '_cluster/health') # => # ----------------------------- +``` -Documentation is included as RDoc annotations in the source code and available online at http://rubydoc.info/gems/elastic-transport[RubyDoc]. +Documentation is included as RDoc annotations in the source code and available online at [RubyDoc](http://rubydoc.info/gems/elastic-transport). -[discrete] -[[transport-implementations]] -==== Transport implementations -By default, the client uses the https://rubygems.org/gems/faraday[Faraday] HTTP library as a transport implementation. +## Transport implementations [transport-implementations] -The Client auto-detects and uses an _adapter_ for _Faraday_ based on gems loaded in your code, preferring HTTP clients with support for persistent connections. Faraday 2 changed the way adapters are used (https://github.com/lostisland/faraday/blob/main/UPGRADING.md#adapters-have-moved[read more here]). If you're using Faraday 1.x, you can require the HTTP library. To use the https://github.com/toland/patron[_Patron_] HTTP, for example, require it: +By default, the client uses the [Faraday](https://rubygems.org/gems/faraday) HTTP library as a transport implementation. +The Client auto-detects and uses an *adapter* for *Faraday* based on gems loaded in your code, preferring HTTP clients with support for persistent connections. Faraday 2 changed the way adapters are used ([read more here](https://github.com/lostisland/faraday/blob/main/UPGRADING.md#adapters-have-moved)). If you’re using Faraday 1.x, you can require the HTTP library. To use the [*Patron*](https://github.com/toland/patron) HTTP, for example, require it: -To use the https://github.com/toland/patron[Patron] HTTP, for example, require it: +To use the [Patron](https://github.com/toland/patron) HTTP, for example, require it: -[source,rb] ----------------------------- +```rb require 'patron' ----------------------------- +``` -If you're using Faraday 2.x, you need to add the corresponding adapter gem to your Gemfile and require it after you require `faraday`: +If you’re using Faraday 2.x, you need to add the corresponding adapter gem to your Gemfile and require it after you require `faraday`: -[source,rb] ----------------------------- +```rb # Gemfile gem 'faraday-patron' # Code require 'faraday' require 'faraday/patron' ----------------------------- - +``` Then, create a new client, and the Patron gem will be used as the "driver": -[source,rb] ----------------------------- +```rb client = Elastic::Transport::Client.new client.transport.connections.first.connection.builder.adapter @@ -127,43 +123,39 @@ end # => Stiletoo : 24 # => Stiletoo : 24 # => ... ----------------------------- +``` To use a specific adapter for Faraday, pass it as the `adapter` argument: -[source,rb] ----------------------------- +```rb client = Elastic::Client.new(adapter: :net_http_persistent) client.transport.connections.first.connection.builder.handlers # => [Faraday::Adapter::NetHttpPersistent] ----------------------------- +``` If you see this error: -[source,rb] ----------------------------- +```rb Faraday::Error: :net_http_persistent is not registered on Faraday::Adapter ----------------------------- -When you're using Faraday 2, you need to require the adapter before instantiating the client: +``` -[source,rb] ----------------------------- +When you’re using Faraday 2, you need to require the adapter before instantiating the client: + +```rb > client = Elasticsearch::Client.new(adapter: :net_http_persistent) Faraday::Error: :net_http_persistent is not registered on Faraday::Adapter > require 'faraday/net_http_persistent' => true > client = Elasticsearch::Client.new(adapter: :net_http_persistent) => # # ----------------------------- +``` -It's possible to customize the Curb instance by passing a block to the constructor as well (in this case, as an inline block): +It’s possible to customize the Curb instance by passing a block to the constructor as well (in this case, as an inline block): -[source,rb] ----------------------------- +```rb transport = Elastic::Transport::Transport::HTTP::Curb.new( hosts: [ { host: 'localhost', port: '9200' } ], & lambda { |c| c.verbose = true } ) client = Elastic::Client.new(transport: transport) ----------------------------- +``` You can write your own transport implementation by including the {Elastic::Transport::Transport::Base} module, implementing the required contract, and passing it to the client as the `transport_class` parameter – or by injecting it directly. -[discrete] -[[transport-architecture]] -==== Transport architecture + +## Transport architecture [transport-architecture] * `Elastic::Transport::Client` is composed of `Elastic::Transport::Transport`. * `Elastic::Transport::Transport` is composed of `Elastic::Transport::Transport::Connections`, and an instance of logger, tracer, serializer and sniffer. -* Logger and tracer can be any object conforming to Ruby logging interface, for example, an instance of https://ruby-doc.org/stdlib-1.9.3/libdoc/logger/rdoc/Logger.html[`Logger`], https://rubygems.org/gems/log4r[log4r], https://github.com/TwP/logging/[logging], and so on. -* The `Elastic::Transport::Transport::Serializer::Base` implementations handle converting data for {es} (for example, to JSON). You can implement your own serializer. +* Logger and tracer can be any object conforming to Ruby logging interface, for example, an instance of [`Logger`](https://ruby-doc.org/stdlib-1.9.3/libdoc/logger/rdoc/Logger.md), [log4r](https://rubygems.org/gems/log4r), [logging](https://github.com/TwP/logging/), and so on. +* The `Elastic::Transport::Transport::Serializer::Base` implementations handle converting data for {{es}} (for example, to JSON). You can implement your own serializer. * `Elastic::Transport::Transport::Sniffer` allows to discover nodes in the cluster and use them as connections. * `Elastic::Transport::Transport::Connections::Collection` is composed of `Elastic::Transport::Transport::Connections::Connection` instances and a selector instance. * `Elastic::Transport::Transport::Connections::Connection` contains the connection attributes such as hostname and port, as well as the concrete persistent "session" connected to a specific node. * The `Elastic::Transport::Transport::Connections::Selector::Base` implementations allow to choose connections from the pool, for example, in a round-robin or random fashion. You can implement your own selector strategy. * The `Elastic::Transport::Transport::Response` object wraps the Elasticsearch JSON response. It provides `body`, `status`, and `headers` methods but you can treat it as a hash and access the keys directly. + diff --git a/docs/release-notes/breaking-changes.md b/docs/release-notes/breaking-changes.md new file mode 100644 index 0000000000..29746c6949 --- /dev/null +++ b/docs/release-notes/breaking-changes.md @@ -0,0 +1,44 @@ +--- +navigation_title: "Elasticsearch Ruby Client" +--- + +# Elasticsearch Ruby Client breaking changes [elasticsearch-ruby-client-breaking-changes] +Before you upgrade, carefully review the Elasticsearch Ruby Client breaking changes and take the necessary steps to mitigate any issues. + +To learn how to upgrade, check out . + +% ## Next version [elasticsearch-ruby-client-nextversion-breaking-changes] +% **Release date:** Month day, year + +% ::::{dropdown} Title of breaking change +% Description of the breaking change. +% For more information, check [PR #](PR link). +% **Impact**
Impact of the breaking change. +% **Action**
Steps for mitigating deprecation impact. +% :::: + +## 9.0.0 [elasticsearch-ruby-client-900-breaking-changes] + +### Scroll APIs need to send scroll_id in request body + +Sending the `scroll_id` as a parameter has been deprecated since version 7.0.0. It needs to be specified in the request body for `clear_scroll` and `scroll`. + +**Impact**
+ +Client code using `clear_scroll` or `scroll` APIs and the deprecated `scroll_id` as a parameter needs to be updated. + +**Action**
+ +If you are using the `clear_scroll` or `scroll` APIs, and sending the `scroll_id` as a parameter, you need to update your code to send the `scroll_id` as part of the request body: +```ruby +# Before: +client.clear_scroll(scroll_id: scroll_id) +# Now: +client.clear_scroll(body: { scroll_id: scroll_id }) + +# Before: +client.scroll(scroll_id: scroll_id) +# Now: +client.scroll(body: { scroll_id: scroll_id }) +``` +% :::: diff --git a/docs/release-notes/deprecations.md b/docs/release-notes/deprecations.md new file mode 100644 index 0000000000..04c3e83766 --- /dev/null +++ b/docs/release-notes/deprecations.md @@ -0,0 +1,32 @@ +--- +navigation_title: "Elasticsearch Ruby Client" +--- + +# Elasticsearch Ruby Client deprecations [elasticsearch-ruby-client-deprecations] +Review the deprecated functionality for your Elasticsearch Ruby Client version. While deprecations have no immediate impact, we strongly encourage you update your implementation after you upgrade. + +To learn how to upgrade, check out . + +## 9.0.0 [elasticsearch-ruby-client-900-deprecations] + +_No deprecations_ + +% ## Next version [elasticsearch-ruby-client-versionnext-deprecations] +% **Release date:** Month day, year + +% ::::{dropdown} Deprecation title +% Description of the deprecation. +% For more information, check [PR #](PR link). +% **Impact**
Impact of deprecation. +% **Action**
Steps for mitigating deprecation impact. +% :::: + +% ## 9.0.0 [elasticsearch-ruby-client-900-deprecations] +% **Release date:** March 25, 2025 + +% ::::{dropdown} Deprecation title +% Description of the deprecation. +% For more information, check [PR #](PR link). +% **Impact**
Impact of deprecation. +% **Action**
Steps for mitigating deprecation impact. +% :::: diff --git a/docs/release-notes/index.md b/docs/release-notes/index.md new file mode 100644 index 0000000000..949f173eec --- /dev/null +++ b/docs/release-notes/index.md @@ -0,0 +1,56 @@ +--- +navigation_title: "Elasticsearch Ruby Client" +--- + +# Elasticsearch Ruby Client release notes [elasticsearch-ruby-client-release-notes] + +Review the changes, fixes, and more in each version of Elasticsearch Ruby Client. + +To check for security updates, go to [Security announcements for the Elastic stack](https://discuss.elastic.co/c/announcements/security-announcements/31). + +% Release notes include only features, enhancements, and fixes. Add breaking changes, deprecations, and known issues to the applicable release notes sections. + +% ## version.next [elasticsearch-ruby-client-next-release-notes] +% **Release date:** Month day, year + +% ### Features and enhancements [elasticsearch-ruby-client-next-features-enhancements] +% * + +% ### Fixes [elasticsearch-ruby-client-next-fixes] +% * + +## 9.0.0 [elasticsearch-ruby-client-900-release-notes] +**Release date:** March 25, 2025 + +### Features and enhancements [elasticsearch-ruby-client-900-features-enhancements] + +Ruby 3.2 and up are tested and supported for 9.0. Older versions of Ruby have reached their end of life. We follow Ruby’s own maintenance policy and officially support all currently maintained versions per [Ruby Maintenance Branches](https://www.ruby-lang.org/en/downloads/branches/). The required Ruby version is set to `2.6` to keep compatiblity wit JRuby 9.3. However, we only test the code against currently supported Ruby versions. + +#### Gem + +The size of both `elasticsearch` and `elasticsearch-api` gems is smaller than in previous versions. Some unnecessary files that were being included in the gem have now been removed. There has also been a lot of old code cleanup for the `9.x` branch. + +#### Elasticsearch Serverless + +With the release of `9.0`, the [Elasticsearch Serverless](https://github.com/elastic/elasticsearch-serverless-ruby) client has been discontinued. You can use this client to build your Elasticsearch Serverless Ruby applications. The Elasticsearch Serverless API is fully supported. The CI build for Elasticsearch Ruby runs tests to ensure compatibility with Elasticsearch Serverless. + +#### Elasticsearch API + +* The source code is now generated from [`elasticsearch-specification`](https://github.com/elastic/elasticsearch-specification/), so the API documentation is much more detailed and extensive. The value `Elasticsearch::ES_SPECIFICATION_COMMIT` is updated with the commit hash of elasticsearch-specification in which the code is based every time it's generated. +* The API code has been updated for compatibility with Elasticsearch API v 9.0. +* `indices.get_field_mapping` - `:fields` is a required parameter. +* `knn_search` - This API has been removed. It was only ever experimental and was deprecated in v`8.4`. It isn't supported in 9.0, and only works when the header `compatible-with=8` is set. The search API should be used for all knn queries. +* The functions in `utils.rb` that had names starting with double underscore have been renamed to remove these (e.g. `__listify` to `listify`). +* **Namespaces clean up**: The API namespaces are now generated dynamically based on the elasticsearch-specification. As such, some deprecated namespace files have been removed from the codebase: + * The `rollup` namespace was removed. The rollup feature was never GA-ed, it has been deprecated since `8.11.0` in favor of downsampling. + * The `data_frame_deprecated`, `remote` namespace files have been removed, no APIs were available. + * The `shutdown` namespace was removed. It is designed for indirect use by ECE/ESS and ECK. Direct use is not supported. + +##### Testing + +The gem `elasticsearch-api` migrated away from the Elasticsearch REST API tests and test runner in CI. We now run the [Elasticsearch Client tests](https://github.com/elastic/elasticsearch-clients-tests/) with the [Elasticsearch Tests Runner](https://github.com/elastic/es-test-runner-ruby). This gives us more control on what we're testing and makes the Buildkite build way faster in Pull Requests and scheduled builds. + +### Fixes [elasticsearch-ruby-client-900-fixes] + +* Some old rake tasks that were not being used have been removed. The rest were streamlined, the `es` namespace has been streamlined to make it easier to run Elasticsearch with Docker during development. The `docker` task namespace was merged into `es`. +* Elasticsearch's REST API Spec tests can still be ran with `rake test:deprecated:rest_api` and setting the corresponding value for the environment variable `TEST_SUITE` ('platinum' or 'free'). diff --git a/docs/release-notes/known-issues.md b/docs/release-notes/known-issues.md new file mode 100644 index 0000000000..5784c8adc7 --- /dev/null +++ b/docs/release-notes/known-issues.md @@ -0,0 +1,24 @@ +--- +navigation_title: "Elasticsearch Ruby Client" + +--- + +# Elasticsearch Ruby Client known issues [elasticsearch-ruby-client-known-issues] + +## 9.0.0 + +_No known issues_ + +% Use the following template to add entries to this page. + +% :::{dropdown} Title of known issue +% **Details** +% On [Month/Day/Year], a known issue was discovered that [description of known issue]. + +% **Workaround** +% Workaround description. + +% **Resolved** +% On [Month/Day/Year], this issue was resolved. + +% ::: diff --git a/docs/release-notes/toc.yml b/docs/release-notes/toc.yml new file mode 100644 index 0000000000..a410067947 --- /dev/null +++ b/docs/release-notes/toc.yml @@ -0,0 +1,5 @@ +toc: + - file: index.md + - file: known-issues.md + - file: breaking-changes.md + - file: deprecations.md \ No newline at end of file diff --git a/docs/release_notes/70.asciidoc b/docs/release_notes/70.asciidoc deleted file mode 100644 index d620366ed9..0000000000 --- a/docs/release_notes/70.asciidoc +++ /dev/null @@ -1,195 +0,0 @@ -[[release_notes_70]] -=== 7.0 Release notes - -This version contains the following changes: - -* Added `elastic_ruby_console` executable. It opens a console with the elasticsearch gems you have installed required. -* Added macro benchmarking framework, available when developing. Use `rake -T` to view all available benchmarking tasks. - - -[discrete] -==== Client - -* Fixed failing integration test -* Updated the Manticore development dependency -* Fixed a failing Manticore unit test -* Removed "turn" and switched the tests to Minitest -* Fixed integration tests for Patron -* Allow passing request headers in `perform_request` -* Added integration test for passing request headers in `perform_request` -* Added, that request headers are printed in trace output, if set -* Fix typos in elasticsearch-transport/README.md -* Assert that connection count is at least previous count when reloaded -* Adjust test for change in default number of shards on ES 7 -* Abstract logging functionality into a Loggable Module (#556) -* Convert client integration tests to rspec -* Add flexible configuration in spec helper -* Use helper methods in spec_helper -* Remove minitest client integration tests in favor of rspec test -* Convert tests to rspec and refactor client -* minor changes to the client specs -* Use pry-nav in development for JRuby -* Keep arguments variable name for now -* Skip round-robin test for now -* Mark test as pending until there is a better way to detect rotating nodes -* Remove client unit test in favor of rspec test -* Comment-out round-robin test as it occasionally passes and pending is ineffective -* Document the default host and port constant -* Add documentation to spec_helper methods -* Redacted password if host info is printed in error message -* Adds tests for not including password in logged error message -* The redacted string change will be in 6.1.1 -* Add more tests for different ways to specify client host argument -* Do not duplicate connections in connection pool after rebuild (#591) -* Ensure that the spec rake task is run as part of integration tests -* Use constant to define Elasticsearch hosts and avoid yellow status when number of nodes is 1 -* Update handling of publish_address in _nodes/http response -* Add another test for hostname/ipv6:port format - - -[discrete] -==== API - -* Added the `wait_for_active_shards` parameter to the "Indices Open" API -* Added the "Indices Split" API -* Added the `wait_for_no_initializing_shards` argument to the "Cluster Health" API -* Added the "Cluster Remote Info" API -* Remove the dependency on "turn" -* Clear cluster transient settings in test setups -* Use `YAML.load_documents` in the REST tests runner -* Removed pinning dependency for Minitest -* Replaced the testing framework from Test::Unit to Minites and improved test output -* Added, that trace logs are printed when the `TRACE` environment variable is set -* Removed the "turn" dependency from generated test_helper.rb -* Update the "Delete By Query" API to support :slices -* Speed up `Elasticsearch::API::Utils.__listify` -* Speed up `Elasticsearch::API::Utils.__pathify` -* Use "String#strip" and "String.empty?" in `Utils.__pathify` -* Updated the inline documentation for using scripts in the "Update" API -* Updated the "Scroll" API inline example with passing the scroll ID in the body -* Marked the `percolate` method as deprecated and added an example for current percolator -* Fixed, that `Utils.__report_unsupported_parameters` and `Utils.__report_unsupported_method` use `Kernel.warn` so they can be suppressed -* Fixed the "greedy" regex in the `Utils.__rescue_from_not_found` method -* Fixed the incorrect `create` method -* Allow passing headers in `perform_request` -* Set application/x-ndjson content type on Bulk and Msearch requests -* Update the Reindex API to support :slices -* Fixed and improved the YAML tests runner -* Added the `include_type_name` parameter to APIs -* Fixed the helper for unit tests -* Removed the requirement for passing the `type` parameter to APIs -* Removed dead code from the YAML tests runner -* Fixed the `api:code:generate` Thor task -* Add copy_settings as valid param to split API -* Port api/actions tests to rspec (#543) -* Update tests to not require type -* Account for escape_utils not being available for JRuby -* Add nodes/reload_secure_settings endpoint support (#546) -* Add new params for search and msearch API -* Retrieve stashed variable if referenced in test -* Convert cat API tests to rspec -* Convert cluster API tests to rspec -* Convert indices tests to rspec -* Fix documentation of #indices.analyze -* Avoid instantiating an array of valid params for each request, each time it is called (#550) -* Add headers to custom client documentation (#527) -* Fix typos in README -* Minor update to scroll documentation example -* Convert snapshot, ingest, tasks, nodes api tests to rspec -* Update source_includes and source_excludes params names for mget -* Update source_includes and source_excludes params names for get, search, bulk, explain -* Update source_includes and source_excludes params names for get_source -* Mark _search endpoint as deprecated -* Link to 6.0 documentation explicitly for _suggest deprecation -* Update documentation for msearch -* Update documentation for scroll_id to be in body of scroll endpoint -* Remove reference to deprecated format option for _analyze endpoint -* Correct endpoints used for get and put search template -* Fix minor typo -* Note that a non-empty body argument is required for the bulk api -* Add note about empty body in yard documentation -* Support if_primary_term param on index API -* Delete test2 template in between tests in case a test is not cleanup up properly -* Support ignore_throttled option on search API -* Updates for types removal changes -* Add missing update param -* Add missing params to methods -* Support if_primary_term param for delete -* Delete an index and index template not cleaned up after in rest api tests -* Update supported params for cat API endpoints -* Update supported params for cluster API endpoints -* Update supported params for indices API endpoints -* Update supported params for ingest API endpoints -* Update supported params for nodes API endpoints -* Update supported params for snapshot API endpoints -* Update missed node API endpoints -* Update missed tasks API endpoints -* Update top-level api endpoints -* Adjust specs and code after test failures -* Fix accidental overwrite of index code -* Add missing param in cat/thread_pool -* The type argument is not required in the index method -* Delete 'nomatch' template to account for lack of test cleanup -* Ensure that the :index param is supported for cat.segments -* Ensure that the :name param is passed to the templates API - -[discrete] -==== DSL - -* Add inner_hits option support for has_parent query -* Add inner_hits option support for has_child query -* Add inner_hits option support for has_parent filter -* Add inner_hits option support for has_child filter -* adds query support for nested queries in filter context (#531) -* Convert aggregations/pipeline tests to rspec (#564) -* Convert aggregations tests to rspec (#566) -* Convert filters tests to rspec (#567) -* Fix bug in applying no_match_filter to indices filter -* Update test for current elasticsearch version -* Fix integration tests for join field syntax -* Update agg scripted metric test for deprecation in ES issue #29328 -* Fix script in update for #29328 -* minor: fix spacing -* Convert queries tests to rspec (#569) -* Add inner_hits test after cherry-picking rspec conversion -* Remove tests already converted to rspec -* spec directory structure should mirror code directory structure -* Support query_string type option -* Ensure that filters are registered when called on bool queries (#609) -* Don't specify a type when creating mappings in tests - - -[discrete] -==== X-Pack - -* Embedded the source code for the `elasticsearch-xpack` Rubygem -* Fixed the `setup` for YAML integration tests -* Added missing X-Pack APIs -* Improved the YAML integration test runner -* Updated the Rakefile for running integration tests -* Added, that password for Elasticsearch is generated -* Fixed the Watcher example -* Updated the README -* Added gitignore for the `elasticsearch-xpack` Rubygem -* Add ruby-prof as a development dependency -* Handle multiple roles passed to get_role_mapping -* Minor updates to xpack api methods (#586) -* Support freeze and unfreeze APIs -* Rewrite xpack rest api yaml test handler (#585) -* Updates to take into account SSL settings -* Fix mistake in testing version range so test can be skipped -* Support set_upgrade_mode machine learning API -* Support typed_keys and rest_total_hits_as_int params for rollup_search -* Improve string output for xpack rest api tests -* Fix logic in version checking -* Support if_seq_no and if_primary_term in put_watch -* Don't test execute_watch/60_http_input because of possible Docker issue -* Support api key methods -* Fix minor typo in test description -* Fix issue with replacing argument value with an Integer value -* Support transform_and_set in yaml tests -* Skip two more tests -* Run security tests against elasticsearch 7.0.0-rc2 -* Account for error when forecast_id is not provided and legacy path is used -* Blacklist specific tests, not the whole file -* Fix version check for skipping test \ No newline at end of file diff --git a/docs/release_notes/710.asciidoc b/docs/release_notes/710.asciidoc deleted file mode 100644 index 9751bf2026..0000000000 --- a/docs/release_notes/710.asciidoc +++ /dev/null @@ -1,62 +0,0 @@ -[[release_notes_710]] -=== 7.10 Release notes - -[discrete] -[[release_notes_7101]] -=== 7.10.1 Release notes -[discrete] -==== Client - -- Updates for connecting with Cloud. - -[discrete] -[[release_notes_7100]] -=== 7.10 Release notes - -[discrete] -==== Client - -- Support for Elasticsearch version `7.10.0`. -- Fixes a bug when building the complete endpoint URL could end with duplicate slashes `//`. -- Fixes a bug when building the complete endpoint URL with cloud id could end with duplicate ports https://github.com/elastic/elasticsearch-ruby/issues/1081[#1081]. - -[discrete] -==== API - -- Fix in RubyDoc comments, some parameters were being duplicated. -- Deprecation notice: Synced flush (`indices.flush_synced`) is deprecated and will be removed in 8.0. Use flush instead. - -[discrete] -===== New API Endpoints - -- `snapshot.clone` - - -[discrete] -===== API Changes - -- `bulk`, `index`, `update`: new parameter `require_alias` (boolean): When true, requires destination to be an alias (default: false) for `index` and `update`. For `bulk` it sets `require_alias` for all incoming documents. Defaults to unset (false). - - -[discrete] -==== X-Pack - -Deprecation notice: `searchable_snapshots.repository_stats` is deprecated and is replaced by the Repositories Metering API. - -[discrete] -===== New API Endpoints - -- `close_point_in_time` -- `open_point_in_time` -- `security.clear_api_key_cache` -- `security.grant_api_key` - -[discrete] -===== API Changes - -- `cat.ml_datafeeds`, `cat.ml_jobs`, `machine_learning.close_job`, `machine_learning.get_datafeed_stats`, `machine_learning.get_datafeeds`, `machine_learning.get_job_stats`, `machine_learning.get_jobs`, `machine_learning.get_overall_buckets`, `machine_learning.stop_datafeed`: new parameter `allow_no_match` (boolean): Whether to ignore if a wildcard expression matches no datafeeds (this includes `_all` string or when no datafeeds have been specified). --`machine_learning.get_data_frame_analytics`: new parameter `verbose` (boolean), whether the stats response should be verbose. -- `machine_learning.get_trained_models`: new parameter `include` (string), a comma-separate list of fields to optionally include. Valid options are 'definition' and 'total_feature_importance'. Default is none. -- `machine_learning.stop_datafeed`: endpoint now accepts a `body`: the URL params optionally sent in the body. -- `security.get_role`, `security/get_role_mapping`: The name parameter is now a comma-separated list of role-mapping names. -- `machine_learning.delete_trained_model`, `machine_learning.get_trained_models`, `machine_learning.get_trained_models_stats`, `machine_learning.put_trained_model`: Internal change, url changed from `_ml/inference` to `_ml/trained_models`. diff --git a/docs/release_notes/711.asciidoc b/docs/release_notes/711.asciidoc deleted file mode 100644 index 9df6f1ba1f..0000000000 --- a/docs/release_notes/711.asciidoc +++ /dev/null @@ -1,49 +0,0 @@ -[[release_notes_711]] -=== 7.11 Release notes - -[discrete] -[[release_notes_7112]] -=== 7.11.2 Release notes - -[discrete] -==== Client - -* Bug fix in meta header, fixes fail when http adapter library hasn't been loaded yet: https://github.com/elastic/elasticsearch-ruby/issues/1224[Issue]. - -[discrete] -[[release_notes_7111]] -=== 7.11.1 Release notes - -[discrete] -==== Client - -* Bug fix in meta header, adds support for unknown Faraday adapters. https://github.com/elastic/elasticsearch-ruby/pull/1204[Pull Request]. - -[discrete] -[[release_notes_7110]] -=== 7.11.0 Release notes - -[discrete] -==== Client - -- Support for Elasticsearch version `7.11.0`. -- Fixes a bug with headers in our default Faraday class. https://github.com/elastic/elasticsearch-ruby/commit/9c4afc452467cc6344359b54b98bbe5af1469219[Commit]. -- Adds the `X-Elastic-Client-Meta` HTTP header which is used by Elastic Cloud and can be disabled with the `enable_meta_header` parameter set to `false`. - - -[discrete] -==== API - -- `cat.tasks` - Parameter `node_id` changes name to `nodes`, a comma-separated list of node IDS or names. Parameter `parent_task` changes name to `parent_task_id`. -- APIs that are no longer experimental: `cluster.delete_component_template`, `cluster.exists_component_template`, `cluster.get_component_template`, `cluster.put_component_template`, `indices.delete_index_template`, `indices.exists_index_template`, `indices.get_index_template`, `indices.put_index_template`, `indices.simulate_index_template`, `indices.simulate_template`. -- Deprecation notice: The _upgrade API is no longer useful and will be removed. Instead, see `_reindex API`. Deprecated since version 8.0.0. Endpoints: `indices.get_upgrade`, `indices.upgrade` - -[discrete] -==== X-Pack - -- New endpoints:`async_search.status`, `autoscaling.get_autoscaling_capacity` (experimental), `indices.migrate_to_data_stream`, `indices.promote_data_stream`, `machine_learning.upgrade_job_snapshot`, `rollup.rollup`, `watcher.query_watches`. -- APIs that are no longer experimental: `eql.delete`, `eql.get`, `eql.search`, -- APIs promoted from experimental to beta: `machine_learning.delete_data_frame_analytics`, `ml.delete_trained_model`, `machine_learning.evaluate_data_frame`, `machine_learning.explain_data_frame_analytics`, `machine_learning.get_data_frame_analytics`, `machine_learning.get_datafeed_stats`, `machine_learning.get_trained_models`, `machine_learning.get_trained_models_stats`, `machine_learning.put_data_frame_analytics`, `machine_learning.put_trained_model`, `machine_learning.start_data_frame_analytics`, `machine_learning.stop_data_frame_analytics`, `machine_learning.update_data_frame_analytics` -- `indices.delete_data_stream`, `indices.get_data_stream` add parameter `expand_wildcards`, wether wildcard expressions should get expanded to open or closed indices (default: open). Options: open, closed, hidden, none, all. -- `machine_learning.get_data_frame_analytics`, `machine_learning.get_datafeeds`, `machine_learning.get_jobs`, `machine_learning.get_trained_models`, `transform.get_transform` add parameter `exclude_generated` - omits fields that are illegal to set on PUT. -- `data_frame_transform_deprecated.get_transform` (_data_frame/transforms/ is deprecated, use _transform/ in the future) adds parameter `exclude_generated` - omits generated files. diff --git a/docs/release_notes/712.asciidoc b/docs/release_notes/712.asciidoc deleted file mode 100644 index c23f8c560c..0000000000 --- a/docs/release_notes/712.asciidoc +++ /dev/null @@ -1,28 +0,0 @@ -[[release_notes_712]] -=== 7.12 Release notes - -[discrete] -==== Client - -- Support for Elasticsearch version 7.12.0 -- Ruby 3 is now tested, it was added to the entire test suite. -- New official documentation pages for configuration: https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/basic-config.html[Basic Configuration] and https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/advanced-config.html[Advanced Configuration]. -- Integration tests runner refactored to keep skipped tests in a yaml file. - -[discrete] -==== API - -- New API namespace: `features` and endpoints `features.get_features` and `snapshot.get_features`. -- `cat.plugins` adds parameter `include_bootstrap`: Include bootstrap plugins in the response. -- Update in `indices.close` parameter `wait_for_active_shards`: Sets the number of active shards to wait for before the operation returns. Set to `index-setting` to wait according to the index setting `index.write.wait_for_active_shards`, or `all` to wait for all shards, or an integer. Defaults to `0`. -- `actions.search` adds parameter `min_compatible_shard_node`: The minimum compatible version that all shards involved in search should have for this request to be successful. - -[discrete] -==== X-Pack - -- New API namespace: `text_structure` and endpoints `text_structure.find_structure`. -- New API namespace: `logstash` and endpoints `logstash.delete_pipeline`, `logstash.get_pipeline`, `logstash.put_pipeline`. -- New API: `eql.get_status`. -- APIs migrated from experimental to stable: `autoscaling.delete_autoscaling_policy`, `autoscaling.get_autoscaling_capacity`, `autoscaling.get_autoscaling_policy`, `autoscaling.put_autoscaling_policy`. -- `searchable_snapshots.mount` adds parameter `storage`: Selects the kind of local storage used to accelerate searches. Experimental, and defaults to `full_copy`. -- `searchable_snapshots.stats` adds parameter `level`: Return stats aggregated at cluster, index or shard level (options: cluster, indices, shards). diff --git a/docs/release_notes/713.asciidoc b/docs/release_notes/713.asciidoc deleted file mode 100644 index 47594bdd12..0000000000 --- a/docs/release_notes/713.asciidoc +++ /dev/null @@ -1,53 +0,0 @@ -[[release_notes_713]] -=== 7.13 Release notes - -[discrete] -[[release_notes_7133]] -=== 7.13.3 Release notes - -- API Support for Elasticsearch version 7.13.3 - -[discrete] -[[release_notes_7132]] -=== 7.13.2 Release notes - -- Mute release, yanked from RubyGems. - -[discrete] -[[release_notes_7131]] -=== 7.13.1 Release notes - -[discrete] -==== Client -- Fixes thread safety issue in `get_connection` - https://github.com/elastic/elasticsearch-ruby/pull/1325[Pull Request]. - -[discrete] -[[release_notes_7130]] -=== 7.13.0 Release notes - -[discrete] -==== Client - -- Support for Elasticsearch version 7.13.0 -- Adds support for compatibility header for Elasticsearch. If the environment variable 'ELASTIC_CLIENT_APIVERSIONING' is set to `true` or `1`, the client will send the headers `Accept` and `Content-Type` with the following value: `application/vnd.elasticsearch+json;compatible-with=7`. -- Better detection of Elasticsearch and Enterprise Search clients in the meta header used by cloud. - -[discrete] -==== API - -- The REST API tests now use an artifact downloaded from the Elastic servers instead of depending of cloning `elasticsearch` locally. Check the README for more information. -- New parameter `include_unloaded_segments` in `cat.nodes`, `nodes.stats`: If set to true segment stats will include stats for segments that are not currently loaded into memory -- New parameter `summary` in `ingest.get_pipeline`: Return pipelines without their definitions (default: false) -- New parameter `index_details` in `snapshot.get`: Whether to include details of each index in the snapshot, if those details are available. Defaults to false. -- New endpoint `features.reset_features`, `ingest/geo_ip_stats` -- New experimental endpoints: `shutdown.delete_node`, `shutdown.get_node`, `shutdown.put_node`. - -[discrete] -==== X-Pack - -- Refactored test tasks, made it easier to run the tests by default. -- New experimental endpoints: `fleet.global_checkpoints`, `searchable_snapshots.cache_stats`. -- New beta endpoints: `security.clear_cached_service_tokens`, `security.create_service_token`, `security.delete_service_token`, `security.get_service_accounts`, `security.get_service_credentials` -- New endpoints: `machine_learning.delete_trained_model_alias`, `machine_learning.preview_data_frame_analytics`, `machine_learning.put_trained_model_alias`. -- APIs migrated from experimental or beta to stable: `machine_learning.delete_data_frame_analytics`, `machine_learning.delete_trained_model`, `machine_learning.estimate_model_memory`, `machine_learning.explain_data_frame_analytics`, `machine_learning.get_data_frame_analytics`, `machine_learning.get_data_frame_analytics_stats`, `machine_learning.get_trained_models`, `machine_learning.get_trained_models_stats`, `machine_learning.put_data_frame_analytics`, `machine_learning.put_trained_model`, `machine_learning.start_data_frame_analytics`, `machine_learning.stop_data_frame_analytics`, `machine_learning.update_data_frame_analytics` -- New parameter `body` in `machine_learning.preview_datafeed`: The datafeed config and job config with which to execute the preview. diff --git a/docs/release_notes/714.asciidoc b/docs/release_notes/714.asciidoc deleted file mode 100644 index 5cdf6092cd..0000000000 --- a/docs/release_notes/714.asciidoc +++ /dev/null @@ -1,93 +0,0 @@ -[[release_notes_714]] -=== 7.14 Release notes - -[discrete] -[[release_notes_7141]] -=== 7.14.1 Release notes - -[discrete] -==== Client - - - Fixes for Manticore Implementation: Addresses custom headers on initialization (https://github.com/elastic/elasticsearch-ruby/commit/3732dd4f6de75365460fa99c1cd89668b107ef1c[3732dd4]) and fixes tracing (https://github.com/elastic/elasticsearch-ruby/commit/3c48ebd9a783988d1f71bfb9940459832ccd63e4[3c48ebd]). Related to https://github.com/elastic/elasticsearch-ruby/issues/1426[#1426] and https://github.com/elastic/elasticsearch-ruby/issues/1428[#1428]. - -[discrete] -[[release_notes_7140]] -=== 7.14.0 Release notes - -[discrete] -==== Client - -Added check that client is connected to an Elasticsearch cluster. If the client isn't connected to a supported Elasticsearch cluster the `UnsupportedProductError` exception will be raised. - -This release changes the way in which the transport layer and the client interact. Previously, when using `elasticsearch-transport`, `Elasticsearch::Transport::Client` had a convenient wrapper, so it could be used as `Elasticsearch::Client`. Now, we are decoupling the transport layer from the Elasticsearch client. If you're using the `elasticsearch` gem, not much will change. It will instantiate a new `Elasticsearch::Transport::Client` when you instantiate `Elasticsearch::Client` and the endpoints from `elasticsearch-api` will be available. - -`Elasticsearch::Client` has an `attr_accessor` for the transport instance: - -[source,ruby] ------------------------------------- -> client = Elasticsearch::Client.new -> client.transport.class -=> Elasticsearch::Transport::Client -> client.transport.transport.class -=> Elasticsearch::Transport::Transport::HTTP::Faraday ------------------------------------- - -The interaction with `elasticsearch-api` remains unchanged. You can use the API endpoints just like before: - -[source,ruby] ------------------------------------- -> client.info -=> {"name"=>"instance", - "cluster_name"=>"elasticsearch", - "cluster_uuid"=>"id", - "version"=> - {"number"=>"7.14.0", - ... -}, - "tagline"=>"You Know, for Search"} ------------------------------------- - -Or perform request directly from the client which will return an `Elasticsearch::Transport::Response` object: - -[source,ruby] ------------------------------------- -> client.perform_request('GET', '/') -# This is the same as doing client.transport.perform_request('GET', '/') -=> #"instance", - "cluster_name"=>"elasticsearch", - "cluster_uuid"=>"id", - "version"=> - {"number"=>"7.14.0-SNAPSHOT", - ... - }, - "tagline"=>"You Know, for Search"}, - @headers= - {"content-type"=>"application/json; charset=UTF-8", - "content-length"=>"571", - ... - }, - @status=200> ------------------------------------- - -If you have any problems, please report them in https://github.com/elastic/elasticsearch-ruby/issues/1344[this issue]. - -[discrete] -==== API - -Code is now generated from Elastic artifacts instead of checked out code of Elasticsearch. See https://github.com/elastic/elasticsearch-ruby/blob/7.14/elasticsearch-api/utils/README.md#generate[the Generator README] for more info. - -- Endpoints `msearch`, `msearch_template` and `search_template` remove `query_and_fetch` and `dfs_query_and_fetch` options from the `search_type` parameter. -- New parameter `include_repository` in `snapshot.get`: (boolean) Whether to include the repository name in the snapshot info. Defaults to true. - -[discrete] -==== X-Pack - -X-Pack is being deprecated. The first time using `xpack` on the client, a warning will be triggered. Please check https://github.com/elastic/elasticsearch-ruby/issues/1274[this issue] for more information. - - -- New endpoints: `index_lifecycle_management.migrate_to_data_tiers`, `machine_learning.reset_job`, `security.saml_authenticate`, `security.saml_complete_logout`, `security.saml_invalidate`, `security.saml_logout`, `security.saml_prepare_authentication`, `security.saml_service_provider_metadata`, `sql.delete_async`, `sql.get_async`, `sql.get_async_status`, `terms_enum`. -- New experimental endpoints: `machine_learning.infer_trained_model_deployment`, `machine_learning.start_trained_model_deployment`, `machine_learning.stop_trained_model_deployment`. -- Deprecation: `indices.freeze` and `indices.unfreeze`: Frozen indices are deprecated because they provide no benefit given improvements in heap memory utilization. They will be removed in a future release. - diff --git a/docs/release_notes/715.asciidoc b/docs/release_notes/715.asciidoc deleted file mode 100644 index 5962394afe..0000000000 --- a/docs/release_notes/715.asciidoc +++ /dev/null @@ -1,20 +0,0 @@ -[[release_notes_715]] -=== 7.15 Release notes - -[discrete] -==== Client - -- Support for Elasticsearch v7.15.0 APIs. -- We've tested and added documentation on best practices for leveraging the client in a Function-as-a-Service (FaaS) environment to the https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/connecting.html#client-faas[official docs]. - -[discrete] -==== API -- New experimental endpoints: `indices.disk_usage`. `indices.field_usage_stats`, `nodes.clear_repositories_metering_archive`, `get_repositories_metering_info`, https://www.elastic.co/guide/en/elasticsearch/reference/7.15/search-vector-tile-api.html[`search_mvt`] -- The `index` parameter is now required for `open_point_in_time`. -- The `index_metric` parameter in `nodes.stats` adds the `shards` option. - -[discrete] -==== X-Pack - -- New parameters for `ml.put_job`: `ignore_unavailable`, `allow_no_indices`, `ignore_throttled`, `expand_wildcards`. -- New endpoint: https://www.elastic.co/guide/en/elasticsearch/reference/7.15/security-api-query-api-key.html[`security.query_api_keys`]. diff --git a/docs/release_notes/716.asciidoc b/docs/release_notes/716.asciidoc deleted file mode 100644 index 11c1b68ad7..0000000000 --- a/docs/release_notes/716.asciidoc +++ /dev/null @@ -1,96 +0,0 @@ -[[release_notes_716]] -=== 7.16 Release notes - -[discrete] -[[release_notes_7163]] -=== 7.16.3 Release notes - -==== API - -Bugfix for https://github.com/elastic/elasticsearch-ruby/issues/1475[#1475], an issue where if you indexed a document with an id such as `an id`, it would get escaped to `an+id` instead of `an%20id` when using `index` or `create`. This would result in the document id being `an+id` instead of the intended value `an id`. - -[discrete] -[[release_notes_7162]] -=== 7.16.2 Release notes - -No release. - -[discrete] -[[release_notes_7161]] -=== 7.16.1 Release notes - -Patch release corresponding with Elastic Stack version 7.16.1 that addresses the Apache Log4j2 vulnerability, https://discuss.elastic.co/t/apache-log4j2-remote-code-execution-rce-vulnerability-cve-2021-44228-esa-2021-31/291476[more information]. - -==== Client - -The only changes in the client since 7.16.0 are a few minor updates for the https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current/connecting.html#client-comp[Compatibility mode with 8.0]. We added the compatibility header in `7.13.0`, but now we have integration tests and compatibility tests for version `7.x` of the client with Elasticsearch `8.0`. - -[discrete] -[[release_notes_7160]] -=== 7.16.0 Release notes - -[discrete] -==== Client - -- Adds the `delay_on_retry` parameter, a value in milliseconds to wait between each failed connection, thanks https://github.com/DinoPullerUqido[DinoPullerUqido]! https://github.com/elastic/elasticsearch-ruby/pull/1521[Pull Request] and https://github.com/elastic/elasticsearch-ruby/pull/1523[backport]. -- Adds *CA fingerprinting*. You can configure the client to only trust certificates that are signed by a specific CA certificate (CA certificate pinning) by providing a `ca_fingerprint` option. This will verify that the fingerprint of the CA certificate that has signed the certificate of the server matches the supplied value. The verification will be run once per connection. Code example: - -[source,ruby] ------------------------------------- -ca_fingerprint = '64F2593F...' -client = Elasticsearch::Client.new( - host: 'https://elastic:changeme@localhost:9200/', - transport_options: { ssl: { verify: false } }, - ca_fingerprint: ca_fingerprint -) ------------------------------------- - -- Fixes compression. When `compression` is set to `true`, the client will now gzip the request body properly and use the appropiate headers. Thanks https://github.com/johnnyshields[johnnyshields]! https://github.com/elastic/elasticsearch-ruby/pull/1478[Pull Request] and https://github.com/elastic/elasticsearch-ruby/pull/1526[backport]. -- Warnings emitted by Elasticsearch are now logged via `log_warn` through the Loggable interface in the client, instead of using `Kernel.warn`. https://github.com/elastic/elasticsearch-ruby/pull/1517[Pull Request]. - -[discrete] -==== API - -- Cleaned up some deprecated code. -- `count` - The API is documented as using `GET`, but it supports both GET and POST on the Elasticsearch side. So it was updated to only use `POST` when there's a body present, or else use `GET`. Elasticsearch would still accept a body with `GET`, but to be more semantically correct in the clients we use `POST` when there's a body. -- `delete_index_template` was updated to support the `ignore_404` parameter to ignore 404 errors when attempting to delete a non-existing template. -- `ingest.put_pipeline` adds new parameter `if_version`: Required version for optimistic concurrency control for pipeline updates. -- `ml.put_trained_model`: adds new parameter `defer_definition_decompression`: If set to `true` and a `compressed_definition` is provided, the request defers definition decompression and skips relevant validations. -- `nodes.hot_threads` adds new parameter `sort`: The sort order for 'cpu' type (default: total) (options: cpu, total). -- `open_point_in_time`: `keep_alive` is now a required parameter. -- `search_mvt`: adds new parameter `track_total_hits`: Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number. -- `transform.preview_transform`: adds new parameter `transform_id`. Body is now optional and the API will use `GET` or `POST` depending on the presence of a body. - -*APIs promoted from experimental to stable since last version:* - -- `fleet.global_checkpoints` -- `get_script_context` -- `get_script_language` -- `indices.resolve_index` -- `monitoring.bulk` -- `rank_eval` -- `searchable_snapshots.mount` -- `searchable_snapshots.stats` -- `security.clear_cached_service_tokens` -- `security.create_service_token` -- `security.delete_service_token` -- `security.get_service_accounts` -- `security.get_service_credentials` -- `shutdown.delete_node` -- `shutdown.get_node` -- `shutdown.put_node` -- `terms_enum` - -*New APIs* - -- `fleet.mseach` -- `fleet.search` -- `indices.modify_data_stream` -- `ml.infer_trained_model_deployment` -- `ml.start_trained_model_deployment` -- `ml.stop_trained_model_deployment` -- `migration.get_feature_upgrade_status` -- `migration.post_feature_upgrade_status` -- `security.enroll_kibana` -- `security.enroll_node` -- `transform.updgrade_transforms` diff --git a/docs/release_notes/717.asciidoc b/docs/release_notes/717.asciidoc deleted file mode 100644 index 4413dd225a..0000000000 --- a/docs/release_notes/717.asciidoc +++ /dev/null @@ -1,29 +0,0 @@ -[[release_notes_717]] -=== 7.17 Release notes - -[discrete] -[[release_notes_7177]] -=== 7.17.7 Release notes - -- Compatibility with Elasticsearch v7.17.7 APIs. -- Tested versions of Ruby for 7.17.7: Ruby (MRI) 2.6, 2.7, 3.0 and 3.1, JRuby 9.3. - -[discrete] -[[release_notes_7172]] -=== 7.17.2, 7.17.3, 7.17.4, 7.17.5, 7.17.6 Release notes - -No release. - -[discrete] -[[release_notes_7171]] -=== 7.17.1 Release notes - -- Improves handling of YAML parsing, uses `safe_load` instead of `load` when doing the product verification (should only affect Ruby < 3.0). -- Updates headers setup when using the Manticore adapter. This fixes an issue where the user-agent header was being foverridden even when it was being set on initialization via the transport options. https://github.com/elastic/elasticsearch-ruby/pull/1685[Pull Request], https://github.com/elastic/elasticsearch-ruby/issues/1684[issue]. - -[discrete] -[[release_notes_7170]] -=== 7.17.0 Release notes - -- Drops Ruby 2.5 from the test matrix. Support for Ruby 2.5 was dropped March 2021. -- Updates the product verification when the response is a `413` error. diff --git a/docs/release_notes/75.asciidoc b/docs/release_notes/75.asciidoc deleted file mode 100644 index ac874d0cfb..0000000000 --- a/docs/release_notes/75.asciidoc +++ /dev/null @@ -1,59 +0,0 @@ -[[release_notes_75]] -=== 7.5 Release notes - -- Support for Elasticsearch 7.5. -- Update API spec generator: The code for Elasticsearch OSS and X-Pack APIs is being generated from the rest api spec. -- Specs have been updated to address new/deprecated parameters. -- Ruby versions tested: 2.3.8, 2.4.9, 2.5.7, 2.6.5 and 2.7.0 (new). - - -[discrete] -==== API - -Endpoints that changed: - -- `_bulk`: body is now required as an argument. -- `cat`: `local` and `master_timeout` parameters are gone. - - `health`: New parameter `health`. - - `indices`: Adds `time` and `include_unload_segments` parameters. - - `nodes`: Adds `bytes`, `time` parameters. - - `pending_tasks`: Adds `time` parameter. - - `recovery`: Adds `active_only`, `detailed`, `index`, `time` parameters. - - `segments`: Removes `index` parameter and it's now a url part. - - `shards`: Adds `time` parameter. - - `snapshots`: Adds `time` parameter. - - `tasks`: Adds `time` parameter. - - `templates`: The `name` parameter is now passed in as a part but not a parameter. - - `thread_pool`: The `thread_pool_patterns` parameter is now passed in as a part but not as a parameter. -- `cluster` - - `put_settings`: body is required. - - `state`: `index_templates` is gone. - - `node_id` is now a url part. -- `delete` - `parent` parameter is gone. -- `delete_by_query`: `analyzer` parameters are gone, `max_docs` is a new parameter, `body` is now a required parameter. -- `delete_by_query_rethrottle` new endpoint. -- `delete_by_rethrottle` - uses `delete_by_query_rethrottle` and hasn't changed. -- `exists`, `exists_source`, `explain`: `parent` parameter is gone. -- `field_caps`: `fields` param is no longer required. -- `get`: `parent` parameter is gone -- `get_source`: `parent` parameter is gone -- `index`: `body` parameter is required, `wait_for_shard` is a new parameter, `consistency`, `include_type_name`, `parent`, `percolate`, `replication`, `timestamp`, `ttl` parameters are gone -- `indices` - - `get`: `feature` paramatere was deprecated and is gone. - - `delete_aliases`, `put_alias`: URL changed internally to 'aliases' instead of 'alias' but shouldn't affect the client's API. -- `render_search_template`: `id` is now a part not a parameter -- `search`: `fielddata_fields`, `include_type_name`, `fields`, `ignore_indices`, `lowercase_expanded_terms`, `query_cache`, `source` parameters are gone, `ccs_minimize_roundtrips`, `track_scores` are new parameters. -- `tasks` - `list`: task_id is not supported anymore, it's in get now. -- `termvectors`: `parent` parameter is gone. -- `update`: `version` parameter is not supported anymore. - - -[discrete] -==== X-Pack - -Some urls changed internally to remove `_xpack`, but it shouldn't affect the client's API. - -- `explore`: `index` is now required. -- `info`: `human` parameter is gone. -- `migration`: some endpoints are gone: `get_assistance`, `get_assistance_test` and `upgrade_test`. -- `watcher`: `restart` endpoint is gone. diff --git a/docs/release_notes/76.asciidoc b/docs/release_notes/76.asciidoc deleted file mode 100644 index bd546df82f..0000000000 --- a/docs/release_notes/76.asciidoc +++ /dev/null @@ -1,86 +0,0 @@ -[[release_notes_76]] -=== 7.6 Release notes - - -[discrete] -==== Client - -* Support for Elasticsearch version 7.6. -* Last release supporting Ruby 2.4. Ruby 2.4 has reached it's end of life and no more security updates will be provided, users are suggested to update to a newer version of Ruby. - - -[discrete] -===== API Key Support - -The client now supports API Key Authentication, check "Authentication" on the https://github.com/elastic/elasticsearch-ruby/tree/7.x/elasticsearch-transport#authentication[transport README] for information on how to use it. - - -[discrete] -===== X-Opaque-Id Support - -The client now supports identifying running tasks with X-Opaque-Id. Check https://github.com/elastic/elasticsearch-ruby/tree/7.x/elasticsearch-transport#identifying-running-tasks-with-x-opaque-id[transport README] for information on how to use X-Opaque-Id. - - -[discrete] -===== Faraday migrated to 1.0 - -We're now using version 1.0 of Faraday: - -* The client initializer was modified but this should not disrupt final users at all, check this commit for more information. -* Migrated error checking to remove the deprecated Faraday::Error namespace. -* *This change is not compatible with https://github.com/typhoeus/typhoeus[Typhoeus]*. The latest release is 1.3.1, but it's https://github.com/typhoeus/typhoeus/blob/v1.3.1/lib/typhoeus/adapters/faraday.rb#L100[still using the deprecated `Faraday::Error` namespace]. This has been fixed on master, but the last release was November 6, 2018. Version 1.4.0 should be ok once it's released. -* Note: Faraday 1.0 drops official support for JRuby. It installs fine on the tests we run with JRuby in this repo, but it's something we should pay attention to. - -Reference: https://github.com/lostisland/faraday/blob/master/UPGRADING.md[Upgrading - Faraday 1.0] - -https://github.com/elastic/elasticsearch-ruby/pull/808[Pull Request] - - -[discrete] -==== API - - -[discrete] -===== API Changes: - -- `cat.indices`: argument `bytes` options were: `b,k,m,g` and are now `b,k,kb,m,mb,g,gb,t,tb,p,pb`. -- `delete_by_query`: New parameter `analyzer` - The analyzer to use for the query string. -- `indices.put_template`: Removed parameters: `timeout`, `flat_settings`. -- `msearch_template`: New Parameter `ccs_minimize_roundtrips` - Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution. -- `rank_eval`: New parameter `search_type` - Search operation type (options: `query_then_fetch,dfs_query_then_fetch`). -- `search_template`: New parameter `ccs_minimize_roundtrips` - Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution. - - -[discrete] -===== New API endpoints: - -- `get_script_context` -- `get_script_languages` - - -[discrete] -===== Warnings: - -Synced flush is deprecated and will be removed in 8.0. - - -[discrete] -==== X-Pack - - -[discrete] -===== New API endpoints: - -- `ml/delete_trained_model` -- `ml/explain_data_frame_analytics` -- `ml/get_trained_models` -- `ml/get_trained_models_stats` -- `ml/put_trained_model` - - -[discrete] -===== API changes: - -- `license/get`: Added parameter `accept_enterprise`. -- `ml/delete_data_frame_analytics` Added parameter `force`. -- `monitoring/bulk` - Removed parameter `system_version`. \ No newline at end of file diff --git a/docs/release_notes/77.asciidoc b/docs/release_notes/77.asciidoc deleted file mode 100644 index 87f5e1bdbb..0000000000 --- a/docs/release_notes/77.asciidoc +++ /dev/null @@ -1,77 +0,0 @@ -[[release_notes_77]] -=== 7.7 Release notes - -This version drops support for Ruby 2.4 since it's reached it's end of life. - - -[discrete] -==== Client - -- Support for Elasticsearch version `7.7` - - -[discrete] -===== Custom Headers - -You can set custom HTTP headers on the client's initializer or pass them as a parameter to any API endpoint. https://github.com/elastic/elasticsearch-ruby/tree/7.x/elasticsearch-transport#custom-http-headers[More info and code examples]. - - -[discrete] -==== API - - -[discrete] -===== API Changes - -- Clean: Removes up some deprecated endpoints: `abort_benchmark`, `benchmark`, `delete_by_rethrottle`, `nodes.shutdown`, `remote.info`. -- `expand_wildcards` Whether to expand wildcard expressions to concrete indices that are open, closed or both. Options: open, closed, hidden, none, all. `hidden` option is new. It was also added to the following endpoints: `cat.aliases`, `cat.indices`. -- `delete_by_query`: Parameter `slices` can now be set to `auto`. -- `reindex`: Parameter `slices` can now be set to `auto`. -- `update_by_query`: Parameter `slices` can now be set to `auto`. -- `snapshot.cleanup_repository`: Parameter `body` is removed. - - -[discrete] -===== New API Endpoints - -- `cluster.delete_component_template` -- `cluster.get_component_template` -- `cluster.put_component_template` -- `indices.create_data_stream` (experimental) -- `indices.delete_data_stream` (experimental) -- `indices.get_data_stream` (experimental) - - -[discrete] -==== X-Pack - - -[discrete] -===== API Changes - -- `machine_learing.get_trained_models`: New parameter `tags` -- `machine_learning.put_datafeed`, `machine_learning.update_datafeed`: Added parameters `ignore_unavailable`, `allow_no_indices`, `ignore_throttled`, `expand_wildcards` -- `reload_secure_settings`: New parameter `body`, an object containing the password for the keystore. - - -[discrete] -===== New API Endpoints - -- `async_search.delete` -- `async_search.get` -- `async_search.submit` -- `cat.ml_data_frame_analytics` -- `cat.ml_datafeeds` -- `cat.ml_jobs` -- `cat.ml_trained_models` -- `cat.transform` -- `cat.transforms` -- `machine_learning.estimate_model_memory` -- `transform.delete_transform` -- `transform.get_transform` -- `transform.get_transform_stats` -- `transform.preview_transform` -- `transform.put_transform` -- `transform.start_transform` -- `transform.stop_transform` -- `transform.update_transform` \ No newline at end of file diff --git a/docs/release_notes/78.asciidoc b/docs/release_notes/78.asciidoc deleted file mode 100644 index a5d59e985e..0000000000 --- a/docs/release_notes/78.asciidoc +++ /dev/null @@ -1,103 +0,0 @@ -[[release_notes_78]] -=== 7.8 Release notes - -[discrete] -[[release_notes_781]] -=== 7.8.1 Release notes - -[discrete] -==== Client - -- Support for Elasticsearch version `7.8.1`. -- Bug fix: Fixed a bug on the API endpoints documentation for RubyDocs: there was an unnecessary empty new line in the documentation for parameters that have options. So the parameters before that empty newline were not being documented in RubyDocs. - - -[discrete] -==== X-Pack - - -[discrete] -===== API Changes - -- Update to `info` endpoint. New parameter `accept_enterprise` (boolean): If an enterprise license is installed, return the type and mode as 'enterprise' (default: false). - - -[discrete] -[[release_notes_780]] -=== 7.8.0 Release notes - -[discrete] -==== Client - -- Support for Elasticsearch version `7.8`. -- Surface deprecation headers from Elasticsearch. When there's a `warning` response header in Elasticsearch's response, the client will emit a warning with `warn`. -- Typhoeus is supported again, version 1.4+ and has been added back to the docs. -- Adds documentation and example for integrating with Elastic APM. - - -[discrete] -==== API - - -[discrete] -===== New API Endpoints - -- `abort_benchmark` -- `benchmark` -- `cluster.delete_voting_config_exclusions` -- `cluster.post_voting_config_exclusions` -- `delete_by_rethrottle` -- `nodes.shutdown` -- `remote.info` - -Experimental endpoints: - -- `cluster.delete_component_template` -- `cluster.exists_component_template` -- `cluster.get_component_template` -- `cluster.put_component_template` - -- `indices.delete_index_template` -- `indices.exists_index_template` -- `indices.get_index_template` -- `indices.put_index_template` -- `indices.simulate_index_template` - - -[discrete] -===== API Changes - -- `cat/thread_pool`: `size` is deprecated. -- `indices.get_data_streams`: `name` is now a string instead of list, the name or wildcard expression of the requested data streams. -- `indices.put_index_template`: new parameter: `cause` (string), user defined reason for creating/updating the index template. -- `indices.simulate_index_template`: Two new parameters: `create`, whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one. `cause` User defined reason for dry-run creating the new template for simulation purposes. -- `snapshot.delete_repository`: New parameter `repository`, name of the snapshot repository, wildcard (`*`) patterns are now supported. -- `task.cancel`: new parameter `wait_for_completion` (boolean) Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false. - - -[discrete] -==== X-Pack - - -[discrete] -===== New API Endpoints - -New namespace: `indices` - -- `indices.freeze` -- `indices.reload_search_analyzers` -- `indices.unfreeze` - -New namespace: `searchable_snapshots` - -- `clear_cache` -- `mount` -- `repository_stats` -- `stats` - - -[discrete] -===== API Changes - -- `machine_learning.delete_expired_data` new param `body`: deleting expired data parameters. -- `machine_learning.delete_data_frame_analytics` new param `timeout`: controls the time to wait until a job is deleted. Defaults to 1 minute. diff --git a/docs/release_notes/79.asciidoc b/docs/release_notes/79.asciidoc deleted file mode 100644 index cd780239fb..0000000000 --- a/docs/release_notes/79.asciidoc +++ /dev/null @@ -1,60 +0,0 @@ -[[release_notes_79]] -=== 7.9 Release notes - -[discrete] -==== Client - -- Support for Elasticsearch version `7.9.0`. -- Transport/Connection: Considers attributes values for equality - https://github.com/elastic/elasticsearch-ruby/commit/06ffd03bf51f5f33a0d87e9914e66b39357d40af[Commit]. -- When an API endpoint accepts both `GET` and `POST`, the client will always use `POST` when a request body is present. - -[discrete] -==== API - -- Documentation for API endpoints will point out when an API is experimental, beta or unstable. - -[discrete] -===== New API Endpoints - -- New namespace: `dangling_indices` -- `dangling_indices.delete_dangling_index` -- `dangling_indices.import_dangling_index` -- `dangling_indices.list_dangling_indices` -- `indices.add_block` - -Experimental endpoints: -- `indices.resolve_index` -- `simulate_template` - -[discrete] -===== API Changes - -- `field_caps`: adds body parameter allowing to filter indices if `index_filter` is provided. -- `eql.search`: new parameters `wait_for_completion`, `keep_on_completion` and `keep_alive`. -- `info`: New parameter `accept_enterprise`: If an enterprise license is installed, return the type and mode as 'enterprise' (default: false). -- `indices.put_mapping`: new parameter `write_index_only`. - -[discrete] -==== X-Pack - -[discrete] -===== New API Endpoints - -The Ruby client now supports all the X-Pack API endpoints. - -- New namespace `autoscaling`: `autoscaling.delete_autoscaling_policy`, `autoscaling.get_autoscaling_decision`, `autoscaling.get_autoscaling_policy`, `autoscaling.put_autoscaling_policy` -- New namespace `enrich`: `enrich.delete_policy`, `enrich.execute_policy`, `enrich.get_policy`, `enrich.put_policy`, `enrich.stats` -- New namespace `eql`: `eql.delete`, `eql.get`, `eql.search` -- New namespace `cross_cluster_replication`: `cross_cluster_replication.delete_auto_follow_pattern`, `cross_cluster_replication.follow`, `cross_cluster_replication.follow_info`, `cross_cluster_replication.follow_stats`, `cross_cluster_replication.forget_follower`, `cross_cluster_replication.get_auto_follow_pattern`, `cross_cluster_replication.pause_auto_follow_pattern`, `cross_cluster_replication.pause_follow`, `cross_cluster_replication.put_auto_follow_pattern`, `cross_cluster_replication.resume_auto_follow_pattern`, `cross_cluster_replication.resume_follow`, `cross_cluster_replication.stats`, `cross_cluster_replication.unfollow` -- New namespace `snapshot_lifecycle_management`: `snapshot_lifecycle_management.delete_lifecycle`, `snapshot_lifecycle_management.execute_lifecycle`, `snapshot_lifecycle_management.execute_retention`, `snapshot_lifecycle_management.get_lifecycle`, `snapshot_lifecycle_management.get_stats`, `snapshot_lifecycle_management.get_status`, `snapshot_lifecycle_management.put_lifecycle`, `snapshot_lifecycle_management.start`, `snapshot_lifecycle_management.stop` -- `indices.create_data_stream` -- `indices.data_streams_stats` -- `indices.delete_data_stream` -- `indices.get_data_stream` -- `security.clear_cached_privileges` -- `machine_learning.update_data_frame_analytics` - -[discrete] -===== API Changes - -- `machine_learning.delete_expired_data`: new parameters `job_id`, `requests_per_second` and `timeout` \ No newline at end of file diff --git a/docs/release_notes/80.asciidoc b/docs/release_notes/80.asciidoc deleted file mode 100644 index c97e91cc7b..0000000000 --- a/docs/release_notes/80.asciidoc +++ /dev/null @@ -1,74 +0,0 @@ -[[release_notes_80]] -=== 8.0 Release notes - -[discrete] -[[release_notes_801]] -=== 8.0.1 Release notes - -- Fixes an issue with the generated API code. When updating the code generator for 8.x, the order of `arguments.clone` in the generated code was changed. This would make it so that we would modify the parameters passed in before cloning them, which is undesired. Issue: https://github.com/elastic/elasticsearch-ruby/issues/1727[#1727]. - -[discrete] -[[release_notes_800]] -=== 8.0.0 Release notes - -First release for the 8.x branch with a few major changes. - -- Tested versions of Ruby for 8.0.0: Ruby (MRI) 2.6, 2.7, 3.0 and 3.1, JRuby 9.3. - -[discrete] -==== Client - -The code for the dependency `elasticsearch-transport` has been promoted to https://github.com/elastic/elastic-transport-ruby[its own repository] and the project and gem have been renamed to https://rubygems.org/gems/elastic-transport[`elastic-transport`]. This gem now powers https://rubygems.org/gems/elasticsearch[`elasticsearch`] and https://rubygems.org/gems/elastic-enterprise-search[`elastic-enterprise-search`]. The `elasticsearch-transport` gem won't be maintained after the last release in the `7.x` branch, in favour of `elastic-transport`. - -This will allow us to better address maintainance in both clients and the library itself. - -[discrete] -==== API - -The `elasticsearch-api` library has been generated based on the {es} 8.0.0 REST specification. - -#### X-Pack Deprecation - -X-Pack has been deprecated. The `elasticsearch-xpack` gem will no longer be maintained after the last release in the `7.x` branch. The "X-Pack" integration library codebase was merged into `elasticsearch-api`. All the functionality is available from `elasticsearch-api`. The `xpack` namespace was removed for accessing any APIs other than `_xpack` (`client.xpack.info`) and `_xpack/usage` (`client.xpack.usage`). But APIs which were previously available through the `xpack` namespace e.g.: `client.xpack.machine_learning` are now only available directly: `client.machine_learning`. - -#### Parameter checking was removed - -The code in `elasticsearch-api` will no longer validate all the parameters sent. It will only validate the required parameters such as those needed to build the path for the request. But other API parameters are going to be validated by {es}. This provides better forwards and backwards compatibility in the client. - -#### Response object - -In previous versions of the client, calling an API endpoint would return the JSON body of the response. With `8.0`, we are returning a new Response object `Elasticsearch::API::Response`. It still behaves like a Hash to maintain backwards compatibility, but adds the `status` and `headers` methods from the `Elastic::Transport:Transport::Response` object: - -```ruby -elastic_ruby(main)> response = client.info -=> #"instance", - "cluster_name"=>"elasticsearch-8-0-0-SNAPSHOT-rest-test", - "cluster_uuid"=>"oIfRARuYRGuVYybjxQJ87w", - "version"=> - {"number"=>"8.0.0-SNAPSHOT", - "build_flavor"=>"default", - "build_type"=>"docker", - "build_hash"=>"7e23c54eb31cc101d1a4811b9ab9c4fd33ed6a8d", - "build_date"=>"2021-11-04T00:21:32.464485627Z", - "build_snapshot"=>true, - "lucene_version"=>"9.0.0", - "minimum_wire_compatibility_version"=>"7.16.0", - "minimum_index_compatibility_version"=>"7.0.0"}, - "tagline"=>"You Know, for Search"}, - @headers={"X-elastic-product"=>"Elasticsearch", "content-type"=>"application/json", "content-length"=>"567"}, - @status=200>> -elastic_ruby(main)> response.status -=> 200 -elastic_ruby(main)> response.headers -=> {"X-elastic-product"=>"Elasticsearch", "content-type"=>"application/json", "content-length"=>"567"} -elastic_ruby(main)> response['name'] -=> "instance" -elastic_ruby(main)> response['tagline'] -=> "You Know, for Search" -``` - -Please https://github.com/elastic/elasticsearch-ruby/issues[let us know if you find any issues]. diff --git a/docs/release_notes/81.asciidoc b/docs/release_notes/81.asciidoc deleted file mode 100644 index 871486ead8..0000000000 --- a/docs/release_notes/81.asciidoc +++ /dev/null @@ -1,55 +0,0 @@ -[[release_notes_81]] -=== 8.1 Release notes - -[discrete] -[[release_notes_812]] -=== 8.1.2 Release notes - -[discrete] -==== API - -- Fixes an issue with the generated API code. When updating the code generator for 8.x, the order of `arguments.clone` in the generated code was changed. This would make it so that we would modify the parameters passed in before cloning them, which is undesired. Issue: https://github.com/elastic/elasticsearch-ruby/issues/1727[#1727]. - -[discrete] -[[release_notes_811]] -=== 8.1.1 Release notes - -No release, no changes on the client. - -[discrete] -[[release_notes_810]] -=== 8.1.0 Release notes - -- Tested versions of Ruby for 8.1.0: Ruby (MRI) 2.6, 2.7, 3.0 and 3.1, JRuby 9.3. - -[discrete] -==== API - -Updated for compatibility with Elasticsearch 8.1's API. - -[discrete] -===== New parameters: -- `indices.forcemerge` - `wait_for_completion` Should the request wait until the force merge is completed. -- `indices.get` - `features` Return only information on specified index features (options: aliases, mappings, settings). -- `ingest.put_pipeline` `if_version` (Integer), required version for optimistic concurrency control for pipeline updates. -- `ml.delete_trained_model` - `timeout` controls the amount of time to wait for the model to be deleted. `force` (Boolean) true if the model should be forcefully deleted. -- `ml.stop_trained_model_deployment` - `allow_no_match` whether to ignore if a wildcard expression matches no deployments. (This includes `_all` string or when no deployments have been specified). `force` true if the deployment should be forcefully stopped. Adds `body` parameter, the stop deployment parameters. -- `nodes.hot_threads` - `sort` the sort order for 'cpu' type (default: total) (options: cpu, total) - -[discrete] -===== Updated parameters: -- `indices.get_index_template` - `name` is now a String, a pattern that returned template names must match. -- `knn_search` - `index` removes option to use empty string to perform the operation on all indices. -- `ml.close_job`, `ml.get_job_stats`, `ml.get_jobs`, `ml.get_overall_buckets` - Remove `allow_no_jobs` parameter. -- `ml.get_datafeed_stats`, `ml.get_datafeeds` - Remove `allow_no_datafeeds` parameter. -- `nodes.hot_threads` - `type` parameter adds `mem` option. -- `nodes.info` - `metric` updated to use `_all` to retrieve all metrics and `_none` to retrieve the node identity without any additional metrics. (options: settings, os, process, jvm, thread_pool, transport, http, plugins, ingest, indices, aggregations, _all, _none). `index_metric` option `shards` changes to `shard_stats`. -- `open_point_in_time` - `keep_alive` is now a required parameter. -- `search_mvt` - `grid_type` parameter adds `centroid` option in addition to `grid` and `point`. - -- New experimental APIs, designed for internal use by the fleet server project: `fleet.search`, `fleet.msearch`. - -[discrete] -===== New APIs -- OpenID Connect Authentication: `security.oidc_authenticate`, `security.oidc_logout`, `security.oidc_prepare_authentication`. -- `transform.reset_transform`. diff --git a/docs/release_notes/810.asciidoc b/docs/release_notes/810.asciidoc deleted file mode 100644 index c58f777d8e..0000000000 --- a/docs/release_notes/810.asciidoc +++ /dev/null @@ -1,51 +0,0 @@ -[[release_notes_8100]] -=== 8.10 Release notes - -[discrete] -[[release_notes_810_0]] -=== 8.10.0 Release notes - -[discrete] -=== Client -* Tested versions of Ruby for 8.10.0: Ruby (MRI) 3.0, 3.1 and 3.2. JRuby 9.3 and JRuby 9.4. - -[discrete] -=== API - -[discrete] -==== New Experimental APIs, for internal use: -- `fleet.delete_secret` -- `fleet.get_secret` -- `fleet.post_secret` - -[discrete] -==== New stable APIs: -- `security.get_settings` - Retrieve settings for the security system indices -- `security.update_settings` - Update settings for the security system indices - -[discrete] -==== New Experimental API: -- `query_ruleset.list` List query rulesets. - -[discrete] -==== API Changes: -- `indices.reload_search_analyzers` - Adds parameter `resource` changed resource to reload analyzers from if applicable - -Promoted from Experimental to Beta: - -- `security.create_cross_cluster_api_key` -- `security.update_cross_cluster_api_key` - -[discrete] -==== Synonyms namespace update: - -All synonym related APIs have been moved to the `synonyms` namespace and some of the endpoints have been renamed, as well as their parameters: - -- `synonyms.delete` => `synonyms.delete_synonym` - requires `id`, the id of the synonyms set to be deleted. -- `synonyms.get` => `synonyms.get_synonym` - requires `id`, the name of the synonyms set to be retrieved. -- `synonyms_set.get_synonyms_sets` => `synonyms.get_synonyms_sets` -- `synonyms.put` => `synonyms.put_synonym` - requires `id` of the synonyms set to be created or updated. -- `synonym_rule.put` => `synonyms.put_synonym_rule` - Parameters changed to `set_id` (the id of the synonym set to be updated with the synonym rule) and `rule_id` (the id of the synonym rule to be updated or created). -- New Experimental API `synonyms.delete_synonym_rule` - Deletes a synonym rule in a synonym set -- New Experimental API `synonyms.get_synonym_rule` - Retrieves a synonym rule from a synonym set - diff --git a/docs/release_notes/811.asciidoc b/docs/release_notes/811.asciidoc deleted file mode 100644 index 43c43427de..0000000000 --- a/docs/release_notes/811.asciidoc +++ /dev/null @@ -1,24 +0,0 @@ -[[release_notes_8110]] -=== 8.11 Release notes - -[discrete] -[[release_notes_811_0]] -=== 8.11.0 Release notes - -[discrete] -=== Client - -* Tested versions of Ruby for 8.11.0: Ruby (MRI) 3.0, 3.1 and 3.2. JRuby 9.3 and JRuby 9.4. -* Adds native support for *Open Telemetry*. See <> for documentation. -* Improved documentation, now you can find more examples in Ruby in the https://www.elastic.co/guide/en/elasticsearch/reference/8.11/rest-apis.html[REST API reference]. - -[discrete] -=== API - -New Experimental APIs: - -* `esql.query` - Executes an ESQL request. -* `inference.delete_model` - Delete model in the Inference API -* `inference.get_model` - Get a model in the Inference API -* `inference.inference` - Perform inference on a model -* `inference.put_model` - Configure a model for use in the Inference API diff --git a/docs/release_notes/812.asciidoc b/docs/release_notes/812.asciidoc deleted file mode 100644 index 7fb1c52f6e..0000000000 --- a/docs/release_notes/812.asciidoc +++ /dev/null @@ -1,65 +0,0 @@ -[[release_notes_8_12]] -=== 8.12 Release notes - -[discrete] -[[release_notes_8_12_0]] -=== 8.12.0 Release notes - -[discrete] -==== Client -* Tested versions of Ruby for 8.12.0: Ruby (MRI) 3.0, 3.1, 3.2 and 3.3. JRuby 9.3 and JRuby 9.4. - -[discrete] -==== API - -API Changes: - -* `bulk` - Adds boolean `:list_executed_pipelines` parameter: Sets `list_executed_pipelines` for all incoming documents. Defaults to unset (false). -* `indices.put_settings` - Adds boolean `:reopen` parameter: Whether to close and reopen the index to apply non-dynamic settings. If set to `true` the indices to which the settings are being applied will be closed temporarily and then reopened in order to apply the changes. The default is `false`. -* `open_point_in_time` - Adds Hash `:body` parameter: an index_filter specified with the Query DSL. -* `security.get_api_key` - Adds boolean `:active_only` parameter: flag to limit response to only active (not invalidated or expired) API keys. - -[discrete] -===== Connectors - -Version 8.12 introduces the experimental https://www.elastic.co/guide/en/elasticsearch/reference/8.12/connector-apis.html[Connectors API]. - -Use the following APIs to manage connectors: - -* `connector.post` - Creates a connector. See https://www.elastic.co/guide/en/elasticsearch/reference/8.12/create-connector-api.html[documentation]. -* `connector.put` - Creates or updates a connector. See https://www.elastic.co/guide/en/elasticsearch/reference/8.12/create-connector-api.html[documentation]. -* `connector.delete` - Deletes a connector. See https://www.elastic.co/guide/en/elasticsearch/reference/8.12/delete-connector-api.html[documentation]. -* `connector.get` - Returns the details about a connector. See https://www.elastic.co/guide/en/elasticsearch/reference/8.12/get-connector-api.html[documentation]. -* `connector.list` - Lists all connectors. See https://www.elastic.co/guide/en/elasticsearch/reference/8.12/list-connector-api.html[documentation]. -* `connector.check_in` - Updates the last_seen timestamp in the connector document. See https://www.elastic.co/guide/en/elasticsearch/reference/8.12/check-in-connector-api.html[documentation]. -* `connector.update_configuration` - Updates the connector configuration. See https://www.elastic.co/guide/en/elasticsearch/reference/8.12/update-connector-configuration-api.html[documentation]. -* `connector.update_error` - Updates the error field in the connector document. See https://www.elastic.co/guide/en/elasticsearch/reference/8.12/update-connector-error-api.html[documentation]. -* `connector.update_filtering` - Updates the filtering field in the connector document. See https://www.elastic.co/guide/en/elasticsearch/reference/8.12/update-connector-filtering-api.html[documentation]. -* `connector.last_sync` - Updates the stats of last sync in the connector document. See https://www.elastic.co/guide/en/elasticsearch/reference/8.12/update-connector-last-sync-api.html[documentation]. -* `connector.update_name` - Updates the name and/or description fields in the connector document. See https://www.elastic.co/guide/en/elasticsearch/reference/8.12/update-connector-name-description-api.html[documentation]. -* `connector.update_pipeline` - Updates the pipeline field in the connector document. See https://www.elastic.co/guide/en/elasticsearch/reference/8.12/update-connector-pipeline-api.html[documentation]. -* `connector.update_scheduling` - Updates the scheduling field in the connector document. See https://www.elastic.co/guide/en/elasticsearch/reference/8.12/update-connector-scheduling-api.html[documentation]. - -Use the following APIs to manage sync jobs: - -* `connector_sync_job.cancel` - Cancels a connector sync job. See https://www.elastic.co/guide/en/elasticsearch/reference/8.12/cancel-connector-sync-job-api.html[documentation]. -* `connector_sync_job.check_in` - Checks in a connector sync job (refreshes 'last_seen'). See https://www.elastic.co/guide/en/elasticsearch/reference/8.12/check-in-connector-sync-job-api.html[documentation]. -* `connector_sync_job.delete` - Deletes a connector sync job. See https://www.elastic.co/guide/en/elasticsearch/reference/8.12/delete-connector-sync-job-api.html[documentation]. -* `connector_sync_job.error` - Sets an error for a connector sync job. See https://www.elastic.co/guide/en/elasticsearch/reference/8.12/set-connector-sync-job-error-api.html[documentation]. -* `connector_sync_job.get` - Returns the details about a connector sync job. See https://www.elastic.co/guide/en/elasticsearch/reference/8.12/get-connector-sync-job-api.html[documentation]. -* `connector_sync_job.list` - Lists all connector sync jobs. See https://www.elastic.co/guide/en/elasticsearch/reference/8.12/list-connector-sync-jobs-api.html[documentation]. -* `connector_sync_job.post` - Creates a connector sync job. See https://www.elastic.co/guide/en/elasticsearch/reference/8.12/create-connector-sync-job-api.html[documentation]. -* `connector_sync_job.update_stats` - Updates the stats fields in the connector sync job document. See https://www.elastic.co/guide/en/elasticsearch/reference/8.12/set-connector-sync-job-stats-api.html[documentation]. - -[discrete] -===== Profiling -New API for https://www.elastic.co/guide/en/observability/8.12/universal-profiling.html[Universal profiling]. - -* `profiling.status` - Returns basic information about the status of Universal Profiling. - - -[discrete] -===== Simulate -New experimental API: - -* `simulate.ingest` - Simulates running ingest with example documents. See: https://www.elastic.co/guide/en/elasticsearch/reference/8.12/simulate-ingest-api.html diff --git a/docs/release_notes/813.asciidoc b/docs/release_notes/813.asciidoc deleted file mode 100644 index 0c3066d3e4..0000000000 --- a/docs/release_notes/813.asciidoc +++ /dev/null @@ -1,76 +0,0 @@ -[[release_notes_8_13]] -=== 8.13 Release notes - -[discrete] -[[release_notes_8_13_0]] -=== 8.13.0 Release notes - -[discrete] -==== Client -* Tested versions of Ruby for 8.13.0: Ruby (MRI) 3.0, 3.1, 3.2 and 3.3. JRuby 9.3 and JRuby 9.4. - -[discrete] -==== Experimental ES|QL Helper - -This version provides a new experimental Helper for the ES|QL `query` API. Please check out https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/8.13/Helpers.html#esql-helper[the documentation] and https://github.com/elastic/elasticsearch-ruby/issues/new/choose[open an issue] if you encounter any problems or have any feedback. - -[discrete] -==== API - -API Changes: - -* `async_search.status` - adds Time `:keep_alive` parameter: Specify the time interval in which the results (partial or final) for this search will be available. -* `bulk` - adds boolean `:require_data_stream` parameter: When true, requires the destination to be a data stream (existing or to-be-created). Default is false. -* `connector.list` - Adds the following parameters: - * `:index_name` (List): A comma-separated list of connector index names to fetch connector documents for. - * `:connector_name` (List): A comma-separated list of connector names to fetch connector documents for. - * `:service_type` (List): A comma-separated list of connector service types to fetch connector documents for. - * `:query` (String): A search string for querying connectors, filtering results by matching against connector names, descriptions, and index names. -* `esql.query` - adds boolean `:drop_null_columns` parameter: Should entirely null columns be removed from the results? Their name and type will be returning in a new `all_columns` section. -* `field_caps` - Adds `:include_empty_fields` boolean parameter: Include empty fields in result. -* `index` - adds boolean `:require_data_stream` parameter: When true, requires the destination to be a data stream (existing or to-be-created). Default is false. -* `indices.rollover` - adds boolean `:lazy` parameter: If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write. Only allowed on data streams. -* connector_sync_job.list - adds List `:job_type` parameter: A comma-separated list of job types. -* `inference.delete_model`, `inference.get_model`, `inference.inference`, `inference.put_model`: renames `:model_id` parameter to `:inference_id`. -* `termvector` will show a warning since it's been deprecated. Please use the plural version, `termvectors`. - -New APIs: - -* `indices.resolve_cluster` - Resolves the specified index expressions to return information about each cluster, including the local cluster, if included. -* `profiling.flamegraph` - Extracts a UI-optimized structure to render flamegraphs from Universal Profiling. -* `profiling.stacktraces` - Extracts raw stacktrace information from Universal Profiling. -* `security.query_user` - Retrieves information for Users using a subset of query DSL -* `text_structure.test_grok_pattern` - Tests a Grok pattern on some text. - -APIs Migrated from experimental to stable: - -* `synonyms.delete_synonym` -* `synonyms.delete_synonym_rule` -* `synonyms.get_synonym` -* `synonyms.get_synonym_rule` -* `synonyms.get_synonyms_sets` -* `synonyms.put_synonym` -* `synonyms.put_synonym_rule` - -New Experimental APIs - -* `connector.update_api_key_id` - Updates the API key id and/or API key secret id fields in the connector document. -* `connector.update_index_name` - Updates the index name of the connector. -* `connector.update_native` - Updates the is_native flag of the connector. -* `connector.update_service_type` - Updates the service type of the connector. -* `connector.update_status` - Updates the status of the connector. -* `esql.async_query` - Executes an ESQL request asynchronously -* `esql.async_query_get` - Retrieves the results of a previously submitted async query request given its ID. - -New Experimental namespace `connector_secret`: - -* `connector_secret.delete` - Deletes a connector secret. -* `connector_secret.get` - Retrieves a secret stored by Connectors. -* `connector_secret.post` - Creates a secret for a Connector. -* `connector_secret.put` - Creates or updates a secret for a Connector. - -[discrete] -==== Development - -* Migrated from `byebug` to `debug`. -* Added extra testing for OpenTelemetry. diff --git a/docs/release_notes/814.asciidoc b/docs/release_notes/814.asciidoc deleted file mode 100644 index 6bb42142f9..0000000000 --- a/docs/release_notes/814.asciidoc +++ /dev/null @@ -1,52 +0,0 @@ -[[release_notes_8_14]] -=== 8.14 Release notes - -[discrete] -[[release_notes_8_14_0]] -=== 8.14.0 Release notes - -[discrete] -==== Client -* Tested versions of Ruby for 8.14.0: Ruby (MRI) 3.0, 3.1, 3.2 and 3.3. JRuby 9.3 and JRuby 9.4. - -[discrete] -==== API - -API changes: - -* All Connector APIs have been migrated to one common namespace `connector`: -** `connector_secret.delete` -> `connector.secret_delete` -** `connector_secret.get` -> `connector.secret_get` -** `connector_secret.post` -> `connector.secret_post` -** `connector_secret.put` -> `connector.secret_put` -** `connector_sync_job.cancel` -> `connector.sync_job_cancel` -** `connector_sync_job.check_in` -> `connector.sync_job_check_in` -** `connector_sync_job.delete` -> `connector.sync_job_delete` -** `connector_sync_job.error` -> `connector.sync_job_error` -** `connector_sync_job.get` -> `connector.sync_job_get` -** `connector_sync_job.post` -> `connector.sync_job_post` -** `connector_sync_job.update_stats` -> `connector.sync_job_update_stats` - -* `connector.delete` - Adds Boolean parameter `:delete_sync_jobs`: Determines whether associated sync jobs are also deleted. -* `cross_cluster_replication.delete_auto_follow_pattern`, `cross_cluster_replication.follow`, `cross_cluster_replication.follow_info`, `cross_cluster_replication.get_auto_follow_pattern`, `cross_cluster_replication.pause_auto_follow_pattern`, `cross_cluster_replication.pause_follow`, `cross_cluster_replication.put_auto_follow_pattern`, `cross_cluster_replication.resume_auto_follow_pattern`, `cross_cluster_replication.resume_follow`, `cross_cluster_replication.stats`, `cross_cluster_replication.unfollow` - Add Time parameter `:master_timeout`: Explicit operation timeout for connection to master node. -* `cross_cluster_replication.follow_stats`, `cross_cluster_replication.forget_follower`, `cross_cluster_replication.stats` - Add Time parameter `:timeout`: Explicit operation timeout. -* `indices/rollover` - Adds Boolean parameter `:target_failure` If set to true, the rollover action will be applied on the failure store of the data stream. -* `inference.get_model` - Parameter `inference_id` no longer required. -* `search_application.search` - Adds Boolean parameter `:typed_keys`: Specify whether aggregation and suggester names should be prefixed by their respective types in the response. -* `security.get_api_key`, `security.query_api_keys` - Add Boolean parameter `:with_profile_uid`: flag to also retrieve the API Key's owner profile uid, if it exists. - -New APIs: - -- `profiling.topn_functions` - Extracts a list of topN functions from Universal Profiling. -- `text_structure.find_field_structure` - Finds the structure of a text field in an index. -- `text_structure/find_message_structure`- Finds the structure of a list of messages. The messages must contain data that is suitable to be ingested into Elasticsearch. - -APIs Migrated from experimental to stable: - -- `esql.async_query` -- `esql.query` - -New Experimental APIs: - -- `connector.update_active_filtering` - Activates the draft filtering rules if they are in a validated state. -- `connector.update_filtering_validation` - Updates the validation info of the draft filtering rules. diff --git a/docs/release_notes/815.asciidoc b/docs/release_notes/815.asciidoc deleted file mode 100644 index 38312a5922..0000000000 --- a/docs/release_notes/815.asciidoc +++ /dev/null @@ -1,99 +0,0 @@ -[[release_notes_8_15]] -=== 8.15 Release notes - -[discrete] -[[release_notes_8_15_0]] -=== 8.15.0 Release notes - -[discrete] -==== Client -* Tested versions of Ruby for 8.15.0: Ruby (MRI) 3.0, 3.1, 3.2 and 3.3. JRuby 9.3 and JRuby 9.4. - -[discrete] -==== API - -[discrete] -===== API changes - -* `cluster.allocation_explain` - `body` is no longer a required parameter. -* `connector.put` - (experimental API) `body` and `connector_id` are no longer required parameters. -* `machine_learning.update_trained_model_deployment` has been promoted to stable from Beta. Adds Integer parameter `number_of_allocations`, updates the model deployment to this number of allocations. -* `snapshot.delete` - Adds `wait_for_completion` Boolean parameter, should this request wait until the operation has completed before returning. - -[discrete] -====== `master_timeout` and `timeout` parameters - -These parameters have been added to several APIs: - -* `master_timeout` timeout for processing on master node. -* `timeout` timeout for acknowledgement of update from all nodes in cluster parameters. - -The APIs: - -* `autoscaling.delete_autoscaling_policy` - both. -* `autoscaling.get_autoscaling_capacity`- `master_timeout`. -* `get_autoscaling_policy` - `master_timeout`. -* `put_autoscaling_policy` - both. -* `enrich.delete_policy` - `master_timeout`. -* `enrich.execute_policy` - `master_timeout`. -* `enrich.get_policy` - `master_timeout`. -* `enrich.put_policy` - `master_timeout`. -* `enrich.stats` - `master_timeout`. -* `features.reset_features` - `master_timeout`. -* `license.delete` - both. -* `license.post` - both. -* `license.post_start_basic` - both. -* `license.post_start_trial` - both. -* `security.get_settings` - `master_timeout`. -* `security.update_settings` - both. -* `shutdown.get_node` - `master_timeout`. -* `snapshot_lifecycle_management.start` - both. -* `snapshot_lifecycle_management.stop` - both. -* `watcher.get_settings` - `master_timeout`. -* `watcher.start` - `master_timeout`. -* `watcher.stop` - `master_timeout`. -* `watcher.update_settings` - both. - -[discrete] -====== Inference APIs have been renamed: - -* `inference.delete_model` => `inference.delete`. Also adds two new parameters: -** `dry_run` (Boolean), if true the endpoint will not be deleted and a list of ingest processors which reference this endpoint will be returned. -** `force` (Boolean), if true the endpoint will be forcefully stopped (regardless of whether or not it is referenced by any ingest processors or semantic text fields). -* `inference.get_model` => `inference.get` -* `inference.put_model` => `inference.put` - -[discrete] -====== Query Rules parameters consolidated - -Changes in `query_ruleset` and `query_rules` APIs, These have been combined into the `query_rules` namespace: - -* `query_rules.delete_ruleset` - Renamed from `query_ruleset.delete`, promoted from experimental to stable. -* `query_rules.delete_rule` - Deletes an individual query rule within a ruleset. -* `query_rules.get_rule` - Returns the details about an individual query rule within a ruleset. -* `query_rules.get_ruleset` - Renamed from `query_ruleset.get`, promoted from experimental to stable. -* `query_rules.list_rulesets` - Renamed from `query_ruleset.list`, promoted from experimental to stable. -* `query_rules.put_rule` - Creates or updates a query rule within a ruleset. -* `query_rules.put_ruleset` - Renamed from `query_ruleset.put_ruleset`, promoted from experimental to stable. - -[discrete] -===== New APIs: - -* `ingest.delete_geoip_database` - Deletes a geoip database configuration. -* `ingest.get_geoip_database` - Returns geoip database configuration. -* `ingest.put_geoip_database` - Puts the configuration for a geoip database to be downloaded. -* `security.bulk_delete_role` - Bulk delete roles in the native realm. -* `security.bulk_put_role` - Bulk adds and updates roles in the native realm. -* `security.query_role` - Retrieves information for Roles using a subset of query DSL. -* `transform.get_node_stats` - Retrieves transform usage information for transform nodes. - -[discrete] -===== New Experimental APIs: - -* `connector.sync_job_claim` - Claims a connector sync job. -* `connector.update_features` - Updates the connector features in the connector document. - -[discrete] -==== Development - -- Added a build using https://github.com/elastic/es-test-runner-ruby[es-test-runner-ruby] and https://github.com/elastic/elasticsearch-clients-tests[Elasticsearch Clients Tests] which will replace the Elasticsearch YAML test runner. diff --git a/docs/release_notes/816.asciidoc b/docs/release_notes/816.asciidoc deleted file mode 100644 index c32e719f57..0000000000 --- a/docs/release_notes/816.asciidoc +++ /dev/null @@ -1,57 +0,0 @@ -[[release_notes_8_16]] -=== 8.16 Release notes - -[discrete] -[[release_notes_8_16_0]] -=== 8.16.0 Release notes - -[discrete] -==== Client -* Tested versions of Ruby for 8.16.0: Ruby (MRI) 3.1, 3.2 and 3.3. JRuby 9.3 and JRuby 9.4. - -[discrete] -==== API - -[discrete] -===== API changes - -* `capabilities` - Adds `local_only` boolean parameter: True if only the node being called should be considered. -* `cluster.stats`- Removes `flat_settings` parameter, adds `include_remotes` boolean parameter: Include remote cluster data into the response (default: false). -* `indices.get_data_stream` - Adds `verbose` boolean parameter: Whether the maximum timestamp for each data stream should be calculated and returned (default: false). Adds `master_timeout` (see below). -* `query_rules.delete_ruleset` - Accepts `ignore: 404` common parameter. - -These parameters have been added to several APIs: - -* `master_timeout` timeout for processing on master node. -* `timeout` timeout for acknowledgement of update from all nodes in cluster parameters. - -Added in: - -* `indices.create_data_stream` - both. -* `indices.delete_data_stream` - `master_timeout`. -* `indices.get_data_lifecycle` - `master_timeout`. -* `indices.get_data_stream` - `master_timeout`. -* `indices.migrate_to_data_stream` - both. -* `indices.promote_data_stream` - `master_timeout`. -* `search_shards` - `master_timeout`. - -**APIs Promoted from Experimental to Stable:** - -* `indices.delete_data_lifecycle` -* `indices.explain_data_lifecycle` -* `indices.get_data_lifecycle` -* `indices.put_data_lifecycle` -* `security.create_cross_cluster_api_key` -* `security.update_cross_cluster_api_key` - -**New APIs** - -* `ingest.delete_ip_location_database` - Deletes an ip location database configuration. -* `ingest.get_ip_location_database` - Returns the specified ip location database configuration. -* `ingest.put_ip_location_database` - Puts the configuration for a ip location database to be downloaded. - - -**New Experimental APIs** - -* `inference.stream_inference` - Perform streaming inference. -* `query_rules.test` - Tests a query ruleset to identify the rules that would match input criteria. diff --git a/docs/release_notes/817.asciidoc b/docs/release_notes/817.asciidoc deleted file mode 100644 index 2963eeb0d1..0000000000 --- a/docs/release_notes/817.asciidoc +++ /dev/null @@ -1,20 +0,0 @@ -[[release_notes_8_17]] -=== 8.17 Release notes - -[discrete] -[[release_notes_8_17_0]] -=== 8.17.0 Release notes - -[discrete] -==== Client -* Tested versions of Ruby for 8.17.0: Ruby (MRI) 3.1, 3.2 and 3.3. JRuby 9.3 and JRuby 9.4. - -[discrete] -==== API - -[discrete] -===== API changes -* `async_search.submit` - Removes `keep_alive` parameter. Adds: -** `ccs_minimize_roundtrips` (Boolean): When doing a cross-cluster search, setting it to true may improve overall search latency, particularly when searching clusters with a large number of shards. However, when set to true, the progress of searches on the remote clusters will not be received until the search finishes on all clusters. -** `rest_total_hits_as_int` (Boolean): Indicates whether hits.total should be rendered as an integer or an object in the rest search response. -* `open_point_in_time` - Adds `allow_partial_search_results` (Boolean) parameter: Specify whether to tolerate shards missing when creating the point-in-time, or otherwise throw an exception (default: false). diff --git a/docs/release_notes/82.asciidoc b/docs/release_notes/82.asciidoc deleted file mode 100644 index 401958b6c7..0000000000 --- a/docs/release_notes/82.asciidoc +++ /dev/null @@ -1,49 +0,0 @@ -[[release_notes_82]] -=== 8.2 Release notes - -[discrete] -[[release_notes_822]] -=== 8.2.2 Release notes - -- Updates dependency on `elastic-transport` to `~> 8.0` - - -[discrete] -[[release_notes_821]] -=== 8.2.1 Release notes - -No release, no changes on the client. - -[discrete] -[[release_notes_820]] -=== 8.2.0 Release notes - - -- Tested versions of Ruby for 8.2.0: Ruby (MRI) 2.7, 3.0 and 3.1, JRuby 9.3. - -[discrete] -==== API - -Updated for compatibility with Elasticsearch 8.2's API. - -[discrete] -===== New parameters: - -* `field_caps` -** `filters` An optional set of filters: can include +metadata,-metadata,-nested,-multifield,-parent -** `types` Only return results for fields that have one of the types in the list - -[discrete] -===== New APIs - -- `cat.component_templates` - Returns information about existing component_templates templates. -- `ml.get_memory_stats` - Returns information on how ML is using memory. - -[discrete] -===== New Experimental APIs -- `security.activate_user_profile` - Creates or updates the user profile on behalf of another user. -- `security.disable_user_profile` - Disables a user profile so it's not visible in user profile searches. -- `security.enable_user_profile` - Enables a user profile so it's visible in user profile searches. -- `security.get_user_profile` - Retrieves a user profile for the given unique ID. -- `security.suggest_user_profiles` - Get suggestions for user profiles that match specified search criteria. -- `security.update_user_profile_data` - Update application specific data for the user profile of the given unique ID. diff --git a/docs/release_notes/83.asciidoc b/docs/release_notes/83.asciidoc deleted file mode 100644 index aa0b2d8d53..0000000000 --- a/docs/release_notes/83.asciidoc +++ /dev/null @@ -1,33 +0,0 @@ -[[release_notes_83]] -=== 8.3 Release notes - -[discrete] -[[release_notes_830]] -=== 8.3.0 Release notes - -- Tested versions of Ruby for 8.3.0: Ruby (MRI) 2.7, 3.0 and 3.1, JRuby 9.3. - -[discrete] -==== API - -- Added build hash to auto generated code. The code generator obtains the git hash from the Elasticsearch specification and adds it as a comment in the code. This allows us to track the version for each generated class. -- Updated for compatibility with Elasticsearch 8.3's API. - -[discrete] -===== API Changes - -* `cluster.delete_voting_config_exclusions`, `cluster.post_voting_config_exclusions` - Add new parameter `master_timeout` (Time) Timeout for submitting request to master. -* `machine_learning.infer_trained_model_deployment` is renamed to `machine_learning.infer_trained_model`. The url `/_ml/trained_models/{model_id}/deployment/_infer` is deprecated since 8.3, use `/_ml/trained_models/{model_id}/_infer` instead. -* `machine_learning.preview_datafeed` - Adds new parameters: -** `start` (String) The start time from where the datafeed preview should begin -** `end` (String) The end time when the datafeed preview should stop -* `machine_learning.start_trained_model_deployment` - Adds new parameters: -** `number_of_allocations` (Integer) The number of model allocations on each node where the model is deployed. -** `threads_per_allocation` (Integer) The number of threads used by each model allocation during inference. -** `queue_capacity` (Integer) Controls how many inference requests are allowed in the queue at a time. -* `search_mvt` - Adds new parameter: `with_labels` (Boolean) If true, the hits and aggs layers will contain additional point features with suggested label positions for the original features -* `snapshot.get` - Adds new parameter: `index_names` (Boolean) Whether to include the name of each index in the snapshot. Defaults to true. - -[discrete] -===== New Experimental APIs -* `security.has_privileges_user_profile` Determines whether the users associated with the specified profile IDs have all the requested privileges diff --git a/docs/release_notes/84.asciidoc b/docs/release_notes/84.asciidoc deleted file mode 100644 index 19901f675e..0000000000 --- a/docs/release_notes/84.asciidoc +++ /dev/null @@ -1,31 +0,0 @@ -[[release_notes_84]] -=== 8.4 Release notes - -[discrete] -[[release_notes_840]] -=== 8.4.0 Release notes - -- Tested versions of Ruby for 8.4.0: Ruby (MRI) 2.7, 3.0 and 3.1, JRuby 9.3. - -[discrete] -==== API - -[discrete] -===== New APIs - -* `security.update_api_key` - Updates attributes of an existing API key. https://www.elastic.co/guide/en/elasticsearch/reference/8.4/security-api-update-api-key.html[Documentation]. - -[discrete] -===== API Changes -* `get` - Adds new parameter `force_synthetic_source` (Boolean) Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index. -* `machine_learning.start_trained_model_deployment` - Adds new parameter `cache_size` (String) A byte-size value for configuring the inference cache size. For example, 20mb. -* `mget` - Adds new parameter `force_synthetic_source` (Boolean) Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index. -* `search` - Adds new parameter `force_synthetic_source` (Boolean) Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index. -* `snapshot.get` - Adds new parameters: -** `sort` (String) Allows setting a sort order for the result. Defaults to start_time (options: start_time, duration, name, repository, index_count, shard_count, failed_shard_count). -** `size` (Integer) Maximum number of snapshots to return. Defaults to 0 which means return all that match without limit. -** `order` (String) Sort order (options: asc, desc). -** `from_sort_value` (String) Value of the current sort column at which to start retrieval. -** `after` (String) Offset identifier to start pagination from as returned by the 'next' field in the response body. -** `offset` (Integer) Numeric offset to start pagination based on the snapshots matching the request. Defaults to 0. -** `slm_policy_filter` (String) Filter snapshots by a comma-separated list of SLM policy names that snapshots belong to. Accepts wildcards. Use the special pattern '_none' to match snapshots without an SLM policy. diff --git a/docs/release_notes/85.asciidoc b/docs/release_notes/85.asciidoc deleted file mode 100644 index 4ba0e56497..0000000000 --- a/docs/release_notes/85.asciidoc +++ /dev/null @@ -1,105 +0,0 @@ -[[release_notes_85]] -=== 8.5 Release notes - -[discrete] -[[release_notes_852]] -=== 8.5.2 Release notes - -[discrete] -==== API Bugfix - -Fixes `security.create_service_token` API, uses `POST` when token name isn't present. -Thanks https://github.com/carlosdelest[@carlosdelest] for reporting in https://github.com/elastic/elasticsearch-ruby/pull/1961[#1961]. - -[discrete] -[[release_notes_851]] -=== 8.5.1 Release notes - -[discrete] -==== Bugfixes - -Fixes bug when instantiating client with `api_key`: When passing in `api_key` and `transport_options` that don't include headers to the client, the `api_key` code would overwrite the arguments passed in for `transport_options`. This was fixed in https://github.com/elastic/elasticsearch-ruby/pull/1941/files[this Pull Request]. -Thanks @svdasein for reporting in https://github.com/elastic/elasticsearch-ruby/issues/1940[#1940]. - -[discrete] -[[release_notes_850]] -=== 8.5.0 Release notes - -- Tested versions of Ruby for 8.5.0: Ruby (MRI) 2.7, 3.0 and 3.1, JRuby 9.3. - -[discrete] -==== Client - -With the latest release of `elastic-transport` - `v8.1.0` - this gem now supports Faraday v2. Elasticsearch Ruby has an open dependency on `elastic-transport` (`'elastic-transport', '~> 8'`), so when you upgrade your gems, `8.1.0` will be installed. This supports both Faraday v1 and Faraday v2. The main change on dependencies when using Faraday v2 is all adapters, except for the default `net_http` one, have been moved out of Faraday into separate gems. This means if you're not using the default adapter and you migrate to Faraday v2, you'll need to add the adapter gems to your Gemfile. - -These are the gems required for the different adapters with Faraday 2, instead of the libraries on which they were based: - -[source,ruby] ------------------------------------- -# HTTPCLient -gem 'faraday-httpclient' - -# NetHTTPPersistent -gem 'faraday-net_http_persistent' - -# Patron -gem 'faraday-patron' - -# Typhoeus -gem 'faraday-typhoeus' ------------------------------------- - -Things should work fine if you migrate to Faraday 2 as long as you include the adapter (unless you're using the default one `net-http`), but worst case scenario, you can always lock the version of Faraday in your project to 1.x: -gem 'faraday', '~> 1' - -Be aware if migrating to Faraday v2 that it requires at least Ruby `2.6`, unlike Faraday v1 which requires `2.4`. - -*Troubleshooting* - -If you see a message like: - -[source,ruby] ------------------------------------- -:adapter is not registered on Faraday::Adapter (Faraday::Error) ------------------------------------- -Then you probably need to include the adapter library in your gemfile and require it. - -Please https://github.com/elastic/elasticsearch-ruby/issues[submit an issue] if you encounter any problems. - -[discrete] -==== API - -[discrete] -===== New APIs - -- `machine_learning.clear_trained_model_deployment_cache` - Clear the cached results from a trained model deployment (Beta). -- `security.bulk_update_api_keys` - Updates the attributes of multiple existing API keys. - -[discrete] -===== API Changes - -- `rollup.rollup` renamed to `indices.downsample`. The method now receives the `index` to downsample (Required) and instead of `rollup_index`, use target_index as the index to store downsampled data. - -- `security.get_api_key` and `security.query_api_keys` add `:with_limited_by` flag to show the limited-by role descriptors of API Keys. -- `security.get_user` adds `:with_profile_uid` flag to retrieve profile uid (if exists) associated to the user. -- `security.get_user_profile` now retrieves user profiles for given unique ID(s). `:uid` is now a list of comma-separated list of unique identifier for user profiles. -- `text_structure.find_structure` adds `:ecs_compatibility`, optional parameter to specify the compatibility mode with ECS Grok patterns - may be either 'v1' or 'disabled'. - -Machine learning APIs promoted from *Experimental* to *Beta*: - -- `machine_learning.clear_trained_model_deployment_cache.rb` -- `machine_learning.infer_trained_model.rb` -- `machine_learning.put_trained_model_definition_part.rb` -- `machine_learning.put_trained_model_vocabulary.rb` -- `machine_learning.start_trained_model_deployment.rb` -- `machine_learning.stop_trained_model_deployment.rb` - -Security usef profile APIs promoted from *Experimental* to *Stable*: - -- `security/activate_user_profile` -- `security/disable_user_profile` -- `security/enable_user_profile` -- `security/get_user_profile` -- `security/has_privileges_user_profile` -- `security/suggest_user_profile` -- `security/update_user_profile_data` diff --git a/docs/release_notes/86.asciidoc b/docs/release_notes/86.asciidoc deleted file mode 100644 index 88a7ad47d2..0000000000 --- a/docs/release_notes/86.asciidoc +++ /dev/null @@ -1,23 +0,0 @@ -[[release_notes_86]] -=== 8.6 Release notes - -[discrete] -[[release_notes_860]] -=== 8.6.0 Release notes - -- Tested versions of Ruby for 8.6.0: Ruby (MRI) 2.7, 3.0, 3.1 and **3.2**. JRuby 9.3 and **JRuby 9.4**. - -[discrete] -==== API - -[discrete] -===== New APIs - -- `update_trained_model_deployment` - Updates certain properties of trained model deployment (This functionality is in Beta and is subject to change). - -[discrete] -===== API Changes - -- `cluster.reroute` - `:metric` parameter adds `none` as an option. -- `ml.start_trained_model_deployment` - New parameter `:priority` (String), the deployment priority - diff --git a/docs/release_notes/87.asciidoc b/docs/release_notes/87.asciidoc deleted file mode 100644 index f58e0856c6..0000000000 --- a/docs/release_notes/87.asciidoc +++ /dev/null @@ -1,35 +0,0 @@ -[[release_notes_87]] -=== 8.7 Release notes - -[discrete] -[[release_notes_871]] -=== 8.7.1 Release notes - -[discrete] -==== API Bugfix - -- Updates `logstash.get_pipeline`, fixed in the specification `id` is not a required parameter, so removes raising `ArgumentError` when id is not present. - - -[discrete] -[[release_notes_870]] -=== 8.7.0 Release notes - -- Tested versions of Ruby for 8.7.0: Ruby (MRI) 2.7, 3.0, 3.1 and **3.2**. JRuby 9.3 and JRuby 9.4. Ruby 2.7's end of life is coming in a few days, so this'll probably be the last release to test for Ruby 2.7. - -[discrete] -==== API - -[discrete] -===== New APIs - -- `health_report` - Returns the health of the cluster. -- `transform.schedule_now_transform` - Schedules now a transform. - -[discrete] -===== API Changes - -- `transform.get_transform_stats` - Adds `timeout` (Time) parameter. Controls the time to wait for the stats. -- `transform.start_transform` - Adds `from` (String) parameter. Restricts the set of transformed entities to those changed after this time. -- `ml.delete_job`, `ml.reset_job` - Add `delete_user_annotations` (Boolean) parameter. Should annotations added by the user be deleted. -- `ml.clear_trained_model_deployment_cache`, `ml.infer_trained_model`, `ml.put_trained_model_definition_part`, `ml.put_trained_model_vocabulary`, `ml.start_trained_model_deployment`, `ml.stop_trained_model_deployment` - These APIs are no longer in Beta. diff --git a/docs/release_notes/88.asciidoc b/docs/release_notes/88.asciidoc deleted file mode 100644 index 13f093fd07..0000000000 --- a/docs/release_notes/88.asciidoc +++ /dev/null @@ -1,47 +0,0 @@ -[[release_notes_88]] -=== 8.8 Release notes - -[discrete] -[[release_notes_880]] -=== 8.8.0 Release notes - -- Tested versions of Ruby for 8.8.0: Ruby (MRI) 3.0, 3.1 and **3.2**. JRuby 9.3 and JRuby 9.4. - -[discrete] -==== API - -- Updates development dependency `minitest-reporters` to `>= 1.6` to include showing failures at the end of the test run. - -[discrete] -===== New APIs - -- `watcher.get_settings` - Retrieve settings for the watcher system index. -- `watcher.update_settings` - Update settings for the watcher system index. - -[discrete] -===== New Experimental APIs - -- `indices.delete_data_lifecycle`- Deletes the data lifecycle of the selected data streams -- `indices.explain_data_lifecycle` - Retrieves information about the index's current DLM lifecycle, such as any potential encountered error, time since creation etc. -- `indices.get_data_lifecycle` - Returns the data lifecycle of the selected data streams. -- `indices.put_data_lifecycle` - Updates the data lifecycle of the selected data streams. -- `search_application.delete` - Deletes a search application. -- `search_application.delete_behavioral_analytics` - Delete a behavioral analytics collection. -- `search_application.get` - Returns the details about a search application. -- `search_application.get_behavioral_analytics` - Returns the existing behavioral analytics collections. -- `search_application.list` - Returns the existing search applications. -- `search_application.post_behavioral_analytics_event` - Creates a behavioral analytics event for existing collection. -- `search_application.put` - Creates or updates a search application. -- `search_application.put_behavioral_analytics` - Creates a behavioral analytics collection. -- `search_application.search` - Perform a search against a search application. - -[discrete] -===== API Changes - -- `clear_scroll` now works with the argument `ignore: 404`. https://github.com/elastic/elasticsearch-ruby/issues/2067[Issue on GitHub]. -- The code generator was updated to fix a bug for `ignore: 404`. APIs that were supposed to support this wouldn't parse the parameters correctly. The support it now: `security.get_role`, `watcher.delete_watch` -- `cluster.get_component_template`, `indices.get_data_stream`, `indices.get_index_template`, `indices.simulate_index_template`, `indices.simulate_template` - Add `include_defaults` (Boolean) parameter: Return all default configurations for the component template (default: false). -- `machine_learning.put_trained_model` - Adds `wait_for_completion` (Boolean) parameter: Whether to wait for all child operations(e.g. model download) to complete, before returning or not (default: false). -- `machine_learning.start_trained_model_deployment` - Adds `deployiment_id` (String) parameter: The Id of the new deployment. Defaults to the model_id if not set. -- `search` - Adds `include_named_queries_score` (Boolean) parameter: Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false). -- `transform.delete_transform` - Adds `delete_dest_index` (Boolean) parameter: When `true`, the destination index is deleted together with the transform. The default value is `false`, meaning that the destination index will not be deleted. diff --git a/docs/release_notes/89.asciidoc b/docs/release_notes/89.asciidoc deleted file mode 100644 index de0f431856..0000000000 --- a/docs/release_notes/89.asciidoc +++ /dev/null @@ -1,54 +0,0 @@ -[[release_notes_89]] -=== 8.9 Release notes - -[discrete] -[[release_notes_890]] -=== 8.9.0 Release notes - -[discrete] -=== Client -* Tested versions of Ruby for 8.9.0: Ruby (MRI) 3.0, 3.1 and 3.2. JRuby 9.3 and JRuby 9.4. -* Updated product validation. The code for the product validation was refactored in a few ways: -** Just check header, does not check the version of the server. -** Warns only once when there's a general server error. -** Removes the call to '/' (client.info) when doing the first request, checking on the first actual request from the client. -* Fixes User-Agent code. In the migration to 8.x, the user agent code was extracted into transport, since we're now using that library in other projects. So for the Elasticsearch Client, the user-agent would be reported as the one defined in elastic-transport. This release fixes the issue and brings back the user agent in the format that was being used in 7.x - -[discrete] -=== Helpers -This release introduces two new Helpers in the client: - -* BulkHelper - This helper provides a better developer experience when using the Bulk API. At its simplest, you can send it a collection of hashes in an array, and it will bulk ingest them into {es}. -* ScrollHelper - This helper provides an easy way to get results from a Scroll. - -See <> to read more about them. - -[discrete] -=== API - -[discrete] -==== New APIs - -* `cluster.info` - Returns different information about the cluster. - -[discrete] -==== New Experimental APIs and namespaces: - -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. - -* New namespace: `query_ruleset` -** `query_ruleset.delete` - Deletes a query ruleset. -** `query_ruleset.get` - Returns the details about a query ruleset. -** `query_ruleset.put` - Creates or updates a query ruleset. -* New API: `search_application.render_query` Renders a query for given search application search parameters. -* New API: `security.create_cross_cluster_api_key` - Creates a cross-cluster API key for API key based remote cluster access. -* New API: `security.upate_cross_cluster_api_key` - Updates attributes of an existing cross-cluster API key. -* New namespace: `synonyms` -** `synonyms.delete`- Deletes a synonym set -** `synonyms.get` - Retrieves a synonym set -** `synonyms.put` - Creates or updates a synonyms set -* New namespace: `synonym_rule` -** `synonym_rule.put` - Creates or updates a synonym rule in a synonym set -* New namespace: `synonyms` -** `synonyms_set.get` - Retrieves a summary of all defined synonym sets - diff --git a/docs/release_notes/index.asciidoc b/docs/release_notes/index.asciidoc deleted file mode 100644 index 3b2ef35788..0000000000 --- a/docs/release_notes/index.asciidoc +++ /dev/null @@ -1,74 +0,0 @@ -[[release_notes]] -== Release Notes - -[discrete] -=== 8.x - -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> - -[discrete] -=== 7.x -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> -* <> - -include::817.asciidoc[] -include::816.asciidoc[] -include::815.asciidoc[] -include::814.asciidoc[] -include::813.asciidoc[] -include::812.asciidoc[] -include::811.asciidoc[] -include::810.asciidoc[] -include::89.asciidoc[] -include::88.asciidoc[] -include::87.asciidoc[] -include::86.asciidoc[] -include::85.asciidoc[] -include::84.asciidoc[] -include::83.asciidoc[] -include::82.asciidoc[] -include::81.asciidoc[] -include::80.asciidoc[] -include::717.asciidoc[] -include::716.asciidoc[] -include::715.asciidoc[] -include::714.asciidoc[] -include::713.asciidoc[] -include::712.asciidoc[] -include::711.asciidoc[] -include::710.asciidoc[] -include::79.asciidoc[] -include::78.asciidoc[] -include::77.asciidoc[] -include::76.asciidoc[] -include::75.asciidoc[] -include::70.asciidoc[] diff --git a/docs/troubleshooting.asciidoc b/docs/troubleshooting.asciidoc deleted file mode 100644 index a2e6a19e05..0000000000 --- a/docs/troubleshooting.asciidoc +++ /dev/null @@ -1,97 +0,0 @@ -[[troubleshooting]] -== Troubleshooting - -Use the information in this section to troubleshoot common problems and find -answers for frequently asked questions. - - -[discrete] -[[ruby-ts-logging]] -=== Logging - -The client provides several options for logging that can help when things go -wrong. Check out the extensive documentation on <>. - -If you are having trouble sending a request to {es} with the client, we suggest -enabling `tracing` on the client and testing the cURL command that appears in -your terminal: - -[source,rb] ----------------------------- -client = Elasticsearch::Client.new(trace: true) -client.info -curl -X GET -H 'x-elastic-client-meta: es=8.9.0,rb=3.2.2,t=8.2.1,fd=2.7.4,nh=0.3.2, User-Agent: elastic-t -ransport-ruby/8.2.1 (RUBY_VERSION: 3.2.2; linux x86_64; Faraday v2.7.4), Content-Type: application/json' 'http://localhost:9200//?pretty' ----------------------------- - -Testing the cURL command can help find out if there's a connection issue or if -the issue is in the client code. - - -[discrete] -[[ruby-ts-connection]] -=== Troubleshooting connection issues - -When working with multiple hosts, you might want to enable the -`retry_on_failure` or `retry_on_status` options to perform a failed request on -another node (refer to <>). - -For optimal performance, use a HTTP library which supports persistent -("keep-alive") connections, such as https://github.com/toland/patron[patron] or -https://github.com/typhoeus/typhoeus[Typhoeus]. Require the library -(`require 'patron'`) in your code for Faraday 1.x or the adapter -(`require 'faraday/patron'`) for Faraday 2.x, and it will be automatically used. - - -[discrete] -[[ruby-ts-adapter]] -=== Adapter is not registered on Faraday - -If you see a message like: -``` -:adapter is not registered on Faraday::Adapter (Faraday::Error) -``` - -Then you might need to include the adapter library in your Gemfile and require -it. You might get this error when migrating from Faraday v1 to Faraday v2. The -main change when using Faraday v2 is all adapters, except for the default -`net_http` one, have been moved out into separate gems. This means if you're not -using the default adapter and you migrate to Faraday v2, you'll need to add the -adapter gems to your Gemfile. - -These are the gems required for the different adapters with Faraday 2, instead -of the libraries on which they were based: - -[source,ruby] ------------------------------------- -# HTTPCLient -gem 'faraday-httpclient' - -# NetHTTPPersistent -gem 'faraday-net_http_persistent' - -# Patron -gem 'faraday-patron' - -# Typhoeus -gem 'faraday-typhoeus' ------------------------------------- - -Migrating to Faraday 2 solves the issue as long as the adapter is included -(unless you're using the default one `net-http`). Alternatively, you can lock -the version of Faraday in your project to 1.x: -`gem 'faraday', '~> 1'` - -IMPORTANT: Migrating to Faraday v2 requires at least Ruby `2.6`. Faraday v1 -requires `2.4`. - -[discrete] -=== More Help - -If you need more help, visit the -https://discuss.elastic.co/[Elastic community forums] and get answers from the -experts in the community, including people from Elastic. - -If you find a bug, have feedback, or find any other issue using the client, -https://github.com/elastic/elasticsearch-ruby/issues/new/choose[submit an issue] -on GitHub. \ No newline at end of file diff --git a/elasticsearch-api/Rakefile b/elasticsearch-api/Rakefile index 6c6fa4fcf7..957016d205 100644 --- a/elasticsearch-api/Rakefile +++ b/elasticsearch-api/Rakefile @@ -35,6 +35,7 @@ namespace :test do task :unit RSpec::Core::RakeTask.new(:unit) do |t| t.pattern = 'spec/unit/**/*_spec.rb' + t.exclude_pattern = 'spec/unit/perform_request_spec.rb' unless ENV['TEST_WITH_OTEL'] end desc 'Run unit and integration tests' diff --git a/elasticsearch-api/lib/elasticsearch/api.rb b/elasticsearch-api/lib/elasticsearch/api.rb index 1a8471002e..eddd6bcd1a 100644 --- a/elasticsearch-api/lib/elasticsearch/api.rb +++ b/elasticsearch-api/lib/elasticsearch/api.rb @@ -15,21 +15,19 @@ # specific language governing permissions and limitations # under the License. -require "cgi" -require "multi_json" - -require "elasticsearch/api/version" -require "elasticsearch/api/namespace/common" -require "elasticsearch/api/utils" +require 'cgi' +require 'multi_json' +require 'elasticsearch/api/version' +require 'elasticsearch/api/utils' require 'elasticsearch/api/response' -Dir[ File.expand_path('../api/actions/**/*.rb', __FILE__) ].each { |f| require f } -Dir[ File.expand_path('../api/namespace/**/*.rb', __FILE__) ].each { |f| require f } +Dir[File.expand_path('api/actions/**/*.rb', __dir__)].each { |f| require f } module Elasticsearch # This is the main module for including all API endpoint functions # It includes the namespace modules from ./api/actions module API + include Elasticsearch::API::Actions DEFAULT_SERIALIZER = MultiJson HTTP_GET = 'GET'.freeze @@ -37,58 +35,84 @@ module API HTTP_POST = 'POST'.freeze HTTP_PUT = 'PUT'.freeze HTTP_DELETE = 'DELETE'.freeze - UNDERSCORE_SEARCH = '_search'.freeze - UNDERSCORE_ALL = '_all'.freeze - DEFAULT_DOC = '_doc'.freeze - # Auto-include all namespaces in the receiver + module CommonClient + attr_reader :client + + def initialize(client) + @client = client + end + + def perform_request(method, path, params = {}, body = nil, headers = nil, request_opts = {}) + client.perform_request(method, path, params, body, headers, request_opts) + end + end + + # Add new namespaces to this constant # - def self.included(base) - base.send :include, - Elasticsearch::API::Common, - Elasticsearch::API::Actions, - Elasticsearch::API::Cluster, - Elasticsearch::API::Nodes, - Elasticsearch::API::Indices, - Elasticsearch::API::Ingest, - Elasticsearch::API::Snapshot, - Elasticsearch::API::Tasks, - Elasticsearch::API::Cat, - Elasticsearch::API::Remote, - Elasticsearch::API::DanglingIndices, - Elasticsearch::API::Features, - Elasticsearch::API::AsyncSearch, - Elasticsearch::API::Autoscaling, - Elasticsearch::API::CrossClusterReplication, - Elasticsearch::API::DataFrameTransformDeprecated, - Elasticsearch::API::Enrich, - Elasticsearch::API::Eql, - Elasticsearch::API::Fleet, - Elasticsearch::API::Graph, - Elasticsearch::API::IndexLifecycleManagement, - Elasticsearch::API::License, - Elasticsearch::API::Logstash, - Elasticsearch::API::Migration, - Elasticsearch::API::MachineLearning, - Elasticsearch::API::Rollup, - Elasticsearch::API::SearchableSnapshots, - Elasticsearch::API::Security, - Elasticsearch::API::SnapshotLifecycleManagement, - Elasticsearch::API::SQL, - Elasticsearch::API::SSL, - Elasticsearch::API::TextStructure, - Elasticsearch::API::Transform, - Elasticsearch::API::Watcher, - Elasticsearch::API::XPack, - Elasticsearch::API::SearchApplication, - Elasticsearch::API::Synonyms, - Elasticsearch::API::Esql, - Elasticsearch::API::Inference, - Elasticsearch::API::Simulate, - Elasticsearch::API::Connector, - Elasticsearch::API::QueryRules + API_NAMESPACES = [:async_search, + :cat, + :cross_cluster_replication, + :cluster, + :connector, + :dangling_indices, + :enrich, + :eql, + :esql, + :features, + :fleet, + :graph, + :index_lifecycle_management, + :indices, + :inference, + :ingest, + :license, + :logstash, + :migration, + :machine_learning, + :nodes, + :query_rules, + :search_application, + :searchable_snapshots, + :security, + :simulate, + :snapshot_lifecycle_management, + :snapshot, + :sql, + :ssl, + :synonyms, + :tasks, + :text_structure, + :transform, + :watcher, + :xpack].freeze + + UPPERCASE_APIS = ['sql', 'ssl'].freeze + API_NAMESPACES.each do |namespace| + name = namespace.to_s + module_name = if UPPERCASE_APIS.include?(name) + name.upcase + elsif name == 'xpack' + 'XPack' + else + name.split('_').map(&:capitalize).join + end + class_name = "#{module_name}Client" + + klass = Class.new(Object) do + include CommonClient, Object.const_get("Elasticsearch::API::#{module_name}::Actions") + end + Object.const_set(class_name, klass) + define_method(name) do + instance_variable_set("@#{name}", klass.new(self)) + end end + alias ml machine_learning + alias ilm index_lifecycle_management + alias ccr cross_cluster_replication + alias slm snapshot_lifecycle_management + # The serializer class # def self.serializer diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/delete.rb index 21fefe4527..03a15ee6eb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/delete.rb @@ -15,19 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module AsyncSearch module Actions - # Deletes an async search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted. + # Delete an async search. + # If the asynchronous search is still running, it is cancelled. + # Otherwise, the saved search results are deleted. + # If the Elasticsearch security features are enabled, the deletion of a specific async search is restricted to: the authenticated user that submitted the original search request; users that have the `cancel_task` cluster privilege. # - # @option arguments [String] :id The async search ID + # @option arguments [String] :id A unique identifier for the async search. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-async-search-submit # def delete(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'async_search.delete' } @@ -47,8 +61,8 @@ def delete(arguments = {}) _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_DELETE - path = "_async_search/#{Utils.__listify(_id)}" - params = {} + path = "_async_search/#{Utils.listify(_id)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/get.rb index 92c26c5887..bba9f18e2a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/get.rb @@ -15,22 +15,41 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module AsyncSearch module Actions - # Retrieves the results of a previously submitted async search request given its ID. + # Get async search results. + # Retrieve the results of a previously submitted asynchronous search request. + # If the Elasticsearch security features are enabled, access to the results of a specific async search is restricted to the user or API key that submitted it. # - # @option arguments [String] :id The async search ID - # @option arguments [Time] :wait_for_completion_timeout Specify the time that the request should block waiting for the final response - # @option arguments [Time] :keep_alive Specify the time interval in which the results (partial or final) for this search will be available + # @option arguments [String] :id A unique identifier for the async search. (*Required*) + # @option arguments [Time] :keep_alive The length of time that the async search should be available in the cluster. + # When not specified, the `keep_alive` set with the corresponding submit async request will be used. + # Otherwise, it is possible to override the value and extend the validity of the request. + # When this period expires, the search, if still running, is cancelled. + # If the search is completed, its saved results are deleted. # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response + # @option arguments [Time] :wait_for_completion_timeout Specifies to wait for the search to be completed up until the provided timeout. + # Final results will be returned if available before the timeout expires, otherwise the currently available results will be returned once the timeout expires. + # By default no timeout is set meaning that the currently available results will be returned without any additional wait. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-async-search-submit # def get(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'async_search.get' } @@ -50,7 +69,7 @@ def get(arguments = {}) _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_GET - path = "_async_search/#{Utils.__listify(_id)}" + path = "_async_search/#{Utils.listify(_id)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/status.rb index 4b2008d03d..2137b0e974 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/status.rb @@ -15,20 +15,36 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module AsyncSearch module Actions - # Retrieves the status of a previously submitted async search request given its ID. + # Get the async search status. + # Get the status of a previously submitted async search request given its identifier, without retrieving search results. + # If the Elasticsearch security features are enabled, the access to the status of a specific async search is restricted to: + # * The user or API key that submitted the original async search request. + # * Users that have the `monitor` cluster privilege or greater privileges. # - # @option arguments [String] :id The async search ID - # @option arguments [Time] :keep_alive Specify the time interval in which the results (partial or final) for this search will be available + # @option arguments [String] :id A unique identifier for the async search. (*Required*) + # @option arguments [Time] :keep_alive The length of time that the async search needs to be available. + # Ongoing async searches and any saved search results are deleted after this period. Server default: 5d. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-async-search-submit # def status(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'async_search.status' } @@ -48,7 +64,7 @@ def status(arguments = {}) _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_GET - path = "_async_search/status/#{Utils.__listify(_id)}" + path = "_async_search/status/#{Utils.listify(_id)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/submit.rb b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/submit.rb index 34c9b80ae1..6e7b4327e0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/async_search/submit.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/async_search/submit.rb @@ -15,63 +15,81 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module AsyncSearch module Actions - # Executes a search request asynchronously. + # Run an async search. + # When the primary sort of the results is an indexed field, shards get sorted based on minimum and maximum value that they hold for that field. Partial results become available following the sort criteria that was requested. + # Warning: Asynchronous search does not support scroll or search requests that include only the suggest section. + # By default, Elasticsearch does not allow you to store an async search response larger than 10Mb and an attempt to do this results in an error. + # The maximum allowed size for a stored async search response can be set by changing the `search.max_async_search_response_size` cluster level setting. # - # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices - # @option arguments [Time] :wait_for_completion_timeout Specify the time that the request should block waiting for the final response - # @option arguments [Boolean] :keep_on_completion Control whether the response should be stored in the cluster if it completed within the provided [wait_for_completion] time (default: false) - # @option arguments [Time] :keep_alive Update the time interval in which the results (partial or final) for this search will be available - # @option arguments [Number] :batched_reduce_size The number of shard results that should be reduced at once on the coordinating node. This value should be used as the granularity at which progress results will be made available. - # @option arguments [Boolean] :request_cache Specify if request cache should be used for this request or not, defaults to true + # @option arguments [String, Array] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices + # @option arguments [Time] :wait_for_completion_timeout Blocks and waits until the search is completed up to a certain timeout. + # When the async search completes within the timeout, the response won’t include the ID as the results are not stored in the cluster. Server default: 1s. + # @option arguments [Time] :keep_alive Specifies how long the async search needs to be available. + # Ongoing async searches and any saved search results are deleted after this period. Server default: 5d. + # @option arguments [Boolean] :keep_on_completion If `true`, results are stored for later retrieval when the search completes within the `wait_for_completion_timeout`. + # @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) + # @option arguments [Boolean] :allow_partial_search_results Indicate if an error should be returned if there is a partial search failure or timeout # @option arguments [String] :analyzer The analyzer to use for the query string # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false) - # @option arguments [Boolean] :ccs_minimize_roundtrips When doing a cross-cluster search, setting it to true may improve overall search latency, particularly when searching clusters with a large number of shards. However, when set to true, the progress of searches on the remote clusters will not be received until the search finishes on all clusters. - # @option arguments [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR) + # @option arguments [Integer] :batched_reduce_size Affects how often partial results become available, which happens whenever shard results are reduced. + # A partial reduction is performed every time the coordinating node has received a certain number of new shard responses (5 by default). Server default: 5. + # @option arguments [Boolean] :ccs_minimize_roundtrips The default value is the only supported value. + # @option arguments [String] :default_operator The default operator for query string query (AND or 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] :docvalue_fields A comma-separated list of fields to return as the docvalue representation of a field for each hit + # @option arguments [String, Array] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. # @option arguments [Boolean] :explain Specify whether to return detailed information about score computation as part of a hit - # @option arguments [List] :stored_fields A comma-separated list of stored fields to return as part of a hit - # @option arguments [List] :docvalue_fields A comma-separated list of fields to return as the docvalue representation of a field for each hit - # @option arguments [Number] :from Starting offset (default: 0) - # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled - # @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) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored + # @option arguments [Integer] :max_concurrent_shard_requests The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) - # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response - # @option arguments [String] :q Query in the Lucene query string syntax - # @option arguments [List] :routing A comma-separated list of specific routing values - # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch) - # @option arguments [Number] :size Number of hits to return (default: 10) - # @option arguments [List] :sort A comma-separated list of : pairs - # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return - # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field - # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field - # @option arguments [Number] :terminate_after The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early. - # @option arguments [List] :stats Specific 'tag' of the request for logging and statistical purposes - # @option arguments [String] :suggest_field Specify which field to use for suggestions - # @option arguments [String] :suggest_mode Specify suggest mode (options: missing, popular, always) - # @option arguments [Number] :suggest_size How many suggestions to return in response - # @option arguments [String] :suggest_text The source text for which the suggestions should be returned + # @option arguments [Boolean] :request_cache Specify if request cache should be used for this request or not, defaults to true Server default: true. + # @option arguments [String] :routing A comma-separated list of specific routing values + # @option arguments [String] :search_type Search operation type + # @option arguments [Array] :stats Specific 'tag' of the request for logging and statistical purposes + # @option arguments [String, Array] :stored_fields A comma-separated list of stored fields to return as part of a hit + # @option arguments [String] :suggest_field Specifies which field to use for suggestions. + # @option arguments [String] :suggest_mode Specify suggest mode + # @option arguments [Integer] :suggest_size How many suggestions to return in response + # @option arguments [String] :suggest_text The source text for which the suggestions should be returned. + # @option arguments [Integer] :terminate_after The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early. # @option arguments [Time] :timeout Explicit operation timeout + # @option arguments [Boolean, Integer] :track_total_hits Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number. # @option arguments [Boolean] :track_scores Whether to calculate and return scores even if they are not used for sorting - # @option arguments [Boolean|long] :track_total_hits Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number. - # @option arguments [Boolean] :allow_partial_search_results Indicate if an error should be returned if there is a partial search failure or timeout # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response + # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response # @option arguments [Boolean] :version Specify whether to return document version as part of a hit + # @option arguments [Boolean, String, Array] :_source True or false to return the _source field or not, or a list of fields to return + # @option arguments [String, Array] :_source_excludes A list of fields to exclude from the returned _source field + # @option arguments [String, Array] :_source_includes A list of fields to extract and return from the _source field # @option arguments [Boolean] :seq_no_primary_term Specify whether to return sequence number and primary term of the last modification of each hit - # @option arguments [Number] :max_concurrent_shard_requests The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests + # @option arguments [String] :q Query in the Lucene query string syntax + # @option arguments [Integer] :size Number of hits to return (default: 10) + # @option arguments [Integer] :from Starting offset (default: 0) + # @option arguments [String, Array] :sort A comma-separated list of : pairs + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The search definition using the Query DSL + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-async-search-submit # def submit(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'async_search.submit' } @@ -84,13 +102,13 @@ def submit(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_POST path = if _index - "#{Utils.__listify(_index)}/_async_search" + "#{Utils.listify(_index)}/_async_search" else '_async_search' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/bulk.rb b/elasticsearch-api/lib/elasticsearch/api/actions/bulk.rb index c1a0491414..7dd50e21a2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/bulk.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/bulk.rb @@ -15,32 +15,146 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Allows to perform multiple index/update/delete operations in a single request. + # Bulk index or delete documents. + # Perform multiple `index`, `create`, `delete`, and `update` actions in a single request. + # This reduces overhead and can greatly increase indexing speed. + # If the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias: + # * To use the `create` action, you must have the `create_doc`, `create`, `index`, or `write` index privilege. Data streams support only the `create` action. + # * To use the `index` action, you must have the `create`, `index`, or `write` index privilege. + # * To use the `delete` action, you must have the `delete` or `write` index privilege. + # * To use the `update` action, you must have the `index` or `write` index privilege. + # * To automatically create a data stream or index with a bulk API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege. + # * To make the result of a bulk operation visible to search using the `refresh` parameter, you must have the `maintenance` or `manage` index privilege. + # Automatic data stream creation requires a matching index template with data stream enabled. + # The actions are specified in the request body using a newline delimited JSON (NDJSON) structure: + # + # ``` + # action_and_meta_data + # + # optional_source + # + # action_and_meta_data + # + # optional_source + # + # .... + # action_and_meta_data + # + # optional_source + # + # ``` + # + # The `index` and `create` actions expect a source on the next line and have the same semantics as the `op_type` parameter in the standard index API. + # A `create` action fails if a document with the same ID already exists in the target + # An `index` action adds or replaces a document as necessary. + # NOTE: Data streams support only the `create` action. + # To update or delete a document in a data stream, you must target the backing index containing the document. + # An `update` action expects that the partial doc, upsert, and script and its options are specified on the next line. + # A `delete` action does not expect a source on the next line and has the same semantics as the standard delete API. + # NOTE: The final line of data must end with a newline character (`\n`). + # Each newline character may be preceded by a carriage return (`\r`). + # When sending NDJSON data to the `_bulk` endpoint, use a `Content-Type` header of `application/json` or `application/x-ndjson`. + # Because this format uses literal newline characters (`\n`) as delimiters, make sure that the JSON actions and sources are not pretty printed. + # If you provide a target in the request path, it is used for any actions that don't explicitly specify an `_index` argument. + # A note on the format: the idea here is to make processing as fast as possible. + # As some of the actions are redirected to other shards on other nodes, only `action_meta_data` is parsed on the receiving node side. + # Client libraries using this protocol should try and strive to do something similar on the client side, and reduce buffering as much as possible. + # There is no "correct" number of actions to perform in a single bulk request. + # Experiment with different settings to find the optimal size for your particular workload. + # Note that Elasticsearch limits the maximum size of a HTTP request to 100mb by default so clients must ensure that no request exceeds this size. + # It is not possible to index a single document that exceeds the size limit, so you must pre-process any such documents into smaller pieces before sending them to Elasticsearch. + # For instance, split documents into pages or chapters before indexing them, or store raw binary data in a system outside Elasticsearch and replace the raw data with a link to the external system in the documents that you send to Elasticsearch. + # **Client suppport for bulk requests** + # Some of the officially supported clients provide helpers to assist with bulk requests and reindexing: + # * Go: Check out `esutil.BulkIndexer` + # * Perl: Check out `Search::Elasticsearch::Client::5_0::Bulk` and `Search::Elasticsearch::Client::5_0::Scroll` + # * Python: Check out `elasticsearch.helpers.*` + # * JavaScript: Check out `client.helpers.*` + # * .NET: Check out `BulkAllObservable` + # * PHP: Check out bulk indexing. + # * Ruby: Check out `Elasticsearch::Helpers::BulkHelper` + # **Submitting bulk requests with cURL** + # If you're providing text file input to `curl`, you must use the `--data-binary` flag instead of plain `-d`. + # The latter doesn't preserve newlines. For example: + # + # ``` + # $ cat requests + # { "index" : { "_index" : "test", "_id" : "1" } } + # { "field1" : "value1" } + # $ curl -s -H "Content-Type: application/x-ndjson" -XPOST localhost:9200/_bulk --data-binary "@requests"; echo + # {"took":7, "errors": false, "items":[{"index":{"_index":"test","_id":"1","_version":1,"result":"created","forced_refresh":false}}]} + # ``` + # + # **Optimistic concurrency control** + # Each `index` and `delete` action within a bulk API call may include the `if_seq_no` and `if_primary_term` parameters in their respective action and meta data lines. + # The `if_seq_no` and `if_primary_term` parameters control how operations are run, based on the last modification to existing documents. See Optimistic concurrency control for more details. + # **Versioning** + # Each bulk item can include the version value using the `version` field. + # It automatically follows the behavior of the index or delete operation based on the `_version` mapping. + # It also support the `version_type`. + # **Routing** + # Each bulk item can include the routing value using the `routing` field. + # It automatically follows the behavior of the index or delete operation based on the `_routing` mapping. + # NOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template. + # **Wait for active shards** + # When making bulk calls, you can set the `wait_for_active_shards` parameter to require a minimum number of shard copies to be active before starting to process the bulk request. + # **Refresh** + # Control when the changes made by this request are visible to search. + # NOTE: Only the shards that receive the bulk request will be affected by refresh. + # Imagine a `_bulk?refresh=wait_for` request with three documents in it that happen to be routed to different shards in an index with five shards. + # The request will only wait for those three shards to refresh. + # The other two shards that make up the index do not participate in the `_bulk` request at all. + # You might want to disable the refresh interval temporarily to improve indexing throughput for large bulk requests. + # Refer to the linked documentation for step-by-step instructions using the index settings API. # - # @option arguments [String] :index Default index for items which don't provide one - # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the bulk operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) - # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (options: true, false, wait_for) - # @option arguments [String] :routing Specific routing value - # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [List] :_source True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request - # @option arguments [List] :_source_excludes Default list of fields to exclude from the returned _source field, can be overridden on each sub-request - # @option arguments [List] :_source_includes Default list of fields to extract and return from the _source field, can be overridden on each sub-request - # @option arguments [String] :pipeline The pipeline id to preprocess incoming documents with - # @option arguments [Boolean] :require_alias If true, the request’s actions must target an index alias. Defaults to false. - # @option arguments [Boolean] :require_data_stream If true, the request's actions must target a data stream (existing or to-be-created). Default to false - # @option arguments [Boolean] :list_executed_pipelines Sets list_executed_pipelines for all incoming documents. Defaults to unset (false) - # @option arguments [Boolean] :include_source_on_error True or false if to include the document source in the error message in case of parsing errors. Defaults to true. + # @option arguments [String] :index The name of the data stream, index, or index alias to perform bulk actions on. + # @option arguments [Boolean] :include_source_on_error True or false if to include the document source in the error message in case of parsing errors. Server default: true. + # @option arguments [Boolean] :list_executed_pipelines If `true`, the response will include the ingest pipelines that were run for each index or create. + # @option arguments [String] :pipeline The pipeline identifier to use to preprocess incoming documents. + # If the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request. + # If a final pipeline is configured, it will always run regardless of the value of this parameter. + # @option arguments [String] :refresh If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search. + # If `wait_for`, wait for a refresh to make this operation visible to search. + # If `false`, do nothing with refreshes. + # Valid values: `true`, `false`, `wait_for`. Server default: false. + # @option arguments [String] :routing A custom value that is used to route operations to a specific shard. + # @option arguments [Boolean, String, Array] :_source Indicates whether to return the `_source` field (`true` or `false`) or contains a list of fields to return. + # @option arguments [String, Array] :_source_excludes A comma-separated list of source fields to exclude from the response. + # You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. + # If the `_source` parameter is `false`, this parameter is ignored. + # @option arguments [String, Array] :_source_includes A comma-separated list of source fields to include in the response. + # If this parameter is specified, only these source fields are returned. + # You can exclude fields from this subset using the `_source_excludes` query parameter. + # If the `_source` parameter is `false`, this parameter is ignored. + # @option arguments [Time] :timeout The period each action waits for the following operations: automatic index creation, dynamic mapping updates, and waiting for active shards. + # The default is `1m` (one minute), which guarantees Elasticsearch waits for at least the timeout before failing. + # The actual wait time could be longer, particularly when multiple waits occur. Server default: 1m. + # @option arguments [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operation. + # Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + # The default is `1`, which waits for each primary shard to be active. Server default: 1. + # @option arguments [Boolean] :require_alias If `true`, the request's actions must target an index alias. + # @option arguments [Boolean] :require_data_stream If `true`, the request's actions must target a data stream (existing or to be created). + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [String|Array] :body The operation definition and data (action-data pairs), separated by newlines. Array of Strings, Header/Data pairs, - # or the conveniency "combined" format can be passed, refer to Elasticsearch::API::Utils.__bulkify documentation. + # @option arguments [String|Array] :body operations. Array of Strings, Header/Data pairs, or the conveniency "combined" format can be passed, refer to Elasticsearch::API::Utils.bulkify documentation. # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-bulk # def bulk(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'bulk' } @@ -55,25 +169,25 @@ def bulk(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_POST path = if _index - "#{Utils.__listify(_index)}/_bulk" + "#{Utils.listify(_index)}/_bulk" else '_bulk' end params = Utils.process_params(arguments) payload = if body.is_a? Array - Elasticsearch::API::Utils.__bulkify(body) + Elasticsearch::API::Utils.bulkify(body) else body end - headers.merge!('Content-Type' => 'application/x-ndjson') + Utils.update_ndjson_headers!(headers, transport.options.dig(:transport_options, :headers)) Elasticsearch::API::Response.new( perform_request(method, path, params, payload, headers, request_opts) ) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb index 8c13623618..b7ff709894 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/aliases.rb @@ -15,26 +15,48 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cat module Actions - # Shows information about currently configured aliases to indices including filter and routing infos. + # Get aliases. + # Get the cluster's index aliases, including filter and routing information. + # This API does not return data stream aliases. + # IMPORTANT: CAT APIs are only intended for human consumption using the command line or the Kibana console. They are not intended for use by applications. For application consumption, use the aliases API. # - # @option arguments [List] :name A comma-separated list of alias names to return - # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [List] :h Comma-separated list of column names to display - # @option arguments [Boolean] :help Return help information - # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by - # @option arguments [Boolean] :v Verbose mode. Display column headers - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) - # @option arguments [Time] :master_timeout Timeout for waiting for new cluster state in case it is blocked + # @option arguments [String, Array] :name A comma-separated list of aliases to retrieve. Supports wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or `_all`. + # @option arguments [String, Array] :h A comma-separated list of columns names to display. It supports simple wildcards. + # @option arguments [String, Array] :s List of columns that determine how the table should be sorted. + # Sorting defaults to ascending and can be changed by setting `:asc` + # or `:desc` as a suffix to the column name. + # @option arguments [String, Array] :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`. + # @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. + # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to + # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. + # @option arguments [Boolean] :help When set to `true` will output available columns. This option + # can't be combined with any other query string option. + # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-alias.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-aliases # def aliases(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.aliases' } @@ -53,12 +75,12 @@ def aliases(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _name - "_cat/aliases/#{Utils.__listify(_name)}" + "_cat/aliases/#{Utils.listify(_name)}" else '_cat/aliases' end params = Utils.process_params(arguments) - params[:h] = Utils.__listify(params[:h]) if params[:h] + params[:h] = Utils.listify(params[:h]) if params[:h] Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/allocation.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/allocation.rb index f37b53e12d..83e81de14d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/allocation.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/allocation.rb @@ -15,27 +15,47 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cat module Actions - # Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using. + # Get shard allocation information. + # Get a snapshot of the number of shards allocated to each data node and their disk space. + # IMPORTANT: CAT APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. # - # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information - # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) - # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [List] :h Comma-separated list of column names to display - # @option arguments [Boolean] :help Return help information - # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by - # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String, Array] :node_id A comma-separated list of node identifiers or names used to limit the returned information. + # @option arguments [String] :bytes The unit used to display byte values. + # @option arguments [String, Array] :h A comma-separated list of columns names to display. It supports simple wildcards. + # @option arguments [String, Array] :s List of columns that determine how the table should be sorted. + # Sorting defaults to ascending and can be changed by setting `:asc` + # or `:desc` as a suffix to the column name. + # @option arguments [Boolean] :local If `true`, the request computes the list of selected nodes from the + # local cluster state. If `false` the list of selected nodes are computed + # from the cluster state of the master node. In both cases the coordinating + # node will send requests for further information to each selected node. + # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. + # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to + # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. + # @option arguments [Boolean] :help When set to `true` will output available columns. This option + # can't be combined with any other query string option. + # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-allocation.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-allocation # def allocation(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.allocation' } @@ -54,12 +74,12 @@ def allocation(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _node_id - "_cat/allocation/#{Utils.__listify(_node_id)}" + "_cat/allocation/#{Utils.listify(_node_id)}" else '_cat/allocation' end params = Utils.process_params(arguments) - params[:h] = Utils.__listify(params[:h]) if params[:h] + params[:h] = Utils.listify(params[:h]) if params[:h] Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/component_templates.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/component_templates.rb index 0765a09a55..62fb05455f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/component_templates.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/component_templates.rb @@ -15,26 +15,50 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cat module Actions - # Returns information about existing component_templates templates. + # Get component templates. + # Get information about component templates in a cluster. + # Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. + # 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 get component template API. # - # @option arguments [String] :name A pattern that returned component template names must match - # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [List] :h Comma-separated list of column names to display - # @option arguments [Boolean] :help Return help information - # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by - # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :name The name of the component template. + # It accepts wildcard expressions. + # If it is omitted, all component templates are returned. + # @option arguments [String, Array] :h A comma-separated list of columns names to display. It supports simple wildcards. + # @option arguments [String, Array] :s List of columns that determine how the table should be sorted. + # Sorting defaults to ascending and can be changed by setting `:asc` + # or `:desc` as a suffix to the column name. + # @option arguments [Boolean] :local If `true`, the request computes the list of selected nodes from the + # local cluster state. If `false` the list of selected nodes are computed + # from the cluster state of the master node. In both cases the coordinating + # node will send requests for further information to each selected node. + # @option arguments [Time] :master_timeout The period to wait for a connection to the master node. Server default: 30s. + # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to + # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. + # @option arguments [Boolean] :help When set to `true` will output available columns. This option + # can't be combined with any other query string option. + # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-component-templates.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-component-templates # def component_templates(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.component_templates' } @@ -53,7 +77,7 @@ def component_templates(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _name - "_cat/component_templates/#{Utils.__listify(_name)}" + "_cat/component_templates/#{Utils.listify(_name)}" else '_cat/component_templates' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/count.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/count.rb index 8afd4cade6..109e7c3f5f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/count.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/count.rb @@ -15,24 +15,45 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cat module Actions - # Provides quick access to the document count of the entire cluster, or individual indices. + # Get a document count. + # Get quick access to a document count for a data stream, an index, or an entire cluster. + # The document count only includes live documents, not deleted documents which have not yet been removed by the merge process. + # 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 count API. # - # @option arguments [List] :index A comma-separated list of index names to limit the returned information - # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [List] :h Comma-separated list of column names to display - # @option arguments [Boolean] :help Return help information - # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by - # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String, Array] :index A comma-separated list of data streams, indices, and aliases used to limit the request. + # It supports wildcards (`*`). + # To target all data streams and indices, omit this parameter or use `*` or `_all`. + # @option arguments [String, Array] :h A comma-separated list of columns names to display. It supports simple wildcards. + # @option arguments [String, Array] :s List of columns that determine how the table should be sorted. + # Sorting defaults to ascending and can be changed by setting `:asc` + # or `:desc` as a suffix to the column name. + # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to + # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. + # @option arguments [Boolean] :help When set to `true` will output available columns. This option + # can't be combined with any other query string option. + # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-count.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-count # def count(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.count' } @@ -45,18 +66,18 @@ def count(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_GET path = if _index - "_cat/count/#{Utils.__listify(_index)}" + "_cat/count/#{Utils.listify(_index)}" else '_cat/count' end params = Utils.process_params(arguments) - params[:h] = Utils.__listify(params[:h]) if params[:h] + params[:h] = Utils.listify(params[:h]) if params[:h] Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/fielddata.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/fielddata.rb index 592958c962..a68d445155 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/fielddata.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/fielddata.rb @@ -15,25 +15,44 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cat module Actions - # Shows how much heap memory is currently being used by fielddata on every data node in the cluster. + # Get field data cache information. + # Get the amount of heap memory currently used by the field data cache on every data node 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 nodes stats API. # - # @option arguments [List] :fields A comma-separated list of fields to return the fielddata size - # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) - # @option arguments [List] :h Comma-separated list of column names to display - # @option arguments [Boolean] :help Return help information - # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by - # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String, Array] :fields Comma-separated list of fields used to limit returned information. + # To retrieve all fields, omit this parameter. + # @option arguments [String] :bytes The unit used to display byte values. + # @option arguments [String, Array] :h A comma-separated list of columns names to display. It supports simple wildcards. + # @option arguments [String, Array] :s List of columns that determine how the table should be sorted. + # Sorting defaults to ascending and can be changed by setting `:asc` + # or `:desc` as a suffix to the column name. + # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to + # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. + # @option arguments [Boolean] :help When set to `true` will output available columns. This option + # can't be combined with any other query string option. + # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-fielddata.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-fielddata # def fielddata(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.fielddata' } @@ -52,7 +71,7 @@ def fielddata(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _fields - "_cat/fielddata/#{Utils.__listify(_fields)}" + "_cat/fielddata/#{Utils.listify(_fields)}" else '_cat/fielddata' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb index 59309d5084..d0b4b83b84 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/health.rb @@ -15,25 +15,49 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cat module Actions - # Returns a concise representation of the cluster health. + # Get the cluster health status. + # 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 cluster health API. + # This API is often used to check malfunctioning clusters. + # To help you track cluster health alongside log files and alerting systems, the API returns timestamps in two formats: + # `HH:MM:SS`, which is human-readable but includes no date information; + # `Unix epoch time`, which is machine-sortable and includes date information. + # The latter format is useful for cluster recoveries that take multiple days. + # You can use the cat health API to verify cluster health across multiple nodes. + # You also can use the API to track the recovery of a large cluster over a longer period of time. # - # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [List] :h Comma-separated list of column names to display - # @option arguments [Boolean] :help Return help information - # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by - # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) - # @option arguments [Boolean] :ts Set to false to disable timestamping - # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :time The unit used to display time values. + # @option arguments [Boolean] :ts If true, returns `HH:MM:SS` and Unix epoch timestamps. Server default: true. + # @option arguments [String, Array] :h A comma-separated list of columns names to display. It supports simple wildcards. + # @option arguments [String, Array] :s List of columns that determine how the table should be sorted. + # Sorting defaults to ascending and can be changed by setting `:asc` + # or `:desc` as a suffix to the column name. + # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to + # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. + # @option arguments [Boolean] :help When set to `true` will output available columns. This option + # can't be combined with any other query string option. + # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-health.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-health # def health(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.health' } @@ -41,12 +65,12 @@ def health(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_cat/health' params = Utils.process_params(arguments) - params[:h] = Utils.__listify(params[:h]) if params[:h] + params[:h] = Utils.listify(params[:h]) if params[:h] Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/help.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/help.rb index 0d9f22f752..d5745922f7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/help.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/help.rb @@ -15,20 +15,19 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cat module Actions - # Returns help for the Cat APIs. + # Get CAT help. + # Get help for the CAT APIs. # - # @option arguments [Boolean] :help Return help information - # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-cat # def help(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.help' } @@ -36,11 +35,11 @@ def help(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_cat' - params = Utils.process_params(arguments) + params = {} Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb index accc79e8cb..3d64ac82be 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/indices.rb @@ -15,31 +15,58 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cat module Actions - # Returns information about indices: number of primaries and replicas, document counts, disk size, ... + # Get index information. + # Get high-level information about indices in a cluster, including backing indices for data streams. + # Use this request to get the following information for each index in a cluster: + # - shard count + # - document count + # - deleted document count + # - primary store size + # - total store size of all shards, including shard replicas + # These metrics are retrieved directly from Lucene, which Elasticsearch uses internally to power indexing and search. As a result, all document counts include hidden nested documents. + # To get an accurate count of Elasticsearch documents, use the cat count or count APIs. + # 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 an index endpoint. # - # @option arguments [List] :index A comma-separated list of index names to limit the returned information - # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [List] :h Comma-separated list of column names to display - # @option arguments [String] :health A health status ("green", "yellow", or "red" to filter only indices matching the specified health status (options: green, yellow, red) - # @option arguments [Boolean] :help Return help information - # @option arguments [Boolean] :pri Set to true to return stats only for primary shards - # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by - # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) - # @option arguments [Boolean] :v Verbose mode. Display column headers - # @option arguments [Boolean] :include_unloaded_segments If set to true segment stats will include stats for segments that are not currently loaded into memory - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @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] :bytes The unit used to display byte values. + # @option arguments [String, Array] :expand_wildcards The type of index that wildcard patterns can match. + # @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. + # @option arguments [String] :time The unit used to display time values. + # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. + # @option arguments [String, Array] :h A comma-separated list of columns names to display. It supports simple wildcards. + # @option arguments [String, Array] :s List of columns that determine how the table should be sorted. + # Sorting defaults to ascending and can be changed by setting `:asc` + # or `:desc` as a suffix to the column name. + # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to + # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. + # @option arguments [Boolean] :help When set to `true` will output available columns. This option + # can't be combined with any other query string option. + # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-indices.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-indices # def indices(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.indices' } @@ -52,18 +79,18 @@ def indices(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_GET path = if _index - "_cat/indices/#{Utils.__listify(_index)}" + "_cat/indices/#{Utils.listify(_index)}" else '_cat/indices' end params = Utils.process_params(arguments) - params[:h] = Utils.__listify(params[:h]) if params[:h] + params[:h] = Utils.listify(params[:h]) if params[:h] Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb index f8512afd3b..bab7a71a5b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/master.rb @@ -15,25 +15,45 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cat module Actions - # Returns information about the master node. + # Get master node information. + # Get information about the master node, including the ID, bound IP address, and name. + # 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 nodes info API. # - # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [List] :h Comma-separated list of column names to display - # @option arguments [Boolean] :help Return help information - # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by - # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String, Array] :h A comma-separated list of columns names to display. It supports simple wildcards. + # @option arguments [String, Array] :s List of columns that determine how the table should be sorted. + # Sorting defaults to ascending and can be changed by setting `:asc` + # or `:desc` as a suffix to the column name. + # @option arguments [Boolean] :local If `true`, the request computes the list of selected nodes from the + # local cluster state. If `false` the list of selected nodes are computed + # from the cluster state of the master node. In both cases the coordinating + # node will send requests for further information to each selected node. + # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. + # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to + # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. + # @option arguments [Boolean] :help When set to `true` will output available columns. This option + # can't be combined with any other query string option. + # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-master.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-master # def master(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.master' } @@ -41,7 +61,7 @@ def master(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_cat/master' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb index 72e1f69773..885ddda57d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb @@ -15,27 +15,45 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cat module Actions - # Gets configuration and usage information about data frame analytics jobs. + # Get data frame analytics jobs. + # Get configuration and usage information about data frame analytics jobs. + # IMPORTANT: CAT APIs are only intended for human consumption using the Kibana + # console or command line. They are not intended for use by applications. For + # application consumption, use the get data frame analytics jobs statistics API. # # @option arguments [String] :id The ID of the data frame analytics to fetch # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no configs. (This includes `_all` string or when no configs have been specified) - # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) - # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [List] :h Comma-separated list of column names to display - # @option arguments [Boolean] :help Return help information - # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by - # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) - # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :bytes The unit in which to display byte values + # @option arguments [String, Array] :h Comma-separated list of column names to display. Server default: create_time,id,state,type. + # @option arguments [String, Array] :s Comma-separated list of column names or column aliases used to sort the + # response. + # @option arguments [String] :time Unit used to display time values. + # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to + # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. + # @option arguments [Boolean] :help When set to `true` will output available columns. This option + # can't be combined with any other query string option. + # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-dfanalytics.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-ml-data-frame-analytics # def ml_data_frame_analytics(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.ml_data_frame_analytics' } @@ -54,7 +72,7 @@ def ml_data_frame_analytics(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _id - "_cat/ml/data_frame/analytics/#{Utils.__listify(_id)}" + "_cat/ml/data_frame/analytics/#{Utils.listify(_id)}" else '_cat/ml/data_frame/analytics' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb index c00d25ba2c..2892c1f817 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb @@ -15,26 +15,52 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cat module Actions - # Gets configuration and usage information about datafeeds. + # Get datafeeds. + # Get configuration and usage information about datafeeds. + # This API returns a maximum of 10,000 datafeeds. + # If the Elasticsearch security features are enabled, you must have `monitor_ml`, `monitor`, `manage_ml`, or `manage` + # cluster privileges to use this API. + # IMPORTANT: CAT APIs are only intended for human consumption using the Kibana + # console or command line. They are not intended for use by applications. For + # application consumption, use the get datafeed statistics API. # - # @option arguments [String] :datafeed_id The ID of the datafeeds stats to fetch - # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) - # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [List] :h Comma-separated list of column names to display - # @option arguments [Boolean] :help Return help information - # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by - # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) - # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :datafeed_id A numerical character string that uniquely identifies the datafeed. + # @option arguments [Boolean] :allow_no_match Specifies what to do when the request: + # - Contains wildcard expressions and there are no datafeeds that match. + # - Contains the `_all` string or no identifiers and there are no matches. + # - Contains wildcard expressions and there are only partial matches. + # If `true`, the API returns an empty datafeeds array when there are no matches and the subset of results when + # there are partial matches. If `false`, the API returns a 404 status code when there are no matches or only + # partial matches. Server default: true. + # @option arguments [String, Array] :h Comma-separated list of column names to display. Server default: ['bc', 'id', 'sc', 's']. + # @option arguments [String, Array] :s Comma-separated list of column names or column aliases used to sort the response. + # @option arguments [String] :time The unit used to display time values. + # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to + # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. + # @option arguments [Boolean] :help When set to `true` will output available columns. This option + # can't be combined with any other query string option. + # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-ml-datafeeds # def ml_datafeeds(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.ml_datafeeds' } @@ -53,7 +79,7 @@ def ml_datafeeds(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _datafeed_id - "_cat/ml/datafeeds/#{Utils.__listify(_datafeed_id)}" + "_cat/ml/datafeeds/#{Utils.listify(_datafeed_id)}" else '_cat/ml/datafeeds' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_jobs.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_jobs.rb index 0a9f41ff97..591db3b10d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_jobs.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_jobs.rb @@ -15,27 +15,53 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cat module Actions - # Gets configuration and usage information about anomaly detection jobs. + # Get anomaly detection jobs. + # Get configuration and usage information for anomaly detection jobs. + # This API returns a maximum of 10,000 jobs. + # If the Elasticsearch security features are enabled, you must have `monitor_ml`, + # `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. + # IMPORTANT: CAT APIs are only intended for human consumption using the Kibana + # console or command line. They are not intended for use by applications. For + # application consumption, use the get anomaly detection job statistics API. # - # @option arguments [String] :job_id The ID of the jobs stats to fetch - # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) - # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) - # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [List] :h Comma-separated list of column names to display - # @option arguments [Boolean] :help Return help information - # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by - # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) - # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :job_id Identifier for the anomaly detection job. + # @option arguments [Boolean] :allow_no_match Specifies what to do when the request: + # - Contains wildcard expressions and there are no jobs that match. + # - Contains the `_all` string or no identifiers and there are no matches. + # - Contains wildcard expressions and there are only partial matches. + # If `true`, the API returns an empty jobs array when there are no matches and the subset of results when there + # are partial matches. If `false`, the API returns a 404 status code when there are no matches or only partial + # matches. Server default: true. + # @option arguments [String] :bytes The unit used to display byte values. + # @option arguments [String, Array] :h Comma-separated list of column names to display. Server default: buckets.count,data.processed_records,forecasts.total,id,model.bytes,model.memory_status,state. + # @option arguments [String, Array] :s Comma-separated list of column names or column aliases used to sort the response. + # @option arguments [String] :time The unit used to display time values. + # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to + # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. + # @option arguments [Boolean] :help When set to `true` will output available columns. This option + # can't be combined with any other query string option. + # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-anomaly-detectors.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-ml-jobs # def ml_jobs(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.ml_jobs' } @@ -54,7 +80,7 @@ def ml_jobs(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _job_id - "_cat/ml/anomaly_detectors/#{Utils.__listify(_job_id)}" + "_cat/ml/anomaly_detectors/#{Utils.listify(_job_id)}" else '_cat/ml/anomaly_detectors' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_trained_models.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_trained_models.rb index 3af9c15a30..51c1bff7fc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_trained_models.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/ml_trained_models.rb @@ -15,29 +15,48 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cat module Actions - # Gets configuration and usage information about inference trained models. + # Get trained models. + # Get configuration and usage information about inference trained models. + # IMPORTANT: CAT APIs are only intended for human consumption using the Kibana + # console or command line. They are not intended for use by applications. For + # application consumption, use the get trained models statistics API. # - # @option arguments [String] :model_id The ID of the trained models stats to fetch - # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified) - # @option arguments [Integer] :from skips a number of trained models - # @option arguments [Integer] :size specifies a max number of trained models to get - # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) - # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [List] :h Comma-separated list of column names to display - # @option arguments [Boolean] :help Return help information - # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by - # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) - # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :model_id A unique identifier for the trained model. + # @option arguments [Boolean] :allow_no_match Specifies what to do when the request: contains wildcard expressions and there are no models that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. + # If `true`, the API returns an empty array when there are no matches and the subset of results when there are partial matches. + # If `false`, the API returns a 404 status code when there are no matches or only partial matches. Server default: true. + # @option arguments [String] :bytes The unit used to display byte values. + # @option arguments [String, Array] :h A comma-separated list of column names to display. + # @option arguments [String, Array] :s A comma-separated list of column names or aliases used to sort the response. + # @option arguments [Integer] :from Skips the specified number of transforms. + # @option arguments [Integer] :size The maximum number of transforms to display. + # @option arguments [String] :time Unit used to display time values. + # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to + # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. + # @option arguments [Boolean] :help When set to `true` will output available columns. This option + # can't be combined with any other query string option. + # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-trained-model.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-ml-trained-models # def ml_trained_models(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.ml_trained_models' } @@ -56,7 +75,7 @@ def ml_trained_models(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _model_id - "_cat/ml/trained_models/#{Utils.__listify(_model_id)}" + "_cat/ml/trained_models/#{Utils.listify(_model_id)}" else '_cat/ml/trained_models' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb index 54102162ef..b8a66fe596 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodeattrs.rb @@ -15,25 +15,45 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cat module Actions - # Returns information about custom node attributes. + # Get node attribute information. + # Get information about custom node attributes. + # 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 nodes info API. # - # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [List] :h Comma-separated list of column names to display - # @option arguments [Boolean] :help Return help information - # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by - # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String, Array] :h A comma-separated list of columns names to display. It supports simple wildcards. + # @option arguments [String, Array] :s List of columns that determine how the table should be sorted. + # Sorting defaults to ascending and can be changed by setting `:asc` + # or `:desc` as a suffix to the column name. + # @option arguments [Boolean] :local If `true`, the request computes the list of selected nodes from the + # local cluster state. If `false` the list of selected nodes are computed + # from the cluster state of the master node. In both cases the coordinating + # node will send requests for further information to each selected node. + # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. + # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to + # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. + # @option arguments [Boolean] :help When set to `true` will output available columns. This option + # can't be combined with any other query string option. + # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-nodeattrs.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-nodeattrs # def nodeattrs(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.nodeattrs' } @@ -41,7 +61,7 @@ def nodeattrs(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_cat/nodeattrs' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodes.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodes.rb index 1411277c44..c5bb82c713 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodes.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/nodes.rb @@ -15,28 +15,46 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cat module Actions - # Returns basic statistics about performance of cluster nodes. + # Get node information. + # Get information about the nodes in a 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 nodes info API. # - # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) - # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [Boolean] :full_id Return the full node ID instead of the shortened version (default: false) - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [List] :h Comma-separated list of column names to display - # @option arguments [Boolean] :help Return help information - # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by - # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) - # @option arguments [Boolean] :v Verbose mode. Display column headers - # @option arguments [Boolean] :include_unloaded_segments If set to true segment stats will include stats for segments that are not currently loaded into memory + # @option arguments [String] :bytes The unit used to display byte values. + # @option arguments [Boolean, String] :full_id If `true`, return the full node ID. If `false`, return the shortened node ID. Server default: false. + # @option arguments [Boolean] :include_unloaded_segments If true, the response includes information from segments that are not loaded into memory. + # @option arguments [String, Array] :h A comma-separated list of columns names to display. + # It supports simple wildcards. Server default: ip,hp,rp,r,m,n,cpu,l. + # @option arguments [String, Array] :s A comma-separated list of column names or aliases that determines the sort order. + # Sorting defaults to ascending and can be changed by setting `:asc` + # or `:desc` as a suffix to the column name. + # @option arguments [Time] :master_timeout The period to wait for a connection to the master node. Server default: 30s. + # @option arguments [String] :time The unit used to display time values. + # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to + # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. + # @option arguments [Boolean] :help When set to `true` will output available columns. This option + # can't be combined with any other query string option. + # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-nodes.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-nodes # def nodes(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.nodes' } @@ -44,12 +62,12 @@ def nodes(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_cat/nodes' params = Utils.process_params(arguments) - params[:h] = Utils.__listify(params[:h], escape: false) if params[:h] + params[:h] = Utils.listify(params[:h], escape: false) if params[:h] Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/pending_tasks.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/pending_tasks.rb index 67acfd7817..8a536c501b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/pending_tasks.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/pending_tasks.rb @@ -15,26 +15,46 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cat module Actions - # Returns a concise representation of the cluster pending tasks. + # Get pending task information. + # Get information about cluster-level changes that have not yet taken effect. + # 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 pending cluster tasks API. # - # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [List] :h Comma-separated list of column names to display - # @option arguments [Boolean] :help Return help information - # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by - # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) - # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String, Array] :h A comma-separated list of columns names to display. It supports simple wildcards. + # @option arguments [String, Array] :s List of columns that determine how the table should be sorted. + # Sorting defaults to ascending and can be changed by setting `:asc` + # or `:desc` as a suffix to the column name. + # @option arguments [Boolean] :local If `true`, the request computes the list of selected nodes from the + # local cluster state. If `false` the list of selected nodes are computed + # from the cluster state of the master node. In both cases the coordinating + # node will send requests for further information to each selected node. + # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. + # @option arguments [String] :time Unit used to display time values. + # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to + # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. + # @option arguments [Boolean] :help When set to `true` will output available columns. This option + # can't be combined with any other query string option. + # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-pending-tasks.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-pending-tasks # def pending_tasks(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.pending_tasks' } @@ -42,12 +62,12 @@ def pending_tasks(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_cat/pending_tasks' params = Utils.process_params(arguments) - params[:h] = Utils.__listify(params[:h]) if params[:h] + params[:h] = Utils.listify(params[:h]) if params[:h] Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb index fbde5d60ed..c47fecbf32 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/plugins.rb @@ -15,26 +15,46 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cat module Actions - # Returns information about installed plugins across nodes node. + # Get plugin information. + # Get a list of plugins running on each node of a 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 nodes info API. # - # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [List] :h Comma-separated list of column names to display - # @option arguments [Boolean] :help Return help information + # @option arguments [String, Array] :h A comma-separated list of columns names to display. It supports simple wildcards. + # @option arguments [String, Array] :s List of columns that determine how the table should be sorted. + # Sorting defaults to ascending and can be changed by setting `:asc` + # or `:desc` as a suffix to the column name. # @option arguments [Boolean] :include_bootstrap Include bootstrap plugins in the response - # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by - # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [Boolean] :local If `true`, the request computes the list of selected nodes from the + # local cluster state. If `false` the list of selected nodes are computed + # from the cluster state of the master node. In both cases the coordinating + # node will send requests for further information to each selected node. + # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. + # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to + # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. + # @option arguments [Boolean] :help When set to `true` will output available columns. This option + # can't be combined with any other query string option. + # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-plugins.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-plugins # def plugins(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.plugins' } @@ -42,7 +62,7 @@ def plugins(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_cat/plugins' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb index 5e6865e47d..b5f1672346 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/recovery.rb @@ -15,28 +15,49 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cat module Actions - # Returns information about index shard recoveries, both on-going completed. + # Get shard recovery information. + # Get information about ongoing and completed shard recoveries. + # Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or syncing a replica shard from a primary shard. When a shard recovery completes, the recovered shard is available for search and indexing. + # For data streams, the API returns information about the stream’s backing indices. + # 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 index recovery API. # - # @option arguments [List] :index Comma-separated list or wildcard expression of index names to limit the returned information - # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [Boolean] :active_only If `true`, the response only includes ongoing shard recoveries - # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) - # @option arguments [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries - # @option arguments [List] :h Comma-separated list of column names to display - # @option arguments [Boolean] :help Return help information - # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by - # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) - # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String, Array] :index A 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 [Boolean] :active_only If `true`, the response only includes ongoing shard recoveries. + # @option arguments [String] :bytes The unit used to display byte values. + # @option arguments [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries. + # @option arguments [String, Array] :h A comma-separated list of columns names to display. + # It supports simple wildcards. Server default: ip,hp,rp,r,m,n,cpu,l. + # @option arguments [String, Array] :s A comma-separated list of column names or aliases that determines the sort order. + # Sorting defaults to ascending and can be changed by setting `:asc` + # or `:desc` as a suffix to the column name. + # @option arguments [String] :time The unit used to display time values. + # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to + # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. + # @option arguments [Boolean] :help When set to `true` will output available columns. This option + # can't be combined with any other query string option. + # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-recovery.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-recovery # def recovery(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.recovery' } @@ -49,18 +70,18 @@ def recovery(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_GET path = if _index - "_cat/recovery/#{Utils.__listify(_index)}" + "_cat/recovery/#{Utils.listify(_index)}" else '_cat/recovery' end params = Utils.process_params(arguments) - params[:h] = Utils.__listify(params[:h]) if params[:h] + params[:h] = Utils.listify(params[:h]) if params[:h] Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/repositories.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/repositories.rb index 482ceff4b3..7e055cbb11 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/repositories.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/repositories.rb @@ -15,25 +15,45 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cat module Actions - # Returns information about snapshot repositories registered in the cluster. + # Get snapshot repository information. + # Get a list of snapshot repositories for a 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 get snapshot repository API. # - # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [List] :h Comma-separated list of column names to display - # @option arguments [Boolean] :help Return help information - # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by - # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String, Array] :h List of columns to appear in the response. Supports simple wildcards. + # @option arguments [String, Array] :s List of columns that determine how the table should be sorted. + # Sorting defaults to ascending and can be changed by setting `:asc` + # or `:desc` as a suffix to the column name. + # @option arguments [Boolean] :local If `true`, the request computes the list of selected nodes from the + # local cluster state. If `false` the list of selected nodes are computed + # from the cluster state of the master node. In both cases the coordinating + # node will send requests for further information to each selected node. + # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. + # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to + # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. + # @option arguments [Boolean] :help When set to `true` will output available columns. This option + # can't be combined with any other query string option. + # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-repositories.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-repositories # def repositories(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.repositories' } @@ -41,7 +61,7 @@ def repositories(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_cat/repositories' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb index 8898f52e26..7c446237ae 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/segments.rb @@ -15,25 +15,51 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cat module Actions - # Provides low-level information about the segments in the shards of an index. + # Get segment information. + # Get low-level information about the Lucene segments in index shards. + # For data streams, the API returns information about the backing indices. + # 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 index segments API. # - # @option arguments [List] :index A comma-separated list of index names to limit the returned information - # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) - # @option arguments [List] :h Comma-separated list of column names to display - # @option arguments [Boolean] :help Return help information - # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by - # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String, Array] :index A 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] :bytes The unit used to display byte values. + # @option arguments [String, Array] :h A comma-separated list of columns names to display. + # It supports simple wildcards. Server default: ip,hp,rp,r,m,n,cpu,l. + # @option arguments [String, Array] :s A comma-separated list of column names or aliases that determines the sort order. + # Sorting defaults to ascending and can be changed by setting `:asc` + # or `:desc` as a suffix to the column name. + # @option arguments [Boolean] :local If `true`, the request computes the list of selected nodes from the + # local cluster state. If `false` the list of selected nodes are computed + # from the cluster state of the master node. In both cases the coordinating + # node will send requests for further information to each selected node. + # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. + # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to + # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. + # @option arguments [Boolean] :help When set to `true` will output available columns. This option + # can't be combined with any other query string option. + # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-segments.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-segments # def segments(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.segments' } @@ -46,13 +72,13 @@ def segments(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_GET path = if _index - "_cat/segments/#{Utils.__listify(_index)}" + "_cat/segments/#{Utils.listify(_index)}" else '_cat/segments' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb index 4e4cae17d5..4ee2e2196d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/shards.rb @@ -15,27 +15,47 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cat module Actions - # Provides a detailed view of shard allocation on nodes. + # Get shard information. + # Get information about the shards in a cluster. + # For data streams, the API returns information about the backing indices. + # IMPORTANT: cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. # - # @option arguments [List] :index A comma-separated list of index names to limit the returned information - # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [String] :bytes The unit in which to display byte values (options: b, k, kb, m, mb, g, gb, t, tb, p, pb) - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [List] :h Comma-separated list of column names to display - # @option arguments [Boolean] :help Return help information - # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by - # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) - # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String, Array] :index A 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] :bytes The unit used to display byte values. + # @option arguments [String, Array] :h List of columns to appear in the response. Supports simple wildcards. + # @option arguments [String, Array] :s A comma-separated list of column names or aliases that determines the sort order. + # Sorting defaults to ascending and can be changed by setting `:asc` + # or `:desc` as a suffix to the column name. + # @option arguments [Time] :master_timeout The period to wait for a connection to the master node. Server default: 30s. + # @option arguments [String] :time The unit used to display time values. + # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to + # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. + # @option arguments [Boolean] :help When set to `true` will output available columns. This option + # can't be combined with any other query string option. + # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-shards.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-shards # def shards(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.shards' } @@ -48,18 +68,18 @@ def shards(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_GET path = if _index - "_cat/shards/#{Utils.__listify(_index)}" + "_cat/shards/#{Utils.listify(_index)}" else '_cat/shards' end params = Utils.process_params(arguments) - params[:h] = Utils.__listify(params[:h]) if params[:h] + params[:h] = Utils.listify(params[:h]) if params[:h] Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb index 3ae1c00888..d5b83ead0c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/snapshots.rb @@ -15,27 +15,49 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cat module Actions - # Returns all snapshots in a specific repository. + # Get snapshot information. + # Get information about the snapshots stored in one or more repositories. + # A snapshot is a backup of an index or running Elasticsearch 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 get snapshot API. # - # @option arguments [List] :repository Name of repository from which to fetch the snapshot information - # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [Boolean] :ignore_unavailable Set to true to ignore unavailable snapshots - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [List] :h Comma-separated list of column names to display - # @option arguments [Boolean] :help Return help information - # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by - # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) - # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String, Array] :repository A comma-separated list of snapshot repositories used to limit the request. + # Accepts wildcard expressions. + # `_all` returns all repositories. + # If any repository fails during the request, Elasticsearch returns an error. + # @option arguments [Boolean] :ignore_unavailable If `true`, the response does not include information from unavailable snapshots. + # @option arguments [String, Array] :h A comma-separated list of columns names to display. + # It supports simple wildcards. Server default: ip,hp,rp,r,m,n,cpu,l. + # @option arguments [String, Array] :s List of columns that determine how the table should be sorted. + # Sorting defaults to ascending and can be changed by setting `:asc` + # or `:desc` as a suffix to the column name. + # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. + # @option arguments [String] :time Unit used to display time values. + # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to + # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. + # @option arguments [Boolean] :help When set to `true` will output available columns. This option + # can't be combined with any other query string option. + # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-snapshots.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-snapshots # def snapshots(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.snapshots' } @@ -54,7 +76,7 @@ def snapshots(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _repository - "_cat/snapshots/#{Utils.__listify(_repository)}" + "_cat/snapshots/#{Utils.listify(_repository)}" else '_cat/snapshots' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/tasks.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/tasks.rb index 4a60aea199..5e12fcecd8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/tasks.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/tasks.rb @@ -15,32 +15,52 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cat module Actions - # Returns information about the tasks currently executing on one or more nodes in the cluster. + # 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. # - # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [List] :nodes A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes - # @option arguments [List] :actions A comma-separated list of actions that should be returned. Leave empty to return all. - # @option arguments [Boolean] :detailed Return detailed task information (default: false) - # @option arguments [String] :parent_task_id Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all. - # @option arguments [List] :h Comma-separated list of column names to display - # @option arguments [Boolean] :help Return help information - # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by - # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) - # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [Array] :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. + # @option arguments [Array] :nodes Unique node identifiers, which are used to limit the response. + # @option arguments [String] :parent_task_id The parent task identifier, which is used to limit the response. + # @option arguments [String, Array] :h A comma-separated list of columns names to display. It supports simple wildcards. + # @option arguments [String, Array] :s List of columns that determine how the table should be sorted. + # Sorting defaults to ascending and can be changed by setting `:asc` + # or `:desc` as a suffix to the column name. + # @option arguments [String] :time Unit used to display time values. + # @option arguments [Time] :timeout Period to wait for a response. + # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :wait_for_completion If `true`, the request blocks until the task has completed. + # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to + # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. + # @option arguments [Boolean] :help When set to `true` will output available columns. This option + # can't be combined with any other query string option. + # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-tasks # def tasks(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.tasks' } @@ -48,7 +68,7 @@ def tasks(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_cat/tasks' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb index 42423d5f2b..89a74aacf1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/templates.rb @@ -15,26 +15,48 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cat module Actions - # Returns information about existing templates. + # Get index template information. + # Get information about the index templates in a cluster. + # You can use index templates to apply index settings and field mappings to new indices at creation. + # 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 get index template API. # - # @option arguments [String] :name A pattern that returned template names must match - # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [List] :h Comma-separated list of column names to display - # @option arguments [Boolean] :help Return help information - # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by - # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :name The name of the template to return. + # Accepts wildcard expressions. If omitted, all templates are returned. + # @option arguments [String, Array] :h A comma-separated list of columns names to display. It supports simple wildcards. + # @option arguments [String, Array] :s List of columns that determine how the table should be sorted. + # Sorting defaults to ascending and can be changed by setting `:asc` + # or `:desc` as a suffix to the column name. + # @option arguments [Boolean] :local If `true`, the request computes the list of selected nodes from the + # local cluster state. If `false` the list of selected nodes are computed + # from the cluster state of the master node. In both cases the coordinating + # node will send requests for further information to each selected node. + # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. + # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to + # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. + # @option arguments [Boolean] :help When set to `true` will output available columns. This option + # can't be combined with any other query string option. + # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-templates.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-templates # def templates(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.templates' } @@ -53,7 +75,7 @@ def templates(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _name - "_cat/templates/#{Utils.__listify(_name)}" + "_cat/templates/#{Utils.listify(_name)}" else '_cat/templates' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/thread_pool.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/thread_pool.rb index f3ffd705f2..bbe195c06b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/thread_pool.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/thread_pool.rb @@ -15,28 +15,49 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cat module Actions - # Returns cluster-wide thread pool statistics per node. - # By default the active, queue and rejected statistics are returned for all thread pools. + # Get thread pool statistics. + # Get thread pool statistics for each node in a cluster. + # Returned information includes all built-in thread pools and custom thread pools. + # 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 nodes info API. # - # @option arguments [List] :thread_pool_patterns A comma-separated list of regular-expressions to filter the thread pools in the output - # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) - # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [List] :h Comma-separated list of column names to display - # @option arguments [Boolean] :help Return help information - # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by - # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String, Array] :thread_pool_patterns A comma-separated list of thread pool names used to limit the request. + # Accepts wildcard expressions. + # @option arguments [String, Array] :h List of columns to appear in the response. Supports simple wildcards. + # @option arguments [String, Array] :s A comma-separated list of column names or aliases that determines the sort order. + # Sorting defaults to ascending and can be changed by setting `:asc` + # or `:desc` as a suffix to the column name. + # @option arguments [String] :time The unit used to display time values. + # @option arguments [Boolean] :local If `true`, the request computes the list of selected nodes from the + # local cluster state. If `false` the list of selected nodes are computed + # from the cluster state of the master node. In both cases the coordinating + # node will send requests for further information to each selected node. + # @option arguments [Time] :master_timeout The period to wait for a connection to the master node. Server default: 30s. + # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to + # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. + # @option arguments [Boolean] :help When set to `true` will output available columns. This option + # can't be combined with any other query string option. + # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-thread-pool.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-thread-pool # def thread_pool(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.thread_pool' } @@ -55,12 +76,12 @@ def thread_pool(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _thread_pool_patterns - "_cat/thread_pool/#{Utils.__listify(_thread_pool_patterns)}" + "_cat/thread_pool/#{Utils.listify(_thread_pool_patterns)}" else '_cat/thread_pool' end params = Utils.process_params(arguments) - params[:h] = Utils.__listify(params[:h]) if params[:h] + params[:h] = Utils.listify(params[:h]) if params[:h] Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cat/transforms.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cat/transforms.rb index 172e7445ae..6b4963e7ba 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cat/transforms.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cat/transforms.rb @@ -15,28 +15,48 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cat module Actions - # Gets configuration and usage information about transforms. + # Get transform information. + # Get configuration and usage information about transforms. + # CAT APIs are only intended for human consumption using the Kibana + # console or command line. They are not intended for use by applications. For + # application consumption, use the get transform statistics API. # - # @option arguments [String] :transform_id The id of the transform for which to get stats. '_all' or '*' implies all transforms - # @option arguments [Integer] :from skips a number of transform configs, defaults to 0 - # @option arguments [Integer] :size specifies a max number of transforms to get, defaults to 100 - # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified) - # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [List] :h Comma-separated list of column names to display - # @option arguments [Boolean] :help Return help information - # @option arguments [List] :s Comma-separated list of column names or column aliases to sort by - # @option arguments [String] :time The unit in which to display time values (options: d, h, m, s, ms, micros, nanos) - # @option arguments [Boolean] :v Verbose mode. Display column headers + # @option arguments [String] :transform_id A transform identifier or a wildcard expression. + # If you do not specify one of these options, the API returns information for all transforms. + # @option arguments [Boolean] :allow_no_match Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there are only partial matches. + # If `true`, it returns an empty transforms array when there are no matches and the subset of results when there are partial matches. + # If `false`, the request returns a 404 status code when there are no matches or only partial matches. Server default: true. + # @option arguments [Integer] :from Skips the specified number of transforms. Server default: 0. + # @option arguments [String, Array] :h Comma-separated list of column names to display. Server default: changes_last_detection_time,checkpoint,checkpoint_progress,documents_processed,id,last_search_time,state. + # @option arguments [String, Array] :s Comma-separated list of column names or column aliases used to sort the response. + # @option arguments [String] :time The unit used to display time values. + # @option arguments [Integer] :size The maximum number of transforms to obtain. Server default: 100. + # @option arguments [String] :format Specifies the format to return the columnar data in, can be set to + # `text`, `json`, `cbor`, `yaml`, or `smile`. Server default: text. + # @option arguments [Boolean] :help When set to `true` will output available columns. This option + # can't be combined with any other query string option. + # @option arguments [Boolean] :v When set to `true` will enable verbose output. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-transforms.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cat-transforms # def transforms(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cat.transforms' } @@ -55,7 +75,7 @@ def transforms(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _transform_id - "_cat/transforms/#{Utils.__listify(_transform_id)}" + "_cat/transforms/#{Utils.listify(_transform_id)}" else '_cat/transforms' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/clear_scroll.rb b/elasticsearch-api/lib/elasticsearch/api/actions/clear_scroll.rb index 793bff1eab..40c7ea8b60 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/clear_scroll.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/clear_scroll.rb @@ -15,33 +15,42 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Explicitly clears the search context for a scroll. + # Clear a scrolling search. + # Clear the search context and results for a scrolling search. # - # @option arguments [List] :scroll_id A comma-separated list of scroll IDs to clear *Deprecated* + # @option arguments [String, Array] :scroll_id A comma-separated list of scroll IDs to clear. + # To clear all scroll IDs, use `_all`. + # IMPORTANT: Scroll IDs can be long. It is recommended to specify scroll IDs in the request body parameter. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body A comma-separated list of scroll IDs to clear if none was specified via the scroll_id parameter + # @option arguments [Hash] :body request body # # *Deprecation notice*: # A scroll id can be quite large and should be specified as part of the body # Deprecated since version 7.0.0 # # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-scroll-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-clear-scroll # def clear_scroll(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'clear_scroll' } - defined_params = [:scroll_id].each_with_object({}) do |variable, set_variables| - set_variables[variable] = arguments[variable] if arguments.key?(variable) - end - request_opts[:defined_params] = defined_params unless defined_params.empty? - arguments = arguments.clone headers = arguments.delete(:headers) || {} @@ -50,15 +59,11 @@ def clear_scroll(arguments = {}) _scroll_id = arguments.delete(:scroll_id) method = Elasticsearch::API::HTTP_DELETE - path = if _scroll_id - "_search/scroll/#{Utils.__listify(_scroll_id)}" - else - '_search/scroll' - end + path = '_search/scroll' params = Utils.process_params(arguments) if Array(arguments[:ignore]).include?(404) - Utils.__rescue_from_not_found do + Utils.rescue_from_not_found do Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/close_point_in_time.rb b/elasticsearch-api/lib/elasticsearch/api/actions/close_point_in_time.rb index 05b7b5935a..70f109ce4c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/close_point_in_time.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/close_point_in_time.rb @@ -15,18 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Close a point in time + # Close a point in time. + # A point in time must be opened explicitly before being used in search requests. + # The `keep_alive` parameter tells Elasticsearch how long it should persist. + # A point in time is automatically closed when the `keep_alive` period has elapsed. + # However, keeping points in time has a cost; close them as soon as they are no longer required for search requests. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body a point-in-time id to close + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/point-in-time-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-open-point-in-time # def close_point_in_time(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'close_point_in_time' } @@ -34,11 +49,11 @@ def close_point_in_time(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_DELETE path = '_pit' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/allocation_explain.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/allocation_explain.rb index 08abe8949a..c6933e3647 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/allocation_explain.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/allocation_explain.rb @@ -15,22 +15,38 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cluster module Actions - # Provides explanations for shard allocations in the cluster. + # Explain the shard allocations. + # Get explanations for shard allocations in the cluster. + # For unassigned shards, it provides an explanation for why the shard is unassigned. + # For assigned shards, it provides an explanation for why the shard is remaining on its current node and has not moved or rebalanced to another node. + # This API can be very useful when attempting to diagnose why a shard is unassigned or why a shard continues to remain on its current node when you might expect otherwise. + # Refer to the linked documentation for examples of how to troubleshoot allocation issues using this API. # - # @option arguments [Time] :master_timeout Timeout for connection to master node - # @option arguments [Boolean] :include_yes_decisions Return 'YES' decisions in explanation (default: false) - # @option arguments [Boolean] :include_disk_info Return information about disk usage and shard sizes (default: false) + # @option arguments [Boolean] :include_disk_info If true, returns information about disk usage and shard sizes. + # @option arguments [Boolean] :include_yes_decisions If true, returns YES decisions in explanation. + # @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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The index, shard, and primary flag to explain. Empty means 'explain a randomly-chosen unassigned shard' + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-allocation-explain.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-allocation-explain # def allocation_explain(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cluster.allocation_explain' } @@ -38,7 +54,7 @@ def allocation_explain(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = if body Elasticsearch::API::HTTP_POST @@ -46,7 +62,7 @@ def allocation_explain(arguments = {}) Elasticsearch::API::HTTP_GET end - path = '_cluster/allocation/explain' + path = '_cluster/allocation/explain' params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/delete_component_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/delete_component_template.rb index a0a62dd669..6fcb984a3d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/delete_component_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/delete_component_template.rb @@ -15,21 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cluster module Actions - # Deletes a component template + # Delete component templates. + # Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. # - # @option arguments [String] :name The name of the template - # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [String, Array] :name Comma-separated list or wildcard expression of component template names used to limit the request. (*Required*) + # @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. + # @option arguments [Time] :timeout Period to wait for a response. + # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-put-component-template # def delete_component_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cluster.delete_component_template' } @@ -49,7 +63,7 @@ def delete_component_template(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_DELETE - path = "_component_template/#{Utils.__listify(_name)}" + path = "_component_template/#{Utils.listify(_name)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/delete_voting_config_exclusions.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/delete_voting_config_exclusions.rb index 4609b743de..9b920c1573 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/delete_voting_config_exclusions.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/delete_voting_config_exclusions.rb @@ -15,20 +15,37 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cluster module Actions - # Clears cluster voting config exclusions. + # Clear cluster voting config exclusions. + # Remove master-eligible nodes from the voting configuration exclusion list. # - # @option arguments [Boolean] :wait_for_removal Specifies whether to wait for all excluded nodes to be removed from the cluster before clearing the voting configuration exclusions list. - # @option arguments [Time] :master_timeout Timeout for submitting request to master + # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. + # @option arguments [Boolean] :wait_for_removal Specifies whether to wait for all excluded nodes to be removed from the + # cluster before clearing the voting configuration exclusions list. + # Defaults to true, meaning that all excluded nodes must be removed from + # the cluster before this API takes any action. If set to false then the + # voting configuration exclusions list is cleared even if some excluded + # nodes are still in the cluster. Server default: true. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/voting-config-exclusions.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-post-voting-config-exclusions # def delete_voting_config_exclusions(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cluster.delete_voting_config_exclusions' } @@ -36,7 +53,7 @@ def delete_voting_config_exclusions(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_DELETE path = '_cluster/voting_config_exclusions' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/exists_component_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/exists_component_template.rb index 505979897d..de33f04612 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/exists_component_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/exists_component_template.rb @@ -15,21 +15,37 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cluster module Actions - # Returns information about whether a particular component template exist + # Check component templates. + # Returns information about whether a particular component template exists. # - # @option arguments [String] :name The name of the template - # @option arguments [Time] :master_timeout Timeout for waiting for new cluster state in case it is blocked - # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) *Deprecated* + # @option arguments [String, Array] :name Comma-separated list of component template names used to limit the request. + # Wildcard (*) expressions are supported. (*Required*) + # @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. + # @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 [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-put-component-template # def exists_component_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cluster.exists_component_template' } @@ -49,7 +65,7 @@ def exists_component_template(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_HEAD - path = "_component_template/#{Utils.__listify(_name)}" + path = "_component_template/#{Utils.listify(_name)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_component_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_component_template.rb index d4570f23aa..7c55d33324 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_component_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_component_template.rb @@ -15,22 +15,39 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cluster module Actions - # Returns one or more component templates + # Get component templates. + # Get information about component templates. # - # @option arguments [List] :name The comma separated names of the component templates - # @option arguments [Time] :master_timeout Timeout for waiting for new cluster state in case it is blocked - # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) *Deprecated* + # @option arguments [String] :name Comma-separated list of component template names used to limit the request. + # Wildcard (`*`) expressions are supported. + # @option arguments [Boolean] :flat_settings If `true`, returns settings in flat format. + # @option arguments [String, Array] :settings_filter Filter out results, for example to filter out sensitive information. Supports wildcards or full settings keys # @option arguments [Boolean] :include_defaults Return all default configurations for the component template (default: false) + # @option arguments [Boolean] :local If `true`, the request retrieves information from the local node only. + # If `false`, 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. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-put-component-template # def get_component_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cluster.get_component_template' } @@ -49,7 +66,7 @@ def get_component_template(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _name - "_component_template/#{Utils.__listify(_name)}" + "_component_template/#{Utils.listify(_name)}" else '_component_template' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_settings.rb index 12beaf9acc..aa262c7d05 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/get_settings.rb @@ -15,22 +15,36 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cluster module Actions - # Returns cluster settings. + # Get cluster-wide settings. + # By default, it returns only settings that have been explicitly defined. # - # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) - # @option arguments [Time] :master_timeout Timeout for waiting for new cluster state in case it is blocked - # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Boolean] :include_defaults Whether to return all default clusters setting. + # @option arguments [Boolean] :flat_settings If `true`, returns settings in flat format. + # @option arguments [Boolean] :include_defaults If `true`, returns default cluster settings from the local 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. + # @option arguments [Time] :timeout Period to wait for a response. + # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-get-settings.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-get-settings # def get_settings(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cluster.get_settings' } @@ -38,7 +52,7 @@ def get_settings(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_cluster/settings' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/health.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/health.rb index 3a585036b6..279064c8bd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/health.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/health.rb @@ -15,30 +15,48 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cluster module Actions - # Returns basic information about the health of the cluster. + # Get the cluster health status. + # You can also use the API to get the health status of only specified data streams and indices. + # For data streams, the API retrieves the health status of the stream’s backing indices. + # The cluster health status is: green, yellow or red. + # On the shard level, a red status indicates that the specific shard is not allocated in the cluster. Yellow means that the primary shard is allocated but replicas are not. Green means that all shards are allocated. + # The index level status is controlled by the worst shard status. + # One of the main benefits of the API is the ability to wait until the cluster reaches a certain high watermark health level. + # The cluster status is controlled by the worst index status. # - # @option arguments [List] :index Limit the information returned to a specific index - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) - # @option arguments [String] :level Specify the level of detail for returned information (options: cluster, indices, shards) - # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [String] :wait_for_active_shards Wait until the specified number of shards is active - # @option arguments [String] :wait_for_nodes Wait until the specified number of nodes is available - # @option arguments [String] :wait_for_events Wait until all currently queued events with the given priority are processed (options: immediate, urgent, high, normal, low, languid) - # @option arguments [Boolean] :wait_for_no_relocating_shards Whether to wait until there are no relocating shards in the cluster - # @option arguments [Boolean] :wait_for_no_initializing_shards Whether to wait until there are no initializing shards in the cluster - # @option arguments [String] :wait_for_status Wait until cluster is in a specific state (options: green, yellow, red) + # @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] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. + # @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. + # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Integer, String] :wait_for_active_shards A number controlling to how many active shards to wait for, all to wait for all shards in the cluster to be active, or 0 to not wait. Server default: 0. + # @option arguments [String] :wait_for_events Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed. + # @option arguments [String, Integer] :wait_for_nodes The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and yellow > red. By default, will not wait for any status. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-health.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-health # def health(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cluster.health' } @@ -51,13 +69,13 @@ def health(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_GET path = if _index - "_cluster/health/#{Utils.__listify(_index)}" + "_cluster/health/#{Utils.listify(_index)}" else '_cluster/health' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/info.rb index 83b2e81d83..d90e7a5f20 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/info.rb @@ -15,19 +15,31 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cluster module Actions - # Returns different information about the cluster. + # Get cluster info. + # Returns basic information about the cluster. # - # @option arguments [List] :target Limit the information returned to the specified target. (options: _all, http, ingest, thread_pool, script) + # @option arguments [String, Array] :target Limits the information returned to the specific target. Supports a comma-separated list, such as http,ingest. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-info.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-info # def info(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cluster.info' } @@ -47,8 +59,8 @@ def info(arguments = {}) _target = arguments.delete(:target) method = Elasticsearch::API::HTTP_GET - path = "_info/#{Utils.__listify(_target)}" - params = {} + path = "_info/#{Utils.listify(_target)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/pending_tasks.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/pending_tasks.rb index 783626ef7d..58239f28b2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/pending_tasks.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/pending_tasks.rb @@ -15,21 +15,37 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cluster module Actions - # Returns a list of any cluster-level changes (e.g. create index, update mapping, - # allocate or fail shard) which have not yet been executed. + # Get the pending cluster tasks. + # Get information about cluster-level changes (such as create index, update mapping, allocate or fail shard) that have not yet taken effect. + # NOTE: This API returns a list of any pending updates to the cluster state. + # These are distinct from the tasks reported by the task management API which include periodic tasks and tasks initiated by the user, such as node stats, search queries, or create index requests. + # However, if a user-initiated task such as a create index command causes a cluster state update, the activity of this task might be reported by both task api and pending cluster tasks API. # - # @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 + # @option arguments [Boolean] :local If `true`, the request retrieves information from the local node only. + # If `false`, 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. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-pending.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-pending-tasks # def pending_tasks(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cluster.pending_tasks' } @@ -37,7 +53,7 @@ def pending_tasks(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_cluster/pending_tasks' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/post_voting_config_exclusions.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/post_voting_config_exclusions.rb index dd9edf0cbe..8acf112429 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/post_voting_config_exclusions.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/post_voting_config_exclusions.rb @@ -15,22 +15,52 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cluster module Actions - # Updates the cluster voting config exclusions by node ids or node names. + # Update voting configuration exclusions. + # Update the cluster voting config exclusions by node IDs or node names. + # By default, if there are more than three master-eligible nodes in the cluster and you remove fewer than half of the master-eligible nodes in the cluster at once, the voting configuration automatically shrinks. + # If you want to shrink the voting configuration to contain fewer than three nodes or to remove half or more of the master-eligible nodes in the cluster at once, use this API to remove departing nodes from the voting configuration manually. + # The API adds an entry for each specified node to the cluster’s voting configuration exclusions list. + # It then waits until the cluster has reconfigured its voting configuration to exclude the specified nodes. + # Clusters should have no voting configuration exclusions in normal operation. + # Once the excluded nodes have stopped, clear the voting configuration exclusions with `DELETE /_cluster/voting_config_exclusions`. + # This API waits for the nodes to be fully removed from the cluster before it returns. + # If your cluster has voting configuration exclusions for nodes that you no longer intend to remove, use `DELETE /_cluster/voting_config_exclusions?wait_for_removal=false` to clear the voting configuration exclusions without waiting for the nodes to leave the cluster. + # A response to `POST /_cluster/voting_config_exclusions` with an HTTP status code of 200 OK guarantees that the node has been removed from the voting configuration and will not be reinstated until the voting configuration exclusions are cleared by calling `DELETE /_cluster/voting_config_exclusions`. + # If the call to `POST /_cluster/voting_config_exclusions` fails or returns a response with an HTTP status code other than 200 OK then the node may not have been removed from the voting configuration. + # In that case, you may safely retry the call. + # NOTE: Voting exclusions are required only when you remove at least half of the master-eligible nodes from a cluster in a short time period. + # They are not required when removing master-ineligible nodes or when removing fewer than half of the master-eligible nodes. # - # @option arguments [String] :node_ids A comma-separated list of the persistent ids of the nodes to exclude from the voting configuration. If specified, you may not also specify ?node_names. - # @option arguments [String] :node_names A comma-separated list of the names of the nodes to exclude from the voting configuration. If specified, you may not also specify ?node_ids. - # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Time] :master_timeout Timeout for submitting request to master + # @option arguments [String, Array] :node_names A comma-separated list of the names of the nodes to exclude from the + # voting configuration. If specified, you may not also specify node_ids. + # @option arguments [String, Array] :node_ids A comma-separated list of the persistent ids of the nodes to exclude + # from the voting configuration. If specified, you may not also specify node_names. + # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. + # @option arguments [Time] :timeout When adding a voting configuration exclusion, the API waits for the + # specified nodes to be excluded from the voting configuration before + # returning. If the timeout expires before the appropriate condition + # is satisfied, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/voting-config-exclusions.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-post-voting-config-exclusions # def post_voting_config_exclusions(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cluster.post_voting_config_exclusions' } @@ -38,7 +68,7 @@ def post_voting_config_exclusions(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_POST path = '_cluster/voting_config_exclusions' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_component_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_component_template.rb index e6cf352034..7253562369 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_component_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_component_template.rb @@ -15,23 +15,52 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cluster module Actions - # Creates or updates a component template + # Create or update a component template. + # Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. + # An index template can be composed of multiple component templates. + # To use a component template, specify it in an index template’s `composed_of` list. + # Component templates are only applied to new data streams and indices as part of a matching index template. + # Settings and mappings specified directly in the index template or the create index request override any settings or mappings specified in a component template. + # Component templates are only used during index creation. + # For data streams, this includes data stream creation and the creation of a stream’s backing indices. + # Changes to component templates do not affect existing indices, including a stream’s backing indices. + # You can use C-style `/* *\/` block comments in component templates. + # You can include comments anywhere in the request body except before the opening curly bracket. + # **Applying component templates** + # You cannot directly apply a component template to a data stream or index. + # To be applied, a component template must be included in an index template's `composed_of` list. # - # @option arguments [String] :name The name of the template - # @option arguments [Boolean] :create Whether the index template should only be added if new or can also replace an existing one - # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [String] :name Name of the component template to create. + # Elasticsearch includes the following built-in component templates: `logs-mappings`; `logs-settings`; `metrics-mappings`; `metrics-settings`;`synthetics-mapping`; `synthetics-settings`. + # Elastic Agent uses these templates to configure backing indices for its data streams. + # If you use Elastic Agent and want to overwrite one of these templates, set the `version` for your replacement template higher than the current version. + # If you don’t use Elastic Agent and want to disable all built-in component and index templates, set `stack.templates.enabled` to `false` using the cluster update settings API. (*Required*) + # @option arguments [Boolean] :create If `true`, this request cannot replace or update existing component templates. + # @option arguments [String] :cause User defined reason for create the component template. Server default: api. + # @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. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The template definition (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-put-component-template # def put_component_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cluster.put_component_template' } @@ -52,7 +81,7 @@ def put_component_template(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_PUT - path = "_component_template/#{Utils.__listify(_name)}" + path = "_component_template/#{Utils.listify(_name)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_settings.rb index 22854aaf9b..d314331c50 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/put_settings.rb @@ -15,22 +15,46 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cluster module Actions - # Updates the cluster settings. + # Update the cluster settings. + # Configure and update dynamic settings on a running cluster. + # You can also configure dynamic settings locally on an unstarted or shut down node in `elasticsearch.yml`. + # Updates made with this API can be persistent, which apply across cluster restarts, or transient, which reset after a cluster restart. + # You can also reset transient or persistent settings by assigning them a null value. + # If you configure the same setting using multiple methods, Elasticsearch applies the settings in following order of precedence: 1) Transient setting; 2) Persistent setting; 3) `elasticsearch.yml` setting; 4) Default setting value. + # For example, you can apply a transient setting to override a persistent setting or `elasticsearch.yml` setting. + # However, a change to an `elasticsearch.yml` setting will not override a defined transient or persistent setting. + # TIP: In Elastic Cloud, use the user settings feature to configure all cluster settings. This method automatically rejects unsafe settings that could break your cluster. + # If you run Elasticsearch on your own hardware, use this API to configure dynamic cluster settings. + # Only use `elasticsearch.yml` for static cluster settings and node settings. + # The API doesn’t require a restart and ensures a setting’s value is the same on all nodes. + # WARNING: Transient cluster settings are no longer recommended. Use persistent cluster settings instead. + # If a cluster becomes unstable, transient settings can clear unexpectedly, resulting in a potentially undesired cluster configuration. # # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [Time] :timeout Explicit operation timeout + # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node Server default: 30s. + # @option arguments [Time] :timeout Explicit operation timeout Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The settings to be updated. Can be either `transient` or `persistent` (survives cluster restart). (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-update-settings.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-put-settings # def put_settings(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cluster.put_settings' } @@ -40,7 +64,7 @@ def put_settings(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) || {} + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_PUT path = '_cluster/settings' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/remote_info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/remote_info.rb index 63d1f824f7..2479373e1f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/remote_info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/remote_info.rb @@ -15,18 +15,31 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cluster module Actions - # Returns the information about configured remote clusters. + # Get remote cluster information. + # Get information about configured remote clusters. + # The API returns connection and endpoint information keyed by the configured remote cluster alias. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-remote-info.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-remote-info # def remote_info(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cluster.remote_info' } @@ -34,11 +47,11 @@ def remote_info(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_remote/info' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/reroute.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/reroute.rb index 450384932f..028dbe02a9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/reroute.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/reroute.rb @@ -15,25 +15,46 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cluster module Actions - # Allows to manually change the allocation of individual shards in the cluster. + # Reroute the cluster. + # Manually change the allocation of individual shards in the cluster. + # For example, a shard can be moved from one node to another explicitly, an allocation can be canceled, and an unassigned shard can be explicitly allocated to a specific node. + # It is important to note that after processing any reroute commands Elasticsearch will perform rebalancing as normal (respecting the values of settings such as `cluster.routing.rebalance.enable`) in order to remain in a balanced state. + # For example, if the requested allocation includes moving a shard from node1 to node2 then this may cause a shard to be moved from node2 back to node1 to even things out. + # The cluster can be set to disable allocations using the `cluster.routing.allocation.enable` setting. + # If allocations are disabled then the only allocations that will be performed are explicit ones given using the reroute command, and consequent allocations due to rebalancing. + # The cluster will attempt to allocate a shard a maximum of `index.allocation.max_retries` times in a row (defaults to `5`), before giving up and leaving the shard unallocated. + # This scenario can be caused by structural problems such as having an analyzer which refers to a stopwords file which doesn’t exist on all nodes. + # Once the problem has been corrected, allocation can be manually retried by calling the reroute API with the `?retry_failed` URI query parameter, which will attempt a single retry round for these shards. # - # @option arguments [Boolean] :dry_run Simulate the operation only and return the resulting state - # @option arguments [Boolean] :explain Return an explanation of why the commands can or cannot be executed - # @option arguments [Boolean] :retry_failed Retries allocation of shards that are blocked due to too many subsequent allocation failures - # @option arguments [List] :metric Limit the information returned to the specified metrics. Defaults to all but metadata (options: _all, blocks, metadata, nodes, none, routing_table, master_node, version) - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [Time] :timeout Explicit operation timeout + # @option arguments [Boolean] :dry_run If true, then the request simulates the operation. + # It will calculate the result of applying the commands to the current cluster state and return the resulting cluster state after the commands (and rebalancing) have been applied; it will not actually perform the requested changes. + # @option arguments [Boolean] :explain If true, then the response contains an explanation of why the commands can or cannot run. + # @option arguments [String, Array] :metric Limits the information returned to the specified metrics. Server default: all. + # @option arguments [Boolean] :retry_failed If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures. + # @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. + # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The definition of `commands` to perform (`move`, `cancel`, `allocate`) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-reroute.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-reroute # def reroute(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cluster.reroute' } @@ -41,7 +62,7 @@ def reroute(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) || {} + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_cluster/reroute' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/state.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/state.rb index 24d7eb487f..7d8b521b93 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/state.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/state.rb @@ -15,33 +15,57 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cluster module Actions - # Returns a comprehensive information about the state of the cluster. + # Get the cluster state. + # Get comprehensive information about the state of the cluster. + # The cluster state is an internal data structure which keeps track of a variety of information needed by every node, including the identity and attributes of the other nodes in the cluster; cluster-wide settings; index metadata, including the mapping and settings for each index; the location and status of every shard copy in the cluster. + # The elected master node ensures that every node in the cluster has a copy of the same cluster state. + # This API lets you retrieve a representation of this internal state for debugging or diagnostic purposes. + # You may need to consult the Elasticsearch source code to determine the precise meaning of the response. + # By default the API will route requests to the elected master node since this node is the authoritative source of cluster states. + # You can also retrieve the cluster state held on the node handling the API request by adding the `?local=true` query parameter. + # Elasticsearch may need to expend significant effort to compute a response to this API in larger clusters, and the response may comprise a very large quantity of data. + # If you use this API repeatedly, your cluster may become unstable. + # WARNING: The response is a representation of an internal data structure. + # Its format is not subject to the same compatibility guarantees as other more stable APIs and may change from version to version. + # Do not query this API using external monitoring tools. + # Instead, obtain the information you require using other more stable cluster APIs. # - # @option arguments [List] :metric Limit the information returned to the specified metrics (options: _all, blocks, metadata, nodes, routing_table, routing_nodes, master_node, version) - # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices - # @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 + # @option arguments [String, Array] :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] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) - # @option arguments [Number] :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] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) - # @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) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @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 [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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-state.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-state # def state(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cluster.state' } - defined_params = %i[metric index].each_with_object({}) do |variable, set_variables| + defined_params = [:metric, :index].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -57,9 +81,9 @@ def state(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _metric && _index - "_cluster/state/#{Utils.__listify(_metric)}/#{Utils.__listify(_index)}" + "_cluster/state/#{Utils.listify(_metric)}/#{Utils.listify(_index)}" elsif _metric - "_cluster/state/#{Utils.__listify(_metric)}" + "_cluster/state/#{Utils.listify(_metric)}" else '_cluster/state' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/stats.rb index a960c912f6..596882b57b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cluster/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cluster/stats.rb @@ -15,21 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Cluster module Actions - # Returns high-level overview of cluster statistics. + # Get cluster statistics. + # Get basic index metrics (shard numbers, store size, memory usage) and information about the current nodes that form the cluster (number, roles, os, jvm versions, memory usage, cpu and installed plugins). # - # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes - # @option arguments [Boolean] :include_remotes Include remote cluster data into the response (default: false) - # @option arguments [Time] :timeout Explicit operation timeout + # @option arguments [String, Array] :node_id Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster. + # @option arguments [Boolean] :include_remotes Include remote cluster data into the response + # @option arguments [Time] :timeout Period to wait for each node to respond. + # If a node does not respond before its timeout expires, the response does not include its stats. + # However, timed out nodes are included in the response’s `_nodes.failed` property. Defaults to no timeout. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-stats.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-cluster-stats # def stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'cluster.stats' } @@ -48,7 +62,7 @@ def stats(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _node_id - "_cluster/stats/nodes/#{Utils.__listify(_node_id)}" + "_cluster/stats/nodes/#{Utils.listify(_node_id)}" else '_cluster/stats' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/check_in.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/check_in.rb index e2c46f6ffd..73696d48e7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/check_in.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/check_in.rb @@ -15,23 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Connector module Actions - # Updates the last_seen timestamp in the connector document. + # 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. # - # @option arguments [String] :connector_id The unique identifier of the connector to be updated. + # @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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/check-in-connector-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-check-in # def check_in(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.check_in' } @@ -51,8 +63,8 @@ def check_in(arguments = {}) _connector_id = arguments.delete(:connector_id) method = Elasticsearch::API::HTTP_PUT - path = "_connector/#{Utils.__listify(_connector_id)}/_check_in" - params = {} + path = "_connector/#{Utils.listify(_connector_id)}/_check_in" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/delete.rb index a10c9e3058..c79595925d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/delete.rb @@ -15,25 +15,40 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Connector module Actions - # Deletes 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. + # Delete a connector. + # Removes a connector and associated sync jobs. + # This is a destructive action that is not recoverable. + # NOTE: This action doesn’t delete any API keys, ingest pipelines, or data indices associated with the connector. + # These need to be removed manually. + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # - # @option arguments [String] :connector_id The unique identifier of the connector to be deleted. - # @option arguments [Boolean] :hard If true, the connector doc is deleted. If false, connector doc is marked as deleted (soft-deleted). - # @option arguments [Boolean] :delete_sync_jobs Determines whether associated sync jobs are also deleted. + # @option arguments [String] :connector_id The unique identifier of the connector to be deleted (*Required*) + # @option arguments [Boolean] :delete_sync_jobs A flag indicating if associated sync jobs should be also removed. Defaults to false. + # @option arguments [Boolean] :hard A flag indicating if the connector should be hard deleted. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-connector-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-delete # def delete(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.delete' } @@ -53,7 +68,7 @@ def delete(arguments = {}) _connector_id = arguments.delete(:connector_id) method = Elasticsearch::API::HTTP_DELETE - path = "_connector/#{Utils.__listify(_connector_id)}" + path = "_connector/#{Utils.listify(_connector_id)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/get.rb index 23b7109386..4c04f4a86f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/get.rb @@ -15,24 +15,36 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Connector module Actions - # Returns the details about 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. + # Get a connector. + # Get the details about a connector. + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # - # @option arguments [String] :connector_id The unique identifier of the connector to be returned. - # @option arguments [Boolean] :include_deleted A flag indicating whether to return connectors that have been soft-deleted. + # @option arguments [String] :connector_id The unique identifier of the connector (*Required*) + # @option arguments [Boolean] :include_deleted A flag to indicate if the desired connector should be fetched, even if it was soft-deleted. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-connector-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-get # def get(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.get' } @@ -52,7 +64,7 @@ def get(arguments = {}) _connector_id = arguments.delete(:connector_id) method = Elasticsearch::API::HTTP_GET - path = "_connector/#{Utils.__listify(_connector_id)}" + path = "_connector/#{Utils.listify(_connector_id)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/last_sync.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/last_sync.rb deleted file mode 100644 index 1a342f408f..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/last_sync.rb +++ /dev/null @@ -1,66 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. -# -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# -module Elasticsearch - module API - module Connector - module Actions - # Updates the stats of last sync in the connector document. - # 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] :connector_id The unique identifier of the connector to be updated. - # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body Object with stats related to the last connector sync run. (*Required*) - # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-last-sync-api.html - # - def last_sync(arguments = {}) - request_opts = { endpoint: arguments[:endpoint] || 'connector.last_sync' } - - defined_params = [:connector_id].each_with_object({}) do |variable, set_variables| - set_variables[variable] = arguments[variable] if arguments.key?(variable) - end - request_opts[:defined_params] = defined_params unless defined_params.empty? - - raise ArgumentError, "Required argument 'body' missing" unless arguments[:body] - raise ArgumentError, "Required argument 'connector_id' missing" unless arguments[:connector_id] - - arguments = arguments.clone - headers = arguments.delete(:headers) || {} - - body = arguments.delete(:body) - - _connector_id = arguments.delete(:connector_id) - - method = Elasticsearch::API::HTTP_PUT - path = "_connector/#{Utils.__listify(_connector_id)}/_last_sync" - params = {} - - Elasticsearch::API::Response.new( - perform_request(method, path, params, body, headers, request_opts) - ) - end - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/list.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/list.rb index e79a2ca64e..531dc56d0a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/list.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/list.rb @@ -15,29 +15,41 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Connector module Actions - # Lists all 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. + # Get all connectors. + # Get information about all connectors. + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [Integer] :from Starting offset (default: 0) - # @option arguments [Integer] :size Specifies a max number of results to get (default: 100) - # @option arguments [List] :index_name A comma-separated list of connector index names to fetch connector documents for - # @option arguments [List] :connector_name A comma-separated list of connector names to fetch connector documents for - # @option arguments [List] :service_type A comma-separated list of connector service types to fetch connector documents for - # @option arguments [String] :query A search string for querying connectors, filtering results by matching against connector names, descriptions, and index names - # @option arguments [Boolean] :include_deleted A flag indicating whether to return connectors that have been soft-deleted. + # @option arguments [Integer] :size Specifies a max number of results to get + # @option arguments [String, Array] :index_name A comma-separated list of connector index names to fetch connector documents for + # @option arguments [String, Array] :connector_name A comma-separated list of connector names to fetch connector documents for + # @option arguments [String, Array] :service_type A comma-separated list of connector service types to fetch connector documents for + # @option arguments [Boolean] :include_deleted A flag to indicate if the desired connector should be fetched, even if it was soft-deleted. + # @option arguments [String] :query A wildcard query string that filters connectors with matching name, description or index name + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/list-connector-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-list # def list(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.list' } @@ -45,7 +57,7 @@ def list(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_connector' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/post.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/post.rb index 6e2c055541..fc41b1ebf5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/post.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/post.rb @@ -15,23 +15,37 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Connector module Actions - # Creates 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. + # Create a connector. + # Connectors are Elasticsearch integrations that bring content from third-party data sources, which can be deployed on Elastic Cloud or hosted on your own infrastructure. + # Elastic managed connectors (Native connectors) are a managed service on Elastic Cloud. + # Self-managed connectors (Connector clients) are self-managed on your infrastructure. + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features 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. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The connector configuration. + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/create-connector-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-put # def post(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.post' } @@ -39,11 +53,11 @@ def post(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_connector' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/put.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/put.rb index 038f37ab3c..78ac3452f3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/put.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/put.rb @@ -15,24 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Connector module Actions - # Creates or updates 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. + # Create or update a connector. + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # - # @option arguments [String] :connector_id The unique identifier of the connector to be created or updated. + # @option arguments [String] :connector_id The unique identifier of the connector to be created or updated. ID is auto-generated if not provided. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The connector configuration. + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/create-connector-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-put # def put(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.put' } @@ -51,11 +62,11 @@ def put(arguments = {}) method = Elasticsearch::API::HTTP_PUT path = if _connector_id - "_connector/#{Utils.__listify(_connector_id)}" + "_connector/#{Utils.listify(_connector_id)}" else '_connector' end - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_cancel.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_cancel.rb index 3a6bcebf48..4655fdb013 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_cancel.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_cancel.rb @@ -15,23 +15,36 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Connector module Actions - # Cancels a connector sync job. - # 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. + # Cancel a connector sync job. + # Cancel a connector sync job, which sets the status to cancelling and updates `cancellation_requested_at` to the current time. + # The connector service is then responsible for setting the status of connector sync jobs to cancelled. + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features 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 canceled + # @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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cancel-connector-sync-job-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-cancel # def sync_job_cancel(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.sync_job_cancel' } @@ -54,8 +67,8 @@ def sync_job_cancel(arguments = {}) _connector_sync_job_id = arguments.delete(:connector_sync_job_id) method = Elasticsearch::API::HTTP_PUT - path = "_connector/_sync_job/#{Utils.__listify(_connector_sync_job_id)}/_cancel" - params = {} + path = "_connector/_sync_job/#{Utils.listify(_connector_sync_job_id)}/_cancel" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_check_in.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_check_in.rb index 90e935c527..0019715262 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_check_in.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_check_in.rb @@ -15,23 +15,37 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Connector module Actions - # Checks in a connector sync job (refreshes 'last_seen'). + # Check in a connector sync job. + # 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. # - # @option arguments [String] :connector_sync_job_id The unique identifier of the connector sync job to be checked in + # @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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/check-in-connector-sync-job-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-check-in # def sync_job_check_in(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.sync_job_check_in' } @@ -54,8 +68,8 @@ def sync_job_check_in(arguments = {}) _connector_sync_job_id = arguments.delete(:connector_sync_job_id) method = Elasticsearch::API::HTTP_PUT - path = "_connector/_sync_job/#{Utils.__listify(_connector_sync_job_id)}/_check_in" - params = {} + path = "_connector/_sync_job/#{Utils.listify(_connector_sync_job_id)}/_check_in" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_claim.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_claim.rb index f524141fc3..a6a827494b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_claim.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_claim.rb @@ -15,24 +15,41 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Connector module Actions - # Claims a connector sync job. + # Claim a connector sync job. + # This action updates the job status to `in_progress` and sets the `last_seen` and `started_at` timestamps to the current time. + # Additionally, it can set the `sync_cursor` property for the sync job. + # This API is not intended for direct connector management by users. + # 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. # - # @option arguments [String] :connector_sync_job_id The unique identifier of the connector sync job to be claimed. + # @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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body Data to claim a sync job. (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/claim-connector-sync-job-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-claim # def sync_job_claim(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.sync_job_claim' } @@ -57,8 +74,8 @@ def sync_job_claim(arguments = {}) _connector_sync_job_id = arguments.delete(:connector_sync_job_id) method = Elasticsearch::API::HTTP_PUT - path = "_connector/_sync_job/#{Utils.__listify(_connector_sync_job_id)}/_claim" - params = {} + path = "_connector/_sync_job/#{Utils.listify(_connector_sync_job_id)}/_claim" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_delete.rb index 3a7ed141ca..1d9f342d57 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_delete.rb @@ -15,23 +15,36 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Connector module Actions - # Deletes a connector sync job. - # 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. + # Delete a connector sync job. + # Remove a connector sync job and its associated data. + # This is a destructive action that is not recoverable. + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features 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 deleted. + # @option arguments [String] :connector_sync_job_id The unique identifier of the connector sync job to be deleted (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-connector-sync-job-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-delete # def sync_job_delete(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.sync_job_delete' } @@ -54,8 +67,8 @@ def sync_job_delete(arguments = {}) _connector_sync_job_id = arguments.delete(:connector_sync_job_id) method = Elasticsearch::API::HTTP_DELETE - path = "_connector/_sync_job/#{Utils.__listify(_connector_sync_job_id)}" - params = {} + path = "_connector/_sync_job/#{Utils.listify(_connector_sync_job_id)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_error.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_error.rb index 73ed91cbd3..42ff4de588 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_error.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_error.rb @@ -15,24 +15,38 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Connector module Actions - # Sets an error for a connector sync job. + # Set a connector sync job error. + # 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. # - # @option arguments [String] :connector_sync_job_id The unique identifier of the connector sync job to set an error for. + # @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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The error to set in the connector sync job. (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/set-connector-sync-job-error-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-error # def sync_job_error(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.sync_job_error' } @@ -57,8 +71,8 @@ def sync_job_error(arguments = {}) _connector_sync_job_id = arguments.delete(:connector_sync_job_id) method = Elasticsearch::API::HTTP_PUT - path = "_connector/_sync_job/#{Utils.__listify(_connector_sync_job_id)}/_error" - params = {} + path = "_connector/_sync_job/#{Utils.listify(_connector_sync_job_id)}/_error" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_get.rb index 22e7554776..51ffcbd2ae 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_get.rb @@ -15,23 +15,34 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Connector module Actions - # Returns the details about a connector sync job. - # 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. + # Get a connector sync job. + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features 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 returned. + # @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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-connector-sync-job-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-get # def sync_job_get(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.sync_job_get' } @@ -54,8 +65,8 @@ def sync_job_get(arguments = {}) _connector_sync_job_id = arguments.delete(:connector_sync_job_id) method = Elasticsearch::API::HTTP_GET - path = "_connector/_sync_job/#{Utils.__listify(_connector_sync_job_id)}" - params = {} + path = "_connector/_sync_job/#{Utils.listify(_connector_sync_job_id)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_list.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_list.rb index 222314a516..2d3d719112 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_list.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_list.rb @@ -15,27 +15,39 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Connector module Actions - # Lists all connector sync jobs. - # 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. + # Get all connector sync jobs. + # Get information about all stored connector sync jobs listed by their creation date in ascending order. + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # # @option arguments [Integer] :from Starting offset (default: 0) - # @option arguments [Integer] :size specifies a max number of results to get (default: 100) - # @option arguments [String] :status Sync job status, which sync jobs are fetched for - # @option arguments [String] :connector_id Id of the connector to fetch the sync jobs for - # @option arguments [List] :job_type A comma-separated list of job types + # @option arguments [Integer] :size Specifies a max number of results to get + # @option arguments [String] :status A sync job status to fetch connector sync jobs for + # @option arguments [String] :connector_id A connector id to fetch connector sync jobs for + # @option arguments [String, Array] :job_type A comma-separated list of job types to fetch the sync jobs for + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/list-connector-sync-jobs-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-list # def sync_job_list(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.sync_job_list' } @@ -43,7 +55,7 @@ def sync_job_list(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_connector/_sync_job' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_post.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_post.rb index a455a80281..930ca1632e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_post.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_post.rb @@ -15,23 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Connector module Actions - # Creates a connector sync job. - # 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. + # Create a connector sync job. + # Create a connector sync job document in the internal index and initialize its counters and timestamps with default values. + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features 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. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The connector sync job data. (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/create-connector-sync-job-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-post # def sync_job_post(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.sync_job_post' } @@ -41,11 +53,11 @@ def sync_job_post(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_connector/_sync_job' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_update_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_update_stats.rb index 772a28cf31..f24168474b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_update_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/sync_job_update_stats.rb @@ -15,24 +15,40 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Connector module Actions - # Updates the stats fields in the connector sync job document. + # Set the connector sync job stats. + # Stats include: `deleted_document_count`, `indexed_document_count`, `indexed_document_volume`, and `total_document_count`. + # You can also update `last_seen`. + # 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. # - # @option arguments [String] :connector_sync_job_id The unique identifier of the connector sync job to be updated. + # @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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The stats to update for the connector sync job. (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/set-connector-sync-job-stats-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-sync-job-update-stats # def sync_job_update_stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.sync_job_update_stats' } @@ -57,8 +73,8 @@ def sync_job_update_stats(arguments = {}) _connector_sync_job_id = arguments.delete(:connector_sync_job_id) method = Elasticsearch::API::HTTP_PUT - path = "_connector/_sync_job/#{Utils.__listify(_connector_sync_job_id)}/_stats" - params = {} + path = "_connector/_sync_job/#{Utils.listify(_connector_sync_job_id)}/_stats" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_active_filtering.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_active_filtering.rb index 975c7aa3d7..ab2559d908 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_active_filtering.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_active_filtering.rb @@ -15,23 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Connector module Actions - # Activates the draft filtering rules if they are in a validated state. + # 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. # - # @option arguments [String] :connector_id The unique identifier of the connector to be updated. + # @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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-filtering-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-filtering # def update_active_filtering(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_active_filtering' } @@ -51,8 +63,8 @@ def update_active_filtering(arguments = {}) _connector_id = arguments.delete(:connector_id) method = Elasticsearch::API::HTTP_PUT - path = "_connector/#{Utils.__listify(_connector_id)}/_filtering/_activate" - params = {} + path = "_connector/#{Utils.listify(_connector_id)}/_filtering/_activate" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_api_key_id.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_api_key_id.rb index a44130824e..80ddbcda23 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_api_key_id.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_api_key_id.rb @@ -15,24 +15,39 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Connector module Actions - # Updates the API key id and/or API key secret id fields in the connector document. - # 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. + # Update the connector API key ID. + # Update the `api_key_id` and `api_key_secret_id` fields of a connector. + # You can specify the ID of the API key used for authorization and the ID of the connector secret where the API key is stored. + # The connector secret ID is required only for Elastic managed (native) connectors. + # Self-managed connectors (connector clients) do not use this field. + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features 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. + # @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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body An object containing the connector's API key id and/or Connector Secret document id for that API key. (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-api-key-id-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-api-key-id # def update_api_key_id(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_api_key_id' } @@ -53,8 +68,8 @@ def update_api_key_id(arguments = {}) _connector_id = arguments.delete(:connector_id) method = Elasticsearch::API::HTTP_PUT - path = "_connector/#{Utils.__listify(_connector_id)}/_api_key_id" - params = {} + path = "_connector/#{Utils.listify(_connector_id)}/_api_key_id" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_configuration.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_configuration.rb index fc51bd4315..2baa827e1a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_configuration.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_configuration.rb @@ -15,24 +15,36 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Connector module Actions - # Updates the connector configuration. - # 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. + # Update the connector configuration. + # Update the configuration field in the connector document. + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features 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. + # @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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body Mapping between field names to configuration. (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-configuration-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-configuration # def update_configuration(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_configuration' } @@ -53,8 +65,8 @@ def update_configuration(arguments = {}) _connector_id = arguments.delete(:connector_id) method = Elasticsearch::API::HTTP_PUT - path = "_connector/#{Utils.__listify(_connector_id)}/_configuration" - params = {} + path = "_connector/#{Utils.listify(_connector_id)}/_configuration" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_error.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_error.rb index eec511fc21..22497d6ced 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_error.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_error.rb @@ -15,24 +15,38 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Connector module Actions - # Updates the error field in the connector document. + # Update the connector error field. + # 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. # - # @option arguments [String] :connector_id The unique identifier of the connector to be updated. + # @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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body An object containing the connector's error. (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-error-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-error # def update_error(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_error' } @@ -53,8 +67,8 @@ def update_error(arguments = {}) _connector_id = arguments.delete(:connector_id) method = Elasticsearch::API::HTTP_PUT - path = "_connector/#{Utils.__listify(_connector_id)}/_error" - params = {} + path = "_connector/#{Utils.listify(_connector_id)}/_error" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_features.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_features.rb index 531a7c2ad1..0a7ca121ef 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_features.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_features.rb @@ -15,24 +15,45 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Connector module Actions - # Updates the connector features in the connector document. + # Update the connector features. + # Update the connector features in the connector document. + # This API can be used to control the following aspects of a connector: + # * document-level security + # * incremental syncs + # * advanced sync rules + # * basic sync rules + # Normally, the running connector service automatically manages these features. + # 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. # - # @option arguments [String] :connector_id The unique identifier of the connector to be updated. + # @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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body An object containing the connector's features definition. (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-features-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-features # def update_features(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_features' } @@ -53,8 +74,8 @@ def update_features(arguments = {}) _connector_id = arguments.delete(:connector_id) method = Elasticsearch::API::HTTP_PUT - path = "_connector/#{Utils.__listify(_connector_id)}/_features" - params = {} + path = "_connector/#{Utils.listify(_connector_id)}/_features" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_filtering.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_filtering.rb index 314a30e6d7..e6a12ea190 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_filtering.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_filtering.rb @@ -15,24 +15,38 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Connector module Actions - # Updates the filtering field in the connector document. - # 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. + # Update the connector filtering. + # Update the draft filtering configuration of a connector and marks the draft validation state as edited. + # The filtering draft is activated once validated by the running Elastic connector service. + # The filtering property is used to configure sync rules (both basic and advanced) for a connector. + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features 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. + # @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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body A list of connector filtering configurations. (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-filtering-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-filtering # def update_filtering(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_filtering' } @@ -53,8 +67,8 @@ def update_filtering(arguments = {}) _connector_id = arguments.delete(:connector_id) method = Elasticsearch::API::HTTP_PUT - path = "_connector/#{Utils.__listify(_connector_id)}/_filtering" - params = {} + path = "_connector/#{Utils.listify(_connector_id)}/_filtering" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_filtering_validation.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_filtering_validation.rb index b42a75b4db..e71ecebfe2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_filtering_validation.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_filtering_validation.rb @@ -15,24 +15,36 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Connector module Actions - # Updates the validation info of the draft filtering rules. + # 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. # - # @option arguments [String] :connector_id The unique identifier of the connector to be updated. + # @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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body Validation info for the draft filtering rules (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-filtering-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-filtering-validation # def update_filtering_validation(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_filtering_validation' } @@ -53,8 +65,8 @@ def update_filtering_validation(arguments = {}) _connector_id = arguments.delete(:connector_id) method = Elasticsearch::API::HTTP_PUT - path = "_connector/#{Utils.__listify(_connector_id)}/_filtering/_validation" - params = {} + path = "_connector/#{Utils.listify(_connector_id)}/_filtering/_validation" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_index_name.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_index_name.rb index ce76d01503..cc86a85df9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_index_name.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_index_name.rb @@ -15,24 +15,36 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Connector module Actions - # Updates the index name of the 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. + # Update the connector index name. + # Update the `index_name` field of a connector, specifying the index where the data ingested by the connector is stored. + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features 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. + # @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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body An object containing the connector's index name. (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-index-name-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-index-name # def update_index_name(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_index_name' } @@ -53,8 +65,8 @@ def update_index_name(arguments = {}) _connector_id = arguments.delete(:connector_id) method = Elasticsearch::API::HTTP_PUT - path = "_connector/#{Utils.__listify(_connector_id)}/_index_name" - params = {} + path = "_connector/#{Utils.listify(_connector_id)}/_index_name" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_name.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_name.rb index ecdac5b2a7..94a37d7069 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_name.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_name.rb @@ -15,24 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Connector module Actions - # Updates the name and/or description fields in the connector document. - # 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. + # Update the connector name and description. + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features 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. + # @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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body An object containing the connector's name and/or description. (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-name-description-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-name # def update_name(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_name' } @@ -53,8 +64,8 @@ def update_name(arguments = {}) _connector_id = arguments.delete(:connector_id) method = Elasticsearch::API::HTTP_PUT - path = "_connector/#{Utils.__listify(_connector_id)}/_name" - params = {} + path = "_connector/#{Utils.listify(_connector_id)}/_name" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_native.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_native.rb index 81779e6e38..ea945bc1c4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_native.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_native.rb @@ -15,24 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Connector module Actions - # Updates the is_native flag of the 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. + # Update the connector is_native flag. + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features 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. + # @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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body An object containing the connector's is_native flag (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/connector-apis.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-native # def update_native(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_native' } @@ -53,8 +64,8 @@ def update_native(arguments = {}) _connector_id = arguments.delete(:connector_id) method = Elasticsearch::API::HTTP_PUT - path = "_connector/#{Utils.__listify(_connector_id)}/_native" - params = {} + path = "_connector/#{Utils.listify(_connector_id)}/_native" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_pipeline.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_pipeline.rb index e5f7f6ee23..216cac32e1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_pipeline.rb @@ -15,24 +15,36 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Connector module Actions - # Updates the pipeline field in the connector document. - # 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. + # Update the connector pipeline. + # When you create a new connector, the configuration of an ingest pipeline is populated with default settings. + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features 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. + # @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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body An object with connector ingest pipeline configuration. (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-pipeline-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-pipeline # def update_pipeline(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_pipeline' } @@ -53,8 +65,8 @@ def update_pipeline(arguments = {}) _connector_id = arguments.delete(:connector_id) method = Elasticsearch::API::HTTP_PUT - path = "_connector/#{Utils.__listify(_connector_id)}/_pipeline" - params = {} + path = "_connector/#{Utils.listify(_connector_id)}/_pipeline" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_scheduling.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_scheduling.rb index 2c87061c26..9eed44bc63 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_scheduling.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_scheduling.rb @@ -15,24 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Connector module Actions - # Updates the scheduling field in the connector document. - # 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. + # Update the connector scheduling. + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features 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. + # @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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body An object containing the connector's scheduling configuration. (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-scheduling-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-scheduling # def update_scheduling(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_scheduling' } @@ -53,8 +64,8 @@ def update_scheduling(arguments = {}) _connector_id = arguments.delete(:connector_id) method = Elasticsearch::API::HTTP_PUT - path = "_connector/#{Utils.__listify(_connector_id)}/_scheduling" - params = {} + path = "_connector/#{Utils.listify(_connector_id)}/_scheduling" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_service_type.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_service_type.rb index 757b43c8ec..94afbe781a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_service_type.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_service_type.rb @@ -15,24 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Connector module Actions - # Updates the service type of the 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. + # Update the connector service type. + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features 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. + # @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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body An object containing the connector's service type. (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-service-type-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-service-type # def update_service_type(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_service_type' } @@ -53,8 +64,8 @@ def update_service_type(arguments = {}) _connector_id = arguments.delete(:connector_id) method = Elasticsearch::API::HTTP_PUT - path = "_connector/#{Utils.__listify(_connector_id)}/_service_type" - params = {} + path = "_connector/#{Utils.listify(_connector_id)}/_service_type" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_status.rb index 8b1ef81f37..f9d0fb852f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/connector/update_status.rb @@ -15,24 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Connector module Actions - # Updates the status of the connector. + # 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. # - # @option arguments [String] :connector_id The unique identifier of the connector to be updated. + # @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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body An object containing the connector's status. (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-status-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-connector-update-status # def update_status(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'connector.update_status' } @@ -53,8 +64,8 @@ def update_status(arguments = {}) _connector_id = arguments.delete(:connector_id) method = Elasticsearch::API::HTTP_PUT - path = "_connector/#{Utils.__listify(_connector_id)}/_status" - params = {} + path = "_connector/#{Utils.listify(_connector_id)}/_status" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/count.rb b/elasticsearch-api/lib/elasticsearch/api/actions/count.rb index 393bbb7fda..a2ec54703a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/count.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/count.rb @@ -15,33 +15,68 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Returns number of documents matching a query. + # Count search results. + # Get the number of documents matching a query. + # The query can be provided either by using a simple query string as a parameter, or by defining Query DSL within the request body. + # The query is optional. When no query is provided, the API uses `match_all` to count all the documents. + # The count API supports multi-target syntax. You can run a single count API search across multiple data streams and indices. + # The operation is broadcast across all shards. + # For each shard ID group, a replica is chosen and the search is run against it. + # This means that replicas increase the scalability of the count. # - # @option arguments [List] :index A comma-separated list of indices to restrict the results - # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) - # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled - # @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) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) - # @option arguments [Number] :min_score Include only documents with a specific `_score` value in the result - # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) - # @option arguments [List] :routing A comma-separated list of specific routing values - # @option arguments [String] :q Query in the Lucene query string syntax - # @option arguments [String] :analyzer The analyzer to use for the query string - # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false) - # @option arguments [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR) - # @option arguments [String] :df The field to use as default where no field prefix is given in the query string - # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored - # @option arguments [Number] :terminate_after The maximum count for each shard, upon reaching which the query execution will terminate early + # @option arguments [String, Array] :index A comma-separated list of data streams, indices, and aliases to search. + # It supports wildcards (`*`). + # To search all data streams and indices, omit this parameter or use `*` or `_all`. + # @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`. Server default: true. + # @option arguments [String] :analyzer The analyzer to use for the query string. + # This parameter can be used only when the `q` query string parameter is specified. + # @option arguments [Boolean] :analyze_wildcard If `true`, wildcard and prefix queries are analyzed. + # This parameter can be used only when the `q` query string parameter is specified. + # @option arguments [String] :default_operator The default operator for query string query: `AND` or `OR`. + # This parameter can be used only when the `q` query string parameter is specified. Server default: OR. + # @option arguments [String] :df The field to use as a default when no field prefix is given in the query string. + # This parameter can be used only when the `q` query string parameter is specified. + # @option arguments [String, Array] :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`. Server default: open. + # @option arguments [Boolean] :ignore_throttled If `true`, concrete, expanded, or aliased indices are ignored when frozen. Server default: true. + # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. + # @option arguments [Boolean] :lenient If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + # This parameter can be used only when the `q` query string parameter is specified. + # @option arguments [Float] :min_score The minimum `_score` value that documents must have to be included in the result. + # @option arguments [String] :preference The node or shard the operation should be performed on. + # By default, it is random. + # @option arguments [String] :routing A custom value used to route operations to a specific shard. + # @option arguments [Integer] :terminate_after The maximum number of documents to collect for each shard. + # If a query reaches this limit, Elasticsearch terminates the query early. + # Elasticsearch collects documents before sorting.IMPORTANT: Use with caution. + # Elasticsearch applies this parameter to each shard handling the request. + # When possible, let Elasticsearch perform early termination automatically. + # Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + # @option arguments [String] :q The query in Lucene query string syntax. This parameter cannot be used with a request body. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body A query to restrict the results specified with the Query DSL (optional) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-count.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-count # def count(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'count' } @@ -64,11 +99,11 @@ def count(arguments = {}) Elasticsearch::API::HTTP_GET end - path = if _index - "#{Utils.__listify(_index)}/_count" - else - '_count' - end + path = if _index + "#{Utils.listify(_index)}/_count" + else + '_count' + end params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/create.rb b/elasticsearch-api/lib/elasticsearch/api/actions/create.rb index cc1cc723a6..d2b996b1ff 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/create.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/create.rb @@ -15,44 +15,134 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Creates a new document in the index. - # - # Returns a 409 response when a document with a same ID already exists in the index. + # Create a new document in the index. + # You can index a new JSON document with the `//_doc/` or `//_create/<_id>` APIs + # Using `_create` guarantees that the document is indexed only if it does not already exist. + # It returns a 409 response when a document with a same ID already exists in the index. + # To update an existing document, you must use the `//_doc/` API. + # If the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias: + # * To add a document using the `PUT //_create/<_id>` or `POST //_create/<_id>` request formats, you must have the `create_doc`, `create`, `index`, or `write` index privilege. + # * To automatically create a data stream or index with this API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege. + # Automatic data stream creation requires a matching index template with data stream enabled. + # **Automatically create data streams and indices** + # If the request's target doesn't exist and matches an index template with a `data_stream` definition, the index operation automatically creates the data stream. + # If the target doesn't exist and doesn't match a data stream template, the operation automatically creates the index and applies any matching index templates. + # NOTE: Elasticsearch includes several built-in index templates. To avoid naming collisions with these templates, refer to index pattern documentation. + # If no mapping exists, the index operation creates a dynamic mapping. + # By default, new fields and objects are automatically added to the mapping if needed. + # Automatic index creation is controlled by the `action.auto_create_index` setting. + # If it is `true`, any index can be created automatically. + # You can modify this setting to explicitly allow or block automatic creation of indices that match specified patterns or set it to `false` to turn off automatic index creation entirely. + # Specify a comma-separated list of patterns you want to allow or prefix each pattern with `+` or `-` to indicate whether it should be allowed or blocked. + # When a list is specified, the default behaviour is to disallow. + # NOTE: The `action.auto_create_index` setting affects the automatic creation of indices only. + # It does not affect the creation of data streams. + # **Routing** + # By default, shard placement — or routing — is controlled by using a hash of the document's ID value. + # For more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the `routing` parameter. + # When setting up explicit mapping, you can also use the `_routing` field to direct the index operation to extract the routing value from the document itself. + # This does come at the (very minimal) cost of an additional document parsing pass. + # If the `_routing` mapping is defined and set to be required, the index operation will fail if no routing value is provided or extracted. + # NOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template. + # **Distributed** + # The index operation is directed to the primary shard based on its route and performed on the actual node containing this shard. + # After the primary shard completes the operation, if needed, the update is distributed to applicable replicas. + # **Active shards** + # To improve the resiliency of writes to the system, indexing operations can be configured to wait for a certain number of active shard copies before proceeding with the operation. + # If the requisite number of active shard copies are not available, then the write operation must wait and retry, until either the requisite shard copies have started or a timeout occurs. + # By default, write operations only wait for the primary shards to be active before proceeding (that is to say `wait_for_active_shards` is `1`). + # This default can be overridden in the index settings dynamically by setting `index.write.wait_for_active_shards`. + # To alter this behavior per operation, use the `wait_for_active_shards request` parameter. + # Valid values are all or any positive integer up to the total number of configured copies per shard in the index (which is `number_of_replicas`+1). + # Specifying a negative value or a number greater than the number of shard copies will throw an error. + # For example, suppose you have a cluster of three nodes, A, B, and C and you create an index index with the number of replicas set to 3 (resulting in 4 shard copies, one more copy than there are nodes). + # If you attempt an indexing operation, by default the operation will only ensure the primary copy of each shard is available before proceeding. + # This means that even if B and C went down and A hosted the primary shard copies, the indexing operation would still proceed with only one copy of the data. + # If `wait_for_active_shards` is set on the request to `3` (and all three nodes are up), the indexing operation will require 3 active shard copies before proceeding. + # This requirement should be met because there are 3 active nodes in the cluster, each one holding a copy of the shard. + # However, if you set `wait_for_active_shards` to `all` (or to `4`, which is the same in this situation), the indexing operation will not proceed as you do not have all 4 copies of each shard active in the index. + # The operation will timeout unless a new node is brought up in the cluster to host the fourth copy of the shard. + # It is important to note that this setting greatly reduces the chances of the write operation not writing to the requisite number of shard copies, but it does not completely eliminate the possibility, because this check occurs before the write operation starts. + # After the write operation is underway, it is still possible for replication to fail on any number of shard copies but still succeed on the primary. + # The `_shards` section of the API response reveals the number of shard copies on which replication succeeded and failed. # - # @option arguments [String] :id Document ID - # @option arguments [String] :index The name of the index - # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) - # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (options: true, false, wait_for) - # @option arguments [String] :routing Specific routing value - # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Number] :version Explicit version number for concurrency control - # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte) - # @option arguments [String] :pipeline The pipeline id to preprocess incoming documents with - # @option arguments [Boolean] :include_source_on_error True or false if to include the document source in the error message in case of parsing errors. Defaults to true. + # @option arguments [String] :id A unique identifier for the document. + # To automatically generate a document ID, use the `POST //_doc/` request format. (*Required*) + # @option arguments [String] :index The name of the data stream or index to target. + # If the target doesn't exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream. + # If the target doesn't exist and doesn’t match a data stream template, this request creates the index. (*Required*) + # @option arguments [Boolean] :include_source_on_error True or false if to include the document source in the error message in case of parsing errors. Server default: true. + # @option arguments [String] :pipeline The ID of the pipeline to use to preprocess incoming documents. + # If the index has a default ingest pipeline specified, setting the value to `_none` turns off the default ingest pipeline for this request. + # If a final pipeline is configured, it will always run regardless of the value of this parameter. + # @option arguments [String] :refresh If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search. + # If `wait_for`, it waits for a refresh to make this operation visible to search. + # If `false`, it does nothing with refreshes. Server default: false. + # @option arguments [Boolean] :require_alias If `true`, the destination must be an index alias. + # @option arguments [Boolean] :require_data_stream If `true`, the request's actions must target a data stream (existing or to be created). + # @option arguments [String] :routing A custom value that is used to route operations to a specific shard. + # @option arguments [Time] :timeout The period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards. + # Elasticsearch waits for at least the specified timeout period before failing. + # The actual wait time could be longer, particularly when multiple waits occur.This parameter is useful for situations where the primary shard assigned to perform the operation might not be available when the operation runs. + # Some reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation. + # By default, the operation will wait on the primary shard to become available for at least 1 minute before failing and responding with an error. + # The actual wait time could be longer, particularly when multiple waits occur. Server default: 1m. + # @option arguments [Integer] :version The explicit version number for concurrency control. + # It must be a non-negative long number. + # @option arguments [String] :version_type The version type. + # @option arguments [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operation. + # You can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + # The default value of `1` means it waits for each primary shard to be active. Server default: 1. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The document (*Required*) + # @option arguments [Hash] :body document # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-create # def create(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'create' } - defined_params = %i[index id].each_with_object({}) do |variable, set_variables| + defined_params = [:index, :id].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? - if arguments[:id] - index arguments.update op_type: 'create' - else - index arguments - end + raise ArgumentError, "Required argument 'body' missing" unless arguments[:body] + raise ArgumentError, "Required argument 'index' missing" unless arguments[:index] + raise ArgumentError, "Required argument 'id' missing" unless arguments[:id] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _id = arguments.delete(:id) + + _index = arguments.delete(:index) + + method = Elasticsearch::API::HTTP_PUT + path = "#{Utils.listify(_index)}/_create/#{Utils.listify(_id)}" + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) end end end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/delete_auto_follow_pattern.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/delete_auto_follow_pattern.rb index b3537c7ad1..7700e36746 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/delete_auto_follow_pattern.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/delete_auto_follow_pattern.rb @@ -15,20 +15,34 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module CrossClusterReplication module Actions - # Deletes auto-follow patterns. + # Delete auto-follow patterns. + # Delete a collection of cross-cluster replication auto-follow patterns. # - # @option arguments [String] :name The name of the auto follow pattern. - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [String] :name The auto-follow pattern collection to delete. (*Required*) + # @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. + # It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-delete-auto-follow-pattern.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-delete-auto-follow-pattern # def delete_auto_follow_pattern(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.delete_auto_follow_pattern' } @@ -48,7 +62,7 @@ def delete_auto_follow_pattern(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_DELETE - path = "_ccr/auto_follow/#{Utils.__listify(_name)}" + path = "_ccr/auto_follow/#{Utils.listify(_name)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow.rb index c1fffadc12..67d672897d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow.rb @@ -15,22 +15,38 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module CrossClusterReplication module Actions - # Creates a new follower index configured to follow the referenced leader index. + # Create a follower. + # Create a cross-cluster replication follower index that follows a specific leader index. + # When the API returns, the follower index exists and cross-cluster replication starts replicating operations from the leader index to the follower index. # - # @option arguments [String] :index The name of the follower index - # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before returning. Defaults to 0. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [String] :index The name of the follower index. (*Required*) + # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. + # @option arguments [Integer, String] :wait_for_active_shards Specifies the number of shards to wait on being active before responding. This defaults to waiting on none of the shards to be + # active. + # A shard must be restored from the leader index before being active. Restoring a follower shard requires transferring all the + # remote Lucene segment files to the follower index. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The name of the leader index and other optional ccr related parameters (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-follow.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-follow # def follow(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.follow' } @@ -46,12 +62,12 @@ def follow(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_PUT - path = "#{Utils.__listify(_index)}/_ccr/follow" + path = "#{Utils.listify(_index)}/_ccr/follow" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow_info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow_info.rb index 7ba6a422b0..1482c5912c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow_info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow_info.rb @@ -15,20 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module CrossClusterReplication module Actions - # Retrieves information about all follower indices, including parameters and status for each follower index + # Get follower information. + # Get information about all cross-cluster replication follower indices. + # For example, the results include follower index names, leader index names, replication options, and whether the follower indices are active or paused. # - # @option arguments [List] :index A comma-separated list of index patterns; use `_all` to perform the operation on all indices - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [String, Array] :index A comma-delimited list of follower index patterns. (*Required*) + # @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. + # It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-info.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-follow-info # def follow_info(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.follow_info' } @@ -43,12 +58,12 @@ def follow_info(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_GET - path = "#{Utils.__listify(_index)}/_ccr/info" + path = "#{Utils.listify(_index)}/_ccr/info" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow_stats.rb index 85e45f1259..0b3a59a515 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/follow_stats.rb @@ -15,20 +15,34 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module CrossClusterReplication module Actions - # Retrieves follower stats. return shard-level stats about the following tasks associated with each shard for the specified indices. + # Get follower stats. + # Get cross-cluster replication follower stats. + # The API returns shard-level stats about the "following tasks" associated with each shard for the specified indices. # - # @option arguments [List] :index A comma-separated list of index patterns; use `_all` to perform the operation on all indices - # @option arguments [Time] :timeout Explicit operation timeout + # @option arguments [String, Array] :index A comma-delimited list of index patterns. (*Required*) + # @option arguments [Time] :timeout The period to wait for a response. + # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-follow-stats.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-follow-stats # def follow_stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.follow_stats' } @@ -43,12 +57,12 @@ def follow_stats(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_GET - path = "#{Utils.__listify(_index)}/_ccr/stats" + path = "#{Utils.listify(_index)}/_ccr/stats" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/forget_follower.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/forget_follower.rb index aa3726b0b6..c24b8fb83b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/forget_follower.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/forget_follower.rb @@ -15,21 +15,41 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module CrossClusterReplication module Actions - # Removes the follower retention leases from the leader. + # Forget a follower. + # Remove the cross-cluster replication follower retention leases from the leader. + # A following index takes out retention leases on its leader index. + # These leases are used to increase the likelihood that the shards of the leader index retain the history of operations that the shards of the following index need to run replication. + # When a follower index is converted to a regular index by the unfollow API (either by directly calling the API or by index lifecycle management tasks), these leases are removed. + # However, removal of the leases can fail, for example when the remote cluster containing the leader index is unavailable. + # While the leases will eventually expire on their own, their extended existence can cause the leader index to hold more history than necessary and prevent index lifecycle management from performing some operations on the leader index. + # This API exists to enable manually removing the leases when the unfollow API is unable to do so. + # NOTE: This API does not stop replication by a following index. If you use this API with a follower index that is still actively following, the following index will add back retention leases on the leader. + # The only purpose of this API is to handle the case of failure to remove the following retention leases after the unfollow API is invoked. # - # @option arguments [String] :index the name of the leader index for which specified follower retention leases should be removed - # @option arguments [Time] :timeout Explicit operation timeout + # @option arguments [String] :index the name of the leader index for which specified follower retention leases should be removed (*Required*) + # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body the name and UUID of the follower index, the name of the cluster containing the follower index, and the alias from the perspective of that cluster for the remote cluster containing the leader index (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-forget-follower.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-forget-follower # def forget_follower(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.forget_follower' } @@ -45,12 +65,12 @@ def forget_follower(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_POST - path = "#{Utils.__listify(_index)}/_ccr/forget_follower" + path = "#{Utils.listify(_index)}/_ccr/forget_follower" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/get_auto_follow_pattern.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/get_auto_follow_pattern.rb index ea4f844ef9..37817ba302 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/get_auto_follow_pattern.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/get_auto_follow_pattern.rb @@ -15,20 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module CrossClusterReplication module Actions - # Gets configured auto-follow patterns. Returns the specified auto-follow pattern collection. + # Get auto-follow patterns. + # Get cross-cluster replication auto-follow patterns. # - # @option arguments [String] :name The name of the auto follow pattern. - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [String] :name The auto-follow pattern collection that you want to retrieve. + # If you do not specify a name, the API returns information for all collections. + # @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. + # It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-auto-follow-pattern.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-get-auto-follow-pattern-1 # def get_auto_follow_pattern(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.get_auto_follow_pattern' } @@ -47,7 +62,7 @@ def get_auto_follow_pattern(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _name - "_ccr/auto_follow/#{Utils.__listify(_name)}" + "_ccr/auto_follow/#{Utils.listify(_name)}" else '_ccr/auto_follow' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/pause_auto_follow_pattern.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/pause_auto_follow_pattern.rb index 573bd73ad4..829de8ac1f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/pause_auto_follow_pattern.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/pause_auto_follow_pattern.rb @@ -15,20 +15,39 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module CrossClusterReplication module Actions - # Pauses an auto-follow pattern + # Pause an auto-follow pattern. + # Pause a cross-cluster replication auto-follow pattern. + # When the API returns, the auto-follow pattern is inactive. + # New indices that are created on the remote cluster and match the auto-follow patterns are ignored. + # You can resume auto-following with the resume auto-follow pattern API. + # When it resumes, the auto-follow pattern is active again and automatically configures follower indices for newly created indices on the remote cluster that match its patterns. + # Remote indices that were created while the pattern was paused will also be followed, unless they have been deleted or closed in the interim. # - # @option arguments [String] :name The name of the auto follow pattern that should pause discovering new indices to follow. - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [String] :name The name of the auto-follow pattern to pause. (*Required*) + # @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. + # It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-pause-auto-follow-pattern.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-pause-auto-follow-pattern # def pause_auto_follow_pattern(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.pause_auto_follow_pattern' } @@ -48,7 +67,7 @@ def pause_auto_follow_pattern(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_POST - path = "_ccr/auto_follow/#{Utils.__listify(_name)}/pause" + path = "_ccr/auto_follow/#{Utils.listify(_name)}/pause" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/pause_follow.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/pause_follow.rb index 275bd1675e..881117a1e5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/pause_follow.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/pause_follow.rb @@ -15,20 +15,37 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module CrossClusterReplication module Actions - # Pauses a follower index. The follower index will not fetch any additional operations from the leader index. + # Pause a follower. + # Pause a cross-cluster replication follower index. + # The follower index will not fetch any additional operations from the leader index. + # You can resume following with the resume follower API. + # You can pause and resume a follower index to change the configuration of the following task. # - # @option arguments [String] :index The name of the follower index that should pause following its leader index. - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [String] :index The name of the follower index. (*Required*) + # @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. + # It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-pause-follow.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-pause-follow # def pause_follow(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.pause_follow' } @@ -43,12 +60,12 @@ def pause_follow(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_POST - path = "#{Utils.__listify(_index)}/_ccr/pause_follow" + path = "#{Utils.listify(_index)}/_ccr/pause_follow" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/put_auto_follow_pattern.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/put_auto_follow_pattern.rb index 4ea1a7a754..9fc2f9f207 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/put_auto_follow_pattern.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/put_auto_follow_pattern.rb @@ -15,21 +15,37 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module CrossClusterReplication module Actions - # Creates a new named collection of auto-follow patterns against a specified remote cluster. Newly created indices on the remote cluster matching any of the specified patterns will be automatically configured as follower indices. + # Create or update auto-follow patterns. + # Create a collection of cross-cluster replication auto-follow patterns for a remote cluster. + # Newly created indices on the remote cluster that match any of the patterns are automatically configured as follower indices. + # Indices on the remote cluster that were created before the auto-follow pattern was created will not be auto-followed even if they match the pattern. + # This API can also be used to update auto-follow patterns. + # NOTE: Follower indices that were configured automatically before updating an auto-follow pattern will remain unchanged even if they do not match against the new patterns. # - # @option arguments [String] :name The name of the auto follow pattern. - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [String] :name The name of the collection of auto-follow patterns. (*Required*) + # @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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The specification of the auto follow pattern (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-put-auto-follow-pattern.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-put-auto-follow-pattern # def put_auto_follow_pattern(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.put_auto_follow_pattern' } @@ -50,7 +66,7 @@ def put_auto_follow_pattern(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_PUT - path = "_ccr/auto_follow/#{Utils.__listify(_name)}" + path = "_ccr/auto_follow/#{Utils.listify(_name)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/resume_auto_follow_pattern.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/resume_auto_follow_pattern.rb index 2a979f9add..971a4ae9da 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/resume_auto_follow_pattern.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/resume_auto_follow_pattern.rb @@ -15,20 +15,36 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module CrossClusterReplication module Actions - # Resumes an auto-follow pattern that has been paused + # Resume an auto-follow pattern. + # Resume a cross-cluster replication auto-follow pattern that was paused. + # The auto-follow pattern will resume configuring following indices for newly created indices that match its patterns on the remote cluster. + # Remote indices created while the pattern was paused will also be followed unless they have been deleted or closed in the interim. # - # @option arguments [String] :name The name of the auto follow pattern to resume discovering new indices to follow. - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [String] :name The name of the auto-follow pattern to resume. (*Required*) + # @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. + # It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-resume-auto-follow-pattern.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-resume-auto-follow-pattern # def resume_auto_follow_pattern(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.resume_auto_follow_pattern' } @@ -48,7 +64,7 @@ def resume_auto_follow_pattern(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_POST - path = "_ccr/auto_follow/#{Utils.__listify(_name)}/resume" + path = "_ccr/auto_follow/#{Utils.listify(_name)}/resume" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/resume_follow.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/resume_follow.rb index f172d59a88..a899220d12 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/resume_follow.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/resume_follow.rb @@ -15,21 +15,36 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module CrossClusterReplication module Actions - # Resumes a follower index that has been paused + # Resume a follower. + # Resume a cross-cluster replication follower index that was paused. + # The follower index could have been paused with the pause follower API. + # Alternatively it could be paused due to replication that cannot be retried due to failures during following tasks. + # When this API returns, the follower index will resume fetching operations from the leader index. # - # @option arguments [String] :index The name of the follow index to resume following. - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [String] :index The name of the follow index to resume following. (*Required*) + # @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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The name of the leader index and other optional ccr related parameters + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-resume-follow.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-resume-follow # def resume_follow(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.resume_follow' } @@ -44,12 +59,12 @@ def resume_follow(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_POST - path = "#{Utils.__listify(_index)}/_ccr/resume_follow" + path = "#{Utils.listify(_index)}/_ccr/resume_follow" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/stats.rb index 276ce44b34..5a765d5b51 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/stats.rb @@ -15,20 +15,34 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module CrossClusterReplication module Actions - # Gets all stats related to cross-cluster replication. + # Get cross-cluster replication stats. + # This API returns stats about auto-following and the same shard-level stats as the get follower stats API. # - # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @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. + # It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s. + # @option arguments [Time] :timeout The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-get-stats.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-stats # def stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.stats' } @@ -36,7 +50,7 @@ def stats(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_ccr/stats' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/unfollow.rb b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/unfollow.rb index 9719fd23a4..6cc0261e9e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/unfollow.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/cross_cluster_replication/unfollow.rb @@ -15,20 +15,36 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module CrossClusterReplication module Actions - # Stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + # Unfollow an index. + # Convert a cross-cluster replication follower index to a regular index. + # The API stops the following task associated with a follower index and removes index metadata and settings associated with cross-cluster replication. + # The follower index must be paused and closed before you call the unfollow API. # - # @option arguments [String] :index The name of the follower index that should be turned into a regular index. - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [String] :index The name of the follower index. (*Required*) + # @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. + # It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ccr-post-unfollow.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ccr-unfollow # def unfollow(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ccr.unfollow' } @@ -43,12 +59,12 @@ def unfollow(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_POST - path = "#{Utils.__listify(_index)}/_ccr/unfollow" + path = "#{Utils.listify(_index)}/_ccr/unfollow" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb b/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb index 82810e3a02..97a8a692eb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb @@ -15,22 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module DanglingIndices module Actions - # Deletes the specified dangling index + # Delete a dangling index. + # If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. + # 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 dangling index - # @option arguments [Boolean] :accept_data_loss Must be set to true in order to delete the dangling index - # @option arguments [Time] :timeout Explicit operation timeout + # @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 [Time] :master_timeout Specify timeout for connection to master + # @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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-gateway-dangling-indices.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-dangling-indices-delete-dangling-index # def delete_dangling_index(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'dangling_indices.delete_dangling_index' } @@ -50,7 +63,7 @@ def delete_dangling_index(arguments = {}) _index_uuid = arguments.delete(:index_uuid) method = Elasticsearch::API::HTTP_DELETE - path = "_dangling/#{Utils.__listify(_index_uuid)}" + path = "_dangling/#{Utils.listify(_index_uuid)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb b/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb index 3806639cb2..9f2c9c8c29 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb @@ -15,22 +15,36 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module DanglingIndices module Actions - # Imports the specified dangling index + # Import a dangling index. + # If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. + # 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 dangling index - # @option arguments [Boolean] :accept_data_loss Must be set to true in order to import the dangling index - # @option arguments [Time] :timeout Explicit operation timeout + # @option arguments [String] :index_uuid The UUID of the index to import. Use the get dangling indices API to locate the UUID. (*Required*) + # @option arguments [Boolean] :accept_data_loss This parameter must be set to true to import a dangling index. + # Because Elasticsearch cannot know where the dangling index data came from or determine which shard copies are fresh and which are stale, it cannot guarantee that the imported data represents the latest state of the index when it was last in the cluster. (*Required*) # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-gateway-dangling-indices.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-dangling-indices-import-dangling-index # def import_dangling_index(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'dangling_indices.import_dangling_index' } @@ -50,7 +64,7 @@ def import_dangling_index(arguments = {}) _index_uuid = arguments.delete(:index_uuid) method = Elasticsearch::API::HTTP_POST - path = "_dangling/#{Utils.__listify(_index_uuid)}" + path = "_dangling/#{Utils.listify(_index_uuid)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/list_dangling_indices.rb b/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/list_dangling_indices.rb index a46ca9851c..69c6665636 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/list_dangling_indices.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/dangling_indices/list_dangling_indices.rb @@ -15,18 +15,32 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module DanglingIndices module Actions - # Returns all dangling indices. + # Get the dangling indices. + # If Elasticsearch encounters index data that is absent from the current cluster state, those indices are considered to be dangling. + # For example, this can happen if you delete more than `cluster.indices.tombstones.size` indices while an Elasticsearch node is offline. + # Use this API to list dangling indices, which you can then import or delete. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-gateway-dangling-indices.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-dangling-indices-list-dangling-indices # def list_dangling_indices(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'dangling_indices.list_dangling_indices' } @@ -34,11 +48,11 @@ def list_dangling_indices(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_dangling' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/delete.rb index 3d0505817f..3367b19256 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/delete.rb @@ -15,32 +15,76 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Removes a document from the index. + # Delete a document. + # Remove a JSON document from the specified index. + # NOTE: You cannot send deletion requests directly to a data stream. + # To delete a document in a data stream, you must target the backing index containing the document. + # **Optimistic concurrency control** + # Delete operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number and primary term specified by the `if_seq_no` and `if_primary_term` parameters. + # If a mismatch is detected, the operation will result in a `VersionConflictException` and a status code of `409`. + # **Versioning** + # Each document indexed is versioned. + # When deleting a document, the version can be specified to make sure the relevant document you are trying to delete is actually being deleted and it has not changed in the meantime. + # Every write operation run on a document, deletes included, causes its version to be incremented. + # The version number of a deleted document remains available for a short time after deletion to allow for control of concurrent operations. + # The length of time for which a deleted document's version remains available is determined by the `index.gc_deletes` index setting. + # **Routing** + # If routing is used during indexing, the routing value also needs to be specified to delete a document. + # If the `_routing` mapping is set to `required` and no routing value is specified, the delete API throws a `RoutingMissingException` and rejects the request. + # For example: + # + # ``` + # DELETE /my-index-000001/_doc/1?routing=shard-1 + # ``` + # + # This request deletes the document with ID 1, but it is routed based on the user. + # The document is not deleted if the correct routing is not specified. + # **Distributed** + # The delete operation gets hashed into a specific shard ID. + # It then gets redirected into the primary shard within that ID group and replicated (if needed) to shard replicas within that ID group. # - # @option arguments [String] :id The document ID - # @option arguments [String] :index The name of the index - # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the delete operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) - # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (options: true, false, wait_for) - # @option arguments [String] :routing Specific routing value - # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Number] :if_seq_no only perform the delete operation if the last operation that has changed the document has the specified sequence number - # @option arguments [Number] :if_primary_term only perform the delete operation if the last operation that has changed the document has the specified primary term - # @option arguments [Number] :version Explicit version number for concurrency control - # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte) + # @option arguments [String] :id A unique identifier for the document. (*Required*) + # @option arguments [String] :index The name of the target index. (*Required*) + # @option arguments [Integer] :if_primary_term Only perform the operation if the document has this primary term. + # @option arguments [Integer] :if_seq_no Only perform the operation if the document has this sequence number. + # @option arguments [String] :refresh If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search. + # If `wait_for`, it waits for a refresh to make this operation visible to search. + # If `false`, it does nothing with refreshes. Server default: false. + # @option arguments [String] :routing A custom value used to route operations to a specific shard. + # @option arguments [Time] :timeout The period to wait for active shards.This parameter is useful for situations where the primary shard assigned to perform the delete operation might not be available when the delete operation runs. + # Some reasons for this might be that the primary shard is currently recovering from a store or undergoing relocation. + # By default, the delete operation will wait on the primary shard to become available for up to 1 minute before failing and responding with an error. Server default: 1m. + # @option arguments [Integer] :version An explicit version number for concurrency control. + # It must match the current version of the document for the request to succeed. + # @option arguments [String] :version_type The version type. + # @option arguments [Integer, String] :wait_for_active_shards The minimum number of shard copies that must be active before proceeding with the operation. + # You can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + # The default value of `1` means it waits for each primary shard to be active. Server default: 1. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-delete # def delete(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'delete' } - defined_params = %i[index id].each_with_object({}) do |variable, set_variables| + defined_params = [:index, :id].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -58,11 +102,11 @@ def delete(arguments = {}) _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_DELETE - path = "#{Utils.__listify(_index)}/_doc/#{Utils.__listify(_id)}" + path = "#{Utils.listify(_index)}/_doc/#{Utils.listify(_id)}" params = Utils.process_params(arguments) if Array(arguments[:ignore]).include?(404) - Utils.__rescue_from_not_found do + Utils.rescue_from_not_found do Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query.rb index 395cd50618..334cf50b62 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query.rb @@ -15,48 +15,145 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Deletes documents matching the provided query. + # Delete documents. + # Deletes documents that match the specified query. + # If the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or alias: + # * `read` + # * `delete` or `write` + # You can specify the query criteria in the request URI or the request body using the same syntax as the search API. + # When you submit a delete by query request, Elasticsearch gets a snapshot of the data stream or index when it begins processing the request and deletes matching documents using internal versioning. + # If a document changes between the time that the snapshot is taken and the delete operation is processed, it results in a version conflict and the delete operation fails. + # NOTE: Documents with a version equal to 0 cannot be deleted using delete by query because internal versioning does not support 0 as a valid version number. + # While processing a delete by query request, Elasticsearch performs multiple search requests sequentially to find all of the matching documents to delete. + # A bulk delete request is performed for each batch of matching documents. + # If a search or bulk request is rejected, the requests are retried up to 10 times, with exponential back off. + # If the maximum retry limit is reached, processing halts and all failed requests are returned in the response. + # Any delete requests that completed successfully still stick, they are not rolled back. + # You can opt to count version conflicts instead of halting and returning by setting `conflicts` to `proceed`. + # Note that if you opt to count version conflicts the operation could attempt to delete more documents from the source than `max_docs` until it has successfully deleted `max_docs documents`, or it has gone through every document in the source query. + # **Throttling delete requests** + # To control the rate at which delete by query issues batches of delete operations, you can set `requests_per_second` to any positive decimal number. + # This pads each batch with a wait time to throttle the rate. + # Set `requests_per_second` to `-1` to disable throttling. + # Throttling uses a wait time between batches so that the internal scroll requests can be given a timeout that takes the request padding into account. + # The padding time is the difference between the batch size divided by the `requests_per_second` and the time spent writing. + # By default the batch size is `1000`, so if `requests_per_second` is set to `500`: + # + # ``` + # target_time = 1000 / 500 per second = 2 seconds + # wait_time = target_time - write_time = 2 seconds - .5 seconds = 1.5 seconds + # ``` + # + # Since the batch is issued as a single `_bulk` request, large batch sizes cause Elasticsearch to create many requests and wait before starting the next set. + # This is "bursty" instead of "smooth". + # **Slicing** + # Delete by query supports sliced scroll to parallelize the delete process. + # This can improve efficiency and provide a convenient way to break the request down into smaller parts. + # Setting `slices` to `auto` lets Elasticsearch choose the number of slices to use. + # This setting will use one slice per shard, up to a certain limit. + # If there are multiple source data streams or indices, it will choose the number of slices based on the index or backing index with the smallest number of shards. + # Adding slices to the delete by query operation creates sub-requests which means it has some quirks: + # * You can see these requests in the tasks APIs. These sub-requests are "child" tasks of the task for the request with slices. + # * Fetching the status of the task for the request with slices only contains the status of completed slices. + # * These sub-requests are individually addressable for things like cancellation and rethrottling. + # * Rethrottling the request with `slices` will rethrottle the unfinished sub-request proportionally. + # * Canceling the request with `slices` will cancel each sub-request. + # * Due to the nature of `slices` each sub-request won't get a perfectly even portion of the documents. All documents will be addressed, but some slices may be larger than others. Expect larger slices to have a more even distribution. + # * Parameters like `requests_per_second` and `max_docs` on a request with `slices` are distributed proportionally to each sub-request. Combine that with the earlier point about distribution being uneven and you should conclude that using `max_docs` with `slices` might not result in exactly `max_docs` documents being deleted. + # * Each sub-request gets a slightly different snapshot of the source data stream or index though these are all taken at approximately the same time. + # If you're slicing manually or otherwise tuning automatic slicing, keep in mind that: + # * Query performance is most efficient when the number of slices is equal to the number of shards in the index or backing index. If that number is large (for example, 500), choose a lower number as too many `slices` hurts performance. Setting `slices` higher than the number of shards generally does not improve efficiency and adds overhead. + # * Delete performance scales linearly across available resources with the number of slices. + # Whether query or delete performance dominates the runtime depends on the documents being reindexed and cluster resources. + # **Cancel a delete by query operation** + # Any delete by query can be canceled using the task cancel API. For example: + # + # ``` + # POST _tasks/r1A2WoRbTwKZ516z6NEs5A:36619/_cancel + # ``` + # + # The task ID can be found by using the get tasks API. + # Cancellation should happen quickly but might take a few seconds. + # The get task status API will continue to list the delete by query task until this task checks that it has been cancelled and terminates itself. # - # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices - # @option arguments [String] :analyzer The analyzer to use for the query string - # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false) - # @option arguments [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR) - # @option arguments [String] :df The field to use as default where no field prefix is given in the query string - # @option arguments [Number] :from Starting offset (default: 0) - # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) - # @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) - # @option arguments [String] :conflicts What to do when the delete by query hits version conflicts? (options: abort, proceed) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) - # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored - # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) - # @option arguments [String] :q Query in the Lucene query string syntax - # @option arguments [List] :routing A comma-separated list of specific routing values - # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search - # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch) - # @option arguments [Time] :search_timeout Explicit timeout for each search request. Defaults to no timeout. - # @option arguments [Number] :max_docs Maximum number of documents to process (default: all documents) - # @option arguments [List] :sort A comma-separated list of : pairs - # @option arguments [Number] :terminate_after The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early. - # @option arguments [List] :stats Specific 'tag' of the request for logging and statistical purposes - # @option arguments [Boolean] :version Specify whether to return document version as part of a hit - # @option arguments [Boolean] :request_cache Specify if request cache should be used for this request or not, defaults to index level setting - # @option arguments [Boolean] :refresh Should the affected indexes be refreshed? - # @option arguments [Time] :timeout Time each individual bulk request should wait for shards that are unavailable. - # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the delete by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) - # @option arguments [Number] :scroll_size Size on the scroll request powering the delete by query - # @option arguments [Boolean] :wait_for_completion Should the request should block until the delete by query is complete. - # @option arguments [Number] :requests_per_second The throttle for this request in sub-requests per second. -1 means no throttle. - # @option arguments [Number|string] :slices The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`. + # @option arguments [String, Array] :index A comma-separated list of data streams, indices, and aliases to search. + # It supports wildcards (`*`). + # To search all data streams or indices, omit this parameter or use `*` or `_all`. (*Required*) + # @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`. Server default: true. + # @option arguments [String] :analyzer Analyzer to use for the query string. + # This parameter can be used only when the `q` query string parameter is specified. + # @option arguments [Boolean] :analyze_wildcard If `true`, wildcard and prefix queries are analyzed. + # This parameter can be used only when the `q` query string parameter is specified. + # @option arguments [String] :conflicts What to do if delete by query hits version conflicts: `abort` or `proceed`. Server default: abort. + # @option arguments [String] :default_operator The default operator for query string query: `AND` or `OR`. + # This parameter can be used only when the `q` query string parameter is specified. Server default: OR. + # @option arguments [String] :df The field to use as default where no field prefix is given in the query string. + # This parameter can be used only when the `q` query string parameter is specified. + # @option arguments [String, Array] :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`. Server default: open. + # @option arguments [Integer] :from Skips the specified number of documents. Server default: 0. + # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. + # @option arguments [Boolean] :lenient If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + # This parameter can be used only when the `q` query string parameter is specified. + # @option arguments [Integer] :max_docs The maximum number of documents to process. + # Defaults to all documents. + # When set to a value less then or equal to `scroll_size`, a scroll will not be used to retrieve the results for the operation. + # @option arguments [String] :preference The node or shard the operation should be performed on. + # It is random by default. + # @option arguments [Boolean] :refresh If `true`, Elasticsearch refreshes all shards involved in the delete by query after the request completes. + # This is different than the delete API's `refresh` parameter, which causes just the shard that received the delete request to be refreshed. + # Unlike the delete API, it does not support `wait_for`. + # @option arguments [Boolean] :request_cache If `true`, the request cache is used for this request. + # Defaults to the index-level setting. + # @option arguments [Float] :requests_per_second The throttle for this request in sub-requests per second. Server default: -1. + # @option arguments [String] :routing A custom value used to route operations to a specific shard. + # @option arguments [String] :q A query in the Lucene query string syntax. + # @option arguments [Time] :scroll The period to retain the search context for scrolling. + # @option arguments [Integer] :scroll_size The size of the scroll request that powers the operation. Server default: 1000. + # @option arguments [Time] :search_timeout The explicit timeout for each search request. + # It defaults to no timeout. + # @option arguments [String] :search_type The type of the search operation. + # Available options include `query_then_fetch` and `dfs_query_then_fetch`. + # @option arguments [Integer, String] :slices The number of slices this task should be divided into. Server default: 1. + # @option arguments [Array] :sort A comma-separated list of `:` pairs. + # @option arguments [Array] :stats The specific `tag` of the request for logging and statistical purposes. + # @option arguments [Integer] :terminate_after The maximum number of documents to collect for each shard. + # If a query reaches this limit, Elasticsearch terminates the query early. + # Elasticsearch collects documents before sorting.Use with caution. + # Elasticsearch applies this parameter to each shard handling the request. + # When possible, let Elasticsearch perform early termination automatically. + # Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + # @option arguments [Time] :timeout The period each deletion request waits for active shards. Server default: 1m. + # @option arguments [Boolean] :version If `true`, returns the document version as part of a hit. + # @option arguments [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operation. + # Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + # The `timeout` value controls how long each write request waits for unavailable shards to become available. Server default: 1. + # @option arguments [Boolean] :wait_for_completion If `true`, the request blocks until the operation is complete. + # If `false`, Elasticsearch performs some preflight checks, launches the request, and returns a task you can use to cancel or get the status of the task. Elasticsearch creates a record of this task as a document at `.tasks/task/${taskId}`. When you are done with a task, you should delete the task document so Elasticsearch can reclaim the space. Server default: true. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The search definition using the Query DSL (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-delete-by-query # def delete_by_query(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'delete_by_query' } @@ -72,12 +169,12 @@ def delete_by_query(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_POST - path = "#{Utils.__listify(_index)}/_delete_by_query" + path = "#{Utils.listify(_index)}/_delete_by_query" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb index 081b6efc86..701cd43976 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb @@ -15,19 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Changes the number of requests per second for a particular Delete By Query operation. + # Throttle a delete by query operation. + # Change the number of requests per second for a particular delete by query operation. + # Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. # - # @option arguments [String] :task_id The task id to rethrottle - # @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. (*Required*) + # @option arguments [String, Integer] :task_id The ID for the task. (*Required*) + # @option arguments [Float] :requests_per_second The throttle for this request in sub-requests per second. + # To disable throttling, set it to `-1`. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-delete-by-query.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-delete-by-query-rethrottle # def delete_by_query_rethrottle(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'delete_by_query_rethrottle' } @@ -47,7 +61,7 @@ def delete_by_query_rethrottle(arguments = {}) _task_id = arguments.delete(:task_id) method = Elasticsearch::API::HTTP_POST - path = "_delete_by_query/#{Utils.__listify(_task_id)}/_rethrottle" + path = "_delete_by_query/#{Utils.listify(_task_id)}/_rethrottle" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/delete_script.rb b/elasticsearch-api/lib/elasticsearch/api/actions/delete_script.rb index 9f1d8be915..f30038e347 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/delete_script.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/delete_script.rb @@ -15,20 +15,36 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Deletes a script. + # Delete a script or search template. + # Deletes a stored script or search template. # - # @option arguments [String] :id Script ID - # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [String] :id The identifier for the stored script or search template. (*Required*) + # @option arguments [Time] :master_timeout The 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. + # It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s. + # @option arguments [Time] :timeout The period to wait for a response. + # If no response is received before the timeout expires, the request fails and returns an error. + # It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-delete-script # def delete_script(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'delete_script' } @@ -48,7 +64,7 @@ def delete_script(arguments = {}) _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_DELETE - path = "_scripts/#{Utils.__listify(_id)}" + path = "_scripts/#{Utils.listify(_id)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/delete_policy.rb b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/delete_policy.rb index de116ae993..fbb7d0d97c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/delete_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/delete_policy.rb @@ -15,20 +15,32 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Enrich module Actions + # Delete an enrich policy. # Deletes an existing enrich policy and its enrich index. # - # @option arguments [String] :name The name of the enrich policy - # @option arguments [Time] :master_timeout Timeout for processing on master node + # @option arguments [String] :name Enrich policy to delete. (*Required*) + # @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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-enrich-policy-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-enrich-delete-policy # def delete_policy(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'enrich.delete_policy' } @@ -48,7 +60,7 @@ def delete_policy(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_DELETE - path = "_enrich/policy/#{Utils.__listify(_name)}" + path = "_enrich/policy/#{Utils.listify(_name)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/execute_policy.rb b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/execute_policy.rb index f30444fefe..f3603b666b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/execute_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/execute_policy.rb @@ -15,21 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Enrich module Actions - # Creates the enrich index for an existing enrich policy. + # Run an enrich policy. + # Create the enrich index for an existing enrich policy. # - # @option arguments [String] :name The name of the enrich policy - # @option arguments [Boolean] :wait_for_completion Should the request should block until the execution is complete. - # @option arguments [Time] :master_timeout Timeout for processing on master node + # @option arguments [String] :name Enrich policy to execute. (*Required*) + # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. + # @option arguments [Boolean] :wait_for_completion If `true`, the request blocks other enrich policy execution requests until complete. Server default: true. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/execute-enrich-policy-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-enrich-execute-policy # def execute_policy(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'enrich.execute_policy' } @@ -49,7 +61,7 @@ def execute_policy(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_PUT - path = "_enrich/policy/#{Utils.__listify(_name)}/_execute" + path = "_enrich/policy/#{Utils.listify(_name)}/_execute" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/get_policy.rb b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/get_policy.rb index 76ef6e7367..ef40296739 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/get_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/get_policy.rb @@ -15,20 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Enrich module Actions - # Gets information about an enrich policy. + # Get an enrich policy. + # Returns information about an enrich policy. # - # @option arguments [List] :name A comma-separated list of enrich policy names - # @option arguments [Time] :master_timeout Timeout for waiting for new cluster state in case it is blocked + # @option arguments [String, Array] :name Comma-separated list of enrich policy names used to limit the request. + # To return information for all enrich policies, omit this parameter. + # @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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-enrich-policy-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-enrich-get-policy # def get_policy(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'enrich.get_policy' } @@ -47,7 +60,7 @@ def get_policy(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _name - "_enrich/policy/#{Utils.__listify(_name)}" + "_enrich/policy/#{Utils.listify(_name)}" else '_enrich/policy' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/put_policy.rb b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/put_policy.rb index b93de33b2c..4e159cbba5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/put_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/put_policy.rb @@ -15,21 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Enrich module Actions - # Creates a new enrich policy. + # Create an enrich policy. + # Creates an enrich policy. # - # @option arguments [String] :name The name of the enrich policy - # @option arguments [Time] :master_timeout Timeout for processing on master node + # @option arguments [String] :name Name of the enrich policy to create or update. (*Required*) + # @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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The enrich policy to register (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-enrich-policy-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-enrich-put-policy # def put_policy(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'enrich.put_policy' } @@ -50,7 +62,7 @@ def put_policy(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_PUT - path = "_enrich/policy/#{Utils.__listify(_name)}" + path = "_enrich/policy/#{Utils.listify(_name)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/stats.rb index 8a71c336d4..2dcb395969 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/enrich/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/enrich/stats.rb @@ -15,19 +15,31 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Enrich module Actions - # Gets enrich coordinator statistics and information about enrich policies that are currently executing. + # Get enrich stats. + # Returns enrich coordinator statistics and information about enrich policies that are currently executing. # - # @option arguments [Time] :master_timeout Timeout for processing on master node + # @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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/enrich-stats-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-enrich-stats # def stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'enrich.stats' } @@ -35,7 +47,7 @@ def stats(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_enrich/_stats' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/eql/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/eql/delete.rb index d0a794a594..6e62454139 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/eql/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/eql/delete.rb @@ -15,19 +15,34 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Eql module Actions - # Deletes an async EQL search by ID. If the search is still running, the search request will be cancelled. Otherwise, the saved search results are deleted. + # Delete an async EQL search. + # Delete an async EQL search or a stored synchronous EQL search. + # The API also deletes results for the search. # - # @option arguments [String] :id The async search ID + # @option arguments [String] :id Identifier for the search to delete. + # A search ID is provided in the EQL search API's response for an async search. + # A search ID is also provided if the request’s `keep_on_completion` parameter is `true`. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-eql-delete # def delete(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'eql.delete' } @@ -47,8 +62,8 @@ def delete(arguments = {}) _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_DELETE - path = "_eql/search/#{Utils.__listify(_id)}" - params = {} + path = "_eql/search/#{Utils.listify(_id)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/eql/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/eql/get.rb index 87341090a1..4ff635f0cd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/eql/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/eql/get.rb @@ -15,21 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Eql module Actions - # Returns async results from previously executed Event Query Language (EQL) search + # Get async EQL search results. + # Get the current status and available results for an async EQL search or a stored synchronous EQL search. # - # @option arguments [String] :id The async search ID - # @option arguments [Time] :wait_for_completion_timeout Specify the time that the request should block waiting for the final response - # @option arguments [Time] :keep_alive Update the time interval in which the results (partial or final) for this search will be available + # @option arguments [String] :id Identifier for the search. (*Required*) + # @option arguments [Time] :keep_alive Period for which the search and its results are stored on the cluster. + # Defaults to the keep_alive value set by the search’s EQL search API request. + # @option arguments [Time] :wait_for_completion_timeout Timeout duration to wait for the request to finish. + # Defaults to no timeout, meaning the request waits for complete search results. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-eql-get # def get(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'eql.get' } @@ -49,7 +63,7 @@ def get(arguments = {}) _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_GET - path = "_eql/search/#{Utils.__listify(_id)}" + path = "_eql/search/#{Utils.listify(_id)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/eql/get_status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/eql/get_status.rb index 06e4d98460..d4023fd242 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/eql/get_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/eql/get_status.rb @@ -15,19 +15,31 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Eql module Actions - # Returns the status of a previously submitted async or stored Event Query Language (EQL) search + # Get the async EQL status. + # Get the current status for an async EQL search or a stored synchronous EQL search without returning results. # - # @option arguments [String] :id The async search ID + # @option arguments [String] :id Identifier for the search. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-eql-get-status # def get_status(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'eql.get_status' } @@ -47,8 +59,8 @@ def get_status(arguments = {}) _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_GET - path = "_eql/search/status/#{Utils.__listify(_id)}" - params = {} + path = "_eql/search/status/#{Utils.listify(_id)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/eql/search.rb b/elasticsearch-api/lib/elasticsearch/api/actions/eql/search.rb index 870291cd16..9307680c64 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/eql/search.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/eql/search.rb @@ -15,25 +15,43 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Eql module Actions - # Returns results matching a query expressed in Event Query Language (EQL) + # Get EQL search results. + # Returns search results for an Event Query Language (EQL) query. + # EQL assumes each document in a data stream or index corresponds to an event. # - # @option arguments [String] :index The name of the index to scope the operation - # @option arguments [Time] :wait_for_completion_timeout Specify the time that the request should block waiting for the final response - # @option arguments [Boolean] :keep_on_completion Control whether the response should be stored in the cluster if it completed within the provided [wait_for_completion] time (default: false) - # @option arguments [Time] :keep_alive Update the time interval in which the results (partial or final) for this search will be available - # @option arguments [Boolean] :allow_partial_search_results Control whether the query should keep running in case of shard failures, and return partial results - # @option arguments [Boolean] :allow_partial_sequence_results Control whether a sequence query should return partial results or no results at all in case of shard failures. This option has effect only if [allow_partial_search_results] is true. + # @option arguments [String, Array] :index The name of the index to scope the operation (*Required*) + # @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 [Boolean] :allow_partial_search_results If true, returns partial results if there are shard failures. If false, returns an error with no partial results. Server default: true. + # @option arguments [Boolean] :allow_partial_sequence_results If true, sequence queries will return partial results in case of shard failures. If false, they will return no results at all. + # This flag has effect only if allow_partial_search_results is true. + # @option arguments [String, Array] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. Server default: open. + # @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution Server default: true. + # @option arguments [Boolean] :ignore_unavailable If true, missing or closed indices are not included in the response. Server default: true. + # @option arguments [Time] :keep_alive Period for which the search and its results are stored on the cluster. Server default: 5d. + # @option arguments [Boolean] :keep_on_completion If true, the search and its results are stored on the cluster. + # @option arguments [Time] :wait_for_completion_timeout Timeout duration to wait for the request to finish. Defaults to no timeout, meaning the request waits for complete search results. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body Eql request body. Use the `query` to limit the query scope. (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/eql-search-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-eql-search # def search(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'eql.search' } @@ -49,12 +67,12 @@ def search(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_POST - path = "#{Utils.__listify(_index)}/_eql/search" + path = "#{Utils.listify(_index)}/_eql/search" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query.rb index fadffc40ef..63b08f7769 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query.rb @@ -15,22 +15,38 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Esql module Actions - # Executes an ESQL request asynchronously + # Run an async ES|QL query. + # Asynchronously run an ES|QL (Elasticsearch query language) query, monitor its progress, and retrieve results when they become available. + # The API accepts the same parameters and request body as the synchronous query API, along with additional async related properties. # - # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [String] :delimiter The character to use between values within a CSV row. Only valid for the csv format. - # @option arguments [Boolean] :drop_null_columns Should entirely null columns be removed from the results? Their name and type will be returning in a new `all_columns` section. + # @option arguments [String] :delimiter The character to use between values within a CSV row. + # It is valid only for the CSV format. + # @option arguments [Boolean] :drop_null_columns Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results. + # If `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns. + # @option arguments [String] :format A short version of the Accept header, e.g. json, yaml.`csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response.For async requests, nothing will be returned if the async query doesn't finish within the timeout. + # The query ID and running status are available in the `X-Elasticsearch-Async-Id` and `X-Elasticsearch-Async-Is-Running` HTTP headers of the response, respectively. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body Use the `query` element to start a query. Use `columnar` to format the answer. (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-async-query-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-esql-async-query # def async_query(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'esql.async_query' } @@ -40,7 +56,7 @@ def async_query(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_query/async' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_delete.rb index 647470b44a..67806a5d97 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_delete.rb @@ -15,19 +15,37 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Esql module Actions - # Delete an async query request given its ID. + # Delete an async ES|QL query. + # If the query is still running, it is cancelled. + # Otherwise, the stored results are deleted. + # If the Elasticsearch security features are enabled, only the following users can use this API to delete a query: + # * The authenticated user that submitted the original query request + # * Users with the `cancel_task` cluster privilege # - # @option arguments [String] :id The async query ID + # @option arguments [String] :id The unique identifier of the query. + # A query ID is provided in the ES|QL async query API response for a query that does not complete in the designated time. + # A query ID is also provided when the request was submitted with the `keep_on_completion` parameter set to `true`. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-async-query-delete-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-esql-async-query-delete # def async_query_delete(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'esql.async_query_delete' } @@ -47,8 +65,8 @@ def async_query_delete(arguments = {}) _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_DELETE - path = "_query/async/#{Utils.__listify(_id)}" - params = {} + path = "_query/async/#{Utils.listify(_id)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_get.rb index 4d59504018..c710573bb2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_get.rb @@ -15,22 +15,43 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Esql module Actions - # Retrieves the results of a previously submitted async query request given its ID. + # Get async ES|QL query results. + # Get the current status and available results or stored results for an ES|QL asynchronous query. + # If the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can retrieve the results using this API. # - # @option arguments [String] :id The async query ID - # @option arguments [Time] :wait_for_completion_timeout Specify the time that the request should block waiting for the final response - # @option arguments [Time] :keep_alive Specify the time interval in which the results (partial or final) for this search will be available - # @option arguments [Boolean] :drop_null_columns Should entirely null columns be removed from the results? Their name and type will be returning in a new `all_columns` section. + # @option arguments [String] :id The unique identifier of the query. + # A query ID is provided in the ES|QL async query API response for a query that does not complete in the designated time. + # A query ID is also provided when the request was submitted with the `keep_on_completion` parameter set to `true`. (*Required*) + # @option arguments [Boolean] :drop_null_columns Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results. + # If `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns. + # @option arguments [String] :format A short version of the Accept header, for example `json` or `yaml`. + # @option arguments [Time] :keep_alive The period for which the query and its results are stored in the cluster. + # When this period expires, the query and its results are deleted, even if the query is still ongoing. + # @option arguments [Time] :wait_for_completion_timeout The period to wait for the request to finish. + # By default, the request waits for complete query results. + # If the request completes during the period specified in this parameter, complete query results are returned. + # Otherwise, the response returns an `is_running` value of `true` and no results. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-async-query-get-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-esql-async-query-get # def async_query_get(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'esql.async_query_get' } @@ -50,7 +71,7 @@ def async_query_get(arguments = {}) _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_GET - path = "_query/async/#{Utils.__listify(_id)}" + path = "_query/async/#{Utils.listify(_id)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_stop.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_stop.rb index 0897edd15a..d26bc64890 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_stop.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/esql/async_query_stop.rb @@ -15,19 +15,36 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Esql module Actions - # Stops a previously submitted async query request given its ID and collects the results. + # Stop async ES|QL query. + # This API interrupts the query execution and returns the results so far. + # If the Elasticsearch security features are enabled, only the user who first submitted the ES|QL query can stop it. # - # @option arguments [String] :id The async query ID + # @option arguments [String] :id The unique identifier of the query. + # A query ID is provided in the ES|QL async query API response for a query that does not complete in the designated time. + # A query ID is also provided when the request was submitted with the `keep_on_completion` parameter set to `true`. (*Required*) + # @option arguments [Boolean] :drop_null_columns Indicates whether columns that are entirely `null` will be removed from the `columns` and `values` portion of the results. + # If `true`, the response will include an extra section under the name `all_columns` which has the name of all the columns. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-async-query-stop-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-esql-async-query-stop # def async_query_stop(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'esql.async_query_stop' } @@ -47,8 +64,8 @@ def async_query_stop(arguments = {}) _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_POST - path = "_query/async/#{Utils.__listify(_id)}/stop" - params = {} + path = "_query/async/#{Utils.listify(_id)}/stop" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/esql/query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/esql/query.rb index 0d722a7f72..ebf3c17537 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/esql/query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/esql/query.rb @@ -15,22 +15,38 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Esql module Actions - # Executes an ESQL request + # Run an ES|QL query. + # Get search results for an ES|QL (Elasticsearch query language) query. + # This functionality is subject to potential breaking changes within a + # minor version, meaning that your referencing code may break when this + # library is upgraded. # - # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml - # @option arguments [String] :delimiter The character to use between values within a CSV row. Only valid for the csv format. - # @option arguments [Boolean] :drop_null_columns Should entirely null columns be removed from the results? Their name and type will be returning in a new `all_columns` section. + # @option arguments [String] :format A short version of the Accept header, e.g. json, yaml.`csv`, `tsv`, and `txt` formats will return results in a tabular format, excluding other metadata fields from the response. + # @option arguments [String] :delimiter The character to use between values within a CSV row. Only valid for the CSV format. + # @option arguments [Boolean] :drop_null_columns Should columns that are entirely `null` be removed from the `columns` and `values` portion of the results? + # Defaults to `false`. If `true` then the response will include an extra section under the name `all_columns` which has the name of all columns. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body Use the `query` element to start a query. Use `columnar` to format the answer. (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-query-api.html + # @see https://www.elastic.co/docs/explore-analyze/query-filter/languages/esql-rest # def query(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'esql.query' } @@ -40,7 +56,7 @@ def query(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_query' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/exists.rb b/elasticsearch-api/lib/elasticsearch/api/actions/exists.rb index aaf756abe1..2a22611e49 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/exists.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/exists.rb @@ -15,34 +15,73 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Returns information about whether a document exists in an index. + # Check a document. + # Verify that a document exists. + # For example, check to see if a document with the `_id` 0 exists: + # + # ``` + # HEAD my-index-000001/_doc/0 + # ``` + # + # If the document exists, the API returns a status code of `200 - OK`. + # If the document doesn’t exist, the API returns `404 - Not Found`. + # **Versioning support** + # You can use the `version` parameter to check the document only if its current version is equal to the specified one. + # Internally, Elasticsearch has marked the old document as deleted and added an entirely new document. + # The old version of the document doesn't disappear immediately, although you won't be able to access it. + # Elasticsearch cleans up deleted documents in the background as you continue to index more data. # - # @option arguments [String] :id The document ID - # @option arguments [String] :index The name of the index - # @option arguments [List] :stored_fields A comma-separated list of stored fields to return in the response - # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) - # @option arguments [Boolean] :realtime Specify whether to perform the operation in realtime or search mode - # @option arguments [Boolean] :refresh Refresh the shard containing the document before performing the operation - # @option arguments [String] :routing Specific routing value - # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return - # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field - # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field - # @option arguments [Number] :version Explicit version number for concurrency control - # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte) + # @option arguments [String] :id A unique document identifier. (*Required*) + # @option arguments [String] :index A comma-separated list of data streams, indices, and aliases. + # It supports wildcards (`*`). (*Required*) + # @option arguments [String] :preference The node or shard the operation should be performed on. + # By default, the operation is randomized between the shard replicas.If it is set to `_local`, the operation will prefer to be run on a local allocated shard when possible. + # If it is set to a custom value, the value is used to guarantee that the same shards will be used for the same custom value. + # This can help with "jumping values" when hitting different shards in different refresh states. + # A sample value can be something like the web session ID or the user name. + # @option arguments [Boolean] :realtime If `true`, the request is real-time as opposed to near-real-time. Server default: true. + # @option arguments [Boolean] :refresh If `true`, the request refreshes the relevant shards before retrieving the document. + # Setting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing). + # @option arguments [String] :routing A custom value used to route operations to a specific shard. + # @option arguments [Boolean, String, Array] :_source Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return. + # @option arguments [String, Array] :_source_excludes A comma-separated list of source fields to exclude from the response. + # You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. + # If the `_source` parameter is `false`, this parameter is ignored. + # @option arguments [String, Array] :_source_includes A comma-separated list of source fields to include in the response. + # If this parameter is specified, only these source fields are returned. + # You can exclude fields from this subset using the `_source_excludes` query parameter. + # If the `_source` parameter is `false`, this parameter is ignored. + # @option arguments [String, Array] :stored_fields A comma-separated list of stored fields to return as part of a hit. + # If no fields are specified, no stored fields are included in the response. + # If this field is specified, the `_source` parameter defaults to `false`. + # @option arguments [Integer] :version Explicit version number for concurrency control. + # The specified version must match the current version of the document for the request to succeed. + # @option arguments [String] :version_type The version type. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-get # def exists(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'exists' } - defined_params = %i[index id].each_with_object({}) do |variable, set_variables| + defined_params = [:index, :id].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -60,10 +99,10 @@ def exists(arguments = {}) _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_HEAD - path = "#{Utils.__listify(_index)}/_doc/#{Utils.__listify(_id)}" + path = "#{Utils.listify(_index)}/_doc/#{Utils.listify(_id)}" params = Utils.process_params(arguments) - Utils.__rescue_from_not_found do + Utils.rescue_from_not_found do perform_request(method, path, params, body, headers, request_opts).status == 200 end end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/exists_source.rb b/elasticsearch-api/lib/elasticsearch/api/actions/exists_source.rb index ce01cb5e22..cf7909553c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/exists_source.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/exists_source.rb @@ -15,33 +15,56 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Returns information about whether a document source exists in an index. + # Check for a document source. + # Check whether a document source exists in an index. + # For example: + # + # ``` + # HEAD my-index-000001/_source/1 + # ``` + # + # A document's source is not available if it is disabled in the mapping. # - # @option arguments [String] :id The document ID - # @option arguments [String] :index The name of the index - # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) - # @option arguments [Boolean] :realtime Specify whether to perform the operation in realtime or search mode - # @option arguments [Boolean] :refresh Refresh the shard containing the document before performing the operation - # @option arguments [String] :routing Specific routing value - # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return - # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field - # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field - # @option arguments [Number] :version Explicit version number for concurrency control - # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte) + # @option arguments [String] :id A unique identifier for the document. (*Required*) + # @option arguments [String] :index A comma-separated list of data streams, indices, and aliases. + # It supports wildcards (`*`). (*Required*) + # @option arguments [String] :preference The node or shard the operation should be performed on. + # By default, the operation is randomized between the shard replicas. + # @option arguments [Boolean] :realtime If `true`, the request is real-time as opposed to near-real-time. Server default: true. + # @option arguments [Boolean] :refresh If `true`, the request refreshes the relevant shards before retrieving the document. + # Setting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing). + # @option arguments [String] :routing A custom value used to route operations to a specific shard. + # @option arguments [Boolean, String, Array] :_source Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return. + # @option arguments [String, Array] :_source_excludes A comma-separated list of source fields to exclude in the response. + # @option arguments [String, Array] :_source_includes A comma-separated list of source fields to include in the response. + # @option arguments [Integer] :version The version number for concurrency control. + # It must match the current version of the document for the request to succeed. + # @option arguments [String] :version_type The version type. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-get # def exists_source(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'exists_source' } - defined_params = %i[index id].each_with_object({}) do |variable, set_variables| + defined_params = [:index, :id].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -59,7 +82,7 @@ def exists_source(arguments = {}) _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_HEAD - path = "#{Utils.__listify(_index)}/_source/#{Utils.__listify(_id)}" + path = "#{Utils.listify(_index)}/_source/#{Utils.listify(_id)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/explain.rb b/elasticsearch-api/lib/elasticsearch/api/actions/explain.rb index b78f9160a5..e11ca4a8af 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/explain.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/explain.rb @@ -15,37 +15,62 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Returns information about why a specific matches (or doesn't match) a query. + # Explain a document match result. + # Get information about why a specific document matches, or doesn't match, a query. + # It computes a score explanation for a query and a specific document. # - # @option arguments [String] :id The document ID - # @option arguments [String] :index The name of the index - # @option arguments [Boolean] :analyze_wildcard Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false) - # @option arguments [String] :analyzer The analyzer for the query string query - # @option arguments [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR) - # @option arguments [String] :df The default field for query string query (default: _all) - # @option arguments [List] :stored_fields A comma-separated list of stored fields to return in the response - # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored - # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) - # @option arguments [String] :q Query in the Lucene query string syntax - # @option arguments [String] :routing Specific routing value - # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return - # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field - # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field + # @option arguments [String] :id The document identifier. (*Required*) + # @option arguments [String] :index Index names that are used to limit the request. + # Only a single index name can be provided to this parameter. (*Required*) + # @option arguments [String] :analyzer The analyzer to use for the query string. + # This parameter can be used only when the `q` query string parameter is specified. + # @option arguments [Boolean] :analyze_wildcard If `true`, wildcard and prefix queries are analyzed. + # This parameter can be used only when the `q` query string parameter is specified. + # @option arguments [String] :default_operator The default operator for query string query: `AND` or `OR`. + # This parameter can be used only when the `q` query string parameter is specified. Server default: OR. + # @option arguments [String] :df The field to use as default where no field prefix is given in the query string. + # This parameter can be used only when the `q` query string parameter is specified. + # @option arguments [Boolean] :lenient If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + # This parameter can be used only when the `q` query string parameter is specified. + # @option arguments [String] :preference The node or shard the operation should be performed on. + # It is random by default. + # @option arguments [String] :routing A custom value used to route operations to a specific shard. + # @option arguments [Boolean, String, Array] :_source `True` or `false` to return the `_source` field or not or a list of fields to return. + # @option arguments [String, Array] :_source_excludes A comma-separated list of source fields to exclude from the response. + # You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. + # If the `_source` parameter is `false`, this parameter is ignored. + # @option arguments [String, Array] :_source_includes A comma-separated list of source fields to include in the response. + # If this parameter is specified, only these source fields are returned. + # You can exclude fields from this subset using the `_source_excludes` query parameter. + # If the `_source` parameter is `false`, this parameter is ignored. + # @option arguments [String, Array] :stored_fields A comma-separated list of stored fields to return in the response. + # @option arguments [String] :q The query in the Lucene query string syntax. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The query definition using the Query DSL + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-explain.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-explain # def explain(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'explain' } - defined_params = %i[index id].each_with_object({}) do |variable, set_variables| + defined_params = [:index, :id].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -68,7 +93,7 @@ def explain(arguments = {}) Elasticsearch::API::HTTP_GET end - path = "#{Utils.__listify(_index)}/_explain/#{Utils.__listify(_id)}" + path = "#{Utils.listify(_index)}/_explain/#{Utils.listify(_id)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/features/get_features.rb b/elasticsearch-api/lib/elasticsearch/api/actions/features/get_features.rb index 65c71bc792..0c0a41f502 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/features/get_features.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/features/get_features.rb @@ -15,19 +15,37 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Features module Actions - # Gets a list of features which can be included in snapshots using the feature_states field when creating a snapshot + # Get the features. + # Get a list of features that can be included in snapshots using the `feature_states` field when creating a snapshot. + # You can use this API to determine which feature states to include when taking a snapshot. + # By default, all feature states are included in a snapshot if that snapshot includes the global state, or none if it does not. + # A feature state includes one or more system indices necessary for a given feature to function. + # In order to ensure data integrity, all system indices that comprise a feature state are snapshotted and restored together. + # The features listed by this API are a combination of built-in features and features defined by plugins. + # In order for a feature state to be listed in this API and recognized as a valid feature state by the create snapshot API, the plugin that defines that feature must be installed on the master node. # - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-features-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-features-get-features # def get_features(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'features.get_features' } @@ -35,7 +53,7 @@ def get_features(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_features' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/features/reset_features.rb b/elasticsearch-api/lib/elasticsearch/api/actions/features/reset_features.rb index 63ea0c5e85..9b0637634a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/features/reset_features.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/features/reset_features.rb @@ -15,23 +15,44 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Features module Actions - # Resets the internal state of features, usually by deleting system indices + # Reset the features. + # Clear all of the state information stored in system indices by Elasticsearch features, including the security and machine learning indices. + # WARNING: Intended for development and testing use only. Do not reset features on a production cluster. + # Return a cluster to the same state as a new installation by resetting the feature state for all Elasticsearch features. + # This deletes all state information stored in system indices. + # The response code is HTTP 200 if the state is successfully reset for all features. + # It is HTTP 500 if the reset operation failed for any feature. + # Note that select features might provide a way to reset particular system indices. + # 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. # - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-features-reset-features # def reset_features(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'features.reset_features' } @@ -39,7 +60,7 @@ def reset_features(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_POST path = '_features/_reset' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/field_caps.rb b/elasticsearch-api/lib/elasticsearch/api/actions/field_caps.rb index 0ad6237bb3..debb179af3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/field_caps.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/field_caps.rb @@ -15,27 +15,46 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Returns the information about the capabilities of fields among multiple indices. + # Get the field capabilities. + # Get information about the capabilities of fields among multiple indices. + # For data streams, the API returns field capabilities among the stream’s backing indices. + # It returns runtime fields like any other field. + # For example, a runtime field with a type of keyword is returned the same as any other field that belongs to the `keyword` family. # - # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices - # @option arguments [List] :fields A comma-separated list of field names - # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) - # @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) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) - # @option arguments [Boolean] :include_unmapped Indicates whether unmapped fields should be included in the response. - # @option arguments [List] :filters An optional set of filters: can include +metadata,-metadata,-nested,-multifield,-parent - # @option arguments [List] :types Only return results for fields that have one of the types in the list - # @option arguments [Boolean] :include_empty_fields Include empty fields in result + # @option arguments [String, Array] :index A 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 [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. Server default: true. + # @option arguments [String, Array] :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. Supports comma-separated values, such as `open,hidden`. Server default: open. + # @option arguments [String, Array] :fields A comma-separated list of fields to retrieve capabilities for. Wildcard (`*`) expressions are supported. + # @option arguments [Boolean] :ignore_unavailable If `true`, missing or closed indices are not included in the response. + # @option arguments [Boolean] :include_unmapped If true, unmapped fields are included in the response. + # @option arguments [String] :filters A comma-separated list of filters to apply to the response. + # @option arguments [Array] :types A comma-separated list of field types to include. + # Any fields that do not match one of these types will be excluded from the results. + # It defaults to empty, meaning that all field types are returned. + # @option arguments [Boolean] :include_empty_fields If false, empty fields are not included in the response. Server default: true. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body An index filter specified with the Query DSL + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-field-caps.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-field-caps # def field_caps(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'field_caps' } @@ -58,11 +77,11 @@ def field_caps(arguments = {}) Elasticsearch::API::HTTP_GET end - path = if _index - "#{Utils.__listify(_index)}/_field_caps" - else - '_field_caps' - end + path = if _index + "#{Utils.listify(_index)}/_field_caps" + else + '_field_caps' + end params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/global_checkpoints.rb b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/global_checkpoints.rb index 7768f2c53d..c72aa9edc2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/global_checkpoints.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/global_checkpoints.rb @@ -15,23 +15,40 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Fleet module Actions - # Returns the current global checkpoints for an index. This API is design for internal use by the fleet server project. + # Get global checkpoints. + # Get the current global checkpoints for an index. + # This API is designed for internal use by the Fleet server project. # - # @option arguments [String] :index The name of the index. - # @option arguments [Boolean] :wait_for_advance Whether to wait for the global checkpoint to advance past the specified current checkpoints - # @option arguments [Boolean] :wait_for_index Whether to wait for the target index to exist and all primary shards be active - # @option arguments [List] :checkpoints Comma separated list of checkpoints - # @option arguments [Time] :timeout Timeout to wait for global checkpoint to advance + # @option arguments [String] :index A single index or index alias that resolves to a single index. (*Required*) + # @option arguments [Boolean] :wait_for_advance A boolean value which controls whether to wait (until the timeout) for the global checkpoints + # to advance past the provided `checkpoints`. + # @option arguments [Boolean] :wait_for_index A boolean value which controls whether to wait (until the timeout) for the target index to exist + # and all primary shards be active. Can only be true when `wait_for_advance` is true. + # @option arguments [Array] :checkpoints A comma separated list of previous global checkpoints. When used in combination with `wait_for_advance`, + # the API will only return once the global checkpoints advances past the checkpoints. Providing an empty list + # will cause Elasticsearch to immediately return the current global checkpoints. Server default: []. + # @option arguments [Time] :timeout Period to wait for a global checkpoints to advance past `checkpoints`. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-global-checkpoints.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-fleet # def global_checkpoints(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'fleet.global_checkpoints' } @@ -46,12 +63,12 @@ def global_checkpoints(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_GET - path = "#{Utils.__listify(_index)}/_fleet/global_checkpoints" + path = "#{Utils.listify(_index)}/_fleet/global_checkpoints" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/msearch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/msearch.rb index d80bbed755..cad1b972fc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/msearch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/msearch.rb @@ -15,24 +15,55 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Fleet module Actions - # Multi Search API where the search will only be executed after specified checkpoints are available due to a refresh. This API is designed for internal use by the fleet server project. + # Run multiple Fleet searches. + # 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. # - # @option arguments [String] :index The index name to use as the default + # @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. + # @option arguments [Boolean] :ccs_minimize_roundtrips If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests. Server default: true. + # @option arguments [String, Array] :expand_wildcards Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + # @option arguments [Boolean] :ignore_throttled If true, concrete, expanded or aliased indices are ignored when frozen. + # @option arguments [Boolean] :ignore_unavailable If true, missing or closed indices are not included in the response. + # @option arguments [Integer] :max_concurrent_searches Maximum number of concurrent searches the multi search API can execute. + # @option arguments [Integer] :max_concurrent_shard_requests Maximum number of concurrent shard requests that each sub-search request executes per node. Server default: 5. + # @option arguments [Integer] :pre_filter_shard_size Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint. + # @option arguments [String] :search_type Indicates whether global term and document frequencies should be used when scoring returned documents. + # @option arguments [Boolean] :rest_total_hits_as_int If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object. + # @option arguments [Boolean] :typed_keys Specifies whether aggregation and suggester names should be prefixed by their respective types in the response. + # @option arguments [Array] :wait_for_checkpoints A comma separated list of checkpoints. When configured, the search API will only be executed on a shard + # after the relevant checkpoint has become visible for search. Defaults to an empty list which will cause + # Elasticsearch to immediately execute the search. Server default: []. + # @option arguments [Boolean] :allow_partial_search_results If true, returns partial results if there are shard request timeouts or shard failures. + # If false, returns an error with no partial results. + # Defaults to the configured cluster setting `search.default_allow_partial_results`, which is true by default. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The request definitions (metadata-fleet search request definition pairs), separated by newlines (*Required*) + # @option arguments [Hash] :body searches # - # @see [TODO] + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-fleet-msearch # def msearch(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'fleet.msearch' } @@ -47,19 +78,19 @@ def msearch(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_POST path = if _index - "#{Utils.__listify(_index)}/_fleet/_fleet_msearch" + "#{Utils.listify(_index)}/_fleet/_fleet_msearch" else '_fleet/_fleet_msearch' end - params = {} + params = Utils.process_params(arguments) - if body.is_a?(Array) && body.any? { |d| d.has_key? :search } + if body.is_a?(Array) && body.any? { |d| d.key? :search } payload = body.each_with_object([]) do |item, sum| meta = item data = meta.delete(:search) @@ -77,7 +108,7 @@ def msearch(arguments = {}) payload = body end - headers.merge!('Content-Type' => 'application/x-ndjson') + Utils.update_ndjson_headers!(headers, client.transport.options.dig(:transport_options, :headers)) Elasticsearch::API::Response.new( perform_request(method, path, params, payload, headers, request_opts) ) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/search.rb b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/search.rb index d3f67b21dc..b772d54bb4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/fleet/search.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/fleet/search.rb @@ -15,27 +15,84 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Fleet module Actions - # Search API where the search will only be executed after specified checkpoints are available due to a refresh. This API is designed for internal use by the fleet server project. + # 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. # - # @option arguments [String] :index The index name to search. - # @option arguments [List] :wait_for_checkpoints Comma separated list of checkpoints, one per shard - # @option arguments [Time] :wait_for_checkpoints_timeout Explicit wait_for_checkpoints timeout - # @option arguments [Boolean] :allow_partial_search_results Indicate if an error should be returned if there is a partial search failure or timeout + # @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] + # @option arguments [String] :analyzer [TODO] + # @option arguments [Boolean] :analyze_wildcard [TODO] + # @option arguments [Integer] :batched_reduce_size [TODO] + # @option arguments [Boolean] :ccs_minimize_roundtrips [TODO] + # @option arguments [String] :default_operator [TODO] + # @option arguments [String] :df [TODO] + # @option arguments [String, Array] :docvalue_fields [TODO] + # @option arguments [String, Array] :expand_wildcards [TODO] + # @option arguments [Boolean] :explain [TODO] + # @option arguments [Boolean] :ignore_throttled [TODO] + # @option arguments [Boolean] :ignore_unavailable [TODO] + # @option arguments [Boolean] :lenient [TODO] + # @option arguments [Integer] :max_concurrent_shard_requests [TODO] + # @option arguments [String] :preference [TODO] + # @option arguments [Integer] :pre_filter_shard_size [TODO] + # @option arguments [Boolean] :request_cache [TODO] + # @option arguments [String] :routing [TODO] + # @option arguments [Time] :scroll [TODO] + # @option arguments [String] :search_type [TODO] + # @option arguments [Array] :stats [TODO] + # @option arguments [String, Array] :stored_fields [TODO] + # @option arguments [String] :suggest_field Specifies which field to use for suggestions. + # @option arguments [String] :suggest_mode [TODO] + # @option arguments [Integer] :suggest_size [TODO] + # @option arguments [String] :suggest_text The source text for which the suggestions should be returned. + # @option arguments [Integer] :terminate_after [TODO] + # @option arguments [Time] :timeout [TODO] + # @option arguments [Boolean, Integer] :track_total_hits [TODO] + # @option arguments [Boolean] :track_scores [TODO] + # @option arguments [Boolean] :typed_keys [TODO] + # @option arguments [Boolean] :rest_total_hits_as_int [TODO] + # @option arguments [Boolean] :version [TODO] + # @option arguments [Boolean, String, Array] :_source [TODO] + # @option arguments [String, Array] :_source_excludes [TODO] + # @option arguments [String, Array] :_source_includes [TODO] + # @option arguments [Boolean] :seq_no_primary_term [TODO] + # @option arguments [String] :q [TODO] + # @option arguments [Integer] :size [TODO] + # @option arguments [Integer] :from [TODO] + # @option arguments [String, Array] :sort [TODO] + # @option arguments [Array] :wait_for_checkpoints A comma separated list of checkpoints. When configured, the search API will only be executed on a shard + # after the relevant checkpoint has become visible for search. Defaults to an empty list which will cause + # Elasticsearch to immediately execute the search. Server default: []. + # @option arguments [Boolean] :allow_partial_search_results If true, returns partial results if there are shard request timeouts or shard failures. + # If false, returns an error with no partial results. + # Defaults to the configured cluster setting `search.default_allow_partial_results`, which is true by default. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The search definition using the Query DSL + # @option arguments [Hash] :body request body # - # @see [TODO] + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-fleet-search # def search(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'fleet.search' } @@ -60,7 +117,7 @@ def search(arguments = {}) Elasticsearch::API::HTTP_GET end - path = "#{Utils.__listify(_index)}/_fleet/_fleet_search" + path = "#{Utils.listify(_index)}/_fleet/_fleet_search" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/get.rb index 3b956abf07..8bd30be5ef 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/get.rb @@ -15,35 +15,110 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Returns a document. + # Get a document by its ID. + # Get a document and its source or stored fields from an index. + # By default, this API is realtime and is not affected by the refresh rate of the index (when data will become visible for search). + # In the case where stored fields are requested with the `stored_fields` parameter and the document has been updated but is not yet refreshed, the API will have to parse and analyze the source to extract the stored fields. + # To turn off realtime behavior, set the `realtime` parameter to false. + # **Source filtering** + # By default, the API returns the contents of the `_source` field unless you have used the `stored_fields` parameter or the `_source` field is turned off. + # You can turn off `_source` retrieval by using the `_source` parameter: + # + # ``` + # GET my-index-000001/_doc/0?_source=false + # ``` + # + # If you only need one or two fields from the `_source`, use the `_source_includes` or `_source_excludes` parameters to include or filter out particular fields. + # This can be helpful with large documents where partial retrieval can save on network overhead + # Both parameters take a comma separated list of fields or wildcard expressions. + # For example: + # + # ``` + # GET my-index-000001/_doc/0?_source_includes=*.id&_source_excludes=entities + # ``` + # + # If you only want to specify includes, you can use a shorter notation: + # + # ``` + # GET my-index-000001/_doc/0?_source=*.id + # ``` + # + # **Routing** + # If routing is used during indexing, the routing value also needs to be specified to retrieve a document. + # For example: + # + # ``` + # GET my-index-000001/_doc/2?routing=user1 + # ``` + # + # This request gets the document with ID 2, but it is routed based on the user. + # The document is not fetched if the correct routing is not specified. + # **Distributed** + # The GET operation is hashed into a specific shard ID. + # It is then redirected to one of the replicas within that shard ID and returns the result. + # The replicas are the primary shard and its replicas within that shard ID group. + # This means that the more replicas you have, the better your GET scaling will be. + # **Versioning support** + # You can use the `version` parameter to retrieve the document only if its current version is equal to the specified one. + # Internally, Elasticsearch has marked the old document as deleted and added an entirely new document. + # The old version of the document doesn't disappear immediately, although you won't be able to access it. + # Elasticsearch cleans up deleted documents in the background as you continue to index more data. # - # @option arguments [String] :id The document ID - # @option arguments [String] :index The name of the index - # @option arguments [Boolean] :force_synthetic_source Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index. - # @option arguments [List] :stored_fields A comma-separated list of stored fields to return in the response - # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) - # @option arguments [Boolean] :realtime Specify whether to perform the operation in realtime or search mode - # @option arguments [Boolean] :refresh Refresh the shard containing the document before performing the operation - # @option arguments [String] :routing Specific routing value - # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return - # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field - # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field - # @option arguments [Number] :version Explicit version number for concurrency control - # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte) + # @option arguments [String] :id A unique document identifier. (*Required*) + # @option arguments [String] :index The name of the index that contains the document. (*Required*) + # @option arguments [Boolean] :force_synthetic_source Indicates whether the request forces synthetic `_source`. + # Use this parameter to test if the mapping supports synthetic `_source` and to get a sense of the worst case performance. + # Fetches with this parameter enabled will be slower than enabling synthetic source natively in the index. + # @option arguments [String] :preference The node or shard the operation should be performed on. + # By default, the operation is randomized between the shard replicas.If it is set to `_local`, the operation will prefer to be run on a local allocated shard when possible. + # If it is set to a custom value, the value is used to guarantee that the same shards will be used for the same custom value. + # This can help with "jumping values" when hitting different shards in different refresh states. + # A sample value can be something like the web session ID or the user name. + # @option arguments [Boolean] :realtime If `true`, the request is real-time as opposed to near-real-time. Server default: true. + # @option arguments [Boolean] :refresh If `true`, the request refreshes the relevant shards before retrieving the document. + # Setting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing). + # @option arguments [String] :routing A custom value used to route operations to a specific shard. + # @option arguments [Boolean, String, Array] :_source Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return. + # @option arguments [String, Array] :_source_excludes A comma-separated list of source fields to exclude from the response. + # You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. + # If the `_source` parameter is `false`, this parameter is ignored. + # @option arguments [String, Array] :_source_includes A comma-separated list of source fields to include in the response. + # If this parameter is specified, only these source fields are returned. + # You can exclude fields from this subset using the `_source_excludes` query parameter. + # If the `_source` parameter is `false`, this parameter is ignored. + # @option arguments [String, Array] :stored_fields A comma-separated list of stored fields to return as part of a hit. + # If no fields are specified, no stored fields are included in the response. + # If this field is specified, the `_source` parameter defaults to `false`. + # Only leaf fields can be retrieved with the `stored_fields` option. + # Object fields can't be returned; if specified, the request fails. + # @option arguments [Integer] :version The version number for concurrency control. + # It must match the current version of the document for the request to succeed. + # @option arguments [String] :version_type The version type. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-get # def get(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'get' } - defined_params = %i[index id].each_with_object({}) do |variable, set_variables| + defined_params = [:index, :id].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -61,11 +136,11 @@ def get(arguments = {}) _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_GET - path = "#{Utils.__listify(_index)}/_doc/#{Utils.__listify(_id)}" + path = "#{Utils.listify(_index)}/_doc/#{Utils.listify(_id)}" params = Utils.process_params(arguments) if Array(arguments[:ignore]).include?(404) - Utils.__rescue_from_not_found do + Utils.rescue_from_not_found do Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/get_script.rb b/elasticsearch-api/lib/elasticsearch/api/actions/get_script.rb index d1a4baf476..fb2e101205 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/get_script.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/get_script.rb @@ -15,19 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Returns a script. + # Get a script or search template. + # Retrieves a stored script or search template. # - # @option arguments [String] :id Script ID - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [String] :id The identifier for the stored script or search template. (*Required*) + # @option arguments [Time] :master_timeout The period to wait for the master node. + # If the master node is not available before the timeout expires, the request fails and returns an error. + # It can also be set to `-1` to indicate that the request should never timeout. Server default: . + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-get-script # def get_script(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'get_script' } @@ -47,7 +61,7 @@ def get_script(arguments = {}) _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_GET - path = "_scripts/#{Utils.__listify(_id)}" + path = "_scripts/#{Utils.listify(_id)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/get_script_context.rb b/elasticsearch-api/lib/elasticsearch/api/actions/get_script_context.rb index 845762ab86..354e1e3685 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/get_script_context.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/get_script_context.rb @@ -15,17 +15,29 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Returns all script contexts. + # Get script contexts. + # Get a list of supported script contexts and their methods. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/painless/current/painless-contexts.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-get-script-context # def get_script_context(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'get_script_context' } @@ -33,11 +45,11 @@ def get_script_context(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_script_context' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/get_script_languages.rb b/elasticsearch-api/lib/elasticsearch/api/actions/get_script_languages.rb index d8f9d8d77b..9e631981ac 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/get_script_languages.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/get_script_languages.rb @@ -15,17 +15,29 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Returns available script types, languages and contexts + # Get script languages. + # Get a list of available script types, languages, and contexts. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-get-script-languages # def get_script_languages(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'get_script_languages' } @@ -33,11 +45,11 @@ def get_script_languages(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_script_language' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/get_source.rb b/elasticsearch-api/lib/elasticsearch/api/actions/get_source.rb index e66b8c5e6c..e309490810 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/get_source.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/get_source.rb @@ -15,33 +15,59 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Returns the source of a document. + # Get a document's source. + # Get the source of a document. + # For example: + # + # ``` + # GET my-index-000001/_source/1 + # ``` + # + # You can use the source filtering parameters to control which parts of the `_source` are returned: + # + # ``` + # GET my-index-000001/_source/1/?_source_includes=*.id&_source_excludes=entities + # ``` # - # @option arguments [String] :id The document ID - # @option arguments [String] :index The name of the index - # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) - # @option arguments [Boolean] :realtime Specify whether to perform the operation in realtime or search mode - # @option arguments [Boolean] :refresh Refresh the shard containing the document before performing the operation - # @option arguments [String] :routing Specific routing value - # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return - # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field - # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field - # @option arguments [Number] :version Explicit version number for concurrency control - # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte) + # @option arguments [String] :id A unique document identifier. (*Required*) + # @option arguments [String] :index The name of the index that contains the document. (*Required*) + # @option arguments [String] :preference The node or shard the operation should be performed on. + # By default, the operation is randomized between the shard replicas. + # @option arguments [Boolean] :realtime If `true`, the request is real-time as opposed to near-real-time. Server default: true. + # @option arguments [Boolean] :refresh If `true`, the request refreshes the relevant shards before retrieving the document. + # Setting it to `true` should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing). + # @option arguments [String] :routing A custom value used to route operations to a specific shard. + # @option arguments [Boolean, String, Array] :_source Indicates whether to return the `_source` field (`true` or `false`) or lists the fields to return. + # @option arguments [String, Array] :_source_excludes A comma-separated list of source fields to exclude in the response. + # @option arguments [String, Array] :_source_includes A comma-separated list of source fields to include in the response. + # @option arguments [Integer] :version The version number for concurrency control. + # It must match the current version of the document for the request to succeed. + # @option arguments [String] :version_type The version type. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-get.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-get # def get_source(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'get_source' } - defined_params = %i[index id].each_with_object({}) do |variable, set_variables| + defined_params = [:index, :id].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -59,7 +85,7 @@ def get_source(arguments = {}) _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_GET - path = "#{Utils.__listify(_index)}/_source/#{Utils.__listify(_id)}" + path = "#{Utils.listify(_index)}/_source/#{Utils.listify(_id)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/graph/explore.rb b/elasticsearch-api/lib/elasticsearch/api/actions/graph/explore.rb index 64306ce433..d56ea8e5c6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/graph/explore.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/graph/explore.rb @@ -15,22 +15,40 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Graph module Actions - # Explore extracted and summarized information about the documents and terms in an index. + # Explore graph analytics. + # Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. + # The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. + # An initial request to the `_explore` API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. + # Subsequent requests enable you to spider out from one more vertices of interest. + # You can exclude vertices that have already been returned. # - # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices - # @option arguments [String] :routing Specific routing value - # @option arguments [Time] :timeout Explicit operation timeout + # @option arguments [String, Array] :index Name of the index. (*Required*) + # @option arguments [String] :routing Custom value used to route operations to a specific shard. + # @option arguments [Time] :timeout Specifies the period of time to wait for a response from each shard. + # If no response is received before the timeout expires, the request fails and returns an error. + # Defaults to no timeout. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body Graph Query DSL + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/graph-explore-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-graph # def explore(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'graph.explore' } @@ -55,7 +73,7 @@ def explore(arguments = {}) Elasticsearch::API::HTTP_GET end - path = "#{Utils.__listify(_index)}/_graph/explore" + path = "#{Utils.listify(_index)}/_graph/explore" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/health_report.rb b/elasticsearch-api/lib/elasticsearch/api/actions/health_report.rb index 7849b26638..d01d2f00bd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/health_report.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/health_report.rb @@ -15,21 +15,44 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Returns the health of the cluster. + # Get the cluster health. + # Get a report with the health status of an Elasticsearch cluster. + # The report contains a list of indicators that compose Elasticsearch functionality. + # Each indicator has a health status of: green, unknown, yellow or red. + # The indicator will provide an explanation and metadata describing the reason for its current health status. + # The cluster’s status is controlled by the worst indicator status. + # In the event that an indicator’s status is non-green, a list of impacts may be present in the indicator result which detail the functionalities that are negatively affected by the health issue. + # Each impact carries with it a severity level, an area of the system that is affected, and a simple description of the impact on the system. + # Some health indicators can determine the root cause of a health problem and prescribe a set of steps that can be performed in order to improve the health of the system. + # The root cause and remediation steps are encapsulated in a diagnosis. + # A diagnosis contains a cause detailing a root cause analysis, an action containing a brief description of the steps to take to fix the problem, the list of affected resources (if applicable), and a detailed step-by-step troubleshooting guide to fix the diagnosed problem. + # NOTE: The health indicators perform root cause analysis of non-green health statuses. This can be computationally expensive when called frequently. + # When setting up automated polling of the API for health status, set verbose to false to disable the more expensive analysis logic. # - # @option arguments [String] :feature A feature of the cluster, as returned by the top-level health API - # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Boolean] :verbose Opt in for more information about the health of the system - # @option arguments [Integer] :size Limit the number of affected resources the health API returns + # @option arguments [String, Array] :feature A feature of the cluster, as returned by the top-level health report API. + # @option arguments [Time] :timeout Explicit operation timeout. + # @option arguments [Boolean] :verbose Opt-in for more information about the health of the system. Server default: true. + # @option arguments [Integer] :size Limit the number of affected resources the health report API returns. Server default: 1000. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/health-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-health-report # def health_report(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'health_report' } @@ -48,7 +71,7 @@ def health_report(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _feature - "_health_report/#{Utils.__listify(_feature)}" + "_health_report/#{Utils.listify(_feature)}" else '_health_report' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index.rb index 311e3d1a3d..8f73eb51f0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index.rb @@ -15,38 +15,150 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Creates or updates a document in an index. + # Create or update a document in an index. + # Add a JSON document to the specified data stream or index and make it searchable. + # If the target is an index and the document already exists, the request updates the document and increments its version. + # NOTE: You cannot use this API to send update requests for existing documents in a data stream. + # If the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or index alias: + # * To add or overwrite a document using the `PUT //_doc/<_id>` request format, you must have the `create`, `index`, or `write` index privilege. + # * To add a document using the `POST //_doc/` request format, you must have the `create_doc`, `create`, `index`, or `write` index privilege. + # * To automatically create a data stream or index with this API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege. + # Automatic data stream creation requires a matching index template with data stream enabled. + # NOTE: Replica shards might not all be started when an indexing operation returns successfully. + # By default, only the primary is required. Set `wait_for_active_shards` to change this default behavior. + # **Automatically create data streams and indices** + # If the request's target doesn't exist and matches an index template with a `data_stream` definition, the index operation automatically creates the data stream. + # If the target doesn't exist and doesn't match a data stream template, the operation automatically creates the index and applies any matching index templates. + # NOTE: Elasticsearch includes several built-in index templates. To avoid naming collisions with these templates, refer to index pattern documentation. + # If no mapping exists, the index operation creates a dynamic mapping. + # By default, new fields and objects are automatically added to the mapping if needed. + # Automatic index creation is controlled by the `action.auto_create_index` setting. + # If it is `true`, any index can be created automatically. + # You can modify this setting to explicitly allow or block automatic creation of indices that match specified patterns or set it to `false` to turn off automatic index creation entirely. + # Specify a comma-separated list of patterns you want to allow or prefix each pattern with `+` or `-` to indicate whether it should be allowed or blocked. + # When a list is specified, the default behaviour is to disallow. + # NOTE: The `action.auto_create_index` setting affects the automatic creation of indices only. + # It does not affect the creation of data streams. + # **Optimistic concurrency control** + # Index operations can be made conditional and only be performed if the last modification to the document was assigned the sequence number and primary term specified by the `if_seq_no` and `if_primary_term` parameters. + # If a mismatch is detected, the operation will result in a `VersionConflictException` and a status code of `409`. + # **Routing** + # By default, shard placement — or routing — is controlled by using a hash of the document's ID value. + # For more explicit control, the value fed into the hash function used by the router can be directly specified on a per-operation basis using the `routing` parameter. + # When setting up explicit mapping, you can also use the `_routing` field to direct the index operation to extract the routing value from the document itself. + # This does come at the (very minimal) cost of an additional document parsing pass. + # If the `_routing` mapping is defined and set to be required, the index operation will fail if no routing value is provided or extracted. + # NOTE: Data streams do not support custom routing unless they were created with the `allow_custom_routing` setting enabled in the template. + # **Distributed** + # The index operation is directed to the primary shard based on its route and performed on the actual node containing this shard. + # After the primary shard completes the operation, if needed, the update is distributed to applicable replicas. + # **Active shards** + # To improve the resiliency of writes to the system, indexing operations can be configured to wait for a certain number of active shard copies before proceeding with the operation. + # If the requisite number of active shard copies are not available, then the write operation must wait and retry, until either the requisite shard copies have started or a timeout occurs. + # By default, write operations only wait for the primary shards to be active before proceeding (that is to say `wait_for_active_shards` is `1`). + # This default can be overridden in the index settings dynamically by setting `index.write.wait_for_active_shards`. + # To alter this behavior per operation, use the `wait_for_active_shards request` parameter. + # Valid values are all or any positive integer up to the total number of configured copies per shard in the index (which is `number_of_replicas`+1). + # Specifying a negative value or a number greater than the number of shard copies will throw an error. + # For example, suppose you have a cluster of three nodes, A, B, and C and you create an index index with the number of replicas set to 3 (resulting in 4 shard copies, one more copy than there are nodes). + # If you attempt an indexing operation, by default the operation will only ensure the primary copy of each shard is available before proceeding. + # This means that even if B and C went down and A hosted the primary shard copies, the indexing operation would still proceed with only one copy of the data. + # If `wait_for_active_shards` is set on the request to `3` (and all three nodes are up), the indexing operation will require 3 active shard copies before proceeding. + # This requirement should be met because there are 3 active nodes in the cluster, each one holding a copy of the shard. + # However, if you set `wait_for_active_shards` to `all` (or to `4`, which is the same in this situation), the indexing operation will not proceed as you do not have all 4 copies of each shard active in the index. + # The operation will timeout unless a new node is brought up in the cluster to host the fourth copy of the shard. + # It is important to note that this setting greatly reduces the chances of the write operation not writing to the requisite number of shard copies, but it does not completely eliminate the possibility, because this check occurs before the write operation starts. + # After the write operation is underway, it is still possible for replication to fail on any number of shard copies but still succeed on the primary. + # The `_shards` section of the API response reveals the number of shard copies on which replication succeeded and failed. + # **No operation (noop) updates** + # When updating a document by using this API, a new version of the document is always created even if the document hasn't changed. + # If this isn't acceptable use the `_update` API with `detect_noop` set to `true`. + # The `detect_noop` option isn't available on this API because it doesn’t fetch the old source and isn't able to compare it against the new source. + # There isn't a definitive rule for when noop updates aren't acceptable. + # It's a combination of lots of factors like how frequently your data source sends updates that are actually noops and how many queries per second Elasticsearch runs on the shard receiving the updates. + # **Versioning** + # Each indexed document is given a version number. + # By default, internal versioning is used that starts at 1 and increments with each update, deletes included. + # Optionally, the version number can be set to an external value (for example, if maintained in a database). + # To enable this functionality, `version_type` should be set to `external`. + # The value provided must be a numeric, long value greater than or equal to 0, and less than around `9.2e+18`. + # NOTE: Versioning is completely real time, and is not affected by the near real time aspects of search operations. + # If no version is provided, the operation runs without any version checks. + # When using the external version type, the system checks to see if the version number passed to the index request is greater than the version of the currently stored document. + # If true, the document will be indexed and the new version number used. + # If the value provided is less than or equal to the stored document's version number, a version conflict will occur and the index operation will fail. For example: + # ``` + # PUT my-index-000001/_doc/1?version=2&version_type=external + # { + # "user": { + # "id": "elkbee" + # } + # } + # In this example, the operation will succeed since the supplied version of 2 is higher than the current document version of 1. + # If the document was already updated and its version was set to 2 or higher, the indexing command will fail and result in a conflict (409 HTTP status code). + # A nice side effect is that there is no need to maintain strict ordering of async indexing operations run as a result of changes to a source database, as long as version numbers from the source database are used. + # Even the simple case of updating the Elasticsearch index using data from a database is simplified if external versioning is used, as only the latest version will be used if the index operations arrive out of order. # - # @option arguments [String] :id Document ID - # @option arguments [String] :index The name of the index - # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) - # @option arguments [String] :op_type Explicit operation type. Defaults to `index` for requests with an explicit document ID, and to `create`for requests without an explicit document ID (options: index, create) - # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (options: true, false, wait_for) - # @option arguments [String] :routing Specific routing value - # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Number] :version Explicit version number for concurrency control - # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte) - # @option arguments [Number] :if_seq_no only perform the index operation if the last operation that has changed the document has the specified sequence number - # @option arguments [Number] :if_primary_term only perform the index operation if the last operation that has changed the document has the specified primary term - # @option arguments [String] :pipeline The pipeline id to preprocess incoming documents with - # @option arguments [Boolean] :require_alias When true, requires destination to be an alias. Default is false - # @option arguments [Boolean] :require_data_stream When true, requires the destination to be a data stream (existing or to-be-created). Default is false - # @option arguments [Boolean] :include_source_on_error True or false if to include the document source in the error message in case of parsing errors. Defaults to true. + # @option arguments [String] :id A unique identifier for the document. + # To automatically generate a document ID, use the `POST //_doc/` request format and omit this parameter. + # @option arguments [String] :index The name of the data stream or index to target. + # If the target doesn't exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream. + # If the target doesn't exist and doesn't match a data stream template, this request creates the index. + # You can check for existing targets with the resolve index API. (*Required*) + # @option arguments [Integer] :if_primary_term Only perform the operation if the document has this primary term. + # @option arguments [Integer] :if_seq_no Only perform the operation if the document has this sequence number. + # @option arguments [Boolean] :include_source_on_error True or false if to include the document source in the error message in case of parsing errors. Server default: true. + # @option arguments [String] :op_type Set to `create` to only index the document if it does not already exist (put if absent). + # If a document with the specified `_id` already exists, the indexing operation will fail. + # The behavior is the same as using the `/_create` endpoint. + # If a document ID is specified, this paramater defaults to `index`. + # Otherwise, it defaults to `create`. + # If the request targets a data stream, an `op_type` of `create` is required. + # @option arguments [String] :pipeline The ID of the pipeline to use to preprocess incoming documents. + # If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request. + # If a final pipeline is configured it will always run, regardless of the value of this parameter. + # @option arguments [String] :refresh If `true`, Elasticsearch refreshes the affected shards to make this operation visible to search. + # If `wait_for`, it waits for a refresh to make this operation visible to search. + # If `false`, it does nothing with refreshes. Server default: false. + # @option arguments [String] :routing A custom value that is used to route operations to a specific shard. + # @option arguments [Time] :timeout The period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.This parameter is useful for situations where the primary shard assigned to perform the operation might not be available when the operation runs. + # Some reasons for this might be that the primary shard is currently recovering from a gateway or undergoing relocation. + # By default, the operation will wait on the primary shard to become available for at least 1 minute before failing and responding with an error. + # The actual wait time could be longer, particularly when multiple waits occur. Server default: 1m. + # @option arguments [Integer] :version An explicit version number for concurrency control. + # It must be a non-negative long number. + # @option arguments [String] :version_type The version type. + # @option arguments [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operation. + # You can set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + # The default value of `1` means it waits for each primary shard to be active. Server default: 1. + # @option arguments [Boolean] :require_alias If `true`, the destination must be an index alias. + # @option arguments [Boolean] :require_data_stream If `true`, the request's actions must target a data stream (existing or to be created). + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The document (*Required*) + # @option arguments [Hash] :body document # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-index_.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-create # def index(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'index' } - defined_params = %i[index id].each_with_object({}) do |variable, set_variables| + defined_params = [:index, :id].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -65,9 +177,9 @@ def index(arguments = {}) method = _id ? Elasticsearch::API::HTTP_PUT : Elasticsearch::API::HTTP_POST path = if _index && _id - "#{Utils.__listify(_index)}/_doc/#{Utils.__listify(_id)}" + "#{Utils.listify(_index)}/_doc/#{Utils.listify(_id)}" else - "#{Utils.__listify(_index)}/_doc" + "#{Utils.listify(_index)}/_doc" end params = Utils.process_params(arguments) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/delete_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/delete_lifecycle.rb index a73ec735ae..5c62446bae 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/delete_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/delete_lifecycle.rb @@ -15,21 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module IndexLifecycleManagement module Actions - # Deletes the specified lifecycle policy definition. A currently used policy cannot be deleted. + # Delete a lifecycle policy. + # You cannot delete policies that are currently in use. If the policy is being used to manage any indices, the request fails and returns an error. # - # @option arguments [String] :policy The name of the index lifecycle policy - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [Time] :timeout Explicit operation timeout + # @option arguments [String] :policy Identifier for the policy. (*Required*) + # @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. + # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-delete-lifecycle.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ilm-delete-lifecycle # def delete_lifecycle(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ilm.delete_lifecycle' } @@ -49,7 +61,7 @@ def delete_lifecycle(arguments = {}) _policy = arguments.delete(:policy) method = Elasticsearch::API::HTTP_DELETE - path = "_ilm/policy/#{Utils.__listify(_policy)}" + path = "_ilm/policy/#{Utils.listify(_policy)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/explain_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/explain_lifecycle.rb index dc5f6b9dcf..c1e4f0a8ce 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/explain_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/explain_lifecycle.rb @@ -15,22 +15,37 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module IndexLifecycleManagement module Actions - # Retrieves information about the index's current lifecycle state, such as the currently executing phase, action, and step. + # Explain the lifecycle state. + # Get the current lifecycle status for one or more indices. + # For data streams, the API retrieves the current lifecycle status for the stream's backing indices. + # The response indicates when the index entered each lifecycle state, provides the definition of the running phase, and information about any failures. # - # @option arguments [String] :index The name of the index to explain - # @option arguments [Boolean] :only_managed filters the indices included in the response to ones managed by ILM - # @option arguments [Boolean] :only_errors filters the indices included in the response to ones in an ILM error state, implies only_managed - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [String] :index Comma-separated list of data streams, indices, and aliases to target. Supports wildcards (`*`). + # To target all data streams and indices, use `*` or `_all`. (*Required*) + # @option arguments [Boolean] :only_errors Filters the returned indices to only indices that are managed by ILM and are in an error state, either due to an encountering an error while executing the policy, or attempting to use a policy that does not exist. + # @option arguments [Boolean] :only_managed Filters the returned indices to only indices that are managed by ILM. + # @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. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-explain-lifecycle.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ilm-explain-lifecycle # def explain_lifecycle(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ilm.explain_lifecycle' } @@ -45,12 +60,12 @@ def explain_lifecycle(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_GET - path = "#{Utils.__listify(_index)}/_ilm/explain" + path = "#{Utils.listify(_index)}/_ilm/explain" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/get_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/get_lifecycle.rb index 92b8c607b3..f2de8b601c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/get_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/get_lifecycle.rb @@ -15,21 +15,32 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module IndexLifecycleManagement module Actions - # Returns the specified policy definition. Includes the policy version and last modified date. + # Get lifecycle policies. # - # @option arguments [String] :policy The name of the index lifecycle policy - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [Time] :timeout Explicit operation timeout + # @option arguments [String] :policy Identifier for the policy. + # @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. + # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-lifecycle.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ilm-get-lifecycle # def get_lifecycle(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ilm.get_lifecycle' } @@ -48,7 +59,7 @@ def get_lifecycle(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _policy - "_ilm/policy/#{Utils.__listify(_policy)}" + "_ilm/policy/#{Utils.listify(_policy)}" else '_ilm/policy' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/get_status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/get_status.rb index 0cf68bc5c1..a62ba78b49 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/get_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/get_status.rb @@ -15,18 +15,30 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module IndexLifecycleManagement module Actions - # Retrieves the current index lifecycle management (ILM) status. + # Get the ILM status. + # Get the current index lifecycle management status. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-get-status.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ilm-get-status # def get_status(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ilm.get_status' } @@ -34,11 +46,11 @@ def get_status(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_ilm/status' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/migrate_to_data_tiers.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/migrate_to_data_tiers.rb index f459f1115d..3faaede439 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/migrate_to_data_tiers.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/migrate_to_data_tiers.rb @@ -15,21 +15,45 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module IndexLifecycleManagement module Actions - # Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routing + # Migrate to data tiers routing. + # Switch the indices, ILM policies, and legacy, composable, and component templates from using custom node attributes and attribute-based allocation filters to using data tiers. + # Optionally, delete one legacy index template. + # Using node roles enables ILM to automatically move the indices between data tiers. + # Migrating away from custom node attributes routing can be manually performed. + # This API provides an automated way of performing three out of the four manual steps listed in the migration guide: + # 1. Stop setting the custom hot attribute on new indices. + # 1. Remove custom allocation settings from existing ILM policies. + # 1. Replace custom allocation settings from existing indices with the corresponding tier preference. + # ILM must be stopped before performing the migration. + # Use the stop ILM and get ILM status APIs to wait until the reported operation mode is `STOPPED`. # - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [Boolean] :dry_run If set to true it will simulate the migration, providing a way to retrieve the ILM policies and indices that need to be migrated. The default is false + # @option arguments [Boolean] :dry_run If true, simulates the migration from node attributes based allocation filters to data tiers, but does not perform the migration. + # This provides a way to retrieve the indices and ILM policies that need to be migrated. + # @option arguments [Time] :master_timeout The 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. + # It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body Optionally specify a legacy index template name to delete and optionally specify a node attribute name used for index shard routing (defaults to "data") + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-migrate-to-data-tiers.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ilm-migrate-to-data-tiers # def migrate_to_data_tiers(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ilm.migrate_to_data_tiers' } @@ -37,7 +61,7 @@ def migrate_to_data_tiers(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_ilm/migrate_to_data_tiers' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/move_to_step.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/move_to_step.rb index 212cb8efc6..6e7aa33bcb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/move_to_step.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/move_to_step.rb @@ -15,20 +15,41 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module IndexLifecycleManagement module Actions - # Manually moves an index into the specified step and executes that step. + # Move to a lifecycle step. + # Manually move an index into a specific step in the lifecycle policy and run that step. + # WARNING: This operation can result in the loss of data. Manually moving an index into a specific step runs that step even if it has already been performed. This is a potentially destructive action and this should be considered an expert level API. + # You must specify both the current step and the step to be executed in the body of the request. + # The request will fail if the current step does not match the step currently running for the index + # This is to prevent the index from being moved from an unexpected step into the next step. + # When specifying the target (`next_step`) to which the index will be moved, either the name or both the action and name fields are optional. + # If only the phase is specified, the index will move to the first step of the first action in the target phase. + # If the phase and action are specified, the index will move to the first step of the specified action in the specified phase. + # Only actions specified in the ILM policy are considered valid. + # An index cannot move to a step that is not part of its policy. # - # @option arguments [String] :index The name of the index whose lifecycle step is to change + # @option arguments [String] :index The name of the index whose lifecycle step is to change (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The new lifecycle step to move to + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-move-to-step.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ilm-move-to-step # def move_to_step(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ilm.move_to_step' } @@ -43,13 +64,13 @@ def move_to_step(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_POST - path = "_ilm/move/#{Utils.__listify(_index)}" - params = {} + path = "_ilm/move/#{Utils.listify(_index)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/put_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/put_lifecycle.rb index 9035c24731..fe4f331cf8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/put_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/put_lifecycle.rb @@ -15,22 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module IndexLifecycleManagement module Actions - # Creates a lifecycle policy + # Create or update a lifecycle policy. + # If the specified policy exists, it is replaced and the policy version is incremented. + # NOTE: Only the latest version of the policy is stored, you cannot revert to previous versions. # - # @option arguments [String] :policy The name of the index lifecycle policy - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [Time] :timeout Explicit operation timeout + # @option arguments [String] :policy Identifier for the policy. (*Required*) + # @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. + # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The lifecycle policy definition to register + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-put-lifecycle.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ilm-put-lifecycle # def put_lifecycle(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ilm.put_lifecycle' } @@ -50,7 +63,7 @@ def put_lifecycle(arguments = {}) _policy = arguments.delete(:policy) method = Elasticsearch::API::HTTP_PUT - path = "_ilm/policy/#{Utils.__listify(_policy)}" + path = "_ilm/policy/#{Utils.listify(_policy)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/remove_policy.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/remove_policy.rb index 96eaed6977..6f5134feb0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/remove_policy.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/remove_policy.rb @@ -15,19 +15,32 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module IndexLifecycleManagement module Actions - # Removes the assigned lifecycle policy and stops managing the specified index + # Remove policies from an index. + # Remove the assigned lifecycle policies from an index or a data stream's backing indices. + # It also stops managing the indices. # - # @option arguments [String] :index The name of the index to remove policy on + # @option arguments [String] :index The name of the index to remove policy on (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-remove-policy.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ilm-remove-policy # def remove_policy(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ilm.remove_policy' } @@ -42,13 +55,13 @@ def remove_policy(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_POST - path = "#{Utils.__listify(_index)}/_ilm/remove" - params = {} + path = "#{Utils.listify(_index)}/_ilm/remove" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/retry.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/retry.rb index 61fbb1b173..58e5ac4687 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/retry.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/retry.rb @@ -15,19 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module IndexLifecycleManagement module Actions - # Retries executing the policy for an index that is in the ERROR step. + # Retry a policy. + # Retry running the lifecycle policy for an index that is in the ERROR step. + # The API sets the policy back to the step where the error occurred and runs the step. + # Use the explain lifecycle state API to determine whether an index is in the ERROR step. # - # @option arguments [String] :index The name of the indices (comma-separated) whose failed lifecycle step is to be retry + # @option arguments [String] :index The name of the indices (comma-separated) whose failed lifecycle step is to be retry (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-retry-policy.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ilm-retry # def retry(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ilm.retry' } @@ -42,13 +56,13 @@ def retry(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_POST - path = "#{Utils.__listify(_index)}/_ilm/retry" - params = {} + path = "#{Utils.listify(_index)}/_ilm/retry" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/start.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/start.rb index de72ec031f..18f71d3320 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/start.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/start.rb @@ -15,20 +15,34 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module IndexLifecycleManagement module Actions - # Start the index lifecycle management (ILM) plugin. + # Start the ILM plugin. + # Start the index lifecycle management plugin if it is currently stopped. + # ILM is started automatically when the cluster is formed. + # Restarting ILM is necessary only when it has been stopped using the stop ILM API. # - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [Time] :timeout Explicit operation timeout + # @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. + # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-start.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ilm-start # def start(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ilm.start' } @@ -36,7 +50,7 @@ def start(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_POST path = '_ilm/start' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/stop.rb b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/stop.rb index 81009ecb9c..3c3037e7eb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/stop.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/index_lifecycle_management/stop.rb @@ -15,20 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module IndexLifecycleManagement module Actions - # Halts all lifecycle management operations and stops the index lifecycle management (ILM) plugin + # Stop the ILM plugin. + # Halt all lifecycle management operations and stop the index lifecycle management plugin. + # This is useful when you are performing maintenance on the cluster and need to prevent ILM from performing any actions on your indices. + # The API returns as soon as the stop request has been acknowledged, but the plugin might continue to run until in-progress operations complete and the plugin can be safely stopped. + # Use the get ILM status API to check whether ILM is running. # - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [Time] :timeout Explicit operation timeout + # @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. + # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-stop.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ilm-stop # def stop(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ilm.stop' } @@ -36,7 +51,7 @@ def stop(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_POST path = '_ilm/stop' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/add_block.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/add_block.rb index b04cfd2b68..9677cd3e01 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/add_block.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/add_block.rb @@ -15,30 +15,54 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Adds a block to an index. + # Add an index block. + # Add an index block to an index. + # Index blocks limit the operations allowed on an index by blocking specific operation types. # - # @option arguments [List] :index A comma separated list of indices to add a block to - # @option arguments [String] :block The block to add (one of read, write, read_only or metadata) - # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Time] :master_timeout Specify timeout for connection to master - # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) - # @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) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [String] :index A comma-separated list or wildcard expression of index names used to limit the request. + # By default, you must explicitly name the indices you are adding blocks to. + # To allow the adding of blocks to indices with `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to `false`. + # You can update this setting in the `elasticsearch.yml` file or by using the cluster update settings API. (*Required*) + # @option arguments [String] :block The block type to add to the index. (*Required*) + # @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`. Server default: true. + # @option arguments [String, Array] :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`. Server default: open. + # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. + # @option arguments [Time] :master_timeout The period to wait for the master node. + # If the master node is not available before the timeout expires, the request fails and returns an error. + # It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s. + # @option arguments [Time] :timeout The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. + # If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. + # It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/index-modules-blocks.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-add-block # def add_block(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.add_block' } - defined_params = %i[index block].each_with_object({}) do |variable, set_variables| + defined_params = [:index, :block].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -49,14 +73,14 @@ def add_block(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) _block = arguments.delete(:block) method = Elasticsearch::API::HTTP_PUT - path = "#{Utils.__listify(_index)}/_block/#{Utils.__listify(_block)}" + path = "#{Utils.listify(_index)}/_block/#{Utils.listify(_block)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/analyze.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/analyze.rb index 00e736136e..61fdd702d2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/analyze.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/analyze.rb @@ -15,20 +15,38 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Performs the analysis process on a text and return the tokens breakdown of the text. + # Get tokens from text analysis. + # The analyze API performs analysis on a text string and returns the resulting tokens. + # Generating excessive amount of tokens may cause a node to run out of memory. + # The `index.analyze.max_token_count` setting enables you to limit the number of tokens that can be produced. + # If more than this limit of tokens gets generated, an error occurs. + # The `_analyze` endpoint without a specified index will always use `10000` as its limit. # - # @option arguments [String] :index The name of the index to scope the operation + # @option arguments [String] :index Index used to derive the analyzer. + # If specified, the `analyzer` or field parameter overrides this value. + # If no index is specified or the index does not have a default analyzer, the analyze API uses the standard analyzer. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body Define analyzer/tokenizer parameters and the text on which the analysis should be performed + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-analyze.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-analyze # def analyze(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.analyze' } @@ -51,11 +69,11 @@ def analyze(arguments = {}) Elasticsearch::API::HTTP_GET end - path = if _index - "#{Utils.__listify(_index)}/_analyze" - else - '_analyze' - end + path = if _index + "#{Utils.listify(_index)}/_analyze" + else + '_analyze' + end params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/rollup_search.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/cancel_migrate_reindex.rb similarity index 54% rename from elasticsearch-api/lib/elasticsearch/api/actions/rollup/rollup_search.rb rename to elasticsearch-api/lib/elasticsearch/api/actions/indices/cancel_migrate_reindex.rb index 597524c347..62317ec961 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/rollup_search.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/cancel_migrate_reindex.rb @@ -15,47 +15,55 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API - module Rollup + module Indices module Actions - # Enables searching rolled-up data using the standard query DSL. + # 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 [List] :index The indices or index-pattern(s) (containing rollup or regular data) that should be searched - # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response - # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response + # @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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The search request body (*Required*) # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-search.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-cancel-migrate-reindex # - def rollup_search(arguments = {}) - request_opts = { endpoint: arguments[:endpoint] || 'rollup.rollup_search' } + def cancel_migrate_reindex(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'indices.cancel_migrate_reindex' } defined_params = [:index].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? - raise ArgumentError, "Required argument 'body' missing" unless arguments[:body] raise ArgumentError, "Required argument 'index' missing" unless arguments[:index] arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_POST - path = "#{Utils.__listify(_index)}/_rollup_search" + path = "_migration/reindex/#{Utils.listify(_index)}/_cancel" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/clear_cache.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/clear_cache.rb index 0e214b6e48..1254bd7503 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/clear_cache.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/clear_cache.rb @@ -15,26 +15,48 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Clears all or specific caches for one or more indices. + # Clear the cache. + # Clear the cache of one or more indices. + # For data streams, the API clears the caches of the stream's backing indices. + # By default, the clear cache API clears all caches. + # To clear only specific caches, use the `fielddata`, `query`, or `request` parameters. + # To clear the cache only of specific fields, use the `fields` parameter. # - # @option arguments [List] :index A comma-separated list of index name to limit the operation - # @option arguments [Boolean] :fielddata Clear field data - # @option arguments [List] :fields A comma-separated list of fields to clear when using the `fielddata` parameter (default: all) - # @option arguments [Boolean] :query Clear query caches - # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) - # @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) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) - # @option arguments [Boolean] :request Clear request cache + # @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 [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. Server default: true. + # @option arguments [String, Array] :expand_wildcards 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. + # Supports comma-separated values, such as `open,hidden`. Server default: open. + # @option arguments [Boolean] :fielddata If `true`, clears the fields cache. + # Use the `fields` parameter to clear the cache of specific fields only. + # @option arguments [String, Array] :fields Comma-separated list of field names used to limit the `fielddata` parameter. + # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. + # @option arguments [Boolean] :query If `true`, clears the query cache. + # @option arguments [Boolean] :request If `true`, clears the request cache. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-clearcache.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-clear-cache # def clear_cache(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.clear_cache' } @@ -47,13 +69,13 @@ def clear_cache(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_POST path = if _index - "#{Utils.__listify(_index)}/_cache/clear" + "#{Utils.listify(_index)}/_cache/clear" else '_cache/clear' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/clone.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/clone.rb index fd336f75ee..209bdee050 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/clone.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/clone.rb @@ -15,29 +15,73 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Clones an index + # Clone an index. + # Clone an existing index into a new index. + # Each original primary shard is cloned into a new primary shard in the new index. + # IMPORTANT: Elasticsearch does not apply index templates to the resulting index. + # The API also does not copy index metadata from the original index. + # Index metadata includes aliases, index lifecycle management phase definitions, and cross-cluster replication (CCR) follower information. + # For example, if you clone a CCR follower index, the resulting clone will not be a follower index. + # The clone API copies most index settings from the source index to the resulting index, with the exception of `index.number_of_replicas` and `index.auto_expand_replicas`. + # To set the number of replicas in the resulting index, configure these settings in the clone request. + # Cloning works as follows: + # * First, it creates a new target index with the same definition as the source index. + # * Then it hard-links segments from the source index into the target index. If the file system does not support hard-linking, all segments are copied into the new index, which is a much more time consuming process. + # * Finally, it recovers the target index as though it were a closed index which had just been re-opened. + # IMPORTANT: Indices can only be cloned if they meet the following requirements: + # * The index must be marked as read-only and have a cluster health status of green. + # * The target index must not exist. + # * The source index must have the same number of primary shards as the target index. + # * The node handling the clone process must have sufficient free disk space to accommodate a second copy of the existing index. + # The current write index on a data stream cannot be cloned. + # In order to clone the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be cloned. + # NOTE: Mappings cannot be specified in the `_clone` request. The mappings of the source index will be used for the target index. + # **Monitor the cloning process** + # The cloning process can be monitored with the cat recovery API or the cluster health API can be used to wait until all primary shards have been allocated by setting the `wait_for_status` parameter to `yellow`. + # The `_clone` API returns as soon as the target index has been added to the cluster state, before any shards have been allocated. + # At this point, all shards are in the state unassigned. + # If, for any reason, the target index can't be allocated, its primary shard will remain unassigned until it can be allocated on that node. + # Once the primary shard is allocated, it moves to state initializing, and the clone process begins. + # When the clone operation completes, the shard will become active. + # At that point, Elasticsearch will try to allocate any replicas and may decide to relocate the primary shard to another node. + # **Wait for active shards** + # Because the clone operation creates a new index to clone the shards to, the wait for active shards setting on index creation applies to the clone index action as well. # - # @option arguments [String] :index The name of the source index to clone - # @option arguments [String] :target The name of the target index to clone into - # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Time] :master_timeout Specify timeout for connection to master - # @option arguments [String] :wait_for_active_shards Set the number of active shards to wait for on the cloned index before the operation returns. + # @option arguments [String] :index Name of the source index to clone. (*Required*) + # @option arguments [String] :target Name of the target index to create. (*Required*) + # @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. + # @option arguments [Time] :timeout Period to wait for a response. + # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operation. + # Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). Server default: 1. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The configuration for the target index (`settings` and `aliases`) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-clone-index.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-clone # def clone(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.clone' } - defined_params = %i[index target].each_with_object({}) do |variable, set_variables| + defined_params = [:index, :target].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -48,14 +92,14 @@ def clone(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) _index = arguments.delete(:index) _target = arguments.delete(:target) method = Elasticsearch::API::HTTP_PUT - path = "#{Utils.__listify(_index)}/_clone/#{Utils.__listify(_target)}" + path = "#{Utils.listify(_index)}/_clone/#{Utils.listify(_target)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/close.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/close.rb index e3533f1a27..596b09ced8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/close.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/close.rb @@ -15,25 +15,55 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Closes an index. + # Close an index. + # A closed index is blocked for read or write operations and does not allow all operations that opened indices allow. + # It is not possible to index documents or to search for documents in a closed index. + # Closed indices do not have to maintain internal data structures for indexing or searching documents, which results in a smaller overhead on the cluster. + # When opening or closing an index, the master node is responsible for restarting the index shards to reflect the new state of the index. + # The shards will then go through the normal recovery process. + # The data of opened and closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. + # You can open and close multiple indices. + # An error is thrown if the request explicitly refers to a missing index. + # This behaviour can be turned off using the `ignore_unavailable=true` parameter. + # By default, you must explicitly name the indices you are opening or closing. + # To open or close indices with `_all`, `*`, or other wildcard expressions, change the`action.destructive_requires_name` setting to `false`. This setting can also be changed with the cluster update settings API. + # Closed indices consume a significant amount of disk-space which can cause problems in managed environments. + # Closing indices can be turned off with the cluster settings API by setting `cluster.indices.close.enable` to `false`. # - # @option arguments [List] :index A comma separated list of indices to close - # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Time] :master_timeout Specify timeout for connection to master - # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) - # @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) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) - # @option arguments [String] :wait_for_active_shards Sets the number of active shards to wait for before the operation returns. + # @option arguments [String, Array] :index Comma-separated list or wildcard expression of index names used to limit the request. (*Required*) + # @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. Server default: true. + # @option arguments [String, Array] :expand_wildcards 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. + # Supports comma-separated values, such as `open,hidden`. Server default: open. + # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. + # @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. + # @option arguments [Time] :timeout Period to wait for a response. + # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operation. + # Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). Server default: 1. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-open-close.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-close # def close(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.close' } @@ -48,12 +78,12 @@ def close(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_POST - path = "#{Utils.__listify(_index)}/_close" + path = "#{Utils.listify(_index)}/_close" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/create.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/create.rb index 0135beabd9..e30e88edd1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/create.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/create.rb @@ -15,23 +15,60 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Creates an index with optional settings and mappings. + # Create an index. + # You can use the create index API to add a new index to an Elasticsearch cluster. + # When creating an index, you can specify the following: + # * Settings for the index. + # * Mappings for fields in the index. + # * Index aliases + # **Wait for active shards** + # By default, index creation will only return a response to the client when the primary copies of each shard have been started, or the request times out. + # The index creation response will indicate what happened. + # For example, `acknowledged` indicates whether the index was successfully created in the cluster, `while shards_acknowledged` indicates whether the requisite number of shard copies were started for each shard in the index before timing out. + # Note that it is still possible for either `acknowledged` or `shards_acknowledged` to be `false`, but for the index creation to be successful. + # These values simply indicate whether the operation completed before the timeout. + # If `acknowledged` is false, the request timed out before the cluster state was updated with the newly created index, but it probably will be created sometime soon. + # If `shards_acknowledged` is false, then the request timed out before the requisite number of shards were started (by default just the primaries), even if the cluster state was successfully updated to reflect the newly created index (that is to say, `acknowledged` is `true`). + # You can change the default of only waiting for the primary shards to start through the index setting `index.write.wait_for_active_shards`. + # Note that changing this setting will also affect the `wait_for_active_shards` value on all subsequent write operations. # - # @option arguments [String] :index The name of the index - # @option arguments [String] :wait_for_active_shards Set the number of active shards to wait for before the operation returns. - # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [String] :index Name of the index you wish to create. + # Index names must meet the following criteria: + # - Lowercase only + # - Cannot include `\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, ` `(space character),`,`, or`#` + # - Indices prior to 7.0 could contain a colon (`:`), but that has been deprecated and will not be supported in later versions + # - Cannot start with `-`, `_`, or `+` + # - Cannot be `.` or `..` + # - Cannot be longer than 255 bytes (note thtat it is bytes, so multi-byte characters will reach the limit faster) + # - Names starting with `.` are deprecated, except for hidden indices and internal indices managed by plugins (*Required*) + # @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. + # @option arguments [Time] :timeout Period to wait for a response. + # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operation. + # Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). Server default: 1. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The configuration for the index (`settings` and `mappings`) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-create # def create(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.create' } @@ -46,12 +83,12 @@ def create(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_PUT - path = "#{Utils.__listify(_index)}" + path = Utils.listify(_index).to_s params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/create_data_stream.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/create_data_stream.rb index 66da1e830c..4b910def2c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/create_data_stream.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/create_data_stream.rb @@ -15,21 +15,38 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Creates a data stream + # Create a data stream. + # You must have a matching index template with data stream enabled. # - # @option arguments [String] :name The name of the data stream - # @option arguments [Time] :timeout Specify timeout for acknowledging the cluster state update - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [String] :name Name of the data stream, which must meet the following criteria: + # Lowercase only; + # Cannot include `\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, `,`, `#`, `:`, or a space character; + # Cannot start with `-`, `_`, `+`, or `.ds-`; + # Cannot be `.` or `..`; + # Cannot be longer than 255 bytes. Multi-byte characters count towards this limit faster. (*Required*) + # @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. + # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-create-data-stream # def create_data_stream(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.create_data_stream' } @@ -49,7 +66,7 @@ def create_data_stream(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_PUT - path = "_data_stream/#{Utils.__listify(_name)}" + path = "_data_stream/#{Utils.listify(_name)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/create_from.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/create_from.rb new file mode 100644 index 0000000000..bd06905d43 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/create_from.rb @@ -0,0 +1,82 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. +module Elasticsearch + module API + 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*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body create_from + # + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-create-from + # + def create_from(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'indices.create_from' } + + defined_params = [:source, :dest].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'body' missing" unless arguments[:body] + raise ArgumentError, "Required argument 'source' missing" unless arguments[:source] + raise ArgumentError, "Required argument 'dest' missing" unless arguments[:dest] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _source = arguments.delete(:source) + + _dest = arguments.delete(:dest) + + method = Elasticsearch::API::HTTP_PUT + path = "_create_from/#{Utils.listify(_source)}/#{Utils.listify(_dest)}" + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/data_streams_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/data_streams_stats.rb index 4d7087632d..30e385d7db 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/data_streams_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/data_streams_stats.rb @@ -15,19 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Provides statistics on operations happening in a data stream. + # Get data stream stats. + # Get statistics for one or more data streams. # - # @option arguments [List] :name A comma-separated list of data stream names; use `_all` or empty string to perform the operation on all data streams + # @option arguments [String] :name Comma-separated list of data streams used to limit the request. + # Wildcard expressions (`*`) are supported. + # To target all data streams in a cluster, omit this parameter or use `*`. + # @option arguments [String, Array] :expand_wildcards Type of data stream that wildcard patterns can match. + # Supports comma-separated values, such as `open,hidden`. Server default: open. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-data-streams-stats-1 # def data_streams_stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.data_streams_stats' } @@ -46,11 +62,11 @@ def data_streams_stats(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _name - "_data_stream/#{Utils.__listify(_name)}/_stats" + "_data_stream/#{Utils.listify(_name)}/_stats" else '_data_stream/_stats' end - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete.rb index bb53aaa0cc..4bf575e161 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete.rb @@ -15,24 +15,48 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Deletes an index. + # Delete indices. + # Deleting an index deletes its documents, shards, and metadata. + # It does not delete related Kibana components, such as data views, visualizations, or dashboards. + # You cannot delete the current write index of a data stream. + # To delete the index, you must roll over the data stream so a new write index is created. + # You can then use the delete index API to delete the previous write index. # - # @option arguments [List] :index A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices - # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Time] :master_timeout Specify timeout for connection to master - # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false) - # @option arguments [Boolean] :allow_no_indices Ignore if a wildcard expression resolves to no concrete indices (default: false) - # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open, closed, or hidden indices (options: open, closed, hidden, none, all) + # @option arguments [String, Array] :index Comma-separated list of indices to delete. + # You cannot specify index aliases. + # By default, this parameter does not support wildcards (`*`) or `_all`. + # To use wildcards or `_all`, set the `action.destructive_requires_name` cluster setting to `false`. (*Required*) + # @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. Server default: true. + # @option arguments [String, Array] :expand_wildcards 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. + # Supports comma-separated values, such as `open,hidden`. Server default: open. + # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. + # @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. + # @option arguments [Time] :timeout Period to wait for a response. + # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-delete-index.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-delete # def delete(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.delete' } @@ -47,16 +71,16 @@ def delete(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_DELETE - path = "#{Utils.__listify(_index)}" + path = Utils.listify(_index).to_s params = Utils.process_params(arguments) if Array(arguments[:ignore]).include?(404) - Utils.__rescue_from_not_found do + Utils.rescue_from_not_found do Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_alias.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_alias.rb index abfd6ebed6..5275e8d369 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_alias.rb @@ -15,27 +15,43 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Deletes an alias. + # Delete an alias. + # Removes a data stream or index from an alias. # - # @option arguments [List] :index A comma-separated list of index names (supports wildcards); use `_all` for all indices - # @option arguments [List] :name A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices. - # @option arguments [Time] :timeout Explicit timestamp for the document - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [String, Array] :index Comma-separated list of data streams or indices used to limit the request. + # Supports wildcards (`*`). (*Required*) + # @option arguments [String, Array] :name Comma-separated list of aliases to remove. + # Supports wildcards (`*`). To remove all aliases, use `*` or `_all`. (*Required*) + # @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. + # @option arguments [Time] :timeout Period to wait for a response. + # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-delete-alias # def delete_alias(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.delete_alias' } - defined_params = %i[index name].each_with_object({}) do |variable, set_variables| + defined_params = [:index, :name].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -46,14 +62,14 @@ def delete_alias(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_DELETE - path = ("#{Utils.__listify(_index)}/_aliases/#{Utils.__listify(_name)}" if _index && _name) + path = ("#{Utils.listify(_index)}/_aliases/#{Utils.listify(_name)}" if _index && _name) params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_lifecycle.rb index a3dd50251c..1fa325fa8d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_lifecycle.rb @@ -15,22 +15,34 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Deletes the data stream lifecycle of the selected data streams. + # Delete data stream lifecycles. + # Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. # - # @option arguments [List] :name A comma-separated list of data streams of which the data stream lifecycle will be deleted; use `*` to get all data streams - # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) - # @option arguments [Time] :timeout Explicit timestamp for the document + # @option arguments [String, Array] :name A comma-separated list of data streams of which the data stream lifecycle will be deleted; use `*` to get all data streams (*Required*) + # @option arguments [String, Array] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [Time] :timeout Explicit timestamp for the document + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-delete-lifecycle.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-delete-data-lifecycle # def delete_data_lifecycle(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.delete_data_lifecycle' } @@ -50,7 +62,7 @@ def delete_data_lifecycle(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_DELETE - path = "_data_stream/#{Utils.__listify(_name)}/_lifecycle" + path = "_data_stream/#{Utils.listify(_name)}/_lifecycle" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream.rb index c773bbc37a..b3417376db 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_data_stream.rb @@ -15,21 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Deletes a data stream. + # Delete data streams. + # Deletes one or more data streams and their backing indices. # - # @option arguments [List] :name A comma-separated list of data streams to delete; use `*` to delete all data streams - # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [String, Array] :name Comma-separated list of data streams to delete. Wildcard (`*`) expressions are supported. (*Required*) + # @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. + # @option arguments [String, Array] :expand_wildcards Type of data stream that wildcard patterns can match. Supports comma-separated values,such as `open,hidden`. Server default: open. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-delete-data-stream # def delete_data_stream(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.delete_data_stream' } @@ -49,7 +61,7 @@ def delete_data_stream(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_DELETE - path = "_data_stream/#{Utils.__listify(_name)}" + path = "_data_stream/#{Utils.listify(_name)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_index_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_index_template.rb index e4e20fad6b..150bf439a3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_index_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_index_template.rb @@ -15,21 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Deletes an index template. + # Delete an index template. + # The provided may contain multiple template names separated by a comma. If multiple template + # names are specified then there is no wildcard support and the provided names should match completely with + # existing templates. # - # @option arguments [String] :name The name of the template - # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [String, Array] :name Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. (*Required*) + # @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. + # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-delete-template.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-delete-index-template # def delete_index_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.delete_index_template' } @@ -49,7 +63,7 @@ def delete_index_template(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_DELETE - path = "_index_template/#{Utils.__listify(_name)}" + path = "_index_template/#{Utils.listify(_name)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_template.rb index ec10ca44aa..c235ea40d3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/delete_template.rb @@ -15,21 +15,36 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Deletes an index template. + # Delete a legacy index template. + # IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. # - # @option arguments [String] :name The name of the template - # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [String] :name The name of the legacy index template to delete. + # Wildcard (`*`) expressions are supported. (*Required*) + # @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. + # @option arguments [Time] :timeout Period to wait for a response. + # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-delete-template-v1.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-delete-template # def delete_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.delete_template' } @@ -49,11 +64,11 @@ def delete_template(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_DELETE - path = "_template/#{Utils.__listify(_name)}" + path = "_template/#{Utils.listify(_name)}" params = Utils.process_params(arguments) if Array(arguments[:ignore]).include?(404) - Utils.__rescue_from_not_found do + Utils.rescue_from_not_found do Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/disk_usage.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/disk_usage.rb index cd3308a1b5..677b445f7e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/disk_usage.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/disk_usage.rb @@ -15,28 +15,52 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Analyzes the disk usage of each field of an index or data stream + # Analyze the index disk usage. + # Analyze the disk usage of each field of an index or data stream. + # This API might not support indices created in previous Elasticsearch versions. + # The result of a small index can be inaccurate as some parts of an index might not be analyzed by the API. + # NOTE: The total size of fields of the analyzed shards of the index in the response is usually smaller than the index `store_size` value because some small metadata files are ignored and some parts of data files might not be scanned by the API. + # Since stored fields are stored together in a compressed format, the sizes of stored fields are also estimates and can be inaccurate. + # The stored size of the `_id` field is likely underestimated while the `_source` field is overestimated. # 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] :index Comma-separated list of indices or data streams to analyze the disk usage - # @option arguments [Boolean] :run_expensive_tasks Must be set to [true] in order for the task to be performed. Defaults to false. - # @option arguments [Boolean] :flush Whether flush or not before analyzing the index disk usage. Defaults to true - # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) - # @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) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases used to limit the request. + # It’s recommended to execute this API with a single index (or the latest backing index of a data stream) as the API consumes resources significantly. (*Required*) + # @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`. Server default: true. + # @option arguments [String, Array] :expand_wildcards 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. + # Supports comma-separated values, such as `open,hidden`. Server default: open. + # @option arguments [Boolean] :flush If `true`, the API performs a flush before analysis. + # If `false`, the response may not include uncommitted data. Server default: true. + # @option arguments [Boolean] :ignore_unavailable If `true`, missing or closed indices are not included in the response. + # @option arguments [Boolean] :run_expensive_tasks Analyzing field disk usage is resource-intensive. + # To use the API, this parameter must be set to `true`. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-disk-usage.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-disk-usage # def disk_usage(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.disk_usage' } @@ -51,12 +75,12 @@ def disk_usage(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_POST - path = "#{Utils.__listify(_index)}/_disk_usage" + path = "#{Utils.listify(_index)}/_disk_usage" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/downsample.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/downsample.rb index b08ac1ecee..c1fe6df29e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/downsample.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/downsample.rb @@ -15,30 +15,47 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Downsample an index + # Downsample an index. + # Aggregate a time series (TSDS) index and store pre-computed statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped by a configured time interval. + # For example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index. + # All documents within an hour interval are summarized and stored as a single document in the downsample index. + # NOTE: Only indices in a time series data stream are supported. + # Neither field nor document level security can be defined on the source index. + # The source index must be read only (`index.blocks.write: true`). # 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] :index The index to downsample (*Required*) - # @option arguments [String] :target_index The name of the target index to store downsampled data (*Required*) + # @option arguments [String] :index Name of the time series index to downsample. (*Required*) + # @option arguments [String] :target_index Name of the index to create. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The downsampling configuration (*Required*) + # @option arguments [Hash] :body config # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/xpack-rollup.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-downsample # def downsample(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.downsample' } - defined_params = %i[index target_index].each_with_object({}) do |variable, set_variables| + defined_params = [:index, :target_index].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -50,15 +67,15 @@ def downsample(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) _index = arguments.delete(:index) _target_index = arguments.delete(:target_index) method = Elasticsearch::API::HTTP_POST - path = "#{Utils.__listify(_index)}/_downsample/#{Utils.__listify(_target_index)}" - params = {} + path = "#{Utils.listify(_index)}/_downsample/#{Utils.listify(_target_index)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists.rb index 34e9b34a54..9ba65463b3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists.rb @@ -15,25 +15,40 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Returns information about whether a particular index exists. + # Check indices. + # Check if one or more indices, index aliases, or data streams exist. # - # @option arguments [List] :index A comma-separated list of index names - # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) - # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false) - # @option arguments [Boolean] :allow_no_indices Ignore if a wildcard expression resolves to no concrete indices (default: false) - # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) - # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) - # @option arguments [Boolean] :include_defaults Whether to return all default setting for each of the indices. + # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases. Supports wildcards (`*`). (*Required*) + # @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. Server default: true. + # @option arguments [String, Array] :expand_wildcards 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. + # Supports comma-separated values, such as `open,hidden`. Server default: open. + # @option arguments [Boolean] :flat_settings If `true`, returns settings in flat format. + # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. + # @option arguments [Boolean] :include_defaults If `true`, return all default settings in the response. + # @option arguments [Boolean] :local If `true`, the request retrieves information from the local node only. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-exists.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-exists # def exists(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.exists' } @@ -48,15 +63,15 @@ def exists(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_HEAD - path = "#{Utils.__listify(_index)}" + path = Utils.listify(_index).to_s params = Utils.process_params(arguments) - Utils.__rescue_from_not_found do + Utils.rescue_from_not_found do perform_request(method, path, params, body, headers, request_opts).status == 200 end end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_alias.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_alias.rb index dc414c862e..97bf9231ef 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_alias.rb @@ -15,29 +15,46 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Returns information about whether a particular alias exists. + # Check aliases. + # Check if one or more data stream or index aliases exist. # - # @option arguments [List] :name A comma-separated list of alias names to return - # @option arguments [List] :index A comma-separated list of index names to filter aliases - # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) - # @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) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) - # @option arguments [Time] :master_timeout Timeout for waiting for new cluster state in case it is blocked + # @option arguments [String, Array] :name Comma-separated list of aliases to check. Supports wildcards (`*`). (*Required*) + # @option arguments [String, Array] :index Comma-separated list of data streams or indices used to limit the request. Supports wildcards (`*`). + # To target all data streams and indices, omit this parameter or use `*` or `_all`. + # @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. Server default: true. + # @option arguments [String, Array] :expand_wildcards 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. + # Supports comma-separated values, such as `open,hidden`. Server default: open. + # @option arguments [Boolean] :ignore_unavailable If `false`, requests that include a missing data stream or index in the target indices or data streams return an error. + # @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. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-exists-alias # def exists_alias(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.exists_alias' } - defined_params = %i[name index].each_with_object({}) do |variable, set_variables| + defined_params = [:name, :index].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -55,13 +72,13 @@ def exists_alias(arguments = {}) method = Elasticsearch::API::HTTP_HEAD path = if _index && _name - "#{Utils.__listify(_index)}/_alias/#{Utils.__listify(_name)}" + "#{Utils.listify(_index)}/_alias/#{Utils.listify(_name)}" else - "_alias/#{Utils.__listify(_name)}" + "_alias/#{Utils.listify(_name)}" end params = Utils.process_params(arguments) - Utils.__rescue_from_not_found do + Utils.rescue_from_not_found do perform_request(method, path, params, body, headers, request_opts).status == 200 end end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_index_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_index_template.rb index b7c2fbb12a..ee67b7b231 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_index_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_index_template.rb @@ -15,22 +15,34 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Returns information about whether a particular index template exists. + # Check index templates. + # Check whether index templates exist. # - # @option arguments [String] :name The name of the template - # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) + # @option arguments [String] :name Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. (*Required*) + # @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 [Boolean] :flat_settings If true, returns settings in flat format. + # @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. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/index-templates.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-exists-index-template # def exists_index_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.exists_index_template' } @@ -50,7 +62,7 @@ def exists_index_template(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_HEAD - path = "_index_template/#{Utils.__listify(_name)}" + path = "_index_template/#{Utils.listify(_name)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_template.rb index 3593eed264..121747f78d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/exists_template.rb @@ -15,22 +15,39 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Returns information about whether a particular index template exists. + # Check existence of index templates. + # Get information about whether index templates exist. + # Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + # IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. # - # @option arguments [List] :name The comma separated names of the index templates - # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) - # @option arguments [Time] :master_timeout Timeout for waiting for new cluster state in case it is blocked - # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) *Deprecated* + # @option arguments [String, Array] :name A comma-separated list of index template names used to limit the request. + # Wildcard (`*`) expressions are supported. (*Required*) + # @option arguments [Boolean] :flat_settings Indicates whether to use a flat format for the response. + # @option arguments [Boolean] :local Indicates whether to get information from the local node only. + # @option arguments [Time] :master_timeout The period to wait for the master node. + # If the master node is not available before the timeout expires, the request fails and returns an error. + # To indicate that the request should never timeout, set it to `-1`. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-template-exists-v1.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-exists-template # def exists_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.exists_template' } @@ -50,10 +67,10 @@ def exists_template(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_HEAD - path = "_template/#{Utils.__listify(_name)}" + path = "_template/#{Utils.listify(_name)}" params = Utils.process_params(arguments) - Utils.__rescue_from_not_found do + Utils.rescue_from_not_found do perform_request(method, path, params, body, headers, request_opts).status == 200 end end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/explain_data_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/explain_data_lifecycle.rb index 8e5ceca257..8c81a4f2f3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/explain_data_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/explain_data_lifecycle.rb @@ -15,21 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Retrieves information about the index's current data stream lifecycle, such as any potential encountered error, time since creation etc. + # Get the status for a data stream lifecycle. + # Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution. # - # @option arguments [String] :index The name of the index to explain + # @option arguments [String, Array] :index The name of the index to explain (*Required*) # @option arguments [Boolean] :include_defaults indicates if the API should return the default values the system uses for the index's lifecycle # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-explain-lifecycle.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-explain-data-lifecycle # def explain_data_lifecycle(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.explain_data_lifecycle' } @@ -44,12 +56,12 @@ def explain_data_lifecycle(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_GET - path = "#{Utils.__listify(_index)}/_lifecycle/explain" + path = "#{Utils.listify(_index)}/_lifecycle/explain" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/field_usage_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/field_usage_stats.rb index aaac263510..25c5027147 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/field_usage_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/field_usage_stats.rb @@ -15,27 +15,47 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Returns the field usage stats for each field of an index + # Get field usage stats. + # Get field usage information for each shard and field of an index. + # Field usage statistics are automatically captured when queries are running on a cluster. + # A shard-level search request that accesses a given field, even if multiple times during that request, is counted as a single use. + # The response body reports the per-shard usage count of the data structures that back the fields in the index. + # A given request will increment each count by a maximum value of 1, even if the request accesses the same field multiple times. # 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] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices - # @option arguments [List] :fields A comma-separated list of fields to include in the stats if only a subset of fields should be returned (supports wildcards) - # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) - # @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) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [String, Array] :index Comma-separated list or wildcard expression of index names used to limit the request. (*Required*) + # @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`. + # @option arguments [String, Array] :expand_wildcards 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. + # Supports comma-separated values, such as `open,hidden`. + # @option arguments [Boolean] :ignore_unavailable If `true`, missing or closed indices are not included in the response. + # @option arguments [String, Array] :fields Comma-separated list or wildcard expressions of fields to include in the statistics. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/field-usage-stats.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-field-usage-stats # def field_usage_stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.field_usage_stats' } @@ -50,12 +70,12 @@ def field_usage_stats(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_GET - path = "#{Utils.__listify(_index)}/_field_usage_stats" + path = "#{Utils.listify(_index)}/_field_usage_stats" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/flush.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/flush.rb index 0e92583735..274a20a321 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/flush.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/flush.rb @@ -15,24 +15,49 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Performs the flush operation on one or more indices. + # Flush data streams or indices. + # Flushing a data stream or index is the process of making sure that any data that is currently only stored in the transaction log is also permanently stored in the Lucene index. + # When restarting, Elasticsearch replays any unflushed operations from the transaction log into the Lucene index to bring it back into the state that it was in before the restart. + # Elasticsearch automatically triggers flushes as needed, using heuristics that trade off the size of the unflushed transaction log against the cost of performing each flush. + # After each operation has been flushed it is permanently stored in the Lucene index. + # This may mean that there is no need to maintain an additional copy of it in the transaction log. + # The transaction log is made up of multiple files, called generations, and Elasticsearch will delete any generation files when they are no longer needed, freeing up disk space. + # It is also possible to trigger a flush on one or more indices using the flush API, although it is rare for users to need to call this API directly. + # If you call the flush API after indexing some documents then a successful response indicates that Elasticsearch has flushed all the documents that were indexed before the flush API was called. # - # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string for all indices - # @option arguments [Boolean] :force Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal) - # @option arguments [Boolean] :wait_if_ongoing If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. The default is true. If set to false the flush will be skipped iff if another flush operation is already running. - # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) - # @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) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases to flush. + # Supports wildcards (`*`). + # To flush all data streams and indices, omit this parameter or use `*` or `_all`. + # @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. Server default: true. + # @option arguments [String, Array] :expand_wildcards 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. + # Supports comma-separated values, such as `open,hidden`. Server default: open. + # @option arguments [Boolean] :force If `true`, the request forces a flush even if there are no changes to commit to the index. Server default: true. + # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. + # @option arguments [Boolean] :wait_if_ongoing If `true`, the flush operation blocks until execution when another flush operation is running. + # If `false`, Elasticsearch returns an error if you request a flush when another flush operation is running. Server default: true. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-flush.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-flush # def flush(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.flush' } @@ -45,13 +70,13 @@ def flush(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_POST path = if _index - "#{Utils.__listify(_index)}/_flush" + "#{Utils.listify(_index)}/_flush" else '_flush' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/forcemerge.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/forcemerge.rb index 6ea744edc3..f957a80d92 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/forcemerge.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/forcemerge.rb @@ -15,26 +15,76 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Performs the force merge operation on one or more indices. + # Force a merge. + # Perform the force merge operation on the shards of one or more indices. + # For data streams, the API forces a merge on the shards of the stream's backing indices. + # Merging reduces the number of segments in each shard by merging some of them together and also frees up the space used by deleted documents. + # Merging normally happens automatically, but sometimes it is useful to trigger a merge manually. + # WARNING: We recommend force merging only a read-only index (meaning the index is no longer receiving writes). + # When documents are updated or deleted, the old version is not immediately removed but instead soft-deleted and marked with a "tombstone". + # These soft-deleted documents are automatically cleaned up during regular segment merges. + # But force merge can cause very large (greater than 5 GB) segments to be produced, which are not eligible for regular merges. + # So the number of soft-deleted documents can then grow rapidly, resulting in higher disk usage and worse search performance. + # If you regularly force merge an index receiving writes, this can also make snapshots more expensive, since the new documents can't be backed up incrementally. + # **Blocks during a force merge** + # Calls to this API block until the merge is complete (unless request contains `wait_for_completion=false`). + # If the client connection is lost before completion then the force merge process will continue in the background. + # Any new requests to force merge the same indices will also block until the ongoing force merge is complete. + # **Running force merge asynchronously** + # If the request contains `wait_for_completion=false`, Elasticsearch performs some preflight checks, launches the request, and returns a task you can use to get the status of the task. + # However, you can not cancel this task as the force merge task is not cancelable. + # Elasticsearch creates a record of this task as a document at `_tasks/`. + # When you are done with a task, you should delete the task document so Elasticsearch can reclaim the space. + # **Force merging multiple indices** + # You can force merge multiple indices with a single request by targeting: + # * One or more data streams that contain multiple backing indices + # * Multiple indices + # * One or more aliases + # * All data streams and indices in a cluster + # Each targeted shard is force-merged separately using the force_merge threadpool. + # By default each node only has a single `force_merge` thread which means that the shards on that node are force-merged one at a time. + # If you expand the `force_merge` threadpool on a node then it will force merge its shards in parallel + # Force merge makes the storage for the shard being merged temporarily increase, as it may require free space up to triple its size in case `max_num_segments parameter` is set to `1`, to rewrite all segments into a new one. + # **Data streams and time-based indices** + # Force-merging is useful for managing a data stream's older backing indices and other time-based indices, particularly after a rollover. + # In these cases, each index only receives indexing traffic for a certain period of time. + # Once an index receive no more writes, its shards can be force-merged to a single segment. + # This can be a good idea because single-segment shards can sometimes use simpler and more efficient data structures to perform searches. + # For example: + # + # ``` + # POST /.ds-my-data-stream-2099.03.07-000001/_forcemerge?max_num_segments=1 + # ``` # - # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices + # @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) + # @option arguments [String, Array] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. # @option arguments [Boolean] :flush Specify whether the index should be flushed after performing the operation (default: true) # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) - # @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) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) - # @option arguments [Number] :max_num_segments The number of segments the index should be merged into (default: dynamic) + # @option arguments [Integer] :max_num_segments The number of segments the index should be merged into (default: dynamic) # @option arguments [Boolean] :only_expunge_deletes Specify whether the operation should only expunge deleted documents # @option arguments [Boolean] :wait_for_completion Should the request wait until the force merge is completed. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-forcemerge.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-forcemerge # def forcemerge(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.forcemerge' } @@ -47,13 +97,13 @@ def forcemerge(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_POST path = if _index - "#{Utils.__listify(_index)}/_forcemerge" + "#{Utils.listify(_index)}/_forcemerge" else '_forcemerge' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get.rb index 33836e4e6c..99d0fef379 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get.rb @@ -15,27 +15,45 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Returns information about one or more indices. + # Get index information. + # Get information about one or more indices. For data streams, the API returns information about the + # stream’s backing indices. # - # @option arguments [List] :index A comma-separated list of index names - # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) - # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false) - # @option arguments [Boolean] :allow_no_indices Ignore if a wildcard expression resolves to no concrete indices (default: false) - # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) - # @option arguments [String] :features Return only information on specified index features (options: aliases, mappings, settings) - # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) - # @option arguments [Boolean] :include_defaults Whether to return all default setting for each of the indices. - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and index aliases used to limit the request. + # Wildcard expressions (*) are supported. (*Required*) + # @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. Server default: true. + # @option arguments [String, Array] :expand_wildcards Type of index that wildcard expressions can match. If the request can target data streams, this argument + # determines whether wildcard expressions match hidden data streams. Supports comma-separated values, + # such as open,hidden. Server default: open. + # @option arguments [Boolean] :flat_settings If true, returns settings in flat format. + # @option arguments [Boolean] :ignore_unavailable If false, requests that target a missing index return an error. + # @option arguments [Boolean] :include_defaults If true, return all default settings in the response. + # @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. + # @option arguments [String, Array] :features Return only information on specified index features Server default: ['aliases', 'mappings', 'settings']. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-index.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get # def get(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.get' } @@ -50,12 +68,12 @@ def get(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_GET - path = "#{Utils.__listify(_index)}" + path = Utils.listify(_index).to_s params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_alias.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_alias.rb index a216dd6c10..269a1b8393 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_alias.rb @@ -15,29 +15,49 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Returns an alias. + # Get aliases. + # Retrieves information for one or more data stream or index aliases. # - # @option arguments [List] :name A comma-separated list of alias names to return - # @option arguments [List] :index A comma-separated list of index names to filter aliases - # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) - # @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) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) - # @option arguments [Time] :master_timeout Timeout for waiting for new cluster state in case it is blocked + # @option arguments [String, Array] :name Comma-separated list of aliases to retrieve. + # Supports wildcards (`*`). + # To retrieve all aliases, omit this parameter or use `*` or `_all`. + # @option arguments [String, Array] :index Comma-separated list of data streams or indices used to limit the request. + # Supports wildcards (`*`). + # To target all data streams and indices, omit this parameter or use `*` or `_all`. + # @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. Server default: true. + # @option arguments [String, Array] :expand_wildcards 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. + # Supports comma-separated values, such as `open,hidden`. Server default: open. + # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. + # @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. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get-alias # def get_alias(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.get_alias' } - defined_params = %i[name index].each_with_object({}) do |variable, set_variables| + defined_params = [:name, :index].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -53,11 +73,11 @@ def get_alias(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _index && _name - "#{Utils.__listify(_index)}/_alias/#{Utils.__listify(_name)}" + "#{Utils.listify(_index)}/_alias/#{Utils.listify(_name)}" elsif _index - "#{Utils.__listify(_index)}/_alias" + "#{Utils.listify(_index)}/_alias" elsif _name - "_alias/#{Utils.__listify(_name)}" + "_alias/#{Utils.listify(_name)}" else '_alias' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_lifecycle.rb index a675850592..4a5f3a8917 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_lifecycle.rb @@ -15,22 +15,37 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Returns the data stream lifecycle of the selected data streams. + # Get data stream lifecycles. + # Get the data stream lifecycle configuration of one or more data streams. # - # @option arguments [List] :name A comma-separated list of data streams to get; use `*` to get all data streams - # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) - # @option arguments [Boolean] :include_defaults Return all relevant default configurations for the data stream (default: false) - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [String, Array] :name Comma-separated list of data streams to limit the request. + # Supports wildcards (`*`). + # To target all data streams, omit this parameter or use `*` or `_all`. (*Required*) + # @option arguments [String, Array] :expand_wildcards Type of data stream that wildcard patterns can match. + # Supports comma-separated values, such as `open,hidden`. Server default: open. + # @option arguments [Boolean] :include_defaults If `true`, return all default settings in the response. + # @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. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-get-lifecycle.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get-data-lifecycle # def get_data_lifecycle(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.get_data_lifecycle' } @@ -50,7 +65,7 @@ def get_data_lifecycle(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_GET - path = "_data_stream/#{Utils.__listify(_name)}/_lifecycle" + path = "_data_stream/#{Utils.listify(_name)}/_lifecycle" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_lifecycle_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_lifecycle_stats.rb index 3446984630..cd49bfbe0c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_lifecycle_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_lifecycle_stats.rb @@ -15,18 +15,30 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Get data stream lifecycle statistics. + # Get data stream lifecycle stats. + # Get statistics about the data streams that are managed by a data stream lifecycle. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-get-lifecycle-stats.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get-data-lifecycle-stats # def get_data_lifecycle_stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.get_data_lifecycle_stats' } @@ -34,11 +46,11 @@ def get_data_lifecycle_stats(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_lifecycle/stats' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream.rb index 5e1ff6ff08..2c1ab085f6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_data_stream.rb @@ -15,23 +15,37 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Returns data streams. + # Get data streams. + # Get information about one or more data streams. # - # @option arguments [List] :name A comma-separated list of data streams to get; use `*` to get all data streams - # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) - # @option arguments [Boolean] :include_defaults Return all relevant default configurations for the data stream (default: false) - # @option arguments [Time] :master_timeout Specify timeout for connection to master - # @option arguments [Boolean] :verbose Whether the maximum timestamp for each data stream should be calculated and returned (default: false) + # @option arguments [String, Array] :name Comma-separated list of data stream names used to limit the request. + # Wildcard (`*`) expressions are supported. If omitted, all data streams are returned. + # @option arguments [String, Array] :expand_wildcards Type of data stream that wildcard patterns can match. + # Supports comma-separated values, such as `open,hidden`. Server default: open. + # @option arguments [Boolean] :include_defaults If true, returns all relevant default configurations for the index template. + # @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. + # @option arguments [Boolean] :verbose Whether the maximum timestamp for each data stream should be calculated and returned. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get-data-stream # def get_data_stream(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.get_data_stream' } @@ -50,7 +64,7 @@ def get_data_stream(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _name - "_data_stream/#{Utils.__listify(_name)}" + "_data_stream/#{Utils.listify(_name)}" else '_data_stream' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_field_mapping.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_field_mapping.rb index f4aad0249d..cae3ab55b1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_field_mapping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_field_mapping.rb @@ -15,49 +15,70 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Returns mapping for one or more fields. + # Get mapping definitions. + # Retrieves mapping definitions for one or more fields. + # For data streams, the API retrieves field mappings for the stream’s backing indices. + # This API is useful if you don't need a complete mapping or if an index mapping contains a large number of fields. # - # @option arguments [List] :fields A comma-separated list of fields - # @option arguments [List] :index A comma-separated list of index names - # @option arguments [Boolean] :include_defaults Whether the default mapping values should be returned as well - # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) - # @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) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) - # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) + # @option arguments [String, Array] :fields Comma-separated list or wildcard expression of fields used to limit returned information. + # Supports wildcards (`*`). (*Required*) + # @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 [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. Server default: true. + # @option arguments [String, Array] :expand_wildcards 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. + # Supports comma-separated values, such as `open,hidden`. Server default: open. + # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. + # @option arguments [Boolean] :include_defaults If `true`, return all default settings in the response. + # @option arguments [Boolean] :local If `true`, the request retrieves information from the local node only. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-field-mapping.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get-mapping # def get_field_mapping(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.get_field_mapping' } - defined_params = %i[fields index].each_with_object({}) do |variable, set_variables| + defined_params = [:fields, :index].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? - arguments = arguments.clone - _fields = arguments.delete(:field) || arguments.delete(:fields) - raise ArgumentError, "Required argument 'field' missing" unless _fields + raise ArgumentError, "Required argument 'fields' missing" unless arguments[:fields] + arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil + + _fields = arguments.delete(:fields) _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_GET path = if _index && _fields - "#{Utils.__listify(_index)}/_mapping/field/#{Utils.__listify(_fields)}" + "#{Utils.listify(_index)}/_mapping/field/#{Utils.listify(_fields)}" else - "_mapping/field/#{Utils.__listify(_fields)}" + "_mapping/field/#{Utils.listify(_fields)}" end params = Utils.process_params(arguments) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_index_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_index_template.rb index a56bd60806..3155f2c1c0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_index_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_index_template.rb @@ -15,23 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Returns an index template. + # Get index templates. + # Get information about one or more index templates. # - # @option arguments [String] :name A pattern that returned template names must match - # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) - # @option arguments [Time] :master_timeout Timeout for waiting for new cluster state in case it is blocked - # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) *Deprecated* - # @option arguments [Boolean] :include_defaults Return all relevant default configurations for the index template (default: false) + # @option arguments [String] :name Comma-separated list of index template names used to limit the request. Wildcard (*) expressions are supported. + # @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 [Boolean] :flat_settings If true, returns settings in flat format. + # @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. + # @option arguments [Boolean] :include_defaults If true, returns all relevant default configurations for the index template. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-template.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get-index-template # def get_index_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.get_index_template' } @@ -50,7 +62,7 @@ def get_index_template(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _name - "_index_template/#{Utils.__listify(_name)}" + "_index_template/#{Utils.listify(_name)}" else '_index_template' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_mapping.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_mapping.rb index 8160fd20b3..97d3e9fa3b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_mapping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_mapping.rb @@ -15,24 +15,42 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Returns mappings for one or more indices. + # Get mapping definitions. + # For data streams, the API retrieves mappings for the stream’s backing indices. # - # @option arguments [List] :index A comma-separated list of index names - # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) - # @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) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) - # @option arguments [Time] :master_timeout Specify timeout for connection to master - # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) *Deprecated* + # @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 [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. Server default: true. + # @option arguments [String, Array] :expand_wildcards 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. + # Supports comma-separated values, such as `open,hidden`. Server default: open. + # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. + # @option arguments [Boolean] :local If `true`, the request retrieves information from the local node only. + # @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. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-mapping.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get-mapping # def get_mapping(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.get_mapping' } @@ -45,13 +63,13 @@ def get_mapping(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_GET path = if _index - "#{Utils.__listify(_index)}/_mapping" + "#{Utils.listify(_index)}/_mapping" else '_mapping' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/get_rollup_index_caps.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_migrate_reindex_status.rb similarity index 53% rename from elasticsearch-api/lib/elasticsearch/api/actions/rollup/get_rollup_index_caps.rb rename to elasticsearch-api/lib/elasticsearch/api/actions/indices/get_migrate_reindex_status.rb index d530edc59f..be605768e8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/get_rollup_index_caps.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_migrate_reindex_status.rb @@ -15,26 +15,38 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API - module Rollup + module Indices module Actions - # Returns the rollup capabilities of all jobs inside of a rollup index (e.g. the index where rollup data is stored). + # Get the migration reindexing status. + # Get the status of 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] :index The rollup index or index pattern to obtain rollup capabilities from. + # @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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-get-rollup-index-caps.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-migration # - def get_rollup_index_caps(arguments = {}) - request_opts = { endpoint: arguments[:endpoint] || 'rollup.get_rollup_index_caps' } + def get_migrate_reindex_status(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'indices.get_migrate_reindex_status' } defined_params = [:index].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) @@ -46,13 +58,13 @@ def get_rollup_index_caps(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_GET - path = "#{Utils.__listify(_index)}/_rollup/data" - params = {} + path = "_migration/reindex/#{Utils.listify(_index)}/_status" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_settings.rb index a388991927..5fefeac991 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_settings.rb @@ -15,32 +15,56 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Returns settings for one or more indices. + # Get index settings. + # Get setting information for one or more indices. + # For data streams, it returns setting information for the stream's backing indices. # - # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices - # @option arguments [List] :name The name of the settings that should be included - # @option arguments [Time] :master_timeout Specify timeout for connection to master - # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) - # @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) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) - # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) - # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) - # @option arguments [Boolean] :include_defaults Whether to return all default setting for each of the indices. + # @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] :name Comma-separated list or wildcard expression of settings to retrieve. + # @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`. Server default: true. + # @option arguments [String, Array] :expand_wildcards 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. + # Supports comma-separated values, such as `open,hidden`. Server default: open. + # @option arguments [Boolean] :flat_settings If `true`, returns settings in flat format. + # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. + # @option arguments [Boolean] :include_defaults If `true`, return all default settings in the response. + # @option arguments [Boolean] :local If `true`, the request retrieves information from the local node only. If + # `false`, 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. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-settings.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get-settings # def get_settings(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.get_settings' } - defined_params = %i[index name].each_with_object({}) do |variable, set_variables| + defined_params = [:index, :name].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -48,7 +72,7 @@ def get_settings(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) @@ -56,11 +80,11 @@ def get_settings(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _index && _name - "#{Utils.__listify(_index)}/_settings/#{Utils.__listify(_name)}" + "#{Utils.listify(_index)}/_settings/#{Utils.listify(_name)}" elsif _index - "#{Utils.__listify(_index)}/_settings" + "#{Utils.listify(_index)}/_settings" elsif _name - "_settings/#{Utils.__listify(_name)}" + "_settings/#{Utils.listify(_name)}" else '_settings' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_template.rb index 8c15a38ae5..750adb9567 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/get_template.rb @@ -15,22 +15,38 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Returns an index template. + # Get legacy index templates. + # Get information about one or more index templates. + # IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. # - # @option arguments [List] :name The comma separated names of the index templates - # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) - # @option arguments [Time] :master_timeout Timeout for waiting for new cluster state in case it is blocked - # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) *Deprecated* + # @option arguments [String, Array] :name Comma-separated list of index template names used to limit the request. + # Wildcard (`*`) expressions are supported. + # To return all index templates, omit this parameter or use a value of `_all` or `*`. + # @option arguments [Boolean] :flat_settings If `true`, returns settings in flat format. + # @option arguments [Boolean] :local If `true`, the request retrieves information from the local node only. + # @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. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-template-v1.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-get-template # def get_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.get_template' } @@ -49,7 +65,7 @@ def get_template(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _name - "_template/#{Utils.__listify(_name)}" + "_template/#{Utils.listify(_name)}" else '_template' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/migrate_reindex.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/migrate_reindex.rb new file mode 100644 index 0000000000..41dab6fe5d --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/migrate_reindex.rb @@ -0,0 +1,71 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. +module Elasticsearch + module API + module Indices + module Actions + # Reindex legacy backing indices. + # Reindex all legacy backing indices for a data stream. + # This operation occurs in a persistent task. + # The persistent task ID is returned immediately and the reindexing work is completed in that task. + # 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 [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body reindex + # + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-migrate-reindex + # + def migrate_reindex(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'indices.migrate_reindex' } + + raise ArgumentError, "Required argument 'body' missing" unless arguments[:body] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + method = Elasticsearch::API::HTTP_POST + path = '_migration/reindex' + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/migrate_to_data_stream.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/migrate_to_data_stream.rb index 7b70036ced..d8dafb41a7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/migrate_to_data_stream.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/migrate_to_data_stream.rb @@ -15,21 +15,42 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Migrates an alias to a data stream + # Convert an index alias to a data stream. + # Converts an index alias to a data stream. + # You must have a matching index template that is data stream enabled. + # The alias must meet the following criteria: + # The alias must have a write index; + # All indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type; + # The alias must not have any filters; + # The alias must not use custom routing. + # If successful, the request removes the alias and creates a data stream with the same name. + # The indices for the alias become hidden backing indices for the stream. + # The write index for the alias becomes the write index for the stream. # - # @option arguments [String] :name The name of the alias to migrate - # @option arguments [Time] :timeout Specify timeout for acknowledging the cluster state update - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [String] :name Name of the index alias to convert to a data stream. (*Required*) + # @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. + # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-migrate-to-data-stream # def migrate_to_data_stream(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.migrate_to_data_stream' } @@ -49,7 +70,7 @@ def migrate_to_data_stream(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_POST - path = "_data_stream/_migrate/#{Utils.__listify(_name)}" + path = "_data_stream/_migrate/#{Utils.listify(_name)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/modify_data_stream.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/modify_data_stream.rb index eb8dedc08e..8663477ffc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/modify_data_stream.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/modify_data_stream.rb @@ -15,19 +15,31 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Modifies a data stream + # Update data streams. + # Performs one or more data stream modification actions in a single atomic operation. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The data stream modifications (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-modify-data-stream # def modify_data_stream(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.modify_data_stream' } @@ -37,11 +49,11 @@ def modify_data_stream(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_data_stream/_modify' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/open.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/open.rb index b1b6844cc0..8ad0db3e11 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/open.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/open.rb @@ -15,25 +15,62 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Opens an index. + # Open a closed index. + # For data streams, the API opens any closed backing indices. + # A closed index is blocked for read/write operations and does not allow all operations that opened indices allow. + # It is not possible to index documents or to search for documents in a closed index. + # This allows closed indices to not have to maintain internal data structures for indexing or searching documents, resulting in a smaller overhead on the cluster. + # When opening or closing an index, the master is responsible for restarting the index shards to reflect the new state of the index. + # The shards will then go through the normal recovery process. + # The data of opened or closed indices is automatically replicated by the cluster to ensure that enough shard copies are safely kept around at all times. + # You can open and close multiple indices. + # An error is thrown if the request explicitly refers to a missing index. + # This behavior can be turned off by using the `ignore_unavailable=true` parameter. + # By default, you must explicitly name the indices you are opening or closing. + # To open or close indices with `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to `false`. + # This setting can also be changed with the cluster update settings API. + # Closed indices consume a significant amount of disk-space which can cause problems in managed environments. + # Closing indices can be turned off with the cluster settings API by setting `cluster.indices.close.enable` to `false`. + # Because opening or closing an index allocates its shards, the `wait_for_active_shards` setting on index creation applies to the `_open` and `_close` index actions as well. # - # @option arguments [List] :index A comma separated list of indices to open - # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Time] :master_timeout Specify timeout for connection to master - # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) - # @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) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) - # @option arguments [String] :wait_for_active_shards Sets the number of active shards to wait for before the operation returns. + # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases used to limit the request. + # Supports wildcards (`*`). + # By default, you must explicitly name the indices you using to limit the request. + # To limit a request using `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to false. + # You can update this setting in the `elasticsearch.yml` file or using the cluster update settings API. (*Required*) + # @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. Server default: true. + # @option arguments [String, Array] :expand_wildcards 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. + # Supports comma-separated values, such as `open,hidden`. Server default: open. + # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. + # @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. + # @option arguments [Time] :timeout Period to wait for a response. + # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operation. + # Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). Server default: 1. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-open-close.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-open # def open(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.open' } @@ -48,12 +85,12 @@ def open(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_POST - path = "#{Utils.__listify(_index)}/_open" + path = "#{Utils.listify(_index)}/_open" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/promote_data_stream.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/promote_data_stream.rb index 1a55479ee6..e7eae8c8d3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/promote_data_stream.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/promote_data_stream.rb @@ -15,20 +15,39 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Promotes a data stream from a replicated data stream managed by CCR to a regular data stream + # Promote a data stream. + # Promote a data stream from a replicated data stream managed by cross-cluster replication (CCR) to a regular data stream. + # With CCR auto following, a data stream from a remote cluster can be replicated to the local cluster. + # These data streams can't be rolled over in the local cluster. + # These replicated data streams roll over only if the upstream data stream rolls over. + # In the event that the remote cluster is no longer available, the data stream in the local cluster can be promoted to a regular data stream, which allows these data streams to be rolled over in the local cluster. + # NOTE: When promoting a data stream, ensure the local cluster has a data stream enabled index template that matches the data stream. + # If this is missing, the data stream will not be able to roll over until a matching index template is created. + # This will affect the lifecycle management of the data stream and interfere with the data stream size and retention. # - # @option arguments [String] :name The name of the data stream - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [String] :name The name of the data stream (*Required*) + # @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. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-promote-data-stream # def promote_data_stream(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.promote_data_stream' } @@ -48,7 +67,7 @@ def promote_data_stream(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_POST - path = "_data_stream/_promote/#{Utils.__listify(_name)}" + path = "_data_stream/_promote/#{Utils.listify(_name)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_alias.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_alias.rb index d18dce3386..d5b5e865e2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_alias.rb @@ -15,28 +15,46 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Creates or updates an alias. + # Create or update an alias. + # Adds a data stream or index to an alias. # - # @option arguments [List] :index A comma-separated list of index names the alias should point to (supports wildcards); use `_all` to perform the operation on all indices. - # @option arguments [String] :name The name of the alias to be created or updated - # @option arguments [Time] :timeout Explicit timestamp for the document - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [String, Array] :index Comma-separated list of data streams or indices to add. + # Supports wildcards (`*`). + # Wildcard patterns that match both data streams and indices return an error. (*Required*) + # @option arguments [String] :name Alias to update. + # If the alias doesn’t exist, the request creates it. + # Index alias names support date math. (*Required*) + # @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. + # @option arguments [Time] :timeout Period to wait for a response. + # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The settings for the alias, such as `routing` or `filter` + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-put-alias # def put_alias(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.put_alias' } - defined_params = %i[index name].each_with_object({}) do |variable, set_variables| + defined_params = [:index, :name].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -47,14 +65,14 @@ def put_alias(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) _index = arguments.delete(:index) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_PUT - path = ("#{Utils.__listify(_index)}/_aliases/#{Utils.__listify(_name)}" if _index && _name) + path = ("#{Utils.listify(_index)}/_aliases/#{Utils.listify(_name)}" if _index && _name) params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_lifecycle.rb index 2f03fa0bd3..b287211455 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_data_lifecycle.rb @@ -15,23 +15,41 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Updates the data stream lifecycle of the selected data streams. + # Update data stream lifecycles. + # Update the data stream lifecycle of the specified data streams. # - # @option arguments [List] :name A comma-separated list of data streams whose lifecycle will be updated; use `*` to set the lifecycle to all data streams - # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) - # @option arguments [Time] :timeout Explicit timestamp for the document - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [String, Array] :name Comma-separated list of data streams used to limit the request. + # Supports wildcards (`*`). + # To target all data streams use `*` or `_all`. (*Required*) + # @option arguments [String, Array] :expand_wildcards Type of data stream that wildcard patterns can match. + # Supports comma-separated values, such as `open,hidden`. Server default: open. + # @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. + # @option arguments [Time] :timeout Period to wait for a response. + # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The data stream lifecycle configuration that consist of the data retention + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-put-lifecycle.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-put-data-lifecycle # def put_data_lifecycle(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.put_data_lifecycle' } @@ -51,7 +69,7 @@ def put_data_lifecycle(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_PUT - path = "_data_stream/#{Utils.__listify(_name)}/_lifecycle" + path = "_data_stream/#{Utils.listify(_name)}/_lifecycle" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_index_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_index_template.rb index 061f55edbc..3792d6ac6a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_index_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_index_template.rb @@ -15,23 +15,55 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Creates or updates an index template. + # Create or update an index template. + # Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + # Elasticsearch applies templates to new indices based on an wildcard pattern that matches the index name. + # Index templates are applied during data stream or index creation. + # For data streams, these settings and mappings are applied when the stream's backing indices are created. + # Settings and mappings specified in a create index API request override any settings or mappings specified in an index template. + # Changes to index templates do not affect existing indices, including the existing backing indices of a data stream. + # You can use C-style `/* *\/` block comments in index templates. + # You can include comments anywhere in the request body, except before the opening curly bracket. + # **Multiple matching templates** + # If multiple index templates match the name of a new index or data stream, the template with the highest priority is used. + # Multiple templates with overlapping index patterns at the same priority are not allowed and an error will be thrown when attempting to create a template matching an existing index template at identical priorities. + # **Composing aliases, mappings, and settings** + # When multiple component templates are specified in the `composed_of` field for an index template, they are merged in the order specified, meaning that later component templates override earlier component templates. + # Any mappings, settings, or aliases from the parent index template are merged in next. + # Finally, any configuration on the index request itself is merged. + # Mapping definitions are merged recursively, which means that later mapping components can introduce new field mappings and update the mapping configuration. + # If a field mapping is already contained in an earlier component, its definition will be completely overwritten by the later one. + # This recursive merging strategy applies not only to field mappings, but also root options like `dynamic_templates` and `meta`. + # If an earlier component contains a `dynamic_templates` block, then by default new `dynamic_templates` entries are appended onto the end. + # If an entry already exists with the same key, then it is overwritten by the new definition. # - # @option arguments [String] :name The name of the template - # @option arguments [Boolean] :create Whether the index template should only be added if new or can also replace an existing one + # @option arguments [String] :name Index or template name (*Required*) + # @option arguments [Boolean] :create If `true`, this request cannot replace or update existing index templates. + # @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. # @option arguments [String] :cause User defined reason for creating/updating the index template - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The template definition (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-put-template.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-put-index-template # def put_index_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.put_index_template' } @@ -52,7 +84,7 @@ def put_index_template(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_PUT - path = "_index_template/#{Utils.__listify(_name)}" + path = "_index_template/#{Utils.listify(_name)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_mapping.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_mapping.rb index c0c85affa7..d7532504e6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_mapping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_mapping.rb @@ -15,26 +15,52 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Updates the index mappings. + # Update field mappings. + # Add new fields to an existing data stream or index. + # You can use the update mapping API to: + # - Add a new field to an existing index + # - Update mappings for multiple indices in a single request + # - Add new properties to an object field + # - Enable multi-fields for an existing field + # - Update supported mapping parameters + # - Change a field's mapping using reindexing + # - Rename a field using a field alias + # Learn how to use the update mapping API with practical examples in the {https://www.elastic.co/docs/manage-data/data-store/mapping/update-mappings-examples Update mapping API examples} guide. # - # @option arguments [List] :index A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices. - # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Time] :master_timeout Specify timeout for connection to master - # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) - # @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) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) - # @option arguments [Boolean] :write_index_only When true, applies mappings only to the write index of an alias or data stream + # @option arguments [String, Array] :index A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices. (*Required*) + # @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. Server default: true. + # @option arguments [String, Array] :expand_wildcards 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. + # Supports comma-separated values, such as `open,hidden`. Server default: open. + # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. + # @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. + # @option arguments [Time] :timeout Period to wait for a response. + # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :write_index_only If `true`, the mappings are applied only to the current write index for the target. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The mapping definition (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-put-mapping.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-put-mapping # def put_mapping(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.put_mapping' } @@ -50,12 +76,12 @@ def put_mapping(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_PUT - path = "#{Utils.__listify(_index)}/_mapping" + path = "#{Utils.listify(_index)}/_mapping" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_settings.rb index 887c817ab4..f0ee35cb5e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_settings.rb @@ -15,28 +15,107 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Updates the index settings. + # Update index settings. + # Changes dynamic index settings in real time. + # For data streams, index setting changes are applied to all backing indices by default. + # To revert a setting to the default value, use a null value. + # The list of per-index settings that can be updated dynamically on live indices can be found in index settings documentation. + # To preserve existing settings from being updated, set the `preserve_existing` parameter to `true`. + # For performance optimization during bulk indexing, you can disable the refresh interval. + # Refer to {https://www.elastic.co/docs/deploy-manage/production-guidance/optimize-performance/indexing-speed#disable-refresh-interval disable refresh interval} for an example. + # There are multiple valid ways to represent index settings in the request body. You can specify only the setting, for example: + # + # ``` + # { + # "number_of_replicas": 1 + # } + # ``` + # + # Or you can use an `index` setting object: + # + # ``` + # { + # "index": { + # "number_of_replicas": 1 + # } + # } + # ``` + # + # Or you can use dot annotation: + # + # ``` + # { + # "index.number_of_replicas": 1 + # } + # ``` + # + # Or you can embed any of the aforementioned options in a `settings` object. For example: + # + # ``` + # { + # "settings": { + # "index": { + # "number_of_replicas": 1 + # } + # } + # } + # ``` + # + # NOTE: You can only define new analyzers on closed indices. + # To add an analyzer, you must close the index, define the analyzer, and reopen the index. + # You cannot close the write index of a data stream. + # To update the analyzer for a data stream's write index and future backing indices, update the analyzer in the index template used by the stream. + # Then roll over the data stream to apply the new analyzer to the stream's write index and future backing indices. + # This affects searches and any new data added to the stream after the rollover. + # However, it does not affect the data stream's backing indices or their existing data. + # To change the analyzer for existing backing indices, you must create a new data stream and reindex your data into it. + # Refer to {https://www.elastic.co/docs/manage-data/data-store/text-analysis/specify-an-analyzer#update-analyzers-on-existing-indices updating analyzers on existing indices} for step-by-step examples. # - # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices - # @option arguments [Time] :master_timeout Specify timeout for connection to master - # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Boolean] :preserve_existing Whether to update existing settings. If set to `true` existing settings on an index remain unchanged, the default is `false` - # @option arguments [Boolean] :reopen Whether to close and reopen the index to apply non-dynamic settings. If set to `true` the indices to which the settings are being applied will be closed temporarily and then reopened in order to apply the changes. The default is `false` - # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) - # @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) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) - # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) + # @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 [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`. + # @option arguments [String, Array] :expand_wildcards 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. Supports comma-separated values, such as + # `open,hidden`. Server default: open. + # @option arguments [Boolean] :flat_settings If `true`, returns settings in flat format. + # @option arguments [Boolean] :ignore_unavailable If `true`, returns settings in flat format. + # @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. + # @option arguments [Boolean] :preserve_existing If `true`, existing index settings remain unchanged. + # @option arguments [Boolean] :reopen Whether to close and reopen the index to apply non-dynamic settings. + # If set to `true` the indices to which the settings are being applied + # will be closed temporarily and then reopened in order to apply the changes. + # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the + # timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The index settings to be updated (*Required*) + # @option arguments [Hash] :body settings # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-update-settings.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-put-settings # def put_settings(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.put_settings' } @@ -51,13 +130,13 @@ def put_settings(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_PUT path = if _index - "#{Utils.__listify(_index)}/_settings" + "#{Utils.listify(_index)}/_settings" else '_settings' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_template.rb index 93888e5236..fe0395cba3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/put_template.rb @@ -15,23 +15,52 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Creates or updates an index template. + # Create or update a legacy index template. + # Index templates define settings, mappings, and aliases that can be applied automatically to new indices. + # Elasticsearch applies templates to new indices based on an index pattern that matches the index name. + # IMPORTANT: This documentation is about legacy index templates, which are deprecated and will be replaced by the composable templates introduced in Elasticsearch 7.8. + # Composable templates always take precedence over legacy templates. + # If no composable template matches a new index, matching legacy templates are applied according to their order. + # Index templates are only applied during index creation. + # Changes to index templates do not affect existing indices. + # Settings and mappings specified in create index API requests override any settings or mappings specified in an index template. + # You can use C-style `/* *\/` block comments in index templates. + # You can include comments anywhere in the request body, except before the opening curly bracket. + # **Indices matching multiple templates** + # Multiple index templates can potentially match an index, in this case, both the settings and mappings are merged into the final configuration of the index. + # The order of the merging can be controlled using the order parameter, with lower order being applied first, and higher orders overriding them. + # NOTE: Multiple matching templates with the same order value will result in a non-deterministic merging order. # - # @option arguments [String] :name The name of the template - # @option arguments [Number] :order The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers) - # @option arguments [Boolean] :create Whether the index template should only be added if new or can also replace an existing one - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [String] :name The name of the template (*Required*) + # @option arguments [Boolean] :create If true, this request cannot replace or update existing index templates. + # @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. + # @option arguments [Integer] :order Order in which Elasticsearch applies this template if index + # matches multiple templates.Templates with lower 'order' values are merged first. Templates with higher + # 'order' values are merged later, overriding templates with lower values. + # @option arguments [String] :cause User defined reason for creating/updating the index template + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The template definition (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-templates-v1.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-put-template # def put_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.put_template' } @@ -52,7 +81,7 @@ def put_template(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_PUT - path = "_template/#{Utils.__listify(_name)}" + path = "_template/#{Utils.listify(_name)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/recovery.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/recovery.rb index c599681e96..936848c450 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/recovery.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/recovery.rb @@ -15,21 +15,56 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Returns information about ongoing index shard recoveries. + # Get index recovery information. + # Get information about ongoing and completed shard recoveries for one or more indices. + # For data streams, the API returns information for the stream's backing indices. + # All recoveries, whether ongoing or complete, are kept in the cluster state and may be reported on at any time. + # Shard recovery is the process of initializing a shard copy, such as restoring a primary shard from a snapshot or creating a replica shard from a primary shard. + # When a shard recovery completes, the recovered shard is available for search and indexing. + # Recovery automatically occurs during the following processes: + # * When creating an index for the first time. + # * When a node rejoins the cluster and starts up any missing primary shard copies using the data that it holds in its data path. + # * Creation of new replica shard copies from the primary. + # * Relocation of a shard copy to a different node in the same cluster. + # * A snapshot restore operation. + # * A clone, shrink, or split operation. + # You can determine the cause of a shard recovery using the recovery or cat recovery APIs. + # The index recovery API reports information about completed recoveries only for shard copies that currently exist in the cluster. + # It only reports the last recovery for each shard copy and does not report historical information about earlier recoveries, nor does it report information about the recoveries of shard copies that no longer exist. + # This means that if a shard copy completes a recovery and then Elasticsearch relocates it onto a different node then the information about the original recovery will not be shown in the recovery API. # - # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices - # @option arguments [Boolean] :detailed Whether to display detailed information about shard recovery - # @option arguments [Boolean] :active_only Display only those recoveries that are currently on-going + # @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 [Boolean] :active_only If `true`, the response only includes ongoing shard recoveries. + # @option arguments [Boolean] :detailed If `true`, the response includes detailed information about shard recoveries. + # @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. Server default: true. + # @option arguments [String, Array] :expand_wildcards 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. + # Supports comma-separated values, such as `open,hidden`. Server default: open. + # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-recovery.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-recovery # def recovery(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.recovery' } @@ -42,13 +77,13 @@ def recovery(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_GET path = if _index - "#{Utils.__listify(_index)}/_recovery" + "#{Utils.listify(_index)}/_recovery" else '_recovery' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/refresh.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/refresh.rb index 732d10d415..6825ecfbf4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/refresh.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/refresh.rb @@ -15,22 +15,47 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Performs the refresh operation in one or more indices. + # Refresh an index. + # A refresh makes recent operations performed on one or more indices available for search. + # For data streams, the API runs the refresh operation on the stream’s backing indices. + # By default, Elasticsearch periodically refreshes indices every second, but only on indices that have received one search request or more in the last 30 seconds. + # You can change this default interval with the `index.refresh_interval` setting. + # Refresh requests are synchronous and do not return a response until the refresh operation completes. + # Refreshes are resource-intensive. + # To ensure good cluster performance, it's recommended to wait for Elasticsearch's periodic refresh rather than performing an explicit refresh when possible. + # If your application workflow indexes documents and then runs a search to retrieve the indexed document, it's recommended to use the index API's `refresh=wait_for` query parameter option. + # This option ensures the indexing operation waits for a periodic refresh before running the search. # - # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices - # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) - # @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) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @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 [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. Server default: true. + # @option arguments [String, Array] :expand_wildcards 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. + # Supports comma-separated values, such as `open,hidden`. Server default: open. + # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-refresh.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-refresh # def refresh(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.refresh' } @@ -43,13 +68,13 @@ def refresh(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_POST path = if _index - "#{Utils.__listify(_index)}/_refresh" + "#{Utils.listify(_index)}/_refresh" else '_refresh' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/reload_search_analyzers.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/reload_search_analyzers.rb index 3fb1dcf414..37253276cb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/reload_search_analyzers.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/reload_search_analyzers.rb @@ -15,23 +15,44 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Reloads an index's search analyzers and their resources. + # Reload search analyzers. + # Reload an index's search analyzers and their resources. + # For data streams, the API reloads search analyzers and resources for the stream's backing indices. + # IMPORTANT: After reloading the search analyzers you should clear the request cache to make sure it doesn't contain responses derived from the previous versions of the analyzer. + # You can use the reload search analyzers API to pick up changes to synonym files used in the `synonym_graph` or `synonym` token filter of a search analyzer. + # To be eligible, the token filter must have an `updateable` flag of `true` and only be used in search analyzers. + # NOTE: This API does not perform a reload for each shard of an index. + # Instead, it performs a reload for each node containing index shards. + # As a result, the total shard count returned by the API can differ from the number of index shards. + # Because reloading affects every node with an index shard, it is important to update the synonym file on every data node in the cluster--including nodes that don't contain a shard replica--before using this API. + # This ensures the synonym file is updated everywhere in the cluster in case shards are relocated in the future. # - # @option arguments [List] :index A comma-separated list of index names to reload analyzers for - # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) + # @option arguments [String, Array] :index A comma-separated list of index names to reload analyzers for (*Required*) # @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) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) - # @option arguments [String] :resource changed resource to reload analyzers from if applicable + # @option arguments [String, Array] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. + # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) + # @option arguments [String] :resource Changed resource to reload analyzers from if applicable + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-reload-analyzers.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-reload-search-analyzers # def reload_search_analyzers(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.reload_search_analyzers' } @@ -46,12 +67,12 @@ def reload_search_analyzers(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_GET - path = "#{Utils.__listify(_index)}/_reload_search_analyzers" + path = "#{Utils.listify(_index)}/_reload_search_analyzers" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_cluster.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_cluster.rb index 9f399ef567..e31945866b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_cluster.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_cluster.rb @@ -15,23 +15,82 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Resolves the specified index expressions to return information about each cluster, including the local cluster, if included. + # Resolve the cluster. + # Resolve the specified index expressions to return information about each cluster, including the local "querying" cluster, if included. + # If no index expression is provided, the API will return information about all the remote clusters that are configured on the querying cluster. + # This endpoint is useful before doing a cross-cluster search in order to determine which remote clusters should be included in a search. + # You use the same index expression with this endpoint as you would for cross-cluster search. + # Index and cluster exclusions are also supported with this endpoint. + # For each cluster in the index expression, information is returned about: + # * Whether the querying ("local") cluster is currently connected to each remote cluster specified in the index expression. Note that this endpoint actively attempts to contact the remote clusters, unlike the `remote/info` endpoint. + # * Whether each remote cluster is configured with `skip_unavailable` as `true` or `false`. + # * Whether there are any indices, aliases, or data streams on that cluster that match the index expression. + # * Whether the search is likely to have errors returned when you do the cross-cluster search (including any authorization errors if you do not have permission to query the index). + # * Cluster version information, including the Elasticsearch server version. + # For example, `GET /_resolve/cluster/my-index-*,cluster*:my-index-*` returns information about the local cluster and all remotely configured clusters that start with the alias `cluster*`. + # Each cluster returns information about whether it has any indices, aliases or data streams that match `my-index-*`.The ability to query without an index expression was added in version 8.18, so when + # querying remote clusters older than that, the local cluster will send the index + # expression `dummy*` to those remote clusters. Thus, if an errors occur, you may see a reference + # to that index expression even though you didn't request it. If it causes a problem, you can + # instead include an index expression like `*:*` to bypass the issue.You may want to exclude a cluster or index from a search when: + # * A remote cluster is not currently connected and is configured with `skip_unavailable=false`. Running a cross-cluster search under those conditions will cause the entire search to fail. + # * A cluster has no matching indices, aliases or data streams for the index expression (or your user does not have permissions to search them). For example, suppose your index expression is `logs*,remote1:logs*` and the remote1 cluster has no indices, aliases or data streams that match `logs*`. In that case, that cluster will return no results from that cluster if you include it in a cross-cluster search. + # * The index expression (combined with any query parameters you specify) will likely cause an exception to be thrown when you do the search. In these cases, the "error" field in the `_resolve/cluster` response will be present. (This is also where security/permission errors will be shown.) + # * A remote cluster is an older version that does not support the feature you want to use in your search.The `remote/info` endpoint is commonly used to test whether the "local" cluster (the cluster being queried) is connected to its remote clusters, but it does not necessarily reflect whether the remote cluster is available or not. + # The remote cluster may be available, while the local cluster is not currently connected to it. + # You can use the `_resolve/cluster` API to attempt to reconnect to remote clusters. + # For example with `GET _resolve/cluster` or `GET _resolve/cluster/*:*`. + # The `connected` field in the response will indicate whether it was successful. + # If a connection was (re-)established, this will also cause the `remote/info` endpoint to now indicate a connected status. # - # @option arguments [List] :name A comma-separated list of cluster:index names or wildcard expressions - # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) - # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled - # @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) - # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) + # @option arguments [String, Array] :name A comma-separated list of names or index patterns for the indices, aliases, and data streams to resolve. + # Resources on remote clusters can be specified using the ``:`` syntax. + # Index and cluster exclusions (e.g., `-cluster1:*`) are also supported. + # If no index expression is specified, information about all remote clusters configured on the local cluster + # is returned without doing any index matching + # @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`. + # NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index + # options to the `_resolve/cluster` API endpoint that takes no index expression. Server default: true. + # @option arguments [String, Array] :expand_wildcards 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. + # Supports comma-separated values, such as `open,hidden`. + # NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index + # options to the `_resolve/cluster` API endpoint that takes no index expression. Server default: open. + # @option arguments [Boolean] :ignore_throttled If true, concrete, expanded, or aliased indices are ignored when frozen. + # NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index + # options to the `_resolve/cluster` API endpoint that takes no index expression. + # @option arguments [Boolean] :ignore_unavailable If false, the request returns an error if it targets a missing or closed index. + # NOTE: This option is only supported when specifying an index expression. You will get an error if you specify index + # options to the `_resolve/cluster` API endpoint that takes no index expression. + # @option arguments [Time] :timeout The maximum time to wait for remote clusters to respond. + # If a remote cluster does not respond within this timeout period, the API response + # will show the cluster as not connected and include an error message that the + # request timed out.The default timeout is unset and the query can take + # as long as the networking layer is configured to wait for remote clusters that are + # not responding (typically 30 seconds). + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-resolve-cluster-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-resolve-cluster # def resolve_cluster(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.resolve_cluster' } @@ -41,8 +100,6 @@ def resolve_cluster(arguments = {}) end request_opts[:defined_params] = defined_params unless defined_params.empty? - raise ArgumentError, "Required argument 'name' missing" unless arguments[:name] - arguments = arguments.clone headers = arguments.delete(:headers) || {} @@ -51,7 +108,11 @@ def resolve_cluster(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_GET - path = "_resolve/cluster/#{Utils.__listify(_name)}" + path = if _name + "_resolve/cluster/#{Utils.listify(_name)}" + else + '_resolve/cluster' + end params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_index.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_index.rb index 9c6e38013d..d12dea882e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_index.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/resolve_index.rb @@ -15,22 +15,40 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Returns information about any matching indices, aliases, and data streams + # Resolve indices. + # Resolve the names and/or index patterns for indices, aliases, and data streams. + # Multiple patterns and remote clusters are supported. # - # @option arguments [List] :name A comma-separated list of names or wildcard expressions - # @option arguments [String] :expand_wildcards Whether wildcard expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) - # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) - # @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) + # @option arguments [String, Array] :name Comma-separated name(s) or index pattern(s) of the indices, aliases, and data streams to resolve. + # Resources on remote clusters can be specified using the ``:`` syntax. (*Required*) + # @option arguments [String, Array] :expand_wildcards 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. + # Supports comma-separated values, such as `open,hidden`. Server default: open. + # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed 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`. Server default: true. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-resolve-index-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-resolve-index # def resolve_index(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.resolve_index' } @@ -50,7 +68,7 @@ def resolve_index(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_GET - path = "_resolve/index/#{Utils.__listify(_name)}" + path = "_resolve/index/#{Utils.listify(_name)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/rollover.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/rollover.rb index fe1c79258f..2ac0d72b11 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/rollover.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/rollover.rb @@ -15,32 +15,73 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Updates an alias to point to a new index when the existing index - # is considered to be too large or too old. + # Roll over to a new index. + # TIP: We recommend using the index lifecycle rollover action to automate rollovers. However, Serverless does not support Index Lifecycle Management (ILM), so don't use this approach in the Serverless context. + # The rollover API creates a new index for a data stream or index alias. + # The API behavior depends on the rollover target. + # **Roll over a data stream** + # If you roll over a data stream, the API creates a new write index for the stream. + # The stream's previous write index becomes a regular backing index. + # A rollover also increments the data stream's generation. + # **Roll over an index alias with a write index** + # TIP: Prior to Elasticsearch 7.9, you'd typically use an index alias with a write index to manage time series data. + # Data streams replace this functionality, require less maintenance, and automatically integrate with data tiers. + # If an index alias points to multiple indices, one of the indices must be a write index. + # The rollover API creates a new write index for the alias with `is_write_index` set to `true`. + # The API also `sets is_write_index` to `false` for the previous write index. + # **Roll over an index alias with one index** + # If you roll over an index alias that points to only one index, the API creates a new index for the alias and removes the original index from the alias. + # NOTE: A rollover creates a new index and is subject to the `wait_for_active_shards` setting. + # **Increment index names for an alias** + # When you roll over an index alias, you can specify a name for the new index. + # If you don't specify a name and the current index ends with `-` and a number, such as `my-index-000001` or `my-index-3`, the new index name increments that number. + # For example, if you roll over an alias with a current index of `my-index-000001`, the rollover creates a new index named `my-index-000002`. + # This number is always six characters and zero-padded, regardless of the previous index's name. + # If you use an index alias for time series data, you can use date math in the index name to track the rollover date. + # For example, you can create an alias that points to an index named ``. + # If you create the index on May 6, 2099, the index's name is `my-index-2099.05.06-000001`. + # If you roll over the alias on May 7, 2099, the new index's name is `my-index-2099.05.07-000002`. # - # @option arguments [String] :alias The name of the alias to rollover - # @option arguments [String] :new_index The name of the rollover index - # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Boolean] :dry_run If set to true the rollover action will only be validated but not actually performed even if a condition matches. The default is false - # @option arguments [Time] :master_timeout Specify timeout for connection to master - # @option arguments [String] :wait_for_active_shards Set the number of active shards to wait for on the newly created rollover index before the operation returns. - # @option arguments [Boolean] :lazy If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write. Only allowed on data streams. + # @option arguments [String] :alias Name of the data stream or index alias to roll over. (*Required*) + # @option arguments [String] :new_index Name of the index to create. + # Supports date math. + # Data streams do not support this parameter. + # @option arguments [Boolean] :dry_run If `true`, checks whether the current index satisfies the specified conditions but does not perform a rollover. + # @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. + # @option arguments [Time] :timeout Period to wait for a response. + # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operation. + # Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). Server default: 1. + # @option arguments [Boolean] :lazy If set to true, the rollover action will only mark a data stream to signal that it needs to be rolled over at the next write. + # Only allowed on data streams. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The conditions that needs to be met for executing rollover + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-rollover-index.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-rollover # def rollover(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.rollover' } - defined_params = %i[alias new_index].each_with_object({}) do |variable, set_variables| + defined_params = [:alias, :new_index].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -50,7 +91,7 @@ def rollover(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) _alias = arguments.delete(:alias) @@ -58,9 +99,9 @@ def rollover(arguments = {}) method = Elasticsearch::API::HTTP_POST path = if _alias && _new_index - "#{Utils.__listify(_alias)}/_rollover/#{Utils.__listify(_new_index)}" + "#{Utils.listify(_alias)}/_rollover/#{Utils.listify(_new_index)}" else - "#{Utils.__listify(_alias)}/_rollover" + "#{Utils.listify(_alias)}/_rollover" end params = Utils.process_params(arguments) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/segments.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/segments.rb index 52d5e8c9c3..e79651387b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/segments.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/segments.rb @@ -15,22 +15,40 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Provides low-level information about segments in a Lucene index. + # Get index segments. + # Get low-level information about the Lucene segments in index shards. + # For data streams, the API returns information about the stream's backing indices. # - # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices - # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) - # @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) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @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 [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. Server default: true. + # @option arguments [String, Array] :expand_wildcards 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. + # Supports comma-separated values, such as `open,hidden`. Server default: open. + # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-segments.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-segments # def segments(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.segments' } @@ -43,13 +61,13 @@ def segments(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_GET path = if _index - "#{Utils.__listify(_index)}/_segments" + "#{Utils.listify(_index)}/_segments" else '_segments' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/shard_stores.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/shard_stores.rb index 04000d4f7e..3395663db9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/shard_stores.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/shard_stores.rb @@ -15,23 +15,45 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Provides store information for shard copies of indices. + # Get index shard stores. + # Get store information about replica shards in one or more indices. + # For data streams, the API retrieves store information for the stream's backing indices. + # The index shard stores API returns the following information: + # * The node on which each replica shard exists. + # * The allocation ID for each replica shard. + # * A unique ID for each replica shard. + # * Any errors encountered while opening the shard index or from an earlier failure. + # By default, the API returns store information only for primary shards that are unassigned or have one or more unassigned replica shards. # - # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices - # @option arguments [List] :status A comma-separated list of statuses used to filter on shards to get store information for (options: green, yellow, red, all) - # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) - # @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) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) + # @option arguments [String, Array] :index List of data streams, indices, and aliases used to limit the request. + # @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. + # @option arguments [String, Array] :expand_wildcards 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. Server default: open. + # @option arguments [Boolean] :ignore_unavailable If true, missing or closed indices are not included in the response. + # @option arguments [String, Array] :status List of shard health statuses used to limit the request. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-shards-stores.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-shard-stores # def shard_stores(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.shard_stores' } @@ -44,13 +66,13 @@ def shard_stores(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_GET path = if _index - "#{Utils.__listify(_index)}/_shard_stores" + "#{Utils.listify(_index)}/_shard_stores" else '_shard_stores' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/shrink.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/shrink.rb index 00a28b5ec1..6676f6ccec 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/shrink.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/shrink.rb @@ -15,29 +15,65 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Allow to shrink an existing index into a new index with fewer primary shards. + # Shrink an index. + # Shrink an index into a new index with fewer primary shards. + # Before you can shrink an index: + # * The index must be read-only. + # * A copy of every shard in the index must reside on the same node. + # * The index must have a green health status. + # To make shard allocation easier, we recommend you also remove the index's replica shards. + # You can later re-add replica shards as part of the shrink operation. + # The requested number of primary shards in the target index must be a factor of the number of shards in the source index. + # For example an index with 8 primary shards can be shrunk into 4, 2 or 1 primary shards or an index with 15 primary shards can be shrunk into 5, 3 or 1. + # If the number of shards in the index is a prime number it can only be shrunk into a single primary shard + # Before shrinking, a (primary or replica) copy of every shard in the index must be present on the same node. + # The current write index on a data stream cannot be shrunk. In order to shrink the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be shrunk. + # A shrink operation: + # * Creates a new target index with the same definition as the source index, but with a smaller number of primary shards. + # * Hard-links segments from the source index into the target index. If the file system does not support hard-linking, then all segments are copied into the new index, which is a much more time consuming process. Also if using multiple data paths, shards on different data paths require a full copy of segment files if they are not on the same disk since hardlinks do not work across disks. + # * Recovers the target index as though it were a closed index which had just been re-opened. Recovers shards to the `.routing.allocation.initial_recovery._id` index setting. + # IMPORTANT: Indices can only be shrunk if they satisfy the following requirements: + # * The target index must not exist. + # * The source index must have more primary shards than the target index. + # * The number of primary shards in the target index must be a factor of the number of primary shards in the source index. The source index must have more primary shards than the target index. + # * The index must not contain more than 2,147,483,519 documents in total across all shards that will be shrunk into a single shard on the target index as this is the maximum number of docs that can fit into a single shard. + # * The node handling the shrink process must have sufficient free disk space to accommodate a second copy of the existing index. # - # @option arguments [String] :index The name of the source index to shrink - # @option arguments [String] :target The name of the target index to shrink into - # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Time] :master_timeout Specify timeout for connection to master - # @option arguments [String] :wait_for_active_shards Set the number of active shards to wait for on the shrunken index before the operation returns. + # @option arguments [String] :index Name of the source index to shrink. (*Required*) + # @option arguments [String] :target Name of the target index to create. (*Required*) + # @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. + # @option arguments [Time] :timeout Period to wait for a response. + # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operation. + # Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). Server default: 1. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The configuration for the target index (`settings` and `aliases`) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-shrink-index.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-shrink # def shrink(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.shrink' } - defined_params = %i[index target].each_with_object({}) do |variable, set_variables| + defined_params = [:index, :target].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -48,14 +84,14 @@ def shrink(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) _index = arguments.delete(:index) _target = arguments.delete(:target) method = Elasticsearch::API::HTTP_PUT - path = "#{Utils.__listify(_index)}/_shrink/#{Utils.__listify(_target)}" + path = "#{Utils.listify(_index)}/_shrink/#{Utils.listify(_target)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_index_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_index_template.rb index 3817f9f5ca..2961a03639 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_index_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_index_template.rb @@ -15,24 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Simulate matching the given index name against the index templates in the system + # Simulate an index. + # Get the index configuration that would be applied to the specified index from an existing index template. # - # @option arguments [String] :name The name of the index (it must be a concrete index name) + # @option arguments [String] :name Name of the index to simulate (*Required*) # @option arguments [Boolean] :create Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one - # @option arguments [String] :cause User defined reason for dry-run creating the new template for simulation purposes - # @option arguments [Time] :master_timeout Specify timeout for connection to master - # @option arguments [Boolean] :include_defaults Return all relevant default configurations for this index template simulation (default: false) + # @option arguments [String] :cause User defined reason for dry-run creating the new template for simulation purposes Server default: false. + # @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. + # @option arguments [Boolean] :include_defaults If true, returns all relevant default configurations for the index template. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body New index template definition, which will be included in the simulation, as if it already exists in the system # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-simulate-index.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-simulate-index-template # def simulate_index_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.simulate_index_template' } @@ -47,12 +58,12 @@ def simulate_index_template(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = nil _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_POST - path = "_index_template/_simulate_index/#{Utils.__listify(_name)}" + path = "_index_template/_simulate_index/#{Utils.listify(_name)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_template.rb index afb1e8306f..8f4f1a6f62 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/simulate_template.rb @@ -15,24 +15,37 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Simulate resolving the given template name or body + # Simulate an index template. + # Get the index configuration that would be applied by a particular index template. # - # @option arguments [String] :name The name of the index template - # @option arguments [Boolean] :create Whether the index template we optionally defined in the body should only be dry-run added if new or can also replace an existing one + # @option arguments [String] :name Name of the index template to simulate. To test a template configuration before you add it to the cluster, omit + # this parameter and specify the template configuration in the request body. + # @option arguments [Boolean] :create If true, the template passed in the body is only used if no existing templates match the same index patterns. If false, the simulation uses the template with the highest priority. Note that the template is not permanently added or updated in either case; it is only used for the simulation. # @option arguments [String] :cause User defined reason for dry-run creating the new template for simulation purposes - # @option arguments [Time] :master_timeout Specify timeout for connection to master - # @option arguments [Boolean] :include_defaults Return all relevant default configurations for this template simulation (default: false) + # @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. + # @option arguments [Boolean] :include_defaults If true, returns all relevant default configurations for the index template. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body New index template definition to be simulated, if no index template name is specified + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-simulate-template.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-simulate-template # def simulate_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.simulate_template' } @@ -51,7 +64,7 @@ def simulate_template(arguments = {}) method = Elasticsearch::API::HTTP_POST path = if _name - "_index_template/_simulate/#{Utils.__listify(_name)}" + "_index_template/_simulate/#{Utils.listify(_name)}" else '_index_template/_simulate' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/split.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/split.rb index 4bd7412a9c..15d5c3f213 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/split.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/split.rb @@ -15,29 +15,68 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Allows you to split an existing index into a new index with more primary shards. + # Split an index. + # Split an index into a new index with more primary shards. + # * Before you can split an index: + # * The index must be read-only. + # * The cluster health status must be green. + # You can do make an index read-only with the following request using the add index block API: + # + # ``` + # PUT /my_source_index/_block/write + # ``` + # + # The current write index on a data stream cannot be split. + # In order to split the current write index, the data stream must first be rolled over so that a new write index is created and then the previous write index can be split. + # The number of times the index can be split (and the number of shards that each original shard can be split into) is determined by the `index.number_of_routing_shards` setting. + # The number of routing shards specifies the hashing space that is used internally to distribute documents across shards with consistent hashing. + # For instance, a 5 shard index with `number_of_routing_shards` set to 30 (5 x 2 x 3) could be split by a factor of 2 or 3. + # A split operation: + # * Creates a new target index with the same definition as the source index, but with a larger number of primary shards. + # * Hard-links segments from the source index into the target index. If the file system doesn't support hard-linking, all segments are copied into the new index, which is a much more time consuming process. + # * Hashes all documents again, after low level files are created, to delete documents that belong to a different shard. + # * Recovers the target index as though it were a closed index which had just been re-opened. + # IMPORTANT: Indices can only be split if they satisfy the following requirements: + # * The target index must not exist. + # * The source index must have fewer primary shards than the target index. + # * The number of primary shards in the target index must be a multiple of the number of primary shards in the source index. + # * The node handling the split process must have sufficient free disk space to accommodate a second copy of the existing index. # - # @option arguments [String] :index The name of the source index to split - # @option arguments [String] :target The name of the target index to split into - # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Time] :master_timeout Specify timeout for connection to master - # @option arguments [String] :wait_for_active_shards Set the number of active shards to wait for on the shrunken index before the operation returns. + # @option arguments [String] :index Name of the source index to split. (*Required*) + # @option arguments [String] :target Name of the target index to create. (*Required*) + # @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. + # @option arguments [Time] :timeout Period to wait for a response. + # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operation. + # Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). Server default: 1. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The configuration for the target index (`settings` and `aliases`) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-split-index.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-split # def split(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.split' } - defined_params = %i[index target].each_with_object({}) do |variable, set_variables| + defined_params = [:index, :target].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -48,14 +87,14 @@ def split(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) _index = arguments.delete(:index) _target = arguments.delete(:target) method = Elasticsearch::API::HTTP_PUT - path = "#{Utils.__listify(_index)}/_split/#{Utils.__listify(_target)}" + path = "#{Utils.listify(_index)}/_split/#{Utils.listify(_target)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/stats.rb index c054f9434a..98cb618f52 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/stats.rb @@ -15,34 +15,54 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Provides statistics on operations happening in an index. + # Get index statistics. + # For data streams, the API retrieves statistics for the stream's backing indices. + # By default, the returned statistics are index-level with `primaries` and `total` aggregations. + # `primaries` are the values for only the primary shards. + # `total` are the accumulated values for both primary and replica shards. + # To get shard-level statistics, set the `level` parameter to `shards`. + # NOTE: When moving to another node, the shard-level statistics for a shard are cleared. + # Although the shard is no longer part of the node, that node retains any node-level statistics to which the shard contributed. # - # @option arguments [List] :metric Limit the information returned the specific metrics. (options: _all, completion, docs, fielddata, query_cache, flush, get, indexing, merge, request_cache, refresh, search, segments, store, warmer, bulk) - # @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices - # @option arguments [List] :completion_fields A comma-separated list of fields for the `completion` index metric (supports wildcards) - # @option arguments [List] :fielddata_fields A comma-separated list of fields for the `fielddata` index metric (supports wildcards) - # @option arguments [List] :fields A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards) - # @option arguments [List] :groups A comma-separated list of search groups for `search` index metric - # @option arguments [String] :level Return stats aggregated at cluster, index or shard level (options: cluster, indices, shards) - # @option arguments [Boolean] :include_segment_file_sizes Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested) - # @option arguments [Boolean] :include_unloaded_segments If set to true segment stats will include stats for segments that are not currently loaded into memory - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) - # @option arguments [Boolean] :forbid_closed_indices If set to false stats will also collected from closed indices if explicitly specified or if expand_wildcards expands to closed indices + # @option arguments [String, Array] :metric Limit the information returned the specific 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 [String, Array] :completion_fields Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. + # @option arguments [String, Array] :expand_wildcards 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. Supports comma-separated values, + # such as `open,hidden`. + # @option arguments [String, Array] :fielddata_fields Comma-separated list or wildcard expressions of fields to include in fielddata statistics. + # @option arguments [String, Array] :fields Comma-separated list or wildcard expressions of fields to include in the statistics. + # @option arguments [Boolean] :forbid_closed_indices If true, statistics are not collected from closed indices. Server default: true. + # @option arguments [String, Array] :groups Comma-separated list of search groups to include in the search statistics. + # @option arguments [Boolean] :include_segment_file_sizes If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). + # @option arguments [Boolean] :include_unloaded_segments If true, the response includes information from segments that are not loaded into memory. + # @option arguments [String] :level Indicates whether statistics are aggregated at the cluster, index, or shard level. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-stats.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-stats # def stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.stats' } - defined_params = %i[metric index].each_with_object({}) do |variable, set_variables| + defined_params = [:metric, :index].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -58,11 +78,11 @@ def stats(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _index && _metric - "#{Utils.__listify(_index)}/_stats/#{Utils.__listify(_metric)}" + "#{Utils.listify(_index)}/_stats/#{Utils.listify(_metric)}" elsif _metric - "_stats/#{Utils.__listify(_metric)}" + "_stats/#{Utils.listify(_metric)}" elsif _index - "#{Utils.__listify(_index)}/_stats" + "#{Utils.listify(_index)}/_stats" else '_stats' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/update_aliases.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/update_aliases.rb index e7178802bf..c4e2d86d38 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/update_aliases.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/update_aliases.rb @@ -15,21 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Updates index aliases. + # Create or update an alias. + # Adds a data stream or index to an alias. # - # @option arguments [Time] :timeout Request timeout - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @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. + # @option arguments [Time] :timeout Period to wait for a response. + # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The definition of `actions` to perform (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-update-aliases # def update_aliases(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.update_aliases' } @@ -39,7 +53,7 @@ def update_aliases(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_aliases' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/indices/validate_query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/indices/validate_query.rb index 03a22a7bc7..9c9b9bae32 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/indices/validate_query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/indices/validate_query.rb @@ -15,32 +15,51 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Indices module Actions - # Allows a user to validate a potentially expensive query without executing it. + # Validate a query. + # Validates a query without running it. # - # @option arguments [List] :index A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices - # @option arguments [Boolean] :explain Return detailed information about the error - # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) - # @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) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) - # @option arguments [String] :q Query in the Lucene query string syntax - # @option arguments [String] :analyzer The analyzer to use for the query string - # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false) - # @option arguments [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR) - # @option arguments [String] :df The field to use as default where no field prefix is given in the query string - # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored - # @option arguments [Boolean] :rewrite Provide a more detailed explanation showing the actual Lucene query that will be executed. - # @option arguments [Boolean] :all_shards Execute validation on all shards instead of one random shard per index + # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and aliases to search. + # Supports wildcards (`*`). + # To search all data streams or indices, omit this parameter or use `*` or `_all`. + # @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. Server default: true. + # @option arguments [Boolean] :all_shards If `true`, the validation is executed on all shards instead of one random shard per index. + # @option arguments [String] :analyzer Analyzer to use for the query string. + # This parameter can only be used when the `q` query string parameter is specified. + # @option arguments [Boolean] :analyze_wildcard If `true`, wildcard and prefix queries are analyzed. + # @option arguments [String] :default_operator The default operator for query string query: `AND` or `OR`. Server default: OR. + # @option arguments [String] :df Field to use as default where no field prefix is given in the query string. + # This parameter can only be used when the `q` query string parameter is specified. + # @option arguments [String, Array] :expand_wildcards 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. + # Supports comma-separated values, such as `open,hidden`. Server default: open. + # @option arguments [Boolean] :explain If `true`, the response returns detailed information if an error has occurred. + # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. + # @option arguments [Boolean] :lenient If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + # @option arguments [Boolean] :rewrite If `true`, returns a more detailed explanation showing the actual Lucene query that will be executed. + # @option arguments [String] :q Query in the Lucene query string syntax. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The query definition specified with the Query DSL + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-validate.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-indices-validate-query # def validate_query(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'indices.validate_query' } @@ -63,11 +82,11 @@ def validate_query(arguments = {}) Elasticsearch::API::HTTP_GET end - path = if _index - "#{Utils.__listify(_index)}/_validate/query" - else - '_validate/query' - end + path = if _index + "#{Utils.listify(_index)}/_validate/query" + else + '_validate/query' + end params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb new file mode 100644 index 0000000000..4c2d4d2ecc --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb @@ -0,0 +1,80 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. +module Elasticsearch + module API + module Inference + module Actions + # Perform chat completion inference + # The chat completion inference API enables real-time responses for chat completion tasks by delivering answers incrementally, reducing response times during computation. + # It only works with the `chat_completion` task type for `openai` and `elastic` inference services. + # NOTE: The `chat_completion` task type is only available within the _stream API and only supports streaming. + # The Chat completion inference API and the Stream inference API differ in their response structure and capabilities. + # The Chat completion inference API provides more comprehensive customization options through more fields and function calling support. + # If you use the `openai` service or the `elastic` service, use the Chat completion inference API. + # + # @option arguments [String] :inference_id The inference Id (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference request to complete. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body chat_completion_request + # + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-unified-inference + # + def chat_completion_unified(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.chat_completion_unified' } + + defined_params = [:inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'body' missing" unless arguments[:body] + raise ArgumentError, "Required argument 'inference_id' missing" unless arguments[:inference_id] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _inference_id = arguments.delete(:inference_id) + + method = Elasticsearch::API::HTTP_POST + path = "_inference/chat_completion/#{Utils.listify(_inference_id)}/_stream" + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/stream_inference.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/completion.rb similarity index 50% rename from elasticsearch-api/lib/elasticsearch/api/actions/inference/stream_inference.rb rename to elasticsearch-api/lib/elasticsearch/api/actions/inference/completion.rb index 539b4922a1..5eb5758a00 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/stream_inference.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/completion.rb @@ -15,26 +15,37 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Inference module Actions - # Perform streaming inference + # Perform completion inference on the service # - # @option arguments [String] :inference_id The inference Id - # @option arguments [String] :task_type The task type + # @option arguments [String] :inference_id The inference Id (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference request to complete. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The inference payload + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/post-stream-inference-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-inference # - def stream_inference(arguments = {}) - request_opts = { endpoint: arguments[:endpoint] || 'inference.stream_inference' } + def completion(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.completion' } - defined_params = %i[inference_id task_type].each_with_object({}) do |variable, set_variables| + defined_params = [:inference_id].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -48,15 +59,9 @@ def stream_inference(arguments = {}) _inference_id = arguments.delete(:inference_id) - _task_type = arguments.delete(:task_type) - method = Elasticsearch::API::HTTP_POST - path = if _task_type && _inference_id - "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_inference_id)}/_stream" - else - "_inference/#{Utils.__listify(_inference_id)}/_stream" - end - params = {} + path = "_inference/completion/#{Utils.listify(_inference_id)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/delete.rb index 02d5f328cd..f8483de6f4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/delete.rb @@ -15,27 +15,38 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Inference module Actions # Delete an inference endpoint # - # @option arguments [String] :inference_id The inference Id # @option arguments [String] :task_type The task type - # @option arguments [Boolean] :dry_run If true the endpoint will not be deleted and a list of ingest processors which reference this endpoint will be returned. - # @option arguments [Boolean] :force If true the endpoint will be forcefully stopped (regardless of whether or not it is referenced by any ingest processors or semantic text fields). + # @option arguments [String] :inference_id The inference identifier. (*Required*) + # @option arguments [Boolean] :dry_run When true, the endpoint is not deleted and a list of ingest processors which reference this endpoint is returned. + # @option arguments [Boolean] :force When true, the inference endpoint is forcefully deleted even if it is still being used by ingest processors or semantic text fields. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-inference-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-delete # def delete(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'inference.delete' } - defined_params = %i[inference_id task_type].each_with_object({}) do |variable, set_variables| + defined_params = [:inference_id, :task_type].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -47,15 +58,15 @@ def delete(arguments = {}) body = nil - _inference_id = arguments.delete(:inference_id) - _task_type = arguments.delete(:task_type) + _inference_id = arguments.delete(:inference_id) + method = Elasticsearch::API::HTTP_DELETE path = if _task_type && _inference_id - "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_inference_id)}" + "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_inference_id)}" else - "_inference/#{Utils.__listify(_inference_id)}" + "_inference/#{Utils.listify(_inference_id)}" end params = Utils.process_params(arguments) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/get.rb index a3fec86adb..2756bd64d8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/get.rb @@ -15,25 +15,36 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Inference module Actions # Get an inference endpoint # - # @option arguments [String] :inference_id The inference Id # @option arguments [String] :task_type The task type + # @option arguments [String] :inference_id The inference Id + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-inference-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-get # def get(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'inference.get' } - defined_params = %i[inference_id task_type].each_with_object({}) do |variable, set_variables| + defined_params = [:inference_id, :task_type].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -43,19 +54,19 @@ def get(arguments = {}) body = nil - _inference_id = arguments.delete(:inference_id) - _task_type = arguments.delete(:task_type) + _inference_id = arguments.delete(:inference_id) + method = Elasticsearch::API::HTTP_GET path = if _task_type && _inference_id - "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_inference_id)}" + "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_inference_id)}" elsif _inference_id - "_inference/#{Utils.__listify(_inference_id)}" + "_inference/#{Utils.listify(_inference_id)}" else '_inference' end - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/inference.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/inference.rb index 1e7fd39d7c..da9a234aa5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/inference.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/inference.rb @@ -15,26 +15,42 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Inference module Actions - # Perform inference + # Perform inference on the service. + # This API enables you to use machine learning models to perform specific tasks on data that you provide as an input. + # It returns a response with the results of the tasks. + # The inference endpoint you use can perform one specific task that has been defined when the endpoint was created with the create inference API. + # For details about using this API with a service, such as Amazon Bedrock, Anthropic, or HuggingFace, refer to the service-specific documentation. # - # @option arguments [String] :inference_id The inference Id - # @option arguments [String] :task_type The task type + # @option arguments [String] :task_type The type of inference task that the model performs. + # @option arguments [String] :inference_id The unique identifier for the inference endpoint. (*Required*) + # @option arguments [Time] :timeout The amount of time to wait for the inference request to complete. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The inference payload + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/post-inference-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-inference # def inference(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'inference.inference' } - defined_params = %i[inference_id task_type].each_with_object({}) do |variable, set_variables| + defined_params = [:inference_id, :task_type].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -46,17 +62,17 @@ def inference(arguments = {}) body = arguments.delete(:body) - _inference_id = arguments.delete(:inference_id) - _task_type = arguments.delete(:task_type) + _inference_id = arguments.delete(:inference_id) + method = Elasticsearch::API::HTTP_POST path = if _task_type && _inference_id - "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_inference_id)}" + "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_inference_id)}" else - "_inference/#{Utils.__listify(_inference_id)}" + "_inference/#{Utils.listify(_inference_id)}" end - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put.rb index aabcd25a4e..44b374b5b9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put.rb @@ -15,30 +15,63 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Inference module Actions - # Configure an inference endpoint for use in the Inference API + # Create an inference endpoint. + # IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Mistral, Azure OpenAI, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. + # For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. + # However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. + # The following integrations are available through the inference API. You can find the available task types next to the integration name: + # * AlibabaCloud AI Search (`completion`, `rerank`, `sparse_embedding`, `text_embedding`) + # * Amazon Bedrock (`completion`, `text_embedding`) + # * Anthropic (`completion`) + # * Azure AI Studio (`completion`, `text_embedding`) + # * Azure OpenAI (`completion`, `text_embedding`) + # * Cohere (`completion`, `rerank`, `text_embedding`) + # * Elasticsearch (`rerank`, `sparse_embedding`, `text_embedding` - this service is for built-in models and models uploaded through Eland) + # * ELSER (`sparse_embedding`) + # * Google AI Studio (`completion`, `text_embedding`) + # * Google Vertex AI (`rerank`, `text_embedding`) + # * Hugging Face (`text_embedding`) + # * Mistral (`text_embedding`) + # * OpenAI (`chat_completion`, `completion`, `text_embedding`) + # * VoyageAI (`text_embedding`, `rerank`) + # * Watsonx inference integration (`text_embedding`) + # * JinaAI (`text_embedding`, `rerank`) # - # @option arguments [String] :inference_id The inference Id - # @option arguments [String] :task_type The task type + # @option arguments [String] :task_type The task type. Refer to the integration list in the API description for the available task types. + # @option arguments [String] :inference_id The inference Id (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The inference endpoint's task and service settings + # @option arguments [Hash] :body inference_config # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-inference-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put # def put(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'inference.put' } - defined_params = %i[inference_id task_type].each_with_object({}) do |variable, set_variables| + defined_params = [:inference_id, :task_type].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? + raise ArgumentError, "Required argument 'body' missing" unless arguments[:body] raise ArgumentError, "Required argument 'inference_id' missing" unless arguments[:inference_id] arguments = arguments.clone @@ -46,17 +79,17 @@ def put(arguments = {}) body = arguments.delete(:body) - _inference_id = arguments.delete(:inference_id) - _task_type = arguments.delete(:task_type) + _inference_id = arguments.delete(:inference_id) + method = Elasticsearch::API::HTTP_PUT path = if _task_type && _inference_id - "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_inference_id)}" + "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_inference_id)}" else - "_inference/#{Utils.__listify(_inference_id)}" + "_inference/#{Utils.listify(_inference_id)}" end - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_alibabacloud.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_alibabacloud.rb new file mode 100644 index 0000000000..1eedcfa206 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_alibabacloud.rb @@ -0,0 +1,82 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. +module Elasticsearch + module API + module Inference + module Actions + # Create an AlibabaCloud AI Search inference endpoint. + # Create an inference endpoint to perform an inference task with the `alibabacloud-ai-search` service. + # + # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*) + # @option arguments [String] :alibabacloud_inference_id The unique identifier of the inference endpoint. (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body request body + # + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-alibabacloud + # + def put_alibabacloud(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.put_alibabacloud' } + + defined_params = [:task_type, :alibabacloud_inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type] + + unless arguments[:alibabacloud_inference_id] + raise ArgumentError, + "Required argument 'alibabacloud_inference_id' missing" + end + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _task_type = arguments.delete(:task_type) + + _alibabacloud_inference_id = arguments.delete(:alibabacloud_inference_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_alibabacloud_inference_id)}" + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_amazonbedrock.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_amazonbedrock.rb new file mode 100644 index 0000000000..9910568755 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_amazonbedrock.rb @@ -0,0 +1,82 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. +module Elasticsearch + module API + module Inference + module Actions + # Create an Amazon Bedrock inference endpoint. + # Create an inference endpoint to perform an inference task with the `amazonbedrock` service. + # + # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*) + # @option arguments [String] :amazonbedrock_inference_id The unique identifier of the inference endpoint. (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body request body + # + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-amazonbedrock + # + def put_amazonbedrock(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.put_amazonbedrock' } + + defined_params = [:task_type, :amazonbedrock_inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type] + + unless arguments[:amazonbedrock_inference_id] + raise ArgumentError, + "Required argument 'amazonbedrock_inference_id' missing" + end + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _task_type = arguments.delete(:task_type) + + _amazonbedrock_inference_id = arguments.delete(:amazonbedrock_inference_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_amazonbedrock_inference_id)}" + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_anthropic.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_anthropic.rb new file mode 100644 index 0000000000..91d58a6015 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_anthropic.rb @@ -0,0 +1,83 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. +module Elasticsearch + module API + module Inference + module Actions + # Create an Anthropic inference endpoint. + # Create an inference endpoint to perform an inference task with the `anthropic` service. + # + # @option arguments [String] :task_type The task type. + # The only valid task type for the model to perform is `completion`. (*Required*) + # @option arguments [String] :anthropic_inference_id The unique identifier of the inference endpoint. (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body request body + # + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-anthropic + # + def put_anthropic(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.put_anthropic' } + + defined_params = [:task_type, :anthropic_inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type] + + unless arguments[:anthropic_inference_id] + raise ArgumentError, + "Required argument 'anthropic_inference_id' missing" + end + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _task_type = arguments.delete(:task_type) + + _anthropic_inference_id = arguments.delete(:anthropic_inference_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_anthropic_inference_id)}" + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureaistudio.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureaistudio.rb new file mode 100644 index 0000000000..7cb06dee8f --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureaistudio.rb @@ -0,0 +1,82 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. +module Elasticsearch + module API + module Inference + module Actions + # Create an Azure AI studio inference endpoint. + # Create an inference endpoint to perform an inference task with the `azureaistudio` service. + # + # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*) + # @option arguments [String] :azureaistudio_inference_id The unique identifier of the inference endpoint. (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body request body + # + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-azureaistudio + # + def put_azureaistudio(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.put_azureaistudio' } + + defined_params = [:task_type, :azureaistudio_inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type] + + unless arguments[:azureaistudio_inference_id] + raise ArgumentError, + "Required argument 'azureaistudio_inference_id' missing" + end + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _task_type = arguments.delete(:task_type) + + _azureaistudio_inference_id = arguments.delete(:azureaistudio_inference_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_azureaistudio_inference_id)}" + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureopenai.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureopenai.rb new file mode 100644 index 0000000000..0cd5e073fc --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_azureopenai.rb @@ -0,0 +1,87 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. +module Elasticsearch + module API + module Inference + module Actions + # Create an Azure OpenAI inference endpoint. + # Create an inference endpoint to perform an inference task with the `azureopenai` service. + # The list of chat completion models that you can choose from in your Azure OpenAI deployment include: + # * {https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#gpt-4-and-gpt-4-turbo-models GPT-4 and GPT-4 Turbo models} + # * {https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#gpt-35 GPT-3.5} + # The list of embeddings models that you can choose from in your deployment can be found in the {https://learn.microsoft.com/en-us/azure/ai-services/openai/concepts/models?tabs=global-standard%2Cstandard-chat-completions#embeddings Azure models documentation}. + # + # @option arguments [String] :task_type The type of the inference task that the model will perform. + # NOTE: The `chat_completion` task type only supports streaming and only through the _stream API. (*Required*) + # @option arguments [String] :azureopenai_inference_id The unique identifier of the inference endpoint. (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body request body + # + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-azureopenai + # + def put_azureopenai(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.put_azureopenai' } + + defined_params = [:task_type, :azureopenai_inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type] + + unless arguments[:azureopenai_inference_id] + raise ArgumentError, + "Required argument 'azureopenai_inference_id' missing" + end + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _task_type = arguments.delete(:task_type) + + _azureopenai_inference_id = arguments.delete(:azureopenai_inference_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_azureopenai_inference_id)}" + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_cohere.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_cohere.rb new file mode 100644 index 0000000000..cee5cdf5a2 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_cohere.rb @@ -0,0 +1,82 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. +module Elasticsearch + module API + module Inference + module Actions + # Create a Cohere inference endpoint. + # Create an inference endpoint to perform an inference task with the `cohere` service. + # + # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*) + # @option arguments [String] :cohere_inference_id The unique identifier of the inference endpoint. (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body request body + # + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-cohere + # + def put_cohere(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.put_cohere' } + + defined_params = [:task_type, :cohere_inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type] + + unless arguments[:cohere_inference_id] + raise ArgumentError, + "Required argument 'cohere_inference_id' missing" + end + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _task_type = arguments.delete(:task_type) + + _cohere_inference_id = arguments.delete(:cohere_inference_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_cohere_inference_id)}" + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_custom.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_custom.rb new file mode 100644 index 0000000000..a8937cbb55 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_custom.rb @@ -0,0 +1,112 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. +module Elasticsearch + module API + module Inference + module Actions + # Create a custom inference endpoint. + # The custom service gives more control over how to interact with external inference services that aren't explicitly supported through dedicated integrations. + # The custom service gives you the ability to define the headers, url, query parameters, request body, and secrets. + # The custom service supports the template replacement functionality, which enables you to define a template that can be replaced with the value associated with that key. + # Templates are portions of a string that start with `${` and end with `}`. + # The parameters `secret_parameters` and `task_settings` are checked for keys for template replacement. Template replacement is supported in the `request`, `headers`, `url`, and `query_parameters`. + # If the definition (key) is not found for a template, an error message is returned. + # In case of an endpoint definition like the following: + # + # ``` + # PUT _inference/text_embedding/test-text-embedding + # { + # "service": "custom", + # "service_settings": { + # "secret_parameters": { + # "api_key": "" + # }, + # "url": "...endpoints.huggingface.cloud/v1/embeddings", + # "headers": { + # "Authorization": "Bearer ${api_key}", + # "Content-Type": "application/json" + # }, + # "request": "{\"input\": ${input}}", + # "response": { + # "json_parser": { + # "text_embeddings":"$.data[*].embedding[*]" + # } + # } + # } + # } + # ``` + # + # To replace `${api_key}` the `secret_parameters` and `task_settings` are checked for a key named `api_key`. + # + # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*) + # @option arguments [String] :custom_inference_id The unique identifier of the inference endpoint. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"exists_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body request body + # + # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put-custom + # + def put_custom(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.put_custom' } + + defined_params = [:task_type, :custom_inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type] + + unless arguments[:custom_inference_id] + raise ArgumentError, + "Required argument 'custom_inference_id' missing" + end + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _task_type = arguments.delete(:task_type) + + _custom_inference_id = arguments.delete(:custom_inference_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_custom_inference_id)}" + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elasticsearch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elasticsearch.rb new file mode 100644 index 0000000000..4ea12f6907 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elasticsearch.rb @@ -0,0 +1,83 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. +module Elasticsearch + module API + module Inference + module Actions + # Create an Elasticsearch inference endpoint. + # Create an inference endpoint to perform an inference task with the `elasticsearch` service. + # + # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*) + # @option arguments [String] :elasticsearch_inference_id The unique identifier of the inference endpoint. + # The must not match the `model_id`. (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body request body + # + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-elasticsearch + # + def put_elasticsearch(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.put_elasticsearch' } + + defined_params = [:task_type, :elasticsearch_inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type] + + unless arguments[:elasticsearch_inference_id] + raise ArgumentError, + "Required argument 'elasticsearch_inference_id' missing" + end + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _task_type = arguments.delete(:task_type) + + _elasticsearch_inference_id = arguments.delete(:elasticsearch_inference_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_elasticsearch_inference_id)}" + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elser.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elser.rb new file mode 100644 index 0000000000..00e4af60d4 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_elser.rb @@ -0,0 +1,79 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. +module Elasticsearch + module API + module Inference + module Actions + # Create an ELSER inference endpoint. + # Create an inference endpoint to perform an inference task with the `elser` service. + # You can also deploy ELSER by using the Elasticsearch inference integration. + # + # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*) + # @option arguments [String] :elser_inference_id The unique identifier of the inference endpoint. (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body request body + # + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-elser + # + def put_elser(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.put_elser' } + + defined_params = [:task_type, :elser_inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type] + raise ArgumentError, "Required argument 'elser_inference_id' missing" unless arguments[:elser_inference_id] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _task_type = arguments.delete(:task_type) + + _elser_inference_id = arguments.delete(:elser_inference_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_elser_inference_id)}" + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googleaistudio.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googleaistudio.rb new file mode 100644 index 0000000000..840bf4e7c3 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googleaistudio.rb @@ -0,0 +1,82 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. +module Elasticsearch + module API + module Inference + module Actions + # Create an Google AI Studio inference endpoint. + # Create an inference endpoint to perform an inference task with the `googleaistudio` service. + # + # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*) + # @option arguments [String] :googleaistudio_inference_id The unique identifier of the inference endpoint. (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body request body + # + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-googleaistudio + # + def put_googleaistudio(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.put_googleaistudio' } + + defined_params = [:task_type, :googleaistudio_inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type] + + unless arguments[:googleaistudio_inference_id] + raise ArgumentError, + "Required argument 'googleaistudio_inference_id' missing" + end + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _task_type = arguments.delete(:task_type) + + _googleaistudio_inference_id = arguments.delete(:googleaistudio_inference_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_googleaistudio_inference_id)}" + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googlevertexai.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googlevertexai.rb new file mode 100644 index 0000000000..7fec9214e7 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_googlevertexai.rb @@ -0,0 +1,82 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. +module Elasticsearch + module API + module Inference + module Actions + # Create a Google Vertex AI inference endpoint. + # Create an inference endpoint to perform an inference task with the `googlevertexai` service. + # + # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*) + # @option arguments [String] :googlevertexai_inference_id The unique identifier of the inference endpoint. (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body request body + # + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-googlevertexai + # + def put_googlevertexai(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.put_googlevertexai' } + + defined_params = [:task_type, :googlevertexai_inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type] + + unless arguments[:googlevertexai_inference_id] + raise ArgumentError, + "Required argument 'googlevertexai_inference_id' missing" + end + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _task_type = arguments.delete(:task_type) + + _googlevertexai_inference_id = arguments.delete(:googlevertexai_inference_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_googlevertexai_inference_id)}" + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_hugging_face.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_hugging_face.rb new file mode 100644 index 0000000000..e4928013da --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_hugging_face.rb @@ -0,0 +1,93 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. +module Elasticsearch + module API + module Inference + module Actions + # Create a Hugging Face inference endpoint. + # Create an inference endpoint to perform an inference task with the `hugging_face` service. + # You must first create an inference endpoint on the Hugging Face endpoint page to get an endpoint URL. + # Select the model you want to use on the new endpoint creation page (for example `intfloat/e5-small-v2`), then select the sentence embeddings task under the advanced configuration section. + # Create the endpoint and copy the URL after the endpoint initialization has been finished. + # The following models are recommended for the Hugging Face service: + # * `all-MiniLM-L6-v2` + # * `all-MiniLM-L12-v2` + # * `all-mpnet-base-v2` + # * `e5-base-v2` + # * `e5-small-v2` + # * `multilingual-e5-base` + # * `multilingual-e5-small` + # + # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*) + # @option arguments [String] :huggingface_inference_id The unique identifier of the inference endpoint. (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body request body + # + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-hugging-face + # + def put_hugging_face(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.put_hugging_face' } + + defined_params = [:task_type, :huggingface_inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type] + + unless arguments[:huggingface_inference_id] + raise ArgumentError, + "Required argument 'huggingface_inference_id' missing" + end + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _task_type = arguments.delete(:task_type) + + _huggingface_inference_id = arguments.delete(:huggingface_inference_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_huggingface_inference_id)}" + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_jinaai.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_jinaai.rb new file mode 100644 index 0000000000..e36d666394 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_jinaai.rb @@ -0,0 +1,84 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. +module Elasticsearch + module API + module Inference + module Actions + # Create an JinaAI inference endpoint. + # Create an inference endpoint to perform an inference task with the `jinaai` service. + # To review the available `rerank` models, refer to . + # To review the available `text_embedding` models, refer to the . + # + # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*) + # @option arguments [String] :jinaai_inference_id The unique identifier of the inference endpoint. (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body request body + # + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-jinaai + # + def put_jinaai(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.put_jinaai' } + + defined_params = [:task_type, :jinaai_inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type] + + unless arguments[:jinaai_inference_id] + raise ArgumentError, + "Required argument 'jinaai_inference_id' missing" + end + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _task_type = arguments.delete(:task_type) + + _jinaai_inference_id = arguments.delete(:jinaai_inference_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_jinaai_inference_id)}" + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_mistral.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_mistral.rb new file mode 100644 index 0000000000..c551b8df82 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_mistral.rb @@ -0,0 +1,83 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. +module Elasticsearch + module API + module Inference + module Actions + # Create a Mistral inference endpoint. + # Creates an inference endpoint to perform an inference task with the `mistral` service. + # + # @option arguments [String] :task_type The task type. + # The only valid task type for the model to perform is `text_embedding`. (*Required*) + # @option arguments [String] :mistral_inference_id The unique identifier of the inference endpoint. (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body request body + # + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-mistral + # + def put_mistral(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.put_mistral' } + + defined_params = [:task_type, :mistral_inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type] + + unless arguments[:mistral_inference_id] + raise ArgumentError, + "Required argument 'mistral_inference_id' missing" + end + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _task_type = arguments.delete(:task_type) + + _mistral_inference_id = arguments.delete(:mistral_inference_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_mistral_inference_id)}" + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_openai.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_openai.rb new file mode 100644 index 0000000000..a4c73acd61 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_openai.rb @@ -0,0 +1,83 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. +module Elasticsearch + module API + module Inference + module Actions + # Create an OpenAI inference endpoint. + # Create an inference endpoint to perform an inference task with the `openai` service or `openai` compatible APIs. + # + # @option arguments [String] :task_type The type of the inference task that the model will perform. + # NOTE: The `chat_completion` task type only supports streaming and only through the _stream API. (*Required*) + # @option arguments [String] :openai_inference_id The unique identifier of the inference endpoint. (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body request body + # + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-openai + # + def put_openai(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.put_openai' } + + defined_params = [:task_type, :openai_inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type] + + unless arguments[:openai_inference_id] + raise ArgumentError, + "Required argument 'openai_inference_id' missing" + end + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _task_type = arguments.delete(:task_type) + + _openai_inference_id = arguments.delete(:openai_inference_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_openai_inference_id)}" + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_voyageai.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_voyageai.rb new file mode 100644 index 0000000000..e00b049734 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_voyageai.rb @@ -0,0 +1,83 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. +module Elasticsearch + module API + module Inference + module Actions + # Create a VoyageAI inference endpoint. + # Create an inference endpoint to perform an inference task with the `voyageai` service. + # Avoid creating multiple endpoints for the same model unless required, as each endpoint consumes significant resources. + # + # @option arguments [String] :task_type The type of the inference task that the model will perform. (*Required*) + # @option arguments [String] :voyageai_inference_id The unique identifier of the inference endpoint. (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body request body + # + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-voyageai + # + def put_voyageai(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.put_voyageai' } + + defined_params = [:task_type, :voyageai_inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type] + + unless arguments[:voyageai_inference_id] + raise ArgumentError, + "Required argument 'voyageai_inference_id' missing" + end + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _task_type = arguments.delete(:task_type) + + _voyageai_inference_id = arguments.delete(:voyageai_inference_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_voyageai_inference_id)}" + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_watsonx.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_watsonx.rb new file mode 100644 index 0000000000..9fca1baff7 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/put_watsonx.rb @@ -0,0 +1,85 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. +module Elasticsearch + module API + module Inference + module Actions + # Create a Watsonx inference endpoint. + # Create an inference endpoint to perform an inference task with the `watsonxai` service. + # You need an IBM Cloud Databases for Elasticsearch deployment to use the `watsonxai` inference service. + # You can provision one through the IBM catalog, the Cloud Databases CLI plug-in, the Cloud Databases API, or Terraform. + # + # @option arguments [String] :task_type The task type. + # The only valid task type for the model to perform is `text_embedding`. (*Required*) + # @option arguments [String] :watsonx_inference_id The unique identifier of the inference endpoint. (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference endpoint to be created. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body request body + # + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-put-watsonx + # + def put_watsonx(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.put_watsonx' } + + defined_params = [:task_type, :watsonx_inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'task_type' missing" unless arguments[:task_type] + + unless arguments[:watsonx_inference_id] + raise ArgumentError, + "Required argument 'watsonx_inference_id' missing" + end + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _task_type = arguments.delete(:task_type) + + _watsonx_inference_id = arguments.delete(:watsonx_inference_id) + + method = Elasticsearch::API::HTTP_PUT + path = "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_watsonx_inference_id)}" + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/rerank.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/rerank.rb new file mode 100644 index 0000000000..bdf90ef57a --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/rerank.rb @@ -0,0 +1,73 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. +module Elasticsearch + module API + module Inference + module Actions + # Perform reranking inference on the service + # + # @option arguments [String] :inference_id The unique identifier for the inference endpoint. (*Required*) + # @option arguments [Time] :timeout The amount of time to wait for the inference request to complete. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body request body + # + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-inference + # + def rerank(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.rerank' } + + defined_params = [:inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'inference_id' missing" unless arguments[:inference_id] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _inference_id = arguments.delete(:inference_id) + + method = Elasticsearch::API::HTTP_POST + path = "_inference/rerank/#{Utils.listify(_inference_id)}" + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/sparse_embedding.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/sparse_embedding.rb new file mode 100644 index 0000000000..cb8899802d --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/sparse_embedding.rb @@ -0,0 +1,73 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. +module Elasticsearch + module API + module Inference + module Actions + # Perform sparse embedding inference on the service + # + # @option arguments [String] :inference_id The inference Id (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference request to complete. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body request body + # + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-inference + # + def sparse_embedding(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.sparse_embedding' } + + defined_params = [:inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'inference_id' missing" unless arguments[:inference_id] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _inference_id = arguments.delete(:inference_id) + + method = Elasticsearch::API::HTTP_POST + path = "_inference/sparse_embedding/#{Utils.listify(_inference_id)}" + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/stream_completion.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/stream_completion.rb new file mode 100644 index 0000000000..715360042e --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/stream_completion.rb @@ -0,0 +1,77 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. +module Elasticsearch + module API + module Inference + module Actions + # Perform streaming inference. + # Get real-time responses for completion tasks by delivering answers incrementally, reducing response times during computation. + # This API works only with the completion task type. + # IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. + # This API requires the `monitor_inference` cluster privilege (the built-in `inference_admin` and `inference_user` roles grant this privilege). You must use a client that supports streaming. + # + # @option arguments [String] :inference_id The unique identifier for the inference endpoint. (*Required*) + # @option arguments [Time] :timeout The amount of time to wait for the inference request to complete. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body request body + # + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-stream-inference + # + def stream_completion(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.stream_completion' } + + defined_params = [:inference_id].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'inference_id' missing" unless arguments[:inference_id] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _inference_id = arguments.delete(:inference_id) + + method = Elasticsearch::API::HTTP_POST + path = "_inference/completion/#{Utils.listify(_inference_id)}/_stream" + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/unified_inference.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/text_embedding.rb similarity index 50% rename from elasticsearch-api/lib/elasticsearch/api/actions/inference/unified_inference.rb rename to elasticsearch-api/lib/elasticsearch/api/actions/inference/text_embedding.rb index f06a42fbef..b5dd02127f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/unified_inference.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/text_embedding.rb @@ -15,26 +15,37 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Inference module Actions - # Perform inference using the Unified Schema + # Perform text embedding inference on the service # - # @option arguments [String] :inference_id The inference Id - # @option arguments [String] :task_type The task type + # @option arguments [String] :inference_id The inference Id (*Required*) + # @option arguments [Time] :timeout Specifies the amount of time to wait for the inference request to complete. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The inference payload + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/unified-inference-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-inference # - def unified_inference(arguments = {}) - request_opts = { endpoint: arguments[:endpoint] || 'inference.unified_inference' } + def text_embedding(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'inference.text_embedding' } - defined_params = %i[inference_id task_type].each_with_object({}) do |variable, set_variables| + defined_params = [:inference_id].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -48,15 +59,9 @@ def unified_inference(arguments = {}) _inference_id = arguments.delete(:inference_id) - _task_type = arguments.delete(:task_type) - method = Elasticsearch::API::HTTP_POST - path = if _task_type && _inference_id - "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_inference_id)}/_unified" - else - "_inference/#{Utils.__listify(_inference_id)}/_unified" - end - params = {} + path = "_inference/text_embedding/#{Utils.listify(_inference_id)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/inference/update.rb b/elasticsearch-api/lib/elasticsearch/api/actions/inference/update.rb index 00bb270ee5..b6e4fad195 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/inference/update.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/inference/update.rb @@ -15,30 +15,46 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Inference module Actions - # Update inference + # Update an inference endpoint. + # Modify `task_settings`, secrets (within `service_settings`), or `num_allocations` for an inference endpoint, depending on the specific endpoint service and `task_type`. + # IMPORTANT: The inference APIs enable you to use certain services, such as built-in machine learning models (ELSER, E5), models uploaded through Eland, Cohere, OpenAI, Azure, Google AI Studio, Google Vertex AI, Anthropic, Watsonx.ai, or Hugging Face. + # For built-in models and models uploaded through Eland, the inference APIs offer an alternative way to use and manage trained models. + # However, if you do not plan to use the inference APIs to use these models or if you want to use non-NLP models, use the machine learning trained model APIs. # - # @option arguments [String] :inference_id The inference Id - # @option arguments [String] :task_type The task type + # @option arguments [String] :inference_id The unique identifier of the inference endpoint. (*Required*) + # @option arguments [String] :task_type The type of inference task that the model performs. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The inference endpoint's task and service settings + # @option arguments [Hash] :body inference_config # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-inference-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-inference-update # def update(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'inference.update' } - defined_params = %i[inference_id task_type].each_with_object({}) do |variable, set_variables| + defined_params = [:inference_id, :task_type].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? + raise ArgumentError, "Required argument 'body' missing" unless arguments[:body] raise ArgumentError, "Required argument 'inference_id' missing" unless arguments[:inference_id] arguments = arguments.clone @@ -52,11 +68,11 @@ def update(arguments = {}) method = Elasticsearch::API::HTTP_PUT path = if _task_type && _inference_id - "_inference/#{Utils.__listify(_task_type)}/#{Utils.__listify(_inference_id)}/_update" + "_inference/#{Utils.listify(_task_type)}/#{Utils.listify(_inference_id)}/_update" else - "_inference/#{Utils.__listify(_inference_id)}/_update" + "_inference/#{Utils.listify(_inference_id)}/_update" end - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/info.rb index ca00f362a8..e166b68c8d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/info.rb @@ -15,17 +15,30 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Returns basic information about the cluster. + # Get cluster info. + # Get basic build, version, and cluster information. + # ::: In Serverless, this API is retained for backward compatibility only. Some response fields, such as the version number, should be ignored. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-info # def info(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'info' } @@ -33,11 +46,11 @@ def info(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_geoip_database.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_geoip_database.rb index a242aaea65..c38fe6dedc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_geoip_database.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_geoip_database.rb @@ -15,21 +15,34 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Ingest module Actions - # Deletes a geoip database configuration + # Delete GeoIP database configurations. + # Delete one or more IP geolocation database configurations. # - # @option arguments [List] :id A comma-separated list of geoip database configurations to delete - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [Time] :timeout Explicit operation timeout + # @option arguments [String, Array] :id A comma-separated list of geoip database configurations to delete (*Required*) + # @option arguments [Time] :master_timeout The 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. + # @option arguments [Time] :timeout The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-geoip-database-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-delete-geoip-database # def delete_geoip_database(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ingest.delete_geoip_database' } @@ -49,7 +62,7 @@ def delete_geoip_database(arguments = {}) _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_DELETE - path = "_ingest/geoip/database/#{Utils.__listify(_id)}" + path = "_ingest/geoip/database/#{Utils.listify(_id)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_ip_location_database.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_ip_location_database.rb index f3a329a184..1eb8c28b0e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_ip_location_database.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_ip_location_database.rb @@ -15,21 +15,36 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Ingest module Actions - # Deletes an ip location database configuration + # Delete IP geolocation database configurations. # - # @option arguments [List] :id A comma-separated list of ip location database configurations to delete - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [Time] :timeout Explicit operation timeout + # @option arguments [String, Array] :id A comma-separated list of IP location database configurations. (*Required*) + # @option arguments [Time] :master_timeout The 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. + # A value of `-1` indicates that the request should never time out. Server default: 30s. + # @option arguments [Time] :timeout The period to wait for a response. + # If no response is received before the timeout expires, the request fails and returns an error. + # A value of `-1` indicates that the request should never time out. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-ip-location-database-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-delete-ip-location-database # def delete_ip_location_database(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ingest.delete_ip_location_database' } @@ -49,7 +64,7 @@ def delete_ip_location_database(arguments = {}) _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_DELETE - path = "_ingest/ip_location/database/#{Utils.__listify(_id)}" + path = "_ingest/ip_location/database/#{Utils.listify(_id)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb index d06a96d72f..3a03daaa20 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb @@ -15,21 +15,36 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Ingest module Actions - # Deletes a pipeline. + # Delete pipelines. + # Delete one or more ingest pipelines. # - # @option arguments [String] :id Pipeline ID - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [Time] :timeout Explicit operation timeout + # @option arguments [String] :id Pipeline ID or wildcard expression of pipeline IDs used to limit the request. + # To delete all ingest pipelines in a cluster, use a value of `*`. (*Required*) + # @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. + # @option arguments [Time] :timeout Period to wait for a response. + # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-pipeline-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-delete-pipeline # def delete_pipeline(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ingest.delete_pipeline' } @@ -49,7 +64,7 @@ def delete_pipeline(arguments = {}) _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_DELETE - path = "_ingest/pipeline/#{Utils.__listify(_id)}" + path = "_ingest/pipeline/#{Utils.listify(_id)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/geo_ip_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/geo_ip_stats.rb index 6764c9cd68..ae1eacf756 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/geo_ip_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/geo_ip_stats.rb @@ -15,18 +15,30 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Ingest module Actions - # Returns statistical information about geoip databases + # Get GeoIP statistics. + # Get download statistics for GeoIP2 databases that are used with the GeoIP processor. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/geoip-stats-api.html + # @see https://www.elastic.co/docs/reference/enrich-processor/geoip-processor # def geo_ip_stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ingest.geo_ip_stats' } @@ -34,11 +46,11 @@ def geo_ip_stats(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_ingest/geoip/stats' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_geoip_database.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_geoip_database.rb index 1cc5f6078b..6aff3d7108 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_geoip_database.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_geoip_database.rb @@ -15,19 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Ingest module Actions - # Returns geoip database configuration. + # Get GeoIP database configurations. + # Get information about one or more IP geolocation database configurations. # - # @option arguments [List] :id A comma-separated list of geoip database configurations to get; use `*` to get all geoip database configurations + # @option arguments [String, Array] :id A comma-separated list of database configuration IDs to retrieve. + # Wildcard (`*`) expressions are supported. + # To get all database configurations, omit this parameter or use `*`. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-geoip-database-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-get-geoip-database # def get_geoip_database(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ingest.get_geoip_database' } @@ -46,11 +60,11 @@ def get_geoip_database(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _id - "_ingest/geoip/database/#{Utils.__listify(_id)}" + "_ingest/geoip/database/#{Utils.listify(_id)}" else '_ingest/geoip/database' end - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_ip_location_database.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_ip_location_database.rb index 9292718d01..4124fc079f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_ip_location_database.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_ip_location_database.rb @@ -15,19 +15,32 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Ingest module Actions - # Returns the specified ip location database configuration + # Get IP geolocation database configurations. # - # @option arguments [List] :id A comma-separated list of ip location database configurations to get; use `*` to get all ip location database configurations + # @option arguments [String, Array] :id Comma-separated list of database configuration IDs to retrieve. + # Wildcard (`*`) expressions are supported. + # To get all database configurations, omit this parameter or use `*`. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ip-location-database-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-get-ip-location-database # def get_ip_location_database(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ingest.get_ip_location_database' } @@ -46,11 +59,11 @@ def get_ip_location_database(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _id - "_ingest/ip_location/database/#{Utils.__listify(_id)}" + "_ingest/ip_location/database/#{Utils.listify(_id)}" else '_ingest/ip_location/database' end - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_pipeline.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_pipeline.rb index 250ff6d312..5cce725431 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/get_pipeline.rb @@ -15,21 +15,37 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Ingest module Actions - # Returns a pipeline. + # Get pipelines. + # Get information about one or more ingest pipelines. + # This API returns a local reference of the pipeline. # - # @option arguments [String] :id Comma separated list of pipeline ids. Wildcards supported + # @option arguments [String] :id Comma-separated list of pipeline IDs to retrieve. + # Wildcard (`*`) expressions are supported. + # To get all ingest pipelines, omit this parameter or use `*`. + # @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. # @option arguments [Boolean] :summary Return pipelines without their definitions (default: false) - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-pipeline-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-get-pipeline # def get_pipeline(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ingest.get_pipeline' } @@ -48,7 +64,7 @@ def get_pipeline(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _id - "_ingest/pipeline/#{Utils.__listify(_id)}" + "_ingest/pipeline/#{Utils.listify(_id)}" else '_ingest/pipeline' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/processor_grok.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/processor_grok.rb index 6dbfa81bbc..d095731eeb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/processor_grok.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/processor_grok.rb @@ -15,18 +15,32 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Ingest module Actions - # Returns a list of the built-in patterns. + # Run a grok processor. + # Extract structured fields out of a single text field within a document. + # You must choose which field to extract matched fields from, as well as the grok pattern you expect will match. + # A grok pattern is like a regular expression that supports aliased expressions that can be reused. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/grok-processor.html#grok-processor-rest-get + # @see https://www.elastic.co/docs/reference/enrich-processor/grok-processor # def processor_grok(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ingest.processor_grok' } @@ -34,11 +48,11 @@ def processor_grok(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_ingest/processor/grok' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_geoip_database.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_geoip_database.rb index 235affce79..34276247bc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_geoip_database.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_geoip_database.rb @@ -15,22 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Ingest module Actions - # Puts the configuration for a geoip database to be downloaded + # Create or update a GeoIP database configuration. + # Refer to the create or update IP geolocation database configuration API. # - # @option arguments [String] :id The id of the database configuration - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [Time] :timeout Explicit operation timeout + # @option arguments [String] :id ID of the database configuration to create or update. (*Required*) + # @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. + # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The database configuration definition (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-geoip-database-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-put-geoip-database # def put_geoip_database(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ingest.put_geoip_database' } @@ -51,7 +64,7 @@ def put_geoip_database(arguments = {}) _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_PUT - path = "_ingest/geoip/database/#{Utils.__listify(_id)}" + path = "_ingest/geoip/database/#{Utils.listify(_id)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_ip_location_database.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_ip_location_database.rb index 0305aef837..a4fca9aa6b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_ip_location_database.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_ip_location_database.rb @@ -15,22 +15,37 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Ingest module Actions - # Puts the configuration for a ip location database to be downloaded + # Create or update an IP geolocation database configuration. # - # @option arguments [String] :id The id of the database configuration - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [Time] :timeout Explicit operation timeout + # @option arguments [String] :id The database configuration identifier. (*Required*) + # @option arguments [Time] :master_timeout The 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. + # A value of `-1` indicates that the request should never time out. Server default: 30s. + # @option arguments [Time] :timeout The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. + # If no response is received before the timeout expires, the cluster metadata update still applies but the response indicates that it was not completely acknowledged. + # A value of `-1` indicates that the request should never time out. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The database configuration definition (*Required*) + # @option arguments [Hash] :body configuration # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-ip-location-database-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-put-ip-location-database # def put_ip_location_database(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ingest.put_ip_location_database' } @@ -51,7 +66,7 @@ def put_ip_location_database(arguments = {}) _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_PUT - path = "_ingest/ip_location/database/#{Utils.__listify(_id)}" + path = "_ingest/ip_location/database/#{Utils.listify(_id)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_pipeline.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_pipeline.rb index 0c626836e2..7cc6e1ed25 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/put_pipeline.rb @@ -15,23 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Ingest module Actions - # Creates or updates a pipeline. + # Create or update a pipeline. + # Changes made using this API take effect immediately. # - # @option arguments [String] :id Pipeline ID + # @option arguments [String] :id ID of the ingest pipeline to create or update. (*Required*) + # @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. + # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. # @option arguments [Integer] :if_version Required version for optimistic concurrency control for pipeline updates - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The ingest definition (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-pipeline-api.html + # @see https://www.elastic.co/docs/manage-data/ingest/transform-enrich/ingest-pipelines # def put_pipeline(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ingest.put_pipeline' } @@ -52,7 +64,7 @@ def put_pipeline(arguments = {}) _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_PUT - path = "_ingest/pipeline/#{Utils.__listify(_id)}" + path = "_ingest/pipeline/#{Utils.listify(_id)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/simulate.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/simulate.rb index 8ea6e3c717..6e3976b184 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ingest/simulate.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ingest/simulate.rb @@ -15,21 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Ingest module Actions - # Allows to simulate a pipeline with example documents. + # Simulate a pipeline. + # Run an ingest pipeline against a set of provided documents. + # You can either specify an existing pipeline to use with the provided documents or supply a pipeline definition in the body of the request. # - # @option arguments [String] :id Pipeline ID - # @option arguments [Boolean] :verbose Verbose mode. Display data output for each processor in executed pipeline + # @option arguments [String] :id The pipeline to test. + # If you don't specify a `pipeline` in the request body, this parameter is required. + # @option arguments [Boolean] :verbose If `true`, the response includes output data for each processor in the executed pipeline. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The simulate definition (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/simulate-pipeline-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ingest-simulate # def simulate(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ingest.simulate' } @@ -50,7 +64,7 @@ def simulate(arguments = {}) method = Elasticsearch::API::HTTP_POST path = if _id - "_ingest/pipeline/#{Utils.__listify(_id)}/_simulate" + "_ingest/pipeline/#{Utils.listify(_id)}/_simulate" else '_ingest/pipeline/_simulate' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/knn_search.rb b/elasticsearch-api/lib/elasticsearch/api/actions/knn_search.rb deleted file mode 100644 index 8a94ed0529..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/actions/knn_search.rb +++ /dev/null @@ -1,69 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. -# -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# -module Elasticsearch - module API - module Actions - # Performs a kNN search. - # 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 [List] :index A comma-separated list of index names to search; use `_all` to perform the operation on all indices - # @option arguments [List] :routing A comma-separated list of specific routing values - # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The search definition - # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html - # - def knn_search(arguments = {}) - request_opts = { endpoint: arguments[:endpoint] || 'knn_search' } - - defined_params = [:index].each_with_object({}) do |variable, set_variables| - set_variables[variable] = arguments[variable] if arguments.key?(variable) - end - request_opts[:defined_params] = defined_params unless defined_params.empty? - - raise ArgumentError, "Required argument 'index' missing" unless arguments[:index] - - arguments = arguments.clone - headers = arguments.delete(:headers) || {} - - body = arguments.delete(:body) - - _index = arguments.delete(:index) - - method = if body - Elasticsearch::API::HTTP_POST - else - Elasticsearch::API::HTTP_GET - end - - path = "#{Utils.__listify(_index)}/_knn_search" - params = Utils.process_params(arguments) - - Elasticsearch::API::Response.new( - perform_request(method, path, params, body, headers, request_opts) - ) - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/license/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/license/delete.rb index b4a2a5fd9d..d625d5f513 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/license/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/license/delete.rb @@ -15,20 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module License module Actions - # Deletes licensing information for the cluster + # Delete the license. + # When the license expires, your subscription level reverts to Basic. + # If the operator privileges feature is enabled, only operator users can use this API. # - # @option arguments [Time] :master_timeout Timeout for processing on master node - # @option arguments [Time] :timeout Timeout for acknowledgement of update from all nodes in cluster + # @option arguments [Time] :master_timeout The period to wait for a connection to the master node. Server default: 30s. + # @option arguments [Time] :timeout The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-license.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-delete # def delete(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'license.delete' } @@ -36,7 +49,7 @@ def delete(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_DELETE path = '_license' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/license/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/license/get.rb index ee9dc42840..96628fdfa6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/license/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/license/get.rb @@ -15,20 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module License module Actions - # Retrieves licensing information for the cluster + # Get license information. + # Get information about your Elastic license including its type, its status, when it was issued, and when it expires. # - # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) - # @option arguments [Boolean] :accept_enterprise Supported for backwards compatibility with 7.x. If this param is used it must be set to true *Deprecated* + # @option arguments [Boolean] :accept_enterprise If `true`, this parameter returns enterprise for Enterprise license types. If `false`, this parameter returns platinum for both platinum and enterprise license types. This behavior is maintained for backwards compatibility. + # This parameter is deprecated and will always be set to true in 8.x. Server default: true. + # @option arguments [Boolean] :local Specifies whether to retrieve local information. The default value is `false`, which means the information is retrieved from the master node. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-license.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-get # def get(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'license.get' } @@ -36,7 +49,7 @@ def get(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_license' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/license/get_basic_status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/license/get_basic_status.rb index 351df544dc..b6823e5353 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/license/get_basic_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/license/get_basic_status.rb @@ -15,18 +15,29 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module License module Actions - # Retrieves information about the status of the basic license. + # Get the basic license status. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-basic-status.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-get-basic-status # def get_basic_status(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'license.get_basic_status' } @@ -34,11 +45,11 @@ def get_basic_status(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_license/basic_status' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/license/get_trial_status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/license/get_trial_status.rb index e611a4570c..ee251073f5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/license/get_trial_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/license/get_trial_status.rb @@ -15,18 +15,29 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module License module Actions - # Retrieves information about the status of the trial license. + # Get the trial status. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trial-status.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-get-trial-status # def get_trial_status(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'license.get_trial_status' } @@ -34,11 +45,11 @@ def get_trial_status(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_license/trial_status' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/license/post.rb b/elasticsearch-api/lib/elasticsearch/api/actions/license/post.rb index 54a72d52e3..015e91606b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/license/post.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/license/post.rb @@ -15,22 +15,39 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module License module Actions - # Updates the license for the cluster. + # Update the license. + # You can update your license at runtime without shutting down your nodes. + # License updates take effect immediately. + # If the license you are installing does not support all of the features that were available with your previous license, however, you are notified in the response. + # You must then re-submit the API request with the acknowledge parameter set to true. + # NOTE: If Elasticsearch security features are enabled and you are installing a gold or higher license, you must enable TLS on the transport networking layer before you install the license. + # If the operator privileges feature is enabled, only operator users can use this API. # - # @option arguments [Boolean] :acknowledge whether the user has acknowledged acknowledge messages (default: false) - # @option arguments [Time] :master_timeout Timeout for processing on master node - # @option arguments [Time] :timeout Timeout for acknowledgement of update from all nodes in cluster + # @option arguments [Boolean] :acknowledge Specifies whether you acknowledge the license changes. + # @option arguments [Time] :master_timeout The period to wait for a connection to the master node. Server default: 30s. + # @option arguments [Time] :timeout The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body licenses to be installed + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-license.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-post # def post(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'license.post' } @@ -38,7 +55,7 @@ def post(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_PUT path = '_license' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_basic.rb b/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_basic.rb index b95eb10bf9..9c14e722d8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_basic.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_basic.rb @@ -15,21 +15,37 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module License module Actions - # Starts an indefinite basic license. + # Start a basic license. + # Start an indefinite basic license, which gives access to all the basic features. + # NOTE: In order to start a basic license, you must not currently have a basic license. + # If the basic license does not support all of the features that are available with your current license, however, you are notified in the response. + # You must then re-submit the API request with the `acknowledge` parameter set to `true`. + # To check the status of your basic license, use the get basic license API. # # @option arguments [Boolean] :acknowledge whether the user has acknowledged acknowledge messages (default: false) - # @option arguments [Time] :master_timeout Timeout for processing on master node - # @option arguments [Time] :timeout Timeout for acknowledgement of update from all nodes in cluster + # @option arguments [Time] :master_timeout Period to wait for a connection to the master node. Server default: 30s. + # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/start-basic.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-post-start-basic # def post_start_basic(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'license.post_start_basic' } @@ -37,7 +53,7 @@ def post_start_basic(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_POST path = '_license/start_basic' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_trial.rb b/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_trial.rb index 561bb0f061..f0ae40da9c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_trial.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/license/post_start_trial.rb @@ -15,21 +15,36 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module License module Actions - # starts a limited time trial license. + # Start a trial. + # Start a 30-day trial, which gives access to all subscription features. + # NOTE: You are allowed to start a trial only if your cluster has not already activated a trial for the current major product version. + # For example, if you have already activated a trial for v8.0, you cannot start a new trial until v9.0. You can, however, request an extended trial at https://www.elastic.co/trialextension. + # To check the status of your trial, use the get trial status API. # - # @option arguments [String] :type The type of trial license to generate (default: "trial") # @option arguments [Boolean] :acknowledge whether the user has acknowledged acknowledge messages (default: false) - # @option arguments [Time] :master_timeout Timeout for processing on master node + # @option arguments [String] :type The type of trial license to generate (default: "trial") + # @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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/start-trial.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-license-post-start-trial # def post_start_trial(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'license.post_start_trial' } @@ -37,7 +52,7 @@ def post_start_trial(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_POST path = '_license/start_trial' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/logstash/delete_pipeline.rb b/elasticsearch-api/lib/elasticsearch/api/actions/logstash/delete_pipeline.rb index 3b8a16c6d9..0ced1ca546 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/logstash/delete_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/logstash/delete_pipeline.rb @@ -15,19 +15,32 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Logstash module Actions - # Deletes Logstash Pipelines used by Central Management + # Delete a Logstash pipeline. + # Delete a pipeline that is used for Logstash Central Management. + # If the request succeeds, you receive an empty response with an appropriate status code. # - # @option arguments [String] :id The ID of the Pipeline + # @option arguments [String] :id An identifier for the pipeline. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-delete-pipeline.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-logstash-delete-pipeline # def delete_pipeline(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'logstash.delete_pipeline' } @@ -47,8 +60,8 @@ def delete_pipeline(arguments = {}) _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_DELETE - path = "_logstash/pipeline/#{Utils.__listify(_id)}" - params = {} + path = "_logstash/pipeline/#{Utils.listify(_id)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/logstash/get_pipeline.rb b/elasticsearch-api/lib/elasticsearch/api/actions/logstash/get_pipeline.rb index eaed065ef7..a6578386dc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/logstash/get_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/logstash/get_pipeline.rb @@ -15,19 +15,31 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Logstash module Actions - # Retrieves Logstash Pipelines used by Central Management + # Get Logstash pipelines. + # Get pipelines that are used for Logstash Central Management. # - # @option arguments [String] :id A comma-separated list of Pipeline IDs + # @option arguments [String, Array] :id A comma-separated list of pipeline identifiers. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-get-pipeline.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-logstash-get-pipeline # def get_pipeline(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'logstash.get_pipeline' } @@ -46,11 +58,11 @@ def get_pipeline(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _id - "_logstash/pipeline/#{Utils.__listify(_id)}" + "_logstash/pipeline/#{Utils.listify(_id)}" else '_logstash/pipeline' end - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/logstash/put_pipeline.rb b/elasticsearch-api/lib/elasticsearch/api/actions/logstash/put_pipeline.rb index 4e51cb3b13..68ed5fbded 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/logstash/put_pipeline.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/logstash/put_pipeline.rb @@ -15,20 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Logstash module Actions - # Adds and updates Logstash Pipelines used for Central Management + # Create or update a Logstash pipeline. + # Create a pipeline that is used for Logstash Central Management. + # If the specified pipeline exists, it is replaced. # - # @option arguments [String] :id The ID of the Pipeline + # @option arguments [String] :id An identifier for the pipeline. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The Pipeline to add or update (*Required*) + # @option arguments [Hash] :body pipeline # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/logstash-api-put-pipeline.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-logstash-put-pipeline # def put_pipeline(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'logstash.put_pipeline' } @@ -49,8 +62,8 @@ def put_pipeline(arguments = {}) _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_PUT - path = "_logstash/pipeline/#{Utils.__listify(_id)}" - params = {} + path = "_logstash/pipeline/#{Utils.listify(_id)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/clear_trained_model_deployment_cache.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/clear_trained_model_deployment_cache.rb index 24d3aa5fc1..01f1132a99 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/clear_trained_model_deployment_cache.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/clear_trained_model_deployment_cache.rb @@ -15,19 +15,34 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Clear the cached results from a trained model deployment + # Clear trained model deployment cache. + # Cache will be cleared on all nodes where the trained model is assigned. + # A trained model deployment may have an inference cache enabled. + # As requests are handled by each allocated node, their responses may be cached on that individual node. + # Calling this API clears the caches without restarting the deployment. # # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-trained-model-deployment-cache.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-clear-trained-model-deployment-cache # def clear_trained_model_deployment_cache(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.clear_trained_model_deployment_cache' } @@ -47,8 +62,8 @@ def clear_trained_model_deployment_cache(arguments = {}) _model_id = arguments.delete(:model_id) method = Elasticsearch::API::HTTP_POST - path = "_ml/trained_models/#{Utils.__listify(_model_id)}/deployment/cache/_clear" - params = {} + path = "_ml/trained_models/#{Utils.listify(_model_id)}/deployment/cache/_clear" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/close_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/close_job.rb index 5683ec5644..4edcc0f69b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/close_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/close_job.rb @@ -15,23 +15,40 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Closes one or more anomaly detection jobs. A job can be opened and closed multiple times throughout its lifecycle. + # Close anomaly detection jobs. + # A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results. + # When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data. + # If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. + # When a datafeed that has a specified end date stops, it automatically closes its associated job. # - # @option arguments [String] :job_id The name of the job to close - # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) - # @option arguments [Boolean] :force True if the job should be forcefully closed - # @option arguments [Time] :timeout Controls the time to wait until a job has closed. Default to 30 minutes + # @option arguments [String] :job_id Identifier for the anomaly detection job. It can be a job identifier, a group name, or a wildcard expression. You can close multiple anomaly detection jobs in a single API request by using a group name, a comma-separated list of jobs, or a wildcard expression. You can close all jobs by using `_all` or by specifying `*` as the job identifier. (*Required*) + # @option arguments [Boolean] :allow_no_match Specifies what to do when the request: contains wildcard expressions and there are no jobs that match; contains the `_all` string or no identifiers and there are no matches; or contains wildcard expressions and there are only partial matches. By default, it returns an empty jobs array when there are no matches and the subset of results when there are partial matches. + # If `false`, the request returns a 404 status code when there are no matches or only partial matches. Server default: true. + # @option arguments [Boolean] :force Use to close a failed job, or to forcefully close a job which has not responded to its initial close request; the request returns without performing the associated actions such as flushing buffers and persisting the model snapshots. + # If you want the job to be in a consistent state after the close job API returns, do not set to `true`. This parameter should be used only in situations where the job has already failed or where you are not interested in results the job might have recently produced or might produce in the future. + # @option arguments [Time] :timeout Controls the time to wait until a job has closed. Server default: 30m. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The URL params optionally sent in the body + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-close-job.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-close-job # def close_job(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.close_job' } @@ -51,7 +68,7 @@ def close_job(arguments = {}) _job_id = arguments.delete(:job_id) method = Elasticsearch::API::HTTP_POST - path = "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/_close" + path = "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/_close" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar.rb index 196d6e25b1..74da1f5f59 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar.rb @@ -15,19 +15,31 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Deletes a calendar. + # Delete a calendar. + # Remove all scheduled events from a calendar, then delete it. # - # @option arguments [String] :calendar_id The ID of the calendar to delete + # @option arguments [String] :calendar_id A string that uniquely identifies a calendar. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-calendar # def delete_calendar(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_calendar' } @@ -47,8 +59,8 @@ def delete_calendar(arguments = {}) _calendar_id = arguments.delete(:calendar_id) method = Elasticsearch::API::HTTP_DELETE - path = "_ml/calendars/#{Utils.__listify(_calendar_id)}" - params = {} + path = "_ml/calendars/#{Utils.listify(_calendar_id)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar_event.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar_event.rb index 2e9d83e657..85924cd9e7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar_event.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar_event.rb @@ -15,25 +15,37 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Deletes scheduled events from a calendar. + # Delete events from a calendar. # - # @option arguments [String] :calendar_id The ID of the calendar to modify - # @option arguments [String] :event_id The ID of the event to remove from the calendar + # @option arguments [String] :calendar_id A string that uniquely identifies a calendar. (*Required*) + # @option arguments [String] :event_id Identifier for the scheduled event. + # You can obtain this identifier by using the get calendar events API. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-event.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-calendar-event # def delete_calendar_event(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_calendar_event' } - defined_params = %i[calendar_id event_id].each_with_object({}) do |variable, set_variables| + defined_params = [:calendar_id, :event_id].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -51,8 +63,8 @@ def delete_calendar_event(arguments = {}) _event_id = arguments.delete(:event_id) method = Elasticsearch::API::HTTP_DELETE - path = "_ml/calendars/#{Utils.__listify(_calendar_id)}/events/#{Utils.__listify(_event_id)}" - params = {} + path = "_ml/calendars/#{Utils.listify(_calendar_id)}/events/#{Utils.listify(_event_id)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar_job.rb index f13bc4a282..d4cef50c3e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_calendar_job.rb @@ -15,25 +15,37 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Deletes anomaly detection jobs from a calendar. + # Delete anomaly jobs from a calendar. # - # @option arguments [String] :calendar_id The ID of the calendar to modify - # @option arguments [String] :job_id The ID of the job to remove from the calendar + # @option arguments [String] :calendar_id A string that uniquely identifies a calendar. (*Required*) + # @option arguments [String, Array] :job_id An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a + # comma-separated list of jobs or groups. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar-job.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-calendar-job # def delete_calendar_job(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_calendar_job' } - defined_params = %i[calendar_id job_id].each_with_object({}) do |variable, set_variables| + defined_params = [:calendar_id, :job_id].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -51,8 +63,8 @@ def delete_calendar_job(arguments = {}) _job_id = arguments.delete(:job_id) method = Elasticsearch::API::HTTP_DELETE - path = "_ml/calendars/#{Utils.__listify(_calendar_id)}/jobs/#{Utils.__listify(_job_id)}" - params = {} + path = "_ml/calendars/#{Utils.listify(_calendar_id)}/jobs/#{Utils.listify(_job_id)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_data_frame_analytics.rb index 3bb2df5542..d7342cd1bf 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_data_frame_analytics.rb @@ -15,21 +15,32 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Deletes an existing data frame analytics job. + # Delete a data frame analytics job. # - # @option arguments [String] :id The ID of the data frame analytics to delete - # @option arguments [Boolean] :force True if the job should be forcefully deleted - # @option arguments [Time] :timeout Controls the time to wait until a job is deleted. Defaults to 1 minute + # @option arguments [String] :id Identifier for the data frame analytics job. (*Required*) + # @option arguments [Boolean] :force If `true`, it deletes a job that is not stopped; this method is quicker than stopping and deleting the job. + # @option arguments [Time] :timeout The time to wait for the job to be deleted. Server default: 1m. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-dfanalytics.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-data-frame-analytics # def delete_data_frame_analytics(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_data_frame_analytics' } @@ -49,7 +60,7 @@ def delete_data_frame_analytics(arguments = {}) _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_DELETE - path = "_ml/data_frame/analytics/#{Utils.__listify(_id)}" + path = "_ml/data_frame/analytics/#{Utils.listify(_id)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_datafeed.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_datafeed.rb index d8778a21b3..2dd36e03b9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_datafeed.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_datafeed.rb @@ -15,20 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Deletes an existing datafeed. + # Delete a datafeed. # - # @option arguments [String] :datafeed_id The ID of the datafeed to delete - # @option arguments [Boolean] :force True if the datafeed should be forcefully deleted + # @option arguments [String] :datafeed_id A numerical character string that uniquely identifies the datafeed. This + # identifier can contain lowercase alphanumeric characters (a-z and 0-9), + # hyphens, and underscores. It must start and end with alphanumeric + # characters. (*Required*) + # @option arguments [Boolean] :force Use to forcefully delete a started datafeed; this method is quicker than + # stopping and deleting the datafeed. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-datafeed.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-datafeed # def delete_datafeed(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_datafeed' } @@ -48,7 +63,7 @@ def delete_datafeed(arguments = {}) _datafeed_id = arguments.delete(:datafeed_id) method = Elasticsearch::API::HTTP_DELETE - path = "_ml/datafeeds/#{Utils.__listify(_datafeed_id)}" + path = "_ml/datafeeds/#{Utils.listify(_datafeed_id)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_expired_data.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_expired_data.rb index 5d9f381d1d..2b4bd4bb87 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_expired_data.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_expired_data.rb @@ -15,22 +15,43 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Deletes expired and unused machine learning data. + # Delete expired ML data. + # Delete all job results, model snapshots and forecast data that have exceeded + # their retention days period. Machine learning state documents that are not + # associated with any job are also deleted. + # You can limit the request to a single or set of anomaly detection jobs by + # using a job identifier, a group name, a comma-separated list of jobs, or a + # wildcard expression. You can delete expired data for all anomaly detection + # jobs by using `_all`, by specifying `*` as the ``, or by omitting the + # ``. # - # @option arguments [String] :job_id The ID of the job(s) to perform expired data hygiene for - # @option arguments [Number] :requests_per_second The desired requests per second for the deletion processes. - # @option arguments [Time] :timeout How long can the underlying delete processes run until they are canceled + # @option arguments [String] :job_id Identifier for an anomaly detection job. It can be a job identifier, a + # group name, or a wildcard expression. + # @option arguments [Float] :requests_per_second The desired requests per second for the deletion processes. The default + # behavior is no throttling. + # @option arguments [Time] :timeout How long can the underlying delete processes run until they are canceled. Server default: 8h. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body deleting expired data parameters + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-expired-data.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-expired-data # def delete_expired_data(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_expired_data' } @@ -49,7 +70,7 @@ def delete_expired_data(arguments = {}) method = Elasticsearch::API::HTTP_DELETE path = if _job_id - "_ml/_delete_expired_data/#{Utils.__listify(_job_id)}" + "_ml/_delete_expired_data/#{Utils.listify(_job_id)}" else '_ml/_delete_expired_data' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_filter.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_filter.rb index 1079e0b75d..25c6ac8b36 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_filter.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_filter.rb @@ -15,19 +15,32 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Deletes a filter. + # Delete a filter. + # If an anomaly detection job references the filter, you cannot delete the + # filter. You must update or delete the job before you can delete the filter. # - # @option arguments [String] :filter_id The ID of the filter to delete + # @option arguments [String] :filter_id A string that uniquely identifies a filter. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-filter.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-filter # def delete_filter(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_filter' } @@ -47,8 +60,8 @@ def delete_filter(arguments = {}) _filter_id = arguments.delete(:filter_id) method = Elasticsearch::API::HTTP_DELETE - path = "_ml/filters/#{Utils.__listify(_filter_id)}" - params = {} + path = "_ml/filters/#{Utils.listify(_filter_id)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_forecast.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_forecast.rb index 0a0d52aab3..e2efd704dc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_forecast.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_forecast.rb @@ -15,27 +15,49 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Deletes forecasts from a machine learning job. + # Delete forecasts from a job. + # By default, forecasts are retained for 14 days. You can specify a + # different retention period with the `expires_in` parameter in the forecast + # jobs API. The delete forecast API enables you to delete one or more + # forecasts before they expire. # - # @option arguments [String] :job_id The ID of the job from which to delete forecasts - # @option arguments [String] :forecast_id The ID of the forecast to delete, can be comma delimited list. Leaving blank implies `_all` - # @option arguments [Boolean] :allow_no_forecasts Whether to ignore if `_all` matches no forecasts - # @option arguments [Time] :timeout Controls the time to wait until the forecast(s) are deleted. Default to 30 seconds + # @option arguments [String] :job_id Identifier for the anomaly detection job. (*Required*) + # @option arguments [String] :forecast_id A comma-separated list of forecast identifiers. If you do not specify + # this optional parameter or if you specify `_all` or `*` the API deletes + # all forecasts from the job. + # @option arguments [Boolean] :allow_no_forecasts Specifies whether an error occurs when there are no forecasts. In + # particular, if this parameter is set to `false` and there are no + # forecasts associated with the job, attempts to delete all forecasts + # return an error. Server default: true. + # @option arguments [Time] :timeout Specifies the period of time to wait for the completion of the delete + # operation. When this period of time elapses, the API fails and returns an + # error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-forecast.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-forecast # def delete_forecast(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_forecast' } - defined_params = %i[job_id forecast_id].each_with_object({}) do |variable, set_variables| + defined_params = [:job_id, :forecast_id].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -53,9 +75,9 @@ def delete_forecast(arguments = {}) method = Elasticsearch::API::HTTP_DELETE path = if _job_id && _forecast_id - "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/_forecast/#{Utils.__listify(_forecast_id)}" + "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/_forecast/#{Utils.listify(_forecast_id)}" else - "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/_forecast" + "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/_forecast" end params = Utils.process_params(arguments) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_job.rb index 7ae7b88f3f..727b039e40 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_job.rb @@ -15,22 +15,43 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Deletes an existing anomaly detection job. + # Delete an anomaly detection job. + # All job configuration, model state and results are deleted. + # It is not currently possible to delete multiple jobs using wildcards or a + # comma separated list. If you delete a job that has a datafeed, the request + # first tries to delete the datafeed. This behavior is equivalent to calling + # the delete datafeed API with the same timeout and force parameters as the + # delete job request. # - # @option arguments [String] :job_id The ID of the job to delete - # @option arguments [Boolean] :force True if the job should be forcefully deleted - # @option arguments [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning - # @option arguments [Boolean] :delete_user_annotations Should annotations added by the user be deleted + # @option arguments [String] :job_id Identifier for the anomaly detection job. (*Required*) + # @option arguments [Boolean] :force Use to forcefully delete an opened job; this method is quicker than + # closing and deleting the job. + # @option arguments [Boolean] :delete_user_annotations Specifies whether annotations that have been added by the + # user should be deleted along with any auto-generated annotations when the job is + # reset. + # @option arguments [Boolean] :wait_for_completion Specifies whether the request should return immediately or wait until the + # job deletion completes. Server default: true. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-job # def delete_job(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_job' } @@ -50,7 +71,7 @@ def delete_job(arguments = {}) _job_id = arguments.delete(:job_id) method = Elasticsearch::API::HTTP_DELETE - path = "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}" + path = "_ml/anomaly_detectors/#{Utils.listify(_job_id)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_model_snapshot.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_model_snapshot.rb index 85cb5b61f7..fdd951a145 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_model_snapshot.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_model_snapshot.rb @@ -15,25 +15,39 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Deletes an existing model snapshot. + # Delete a model snapshot. + # You cannot delete the active model snapshot. To delete that snapshot, first + # revert to a different one. To identify the active model snapshot, refer to + # the `model_snapshot_id` in the results from the get jobs API. # - # @option arguments [String] :job_id The ID of the job to fetch - # @option arguments [String] :snapshot_id The ID of the snapshot to delete + # @option arguments [String] :job_id Identifier for the anomaly detection job. (*Required*) + # @option arguments [String] :snapshot_id Identifier for the model snapshot. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapshot.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-model-snapshot # def delete_model_snapshot(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_model_snapshot' } - defined_params = %i[job_id snapshot_id].each_with_object({}) do |variable, set_variables| + defined_params = [:job_id, :snapshot_id].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -51,8 +65,8 @@ def delete_model_snapshot(arguments = {}) _snapshot_id = arguments.delete(:snapshot_id) method = Elasticsearch::API::HTTP_DELETE - path = "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/model_snapshots/#{Utils.__listify(_snapshot_id)}" - params = {} + path = "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/model_snapshots/#{Utils.listify(_snapshot_id)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_trained_model.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_trained_model.rb index 56ea524b30..b1343b926d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_trained_model.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_trained_model.rb @@ -15,21 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Deletes an existing trained inference model that is currently not referenced by an ingest pipeline. + # Delete an unreferenced trained model. + # The request deletes a trained inference model that is not referenced by an ingest pipeline. # - # @option arguments [String] :model_id The ID of the trained model to delete - # @option arguments [Time] :timeout Controls the amount of time to wait for the model to be deleted. - # @option arguments [Boolean] :force True if the model should be forcefully deleted + # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*) + # @option arguments [Boolean] :force Forcefully deletes a trained model that is referenced by ingest pipelines or has a started deployment. + # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-trained-model # def delete_trained_model(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_trained_model' } @@ -49,7 +61,7 @@ def delete_trained_model(arguments = {}) _model_id = arguments.delete(:model_id) method = Elasticsearch::API::HTTP_DELETE - path = "_ml/trained_models/#{Utils.__listify(_model_id)}" + path = "_ml/trained_models/#{Utils.listify(_model_id)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_trained_model_alias.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_trained_model_alias.rb index cc56b05856..bc2b16ef09 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_trained_model_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/delete_trained_model_alias.rb @@ -15,25 +15,39 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Deletes a model alias that refers to the trained model + # Delete a trained model alias. + # This API deletes an existing model alias that refers to a trained model. If + # the model alias is missing or refers to a model other than the one identified + # by the `model_id`, this API returns an error. # - # @option arguments [String] :model_alias The trained model alias to delete - # @option arguments [String] :model_id The trained model where the model alias is assigned + # @option arguments [String] :model_alias The model alias to delete. (*Required*) + # @option arguments [String] :model_id The trained model ID to which the model alias refers. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models-aliases.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-delete-trained-model-alias # def delete_trained_model_alias(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.delete_trained_model_alias' } - defined_params = %i[model_id model_alias].each_with_object({}) do |variable, set_variables| + defined_params = [:model_id, :model_alias].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -51,8 +65,8 @@ def delete_trained_model_alias(arguments = {}) _model_id = arguments.delete(:model_id) method = Elasticsearch::API::HTTP_DELETE - path = "_ml/trained_models/#{Utils.__listify(_model_id)}/model_aliases/#{Utils.__listify(_model_alias)}" - params = {} + path = "_ml/trained_models/#{Utils.listify(_model_id)}/model_aliases/#{Utils.listify(_model_alias)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/estimate_model_memory.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/estimate_model_memory.rb index dc40e34a56..7b337e6487 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/estimate_model_memory.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/estimate_model_memory.rb @@ -15,19 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Estimates the model memory + # Estimate job model memory usage. + # Make an estimation of the memory usage for an anomaly detection job model. + # The estimate is based on analysis configuration details for the job and cardinality + # estimates for the fields it references. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The analysis config, plus cardinality estimates for fields it references (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-apis.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-estimate-model-memory # def estimate_model_memory(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.estimate_model_memory' } @@ -37,11 +51,11 @@ def estimate_model_memory(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_ml/anomaly_detectors/_estimate_model_memory' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/evaluate_data_frame.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/evaluate_data_frame.rb index 957f203433..15f094cc4b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/evaluate_data_frame.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/evaluate_data_frame.rb @@ -15,19 +15,34 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Evaluates the data frame analytics for an annotated index. + # Evaluate data frame analytics. + # The API packages together commonly used evaluation metrics for various types + # of machine learning features. This has been designed for use on indexes + # created by data frame analytics. Evaluation requires both a ground truth + # field and an analytics result field to be present. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The evaluation definition (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-evaluate-data-frame # def evaluate_data_frame(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.evaluate_data_frame' } @@ -37,11 +52,11 @@ def evaluate_data_frame(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_ml/data_frame/_evaluate' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/explain_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/explain_data_frame_analytics.rb index 8aef4b83b4..9b022e7358 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/explain_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/explain_data_frame_analytics.rb @@ -15,20 +15,39 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Explains a data frame analytics config. + # Explain data frame analytics config. + # This API provides explanations for a data frame analytics config that either + # exists already or one that has not been created yet. The following + # explanations are provided: + # * which fields are included or not in the analysis and why, + # * how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on. + # If you have object fields or fields that are excluded via source filtering, they are not included in the explanation. # - # @option arguments [String] :id The ID of the data frame analytics to explain + # @option arguments [String] :id Identifier for the data frame analytics job. This identifier can contain + # lowercase alphanumeric characters (a-z and 0-9), hyphens, and + # underscores. It must start and end with alphanumeric characters. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The data frame analytics config to explain + # @option arguments [Hash] :body request body # - # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/explain-dfanalytics.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-explain-data-frame-analytics # def explain_data_frame_analytics(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.explain_data_frame_analytics' } @@ -51,12 +70,12 @@ def explain_data_frame_analytics(arguments = {}) Elasticsearch::API::HTTP_GET end - path = if _id - "_ml/data_frame/analytics/#{Utils.__listify(_id)}/_explain" - else - '_ml/data_frame/analytics/_explain' - end - params = {} + path = if _id + "_ml/data_frame/analytics/#{Utils.listify(_id)}/_explain" + else + '_ml/data_frame/analytics/_explain' + end + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/flush_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/flush_job.rb index 48b8334e30..c11f195a44 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/flush_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/flush_job.rb @@ -15,25 +15,49 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Forces any buffered data to be processed by the job. + # Force buffered data to be processed. + # The flush jobs API is only applicable when sending data for analysis using + # the post data API. Depending on the content of the buffer, then it might + # additionally calculate new results. Both flush and close operations are + # similar, however the flush is more efficient if you are expecting to send + # more data for analysis. When flushing, the job remains open and is available + # to continue analyzing data. A close operation additionally prunes and + # persists the model state to disk and the job must be opened again before + # analyzing further data. # - # @option arguments [String] :job_id The name of the job to flush - # @option arguments [Boolean] :calc_interim Calculates interim results for the most recent bucket or all buckets within the latency period - # @option arguments [String] :start When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results - # @option arguments [String] :end When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results - # @option arguments [String] :advance_time Advances time to the given value generating results and updating the model for the advanced interval - # @option arguments [String] :skip_time Skips time to the given value without generating results or updating the model for the skipped interval + # @option arguments [String] :job_id Identifier for the anomaly detection job. (*Required*) + # @option arguments [String, Time] :advance_time Specifies to advance to a particular time value. Results are generated + # and the model is updated for data from the specified time interval. + # @option arguments [Boolean] :calc_interim If true, calculates the interim results for the most recent bucket or all + # buckets within the latency period. + # @option arguments [String, Time] :end When used in conjunction with `calc_interim` and `start`, specifies the + # range of buckets on which to calculate interim results. + # @option arguments [String, Time] :skip_time Specifies to skip to a particular time value. Results are not generated + # and the model is not updated for data from the specified time interval. + # @option arguments [String, Time] :start When used in conjunction with `calc_interim`, specifies the range of + # buckets on which to calculate interim results. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body Flush parameters + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-flush-job.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-flush-job # def flush_job(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.flush_job' } @@ -53,7 +77,7 @@ def flush_job(arguments = {}) _job_id = arguments.delete(:job_id) method = Elasticsearch::API::HTTP_POST - path = "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/_flush" + path = "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/_flush" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/forecast.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/forecast.rb index fefe7dbdb5..321e6f7527 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/forecast.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/forecast.rb @@ -15,23 +15,47 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Predicts the future behavior of a time series by using its historical behavior. + # Predict future behavior of a time series. + # Forecasts are not supported for jobs that perform population analysis; an + # error occurs if you try to create a forecast for a job that has an + # `over_field_name` in its configuration. Forcasts predict future behavior + # based on historical data. # - # @option arguments [String] :job_id The ID of the job to forecast for - # @option arguments [Time] :duration The duration of the forecast - # @option arguments [Time] :expires_in The time interval after which the forecast expires. Expired forecasts will be deleted at the first opportunity. - # @option arguments [String] :max_model_memory The max memory able to be used by the forecast. Default is 20mb. + # @option arguments [String] :job_id Identifier for the anomaly detection job. The job must be open when you + # create a forecast; otherwise, an error occurs. (*Required*) + # @option arguments [Time] :duration A period of time that indicates how far into the future to forecast. For + # example, `30d` corresponds to 30 days. The forecast starts at the last + # record that was processed. Server default: 1d. + # @option arguments [Time] :expires_in The period of time that forecast results are retained. After a forecast + # expires, the results are deleted. If set to a value of 0, the forecast is + # never automatically deleted. Server default: 14d. + # @option arguments [String] :max_model_memory The maximum memory the forecast can use. If the forecast needs to use + # more than the provided amount, it will spool to disk. Default is 20mb, + # maximum is 500mb and minimum is 1mb. If set to 40% or more of the job’s + # configured memory limit, it is automatically reduced to below that + # amount. Server default: 20mb. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body Query parameters can be specified in the body + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-forecast.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-forecast # def forecast(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.forecast' } @@ -51,7 +75,7 @@ def forecast(arguments = {}) _job_id = arguments.delete(:job_id) method = Elasticsearch::API::HTTP_POST - path = "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/_forecast" + path = "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/_forecast" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_buckets.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_buckets.rb index a68322b96a..97a80db73f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_buckets.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_buckets.rb @@ -15,35 +15,50 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Retrieves anomaly detection job results for one or more buckets. + # Get anomaly detection job results for buckets. + # The API presents a chronological view of the records, grouped by bucket. # - # @option arguments [String] :job_id ID of the job to get bucket results from - # @option arguments [String] :timestamp The timestamp of the desired single bucket result - # @option arguments [Boolean] :expand Include anomaly records - # @option arguments [Boolean] :exclude_interim Exclude interim results - # @option arguments [Integer] :from skips a number of buckets - # @option arguments [Integer] :size specifies a max number of buckets to get - # @option arguments [String] :start Start time filter for buckets - # @option arguments [String] :end End time filter for buckets - # @option arguments [Double] :anomaly_score Filter for the most anomalous buckets - # @option arguments [String] :sort Sort buckets by a particular field - # @option arguments [Boolean] :desc Set the sort direction + # @option arguments [String] :job_id Identifier for the anomaly detection job. (*Required*) + # @option arguments [String, Time] :timestamp The timestamp of a single bucket result. If you do not specify this + # parameter, the API returns information about all buckets. + # @option arguments [Float] :anomaly_score Returns buckets with anomaly scores greater or equal than this value. Server default: 0. + # @option arguments [Boolean] :desc If `true`, the buckets are sorted in descending order. + # @option arguments [String, Time] :end Returns buckets with timestamps earlier than this time. `-1` means it is + # unset and results are not limited to specific timestamps. Server default: -1. + # @option arguments [Boolean] :exclude_interim If `true`, the output excludes interim results. + # @option arguments [Boolean] :expand If true, the output includes anomaly records. + # @option arguments [Integer] :from Skips the specified number of buckets. Server default: 0. + # @option arguments [Integer] :size Specifies the maximum number of buckets to obtain. Server default: 100. + # @option arguments [String] :sort Specifies the sort field for the requested buckets. Server default: timestamp. + # @option arguments [String, Time] :start Returns buckets with timestamps after this time. `-1` means it is unset + # and results are not limited to specific timestamps. Server default: -1. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body Bucket selection details if not provided in URI + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-bucket.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-buckets # def get_buckets(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_buckets' } - defined_params = %i[job_id timestamp].each_with_object({}) do |variable, set_variables| + defined_params = [:job_id, :timestamp].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -65,11 +80,11 @@ def get_buckets(arguments = {}) Elasticsearch::API::HTTP_GET end - path = if _job_id && _timestamp - "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/results/buckets/#{Utils.__listify(_timestamp)}" - else - "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/results/buckets" - end + path = if _job_id && _timestamp + "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/results/buckets/#{Utils.listify(_timestamp)}" + else + "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/results/buckets" + end params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_calendar_events.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_calendar_events.rb index d207e8872b..ef7dac8861 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_calendar_events.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_calendar_events.rb @@ -15,24 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Retrieves information about the scheduled events in calendars. + # Get info about events in calendars. # - # @option arguments [String] :calendar_id The ID of the calendar containing the events - # @option arguments [String] :job_id Get events for the job. When this option is used calendar_id must be '_all' - # @option arguments [String] :start Get events after this time - # @option arguments [Date] :end Get events before this time - # @option arguments [Integer] :from Skips a number of events - # @option arguments [Integer] :size Specifies a max number of events to get + # @option arguments [String] :calendar_id A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids or a wildcard expression. You can get information for all calendars by using `_all` or `*` or by omitting the calendar identifier. (*Required*) + # @option arguments [String, Time] :end Specifies to get events with timestamps earlier than this time. + # @option arguments [Integer] :from Skips the specified number of events. Server default: 0. + # @option arguments [String] :job_id Specifies to get events for a specific anomaly detection job identifier or job group. It must be used with a calendar identifier of `_all` or `*`. + # @option arguments [Integer] :size Specifies the maximum number of events to obtain. Server default: 100. + # @option arguments [String, Time] :start Specifies to get events with timestamps after this time. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar-event.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-calendar-events # def get_calendar_events(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_calendar_events' } @@ -52,7 +63,7 @@ def get_calendar_events(arguments = {}) _calendar_id = arguments.delete(:calendar_id) method = Elasticsearch::API::HTTP_GET - path = "_ml/calendars/#{Utils.__listify(_calendar_id)}/events" + path = "_ml/calendars/#{Utils.listify(_calendar_id)}/events" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_calendars.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_calendars.rb index b068075dbe..352fc9dd8d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_calendars.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_calendars.rb @@ -15,22 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Retrieves configuration information for calendars. + # Get calendar configuration info. # - # @option arguments [String] :calendar_id The ID of the calendar to fetch - # @option arguments [Integer] :from skips a number of calendars - # @option arguments [Integer] :size specifies a max number of calendars to get + # @option arguments [String] :calendar_id A string that uniquely identifies a calendar. You can get information for multiple calendars by using a comma-separated list of ids or a wildcard expression. You can get information for all calendars by using `_all` or `*` or by omitting the calendar identifier. + # @option arguments [Integer] :from Skips the specified number of calendars. This parameter is supported only when you omit the calendar identifier. Server default: 0. + # @option arguments [Integer] :size Specifies the maximum number of calendars to obtain. This parameter is supported only when you omit the calendar identifier. Server default: 10000. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The from and size parameters optionally sent in the body + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-calendar.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-calendars # def get_calendars(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_calendars' } @@ -53,11 +64,11 @@ def get_calendars(arguments = {}) Elasticsearch::API::HTTP_GET end - path = if _calendar_id - "_ml/calendars/#{Utils.__listify(_calendar_id)}" - else - '_ml/calendars' - end + path = if _calendar_id + "_ml/calendars/#{Utils.listify(_calendar_id)}" + else + '_ml/calendars' + end params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_categories.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_categories.rb index 4bac8ea0e6..05b94ca9c2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_categories.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_categories.rb @@ -15,29 +15,44 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Retrieves anomaly detection job results for one or more categories. + # Get anomaly detection job results for categories. # - # @option arguments [String] :job_id The name of the job - # @option arguments [Long] :category_id The identifier of the category definition of interest - # @option arguments [Integer] :from skips a number of categories - # @option arguments [Integer] :size specifies a max number of categories to get - # @option arguments [String] :partition_field_value Specifies the partition to retrieve categories for. This is optional, and should never be used for jobs where per-partition categorization is disabled. + # @option arguments [String] :job_id Identifier for the anomaly detection job. (*Required*) + # @option arguments [String] :category_id Identifier for the category, which is unique in the job. If you specify + # neither the category ID nor the partition_field_value, the API returns + # information about all categories. If you specify only the + # partition_field_value, it returns information about all categories for + # the specified partition. + # @option arguments [Integer] :from Skips the specified number of categories. Server default: 0. + # @option arguments [String] :partition_field_value Only return categories for the specified partition. + # @option arguments [Integer] :size Specifies the maximum number of categories to obtain. Server default: 100. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body Category selection details if not provided in URI + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-category.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-categories # def get_categories(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_categories' } - defined_params = %i[job_id category_id].each_with_object({}) do |variable, set_variables| + defined_params = [:job_id, :category_id].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -59,11 +74,11 @@ def get_categories(arguments = {}) Elasticsearch::API::HTTP_GET end - path = if _job_id && _category_id - "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/results/categories/#{Utils.__listify(_category_id)}" - else - "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/results/categories" - end + path = if _job_id && _category_id + "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/results/categories/#{Utils.listify(_category_id)}" + else + "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/results/categories" + end params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics.rb index a6a097d654..e0687e3c8d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics.rb @@ -15,23 +15,49 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Retrieves configuration information for data frame analytics jobs. + # Get data frame analytics job configuration info. + # You can get information for multiple data frame analytics jobs in a single + # API request by using a comma-separated list of data frame analytics jobs or a + # wildcard expression. # - # @option arguments [String] :id The ID of the data frame analytics to fetch - # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified) - # @option arguments [Integer] :from skips a number of analytics - # @option arguments [Integer] :size specifies a max number of analytics to get - # @option arguments [Boolean] :exclude_generated Omits fields that are illegal to set on data frame analytics PUT + # @option arguments [String] :id Identifier for the data frame analytics job. If you do not specify this + # option, the API returns information for the first hundred data frame + # analytics jobs. + # @option arguments [Boolean] :allow_no_match Specifies what to do when the request: + # - Contains wildcard expressions and there are no data frame analytics + # jobs that match. + # - Contains the `_all` string or no identifiers and there are no matches. + # - Contains wildcard expressions and there are only partial matches. + # The default value returns an empty data_frame_analytics array when there + # are no matches and the subset of results when there are partial matches. + # If this parameter is `false`, the request returns a 404 status code when + # there are no matches or only partial matches. Server default: true. + # @option arguments [Integer] :from Skips the specified number of data frame analytics jobs. Server default: 0. + # @option arguments [Integer] :size Specifies the maximum number of data frame analytics jobs to obtain. Server default: 100. + # @option arguments [Boolean] :exclude_generated Indicates if certain fields should be removed from the configuration on + # retrieval. This allows the configuration to be in an acceptable format to + # be retrieved and then added to another cluster. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-data-frame-analytics # def get_data_frame_analytics(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_data_frame_analytics' } @@ -50,7 +76,7 @@ def get_data_frame_analytics(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _id - "_ml/data_frame/analytics/#{Utils.__listify(_id)}" + "_ml/data_frame/analytics/#{Utils.listify(_id)}" else '_ml/data_frame/analytics' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics_stats.rb index 5a12263db7..ae8961d4ba 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics_stats.rb @@ -15,23 +15,44 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Retrieves usage information for data frame analytics jobs. + # Get data frame analytics job stats. # - # @option arguments [String] :id The ID of the data frame analytics stats to fetch - # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified) - # @option arguments [Integer] :from skips a number of analytics - # @option arguments [Integer] :size specifies a max number of analytics to get - # @option arguments [Boolean] :verbose whether the stats response should be verbose + # @option arguments [String] :id Identifier for the data frame analytics job. If you do not specify this + # option, the API returns information for the first hundred data frame + # analytics jobs. + # @option arguments [Boolean] :allow_no_match Specifies what to do when the request: + # - Contains wildcard expressions and there are no data frame analytics + # jobs that match. + # - Contains the `_all` string or no identifiers and there are no matches. + # - Contains wildcard expressions and there are only partial matches. + # The default value returns an empty data_frame_analytics array when there + # are no matches and the subset of results when there are partial matches. + # If this parameter is `false`, the request returns a 404 status code when + # there are no matches or only partial matches. Server default: true. + # @option arguments [Integer] :from Skips the specified number of data frame analytics jobs. Server default: 0. + # @option arguments [Integer] :size Specifies the maximum number of data frame analytics jobs to obtain. Server default: 100. + # @option arguments [Boolean] :verbose Defines whether the stats response should be verbose. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-data-frame-analytics-stats # def get_data_frame_analytics_stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_data_frame_analytics_stats' } @@ -50,7 +71,7 @@ def get_data_frame_analytics_stats(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _id - "_ml/data_frame/analytics/#{Utils.__listify(_id)}/_stats" + "_ml/data_frame/analytics/#{Utils.listify(_id)}/_stats" else '_ml/data_frame/analytics/_stats' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_datafeed_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_datafeed_stats.rb index 9a527cf537..b8ed04ec99 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_datafeed_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_datafeed_stats.rb @@ -15,20 +15,46 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Retrieves usage information for datafeeds. + # Get datafeed stats. + # You can get statistics for multiple datafeeds in a single API request by + # using a comma-separated list of datafeeds or a wildcard expression. You can + # get statistics for all datafeeds by using `_all`, by specifying `*` as the + # ``, or by omitting the ``. If the datafeed is stopped, the + # only information you receive is the `datafeed_id` and the `state`. + # This API returns a maximum of 10,000 datafeeds. # - # @option arguments [String] :datafeed_id The ID of the datafeeds stats to fetch - # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) + # @option arguments [String, Array] :datafeed_id Identifier for the datafeed. It can be a datafeed identifier or a + # wildcard expression. If you do not specify one of these options, the API + # returns information about all datafeeds. + # @option arguments [Boolean] :allow_no_match Specifies what to do when the request: + # - Contains wildcard expressions and there are no datafeeds that match. + # - Contains the `_all` string or no identifiers and there are no matches. + # - Contains wildcard expressions and there are only partial matches. + # The default value is `true`, which returns an empty `datafeeds` array + # when there are no matches and the subset of results when there are + # partial matches. If this parameter is `false`, the request returns a + # `404` status code when there are no matches or only partial matches. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed-stats.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-datafeed-stats # def get_datafeed_stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_datafeed_stats' } @@ -47,7 +73,7 @@ def get_datafeed_stats(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _datafeed_id - "_ml/datafeeds/#{Utils.__listify(_datafeed_id)}/_stats" + "_ml/datafeeds/#{Utils.listify(_datafeed_id)}/_stats" else '_ml/datafeeds/_stats' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_datafeeds.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_datafeeds.rb index f7c0d75e1a..3c4511f9ae 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_datafeeds.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_datafeeds.rb @@ -15,21 +15,48 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Retrieves configuration information for datafeeds. + # Get datafeeds configuration info. + # You can get information for multiple datafeeds in a single API request by + # using a comma-separated list of datafeeds or a wildcard expression. You can + # get information for all datafeeds by using `_all`, by specifying `*` as the + # ``, or by omitting the ``. + # This API returns a maximum of 10,000 datafeeds. # - # @option arguments [String] :datafeed_id The ID of the datafeeds to fetch - # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) - # @option arguments [Boolean] :exclude_generated Omits fields that are illegal to set on datafeed PUT + # @option arguments [String, Array] :datafeed_id Identifier for the datafeed. It can be a datafeed identifier or a + # wildcard expression. If you do not specify one of these options, the API + # returns information about all datafeeds. + # @option arguments [Boolean] :allow_no_match Specifies what to do when the request: + # - Contains wildcard expressions and there are no datafeeds that match. + # - Contains the `_all` string or no identifiers and there are no matches. + # - Contains wildcard expressions and there are only partial matches. + # The default value is `true`, which returns an empty `datafeeds` array + # when there are no matches and the subset of results when there are + # partial matches. If this parameter is `false`, the request returns a + # `404` status code when there are no matches or only partial matches. + # @option arguments [Boolean] :exclude_generated Indicates if certain fields should be removed from the configuration on + # retrieval. This allows the configuration to be in an acceptable format to + # be retrieved and then added to another cluster. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-datafeed.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-datafeeds # def get_datafeeds(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_datafeeds' } @@ -48,7 +75,7 @@ def get_datafeeds(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _datafeed_id - "_ml/datafeeds/#{Utils.__listify(_datafeed_id)}" + "_ml/datafeeds/#{Utils.listify(_datafeed_id)}" else '_ml/datafeeds' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_filters.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_filters.rb index 740d6087d1..f7b3014056 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_filters.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_filters.rb @@ -15,21 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Retrieves filters. + # Get filters. + # You can get a single filter or all filters. # - # @option arguments [String] :filter_id The ID of the filter to fetch - # @option arguments [Integer] :from skips a number of filters - # @option arguments [Integer] :size specifies a max number of filters to get + # @option arguments [String, Array] :filter_id A string that uniquely identifies a filter. + # @option arguments [Integer] :from Skips the specified number of filters. Server default: 0. + # @option arguments [Integer] :size Specifies the maximum number of filters to obtain. Server default: 100. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-filter.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-filters # def get_filters(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_filters' } @@ -48,7 +60,7 @@ def get_filters(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _filter_id - "_ml/filters/#{Utils.__listify(_filter_id)}" + "_ml/filters/#{Utils.listify(_filter_id)}" else '_ml/filters' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_influencers.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_influencers.rb index c26cfe0ee3..8d05808511 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_influencers.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_influencers.rb @@ -15,28 +15,48 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Retrieves anomaly detection job results for one or more influencers. + # Get anomaly detection job results for influencers. + # Influencers are the entities that have contributed to, or are to blame for, + # the anomalies. Influencer results are available only if an + # `influencer_field_name` is specified in the job configuration. # - # @option arguments [String] :job_id Identifier for the anomaly detection job - # @option arguments [Boolean] :exclude_interim Exclude interim results - # @option arguments [Integer] :from skips a number of influencers - # @option arguments [Integer] :size specifies a max number of influencers to get - # @option arguments [String] :start start timestamp for the requested influencers - # @option arguments [String] :end end timestamp for the requested influencers - # @option arguments [Double] :influencer_score influencer score threshold for the requested influencers - # @option arguments [String] :sort sort field for the requested influencers - # @option arguments [Boolean] :desc whether the results should be sorted in decending order + # @option arguments [String] :job_id Identifier for the anomaly detection job. (*Required*) + # @option arguments [Boolean] :desc If true, the results are sorted in descending order. + # @option arguments [String, Time] :end Returns influencers with timestamps earlier than this time. + # The default value means it is unset and results are not limited to + # specific timestamps. Server default: -1. + # @option arguments [Boolean] :exclude_interim If true, the output excludes interim results. By default, interim results + # are included. + # @option arguments [Float] :influencer_score Returns influencers with anomaly scores greater than or equal to this + # value. Server default: 0. + # @option arguments [Integer] :from Skips the specified number of influencers. Server default: 0. + # @option arguments [Integer] :size Specifies the maximum number of influencers to obtain. Server default: 100. + # @option arguments [String] :sort Specifies the sort field for the requested influencers. By default, the + # influencers are sorted by the `influencer_score` value. + # @option arguments [String, Time] :start Returns influencers with timestamps after this time. The default value + # means it is unset and results are not limited to specific timestamps. Server default: -1. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body Influencer selection criteria + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-influencer.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-influencers # def get_influencers(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_influencers' } @@ -61,7 +81,7 @@ def get_influencers(arguments = {}) Elasticsearch::API::HTTP_GET end - path = "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/results/influencers" + path = "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/results/influencers" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_job_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_job_stats.rb index a775aa6822..31785a2b58 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_job_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_job_stats.rb @@ -15,20 +15,41 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Retrieves usage information for anomaly detection jobs. + # Get anomaly detection job stats. # - # @option arguments [String] :job_id The ID of the jobs stats to fetch - # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) + # @option arguments [String] :job_id Identifier for the anomaly detection job. It can be a job identifier, a + # group name, a comma-separated list of jobs, or a wildcard expression. If + # you do not specify one of these options, the API returns information for + # all anomaly detection jobs. + # @option arguments [Boolean] :allow_no_match Specifies what to do when the request: + # - Contains wildcard expressions and there are no jobs that match. + # - Contains the _all string or no identifiers and there are no matches. + # - Contains wildcard expressions and there are only partial matches. + # If `true`, the API returns an empty `jobs` array when + # there are no matches and the subset of results when there are partial + # matches. If `false`, the API returns a `404` status + # code when there are no matches or only partial matches. Server default: true. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-stats.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-job-stats # def get_job_stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_job_stats' } @@ -47,7 +68,7 @@ def get_job_stats(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _job_id - "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/_stats" + "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/_stats" else '_ml/anomaly_detectors/_stats' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_jobs.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_jobs.rb index ed56801065..db83f82f56 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_jobs.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_jobs.rb @@ -15,21 +15,47 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Retrieves configuration information for anomaly detection jobs. + # Get anomaly detection jobs configuration info. + # You can get information for multiple anomaly detection jobs in a single API + # request by using a group name, a comma-separated list of jobs, or a wildcard + # expression. You can get information for all anomaly detection jobs by using + # `_all`, by specifying `*` as the ``, or by omitting the ``. # - # @option arguments [String] :job_id The ID of the jobs to fetch - # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) - # @option arguments [Boolean] :exclude_generated Omits fields that are illegal to set on job PUT + # @option arguments [String, Array] :job_id Identifier for the anomaly detection job. It can be a job identifier, a + # group name, or a wildcard expression. If you do not specify one of these + # options, the API returns information for all anomaly detection jobs. + # @option arguments [Boolean] :allow_no_match Specifies what to do when the request: + # - Contains wildcard expressions and there are no jobs that match. + # - Contains the _all string or no identifiers and there are no matches. + # - Contains wildcard expressions and there are only partial matches. + # The default value is `true`, which returns an empty `jobs` array when + # there are no matches and the subset of results when there are partial + # matches. If this parameter is `false`, the request returns a `404` status + # code when there are no matches or only partial matches. Server default: true. + # @option arguments [Boolean] :exclude_generated Indicates if certain fields should be removed from the configuration on + # retrieval. This allows the configuration to be in an acceptable format to + # be retrieved and then added to another cluster. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-jobs # def get_jobs(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_jobs' } @@ -48,7 +74,7 @@ def get_jobs(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _job_id - "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}" + "_ml/anomaly_detectors/#{Utils.listify(_job_id)}" else '_ml/anomaly_detectors' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_memory_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_memory_stats.rb index 001adaa2d5..f504a6c499 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_memory_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_memory_stats.rb @@ -15,21 +15,37 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Returns information on how ML is using memory. + # Get machine learning memory usage info. + # Get information about how machine learning jobs and trained models are using memory, + # on each node, both within the JVM heap, and natively, outside of the JVM. # - # @option arguments [String] :node_id Specifies the node or nodes to retrieve stats for. - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [Time] :timeout Explicit operation timeout + # @option arguments [String] :node_id The names of particular nodes in the cluster to target. For example, `nodeId1,nodeId2` or + # `ml:true` + # @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. + # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request + # fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-memory.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-memory-stats # def get_memory_stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_memory_stats' } @@ -48,7 +64,7 @@ def get_memory_stats(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _node_id - "_ml/memory/#{Utils.__listify(_node_id)}/_stats" + "_ml/memory/#{Utils.listify(_node_id)}/_stats" else '_ml/memory/_stats' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_model_snapshot_upgrade_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_model_snapshot_upgrade_stats.rb index 561bd95bad..8fb36898fc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_model_snapshot_upgrade_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_model_snapshot_upgrade_stats.rb @@ -15,26 +15,45 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Gets stats for anomaly detection job model snapshot upgrades that are in progress. + # Get anomaly detection job model snapshot upgrade usage info. # - # @option arguments [String] :job_id The ID of the job. May be a wildcard, comma separated list or `_all`. - # @option arguments [String] :snapshot_id The ID of the snapshot. May be a wildcard, comma separated list or `_all`. - # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no jobs or no snapshots. (This includes the `_all` string.) + # @option arguments [String] :job_id Identifier for the anomaly detection job. (*Required*) + # @option arguments [String] :snapshot_id A numerical character string that uniquely identifies the model snapshot. You can get information for multiple + # snapshots by using a comma-separated list or a wildcard expression. You can get all snapshots by using `_all`, + # by specifying `*` as the snapshot ID, or by omitting the snapshot ID. (*Required*) + # @option arguments [Boolean] :allow_no_match Specifies what to do when the request: + # - Contains wildcard expressions and there are no jobs that match. + # - Contains the _all string or no identifiers and there are no matches. + # - Contains wildcard expressions and there are only partial matches. + # The default value is true, which returns an empty jobs array when there are no matches and the subset of results + # when there are partial matches. If this parameter is false, the request returns a 404 status code when there are + # no matches or only partial matches. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-job-model-snapshot-upgrade-stats.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-model-snapshot-upgrade-stats # def get_model_snapshot_upgrade_stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_model_snapshot_upgrade_stats' } - defined_params = %i[job_id snapshot_id].each_with_object({}) do |variable, set_variables| + defined_params = [:job_id, :snapshot_id].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -52,7 +71,7 @@ def get_model_snapshot_upgrade_stats(arguments = {}) _snapshot_id = arguments.delete(:snapshot_id) method = Elasticsearch::API::HTTP_GET - path = "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/model_snapshots/#{Utils.__listify(_snapshot_id)}/_upgrade/_stats" + path = "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/model_snapshots/#{Utils.listify(_snapshot_id)}/_upgrade/_stats" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_model_snapshots.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_model_snapshots.rb index df56a11e88..2df7f960f1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_model_snapshots.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_model_snapshots.rb @@ -15,32 +15,46 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Retrieves information about model snapshots. + # Get model snapshots info. # - # @option arguments [String] :job_id The ID of the job to fetch - # @option arguments [String] :snapshot_id The ID of the snapshot to fetch - # @option arguments [Integer] :from Skips a number of documents - # @option arguments [Integer] :size The default number of documents returned in queries as a string. - # @option arguments [Date] :start The filter 'start' query parameter - # @option arguments [Date] :end The filter 'end' query parameter - # @option arguments [String] :sort Name of the field to sort on - # @option arguments [Boolean] :desc True if the results should be sorted in descending order + # @option arguments [String] :job_id Identifier for the anomaly detection job. (*Required*) + # @option arguments [String] :snapshot_id A numerical character string that uniquely identifies the model snapshot. You can get information for multiple + # snapshots by using a comma-separated list or a wildcard expression. You can get all snapshots by using `_all`, + # by specifying `*` as the snapshot ID, or by omitting the snapshot ID. + # @option arguments [Boolean] :desc If true, the results are sorted in descending order. + # @option arguments [String, Time] :end Returns snapshots with timestamps earlier than this time. + # @option arguments [Integer] :from Skips the specified number of snapshots. Server default: 0. + # @option arguments [Integer] :size Specifies the maximum number of snapshots to obtain. Server default: 100. + # @option arguments [String] :sort Specifies the sort field for the requested snapshots. By default, the + # snapshots are sorted by their timestamp. + # @option arguments [String, Time] :start Returns snapshots with timestamps after this time. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body Model snapshot selection criteria + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-snapshot.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-model-snapshots # def get_model_snapshots(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_model_snapshots' } - defined_params = %i[job_id snapshot_id].each_with_object({}) do |variable, set_variables| + defined_params = [:job_id, :snapshot_id].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -62,11 +76,11 @@ def get_model_snapshots(arguments = {}) Elasticsearch::API::HTTP_GET end - path = if _job_id && _snapshot_id - "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/model_snapshots/#{Utils.__listify(_snapshot_id)}" - else - "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/model_snapshots" - end + path = if _job_id && _snapshot_id + "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/model_snapshots/#{Utils.listify(_snapshot_id)}" + else + "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/model_snapshots" + end params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_overall_buckets.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_overall_buckets.rb index fa40a14238..c56e33ab46 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_overall_buckets.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_overall_buckets.rb @@ -15,27 +15,70 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Retrieves overall bucket results that summarize the bucket results of multiple anomaly detection jobs. + # Get overall bucket results. + # Retrievs overall bucket results that summarize the bucket results of + # multiple anomaly detection jobs. + # The `overall_score` is calculated by combining the scores of all the + # buckets within the overall bucket span. First, the maximum + # `anomaly_score` per anomaly detection job in the overall bucket is + # calculated. Then the `top_n` of those scores are averaged to result in + # the `overall_score`. This means that you can fine-tune the + # `overall_score` so that it is more or less sensitive to the number of + # jobs that detect an anomaly at the same time. For example, if you set + # `top_n` to `1`, the `overall_score` is the maximum bucket score in the + # overall bucket. Alternatively, if you set `top_n` to the number of jobs, + # the `overall_score` is high only when all jobs detect anomalies in that + # overall bucket. If you set the `bucket_span` parameter (to a value + # greater than its default), the `overall_score` is the maximum + # `overall_score` of the overall buckets that have a span equal to the + # jobs' largest bucket span. # - # @option arguments [String] :job_id The job IDs for which to calculate overall bucket results - # @option arguments [Integer] :top_n The number of top job bucket scores to be used in the overall_score calculation - # @option arguments [String] :bucket_span The span of the overall buckets. Defaults to the longest job bucket_span - # @option arguments [Double] :overall_score Returns overall buckets with overall scores higher than this value - # @option arguments [Boolean] :exclude_interim If true overall buckets that include interim buckets will be excluded - # @option arguments [String] :start Returns overall buckets with timestamps after this time - # @option arguments [String] :end Returns overall buckets with timestamps earlier than this time - # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) + # @option arguments [String] :job_id Identifier for the anomaly detection job. It can be a job identifier, a + # group name, a comma-separated list of jobs or groups, or a wildcard + # expression.You can summarize the bucket results for all anomaly detection jobs by + # using `_all` or by specifying `*` as the ``. (*Required*) + # @option arguments [Boolean] :allow_no_match Specifies what to do when the request: + # - Contains wildcard expressions and there are no jobs that match. + # - Contains the `_all` string or no identifiers and there are no matches. + # - Contains wildcard expressions and there are only partial matches. + # If `true`, the request returns an empty `jobs` array when there are no + # matches and the subset of results when there are partial matches. If this + # parameter is `false`, the request returns a `404` status code when there + # are no matches or only partial matches. Server default: true. + # @option arguments [Time] :bucket_span The span of the overall buckets. Must be greater or equal to the largest + # bucket span of the specified anomaly detection jobs, which is the default + # value.By default, an overall bucket has a span equal to the largest bucket span + # of the specified anomaly detection jobs. To override that behavior, use + # the optional `bucket_span` parameter. + # @option arguments [String, Time] :end Returns overall buckets with timestamps earlier than this time. + # @option arguments [Boolean] :exclude_interim If `true`, the output excludes interim results. + # @option arguments [Float, String] :overall_score Returns overall buckets with overall scores greater than or equal to this + # value. + # @option arguments [String, Time] :start Returns overall buckets with timestamps after this time. + # @option arguments [Integer] :top_n The number of top anomaly detection job bucket scores to be used in the + # `overall_score` calculation. Server default: 1. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body Overall bucket selection details if not provided in URI + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-overall-buckets.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-overall-buckets # def get_overall_buckets(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_overall_buckets' } @@ -60,7 +103,7 @@ def get_overall_buckets(arguments = {}) Elasticsearch::API::HTTP_GET end - path = "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/results/overall_buckets" + path = "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/results/overall_buckets" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_records.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_records.rb index 66b4f6b7df..b191358d47 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_records.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_records.rb @@ -15,28 +15,51 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Retrieves anomaly records for an anomaly detection job. + # Get anomaly records for an anomaly detection job. + # Records contain the detailed analytical results. They describe the anomalous + # activity that has been identified in the input data based on the detector + # configuration. + # There can be many anomaly records depending on the characteristics and size + # of the input data. In practice, there are often too many to be able to + # manually process them. The machine learning features therefore perform a + # sophisticated aggregation of the anomaly records into buckets. + # The number of record results depends on the number of anomalies found in each + # bucket, which relates to the number of time series being modeled and the + # number of detectors. # - # @option arguments [String] :job_id The ID of the job - # @option arguments [Boolean] :exclude_interim Exclude interim results - # @option arguments [Integer] :from skips a number of records - # @option arguments [Integer] :size specifies a max number of records to get - # @option arguments [String] :start Start time filter for records - # @option arguments [String] :end End time filter for records - # @option arguments [Double] :record_score Returns records with anomaly scores greater or equal than this value - # @option arguments [String] :sort Sort records by a particular field - # @option arguments [Boolean] :desc Set the sort direction + # @option arguments [String] :job_id Identifier for the anomaly detection job. (*Required*) + # @option arguments [Boolean] :desc If true, the results are sorted in descending order. + # @option arguments [String, Time] :end Returns records with timestamps earlier than this time. The default value + # means results are not limited to specific timestamps. Server default: -1. + # @option arguments [Boolean] :exclude_interim If `true`, the output excludes interim results. + # @option arguments [Integer] :from Skips the specified number of records. Server default: 0. + # @option arguments [Float] :record_score Returns records with anomaly scores greater or equal than this value. Server default: 0. + # @option arguments [Integer] :size Specifies the maximum number of records to obtain. Server default: 100. + # @option arguments [String] :sort Specifies the sort field for the requested records. Server default: record_score. + # @option arguments [String, Time] :start Returns records with timestamps after this time. The default value means + # results are not limited to specific timestamps. Server default: -1. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body Record selection criteria + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-get-record.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-records # def get_records(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_records' } @@ -61,7 +84,7 @@ def get_records(arguments = {}) Elasticsearch::API::HTTP_GET end - path = "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/results/records" + path = "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/results/records" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_trained_models.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_trained_models.rb index 09b7813943..2ce6b52f52 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_trained_models.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_trained_models.rb @@ -15,27 +15,50 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Retrieves configuration information for a trained inference model. + # Get trained model configuration info. # - # @option arguments [String] :model_id The ID of the trained models to fetch - # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified) - # @option arguments [String] :include A comma-separate list of fields to optionally include. Valid options are 'definition' and 'total_feature_importance'. Default is none. - # @option arguments [Boolean] :include_model_definition Should the full model definition be included in the results. These definitions can be large. So be cautious when including them. Defaults to false. *Deprecated* - # @option arguments [Boolean] :decompress_definition Should the model definition be decompressed into valid JSON or returned in a custom compressed format. Defaults to true. - # @option arguments [Integer] :from skips a number of trained models - # @option arguments [Integer] :size specifies a max number of trained models to get - # @option arguments [List] :tags A comma-separated list of tags that the model must have. - # @option arguments [Boolean] :exclude_generated Omits fields that are illegal to set on model PUT + # @option arguments [String, Array] :model_id The unique identifier of the trained model or a model alias.You can get information for multiple trained models in a single API + # request by using a comma-separated list of model IDs or a wildcard + # expression. + # @option arguments [Boolean] :allow_no_match Specifies what to do when the request: + # - Contains wildcard expressions and there are no models that match. + # - Contains the _all string or no identifiers and there are no matches. + # - Contains wildcard expressions and there are only partial matches. + # If true, it returns an empty array when there are no matches and the + # subset of results when there are partial matches. Server default: true. + # @option arguments [Boolean] :decompress_definition Specifies whether the included model definition should be returned as a + # JSON map (true) or in a custom compressed format (false). Server default: true. + # @option arguments [Boolean] :exclude_generated Indicates if certain fields should be removed from the configuration on + # retrieval. This allows the configuration to be in an acceptable format to + # be retrieved and then added to another cluster. + # @option arguments [Integer] :from Skips the specified number of models. Server default: 0. + # @option arguments [String] :include A comma delimited string of optional fields to include in the response + # body. + # @option arguments [Integer] :size Specifies the maximum number of models to obtain. Server default: 100. + # @option arguments [String, Array] :tags A comma delimited string of tags. A trained model can have many tags, or + # none. When supplied, only trained models that contain all the supplied + # tags are returned. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-trained-models # def get_trained_models(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_trained_models' } @@ -54,7 +77,7 @@ def get_trained_models(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _model_id - "_ml/trained_models/#{Utils.__listify(_model_id)}" + "_ml/trained_models/#{Utils.listify(_model_id)}" else '_ml/trained_models' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_trained_models_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_trained_models_stats.rb index 0d56ddb20a..40d7a8a954 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_trained_models_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_trained_models_stats.rb @@ -15,22 +15,41 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Retrieves usage information for trained inference models. + # Get trained models usage info. + # You can get usage information for multiple trained + # models in a single API request by using a comma-separated list of model IDs or a wildcard expression. # - # @option arguments [String] :model_id The ID of the trained models stats to fetch - # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified) - # @option arguments [Integer] :from skips a number of trained models - # @option arguments [Integer] :size specifies a max number of trained models to get + # @option arguments [String, Array] :model_id The unique identifier of the trained model or a model alias. It can be a + # comma-separated list or a wildcard expression. + # @option arguments [Boolean] :allow_no_match Specifies what to do when the request: + # - Contains wildcard expressions and there are no models that match. + # - Contains the _all string or no identifiers and there are no matches. + # - Contains wildcard expressions and there are only partial matches. + # If true, it returns an empty array when there are no matches and the + # subset of results when there are partial matches. Server default: true. + # @option arguments [Integer] :from Skips the specified number of models. Server default: 0. + # @option arguments [Integer] :size Specifies the maximum number of models to obtain. Server default: 100. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-trained-models-stats.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-get-trained-models-stats # def get_trained_models_stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.get_trained_models_stats' } @@ -49,7 +68,7 @@ def get_trained_models_stats(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _model_id - "_ml/trained_models/#{Utils.__listify(_model_id)}/_stats" + "_ml/trained_models/#{Utils.listify(_model_id)}/_stats" else '_ml/trained_models/_stats' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/infer_trained_model.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/infer_trained_model.rb index 59dbc17156..380d790809 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/infer_trained_model.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/infer_trained_model.rb @@ -15,9 +15,9 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning @@ -25,16 +25,22 @@ module Actions # Evaluate a trained model. # # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*) - # @option arguments [Time] :timeout Controls the amount of time to wait for inference results. + # @option arguments [Time] :timeout Controls the amount of time to wait for inference results. Server default: 10s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The docs to apply inference on and inference configuration overrides (*Required*) - # - # *Deprecation notice*: - # /_ml/trained_models/{model_id}/deployment/_infer is deprecated. Use /_ml/trained_models/{model_id}/_infer instead - # Deprecated since version 8.3.0 - # + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/infer-trained-model.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-infer-trained-model # def infer_trained_model(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.infer_trained_model' } @@ -55,7 +61,7 @@ def infer_trained_model(arguments = {}) _model_id = arguments.delete(:model_id) method = Elasticsearch::API::HTTP_POST - path = ("_ml/trained_models/#{Utils.__listify(_model_id)}/deployment/_infer" if _model_id) + path = "_ml/trained_models/#{Utils.listify(_model_id)}/_infer" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/info.rb index c1f3d46670..cabecd558d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/info.rb @@ -15,18 +15,36 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Returns defaults and limits used by machine learning. + # Get machine learning information. + # Get defaults and limits used by machine learning. + # This endpoint is designed to be used by a user interface that needs to fully + # understand machine learning configurations where some options are not + # specified, meaning that the defaults should be used. This endpoint may be + # used to find out what those defaults are. It also provides information about + # the maximum size of machine learning jobs that could run in the current + # cluster configuration. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-ml-info.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-info # def info(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.info' } @@ -34,11 +52,11 @@ def info(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_ml/info' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/open_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/open_job.rb index 69ab6ad44e..e8b8d7efd8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/open_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/open_job.rb @@ -15,20 +15,38 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Opens one or more anomaly detection jobs. + # Open anomaly detection jobs. + # An anomaly detection job must be opened to be ready to receive and analyze + # data. It can be opened and closed multiple times throughout its lifecycle. + # When you open a new job, it starts with an empty model. + # When you open an existing job, the most recent model state is automatically + # loaded. The job is ready to resume its analysis from where it left off, once + # new data is received. # - # @option arguments [String] :job_id The ID of the job to open + # @option arguments [String] :job_id Identifier for the anomaly detection job. (*Required*) + # @option arguments [Time] :timeout Controls the time to wait until a job has opened. Server default: 30m. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body Query parameters can be specified in the body + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-open-job # def open_job(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.open_job' } @@ -48,8 +66,8 @@ def open_job(arguments = {}) _job_id = arguments.delete(:job_id) method = Elasticsearch::API::HTTP_POST - path = "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/_open" - params = {} + path = "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/_open" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/post_calendar_events.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/post_calendar_events.rb index c80bc49eab..b4c1bc9a12 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/post_calendar_events.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/post_calendar_events.rb @@ -15,20 +15,31 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Posts scheduled events in a calendar. + # Add scheduled events to the calendar. # - # @option arguments [String] :calendar_id The ID of the calendar to modify + # @option arguments [String] :calendar_id A string that uniquely identifies a calendar. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body A list of events (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-calendar-event.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-post-calendar-events # def post_calendar_events(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.post_calendar_events' } @@ -49,8 +60,8 @@ def post_calendar_events(arguments = {}) _calendar_id = arguments.delete(:calendar_id) method = Elasticsearch::API::HTTP_POST - path = "_ml/calendars/#{Utils.__listify(_calendar_id)}/events" - params = {} + path = "_ml/calendars/#{Utils.listify(_calendar_id)}/events" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/post_data.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/post_data.rb index f19f58530b..a3dc788910 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/post_data.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/post_data.rb @@ -15,22 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Sends data to an anomaly detection job for analysis. + # Send data to an anomaly detection job for analysis. + # IMPORTANT: For each job, data can be accepted from only a single connection at a time. + # It is not currently possible to post data to multiple jobs using wildcards or a comma-separated list. # - # @option arguments [String] :job_id The name of the job receiving the data - # @option arguments [String] :reset_start Optional parameter to specify the start of the bucket resetting range - # @option arguments [String] :reset_end Optional parameter to specify the end of the bucket resetting range + # @option arguments [String] :job_id Identifier for the anomaly detection job. The job must have a state of open to receive and process the data. (*Required*) + # @option arguments [String, Time] :reset_end Specifies the end of the bucket resetting range. + # @option arguments [String, Time] :reset_start Specifies the start of the bucket resetting range. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The data to process (*Required*) + # @option arguments [Hash] :body data # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-post-data.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-post-data # def post_data(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.post_data' } @@ -51,7 +64,7 @@ def post_data(arguments = {}) _job_id = arguments.delete(:job_id) method = Elasticsearch::API::HTTP_POST - path = "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/_data" + path = "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/_data" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_data_frame_analytics.rb index 33e7ca9675..35e410959f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_data_frame_analytics.rb @@ -15,20 +15,32 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Previews that will be analyzed given a data frame analytics config. + # Preview features used by data frame analytics. + # Preview the extracted features used by a data frame analytics config. # - # @option arguments [String] :id The ID of the data frame analytics to preview + # @option arguments [String] :id Identifier for the data frame analytics job. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The data frame analytics config to preview + # @option arguments [Hash] :body request body # - # @see http://www.elastic.co/guide/en/elasticsearch/reference/current/preview-dfanalytics.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-preview-data-frame-analytics # def preview_data_frame_analytics(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.preview_data_frame_analytics' } @@ -51,12 +63,12 @@ def preview_data_frame_analytics(arguments = {}) Elasticsearch::API::HTTP_GET end - path = if _id - "_ml/data_frame/analytics/#{Utils.__listify(_id)}/_preview" - else - '_ml/data_frame/analytics/_preview' - end - params = {} + path = if _id + "_ml/data_frame/analytics/#{Utils.listify(_id)}/_preview" + else + '_ml/data_frame/analytics/_preview' + end + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_datafeed.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_datafeed.rb index 78f421329b..60785c77c0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_datafeed.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_datafeed.rb @@ -15,22 +15,44 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Previews a datafeed. + # Preview a datafeed. + # This API returns the first "page" of search results from a datafeed. + # You can preview an existing datafeed or provide configuration details for a datafeed + # and anomaly detection job in the API. The preview shows the structure of the data + # that will be passed to the anomaly detection engine. + # IMPORTANT: When Elasticsearch security features are enabled, the preview uses the credentials of the user that + # called the API. However, when the datafeed starts it uses the roles of the last user that created or updated the + # datafeed. To get a preview that accurately reflects the behavior of the datafeed, use the appropriate credentials. + # You can also use secondary authorization headers to supply the credentials. # - # @option arguments [String] :datafeed_id The ID of the datafeed to preview - # @option arguments [String] :start The start time from where the datafeed preview should begin - # @option arguments [String] :end The end time when the datafeed preview should stop + # @option arguments [String] :datafeed_id A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase + # alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric + # characters. NOTE: If you use this path parameter, you cannot provide datafeed or anomaly detection job + # configuration details in the request body. + # @option arguments [String, Time] :start The start time from where the datafeed preview should begin + # @option arguments [String, Time] :end The end time when the datafeed preview should stop + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The datafeed config and job config with which to execute the preview + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-preview-datafeed.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-preview-datafeed # def preview_datafeed(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.preview_datafeed' } @@ -53,11 +75,11 @@ def preview_datafeed(arguments = {}) Elasticsearch::API::HTTP_GET end - path = if _datafeed_id - "_ml/datafeeds/#{Utils.__listify(_datafeed_id)}/_preview" - else - '_ml/datafeeds/_preview' - end + path = if _datafeed_id + "_ml/datafeeds/#{Utils.listify(_datafeed_id)}/_preview" + else + '_ml/datafeeds/_preview' + end params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_calendar.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_calendar.rb index 6bac27c8cc..0c137557c0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_calendar.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_calendar.rb @@ -15,20 +15,31 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Instantiates a calendar. + # Create a calendar. # - # @option arguments [String] :calendar_id The ID of the calendar to create + # @option arguments [String] :calendar_id A string that uniquely identifies a calendar. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The calendar details + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-calendar # def put_calendar(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.put_calendar' } @@ -48,8 +59,8 @@ def put_calendar(arguments = {}) _calendar_id = arguments.delete(:calendar_id) method = Elasticsearch::API::HTTP_PUT - path = "_ml/calendars/#{Utils.__listify(_calendar_id)}" - params = {} + path = "_ml/calendars/#{Utils.listify(_calendar_id)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_calendar_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_calendar_job.rb index 5c7b779e81..e7d07e2f13 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_calendar_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_calendar_job.rb @@ -15,25 +15,36 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Adds an anomaly detection job to a calendar. + # Add anomaly detection job to calendar. # - # @option arguments [String] :calendar_id The ID of the calendar to modify - # @option arguments [String] :job_id The ID of the job to add to the calendar + # @option arguments [String] :calendar_id A string that uniquely identifies a calendar. (*Required*) + # @option arguments [String, Array] :job_id An identifier for the anomaly detection jobs. It can be a job identifier, a group name, or a comma-separated list of jobs or groups. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-calendar-job.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-calendar-job # def put_calendar_job(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.put_calendar_job' } - defined_params = %i[calendar_id job_id].each_with_object({}) do |variable, set_variables| + defined_params = [:calendar_id, :job_id].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -51,8 +62,8 @@ def put_calendar_job(arguments = {}) _job_id = arguments.delete(:job_id) method = Elasticsearch::API::HTTP_PUT - path = "_ml/calendars/#{Utils.__listify(_calendar_id)}/jobs/#{Utils.__listify(_job_id)}" - params = {} + path = "_ml/calendars/#{Utils.listify(_calendar_id)}/jobs/#{Utils.listify(_job_id)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_data_frame_analytics.rb index 737b51a739..2d76868031 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_data_frame_analytics.rb @@ -15,20 +15,38 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Instantiates a data frame analytics job. + # Create a data frame analytics job. + # This API creates a data frame analytics job that performs an analysis on the + # source indices and stores the outcome in a destination index. + # By default, the query used in the source configuration is `{"match_all": {}}`. + # If the destination index does not exist, it is created automatically when you start the job. + # If you supply only a subset of the regression or classification parameters, hyperparameter optimization occurs. It determines a value for each of the undefined parameters. # - # @option arguments [String] :id The ID of the data frame analytics to create + # @option arguments [String] :id Identifier for the data frame analytics job. This identifier can contain + # lowercase alphanumeric characters (a-z and 0-9), hyphens, and + # underscores. It must start and end with alphanumeric characters. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The data frame analytics configuration (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-dfanalytics.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-data-frame-analytics # def put_data_frame_analytics(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.put_data_frame_analytics' } @@ -49,8 +67,8 @@ def put_data_frame_analytics(arguments = {}) _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_PUT - path = "_ml/data_frame/analytics/#{Utils.__listify(_id)}" - params = {} + path = "_ml/data_frame/analytics/#{Utils.listify(_id)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_datafeed.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_datafeed.rb index 55ac679569..66aae435aa 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_datafeed.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_datafeed.rb @@ -15,24 +15,49 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Instantiates a datafeed. + # Create a datafeed. + # Datafeeds retrieve data from Elasticsearch for analysis by an anomaly detection job. + # You can associate only one datafeed with each anomaly detection job. + # The datafeed contains a query that runs at a defined interval (`frequency`). + # If you are concerned about delayed data, you can add a delay (`query_delay`) at each interval. + # By default, the datafeed uses the following query: `{"match_all": {"boost": 1}}`. + # When Elasticsearch security features are enabled, your datafeed remembers which roles the user who created it had + # at the time of creation and runs the query using those same roles. If you provide secondary authorization headers, + # those credentials are used instead. + # You must use Kibana, this API, or the create anomaly detection jobs API to create a datafeed. Do not add a datafeed + # directly to the `.ml-config` index. Do not give users `write` privileges on the `.ml-config` index. # - # @option arguments [String] :datafeed_id The ID of the datafeed to create - # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false) - # @option arguments [Boolean] :allow_no_indices Ignore if the source indices expressions resolves to no concrete indices (default: true) - # @option arguments [Boolean] :ignore_throttled Ignore indices that are marked as throttled (default: true) - # @option arguments [String] :expand_wildcards Whether source index expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) + # @option arguments [String] :datafeed_id A numerical character string that uniquely identifies the datafeed. + # This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. + # It must start and end with alphanumeric characters. (*Required*) + # @option arguments [Boolean] :allow_no_indices If true, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the `_all` + # string or when no indices are specified. Server default: true. + # @option arguments [String, Array] :expand_wildcards 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. Supports comma-separated values. Server default: open. + # @option arguments [Boolean] :ignore_throttled If true, concrete, expanded, or aliased indices are ignored when frozen. Server default: true. + # @option arguments [Boolean] :ignore_unavailable If true, unavailable indices (missing or closed) are ignored. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The datafeed config (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-datafeed.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-datafeed # def put_datafeed(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.put_datafeed' } @@ -53,7 +78,7 @@ def put_datafeed(arguments = {}) _datafeed_id = arguments.delete(:datafeed_id) method = Elasticsearch::API::HTTP_PUT - path = "_ml/datafeeds/#{Utils.__listify(_datafeed_id)}" + path = "_ml/datafeeds/#{Utils.listify(_datafeed_id)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_filter.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_filter.rb index b08ad3dc1c..eaef9498d8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_filter.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_filter.rb @@ -15,20 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Instantiates a filter. + # Create a filter. + # A filter contains a list of strings. It can be used by one or more anomaly detection jobs. + # Specifically, filters are referenced in the `custom_rules` property of detector configuration objects. # - # @option arguments [String] :filter_id The ID of the filter to create + # @option arguments [String] :filter_id A string that uniquely identifies a filter. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The filter details (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-filter.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-filter # def put_filter(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.put_filter' } @@ -49,8 +62,8 @@ def put_filter(arguments = {}) _filter_id = arguments.delete(:filter_id) method = Elasticsearch::API::HTTP_PUT - path = "_ml/filters/#{Utils.__listify(_filter_id)}" - params = {} + path = "_ml/filters/#{Utils.listify(_filter_id)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_job.rb index d5cebda595..9047dc5cf4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_job.rb @@ -15,24 +15,39 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Instantiates an anomaly detection job. + # Create an anomaly detection job. + # If you include a `datafeed_config`, you must have read index privileges on the source index. + # If you include a `datafeed_config` but do not provide a query, the datafeed uses `{"match_all": {"boost": 1}}`. # - # @option arguments [String] :job_id The ID of the job to create - # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false). Only set if datafeed_config is provided. - # @option arguments [Boolean] :allow_no_indices Ignore if the source indices expressions resolves to no concrete indices (default: true). Only set if datafeed_config is provided. - # @option arguments [Boolean] :ignore_throttled Ignore indices that are marked as throttled (default: true). Only set if datafeed_config is provided. - # @option arguments [String] :expand_wildcards Whether source index expressions should get expanded to open or closed indices (default: open). Only set if datafeed_config is provided. (options: open, closed, hidden, none, all) + # @option arguments [String] :job_id The identifier for the anomaly detection job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters. (*Required*) + # @option arguments [Boolean] :allow_no_indices If `true`, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the + # `_all` string or when no indices are specified. Server default: true. + # @option arguments [String, Array] :expand_wildcards 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. Supports comma-separated values. Server default: open. + # @option arguments [Boolean] :ignore_throttled If `true`, concrete, expanded or aliased indices are ignored when frozen. Server default: true. + # @option arguments [Boolean] :ignore_unavailable If `true`, unavailable indices (missing or closed) are ignored. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The job (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-job # def put_job(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.put_job' } @@ -53,7 +68,7 @@ def put_job(arguments = {}) _job_id = arguments.delete(:job_id) method = Elasticsearch::API::HTTP_PUT - path = "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}" + path = "_ml/anomaly_detectors/#{Utils.listify(_job_id)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model.rb index 5107273c56..101075a409 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model.rb @@ -15,22 +15,37 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Creates an inference trained model. + # Create a trained model. + # Enable you to supply a trained model that is not created by data frame analytics. # - # @option arguments [String] :model_id The ID of the trained models to store - # @option arguments [Boolean] :defer_definition_decompression If set to `true` and a `compressed_definition` is provided, the request defers definition decompression and skips relevant validations. - # @option arguments [Boolean] :wait_for_completion Whether to wait for all child operations(e.g. model download) to complete, before returning or not. Default to false + # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*) + # @option arguments [Boolean] :defer_definition_decompression If set to `true` and a `compressed_definition` is provided, + # the request defers definition decompression and skips relevant + # validations. + # @option arguments [Boolean] :wait_for_completion Whether to wait for all child operations (e.g. model download) + # to complete. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The trained model configuration (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-trained-model # def put_trained_model(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.put_trained_model' } @@ -51,7 +66,7 @@ def put_trained_model(arguments = {}) _model_id = arguments.delete(:model_id) method = Elasticsearch::API::HTTP_PUT - path = "_ml/trained_models/#{Utils.__listify(_model_id)}" + path = "_ml/trained_models/#{Utils.listify(_model_id)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_alias.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_alias.rb index 9da28749f1..5d7b5a70f2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_alias.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_alias.rb @@ -15,26 +15,55 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Creates a new model alias (or reassigns an existing one) to refer to the trained model + # Create or update a trained model alias. + # A trained model alias is a logical name used to reference a single trained + # model. + # You can use aliases instead of trained model identifiers to make it easier to + # reference your models. For example, you can use aliases in inference + # aggregations and processors. + # An alias must be unique and refer to only a single trained model. However, + # you can have multiple aliases for each trained model. + # If you use this API to update an alias such that it references a different + # trained model ID and the model uses a different type of data frame analytics, + # an error occurs. For example, this situation occurs if you have a trained + # model for regression analysis and a trained model for classification + # analysis; you cannot reassign an alias from one type of trained model to + # another. + # If you use this API to update an alias and there are very few input fields in + # common between the old and new trained models for the model alias, the API + # returns a warning. # - # @option arguments [String] :model_alias The trained model alias to update - # @option arguments [String] :model_id The trained model where the model alias should be assigned - # @option arguments [Boolean] :reassign If the model_alias already exists and points to a separate model_id, this parameter must be true. Defaults to false. + # @option arguments [String] :model_alias The alias to create or update. This value cannot end in numbers. (*Required*) + # @option arguments [String] :model_id The identifier for the trained model that the alias refers to. (*Required*) + # @option arguments [Boolean] :reassign Specifies whether the alias gets reassigned to the specified trained + # model if it is already assigned to a different model. If the alias is + # already assigned and this parameter is false, the API returns an error. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models-aliases.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-trained-model-alias # def put_trained_model_alias(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.put_trained_model_alias' } - defined_params = %i[model_id model_alias].each_with_object({}) do |variable, set_variables| + defined_params = [:model_id, :model_alias].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -52,7 +81,7 @@ def put_trained_model_alias(arguments = {}) _model_id = arguments.delete(:model_id) method = Elasticsearch::API::HTTP_PUT - path = "_ml/trained_models/#{Utils.__listify(_model_id)}/model_aliases/#{Utils.__listify(_model_alias)}" + path = "_ml/trained_models/#{Utils.listify(_model_id)}/model_aliases/#{Utils.listify(_model_alias)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_definition_part.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_definition_part.rb index 5fb6155e59..bd2309f475 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_definition_part.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_definition_part.rb @@ -15,26 +15,38 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Creates part of a trained model definition + # Create part of a trained model definition. # - # @option arguments [String] :model_id The ID of the trained model for this definition part - # @option arguments [Integer] :part The part number + # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*) + # @option arguments [Integer] :part The definition part number. When the definition is loaded for inference the definition parts are streamed in the + # order of their part number. The first part must be `0` and the final part must be `total_parts - 1`. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The trained model definition part (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-definition-part.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-trained-model-definition-part # def put_trained_model_definition_part(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.put_trained_model_definition_part' } - defined_params = %i[model_id part].each_with_object({}) do |variable, set_variables| + defined_params = [:model_id, :part].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -53,8 +65,8 @@ def put_trained_model_definition_part(arguments = {}) _part = arguments.delete(:part) method = Elasticsearch::API::HTTP_PUT - path = "_ml/trained_models/#{Utils.__listify(_model_id)}/definition/#{Utils.__listify(_part)}" - params = {} + path = "_ml/trained_models/#{Utils.listify(_model_id)}/definition/#{Utils.listify(_part)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_vocabulary.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_vocabulary.rb index f080f5f763..16a1c915f5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_vocabulary.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/put_trained_model_vocabulary.rb @@ -15,20 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Creates a trained model vocabulary + # Create a trained model vocabulary. + # This API is supported only for natural language processing (NLP) models. + # The vocabulary is stored in the index as described in `inference_config.*.vocabulary` of the trained model definition. # - # @option arguments [String] :model_id The ID of the trained model for this vocabulary + # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The trained model vocabulary (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-model-vocabulary.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-put-trained-model-vocabulary # def put_trained_model_vocabulary(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.put_trained_model_vocabulary' } @@ -49,8 +62,8 @@ def put_trained_model_vocabulary(arguments = {}) _model_id = arguments.delete(:model_id) method = Elasticsearch::API::HTTP_PUT - path = "_ml/trained_models/#{Utils.__listify(_model_id)}/vocabulary" - params = {} + path = "_ml/trained_models/#{Utils.listify(_model_id)}/vocabulary" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/reset_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/reset_job.rb index a5ce0e1b20..4e34f5b6b0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/reset_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/reset_job.rb @@ -15,21 +15,39 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Resets an existing anomaly detection job. + # Reset an anomaly detection job. + # All model state and results are deleted. The job is ready to start over as if + # it had just been created. + # It is not currently possible to reset multiple jobs using wildcards or a + # comma separated list. # - # @option arguments [String] :job_id The ID of the job to reset - # @option arguments [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning - # @option arguments [Boolean] :delete_user_annotations Should annotations added by the user be deleted + # @option arguments [String] :job_id The ID of the job to reset. (*Required*) + # @option arguments [Boolean] :wait_for_completion Should this request wait until the operation has completed before + # returning. Server default: true. + # @option arguments [Boolean] :delete_user_annotations Specifies whether annotations that have been added by the + # user should be deleted along with any auto-generated annotations when the job is + # reset. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-reset-job.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-reset-job # def reset_job(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.reset_job' } @@ -49,7 +67,7 @@ def reset_job(arguments = {}) _job_id = arguments.delete(:job_id) method = Elasticsearch::API::HTTP_POST - path = "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/_reset" + path = "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/_reset" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/revert_model_snapshot.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/revert_model_snapshot.rb index 80f70b212a..e5938e6ed4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/revert_model_snapshot.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/revert_model_snapshot.rb @@ -15,27 +15,52 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Reverts to a specific snapshot. + # Revert to a snapshot. + # The machine learning features react quickly to anomalous input, learning new + # behaviors in data. Highly anomalous input increases the variance in the + # models whilst the system learns whether this is a new step-change in behavior + # or a one-off event. In the case where this anomalous input is known to be a + # one-off, then it might be appropriate to reset the model state to a time + # before this event. For example, you might consider reverting to a saved + # snapshot after Black Friday or a critical system failure. # - # @option arguments [String] :job_id The ID of the job to fetch - # @option arguments [String] :snapshot_id The ID of the snapshot to revert to - # @option arguments [Boolean] :delete_intervening_results Should we reset the results back to the time of the snapshot? + # @option arguments [String] :job_id Identifier for the anomaly detection job. (*Required*) + # @option arguments [String] :snapshot_id You can specify `empty` as the . Reverting to the empty + # snapshot means the anomaly detection job starts learning a new model from + # scratch when it is started. (*Required*) + # @option arguments [Boolean] :delete_intervening_results If true, deletes the results in the time period between the latest + # results and the time of the reverted snapshot. It also resets the model + # to accept records for this time period. If you choose not to delete + # intervening results when reverting a snapshot, the job will not accept + # input data that is older than the current time. If you want to resend + # data, then delete the intervening results. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body Reversion options + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-revert-snapshot.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-revert-model-snapshot # def revert_model_snapshot(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.revert_model_snapshot' } - defined_params = %i[job_id snapshot_id].each_with_object({}) do |variable, set_variables| + defined_params = [:job_id, :snapshot_id].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -53,7 +78,7 @@ def revert_model_snapshot(arguments = {}) _snapshot_id = arguments.delete(:snapshot_id) method = Elasticsearch::API::HTTP_POST - path = "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/model_snapshots/#{Utils.__listify(_snapshot_id)}/_revert" + path = "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/model_snapshots/#{Utils.listify(_snapshot_id)}/_revert" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/set_upgrade_mode.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/set_upgrade_mode.rb index 08bba48120..ae288b22a1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/set_upgrade_mode.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/set_upgrade_mode.rb @@ -15,20 +15,45 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Sets a cluster wide upgrade_mode setting that prepares machine learning indices for an upgrade. + # Set upgrade_mode for ML indices. + # Sets a cluster wide upgrade_mode setting that prepares machine learning + # indices for an upgrade. + # When upgrading your cluster, in some circumstances you must restart your + # nodes and reindex your machine learning indices. In those circumstances, + # there must be no machine learning jobs running. You can close the machine + # learning jobs, do the upgrade, then open all the jobs again. Alternatively, + # you can use this API to temporarily halt tasks associated with the jobs and + # datafeeds and prevent new jobs from opening. You can also use this API + # during upgrades that do not require you to reindex your machine learning + # indices, though stopping jobs is not a requirement in that case. + # You can see the current value for the upgrade_mode setting by using the get + # machine learning info API. # - # @option arguments [Boolean] :enabled Whether to enable upgrade_mode ML setting or not. Defaults to false. - # @option arguments [Time] :timeout Controls the time to wait before action times out. Defaults to 30 seconds + # @option arguments [Boolean] :enabled When `true`, it enables `upgrade_mode` which temporarily halts all job + # and datafeed tasks and prohibits new job and datafeed tasks from + # starting. + # @option arguments [Time] :timeout The time to wait for the request to be completed. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-set-upgrade-mode.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-set-upgrade-mode # def set_upgrade_mode(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.set_upgrade_mode' } @@ -36,7 +61,7 @@ def set_upgrade_mode(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_POST path = '_ml/set_upgrade_mode' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_data_frame_analytics.rb index f54893de3d..ece1e2937f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_data_frame_analytics.rb @@ -15,21 +15,45 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Starts a data frame analytics job. + # Start a data frame analytics job. + # A data frame analytics job can be started and stopped multiple times + # throughout its lifecycle. + # If the destination index does not exist, it is created automatically the + # first time you start the data frame analytics job. The + # `index.number_of_shards` and `index.number_of_replicas` settings for the + # destination index are copied from the source index. If there are multiple + # source indices, the destination index copies the highest setting values. The + # mappings for the destination index are also copied from the source indices. + # If there are any mapping conflicts, the job fails to start. + # If the destination index exists, it is used as is. You can therefore set up + # the destination index in advance with custom settings and mappings. # - # @option arguments [String] :id The ID of the data frame analytics to start - # @option arguments [Time] :timeout Controls the time to wait until the task has started. Defaults to 20 seconds + # @option arguments [String] :id Identifier for the data frame analytics job. This identifier can contain + # lowercase alphanumeric characters (a-z and 0-9), hyphens, and + # underscores. It must start and end with alphanumeric characters. (*Required*) + # @option arguments [Time] :timeout Controls the amount of time to wait until the data frame analytics job + # starts. Server default: 20s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The start data frame analytics parameters # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-start-data-frame-analytics # def start_data_frame_analytics(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.start_data_frame_analytics' } @@ -44,12 +68,12 @@ def start_data_frame_analytics(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = nil _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_POST - path = "_ml/data_frame/analytics/#{Utils.__listify(_id)}/_start" + path = "_ml/data_frame/analytics/#{Utils.listify(_id)}/_start" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_datafeed.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_datafeed.rb index ec6b3957df..372a9a0e8a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_datafeed.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_datafeed.rb @@ -15,23 +15,57 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Starts one or more datafeeds. + # Start datafeeds. + # A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped + # multiple times throughout its lifecycle. + # Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs. + # If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped. + # If new data was indexed for that exact millisecond between stopping and starting, it will be ignored. + # When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or + # update it had at the time of creation or update and runs the query using those same roles. If you provided secondary + # authorization headers when you created or updated the datafeed, those credentials are used instead. # - # @option arguments [String] :datafeed_id The ID of the datafeed to start - # @option arguments [String] :start The start time from where the datafeed should begin - # @option arguments [String] :end The end time when the datafeed should stop. When not set, the datafeed continues in real time - # @option arguments [Time] :timeout Controls the time to wait until a datafeed has started. Default to 20 seconds + # @option arguments [String] :datafeed_id A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase + # alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric + # characters. (*Required*) + # @option arguments [String, Time] :end The time that the datafeed should end, which can be specified by using one of the following formats: + # - ISO 8601 format with milliseconds, for example `2017-01-22T06:00:00.000Z` + # - ISO 8601 format without milliseconds, for example `2017-01-22T06:00:00+00:00` + # - Milliseconds since the epoch, for example `1485061200000` + # Date-time arguments using either of the ISO 8601 formats must have a time zone designator, where `Z` is accepted + # as an abbreviation for UTC time. When a URL is expected (for example, in browsers), the `+` used in time zone + # designators must be encoded as `%2B`. + # The end time value is exclusive. If you do not specify an end time, the datafeed + # runs continuously. + # @option arguments [String, Time] :start The time that the datafeed should begin, which can be specified by using the same formats as the `end` parameter. + # This value is inclusive. + # If you do not specify a start time and the datafeed is associated with a new anomaly detection job, the analysis + # starts from the earliest time for which data is available. + # If you restart a stopped datafeed and specify a start value that is earlier than the timestamp of the latest + # processed record, the datafeed continues from 1 millisecond after the timestamp of the latest processed record. + # @option arguments [Time] :timeout Specifies the amount of time to wait until a datafeed starts. Server default: 20s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The start datafeed parameters + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-start-datafeed.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-start-datafeed # def start_datafeed(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.start_datafeed' } @@ -51,7 +85,7 @@ def start_datafeed(arguments = {}) _datafeed_id = arguments.delete(:datafeed_id) method = Elasticsearch::API::HTTP_POST - path = "_ml/datafeeds/#{Utils.__listify(_datafeed_id)}/_start" + path = "_ml/datafeeds/#{Utils.listify(_datafeed_id)}/_start" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_trained_model_deployment.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_trained_model_deployment.rb index 9a63f004ab..9673fded56 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_trained_model_deployment.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_trained_model_deployment.rb @@ -15,27 +15,53 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions # Start a trained model deployment. + # It allocates the model to every machine learning node. # - # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*) - # @option arguments [String] :cache_size A byte-size value for configuring the inference cache size. For example, 20mb. - # @option arguments [String] :deployment_id The Id of the new deployment. Defaults to the model_id if not set. - # @option arguments [Integer] :number_of_allocations The total number of allocations this model is assigned across machine learning nodes. - # @option arguments [Integer] :threads_per_allocation The number of threads used by each model allocation during inference. + # @option arguments [String] :model_id The unique identifier of the trained model. Currently, only PyTorch models are supported. (*Required*) + # @option arguments [Integer, String] :cache_size The inference cache size (in memory outside the JVM heap) per node for the model. + # The default value is the same size as the `model_size_bytes`. To disable the cache, + # `0b` can be provided. + # @option arguments [String] :deployment_id A unique identifier for the deployment of the model. + # @option arguments [Integer] :number_of_allocations The number of model allocations on each node where the model is deployed. + # All allocations on a node share the same copy of the model in memory but use + # a separate set of threads to evaluate the model. + # Increasing this value generally increases the throughput. + # If this setting is greater than the number of hardware threads + # it will automatically be changed to a value less than the number of hardware threads. + # If adaptive_allocations is enabled, do not set this value, because it’s automatically set. Server default: 1. # @option arguments [String] :priority The deployment priority. - # @option arguments [Integer] :queue_capacity Controls how many inference requests are allowed in the queue at a time. - # @option arguments [Time] :timeout Controls the amount of time to wait for the model to deploy. - # @option arguments [String] :wait_for The allocation status for which to wait (options: starting, started, fully_allocated) + # @option arguments [Integer] :queue_capacity Specifies the number of inference requests that are allowed in the queue. After the number of requests exceeds + # this value, new requests are rejected with a 429 error. Server default: 1024. + # @option arguments [Integer] :threads_per_allocation Sets the number of threads used by each model allocation during inference. This generally increases + # the inference speed. The inference process is a compute-bound process; any number + # greater than the number of available hardware threads on the machine does not increase the + # inference speed. If this setting is greater than the number of hardware threads + # it will automatically be changed to a value less than the number of hardware threads. Server default: 1. + # @option arguments [Time] :timeout Specifies the amount of time to wait for the model to deploy. Server default: 20s. + # @option arguments [String] :wait_for Specifies the allocation status to wait for before returning. Server default: started. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/start-trained-model-deployment.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-start-trained-model-deployment # def start_trained_model_deployment(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.start_trained_model_deployment' } @@ -50,12 +76,12 @@ def start_trained_model_deployment(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = arguments.delete(:body) _model_id = arguments.delete(:model_id) method = Elasticsearch::API::HTTP_POST - path = "_ml/trained_models/#{Utils.__listify(_model_id)}/deployment/_start" + path = "_ml/trained_models/#{Utils.listify(_model_id)}/deployment/_start" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_data_frame_analytics.rb index 142085941a..739a6e89db 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_data_frame_analytics.rb @@ -15,23 +15,46 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Stops one or more data frame analytics jobs. + # Stop data frame analytics jobs. + # A data frame analytics job can be started and stopped multiple times + # throughout its lifecycle. # - # @option arguments [String] :id The ID of the data frame analytics to stop - # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified) - # @option arguments [Boolean] :force True if the data frame analytics should be forcefully stopped - # @option arguments [Time] :timeout Controls the time to wait until the task has stopped. Defaults to 20 seconds + # @option arguments [String] :id Identifier for the data frame analytics job. This identifier can contain + # lowercase alphanumeric characters (a-z and 0-9), hyphens, and + # underscores. It must start and end with alphanumeric characters. (*Required*) + # @option arguments [Boolean] :allow_no_match Specifies what to do when the request: + # - Contains wildcard expressions and there are no data frame analytics + # jobs that match. + # - Contains the _all string or no identifiers and there are no matches. + # - Contains wildcard expressions and there are only partial matches. + # The default value is true, which returns an empty data_frame_analytics + # array when there are no matches and the subset of results when there are + # partial matches. If this parameter is false, the request returns a 404 + # status code when there are no matches or only partial matches. Server default: true. + # @option arguments [Boolean] :force If true, the data frame analytics job is stopped forcefully. + # @option arguments [Time] :timeout Controls the amount of time to wait until the data frame analytics job + # stops. Defaults to 20 seconds. Server default: 20s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The stop data frame analytics parameters # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-stop-data-frame-analytics # def stop_data_frame_analytics(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.stop_data_frame_analytics' } @@ -46,12 +69,12 @@ def stop_data_frame_analytics(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = nil _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_POST - path = "_ml/data_frame/analytics/#{Utils.__listify(_id)}/_stop" + path = "_ml/data_frame/analytics/#{Utils.listify(_id)}/_stop" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_datafeed.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_datafeed.rb index dd7e8f0ad3..d902d6196e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_datafeed.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_datafeed.rb @@ -15,24 +15,44 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Stops one or more datafeeds. + # Stop datafeeds. + # A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed can be started and stopped + # multiple times throughout its lifecycle. # - # @option arguments [String] :datafeed_id The ID of the datafeed to stop - # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) - # @option arguments [Boolean] :allow_no_datafeeds Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) *Deprecated* - # @option arguments [Boolean] :force True if the datafeed should be forcefully stopped. - # @option arguments [Time] :timeout Controls the time to wait until a datafeed has stopped. Default to 20 seconds + # @option arguments [String] :datafeed_id Identifier for the datafeed. You can stop multiple datafeeds in a single API request by using a comma-separated + # list of datafeeds or a wildcard expression. You can close all datafeeds by using `_all` or by specifying `*` as + # the identifier. (*Required*) + # @option arguments [Boolean] :allow_no_match Specifies what to do when the request: + # - Contains wildcard expressions and there are no datafeeds that match. + # - Contains the `_all` string or no identifiers and there are no matches. + # - Contains wildcard expressions and there are only partial matches. + # If `true`, the API returns an empty datafeeds array when there are no matches and the subset of results when + # there are partial matches. If `false`, the API returns a 404 status code when there are no matches or only + # partial matches. Server default: true. + # @option arguments [Boolean] :force If `true`, the datafeed is stopped forcefully. + # @option arguments [Time] :timeout Specifies the amount of time to wait until a datafeed stops. Server default: 20s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The URL params optionally sent in the body + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-stop-datafeed.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-stop-datafeed # def stop_datafeed(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.stop_datafeed' } @@ -52,7 +72,7 @@ def stop_datafeed(arguments = {}) _datafeed_id = arguments.delete(:datafeed_id) method = Elasticsearch::API::HTTP_POST - path = "_ml/datafeeds/#{Utils.__listify(_datafeed_id)}/_stop" + path = "_ml/datafeeds/#{Utils.listify(_datafeed_id)}/_stop" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_trained_model_deployment.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_trained_model_deployment.rb index df59c9fb7a..d96a138948 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_trained_model_deployment.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/stop_trained_model_deployment.rb @@ -15,9 +15,9 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning @@ -25,12 +25,26 @@ module Actions # Stop a trained model deployment. # # @option arguments [String] :model_id The unique identifier of the trained model. (*Required*) - # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no deployments. (This includes `_all` string or when no deployments have been specified) - # @option arguments [Boolean] :force True if the deployment should be forcefully stopped + # @option arguments [Boolean] :allow_no_match Specifies what to do when the request: contains wildcard expressions and there are no deployments that match; + # contains the `_all` string or no identifiers and there are no matches; or contains wildcard expressions and + # there are only partial matches. By default, it returns an empty array when there are no matches and the subset of results when there are partial matches. + # If `false`, the request returns a 404 status code when there are no matches or only partial matches. Server default: true. + # @option arguments [Boolean] :force Forcefully stops the deployment, even if it is used by ingest pipelines. You can't use these pipelines until you + # restart the model deployment. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The stop deployment parameters # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-trained-model-deployment.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-stop-trained-model-deployment # def stop_trained_model_deployment(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.stop_trained_model_deployment' } @@ -45,12 +59,12 @@ def stop_trained_model_deployment(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = nil _model_id = arguments.delete(:model_id) method = Elasticsearch::API::HTTP_POST - path = "_ml/trained_models/#{Utils.__listify(_model_id)}/deployment/_stop" + path = "_ml/trained_models/#{Utils.listify(_model_id)}/deployment/_stop" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_data_frame_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_data_frame_analytics.rb index fe5c713b46..3c1f82ac03 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_data_frame_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_data_frame_analytics.rb @@ -15,20 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Updates certain properties of a data frame analytics job. + # Update a data frame analytics job. # - # @option arguments [String] :id The ID of the data frame analytics to update + # @option arguments [String] :id Identifier for the data frame analytics job. This identifier can contain + # lowercase alphanumeric characters (a-z and 0-9), hyphens, and + # underscores. It must start and end with alphanumeric characters. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The data frame analytics settings to update (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-dfanalytics.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-update-data-frame-analytics # def update_data_frame_analytics(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.update_data_frame_analytics' } @@ -49,8 +62,8 @@ def update_data_frame_analytics(arguments = {}) _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_POST - path = "_ml/data_frame/analytics/#{Utils.__listify(_id)}/_update" - params = {} + path = "_ml/data_frame/analytics/#{Utils.listify(_id)}/_update" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_datafeed.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_datafeed.rb index 34dc4dc9e3..5235c582eb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_datafeed.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_datafeed.rb @@ -15,24 +15,43 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Updates certain properties of a datafeed. + # Update a datafeed. + # You must stop and start the datafeed for the changes to be applied. + # When Elasticsearch security features are enabled, your datafeed remembers which roles the user who updated it had at + # the time of the update and runs the query using those same roles. If you provide secondary authorization headers, + # those credentials are used instead. # - # @option arguments [String] :datafeed_id The ID of the datafeed to update - # @option arguments [Boolean] :ignore_unavailable Ignore unavailable indexes (default: false) - # @option arguments [Boolean] :allow_no_indices Ignore if the source indices expressions resolves to no concrete indices (default: true) - # @option arguments [Boolean] :ignore_throttled Ignore indices that are marked as throttled (default: true) - # @option arguments [String] :expand_wildcards Whether source index expressions should get expanded to open or closed indices (default: open) (options: open, closed, hidden, none, all) + # @option arguments [String] :datafeed_id A numerical character string that uniquely identifies the datafeed. + # This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. + # It must start and end with alphanumeric characters. (*Required*) + # @option arguments [Boolean] :allow_no_indices If `true`, wildcard indices expressions that resolve into no concrete indices are ignored. This includes the + # `_all` string or when no indices are specified. Server default: true. + # @option arguments [String, Array] :expand_wildcards 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. Supports comma-separated values. Server default: open. + # @option arguments [Boolean] :ignore_throttled If `true`, concrete, expanded or aliased indices are ignored when frozen. Server default: true. + # @option arguments [Boolean] :ignore_unavailable If `true`, unavailable indices (missing or closed) are ignored. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The datafeed update settings (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-datafeed.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-update-datafeed # def update_datafeed(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.update_datafeed' } @@ -53,7 +72,7 @@ def update_datafeed(arguments = {}) _datafeed_id = arguments.delete(:datafeed_id) method = Elasticsearch::API::HTTP_POST - path = "_ml/datafeeds/#{Utils.__listify(_datafeed_id)}/_update" + path = "_ml/datafeeds/#{Utils.listify(_datafeed_id)}/_update" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_filter.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_filter.rb index a540151478..598212874a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_filter.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_filter.rb @@ -15,20 +15,32 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Updates the description of a filter, adds items, or removes items. + # Update a filter. + # Updates the description of a filter, adds items, or removes items from the list. # - # @option arguments [String] :filter_id The ID of the filter to update + # @option arguments [String] :filter_id A string that uniquely identifies a filter. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The filter update (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-filter.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-update-filter # def update_filter(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.update_filter' } @@ -49,8 +61,8 @@ def update_filter(arguments = {}) _filter_id = arguments.delete(:filter_id) method = Elasticsearch::API::HTTP_POST - path = "_ml/filters/#{Utils.__listify(_filter_id)}/_update" - params = {} + path = "_ml/filters/#{Utils.listify(_filter_id)}/_update" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_job.rb index 6ed25d906e..0f67b82a10 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_job.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_job.rb @@ -15,20 +15,32 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions + # Update an anomaly detection job. # Updates certain properties of an anomaly detection job. # - # @option arguments [String] :job_id The ID of the job to create + # @option arguments [String] :job_id Identifier for the job. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The job update settings (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-job.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-update-job # def update_job(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.update_job' } @@ -49,8 +61,8 @@ def update_job(arguments = {}) _job_id = arguments.delete(:job_id) method = Elasticsearch::API::HTTP_POST - path = "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/_update" - params = {} + path = "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/_update" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_model_snapshot.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_model_snapshot.rb index 06c73a0dcc..ea54fa188f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_model_snapshot.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_model_snapshot.rb @@ -15,26 +15,38 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions + # Update a snapshot. # Updates certain properties of a snapshot. # - # @option arguments [String] :job_id The ID of the job to fetch - # @option arguments [String] :snapshot_id The ID of the snapshot to update + # @option arguments [String] :job_id Identifier for the anomaly detection job. (*Required*) + # @option arguments [String] :snapshot_id Identifier for the model snapshot. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The model snapshot properties to update (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-update-snapshot.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-update-model-snapshot # def update_model_snapshot(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.update_model_snapshot' } - defined_params = %i[job_id snapshot_id].each_with_object({}) do |variable, set_variables| + defined_params = [:job_id, :snapshot_id].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -53,8 +65,8 @@ def update_model_snapshot(arguments = {}) _snapshot_id = arguments.delete(:snapshot_id) method = Elasticsearch::API::HTTP_POST - path = "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/model_snapshots/#{Utils.__listify(_snapshot_id)}/_update" - params = {} + path = "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/model_snapshots/#{Utils.listify(_snapshot_id)}/_update" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_trained_model_deployment.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_trained_model_deployment.rb index 64c623c328..2a6f7c1faf 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_trained_model_deployment.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/update_trained_model_deployment.rb @@ -15,21 +15,37 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Updates certain properties of trained model deployment. + # Update a trained model deployment. # - # @option arguments [String] :model_id The unique identifier of the trained model. - # @option arguments [Integer] :number_of_allocations Update the model deployment to this number of allocations. + # @option arguments [String] :model_id The unique identifier of the trained model. Currently, only PyTorch models are supported. (*Required*) + # @option arguments [Integer] :number_of_allocations The number of model allocations on each node where the model is deployed. + # All allocations on a node share the same copy of the model in memory but use + # a separate set of threads to evaluate the model. + # Increasing this value generally increases the throughput. + # If this setting is greater than the number of hardware threads + # it will automatically be changed to a value less than the number of hardware threads. Server default: 1. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The updated trained model deployment settings + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-trained-model-deployment.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-update-trained-model-deployment # def update_trained_model_deployment(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.update_trained_model_deployment' } @@ -49,7 +65,7 @@ def update_trained_model_deployment(arguments = {}) _model_id = arguments.delete(:model_id) method = Elasticsearch::API::HTTP_POST - path = "_ml/trained_models/#{Utils.__listify(_model_id)}/deployment/_update" + path = "_ml/trained_models/#{Utils.listify(_model_id)}/deployment/_update" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/upgrade_job_snapshot.rb b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/upgrade_job_snapshot.rb index 7d21a2afd3..d192284132 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/upgrade_job_snapshot.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/upgrade_job_snapshot.rb @@ -15,27 +15,48 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module MachineLearning module Actions - # Upgrades a given job snapshot to the current major version. + # Upgrade a snapshot. + # Upgrade an anomaly detection model snapshot to the latest major version. + # Over time, older snapshot formats are deprecated and removed. Anomaly + # detection jobs support only snapshots that are from the current or previous + # major version. + # This API provides a means to upgrade a snapshot to the current major version. + # This aids in preparing the cluster for an upgrade to the next major version. + # Only one snapshot per anomaly detection job can be upgraded at a time and the + # upgraded snapshot cannot be the current snapshot of the anomaly detection + # job. # - # @option arguments [String] :job_id The ID of the job - # @option arguments [String] :snapshot_id The ID of the snapshot - # @option arguments [Time] :timeout How long should the API wait for the job to be opened and the old snapshot to be loaded. - # @option arguments [Boolean] :wait_for_completion Should the request wait until the task is complete before responding to the caller. Default is false. + # @option arguments [String] :job_id Identifier for the anomaly detection job. (*Required*) + # @option arguments [String] :snapshot_id A numerical character string that uniquely identifies the model snapshot. (*Required*) + # @option arguments [Boolean] :wait_for_completion When true, the API won’t respond until the upgrade is complete. + # Otherwise, it responds as soon as the upgrade task is assigned to a node. + # @option arguments [Time] :timeout Controls the time to wait for the request to complete. Server default: 30m. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-upgrade-job-model-snapshot.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ml-upgrade-job-snapshot # def upgrade_job_snapshot(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ml.upgrade_job_snapshot' } - defined_params = %i[job_id snapshot_id].each_with_object({}) do |variable, set_variables| + defined_params = [:job_id, :snapshot_id].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -53,7 +74,7 @@ def upgrade_job_snapshot(arguments = {}) _snapshot_id = arguments.delete(:snapshot_id) method = Elasticsearch::API::HTTP_POST - path = "_ml/anomaly_detectors/#{Utils.__listify(_job_id)}/model_snapshots/#{Utils.__listify(_snapshot_id)}/_upgrade" + path = "_ml/anomaly_detectors/#{Utils.listify(_job_id)}/model_snapshots/#{Utils.listify(_snapshot_id)}/_upgrade" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/mget.rb b/elasticsearch-api/lib/elasticsearch/api/actions/mget.rb index ada183568f..ce91475a27 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/mget.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/mget.rb @@ -15,28 +15,55 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Allows to get multiple documents in one request. + # Get multiple documents. + # Get multiple JSON documents by ID from one or more indices. + # If you specify an index in the request URI, you only need to specify the document IDs in the request body. + # To ensure fast responses, this multi get (mget) API responds with partial results if one or more shards fail. + # **Filter source fields** + # By default, the `_source` field is returned for every document (if stored). + # Use the `_source` and `_source_include` or `source_exclude` attributes to filter what fields are returned for a particular document. + # You can include the `_source`, `_source_includes`, and `_source_excludes` query parameters in the request URI to specify the defaults to use when there are no per-document instructions. + # **Get stored fields** + # Use the `stored_fields` attribute to specify the set of stored fields you want to retrieve. + # Any requested fields that are not stored are ignored. + # You can include the `stored_fields` query parameter in the request URI to specify the defaults to use when there are no per-document instructions. # - # @option arguments [String] :index The name of the index - # @option arguments [Boolean] :force_synthetic_source Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index. - # @option arguments [List] :stored_fields A comma-separated list of stored fields to return in the response - # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) - # @option arguments [Boolean] :realtime Specify whether to perform the operation in realtime or search mode - # @option arguments [Boolean] :refresh Refresh the shard containing the document before performing the operation - # @option arguments [String] :routing Specific routing value - # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return - # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field - # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field + # @option arguments [String] :index Name of the index to retrieve documents from when `ids` are specified, or when a document in the `docs` array does not specify an index. + # @option arguments [Boolean] :force_synthetic_source Should this request force synthetic _source? + # Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. + # Fetches with this enabled will be slower the enabling synthetic source natively in the index. + # @option arguments [String] :preference Specifies the node or shard the operation should be performed on. Random by default. + # @option arguments [Boolean] :realtime If `true`, the request is real-time as opposed to near-real-time. Server default: true. + # @option arguments [Boolean] :refresh If `true`, the request refreshes relevant shards before retrieving documents. + # @option arguments [String] :routing Custom value used to route operations to a specific shard. + # @option arguments [Boolean, String, Array] :_source True or false to return the `_source` field or not, or a list of fields to return. + # @option arguments [String, Array] :_source_excludes A comma-separated list of source fields to exclude from the response. + # You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. + # @option arguments [String, Array] :_source_includes A comma-separated list of source fields to include in the response. + # If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. + # If the `_source` parameter is `false`, this parameter is ignored. + # @option arguments [String, Array] :stored_fields If `true`, retrieves the document fields stored in the index rather than the document `_source`. Server default: false. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body Document identifiers; can be either `docs` (containing full document information) or `ids` (when index is provided in the URL. (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-get.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-mget # def mget(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'mget' } @@ -51,13 +78,13 @@ def mget(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_POST path = if _index - "#{Utils.__listify(_index)}/_mget" + "#{Utils.listify(_index)}/_mget" else '_mget' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/migration/deprecations.rb b/elasticsearch-api/lib/elasticsearch/api/actions/migration/deprecations.rb index 561bfa4c0d..97767c915a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/migration/deprecations.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/migration/deprecations.rb @@ -15,19 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Migration module Actions - # Retrieves information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version. + # Get deprecation information. + # Get information about different cluster, node, and index level settings that use deprecated features that will be removed or changed in the next major version. + # TIP: This APIs is designed for indirect use by the Upgrade Assistant. + # You are strongly recommended to use the Upgrade Assistant. # - # @option arguments [String] :index Index pattern + # @option arguments [String] :index Comma-separate list of data streams or indices to check. Wildcard (*) expressions are supported. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-deprecation.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-migration-deprecations # def deprecations(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'migration.deprecations' } @@ -40,17 +54,17 @@ def deprecations(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_GET path = if _index - "#{Utils.__listify(_index)}/_migration/deprecations" + "#{Utils.listify(_index)}/_migration/deprecations" else '_migration/deprecations' end - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/migration/get_feature_upgrade_status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/migration/get_feature_upgrade_status.rb index b5263b949f..1a93dc1295 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/migration/get_feature_upgrade_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/migration/get_feature_upgrade_status.rb @@ -15,18 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Migration module Actions - # Find out whether system features need to be upgraded or not + # Get feature migration information. + # Version upgrades sometimes require changes to how features store configuration information and data in system indices. + # Check which features need to be migrated and the status of any migrations that are in progress. + # TIP: This API is designed for indirect use by the Upgrade Assistant. + # You are strongly recommended to use the Upgrade Assistant. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-feature-upgrade.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-migration-get-feature-upgrade-status # def get_feature_upgrade_status(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'migration.get_feature_upgrade_status' } @@ -34,11 +49,11 @@ def get_feature_upgrade_status(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_migration/system_features' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/migration/post_feature_upgrade.rb b/elasticsearch-api/lib/elasticsearch/api/actions/migration/post_feature_upgrade.rb index 64f31d63d6..3bdde2a111 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/migration/post_feature_upgrade.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/migration/post_feature_upgrade.rb @@ -15,18 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Migration module Actions - # Begin upgrades for system features + # Start the feature migration. + # Version upgrades sometimes require changes to how features store configuration information and data in system indices. + # This API starts the automatic migration process. + # Some functionality might be temporarily unavailable during the migration process. + # TIP: The API is designed for indirect use by the Upgrade Assistant. We strongly recommend you use the Upgrade Assistant. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-feature-upgrade.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-migration-get-feature-upgrade-status # def post_feature_upgrade(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'migration.post_feature_upgrade' } @@ -34,11 +49,11 @@ def post_feature_upgrade(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_POST path = '_migration/system_features' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb index 4b326a03fc..bfdfd55fc8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/msearch.rb @@ -15,26 +15,67 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Allows to execute several search operations in one request. + # Run multiple searches. + # The format of the request is similar to the bulk API format and makes use of the newline delimited JSON (NDJSON) format. + # The structure is as follows: + # + # ``` + # header + # + # body + # + # header + # + # body + # + # ``` + # + # This structure is specifically optimized to reduce parsing if a specific search ends up redirected to another node. + # IMPORTANT: The final line of data must end with a newline character `\n`. + # Each newline character may be preceded by a carriage return `\r`. + # When sending requests to this endpoint the `Content-Type` header should be set to `application/x-ndjson`. # - # @option arguments [List] :index A comma-separated list of index names to use as default - # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch) - # @option arguments [Number] :max_concurrent_searches Controls the maximum number of concurrent searches the multi search api will execute - # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response - # @option arguments [Number] :pre_filter_shard_size A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint. - # @option arguments [Number] :max_concurrent_shard_requests The number of concurrent shard requests each sub search executes concurrently per node. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests - # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response - # @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution + # @option arguments [String, Array] :index Comma-separated list of data streams, indices, and index aliases to search. + # @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. + # @option arguments [Boolean] :ccs_minimize_roundtrips If true, network roundtrips between the coordinating node and remote clusters are minimized for cross-cluster search requests. Server default: true. + # @option arguments [String, Array] :expand_wildcards Type of index that wildcard expressions can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. + # @option arguments [Boolean] :ignore_throttled If true, concrete, expanded or aliased indices are ignored when frozen. + # @option arguments [Boolean] :ignore_unavailable If true, missing or closed indices are not included in the response. + # @option arguments [Boolean] :include_named_queries_score Indicates whether hit.matched_queries should be rendered as a map that includes + # the name of the matched query associated with its score (true) + # or as an array containing the name of the matched queries (false) + # This functionality reruns each named query on every hit in a search response. + # Typically, this adds a small overhead to a request. + # However, using computationally expensive named queries on a large number of hits may add significant overhead. + # @option arguments [Integer] :max_concurrent_searches Maximum number of concurrent searches the multi search API can execute. + # Defaults to `max(1, (# of data nodes * min(search thread pool size, 10)))`. + # @option arguments [Integer] :max_concurrent_shard_requests Maximum number of concurrent shard requests that each sub-search request executes per node. Server default: 5. + # @option arguments [Integer] :pre_filter_shard_size Defines a threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method i.e., if date filters are mandatory to match but the shard bounds and the query are disjoint. + # @option arguments [Boolean] :rest_total_hits_as_int If true, hits.total are returned as an integer in the response. Defaults to false, which returns an object. + # @option arguments [String] :routing Custom routing value used to route search operations to a specific shard. + # @option arguments [String] :search_type Indicates whether global term and document frequencies should be used when scoring returned documents. + # @option arguments [Boolean] :typed_keys Specifies whether aggregation and suggester names should be prefixed by their respective types in the response. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The request definitions (metadata-search request definition pairs), separated by newlines (*Required*) + # @option arguments [Hash] :body searches # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-msearch # def msearch(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'msearch' } @@ -49,19 +90,19 @@ def msearch(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_POST path = if _index - "#{Utils.__listify(_index)}/_msearch" + "#{Utils.listify(_index)}/_msearch" else '_msearch' end params = Utils.process_params(arguments) - if body.is_a?(Array) && body.any? { |d| d.has_key? :search } + if body.is_a?(Array) && body.any? { |d| d.key? :search } payload = body.each_with_object([]) do |item, sum| meta = item data = meta.delete(:search) @@ -79,7 +120,7 @@ def msearch(arguments = {}) payload = body end - headers.merge!('Content-Type' => 'application/x-ndjson') + Utils.update_ndjson_headers!(headers, transport.options.dig(:transport_options, :headers)) Elasticsearch::API::Response.new( perform_request(method, path, params, payload, headers, request_opts) ) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/msearch_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/msearch_template.rb index 9f8c741f39..f480272ef1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/msearch_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/msearch_template.rb @@ -15,24 +15,50 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Allows to execute several search template operations in one request. + # Run multiple templated searches. + # Run multiple templated searches with a single request. + # If you are providing a text file or text input to `curl`, use the `--data-binary` flag instead of `-d` to preserve newlines. + # For example: + # + # ``` + # $ cat requests + # { "index": "my-index" } + # { "id": "my-search-template", "params": { "query_string": "hello world", "from": 0, "size": 10 }} + # { "index": "my-other-index" } + # { "id": "my-other-search-template", "params": { "query_type": "match_all" }} + # $ curl -H "Content-Type: application/x-ndjson" -XGET localhost:9200/_msearch/template --data-binary "@requests"; echo + # ``` # - # @option arguments [List] :index A comma-separated list of index names to use as default - # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch) - # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response - # @option arguments [Number] :max_concurrent_searches Controls the maximum number of concurrent searches the multi search api will execute - # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response - # @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution + # @option arguments [String, Array] :index A comma-separated list of data streams, indices, and aliases to search. + # It supports wildcards (`*`). + # To search all data streams and indices, omit this parameter or use `*`. + # @option arguments [Boolean] :ccs_minimize_roundtrips If `true`, network round-trips are minimized for cross-cluster search requests. Server default: true. + # @option arguments [Integer] :max_concurrent_searches The maximum number of concurrent searches the API can run. + # @option arguments [String] :search_type The type of the search operation. + # @option arguments [Boolean] :rest_total_hits_as_int If `true`, the response returns `hits.total` as an integer. + # If `false`, it returns `hits.total` as an object. + # @option arguments [Boolean] :typed_keys If `true`, the response prefixes aggregation and suggester names with their respective types. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The request definitions (metadata-search request definition pairs), separated by newlines (*Required*) + # @option arguments [Hash] :body search_templates # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-multi-search.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-msearch-template # def msearch_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'msearch_template' } @@ -47,13 +73,13 @@ def msearch_template(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_POST path = if _index - "#{Utils.__listify(_index)}/_msearch/template" + "#{Utils.listify(_index)}/_msearch/template" else '_msearch/template' end @@ -67,7 +93,7 @@ def msearch_template(arguments = {}) payload = body end - headers.merge!('Content-Type' => 'application/x-ndjson') + Utils.update_ndjson_headers!(headers, transport.options.dig(:transport_options, :headers)) Elasticsearch::API::Response.new( perform_request(method, path, params, payload, headers, request_opts) ) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/mtermvectors.rb b/elasticsearch-api/lib/elasticsearch/api/actions/mtermvectors.rb index 2621ff9d51..7b3e85aebf 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/mtermvectors.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/mtermvectors.rb @@ -15,31 +15,52 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Returns multiple termvectors in one request. + # Get multiple term vectors. + # Get multiple term vectors with a single request. + # You can specify existing documents by index and ID or provide artificial documents in the body of the request. + # You can specify the index in the request body or request URI. + # The response contains a `docs` array with all the fetched termvectors. + # Each element has the structure provided by the termvectors API. + # **Artificial documents** + # You can also use `mtermvectors` to generate term vectors for artificial documents provided in the body of the request. + # The mapping used is determined by the specified `_index`. # - # @option arguments [String] :index The index in which the document resides. - # @option arguments [List] :ids A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body - # @option arguments [Boolean] :term_statistics Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". - # @option arguments [Boolean] :field_statistics Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". - # @option arguments [List] :fields A comma-separated list of fields to return. Applies to all returned documents unless otherwise specified in body "params" or "docs". - # @option arguments [Boolean] :offsets Specifies if term offsets should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". - # @option arguments [Boolean] :positions Specifies if term positions should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". - # @option arguments [Boolean] :payloads Specifies if term payloads should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs". - # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) .Applies to all returned documents unless otherwise specified in body "params" or "docs". - # @option arguments [String] :routing Specific routing value. Applies to all returned documents unless otherwise specified in body "params" or "docs". - # @option arguments [Boolean] :realtime Specifies if requests are real-time as opposed to near-real-time (default: true). - # @option arguments [Number] :version Explicit version number for concurrency control - # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte) + # @option arguments [String] :index The name of the index that contains the documents. + # @option arguments [Array] :ids A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body + # @option arguments [String, Array] :fields A comma-separated list or wildcard expressions of fields to include in the statistics. + # It is used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters. + # @option arguments [Boolean] :field_statistics If `true`, the response includes the document count, sum of document frequencies, and sum of total term frequencies. Server default: true. + # @option arguments [Boolean] :offsets If `true`, the response includes term offsets. Server default: true. + # @option arguments [Boolean] :payloads If `true`, the response includes term payloads. Server default: true. + # @option arguments [Boolean] :positions If `true`, the response includes term positions. Server default: true. + # @option arguments [String] :preference The node or shard the operation should be performed on. + # It is random by default. + # @option arguments [Boolean] :realtime If true, the request is real-time as opposed to near-real-time. Server default: true. + # @option arguments [String] :routing A custom value used to route operations to a specific shard. + # @option arguments [Boolean] :term_statistics If true, the response includes term frequency and document frequency. + # @option arguments [Integer] :version If `true`, returns the document version as part of a hit. + # @option arguments [String] :version_type The version type. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body Define ids, documents, parameters or a list of parameters per document here. You must at least provide a list of document ids. See documentation. + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-multi-termvectors.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-mtermvectors # def mtermvectors(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'mtermvectors' } @@ -52,11 +73,7 @@ def mtermvectors(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = if (ids = arguments.delete(:ids)) - { ids: ids } - else - arguments.delete(:body) - end + body = arguments.delete(:body) _index = arguments.delete(:index) @@ -66,11 +83,11 @@ def mtermvectors(arguments = {}) Elasticsearch::API::HTTP_GET end - path = if _index - "#{Utils.__listify(_index)}/_mtermvectors" - else - '_mtermvectors' - end + path = if _index + "#{Utils.listify(_index)}/_mtermvectors" + else + '_mtermvectors' + end params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/clear_repositories_metering_archive.rb b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/clear_repositories_metering_archive.rb index 9d26816ac4..6316fffc40 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/clear_repositories_metering_archive.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/clear_repositories_metering_archive.rb @@ -15,35 +15,51 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Nodes module Actions - # Removes the archived repositories metering information present in the cluster. + # Clear the archived repositories metering. + # Clear the archived repositories metering information in the cluster. # 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 [List] :node_id Comma-separated list of node IDs or names used to limit returned information. - # @option arguments [Long] :max_archive_version Specifies the maximum archive_version to be cleared from the archive. + # @option arguments [String, Array] :node_id Comma-separated list of node IDs or names used to limit returned information. (*Required*) + # @option arguments [Integer] :max_archive_version Specifies the maximum `archive_version` to be cleared from the archive. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-repositories-metering-archive-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-nodes-clear-repositories-metering-archive # def clear_repositories_metering_archive(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'nodes.clear_repositories_metering_archive' } - defined_params = %i[node_id max_archive_version].each_with_object({}) do |variable, set_variables| + defined_params = [:node_id, :max_archive_version].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? raise ArgumentError, "Required argument 'node_id' missing" unless arguments[:node_id] - raise ArgumentError, "Required argument 'max_archive_version' missing" unless arguments[:max_archive_version] + + unless arguments[:max_archive_version] + raise ArgumentError, + "Required argument 'max_archive_version' missing" + end arguments = arguments.clone headers = arguments.delete(:headers) || {} @@ -55,8 +71,8 @@ def clear_repositories_metering_archive(arguments = {}) _max_archive_version = arguments.delete(:max_archive_version) method = Elasticsearch::API::HTTP_DELETE - path = "_nodes/#{Utils.__listify(_node_id)}/_repositories_metering/#{Utils.__listify(_max_archive_version)}" - params = {} + path = "_nodes/#{Utils.listify(_node_id)}/_repositories_metering/#{Utils.listify(_max_archive_version)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/get_repositories_metering_info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/get_repositories_metering_info.rb index 9afe42fab4..464e721380 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/get_repositories_metering_info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/get_repositories_metering_info.rb @@ -15,23 +15,37 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Nodes module Actions - # Returns cluster repositories metering information. + # Get cluster repositories metering. + # Get repositories metering information for a cluster. + # This API exposes monotonically non-decreasing counters and it is expected that clients would durably store the information needed to compute aggregations over a period of time. + # Additionally, the information exposed by this API is volatile, meaning that it will not be present after node restarts. # 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 [List] :node_id A comma-separated list of node IDs or names to limit the returned information. + # @option arguments [String, Array] :node_id Comma-separated list of node IDs or names used to limit returned information. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-repositories-metering-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-nodes-get-repositories-metering-info # def get_repositories_metering_info(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'nodes.get_repositories_metering_info' } @@ -51,8 +65,8 @@ def get_repositories_metering_info(arguments = {}) _node_id = arguments.delete(:node_id) method = Elasticsearch::API::HTTP_GET - path = "_nodes/#{Utils.__listify(_node_id)}/_repositories_metering" - params = {} + path = "_nodes/#{Utils.listify(_node_id)}/_repositories_metering" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/hot_threads.rb b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/hot_threads.rb index 20465247db..059e255ef1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/hot_threads.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/hot_threads.rb @@ -15,26 +15,41 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Nodes module Actions - # Returns information about hot threads on each node in the cluster. + # Get the hot threads for nodes. + # Get a breakdown of the hot threads on each selected node in the cluster. + # The output is plain text with a breakdown of the top hot threads for each node. # - # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes - # @option arguments [Time] :interval The interval for the second sampling of threads - # @option arguments [Number] :snapshots Number of samples of thread stacktrace (default: 10) - # @option arguments [Number] :threads Specify the number of threads to provide information for (default: 3) - # @option arguments [Boolean] :ignore_idle_threads Don't show threads that are in known-idle places, such as waiting on a socket select or pulling from an empty task queue (default: true) - # @option arguments [String] :type The type to sample (default: cpu) (options: cpu, wait, block, mem) - # @option arguments [String] :sort The sort order for 'cpu' type (default: total) (options: cpu, total) - # @option arguments [Time] :timeout Explicit operation timeout + # @option arguments [String, Array] :node_id List of node IDs or names used to limit returned information. + # @option arguments [Boolean] :ignore_idle_threads If true, known idle threads (e.g. waiting in a socket select, or to get + # a task from an empty queue) are filtered out. Server default: true. + # @option arguments [Time] :interval The interval to do the second sampling of threads. Server default: 500ms. + # @option arguments [Integer] :snapshots Number of samples of thread stacktrace. Server default: 10. + # @option arguments [Integer] :threads Specifies the number of hot threads to provide information for. Server default: 3. + # @option arguments [Time] :timeout Period to wait for a response. If no response is received + # before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [String] :type The type to sample. Server default: cpu. + # @option arguments [String] :sort The sort order for 'cpu' type (default: total) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-hot-threads.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-nodes-hot-threads # def hot_threads(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'nodes.hot_threads' } @@ -53,7 +68,7 @@ def hot_threads(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _node_id - "_nodes/#{Utils.__listify(_node_id)}/hot_threads" + "_nodes/#{Utils.listify(_node_id)}/hot_threads" else '_nodes/hot_threads' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/info.rb index 0fb3986309..ea9a40b7b0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/info.rb @@ -15,27 +15,39 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Nodes module Actions - # Returns information about nodes in the cluster. + # Get node information. + # By default, the API returns all attributes and core settings for cluster nodes. # - # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes - # @option arguments [List] :metric A comma-separated list of metrics you wish returned. Use `_all` to retrieve all metrics and `_none` to retrieve the node identity without any additional metrics. (options: settings, os, process, jvm, thread_pool, transport, http, plugins, ingest, indices, aggregations, _all, _none) - # @option arguments [Boolean] :flat_settings Return settings in flat format (default: false) - # @option arguments [Time] :timeout Explicit operation timeout + # @option arguments [String, Array] :node_id Comma-separated list of node IDs or names used to limit returned information. + # @option arguments [String, Array] :metric Limits the information returned to the specific metrics. Supports a comma-separated list, such as http,ingest. + # @option arguments [Boolean] :flat_settings If true, returns settings in flat format. + # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-info.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-nodes-info # def info(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'nodes.info' } - defined_params = %i[node_id metric].each_with_object({}) do |variable, set_variables| + defined_params = [:node_id, :metric].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -51,11 +63,11 @@ def info(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _node_id && _metric - "_nodes/#{Utils.__listify(_node_id)}/#{Utils.__listify(_metric)}" + "_nodes/#{Utils.listify(_node_id)}/#{Utils.listify(_metric)}" elsif _node_id - "_nodes/#{Utils.__listify(_node_id)}" + "_nodes/#{Utils.listify(_node_id)}" elsif _metric - "_nodes/#{Utils.__listify(_metric)}" + "_nodes/#{Utils.listify(_metric)}" else '_nodes' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb index 8c7ed792db..a60a79dc87 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb @@ -15,21 +15,39 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Nodes module Actions - # Reloads secure settings. + # Reload the keystore on nodes in the cluster. + # Secure settings are stored in an on-disk keystore. Certain of these settings are reloadable. + # That is, you can change them on disk and reload them without restarting any nodes in the cluster. + # When you have updated reloadable secure settings in your keystore, you can use this API to reload those settings on each node. + # When the Elasticsearch keystore is password protected and not simply obfuscated, you must provide the password for the keystore when you reload the secure settings. + # Reloading the settings for the whole cluster assumes that the keystores for all nodes are protected with the same password; this method is allowed only when inter-node communications are encrypted. + # Alternatively, you can reload the secure settings on each node by locally accessing the API and passing the node-specific Elasticsearch keystore password. # - # @option arguments [List] :node_id A comma-separated list of node IDs to span the reload/reinit call. Should stay empty because reloading usually involves all cluster nodes. - # @option arguments [Time] :timeout Explicit operation timeout + # @option arguments [String, Array] :node_id The names of particular nodes in the cluster to target. + # @option arguments [Time] :timeout Period to wait for a response. + # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body An object containing the password for the elasticsearch keystore + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/secure-settings.html#reloadable-secure-settings + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-nodes-reload-secure-settings # def reload_secure_settings(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'nodes.reload_secure_settings' } @@ -48,7 +66,7 @@ def reload_secure_settings(arguments = {}) method = Elasticsearch::API::HTTP_POST path = if _node_id - "_nodes/#{Utils.__listify(_node_id)}/reload_secure_settings" + "_nodes/#{Utils.listify(_node_id)}/reload_secure_settings" else '_nodes/reload_secure_settings' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/stats.rb index 318d8c217c..f8e6fbb099 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/stats.rb @@ -15,35 +15,48 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Nodes module Actions - # Returns statistical information about nodes in the cluster. + # Get node statistics. + # Get statistics for nodes in a cluster. + # By default, all stats are returned. You can limit the returned information by using metrics. # - # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes - # @option arguments [List] :metric Limit the information returned to the specified metrics (options: _all, breaker, fs, http, indices, jvm, os, process, thread_pool, transport, discovery, indexing_pressure) - # @option arguments [List] :index_metric Limit the information returned for `indices` metric to the specific index metrics. Isn't used if `indices` (or `all`) metric isn't specified. (options: _all, completion, docs, fielddata, query_cache, flush, get, indexing, merge, request_cache, refresh, search, segments, store, warmer, bulk, shard_stats) - # @option arguments [List] :completion_fields A comma-separated list of fields for the `completion` index metric (supports wildcards) - # @option arguments [List] :fielddata_fields A comma-separated list of fields for the `fielddata` index metric (supports wildcards) - # @option arguments [List] :fields A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards) - # @option arguments [Boolean] :groups A comma-separated list of search groups for `search` index metric - # @option arguments [String] :level Return indices stats aggregated at index, node or shard level (options: indices, node, shards) - # @option arguments [List] :types A comma-separated list of document types for the `indexing` index metric - # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Boolean] :include_segment_file_sizes Whether to report the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested) - # @option arguments [Boolean] :include_unloaded_segments If set to true segment stats will include stats for segments that are not currently loaded into memory + # @option arguments [String, Array] :node_id Comma-separated list of node IDs or names used to limit returned information. + # @option arguments [String, Array] :metric Limit the information returned to the specified metrics + # @option arguments [String, Array] :index_metric Limit the information returned for indices metric to the specific index metrics. It can be used only if indices (or all) metric is specified. + # @option arguments [String, Array] :completion_fields Comma-separated list or wildcard expressions of fields to include in fielddata and suggest statistics. + # @option arguments [String, Array] :fielddata_fields Comma-separated list or wildcard expressions of fields to include in fielddata statistics. + # @option arguments [String, Array] :fields Comma-separated list or wildcard expressions of fields to include in the statistics. + # @option arguments [Boolean] :groups Comma-separated list of search groups to include in the search statistics. + # @option arguments [Boolean] :include_segment_file_sizes If true, the call reports the aggregated disk usage of each one of the Lucene index files (only applies if segment stats are requested). + # @option arguments [String] :level Indicates whether statistics are aggregated at the cluster, index, or shard level. + # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Array] :types A comma-separated list of document types for the indexing index metric. + # @option arguments [Boolean] :include_unloaded_segments If `true`, the response includes information from segments that are not loaded into memory. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-stats.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-nodes-stats # def stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'nodes.stats' } - defined_params = %i[node_id metric index_metric].each_with_object({}) do |variable, set_variables| + defined_params = [:node_id, :metric, :index_metric].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -61,15 +74,15 @@ def stats(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _node_id && _metric && _index_metric - "_nodes/#{Utils.__listify(_node_id)}/stats/#{Utils.__listify(_metric)}/#{Utils.__listify(_index_metric)}" + "_nodes/#{Utils.listify(_node_id)}/stats/#{Utils.listify(_metric)}/#{Utils.listify(_index_metric)}" elsif _metric && _index_metric - "_nodes/stats/#{Utils.__listify(_metric)}/#{Utils.__listify(_index_metric)}" + "_nodes/stats/#{Utils.listify(_metric)}/#{Utils.listify(_index_metric)}" elsif _node_id && _metric - "_nodes/#{Utils.__listify(_node_id)}/stats/#{Utils.__listify(_metric)}" + "_nodes/#{Utils.listify(_node_id)}/stats/#{Utils.listify(_metric)}" elsif _node_id - "_nodes/#{Utils.__listify(_node_id)}/stats" + "_nodes/#{Utils.listify(_node_id)}/stats" elsif _metric - "_nodes/stats/#{Utils.__listify(_metric)}" + "_nodes/stats/#{Utils.listify(_metric)}" else '_nodes/stats' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/usage.rb b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/usage.rb index 9d5150ab6c..c5072b16df 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/nodes/usage.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/nodes/usage.rb @@ -15,26 +15,39 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Nodes module Actions - # Returns low-level information about REST actions usage on nodes. + # Get feature usage information. # - # @option arguments [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes - # @option arguments [List] :metric Limit the information returned to the specified metrics (options: _all, rest_actions) - # @option arguments [Time] :timeout Explicit operation timeout + # @option arguments [String, Array] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes + # @option arguments [String, Array] :metric Limits the information returned to the specific metrics. + # A comma-separated list of the following options: `_all`, `rest_actions`. + # @option arguments [Time] :timeout Period to wait for a response. + # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-usage.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-nodes-usage # def usage(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'nodes.usage' } - defined_params = %i[node_id metric].each_with_object({}) do |variable, set_variables| + defined_params = [:node_id, :metric].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -50,11 +63,11 @@ def usage(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _node_id && _metric - "_nodes/#{Utils.__listify(_node_id)}/usage/#{Utils.__listify(_metric)}" + "_nodes/#{Utils.listify(_node_id)}/usage/#{Utils.listify(_metric)}" elsif _node_id - "_nodes/#{Utils.__listify(_node_id)}/usage" + "_nodes/#{Utils.listify(_node_id)}/usage" elsif _metric - "_nodes/usage/#{Utils.__listify(_metric)}" + "_nodes/usage/#{Utils.listify(_metric)}" else '_nodes/usage' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/open_point_in_time.rb b/elasticsearch-api/lib/elasticsearch/api/actions/open_point_in_time.rb index 79bda5d140..49d9ec2196 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/open_point_in_time.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/open_point_in_time.rb @@ -15,25 +15,67 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Open a point in time that can be used in subsequent searches + # Open a point in time. + # A search request by default runs against the most recent visible data of the target indices, + # which is called point in time. Elasticsearch pit (point in time) is a lightweight view into the + # state of the data as it existed when initiated. In some cases, it’s preferred to perform multiple + # search requests using the same point in time. For example, if refreshes happen between + # `search_after` requests, then the results of those requests might not be consistent as changes happening + # between searches are only visible to the more recent point in time. + # A point in time must be opened explicitly before being used in search requests. + # A subsequent search request with the `pit` parameter must not specify `index`, `routing`, or `preference` values as these parameters are copied from the point in time. + # Just like regular searches, you can use `from` and `size` to page through point in time search results, up to the first 10,000 hits. + # If you want to retrieve more hits, use PIT with `search_after`. + # IMPORTANT: The open point in time request and each subsequent search request can return different identifiers; always use the most recently received ID for the next search request. + # When a PIT that contains shard failures is used in a search request, the missing are always reported in the search response as a `NoShardAvailableActionException` exception. + # To get rid of these exceptions, a new PIT needs to be created so that shards missing from the previous PIT can be handled, assuming they become available in the meantime. + # **Keeping point in time alive** + # The `keep_alive` parameter, which is passed to a open point in time request and search request, extends the time to live of the corresponding point in time. + # The value does not need to be long enough to process all data — it just needs to be long enough for the next request. + # Normally, the background merge process optimizes the index by merging together smaller segments to create new, bigger segments. + # Once the smaller segments are no longer needed they are deleted. + # However, open point-in-times prevent the old segments from being deleted since they are still in use. + # TIP: Keeping older segments alive means that more disk space and file handles are needed. + # Ensure that you have configured your nodes to have ample free file handles. + # Additionally, if a segment contains deleted or updated documents then the point in time must keep track of whether each document in the segment was live at the time of the initial search request. + # Ensure that your nodes have sufficient heap space if you have many open point-in-times on an index that is subject to ongoing deletes or updates. + # Note that a point-in-time doesn't prevent its associated indices from being deleted. + # You can check how many point-in-times (that is, search contexts) are open with the nodes stats API. # - # @option arguments [List] :index A comma-separated list of index names to open point in time; use `_all` or empty string to perform the operation on all indices - # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) - # @option arguments [String] :routing Specific routing value - # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) - # @option arguments [String] :keep_alive Specific the time to live for the point in time (*Required*) - # @option arguments [Boolean] :allow_partial_search_results Specify whether to tolerate shards missing when creating the point-in-time, or otherwise throw an exception. (default: false) + # @option arguments [String, Array] :index A comma-separated list of index names to open point in time; use `_all` or empty string to perform the operation on all indices (*Required*) + # @option arguments [Time] :keep_alive Extend the length of time that the point in time persists. (*Required*) + # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. + # @option arguments [String] :preference The node or shard the operation should be performed on. + # By default, it is random. + # @option arguments [String] :routing A custom value that is used to route operations to a specific shard. + # @option arguments [String, Array] :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`. Server default: open. + # @option arguments [Boolean] :allow_partial_search_results Indicates whether the point in time tolerates unavailable shards or shard failures when initially creating the PIT. + # If `false`, creating a point in time request when a shard is missing or unavailable will throw an exception. + # If `true`, the point in time will contain all the shards that are available at the time of the request. + # @option arguments [Integer] :max_concurrent_shard_requests Maximum number of concurrent shard requests that each sub-search request executes per node. Server default: 5. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body An index_filter specified with the Query DSL + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/point-in-time-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-open-point-in-time # def open_point_in_time(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'open_point_in_time' } @@ -48,12 +90,12 @@ def open_point_in_time(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_POST - path = "#{Utils.__listify(_index)}/_pit" + path = "#{Utils.listify(_index)}/_pit" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ping.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ping.rb index 7f8dd0bbf8..dec95d7b19 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ping.rb @@ -15,17 +15,29 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Returns whether the cluster is running. + # Ping the cluster. + # Get information about whether the cluster is running. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-cluster # def ping(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ping' } @@ -33,11 +45,11 @@ def ping(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_HEAD path = '' - params = {} + params = Utils.process_params(arguments) begin perform_request(method, path, params, body, headers, request_opts).status == 200 diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/put_script.rb b/elasticsearch-api/lib/elasticsearch/api/actions/put_script.rb index b720d74044..96a7d6ed92 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/put_script.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/put_script.rb @@ -15,27 +15,45 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Creates or updates a script. + # Create or update a script or search template. + # Creates or updates a stored script or search template. # - # @option arguments [String] :id Script ID - # @option arguments [String] :context Script context - # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [String] :id The identifier for the stored script or search template. + # It must be unique within the cluster. (*Required*) + # @option arguments [String] :context The context in which the script or search template should run. + # To prevent errors, the API immediately compiles the script or template in this context. + # @option arguments [Time] :master_timeout The 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. + # It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s. + # @option arguments [Time] :timeout The period to wait for a response. + # If no response is received before the timeout expires, the request fails and returns an error. + # It can also be set to `-1` to indicate that the request should never timeout. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The document (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-scripting.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-put-script # def put_script(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'put_script' } - defined_params = %i[id context].each_with_object({}) do |variable, set_variables| + defined_params = [:id, :context].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -54,9 +72,9 @@ def put_script(arguments = {}) method = Elasticsearch::API::HTTP_PUT path = if _id && _context - "_scripts/#{Utils.__listify(_id)}/#{Utils.__listify(_context)}" + "_scripts/#{Utils.listify(_id)}/#{Utils.listify(_context)}" else - "_scripts/#{Utils.__listify(_id)}" + "_scripts/#{Utils.listify(_id)}" end params = Utils.process_params(arguments) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/delete_rule.rb b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/delete_rule.rb index a7f69d8916..39919c5ad8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/delete_rule.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/delete_rule.rb @@ -15,25 +15,38 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module QueryRules module Actions - # Deletes an individual query rule within a ruleset. + # Delete a query rule. + # Delete a query rule within a query ruleset. + # This is a destructive action that is only recoverable by re-adding the same rule with the create or update query rule API. # - # @option arguments [String] :ruleset_id The unique identifier of the query ruleset this rule exists in - # @option arguments [String] :rule_id The unique identifier of the rule to delete. + # @option arguments [String] :ruleset_id The unique identifier of the query ruleset containing the rule to delete (*Required*) + # @option arguments [String] :rule_id The unique identifier of the query rule within the specified ruleset to delete (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-query-rule.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-query-rules-delete-rule # def delete_rule(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'query_rules.delete_rule' } - defined_params = %i[ruleset_id rule_id].each_with_object({}) do |variable, set_variables| + defined_params = [:ruleset_id, :rule_id].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -51,8 +64,8 @@ def delete_rule(arguments = {}) _rule_id = arguments.delete(:rule_id) method = Elasticsearch::API::HTTP_DELETE - path = "_query_rules/#{Utils.__listify(_ruleset_id)}/_rule/#{Utils.__listify(_rule_id)}" - params = {} + path = "_query_rules/#{Utils.listify(_ruleset_id)}/_rule/#{Utils.listify(_rule_id)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/delete_ruleset.rb b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/delete_ruleset.rb index f6739b40b6..be9dde5941 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/delete_ruleset.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/delete_ruleset.rb @@ -15,19 +15,32 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module QueryRules module Actions - # Deletes a query ruleset. + # Delete a query ruleset. + # Remove a query ruleset and its associated data. + # This is a destructive action that is not recoverable. # - # @option arguments [String] :ruleset_id The unique identifier of the query ruleset to delete + # @option arguments [String] :ruleset_id The unique identifier of the query ruleset to delete (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-query-ruleset.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-query-rules-delete-ruleset # def delete_ruleset(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'query_rules.delete_ruleset' } @@ -47,11 +60,11 @@ def delete_ruleset(arguments = {}) _ruleset_id = arguments.delete(:ruleset_id) method = Elasticsearch::API::HTTP_DELETE - path = "_query_rules/#{Utils.__listify(_ruleset_id)}" + path = "_query_rules/#{Utils.listify(_ruleset_id)}" params = Utils.process_params(arguments) if Array(arguments[:ignore]).include?(404) - Utils.__rescue_from_not_found do + Utils.rescue_from_not_found do Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/get_rule.rb b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/get_rule.rb index 579d2a9627..2e97e5effc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/get_rule.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/get_rule.rb @@ -15,25 +15,37 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module QueryRules module Actions - # Returns the details about an individual query rule within a ruleset. + # Get a query rule. + # Get details about a query rule within a query ruleset. # - # @option arguments [String] :ruleset_id The unique identifier of the query ruleset the rule exists within - # @option arguments [String] :rule_id The unique identifier of the rule to be retrieved. + # @option arguments [String] :ruleset_id The unique identifier of the query ruleset containing the rule to retrieve (*Required*) + # @option arguments [String] :rule_id The unique identifier of the query rule within the specified ruleset to retrieve (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-query-rule.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-query-rules-get-rule # def get_rule(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'query_rules.get_rule' } - defined_params = %i[ruleset_id rule_id].each_with_object({}) do |variable, set_variables| + defined_params = [:ruleset_id, :rule_id].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -51,8 +63,8 @@ def get_rule(arguments = {}) _rule_id = arguments.delete(:rule_id) method = Elasticsearch::API::HTTP_GET - path = "_query_rules/#{Utils.__listify(_ruleset_id)}/_rule/#{Utils.__listify(_rule_id)}" - params = {} + path = "_query_rules/#{Utils.listify(_ruleset_id)}/_rule/#{Utils.listify(_rule_id)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/get_ruleset.rb b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/get_ruleset.rb index 3eb2931d90..3bba6796b0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/get_ruleset.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/get_ruleset.rb @@ -15,19 +15,31 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module QueryRules module Actions - # Returns the details about a query ruleset. + # Get a query ruleset. + # Get details about a query ruleset. # - # @option arguments [String] :ruleset_id The unique identifier of the query ruleset + # @option arguments [String] :ruleset_id The unique identifier of the query ruleset (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-query-ruleset.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-query-rules-get-ruleset # def get_ruleset(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'query_rules.get_ruleset' } @@ -47,8 +59,8 @@ def get_ruleset(arguments = {}) _ruleset_id = arguments.delete(:ruleset_id) method = Elasticsearch::API::HTTP_GET - path = "_query_rules/#{Utils.__listify(_ruleset_id)}" - params = {} + path = "_query_rules/#{Utils.listify(_ruleset_id)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/list_rulesets.rb b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/list_rulesets.rb index 46cb469e2a..a010b79a84 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/list_rulesets.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/list_rulesets.rb @@ -15,20 +15,32 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module QueryRules module Actions - # Lists query rulesets. + # Get all query rulesets. + # Get summarized information about the query rulesets. # - # @option arguments [Integer] :from Starting offset (default: 0) - # @option arguments [Integer] :size specifies a max number of results to get (default: 100) + # @option arguments [Integer] :from The offset from the first result to fetch. Server default: 0. + # @option arguments [Integer] :size The maximum number of results to retrieve. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/list-query-rulesets.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-query-rules-list-rulesets # def list_rulesets(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'query_rules.list_rulesets' } @@ -36,7 +48,7 @@ def list_rulesets(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_query_rules' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/put_rule.rb b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/put_rule.rb index 659f785d6c..442adbd27e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/put_rule.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/put_rule.rb @@ -15,26 +15,42 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module QueryRules module Actions - # Creates or updates a query rule within a ruleset. + # Create or update a query rule. + # Create or update a query rule within a query ruleset. + # IMPORTANT: Due to limitations within pinned queries, you can only pin documents using ids or docs, but cannot use both in single rule. + # It is advised to use one or the other in query rulesets, to avoid errors. + # Additionally, pinned queries have a maximum limit of 100 pinned hits. + # If multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset. # - # @option arguments [String] :ruleset_id The unique identifier of the ruleset this rule should be added to. The ruleset will be created if it does not exist. - # @option arguments [String] :rule_id The unique identifier of the rule to be created or updated. + # @option arguments [String] :ruleset_id The unique identifier of the query ruleset containing the rule to be created or updated. (*Required*) + # @option arguments [String] :rule_id The unique identifier of the query rule within the specified ruleset to be created or updated. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The query rule configuration, including the type of rule, the criteria to match the rule, and the action that should be taken if the rule matches. (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-query-rule.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-query-rules-put-rule # def put_rule(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'query_rules.put_rule' } - defined_params = %i[ruleset_id rule_id].each_with_object({}) do |variable, set_variables| + defined_params = [:ruleset_id, :rule_id].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -53,8 +69,8 @@ def put_rule(arguments = {}) _rule_id = arguments.delete(:rule_id) method = Elasticsearch::API::HTTP_PUT - path = "_query_rules/#{Utils.__listify(_ruleset_id)}/_rule/#{Utils.__listify(_rule_id)}" - params = {} + path = "_query_rules/#{Utils.listify(_ruleset_id)}/_rule/#{Utils.listify(_rule_id)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/put_ruleset.rb b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/put_ruleset.rb index ed042f3960..b2da9bd10d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/put_ruleset.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/put_ruleset.rb @@ -15,20 +15,37 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module QueryRules module Actions - # Creates or updates a query ruleset. + # Create or update a query ruleset. + # There is a limit of 100 rules per ruleset. + # This limit can be increased by using the `xpack.applications.rules.max_rules_per_ruleset` cluster setting. + # IMPORTANT: Due to limitations within pinned queries, you can only select documents using `ids` or `docs`, but cannot use both in single rule. + # It is advised to use one or the other in query rulesets, to avoid errors. + # Additionally, pinned queries have a maximum limit of 100 pinned hits. + # If multiple matching rules pin more than 100 documents, only the first 100 documents are pinned in the order they are specified in the ruleset. # - # @option arguments [String] :ruleset_id The unique identifier of the ruleset to be created or updated. + # @option arguments [String] :ruleset_id The unique identifier of the query ruleset to be created or updated. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The query ruleset configuration, including `rules` (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-query-ruleset.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-query-rules-put-ruleset # def put_ruleset(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'query_rules.put_ruleset' } @@ -49,8 +66,8 @@ def put_ruleset(arguments = {}) _ruleset_id = arguments.delete(:ruleset_id) method = Elasticsearch::API::HTTP_PUT - path = "_query_rules/#{Utils.__listify(_ruleset_id)}" - params = {} + path = "_query_rules/#{Utils.listify(_ruleset_id)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/test.rb b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/test.rb index 0215f0656a..4c3dd7bcae 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/test.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/query_rules/test.rb @@ -15,24 +15,32 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module QueryRules module Actions - # Tests a query ruleset to identify the rules that would match input criteria - # 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. + # Test a query ruleset. + # Evaluate match criteria against a query ruleset to identify the rules that would match that criteria. # - # @option arguments [String] :ruleset_id The unique identifier of the ruleset to test. + # @option arguments [String] :ruleset_id The unique identifier of the query ruleset to be created or updated (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The match criteria to test against the ruleset (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/test-query-ruleset.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-query-rules-test # def test(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'query_rules.test' } @@ -53,8 +61,8 @@ def test(arguments = {}) _ruleset_id = arguments.delete(:ruleset_id) method = Elasticsearch::API::HTTP_POST - path = "_query_rules/#{Utils.__listify(_ruleset_id)}/_test" - params = {} + path = "_query_rules/#{Utils.listify(_ruleset_id)}/_test" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/rank_eval.rb b/elasticsearch-api/lib/elasticsearch/api/actions/rank_eval.rb index f9477705e7..b5c350f027 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/rank_eval.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/rank_eval.rb @@ -15,23 +15,37 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Allows to evaluate the quality of ranked search results over a set of typical search queries + # Evaluate ranked search results. + # Evaluate the quality of ranked search results over a set of typical search queries. # - # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices - # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) - # @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) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) - # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch) + # @option arguments [String, Array] :index A 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 [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`. Server default: true. + # @option arguments [String, Array] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. + # @option arguments [Boolean] :ignore_unavailable If `true`, missing or closed indices are not included in the response. + # @option arguments [String] :search_type Search operation type + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The ranking evaluation search definition, including search requests, document ratings and ranking metric definition. (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-rank-eval.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-rank-eval # def rank_eval(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'rank_eval' } @@ -46,13 +60,13 @@ def rank_eval(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_POST path = if _index - "#{Utils.__listify(_index)}/_rank_eval" + "#{Utils.listify(_index)}/_rank_eval" else '_rank_eval' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb b/elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb index 1447568931..4c0e24bd60 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/reindex.rb @@ -15,28 +15,84 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # 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. + # Reindex documents. + # Copy documents from a source to a destination. + # You can copy all documents to the destination index or reindex a subset of the documents. + # The source can be any existing index, alias, or data stream. + # The destination must differ from the source. + # For example, you cannot reindex a data stream into itself. + # IMPORTANT: Reindex requires `_source` to be enabled for all documents in the source. + # The destination should be configured as wanted before calling the reindex API. + # Reindex does not copy the settings from the source or its associated template. + # Mappings, shard counts, and replicas, for example, must be configured ahead of time. + # If the Elasticsearch security features are enabled, you must have the following security privileges: + # * The `read` index privilege for the source data stream, index, or alias. + # * The `write` index privilege for the destination data stream, index, or index alias. + # * To automatically create a data stream or index with a reindex API request, you must have the `auto_configure`, `create_index`, or `manage` index privilege for the destination data stream, index, or alias. + # * If reindexing from a remote cluster, the `source.remote.user` must have the `monitor` cluster privilege and the `read` index privilege for the source data stream, index, or alias. + # If reindexing from a remote cluster, you must explicitly allow the remote host in the `reindex.remote.whitelist` setting. + # Automatic data stream creation requires a matching index template with data stream enabled. + # The `dest` element can be configured like the index API to control optimistic concurrency control. + # Omitting `version_type` or setting it to `internal` causes Elasticsearch to blindly dump documents into the destination, overwriting any that happen to have the same ID. + # Setting `version_type` to `external` causes Elasticsearch to preserve the `version` from the source, create any documents that are missing, and update any documents that have an older version in the destination than they do in the source. + # Setting `op_type` to `create` causes the reindex API to create only missing documents in the destination. + # All existing documents will cause a version conflict. + # IMPORTANT: Because data streams are append-only, any reindex request to a destination data stream must have an `op_type` of `create`. + # A reindex can only add new documents to a destination data stream. + # It cannot update existing documents in a destination data stream. + # By default, version conflicts abort the reindex process. + # To continue reindexing if there are conflicts, set the `conflicts` request body property to `proceed`. + # In this case, the response includes a count of the version conflicts that were encountered. + # Note that the handling of other error types is unaffected by the `conflicts` property. + # Additionally, if you opt to count version conflicts, the operation could attempt to reindex more documents from the source than `max_docs` until it has successfully indexed `max_docs` documents into the target or it has gone through every document in the source query. + # It's recommended to reindex on indices with a green status. Reindexing can fail when a node shuts down or crashes. + # * When requested with `wait_for_completion=true` (default), the request fails if the node shuts down. + # * When requested with `wait_for_completion=false`, a task id is returned, for use with the task management APIs. The task may disappear or fail if the node shuts down. + # When retrying a failed reindex operation, it might be necessary to set `conflicts=proceed` or to first delete the partial destination index. + # Additionally, dry runs, checking disk space, and fetching index recovery information can help address the root cause. + # Refer to the linked documentation for examples of how to reindex documents. # - # @option arguments [Boolean] :refresh Should the affected indexes be refreshed? - # @option arguments [Time] :timeout Time each individual bulk request should wait for shards that are unavailable. - # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the reindex operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) - # @option arguments [Boolean] :wait_for_completion Should the request should block until the reindex is complete. - # @option arguments [Number] :requests_per_second The throttle to set on this request in sub-requests per second. -1 means no throttle. - # @option arguments [Time] :scroll Control how long to keep the search context alive - # @option arguments [Number|string] :slices The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`. - # @option arguments [Number] :max_docs Maximum number of documents to process (default: all documents) + # @option arguments [Boolean] :refresh If `true`, the request refreshes affected shards to make this operation visible to search. + # @option arguments [Float] :requests_per_second The throttle for this request in sub-requests per second. + # By default, there is no throttle. Server default: -1. + # @option arguments [Time] :scroll The period of time that a consistent view of the index should be maintained for scrolled search. + # @option arguments [Integer, String] :slices The number of slices this task should be divided into. + # It defaults to one slice, which means the task isn't sliced into subtasks.Reindex supports sliced scroll to parallelize the reindexing process. + # This parallelization can improve efficiency and provide a convenient way to break the request down into smaller parts.NOTE: Reindexing from remote clusters does not support manual or automatic slicing.If set to `auto`, Elasticsearch chooses the number of slices to use. + # This setting will use one slice per shard, up to a certain limit. + # If there are multiple sources, it will choose the number of slices based on the index or backing index with the smallest number of shards. Server default: 1. + # @option arguments [Integer] :max_docs The maximum number of documents to reindex. + # By default, all documents are reindexed. + # If it is a value less then or equal to `scroll_size`, a scroll will not be used to retrieve the results for the operation.If `conflicts` is set to `proceed`, the reindex operation could attempt to reindex more documents from the source than `max_docs` until it has successfully indexed `max_docs` documents into the target or it has gone through every document in the source query. + # @option arguments [Time] :timeout The period each indexing waits for automatic index creation, dynamic mapping updates, and waiting for active shards. + # By default, Elasticsearch waits for at least one minute before failing. + # The actual wait time could be longer, particularly when multiple waits occur. Server default: 1m. + # @option arguments [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operation. + # Set it to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + # The default value is one, which means it waits for each primary shard to be active. Server default: 1. + # @option arguments [Boolean] :wait_for_completion If `true`, the request blocks until the operation is complete. Server default: true. + # @option arguments [Boolean] :require_alias If `true`, the destination must be an index alias. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The search definition using the Query DSL and the prototype for the index request. (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-reindex # def reindex(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'reindex' } @@ -46,7 +102,7 @@ def reindex(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_reindex' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/reindex_rethrottle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/reindex_rethrottle.rb index e528d3b6ed..8939e9c03c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/reindex_rethrottle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/reindex_rethrottle.rb @@ -15,19 +15,41 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Changes the number of requests per second for a particular Reindex operation. + # Throttle a reindex operation. + # Change the number of requests per second for a particular reindex operation. + # For example: + # + # ``` + # POST _reindex/r1A2WoRbTwKZ516z6NEs5A:36619/_rethrottle?requests_per_second=-1 + # ``` + # + # Rethrottling that speeds up the query takes effect immediately. + # Rethrottling that slows down the query will take effect after completing the current batch. + # This behavior prevents scroll timeouts. # - # @option arguments [String] :task_id The task id to rethrottle - # @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. (*Required*) + # @option arguments [String] :task_id The task identifier, which can be found by using the tasks API. (*Required*) + # @option arguments [Float] :requests_per_second The throttle for this request in sub-requests per second. + # It can be either `-1` to turn off throttling or any decimal number like `1.7` or `12` to throttle to that level. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-reindex # def reindex_rethrottle(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'reindex_rethrottle' } @@ -47,7 +69,7 @@ def reindex_rethrottle(arguments = {}) _task_id = arguments.delete(:task_id) method = Elasticsearch::API::HTTP_POST - path = "_reindex/#{Utils.__listify(_task_id)}/_rethrottle" + path = "_reindex/#{Utils.listify(_task_id)}/_rethrottle" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/render_search_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/render_search_template.rb index 90de6aaea6..bcb00a4c01 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/render_search_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/render_search_template.rb @@ -15,19 +15,32 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Allows to use the Mustache language to pre-render a search definition. + # Render a search template. + # Render a search template as a search request body. # - # @option arguments [String] :id The id of the stored search template + # @option arguments [String] :id The ID of the search template to render. + # If no `source` is specified, this or the `id` request body parameter is required. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The search definition template and its params + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/render-search-template-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-render-search-template # def render_search_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'render_search_template' } @@ -50,12 +63,12 @@ def render_search_template(arguments = {}) Elasticsearch::API::HTTP_GET end - path = if _id - "_render/template/#{Utils.__listify(_id)}" - else - '_render/template' - end - params = {} + path = if _id + "_render/template/#{Utils.listify(_id)}" + else + '_render/template' + end + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/delete_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/delete_job.rb deleted file mode 100644 index fe87cfa556..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/delete_job.rb +++ /dev/null @@ -1,64 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. -# -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# -module Elasticsearch - module API - module Rollup - module Actions - # Deletes an existing rollup job. - # 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] :id The ID of the job to delete - # @option arguments [Hash] :headers Custom HTTP headers - # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-delete-job.html - # - def delete_job(arguments = {}) - request_opts = { endpoint: arguments[:endpoint] || 'rollup.delete_job' } - - defined_params = [:id].each_with_object({}) do |variable, set_variables| - set_variables[variable] = arguments[variable] if arguments.key?(variable) - end - request_opts[:defined_params] = defined_params unless defined_params.empty? - - raise ArgumentError, "Required argument 'id' missing" unless arguments[:id] - - arguments = arguments.clone - headers = arguments.delete(:headers) || {} - - body = nil - - _id = arguments.delete(:id) - - method = Elasticsearch::API::HTTP_DELETE - path = "_rollup/job/#{Utils.__listify(_id)}" - params = {} - - Elasticsearch::API::Response.new( - perform_request(method, path, params, body, headers, request_opts) - ) - end - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/get_jobs.rb b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/get_jobs.rb deleted file mode 100644 index 4344386526..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/get_jobs.rb +++ /dev/null @@ -1,66 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. -# -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# -module Elasticsearch - module API - module Rollup - module Actions - # Retrieves the configuration, stats, and status of rollup jobs. - # 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] :id The ID of the job(s) to fetch. Accepts glob patterns, or left blank for all jobs - # @option arguments [Hash] :headers Custom HTTP headers - # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-get-job.html - # - def get_jobs(arguments = {}) - request_opts = { endpoint: arguments[:endpoint] || 'rollup.get_jobs' } - - defined_params = [:id].each_with_object({}) do |variable, set_variables| - set_variables[variable] = arguments[variable] if arguments.key?(variable) - end - request_opts[:defined_params] = defined_params unless defined_params.empty? - - arguments = arguments.clone - headers = arguments.delete(:headers) || {} - - body = nil - - _id = arguments.delete(:id) - - method = Elasticsearch::API::HTTP_GET - path = if _id - "_rollup/job/#{Utils.__listify(_id)}" - else - '_rollup/job' - end - params = {} - - Elasticsearch::API::Response.new( - perform_request(method, path, params, body, headers, request_opts) - ) - end - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/get_rollup_caps.rb b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/get_rollup_caps.rb deleted file mode 100644 index 93ac86cec1..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/get_rollup_caps.rb +++ /dev/null @@ -1,66 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. -# -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# -module Elasticsearch - module API - module Rollup - module Actions - # Returns the capabilities of any rollup jobs that have been configured for a specific index or index pattern. - # 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] :id The ID of the index to check rollup capabilities on, or left blank for all jobs - # @option arguments [Hash] :headers Custom HTTP headers - # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-get-rollup-caps.html - # - def get_rollup_caps(arguments = {}) - request_opts = { endpoint: arguments[:endpoint] || 'rollup.get_rollup_caps' } - - defined_params = [:id].each_with_object({}) do |variable, set_variables| - set_variables[variable] = arguments[variable] if arguments.key?(variable) - end - request_opts[:defined_params] = defined_params unless defined_params.empty? - - arguments = arguments.clone - headers = arguments.delete(:headers) || {} - - body = nil - - _id = arguments.delete(:id) - - method = Elasticsearch::API::HTTP_GET - path = if _id - "_rollup/data/#{Utils.__listify(_id)}" - else - '_rollup/data' - end - params = {} - - Elasticsearch::API::Response.new( - perform_request(method, path, params, body, headers, request_opts) - ) - end - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/put_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/put_job.rb deleted file mode 100644 index 1286e65c2b..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/put_job.rb +++ /dev/null @@ -1,66 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. -# -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# -module Elasticsearch - module API - module Rollup - module Actions - # Creates a rollup job. - # 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] :id The ID of the job to create - # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The job configuration (*Required*) - # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-put-job.html - # - def put_job(arguments = {}) - request_opts = { endpoint: arguments[:endpoint] || 'rollup.put_job' } - - defined_params = [:id].each_with_object({}) do |variable, set_variables| - set_variables[variable] = arguments[variable] if arguments.key?(variable) - end - request_opts[:defined_params] = defined_params unless defined_params.empty? - - raise ArgumentError, "Required argument 'body' missing" unless arguments[:body] - raise ArgumentError, "Required argument 'id' missing" unless arguments[:id] - - arguments = arguments.clone - headers = arguments.delete(:headers) || {} - - body = arguments.delete(:body) - - _id = arguments.delete(:id) - - method = Elasticsearch::API::HTTP_PUT - path = "_rollup/job/#{Utils.__listify(_id)}" - params = {} - - Elasticsearch::API::Response.new( - perform_request(method, path, params, body, headers, request_opts) - ) - end - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/start_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/start_job.rb deleted file mode 100644 index d1108d1ba3..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/start_job.rb +++ /dev/null @@ -1,64 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. -# -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# -module Elasticsearch - module API - module Rollup - module Actions - # Starts an existing, stopped rollup job. - # 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] :id The ID of the job to start - # @option arguments [Hash] :headers Custom HTTP headers - # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-start-job.html - # - def start_job(arguments = {}) - request_opts = { endpoint: arguments[:endpoint] || 'rollup.start_job' } - - defined_params = [:id].each_with_object({}) do |variable, set_variables| - set_variables[variable] = arguments[variable] if arguments.key?(variable) - end - request_opts[:defined_params] = defined_params unless defined_params.empty? - - raise ArgumentError, "Required argument 'id' missing" unless arguments[:id] - - arguments = arguments.clone - headers = arguments.delete(:headers) || {} - - body = nil - - _id = arguments.delete(:id) - - method = Elasticsearch::API::HTTP_POST - path = "_rollup/job/#{Utils.__listify(_id)}/_start" - params = {} - - Elasticsearch::API::Response.new( - perform_request(method, path, params, body, headers, request_opts) - ) - end - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/stop_job.rb b/elasticsearch-api/lib/elasticsearch/api/actions/rollup/stop_job.rb deleted file mode 100644 index f33070a4db..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/actions/rollup/stop_job.rb +++ /dev/null @@ -1,66 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. -# -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# -module Elasticsearch - module API - module Rollup - module Actions - # Stops an existing, started rollup job. - # 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] :id The ID of the job to stop - # @option arguments [Boolean] :wait_for_completion True if the API should block until the job has fully stopped, false if should be executed async. Defaults to false. - # @option arguments [Time] :timeout Block for (at maximum) the specified duration while waiting for the job to stop. Defaults to 30s. - # @option arguments [Hash] :headers Custom HTTP headers - # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/rollup-stop-job.html - # - def stop_job(arguments = {}) - request_opts = { endpoint: arguments[:endpoint] || 'rollup.stop_job' } - - defined_params = [:id].each_with_object({}) do |variable, set_variables| - set_variables[variable] = arguments[variable] if arguments.key?(variable) - end - request_opts[:defined_params] = defined_params unless defined_params.empty? - - raise ArgumentError, "Required argument 'id' missing" unless arguments[:id] - - arguments = arguments.clone - headers = arguments.delete(:headers) || {} - - body = nil - - _id = arguments.delete(:id) - - method = Elasticsearch::API::HTTP_POST - path = "_rollup/job/#{Utils.__listify(_id)}/_stop" - params = Utils.process_params(arguments) - - Elasticsearch::API::Response.new( - perform_request(method, path, params, body, headers, request_opts) - ) - end - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/scripts_painless_execute.rb b/elasticsearch-api/lib/elasticsearch/api/actions/scripts_painless_execute.rb index e9cc67da66..03eea42c38 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/scripts_painless_execute.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/scripts_painless_execute.rb @@ -15,22 +15,38 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Allows an arbitrary script to be executed and a result to be returned + # Run a script. + # Runs a script and returns a result. + # Use this API to build and test scripts, such as when defining a script for a runtime field. + # This API requires very few dependencies and is especially useful if you don't have permissions to write documents on a cluster. + # The API uses several _contexts_, which control how scripts are run, what variables are available at runtime, and what the return type is. + # Each context requires a script, but additional parameters depend on the context you're using for that script. # 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 [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The script to execute + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/painless/current/painless-execute-api.html + # @see https://www.elastic.co/docs/reference/scripting-languages/painless/painless-api-examples # def scripts_painless_execute(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'scripts_painless_execute' } @@ -38,7 +54,7 @@ def scripts_painless_execute(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = if body Elasticsearch::API::HTTP_POST @@ -46,8 +62,8 @@ def scripts_painless_execute(arguments = {}) Elasticsearch::API::HTTP_GET end - path = '_scripts/painless/_execute' - params = {} + path = '_scripts/painless/_execute' + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/scroll.rb b/elasticsearch-api/lib/elasticsearch/api/actions/scroll.rb index 2885c09a83..02607f5673 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/scroll.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/scroll.rb @@ -15,35 +15,50 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Allows to retrieve a large numbers of results from a single search request. + # Run a scrolling search. + # IMPORTANT: The scroll API is no longer recommend for deep pagination. If you need to preserve the index state while paging through more than 10,000 hits, use the `search_after` parameter with a point in time (PIT). + # The scroll API gets large sets of results from a single scrolling search request. + # To get the necessary scroll ID, submit a search API request that includes an argument for the `scroll` query parameter. + # The `scroll` parameter indicates how long Elasticsearch should retain the search context for the request. + # The search response returns a scroll ID in the `_scroll_id` response body parameter. + # You can then use the scroll ID with the scroll API to retrieve the next batch of results for the request. + # If the Elasticsearch security features are enabled, the access to the results of a specific scroll ID is restricted to the user or API key that submitted the search. + # You can also use the scroll API to specify a new scroll parameter that extends or shortens the retention period for the search context. + # IMPORTANT: Results from a scrolling search reflect the state of the index at the time of the initial search request. Subsequent indexing or document changes only affect later search and scroll requests. # - # @option arguments [String] :scroll_id The scroll ID *Deprecated* - # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search - # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response + # @option arguments [String] :scroll_id The scroll ID + # @option arguments [Time] :scroll The period to retain the search context for scrolling. Server default: 1d. + # @option arguments [Boolean] :rest_total_hits_as_int If true, the API response’s hit.total property is returned as an integer. If false, the API response’s hit.total property is returned as an object. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The scroll ID if not passed by URL or query parameter. + # @option arguments [Hash] :body request body # # *Deprecation notice*: # A scroll id can be quite large and should be specified as part of the body # Deprecated since version 7.0.0 # # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-body.html#request-body-search-scroll + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-scroll # def scroll(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'scroll' } - defined_params = [:scroll_id].each_with_object({}) do |variable, set_variables| - set_variables[variable] = arguments[variable] if arguments.key?(variable) - end - request_opts[:defined_params] = defined_params unless defined_params.empty? - arguments = arguments.clone headers = arguments.delete(:headers) || {} @@ -57,11 +72,7 @@ def scroll(arguments = {}) Elasticsearch::API::HTTP_GET end - path = if _scroll_id - "_search/scroll/#{Utils.__listify(_scroll_id)}" - else - '_search/scroll' - end + path = '_search/scroll' params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search.rb index b62d05935d..db10f0e4cf 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search.rb @@ -15,63 +15,153 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Returns results matching a query. + # Run a search. + # Get search hits that match the query defined in the request. + # You can provide search queries using the `q` query string parameter or the request body. + # If both are specified, only the query parameter is used. + # If the Elasticsearch security features are enabled, you must have the read index privilege for the target data stream, index, or alias. For cross-cluster search, refer to the documentation about configuring CCS privileges. + # To search a point in time (PIT) for an alias, you must have the `read` index privilege for the alias's data streams or indices. + # **Search slicing** + # When paging through a large number of documents, it can be helpful to split the search into multiple slices to consume them independently with the `slice` and `pit` properties. + # By default the splitting is done first on the shards, then locally on each shard. + # The local splitting partitions the shard into contiguous ranges based on Lucene document IDs. + # For instance if the number of shards is equal to 2 and you request 4 slices, the slices 0 and 2 are assigned to the first shard and the slices 1 and 3 are assigned to the second shard. + # IMPORTANT: The same point-in-time ID should be used for all slices. + # If different PIT IDs are used, slices can overlap and miss documents. + # This situation can occur because the splitting criterion is based on Lucene document IDs, which are not stable across changes to the index. # - # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices - # @option arguments [String] :analyzer The analyzer to use for the query string - # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false) - # @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution - # @option arguments [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR) - # @option arguments [String] :df The field to use as default where no field prefix is given in the query string - # @option arguments [Boolean] :explain Specify whether to return detailed information about score computation as part of a hit - # @option arguments [List] :stored_fields A comma-separated list of stored fields to return as part of a hit - # @option arguments [List] :docvalue_fields A comma-separated list of fields to return as the docvalue representation of a field for each hit - # @option arguments [Number] :from Starting offset (default: 0) - # @option arguments [Boolean] :force_synthetic_source Should this request force synthetic _source? Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. Fetches with this enabled will be slower the enabling synthetic source natively in the index. - # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) - # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled - # @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) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) - # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored - # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) - # @option arguments [String] :q Query in the Lucene query string syntax - # @option arguments [List] :routing A comma-separated list of specific routing values - # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search - # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch) - # @option arguments [Number] :size Number of hits to return (default: 10) - # @option arguments [List] :sort A comma-separated list of : pairs - # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return - # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field - # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field - # @option arguments [Number] :terminate_after The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early. - # @option arguments [List] :stats Specific 'tag' of the request for logging and statistical purposes - # @option arguments [String] :suggest_field Specify which field to use for suggestions - # @option arguments [String] :suggest_mode Specify suggest mode (options: missing, popular, always) - # @option arguments [Number] :suggest_size How many suggestions to return in response - # @option arguments [String] :suggest_text The source text for which the suggestions should be returned - # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Boolean] :track_scores Whether to calculate and return scores even if they are not used for sorting - # @option arguments [Boolean|long] :track_total_hits Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number. - # @option arguments [Boolean] :allow_partial_search_results Indicate if an error should be returned if there is a partial search failure or timeout - # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response - # @option arguments [Boolean] :version Specify whether to return document version as part of a hit - # @option arguments [Boolean] :seq_no_primary_term Specify whether to return sequence number and primary term of the last modification of each hit - # @option arguments [Boolean] :request_cache Specify if request cache should be used for this request or not, defaults to index level setting - # @option arguments [Number] :batched_reduce_size The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large. - # @option arguments [Number] :max_concurrent_shard_requests The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests - # @option arguments [Number] :pre_filter_shard_size A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint. - # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response - # @option arguments [Boolean] :include_named_queries_score Indicates whether hit.matched_queries should be rendered as a map that includes the name of the matched query associated with its score (true) or as an array containing the name of the matched queries (false) + # @option arguments [String, Array] :index A comma-separated list of data streams, indices, and aliases to search. + # It supports wildcards (`*`). + # To search all data streams and indices, omit this parameter or use `*` or `_all`. + # @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`. Server default: true. + # @option arguments [Boolean] :allow_partial_search_results If `true` and there are shard request timeouts or shard failures, the request returns partial results. + # If `false`, it returns an error with no partial results.To override the default behavior, you can set the `search.default_allow_partial_results` cluster setting to `false`. Server default: true. + # @option arguments [String] :analyzer The analyzer to use for the query string. + # This parameter can be used only when the `q` query string parameter is specified. + # @option arguments [Boolean] :analyze_wildcard If `true`, wildcard and prefix queries are analyzed. + # This parameter can be used only when the `q` query string parameter is specified. + # @option arguments [Integer] :batched_reduce_size The number of shard results that should be reduced at once on the coordinating node. + # If the potential number of shards in the request can be large, this value should be used as a protection mechanism to reduce the memory overhead per search request. Server default: 512. + # @option arguments [Boolean] :ccs_minimize_roundtrips If `true`, network round-trips between the coordinating node and the remote clusters are minimized when running cross-cluster search (CCS) requests. Server default: true. + # @option arguments [String] :default_operator The default operator for the query string query: `AND` or `OR`. + # This parameter can be used only when the `q` query string parameter is specified. Server default: OR. + # @option arguments [String] :df The field to use as a default when no field prefix is given in the query string. + # This parameter can be used only when the `q` query string parameter is specified. + # @option arguments [String, Array] :docvalue_fields A comma-separated list of fields to return as the docvalue representation of a field for each hit. + # @option arguments [String, Array] :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`. Server default: open. + # @option arguments [Boolean] :explain If `true`, the request returns detailed information about score computation as part of a hit. + # @option arguments [Boolean] :ignore_throttled If `true`, concrete, expanded or aliased indices will be ignored when frozen. Server default: true. + # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. + # @option arguments [Boolean] :include_named_queries_score If `true`, the response includes the score contribution from any named queries.This functionality reruns each named query on every hit in a search response. + # Typically, this adds a small overhead to a request. + # However, using computationally expensive named queries on a large number of hits may add significant overhead. + # @option arguments [Boolean] :lenient If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + # This parameter can be used only when the `q` query string parameter is specified. + # @option arguments [Integer] :max_concurrent_shard_requests The number of concurrent shard requests per node that the search runs concurrently. + # This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests. Server default: 5. + # @option arguments [String] :preference The nodes and shards used for the search. + # By default, Elasticsearch selects from eligible nodes and shards using adaptive replica selection, accounting for allocation awareness. + # Valid values are: + # - `_only_local` to run the search only on shards on the local node. + # - `_local` to, if possible, run the search on shards on the local node, or if not, select shards using the default method. + # - `_only_nodes:,` to run the search on only the specified nodes IDs. If suitable shards exist on more than one selected node, use shards on those nodes using the default method. If none of the specified nodes are available, select shards from any available node using the default method. + # - `_prefer_nodes:,` to if possible, run the search on the specified nodes IDs. If not, select shards using the default method. + # - `_shards:,` to run the search only on the specified shards. You can combine this value with other `preference` values. However, the `_shards` value must come first. For example: `_shards:2,3|_local`. + # - `` (any string that does not start with `_`) to route searches with the same `` to the same shards in the same order. + # @option arguments [Integer] :pre_filter_shard_size A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. + # This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method (if date filters are mandatory to match but the shard bounds and the query are disjoint). + # When unspecified, the pre-filter phase is executed if any of these conditions is met: + # - The request targets more than 128 shards. + # - The request targets one or more read-only index. + # - The primary sort of the query targets an indexed field. + # @option arguments [Boolean] :request_cache If `true`, the caching of search results is enabled for requests where `size` is `0`. + # It defaults to index level settings. + # @option arguments [String] :routing A custom value that is used to route operations to a specific shard. + # @option arguments [Time] :scroll The period to retain the search context for scrolling. + # By default, this value cannot exceed `1d` (24 hours). + # You can change this limit by using the `search.max_keep_alive` cluster-level setting. + # @option arguments [String] :search_type Indicates how distributed term frequencies are calculated for relevance scoring. + # @option arguments [Array] :stats Specific `tag` of the request for logging and statistical purposes. + # @option arguments [String, Array] :stored_fields A comma-separated list of stored fields to return as part of a hit. + # If no fields are specified, no stored fields are included in the response. + # If this field is specified, the `_source` parameter defaults to `false`. + # You can pass `_source: true` to return both source fields and stored fields in the search response. + # @option arguments [String] :suggest_field The field to use for suggestions. + # @option arguments [String] :suggest_mode The suggest mode. + # This parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified. Server default: missing. + # @option arguments [Integer] :suggest_size The number of suggestions to return. + # This parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified. + # @option arguments [String] :suggest_text The source text for which the suggestions should be returned. + # This parameter can be used only when the `suggest_field` and `suggest_text` query string parameters are specified. + # @option arguments [Integer] :terminate_after The maximum number of documents to collect for each shard. + # If a query reaches this limit, Elasticsearch terminates the query early. + # Elasticsearch collects documents before sorting.IMPORTANT: Use with caution. + # Elasticsearch applies this parameter to each shard handling the request. + # When possible, let Elasticsearch perform early termination automatically. + # Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + # If set to `0` (default), the query does not terminate early. Server default: 0. + # @option arguments [Time] :timeout The period of time to wait for a response from each shard. + # If no response is received before the timeout expires, the request fails and returns an error. + # It defaults to no timeout. + # @option arguments [Boolean, Integer] :track_total_hits The number of hits matching the query to count accurately. + # If `true`, the exact number of hits is returned at the cost of some performance. + # If `false`, the response does not include the total number of hits matching the query. Server default: 10000. + # @option arguments [Boolean] :track_scores If `true`, the request calculates and returns document scores, even if the scores are not used for sorting. + # @option arguments [Boolean] :typed_keys If `true`, aggregation and suggester names are be prefixed by their respective types in the response. + # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether `hits.total` should be rendered as an integer or an object in the rest search response. + # @option arguments [Boolean] :version If `true`, the request returns the document version as part of a hit. + # @option arguments [Boolean, String, Array] :_source The source fields that are returned for matching documents. + # These fields are returned in the `hits._source` property of the search response. + # Valid values are: + # - `true` to return the entire document source. + # - `false` to not return the document source. + # - `` to return the source fields that are specified as a comma-separated list that supports wildcard (`*`) patterns. Server default: true. + # @option arguments [String, Array] :_source_excludes A comma-separated list of source fields to exclude from the response. + # You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter. + # If the `_source` parameter is `false`, this parameter is ignored. + # @option arguments [String, Array] :_source_includes A comma-separated list of source fields to include in the response. + # If this parameter is specified, only these source fields are returned. + # You can exclude fields from this subset using the `_source_excludes` query parameter. + # If the `_source` parameter is `false`, this parameter is ignored. + # @option arguments [Boolean] :seq_no_primary_term If `true`, the request returns the sequence number and primary term of the last modification of each hit. + # @option arguments [String] :q A query in the Lucene query string syntax. + # Query parameter searches do not support the full Elasticsearch Query DSL but are handy for testing.IMPORTANT: This parameter overrides the query parameter in the request body. + # If both parameters are specified, documents matching the query request body parameter are not returned. + # @option arguments [Integer] :size The number of hits to return. + # By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. + # To page through more hits, use the `search_after` parameter. Server default: 10. + # @option arguments [Integer] :from The starting document offset, which must be non-negative. + # By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters. + # To page through more hits, use the `search_after` parameter. Server default: 0. + # @option arguments [String, Array] :sort A comma-separated list of `:` pairs. + # @option arguments [Boolean] :force_synthetic_source Should this request force synthetic _source? + # Use this to test if the mapping supports synthetic _source and to get a sense of the worst case performance. + # Fetches with this enabled will be slower the enabling synthetic source natively in the index. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The search definition using the Query DSL + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search # def search(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search' } @@ -94,11 +184,11 @@ def search(arguments = {}) Elasticsearch::API::HTTP_GET end - path = if _index - "#{Utils.__listify(_index)}/_search" - else - '_search' - end + path = if _index + "#{Utils.listify(_index)}/_search" + else + '_search' + end params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/delete.rb index 165e1093dd..518e4d09ba 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/delete.rb @@ -15,23 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module SearchApplication module Actions - # Deletes a search application. - # 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. + # Delete a search application. + # Remove a search application and its associated alias. Indices attached to the search application are not removed. + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # - # @option arguments [String] :name The name of the search application + # @option arguments [String] :name The name of the search application to delete. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-search-application.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-delete # def delete(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_application.delete' } @@ -51,8 +63,8 @@ def delete(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_DELETE - path = "_application/search_application/#{Utils.__listify(_name)}" - params = {} + path = "_application/search_application/#{Utils.listify(_name)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/delete_behavioral_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/delete_behavioral_analytics.rb index 38ab030e26..85776778c4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/delete_behavioral_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/delete_behavioral_analytics.rb @@ -15,23 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module SearchApplication module Actions # Delete a behavioral analytics collection. + # The associated data stream is also deleted. # 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] :name The name of the analytics collection to be deleted + # @option arguments [String] :name The name of the analytics collection to be deleted (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-analytics-collection.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-delete-behavioral-analytics # def delete_behavioral_analytics(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_application.delete_behavioral_analytics' } @@ -51,8 +63,8 @@ def delete_behavioral_analytics(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_DELETE - path = "_application/analytics/#{Utils.__listify(_name)}" - params = {} + path = "_application/analytics/#{Utils.listify(_name)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/get.rb index a860983d7f..392cc9314d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/get.rb @@ -15,23 +15,34 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module SearchApplication module Actions - # Returns the details about a search application. - # 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. + # Get search application details. + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # - # @option arguments [String] :name The name of the search application + # @option arguments [String] :name The name of the search application (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-search-application.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-get # def get(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_application.get' } @@ -51,8 +62,8 @@ def get(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_GET - path = "_application/search_application/#{Utils.__listify(_name)}" - params = {} + path = "_application/search_application/#{Utils.listify(_name)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/get_behavioral_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/get_behavioral_analytics.rb index 03162964b8..9d58fbcf32 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/get_behavioral_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/get_behavioral_analytics.rb @@ -15,23 +15,34 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module SearchApplication module Actions - # Returns the existing behavioral analytics collections. + # Get behavioral analytics collections. # 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 [List] :name A comma-separated list of analytics collections to limit the returned information + # @option arguments [Array] :name A list of analytics collections to limit the returned information + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/list-analytics-collection.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-get-behavioral-analytics # def get_behavioral_analytics(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_application.get_behavioral_analytics' } @@ -50,11 +61,11 @@ def get_behavioral_analytics(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _name - "_application/analytics/#{Utils.__listify(_name)}" + "_application/analytics/#{Utils.listify(_name)}" else '_application/analytics' end - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/list.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/list.rb index e16653f8d0..6ed256b8cb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/list.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/list.rb @@ -15,25 +15,37 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module SearchApplication module Actions - # Returns the existing search applications. - # 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. + # Get search applications. + # Get information about search applications. + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # - # @option arguments [String] :q Query in the Lucene query string syntax - # @option arguments [Integer] :from Starting offset (default: 0) - # @option arguments [Integer] :size specifies a max number of results to get + # @option arguments [String] :q Query in the Lucene query string syntax. + # @option arguments [Integer] :from Starting offset. Server default: 0. + # @option arguments [Integer] :size Specifies a max number of results to get. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/list-search-applications.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-get-behavioral-analytics # def list(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_application.list' } @@ -41,7 +53,7 @@ def list(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_application/search_application' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/post_behavioral_analytics_event.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/post_behavioral_analytics_event.rb index 73ddcf543e..781fdef2fa 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/post_behavioral_analytics_event.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/post_behavioral_analytics_event.rb @@ -15,31 +15,42 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module SearchApplication module Actions - # Creates a behavioral analytics event for existing collection. + # Create a behavioral analytics collection event. # 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] :collection_name The name of behavioral analytics collection - # @option arguments [String] :event_type Behavioral analytics event type. Available: page_view, search, search_click - # @option arguments [Boolean] :debug If true, returns event information that will be stored + # @option arguments [String] :collection_name The name of the behavioral analytics collection. (*Required*) + # @option arguments [String] :event_type The analytics event type. (*Required*) + # @option arguments [Boolean] :debug Whether the response type has to include more details + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The event definition (*Required*) + # @option arguments [Hash] :body payload # - # @see http://todo.com/tbd + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-post-behavioral-analytics-event # def post_behavioral_analytics_event(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_application.post_behavioral_analytics_event' } - defined_params = %i[collection_name event_type].each_with_object({}) do |variable, set_variables| + defined_params = [:collection_name, :event_type].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -58,7 +69,7 @@ def post_behavioral_analytics_event(arguments = {}) _event_type = arguments.delete(:event_type) method = Elasticsearch::API::HTTP_POST - path = "_application/analytics/#{Utils.__listify(_collection_name)}/event/#{Utils.__listify(_event_type)}" + path = "_application/analytics/#{Utils.listify(_collection_name)}/event/#{Utils.listify(_event_type)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/put.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/put.rb index 4b71715586..5697f563af 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/put.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/put.rb @@ -15,25 +15,36 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module SearchApplication module Actions - # Creates or updates a search application. - # 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. + # Create or update a search application. + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # - # @option arguments [String] :name The name of the search application to be created or updated - # @option arguments [Boolean] :create If true, requires that a search application with the specified resource_id does not already exist. (default: false) + # @option arguments [String] :name The name of the search application to be created or updated. (*Required*) + # @option arguments [Boolean] :create If `true`, this request cannot replace or update existing Search Applications. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The search application configuration, including `indices` (*Required*) + # @option arguments [Hash] :body search_application # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-search-application.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-put # def put(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_application.put' } @@ -54,7 +65,7 @@ def put(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_PUT - path = "_application/search_application/#{Utils.__listify(_name)}" + path = "_application/search_application/#{Utils.listify(_name)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/put_behavioral_analytics.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/put_behavioral_analytics.rb index b04054239f..ca3ac25c86 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/put_behavioral_analytics.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/put_behavioral_analytics.rb @@ -15,23 +15,34 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module SearchApplication module Actions - # Creates a behavioral analytics collection. + # Create a behavioral analytics collection. # 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] :name The name of the analytics collection to be created or updated + # @option arguments [String] :name The name of the analytics collection to be created or updated. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-analytics-collection.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-put-behavioral-analytics # def put_behavioral_analytics(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_application.put_behavioral_analytics' } @@ -51,8 +62,8 @@ def put_behavioral_analytics(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_PUT - path = "_application/analytics/#{Utils.__listify(_name)}" - params = {} + path = "_application/analytics/#{Utils.listify(_name)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/render_query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/render_query.rb index b6d21c350a..420a8c7373 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/render_query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/render_query.rb @@ -15,24 +15,39 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module SearchApplication module Actions - # Renders a query for given search application search parameters + # Render a search application query. + # Generate an Elasticsearch query using the specified query parameters and the search template associated with the search application or a default template if none is specified. + # If a parameter used in the search template is not specified in `params`, the parameter's default value will be used. + # The API returns the specific Elasticsearch query that would be generated and run by calling the search application search API. + # You must have `read` privileges on the backing alias of the search application. # 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] :name The name of the search application to render the query for + # @option arguments [String] :name The name of the search application to render teh query for. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body Search parameters, which will override any default search parameters defined in the search application template + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-application-render-query.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-render-query # def render_query(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_application.render_query' } @@ -52,8 +67,8 @@ def render_query(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_POST - path = "_application/search_application/#{Utils.__listify(_name)}/_render_query" - params = {} + path = "_application/search_application/#{Utils.listify(_name)}/_render_query" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/search.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/search.rb index f3a7797355..ecf076d37b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_application/search.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_application/search.rb @@ -15,25 +15,38 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module SearchApplication module Actions - # Perform a search against a search application - # 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. + # Run a search application search. + # Generate and run an Elasticsearch query that uses the specified query parameteter and the search template associated with the search application or default template. + # Unspecified template parameters are assigned their default values if applicable. + # This functionality is in Beta and is subject to change. The design and + # code is less mature than official GA features and is being provided + # as-is with no warranties. Beta features are not subject to the support + # SLA of official GA features. # - # @option arguments [String] :name The name of the search application to be searched - # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response + # @option arguments [String] :name The name of the search application to be searched. (*Required*) + # @option arguments [Boolean] :typed_keys Determines whether aggregation names are prefixed by their respective types in the response. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body Search parameters, including template parameters that override defaults + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-application-search.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-application-search # def search(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_application.search' } @@ -58,7 +71,7 @@ def search(arguments = {}) Elasticsearch::API::HTTP_GET end - path = "_application/search_application/#{Utils.__listify(_name)}/_search" + path = "_application/search_application/#{Utils.listify(_name)}/_search" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_mvt.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_mvt.rb index 80bde3ce4f..f2ebc99452 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_mvt.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_mvt.rb @@ -15,39 +15,139 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Searches a vector tile for geospatial values. Returns results as a binary Mapbox vector tile. - # 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. + # Search a vector tile. + # Search a vector tile for geospatial values. + # Before using this API, you should be familiar with the Mapbox vector tile specification. + # The API returns results as a binary mapbox vector tile. + # Internally, Elasticsearch translates a vector tile search API request into a search containing: + # * A `geo_bounding_box` query on the ``. The query uses the `//` tile as a bounding box. + # * A `geotile_grid` or `geohex_grid` aggregation on the ``. The `grid_agg` parameter determines the aggregation type. The aggregation uses the `//` tile as a bounding box. + # * Optionally, a `geo_bounds` aggregation on the ``. The search only includes this aggregation if the `exact_bounds` parameter is `true`. + # * If the optional parameter `with_labels` is `true`, the internal search will include a dynamic runtime field that calls the `getLabelPosition` function of the geometry doc value. This enables the generation of new point features containing suggested geometry labels, so that, for example, multi-polygons will have only one label. + # The API returns results as a binary Mapbox vector tile. + # Mapbox vector tiles are encoded as Google Protobufs (PBF). By default, the tile contains three layers: + # * A `hits` layer containing a feature for each `` value matching the `geo_bounding_box` query. + # * An `aggs` layer containing a feature for each cell of the `geotile_grid` or `geohex_grid`. The layer only contains features for cells with matching data. + # * A meta layer containing: + # * A feature containing a bounding box. By default, this is the bounding box of the tile. + # * Value ranges for any sub-aggregations on the `geotile_grid` or `geohex_grid`. + # * Metadata for the search. + # The API only returns features that can display at its zoom level. + # For example, if a polygon feature has no area at its zoom level, the API omits it. + # The API returns errors as UTF-8 encoded JSON. + # IMPORTANT: You can specify several options for this API as either a query parameter or request body parameter. + # If you specify both parameters, the query parameter takes precedence. + # **Grid precision for geotile** + # For a `grid_agg` of `geotile`, you can use cells in the `aggs` layer as tiles for lower zoom levels. + # `grid_precision` represents the additional zoom levels available through these cells. The final precision is computed by as follows: ` + grid_precision`. + # For example, if `` is 7 and `grid_precision` is 8, then the `geotile_grid` aggregation will use a precision of 15. + # The maximum final precision is 29. + # The `grid_precision` also determines the number of cells for the grid as follows: `(2^grid_precision) x (2^grid_precision)`. + # For example, a value of 8 divides the tile into a grid of 256 x 256 cells. + # The `aggs` layer only contains features for cells with matching data. + # **Grid precision for geohex** + # For a `grid_agg` of `geohex`, Elasticsearch uses `` and `grid_precision` to calculate a final precision as follows: ` + grid_precision`. + # This precision determines the H3 resolution of the hexagonal cells produced by the `geohex` aggregation. + # The following table maps the H3 resolution for each precision. + # For example, if `` is 3 and `grid_precision` is 3, the precision is 6. + # At a precision of 6, hexagonal cells have an H3 resolution of 2. + # If `` is 3 and `grid_precision` is 4, the precision is 7. + # At a precision of 7, hexagonal cells have an H3 resolution of 3. + # | Precision | Unique tile bins | H3 resolution | Unique hex bins | Ratio | + # | --------- | ---------------- | ------------- | ----------------| ----- | + # | 1 | 4 | 0 | 122 | 30.5 | + # | 2 | 16 | 0 | 122 | 7.625 | + # | 3 | 64 | 1 | 842 | 13.15625 | + # | 4 | 256 | 1 | 842 | 3.2890625 | + # | 5 | 1024 | 2 | 5882 | 5.744140625 | + # | 6 | 4096 | 2 | 5882 | 1.436035156 | + # | 7 | 16384 | 3 | 41162 | 2.512329102 | + # | 8 | 65536 | 3 | 41162 | 0.6280822754 | + # | 9 | 262144 | 4 | 288122 | 1.099098206 | + # | 10 | 1048576 | 4 | 288122 | 0.2747745514 | + # | 11 | 4194304 | 5 | 2016842 | 0.4808526039 | + # | 12 | 16777216 | 6 | 14117882 | 0.8414913416 | + # | 13 | 67108864 | 6 | 14117882 | 0.2103728354 | + # | 14 | 268435456 | 7 | 98825162 | 0.3681524172 | + # | 15 | 1073741824 | 8 | 691776122 | 0.644266719 | + # | 16 | 4294967296 | 8 | 691776122 | 0.1610666797 | + # | 17 | 17179869184 | 9 | 4842432842 | 0.2818666889 | + # | 18 | 68719476736 | 10 | 33897029882 | 0.4932667053 | + # | 19 | 274877906944 | 11 | 237279209162 | 0.8632167343 | + # | 20 | 1099511627776 | 11 | 237279209162 | 0.2158041836 | + # | 21 | 4398046511104 | 12 | 1660954464122 | 0.3776573213 | + # | 22 | 17592186044416 | 13 | 11626681248842 | 0.6609003122 | + # | 23 | 70368744177664 | 13 | 11626681248842 | 0.165225078 | + # | 24 | 281474976710656 | 14 | 81386768741882 | 0.2891438866 | + # | 25 | 1125899906842620 | 15 | 569707381193162 | 0.5060018015 | + # | 26 | 4503599627370500 | 15 | 569707381193162 | 0.1265004504 | + # | 27 | 18014398509482000 | 15 | 569707381193162 | 0.03162511259 | + # | 28 | 72057594037927900 | 15 | 569707381193162 | 0.007906278149 | + # | 29 | 288230376151712000 | 15 | 569707381193162 | 0.001976569537 | + # Hexagonal cells don't align perfectly on a vector tile. + # Some cells may intersect more than one vector tile. + # To compute the H3 resolution for each precision, Elasticsearch compares the average density of hexagonal bins at each resolution with the average density of tile bins at each zoom level. + # Elasticsearch uses the H3 resolution that is closest to the corresponding geotile density. + # Learn how to use the vector tile search API with practical examples in the {https://www.elastic.co/docs/reference/elasticsearch/rest-apis/vector-tile-search Vector tile search examples} guide. # - # @option arguments [List] :index Comma-separated list of data streams, indices, or aliases to search - # @option arguments [String] :field Field containing geospatial data to return - # @option arguments [Integer] :zoom Zoom level for the vector tile to search - # @option arguments [Integer] :x X coordinate for the vector tile to search - # @option arguments [Integer] :y Y coordinate for the vector tile to search - # @option arguments [Boolean] :exact_bounds If false, the meta layer's feature is the bounding box of the tile. If true, the meta layer's feature is a bounding box resulting from a `geo_bounds` aggregation. - # @option arguments [Integer] :extent Size, in pixels, of a side of the vector tile. - # @option arguments [Integer] :grid_precision Additional zoom levels available through the aggs layer. Accepts 0-8. - # @option arguments [String] :grid_type Determines the geometry type for features in the aggs layer. (options: grid, point, centroid) + # @option arguments [String, Array] :index Comma-separated list of data streams, indices, or aliases to search (*Required*) + # @option arguments [String] :field Field containing geospatial data to return (*Required*) + # @option arguments [Integer] :zoom Zoom level for the vector tile to search (*Required*) + # @option arguments [Integer] :x X coordinate for the vector tile to search (*Required*) + # @option arguments [Integer] :y Y coordinate for the vector tile to search (*Required*) + # @option arguments [Boolean] :exact_bounds If `false`, the meta layer's feature is the bounding box of the tile. + # If true, the meta layer's feature is a bounding box resulting from a + # geo_bounds aggregation. The aggregation runs on values that intersect + # the // tile with wrap_longitude set to false. The resulting + # bounding box may be larger than the vector tile. + # @option arguments [Integer] :extent The size, in pixels, of a side of the tile. Vector tiles are square with equal sides. Server default: 4096. + # @option arguments [String] :grid_agg Aggregation used to create a grid for `field`. + # @option arguments [Integer] :grid_precision Additional zoom levels available through the aggs layer. For example, if is 7 + # and grid_precision is 8, you can zoom in up to level 15. Accepts 0-8. If 0, results + # don't include the aggs layer. Server default: 8. + # @option arguments [String] :grid_type Determines the geometry type for features in the aggs layer. In the aggs layer, + # each feature represents a geotile_grid cell. If 'grid' each feature is a Polygon + # of the cells bounding box. If 'point' each feature is a Point that is the centroid + # of the cell. Server default: grid. # @option arguments [Integer] :size Maximum number of features to return in the hits layer. Accepts 0-10000. - # @option arguments [Boolean|long] :track_total_hits Indicate if the number of documents that match the query should be tracked. A number can also be specified, to accurately track the total hit count up to the number. - # @option arguments [Boolean] :with_labels If true, the hits and aggs layers will contain additional point features with suggested label positions for the original features. + # If 0, results don't include the hits layer. Server default: 10000. + # @option arguments [Boolean, Integer] :track_total_hits The number of hits matching the query to count accurately. + # If `true`, the exact number of hits is returned at the cost of some performance. + # If `false`, the response does not include the total number of hits matching the query. Server default: 10000. + # @option arguments [Boolean] :with_labels If `true`, the hits and aggs layers will contain additional point features representing + # suggested label positions for the original features. + # - `Point` and `MultiPoint` features will have one of the points selected. + # - `Polygon` and `MultiPolygon` features will have a single point generated, either the centroid, if it is within the polygon, or another point within the polygon selected from the sorted triangle-tree. + # - `LineString` features will likewise provide a roughly central point selected from the triangle-tree. + # - The aggregation results will provide one central point for each aggregation bucket. + # All attributes from the original features will also be copied to the new label features. + # In addition, the new features will be distinguishable using the tag `_mvt_label_position`. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body Search request body. + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-vector-tile-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-mvt # def search_mvt(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_mvt' } - defined_params = %i[index field zoom x y].each_with_object({}) do |variable, set_variables| + defined_params = [:index, :field, :zoom, :x, :y].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -61,7 +161,7 @@ def search_mvt(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) _index = arguments.delete(:index) @@ -74,7 +174,7 @@ def search_mvt(arguments = {}) _y = arguments.delete(:y) method = Elasticsearch::API::HTTP_POST - path = "#{Utils.__listify(_index)}/_mvt/#{Utils.__listify(_field)}/#{Utils.__listify(_zoom)}/#{Utils.__listify(_x)}/#{Utils.__listify(_y)}" + path = "#{Utils.listify(_index)}/_mvt/#{Utils.listify(_field)}/#{Utils.listify(_zoom)}/#{Utils.listify(_x)}/#{Utils.listify(_y)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_shards.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_shards.rb index 70189da643..65306c2191 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_shards.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_shards.rb @@ -15,25 +15,49 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Returns information about the indices and shards that a search request would be executed against. + # Get the search shards. + # Get the indices and shards that a search request would be run against. + # This information can be useful for working out issues or planning optimizations with routing and shard preferences. + # When filtered aliases are used, the filter is returned as part of the `indices` section. + # If the Elasticsearch security features are enabled, you must have the `view_index_metadata` or `manage` index privilege for the target data stream, index, or alias. # - # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices - # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) - # @option arguments [String] :routing Specific routing value - # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) - # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) - # @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) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [String, Array] :index A comma-separated list of data streams, indices, and aliases to search. + # It supports wildcards (`*`). + # To search all data streams and indices, omit this parameter or use `*` or `_all`. + # @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`. + # @option arguments [String, Array] :expand_wildcards 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. + # Supports comma-separated values, such as `open,hidden`. Server default: open. + # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. + # @option arguments [Boolean] :local If `true`, the request retrieves information from the local node only. + # @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. + # IT can also be set to `-1` to indicate that the request should never timeout. Server default: 30s. + # @option arguments [String] :preference The node or shard the operation should be performed on. + # It is random by default. + # @option arguments [String] :routing A custom value used to route operations to a specific shard. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-shards.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-shards # def search_shards(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_shards' } @@ -46,13 +70,13 @@ def search_shards(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_GET path = if _index - "#{Utils.__listify(_index)}/_search_shards" + "#{Utils.listify(_index)}/_search_shards" else '_search_shards' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/search_template.rb b/elasticsearch-api/lib/elasticsearch/api/actions/search_template.rb index 5b67dfb582..69c93a4b0d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/search_template.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/search_template.rb @@ -15,32 +15,51 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Allows to use the Mustache language to pre-render a search definition. + # Run a search with a search template. # - # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices - # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) - # @option arguments [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indices should be ignored when throttled - # @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) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) - # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) - # @option arguments [List] :routing A comma-separated list of specific routing values - # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search - # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch) - # @option arguments [Boolean] :explain Specify whether to return detailed information about score computation as part of a hit - # @option arguments [Boolean] :profile Specify whether to profile the query execution - # @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response - # @option arguments [Boolean] :rest_total_hits_as_int Indicates whether hits.total should be rendered as an integer or an object in the rest search response - # @option arguments [Boolean] :ccs_minimize_roundtrips Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution + # @option arguments [String, Array] :index A comma-separated list of data streams, indices, and aliases to search. + # It supports wildcards (`*`). + # @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`. Server default: true. + # @option arguments [Boolean] :ccs_minimize_roundtrips If `true`, network round-trips are minimized for cross-cluster search requests. + # @option arguments [String, Array] :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. + # Supports comma-separated values, such as `open,hidden`. + # @option arguments [Boolean] :explain If `true`, the response includes additional details about score computation as part of a hit. + # @option arguments [Boolean] :ignore_throttled If `true`, specified concrete, expanded, or aliased indices are not included in the response when throttled. Server default: true. + # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. + # @option arguments [String] :preference The node or shard the operation should be performed on. + # It is random by default. + # @option arguments [Boolean] :profile If `true`, the query execution is profiled. + # @option arguments [String] :routing A custom value used to route operations to a specific shard. + # @option arguments [Time] :scroll Specifies how long a consistent view of the index + # should be maintained for scrolled search. + # @option arguments [String] :search_type The type of the search operation. + # @option arguments [Boolean] :rest_total_hits_as_int If `true`, `hits.total` is rendered as an integer in the response. + # If `false`, it is rendered as an object. + # @option arguments [Boolean] :typed_keys If `true`, the response prefixes aggregation and suggester names with their respective types. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The search definition template and its params (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-search-template # def search_template(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'search_template' } @@ -55,13 +74,13 @@ def search_template(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_POST path = if _index - "#{Utils.__listify(_index)}/_search/template" + "#{Utils.listify(_index)}/_search/template" else '_search/template' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/cache_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/cache_stats.rb index 89b16a6c14..2a5033f328 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/cache_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/cache_stats.rb @@ -15,23 +15,36 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module SearchableSnapshots module Actions - # Retrieve node-level cache statistics about searchable snapshots. + # Get cache statistics. + # Get statistics about the shared cache for partially mounted indices. # 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 [List] :node_id A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes + # @option arguments [String, Array] :node_id The names of the nodes in the cluster to target. + # @option arguments [Time] :master_timeout [TODO] + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-apis.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-searchable-snapshots-cache-stats # def cache_stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'searchable_snapshots.cache_stats' } @@ -50,11 +63,11 @@ def cache_stats(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _node_id - "_searchable_snapshots/#{Utils.__listify(_node_id)}/cache/stats" + "_searchable_snapshots/#{Utils.listify(_node_id)}/cache/stats" else '_searchable_snapshots/cache/stats' end - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/clear_cache.rb b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/clear_cache.rb index a7d0b6a246..a777feee1d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/clear_cache.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/clear_cache.rb @@ -15,26 +15,39 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module SearchableSnapshots module Actions - # Clear the cache of searchable snapshots. + # Clear the cache. + # Clear indices and data streams from the shared cache for partially mounted indices. # 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 [List] :index A comma-separated list of index names - # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) + # @option arguments [String, Array] :index A comma-separated list of data streams, indices, and aliases to clear from the cache. + # It supports wildcards (`*`). + # @option arguments [String, Array] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. # @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) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, none, all) + # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-apis.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-searchable-snapshots-clear-cache # def clear_cache(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'searchable_snapshots.clear_cache' } @@ -47,13 +60,13 @@ def clear_cache(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_POST path = if _index - "#{Utils.__listify(_index)}/_searchable_snapshots/cache/clear" + "#{Utils.listify(_index)}/_searchable_snapshots/cache/clear" else '_searchable_snapshots/cache/clear' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/mount.rb b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/mount.rb index e8238c98b7..22e17946fa 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/mount.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/mount.rb @@ -15,29 +15,45 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module SearchableSnapshots module Actions - # Mount a snapshot as a searchable index. + # Mount a snapshot. + # Mount a snapshot as a searchable snapshot index. + # Do not use this API for snapshots managed by index lifecycle management (ILM). + # Manually mounting ILM-managed snapshots can interfere with ILM processes. # - # @option arguments [String] :repository The name of the repository containing the snapshot of the index to mount - # @option arguments [String] :snapshot The name of the snapshot of the index to mount - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning - # @option arguments [String] :storage Selects the kind of local storage used to accelerate searches. Experimental, and defaults to `full_copy` + # @option arguments [String] :repository The name of the repository containing the snapshot of the index to mount. (*Required*) + # @option arguments [String] :snapshot The name of the snapshot of the index to mount. (*Required*) + # @option arguments [Time] :master_timeout The period to wait for the master node. + # If the master node is not available before the timeout expires, the request fails and returns an error. + # To indicate that the request should never timeout, set it to `-1`. Server default: 30s. + # @option arguments [Boolean] :wait_for_completion If true, the request blocks until the operation is complete. + # @option arguments [String] :storage The mount option for the searchable snapshot index. Server default: full_copy. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The restore configuration for mounting the snapshot as searchable (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-api-mount-snapshot.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-searchable-snapshots-mount # def mount(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'searchable_snapshots.mount' } - defined_params = %i[repository snapshot].each_with_object({}) do |variable, set_variables| + defined_params = [:repository, :snapshot].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -56,7 +72,7 @@ def mount(arguments = {}) _snapshot = arguments.delete(:snapshot) method = Elasticsearch::API::HTTP_POST - path = "_snapshot/#{Utils.__listify(_repository)}/#{Utils.__listify(_snapshot)}/_mount" + path = "_snapshot/#{Utils.listify(_repository)}/#{Utils.listify(_snapshot)}/_mount" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/stats.rb index eafb705ad0..9b0c47b238 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/searchable_snapshots/stats.rb @@ -15,20 +15,31 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module SearchableSnapshots module Actions - # Retrieve shard-level statistics about searchable snapshots. + # Get searchable snapshot statistics. # - # @option arguments [List] :index A comma-separated list of index names - # @option arguments [String] :level Return stats aggregated at cluster, index or shard level (options: cluster, indices, shards) + # @option arguments [String, Array] :index A comma-separated list of data streams and indices to retrieve statistics for. + # @option arguments [String] :level Return stats aggregated at cluster, index or shard level + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-apis.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-searchable-snapshots-stats # def stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'searchable_snapshots.stats' } @@ -41,13 +52,13 @@ def stats(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_GET path = if _index - "#{Utils.__listify(_index)}/_searchable_snapshots/stats" + "#{Utils.listify(_index)}/_searchable_snapshots/stats" else '_searchable_snapshots/stats' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/activate_user_profile.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/activate_user_profile.rb new file mode 100644 index 0000000000..ba9d872321 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/activate_user_profile.rb @@ -0,0 +1,73 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. +module Elasticsearch + module API + module Security + module Actions + # Activate a user profile. + # Create or update a user profile on behalf of another user. + # NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. + # Individual users and external applications should not call this API directly. + # The calling application must have either an `access_token` or a combination of `username` and `password` for the user that the profile document is intended for. + # Elastic reserves the right to change or remove this feature in future releases without prior notice. + # This API creates or updates a profile document for end users with information that is extracted from the user's authentication object including `username`, `full_name,` `roles`, and the authentication realm. + # For example, in the JWT `access_token` case, the profile user's `username` is extracted from the JWT token claim pointed to by the `claims.principal` setting of the JWT realm that authenticated the token. + # When updating a profile document, the API enables the document if it was disabled. + # Any updates do not change existing content for either the `labels` or `data` fields. + # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body request body + # + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-activate-user-profile + # + def activate_user_profile(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'security.activate_user_profile' } + + raise ArgumentError, "Required argument 'body' missing" unless arguments[:body] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + method = Elasticsearch::API::HTTP_POST + path = '_security/profile/_activate' + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/authenticate.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/authenticate.rb index 03f02c57ea..2030cad4ec 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/authenticate.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/authenticate.rb @@ -15,18 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Enables authentication as a user and retrieve information about the authenticated user. + # Authenticate a user. + # Authenticates a user and returns information about the authenticated user. + # Include the user information in a {https://en.wikipedia.org/wiki/Basic_access_authentication basic auth header}. + # A successful call returns a JSON structure that shows user information such as their username, the roles that are assigned to the user, any assigned metadata, and information about the realms that authenticated and authorized the user. + # If the user cannot be authenticated, this API returns a 401 status code. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-authenticate.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-authenticate # def authenticate(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.authenticate' } @@ -34,11 +49,11 @@ def authenticate(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_security/_authenticate' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_delete_role.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_delete_role.rb index ae3d6bbfd1..c7c4d2edfc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_delete_role.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_delete_role.rb @@ -15,20 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Bulk delete roles in the native realm. + # Bulk delete roles. + # The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. + # The bulk delete roles API cannot delete roles that are defined in roles files. # - # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for) + # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The roles to delete (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-bulk-delete-role.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-bulk-delete-role # def bulk_delete_role(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.bulk_delete_role' } @@ -38,7 +51,7 @@ def bulk_delete_role(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_DELETE path = '_security/role' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_put_role.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_put_role.rb index 5ec4578391..7e4121f725 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_put_role.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_put_role.rb @@ -15,20 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Bulk adds and updates roles in the native realm. + # Bulk create or update roles. + # The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. + # The bulk create or update roles API cannot update roles that are defined in roles files. # - # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for) + # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The roles to add (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-bulk-put-role.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-bulk-put-role # def bulk_put_role(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.bulk_put_role' } @@ -38,7 +51,7 @@ def bulk_put_role(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_security/role' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_update_api_keys.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_update_api_keys.rb index bf311c01f4..18121a51e7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_update_api_keys.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/bulk_update_api_keys.rb @@ -15,19 +15,39 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Updates the attributes of multiple existing API keys. + # Bulk update API keys. + # Update the attributes for multiple API keys. + # IMPORTANT: It is not possible to use an API key as the authentication credential for this API. To update API keys, the owner user's credentials are required. + # This API is similar to the update API key API but enables you to apply the same update to multiple API keys in one API call. This operation can greatly improve performance over making individual updates. + # It is not possible to update expired or invalidated API keys. + # This API supports updates to API key access scope, metadata and expiration. + # The access scope of each API key is derived from the `role_descriptors` you specify in the request and a snapshot of the owner user's permissions at the time of the request. + # The snapshot of the owner's permissions is updated automatically on every call. + # IMPORTANT: If you don't specify `role_descriptors` in the request, a call to this API might still change an API key's access scope. This change can occur if the owner user's permissions have changed since the API key was created or last modified. + # A successful request returns a JSON structure that contains the IDs of all updated API keys, the IDs of API keys that already had the requested changes and did not require an update, and error details for any failed update. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The API key request to update the attributes of multiple API keys. (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-bulk-update-api-keys.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-bulk-update-api-keys # def bulk_update_api_keys(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.bulk_update_api_keys' } @@ -37,11 +57,11 @@ def bulk_update_api_keys(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_security/api_key/_bulk_update' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/change_password.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/change_password.rb index 186861cdb7..37ade27c16 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/change_password.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/change_password.rb @@ -15,21 +15,34 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Changes the passwords of users in the native realm and built-in users. + # Change passwords. + # Change the passwords of users in the native realm and built-in users. # - # @option arguments [String] :username The username of the user to change the password for - # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for) + # @option arguments [String] :username The user whose password you want to change. If you do not specify this + # parameter, the password is changed for the current user. + # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body the new password for the user (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-change-password.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-change-password # def change_password(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.change_password' } @@ -50,7 +63,7 @@ def change_password(arguments = {}) method = Elasticsearch::API::HTTP_PUT path = if _username - "_security/user/#{Utils.__listify(_username)}/_password" + "_security/user/#{Utils.listify(_username)}/_password" else '_security/user/_password' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_api_key_cache.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_api_key_cache.rb index 8eb36221f1..e4200fe478 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_api_key_cache.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_api_key_cache.rb @@ -15,19 +15,34 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Clear a subset or all entries from the API key cache. + # Clear the API key cache. + # Evict a subset of all entries from the API key cache. + # The cache is also automatically cleared on state changes of the security index. # - # @option arguments [List] :ids A comma-separated list of IDs of API keys to clear from the cache + # @option arguments [String, Array] :ids Comma-separated list of API key IDs to evict from the API key cache. + # To evict all API keys, use `*`. + # Does not support other wildcard patterns. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-api-key-cache.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-clear-api-key-cache # def clear_api_key_cache(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.clear_api_key_cache' } @@ -42,13 +57,13 @@ def clear_api_key_cache(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil _ids = arguments.delete(:ids) method = Elasticsearch::API::HTTP_POST - path = "_security/api_key/#{Utils.__listify(_ids)}/_clear_cache" - params = {} + path = "_security/api_key/#{Utils.listify(_ids)}/_clear_cache" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_privileges.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_privileges.rb index 2b6ff2d79e..58dea38664 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_privileges.rb @@ -15,19 +15,34 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Evicts application privileges from the native application privileges cache. + # Clear the privileges cache. + # Evict privileges from the native application privilege cache. + # The cache is also automatically cleared for applications that have their privileges updated. # - # @option arguments [List] :application A comma-separated list of application names + # @option arguments [String] :application A comma-separated list of applications. + # To clear all applications, use an asterism (`*`). + # It does not support other wildcard patterns. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-privilege-cache.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-clear-cached-privileges # def clear_cached_privileges(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.clear_cached_privileges' } @@ -47,8 +62,8 @@ def clear_cached_privileges(arguments = {}) _application = arguments.delete(:application) method = Elasticsearch::API::HTTP_POST - path = "_security/privilege/#{Utils.__listify(_application)}/_clear_cache" - params = {} + path = "_security/privilege/#{Utils.listify(_application)}/_clear_cache" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_realms.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_realms.rb index 9f427c62e3..70f2365278 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_realms.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_realms.rb @@ -15,20 +15,39 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Evicts users from the user cache. Can completely clear the cache or evict specific users. + # Clear the user cache. + # Evict users from the user cache. + # You can completely clear the cache or evict specific users. + # User credentials are cached in memory on each node to avoid connecting to a remote authentication service or hitting the disk for every incoming request. + # There are realm settings that you can use to configure the user cache. + # For more information, refer to the documentation about controlling the user cache. # - # @option arguments [List] :realms Comma-separated list of realms to clear - # @option arguments [List] :usernames Comma-separated list of usernames to clear from the cache + # @option arguments [String, Array] :realms A comma-separated list of realms. + # To clear all realms, use an asterisk (`*`). + # It does not support other wildcard patterns. (*Required*) + # @option arguments [Array] :usernames A comma-separated list of the users to clear from the cache. + # If you do not specify this parameter, the API evicts all users from the user cache. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-cache.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-clear-cached-realms # def clear_cached_realms(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.clear_cached_realms' } @@ -48,7 +67,7 @@ def clear_cached_realms(arguments = {}) _realms = arguments.delete(:realms) method = Elasticsearch::API::HTTP_POST - path = "_security/realm/#{Utils.__listify(_realms)}/_clear_cache" + path = "_security/realm/#{Utils.listify(_realms)}/_clear_cache" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_roles.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_roles.rb index 8e253de2d5..041f66ab55 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_roles.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_roles.rb @@ -15,19 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Evicts roles from the native role cache. + # Clear the roles cache. + # Evict roles from the native role cache. # - # @option arguments [List] :name Role name + # @option arguments [String, Array] :name A comma-separated list of roles to evict from the role cache. + # To evict all roles, use an asterisk (`*`). + # It does not support other wildcard patterns. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-role-cache.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-clear-cached-roles # def clear_cached_roles(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.clear_cached_roles' } @@ -47,8 +61,8 @@ def clear_cached_roles(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_POST - path = "_security/role/#{Utils.__listify(_name)}/_clear_cache" - params = {} + path = "_security/role/#{Utils.listify(_name)}/_clear_cache" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_service_tokens.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_service_tokens.rb index e2d0d96d0b..e6d0392d8c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_service_tokens.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/clear_cached_service_tokens.rb @@ -15,26 +15,44 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Evicts tokens from the service account token caches. + # Clear service account token caches. + # Evict a subset of all entries from the service account token caches. + # Two separate caches exist for service account tokens: one cache for tokens backed by the `service_tokens` file, and another for tokens backed by the `.security` index. + # This API clears matching entries from both caches. + # The cache for service account tokens backed by the `.security` index is cleared automatically on state changes of the security index. + # The cache for tokens backed by the `service_tokens` file is cleared automatically on file changes. # - # @option arguments [String] :namespace An identifier for the namespace - # @option arguments [String] :service An identifier for the service name - # @option arguments [List] :name A comma-separated list of service token names + # @option arguments [String] :namespace The namespace, which is a top-level grouping of service accounts. (*Required*) + # @option arguments [String] :service The name of the service, which must be unique within its namespace. (*Required*) + # @option arguments [String, Array] :name A comma-separated list of token names to evict from the service account token caches. + # Use a wildcard (`*`) to evict all tokens that belong to a service account. + # It does not support other wildcard patterns. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-service-token-caches.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-clear-cached-service-tokens # def clear_cached_service_tokens(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.clear_cached_service_tokens' } - defined_params = %i[namespace service name].each_with_object({}) do |variable, set_variables| + defined_params = [:namespace, :service, :name].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -55,8 +73,8 @@ def clear_cached_service_tokens(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_POST - path = "_security/service/#{Utils.__listify(_namespace)}/#{Utils.__listify(_service)}/credential/token/#{Utils.__listify(_name)}/_clear_cache" - params = {} + path = "_security/service/#{Utils.listify(_namespace)}/#{Utils.listify(_service)}/credential/token/#{Utils.listify(_name)}/_clear_cache" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/create_api_key.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/create_api_key.rb index eb05c11c87..b0f5243994 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/create_api_key.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/create_api_key.rb @@ -15,20 +15,39 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Creates an API key for access without requiring basic authentication. + # Create an API key. + # Create an API key for access without requiring basic authentication. + # IMPORTANT: If the credential that is used to authenticate this request is an API key, the derived API key cannot have any privileges. + # If you specify privileges, the API returns an error. + # A successful request returns a JSON structure that contains the API key, its unique id, and its name. + # If applicable, it also returns expiration information for the API key in milliseconds. + # NOTE: By default, API keys never expire. You can specify expiration information when you create the API keys. + # The API keys are created by the Elasticsearch API key service, which is automatically enabled. + # To configure or turn off the API key service, refer to API key service setting documentation. # - # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for) + # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The api key request to create an API key (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-api-key.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-create-api-key # def create_api_key(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.create_api_key' } @@ -38,7 +57,7 @@ def create_api_key(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_PUT path = '_security/api_key' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/create_cross_cluster_api_key.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/create_cross_cluster_api_key.rb index 4933f9fbb8..5ef9dfbbd0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/create_cross_cluster_api_key.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/create_cross_cluster_api_key.rb @@ -15,19 +15,39 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Creates a cross-cluster API key for API key based remote cluster access. + # Create a cross-cluster API key. + # Create an API key of the `cross_cluster` type for the API key based remote cluster access. + # A `cross_cluster` API key cannot be used to authenticate through the REST interface. + # IMPORTANT: To authenticate this request you must use a credential that is not an API key. Even if you use an API key that has the required privilege, the API returns an error. + # Cross-cluster API keys are created by the Elasticsearch API key service, which is automatically enabled. + # NOTE: Unlike REST API keys, a cross-cluster API key does not capture permissions of the authenticated user. The API key’s effective permission is exactly as specified with the `access` property. + # A successful request returns a JSON structure that contains the API key, its unique ID, and its name. If applicable, it also returns expiration information for the API key in milliseconds. + # By default, API keys never expire. You can specify expiration information when you create the API keys. + # Cross-cluster API keys can only be updated with the update cross-cluster API key API. + # Attempting to update them with the update REST API key API or the bulk update REST API keys API will result in an error. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The request to create a cross-cluster API key (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-cross-cluster-api-key.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-create-cross-cluster-api-key # def create_cross_cluster_api_key(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.create_cross_cluster_api_key' } @@ -37,11 +57,11 @@ def create_cross_cluster_api_key(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_security/cross_cluster/api_key' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/create_service_token.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/create_service_token.rb index 9ebfacea38..a9d3557430 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/create_service_token.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/create_service_token.rb @@ -15,27 +15,44 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Creates a service account token for access without requiring basic authentication. + # Create a service account token. + # Create a service accounts token for access without requiring basic authentication. + # NOTE: Service account tokens never expire. + # You must actively delete them if they are no longer needed. # - # @option arguments [String] :namespace An identifier for the namespace - # @option arguments [String] :service An identifier for the service name - # @option arguments [String] :name An identifier for the token name - # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for) + # @option arguments [String] :namespace The name of the namespace, which is a top-level grouping of service accounts. (*Required*) + # @option arguments [String] :service The name of the service. (*Required*) + # @option arguments [String] :name The name for the service account token. + # If omitted, a random name will be generated.Token names must be at least one and no more than 256 characters. + # They can contain alphanumeric characters (a-z, A-Z, 0-9), dashes (`-`), and underscores (`_`), but cannot begin with an underscore.NOTE: Token names must be unique in the context of the associated service account. + # They must also be globally unique with their fully qualified names, which are comprised of the service account principal and token name, such as `//`. + # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-create-service-token.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-create-service-token # def create_service_token(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.create_service_token' } - defined_params = %i[namespace service name].each_with_object({}) do |variable, set_variables| + defined_params = [:namespace, :service, :name].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -56,9 +73,9 @@ def create_service_token(arguments = {}) method = _name ? Elasticsearch::API::HTTP_PUT : Elasticsearch::API::HTTP_POST path = if _namespace && _service && _name - "_security/service/#{Utils.__listify(_namespace)}/#{Utils.__listify(_service)}/credential/token/#{Utils.__listify(_name)}" + "_security/service/#{Utils.listify(_namespace)}/#{Utils.listify(_service)}/credential/token/#{Utils.listify(_name)}" else - "_security/service/#{Utils.__listify(_namespace)}/#{Utils.__listify(_service)}/credential/token" + "_security/service/#{Utils.listify(_namespace)}/#{Utils.listify(_service)}/credential/token" end params = Utils.process_params(arguments) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/delegate_pki.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/delegate_pki.rb index 1d637ba77e..9e1a3f0756 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/delegate_pki.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/delegate_pki.rb @@ -15,19 +15,37 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions # Delegate PKI authentication. + # This API implements the exchange of an X509Certificate chain for an Elasticsearch access token. + # The certificate chain is validated, according to RFC 5280, by sequentially considering the trust configuration of every installed PKI realm that has `delegation.enabled` set to `true`. + # A successfully trusted client certificate is also subject to the validation of the subject distinguished name according to thw `username_pattern` of the respective realm. + # This API is called by smart and trusted proxies, such as Kibana, which terminate the user's TLS session but still want to authenticate the user by using a PKI realm—-​as if the user connected directly to Elasticsearch. + # IMPORTANT: The association between the subject public key in the target certificate and the corresponding private key is not validated. + # This is part of the TLS authentication process and it is delegated to the proxy that calls this API. + # The proxy is trusted to have performed the TLS authentication and this API translates that authentication into an Elasticsearch access token. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The X509Certificate chain. (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delegate-pki-authentication.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-delegate-pki # def delegate_pki(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.delegate_pki' } @@ -37,11 +55,11 @@ def delegate_pki(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_security/delegate_pki' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_privileges.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_privileges.rb index fa4260b296..faf6a4c5c4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_privileges.rb @@ -15,26 +15,41 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Removes application privileges. + # Delete application privileges. + # To use this API, you must have one of the following privileges: + # * The `manage_security` cluster privilege (or a greater privilege such as `all`). + # * The "Manage Application Privileges" global privilege for the application being referenced in the request. # - # @option arguments [String] :application Application name - # @option arguments [String] :name Privilege name - # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for) + # @option arguments [String] :application The name of the application. + # Application privileges are always associated with exactly one application. (*Required*) + # @option arguments [String, Array] :name The name of the privilege. (*Required*) + # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-privilege.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-delete-privileges # def delete_privileges(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.delete_privileges' } - defined_params = %i[application name].each_with_object({}) do |variable, set_variables| + defined_params = [:application, :name].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -52,7 +67,7 @@ def delete_privileges(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_DELETE - path = "_security/privilege/#{Utils.__listify(_application)}/#{Utils.__listify(_name)}" + path = "_security/privilege/#{Utils.listify(_application)}/#{Utils.listify(_name)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role.rb index 81a755ea5a..fce4229c0d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role.rb @@ -15,20 +15,34 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Removes roles in the native realm. + # Delete roles. + # Delete roles in the native realm. + # The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. + # The delete roles API cannot remove roles that are defined in roles files. # - # @option arguments [String] :name Role name - # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for) + # @option arguments [String] :name The name of the role. (*Required*) + # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-delete-role # def delete_role(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.delete_role' } @@ -48,7 +62,7 @@ def delete_role(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_DELETE - path = "_security/role/#{Utils.__listify(_name)}" + path = "_security/role/#{Utils.listify(_name)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role_mapping.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role_mapping.rb index 57cc5f4258..7bf6337676 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role_mapping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_role_mapping.rb @@ -15,20 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Removes role mappings. + # Delete role mappings. + # Role mappings define which roles are assigned to each user. + # The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. + # The delete role mappings API cannot remove role mappings that are defined in role mapping files. # - # @option arguments [String] :name Role-mapping name - # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for) + # @option arguments [String] :name The distinct name that identifies the role mapping. + # The name is used solely as an identifier to facilitate interaction via the API; it does not affect the behavior of the mapping in any way. (*Required*) + # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-role-mapping.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-delete-role-mapping # def delete_role_mapping(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.delete_role_mapping' } @@ -48,7 +63,7 @@ def delete_role_mapping(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_DELETE - path = "_security/role_mapping/#{Utils.__listify(_name)}" + path = "_security/role_mapping/#{Utils.listify(_name)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_service_token.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_service_token.rb index e1e956f288..a8b0933dd4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_service_token.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_service_token.rb @@ -15,27 +15,39 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Deletes a service account token. + # Delete service account tokens. + # Delete service account tokens for a service in a specified namespace. # - # @option arguments [String] :namespace An identifier for the namespace - # @option arguments [String] :service An identifier for the service name - # @option arguments [String] :name An identifier for the token name - # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for) + # @option arguments [String] :namespace The namespace, which is a top-level grouping of service accounts. (*Required*) + # @option arguments [String] :service The service name. (*Required*) + # @option arguments [String] :name The name of the service account token. (*Required*) + # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-service-token.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-delete-service-token # def delete_service_token(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.delete_service_token' } - defined_params = %i[namespace service name].each_with_object({}) do |variable, set_variables| + defined_params = [:namespace, :service, :name].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -56,7 +68,7 @@ def delete_service_token(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_DELETE - path = "_security/service/#{Utils.__listify(_namespace)}/#{Utils.__listify(_service)}/credential/token/#{Utils.__listify(_name)}" + path = "_security/service/#{Utils.listify(_namespace)}/#{Utils.listify(_service)}/credential/token/#{Utils.listify(_name)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_user.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_user.rb index 6c60f97ffc..44379324aa 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_user.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/delete_user.rb @@ -15,20 +15,32 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Deletes users from the native realm. + # Delete users. + # Delete users from the native realm. # - # @option arguments [String] :username username - # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for) + # @option arguments [String] :username An identifier for the user. (*Required*) + # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-user.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-delete-user # def delete_user(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.delete_user' } @@ -48,7 +60,7 @@ def delete_user(arguments = {}) _username = arguments.delete(:username) method = Elasticsearch::API::HTTP_DELETE - path = "_security/user/#{Utils.__listify(_username)}" + path = "_security/user/#{Utils.listify(_username)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/disable_user.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/disable_user.rb index cd15f71593..6bd8518adf 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/disable_user.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/disable_user.rb @@ -15,20 +15,34 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Disables users in the native realm. + # Disable users. + # Disable users in the native realm. + # By default, when you create users, they are enabled. + # You can use this API to revoke a user's access to Elasticsearch. # - # @option arguments [String] :username The username of the user to disable - # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for) + # @option arguments [String] :username An identifier for the user. (*Required*) + # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-disable-user.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-disable-user # def disable_user(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.disable_user' } @@ -48,7 +62,7 @@ def disable_user(arguments = {}) _username = arguments.delete(:username) method = Elasticsearch::API::HTTP_PUT - path = "_security/user/#{Utils.__listify(_username)}/_disable" + path = "_security/user/#{Utils.listify(_username)}/_disable" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/disable_user_profile.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/disable_user_profile.rb new file mode 100644 index 0000000000..1b5c63a290 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/disable_user_profile.rb @@ -0,0 +1,80 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. +module Elasticsearch + module API + module Security + module Actions + # Disable a user profile. + # Disable user profiles so that they are not visible in user profile searches. + # NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. + # Individual users and external applications should not call this API directly. + # Elastic reserves the right to change or remove this feature in future releases without prior notice. + # When you activate a user profile, its automatically enabled and visible in user profile searches. You can use the disable user profile API to disable a user profile so it’s not visible in these searches. + # To re-enable a disabled user profile, use the enable user profile API . + # + # @option arguments [String] :uid Unique identifier for the user profile. (*Required*) + # @option arguments [String] :refresh If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search. + # If 'wait_for', it waits for a refresh to make this operation visible to search. + # If 'false', it does nothing with refreshes. Server default: false. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. + # @option arguments [Hash] :headers Custom HTTP headers + # + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-disable-user-profile + # + def disable_user_profile(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'security.disable_user_profile' } + + defined_params = [:uid].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'uid' missing" unless arguments[:uid] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = nil + + _uid = arguments.delete(:uid) + + method = Elasticsearch::API::HTTP_PUT + path = "_security/profile/#{Utils.listify(_uid)}/_disable" + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/enable_user.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/enable_user.rb index e6dadc479f..3d38aeeb17 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/enable_user.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/enable_user.rb @@ -15,20 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Enables users in the native realm. + # Enable users. + # Enable users in the native realm. + # By default, when you create users, they are enabled. # - # @option arguments [String] :username The username of the user to enable - # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for) + # @option arguments [String] :username An identifier for the user. (*Required*) + # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-enable-user.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-enable-user # def enable_user(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.enable_user' } @@ -48,7 +61,7 @@ def enable_user(arguments = {}) _username = arguments.delete(:username) method = Elasticsearch::API::HTTP_PUT - path = "_security/user/#{Utils.__listify(_username)}/_enable" + path = "_security/user/#{Utils.listify(_username)}/_enable" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/enable_user_profile.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/enable_user_profile.rb new file mode 100644 index 0000000000..4e62cfda41 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/enable_user_profile.rb @@ -0,0 +1,81 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. +module Elasticsearch + module API + module Security + module Actions + # Enable a user profile. + # Enable user profiles to make them visible in user profile searches. + # NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. + # Individual users and external applications should not call this API directly. + # Elastic reserves the right to change or remove this feature in future releases without prior notice. + # When you activate a user profile, it's automatically enabled and visible in user profile searches. + # If you later disable the user profile, you can use the enable user profile API to make the profile visible in these searches again. + # + # @option arguments [String] :uid A unique identifier for the user profile. (*Required*) + # @option arguments [String] :refresh If 'true', Elasticsearch refreshes the affected shards to make this operation + # visible to search. + # If 'wait_for', it waits for a refresh to make this operation visible to search. + # If 'false', nothing is done with refreshes. Server default: false. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. + # @option arguments [Hash] :headers Custom HTTP headers + # + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-enable-user-profile + # + def enable_user_profile(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'security.enable_user_profile' } + + defined_params = [:uid].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'uid' missing" unless arguments[:uid] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = nil + + _uid = arguments.delete(:uid) + + method = Elasticsearch::API::HTTP_PUT + path = "_security/profile/#{Utils.listify(_uid)}/_enable" + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/enroll_kibana.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/enroll_kibana.rb index 9c16f925ef..5110894326 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/enroll_kibana.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/enroll_kibana.rb @@ -15,18 +15,32 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Allows a kibana instance to configure itself to communicate with a secured elasticsearch cluster. + # Enroll Kibana. + # Enable a Kibana instance to configure itself for communication with a secured Elasticsearch cluster. + # NOTE: This API is currently intended for internal use only by Kibana. + # Kibana uses this API internally to configure itself for communications with an Elasticsearch cluster that already has security features enabled. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-kibana-enrollment.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-enroll-kibana # def enroll_kibana(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.enroll_kibana' } @@ -34,11 +48,11 @@ def enroll_kibana(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_security/enroll/kibana' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/enroll_node.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/enroll_node.rb index 2a9dc5c0af..f4ef66d16d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/enroll_node.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/enroll_node.rb @@ -15,18 +15,32 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Allows a new node to enroll to an existing cluster with security enabled. + # Enroll a node. + # Enroll a new node to allow it to join an existing cluster with security features enabled. + # The response contains all the necessary information for the joining node to bootstrap discovery and security related settings so that it can successfully join the cluster. + # The response contains key and certificate material that allows the caller to generate valid signed certificates for the HTTP layer of all nodes in the cluster. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-node-enrollment.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-enroll-node # def enroll_node(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.enroll_node' } @@ -34,11 +48,11 @@ def enroll_node(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_security/enroll/node' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_api_key.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_api_key.rb index b023edb480..ad4153e9bb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_api_key.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_api_key.rb @@ -15,26 +15,49 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions + # Get API key information. # Retrieves information for one or more API keys. + # NOTE: If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own. + # If you have `read_security`, `manage_api_key` or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership. # - # @option arguments [String] :id API key id of the API key to be retrieved - # @option arguments [String] :name API key name of the API key to be retrieved - # @option arguments [String] :username user name of the user who created this API key to be retrieved - # @option arguments [String] :realm_name realm name of the user who created this API key to be retrieved - # @option arguments [Boolean] :owner flag to query API keys owned by the currently authenticated user - # @option arguments [Boolean] :with_limited_by flag to show the limited-by role descriptors of API Keys - # @option arguments [Boolean] :with_profile_uid flag to also retrieve the API Key's owner profile uid, if it exists - # @option arguments [Boolean] :active_only flag to limit response to only active (not invalidated or expired) API keys + # @option arguments [String] :id An API key id. + # This parameter cannot be used with any of `name`, `realm_name` or `username`. + # @option arguments [String] :name An API key name. + # This parameter cannot be used with any of `id`, `realm_name` or `username`. + # It supports prefix search with wildcard. + # @option arguments [Boolean] :owner A boolean flag that can be used to query API keys owned by the currently authenticated user. + # The `realm_name` or `username` parameters cannot be specified when this parameter is set to `true` as they are assumed to be the currently authenticated ones. + # @option arguments [String] :realm_name The name of an authentication realm. + # This parameter cannot be used with either `id` or `name` or when `owner` flag is set to `true`. + # @option arguments [String] :username The username of a user. + # This parameter cannot be used with either `id` or `name` or when `owner` flag is set to `true`. + # @option arguments [Boolean] :with_limited_by Return the snapshot of the owner user's role descriptors + # associated with the API key. An API key's actual + # permission is the intersection of its assigned role + # descriptors and the owner user's role descriptors. + # @option arguments [Boolean] :active_only A boolean flag that can be used to query API keys that are currently active. An API key is considered active if it is neither invalidated, nor expired at query time. You can specify this together with other parameters such as `owner` or `name`. If `active_only` is false, the response will include both active and inactive (expired or invalidated) keys. + # @option arguments [Boolean] :with_profile_uid Determines whether to also retrieve the profile uid, for the API key owner principal, if it exists. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-api-key.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-get-api-key # def get_api_key(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.get_api_key' } @@ -42,7 +65,7 @@ def get_api_key(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_security/api_key' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_builtin_privileges.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_builtin_privileges.rb index aac95e8a75..0df49aa864 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_builtin_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_builtin_privileges.rb @@ -15,18 +15,30 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Retrieves the list of cluster privileges and index privileges that are available in this version of Elasticsearch. + # Get builtin privileges. + # Get the list of cluster privileges and index privileges that are available in this version of Elasticsearch. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-builtin-privileges.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-get-builtin-privileges # def get_builtin_privileges(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.get_builtin_privileges' } @@ -34,11 +46,11 @@ def get_builtin_privileges(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_security/privilege/_builtin' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_privileges.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_privileges.rb index 08b6a96c22..91e6889131 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_privileges.rb @@ -15,25 +15,42 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Retrieves application privileges. + # Get application privileges. + # To use this API, you must have one of the following privileges: + # * The `read_security` cluster privilege (or a greater privilege such as `manage_security` or `all`). + # * The "Manage Application Privileges" global privilege for the application being referenced in the request. # - # @option arguments [String] :application Application name - # @option arguments [String] :name Privilege name + # @option arguments [String] :application The name of the application. + # Application privileges are always associated with exactly one application. + # If you do not specify this parameter, the API returns information about all privileges for all applications. + # @option arguments [String, Array] :name The name of the privilege. + # If you do not specify this parameter, the API returns information about all privileges for the requested application. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-privileges.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-get-privileges # def get_privileges(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.get_privileges' } - defined_params = %i[application name].each_with_object({}) do |variable, set_variables| + defined_params = [:application, :name].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -49,13 +66,13 @@ def get_privileges(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _application && _name - "_security/privilege/#{Utils.__listify(_application)}/#{Utils.__listify(_name)}" + "_security/privilege/#{Utils.listify(_application)}/#{Utils.listify(_name)}" elsif _application - "_security/privilege/#{Utils.__listify(_application)}" + "_security/privilege/#{Utils.listify(_application)}" else '_security/privilege' end - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role.rb index 9b8f533987..34231946f6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role.rb @@ -15,19 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Retrieves roles in the native realm. + # Get roles. + # Get roles in the native realm. + # The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. + # The get roles API cannot retrieve roles that are defined in roles files. # - # @option arguments [List] :name A comma-separated list of role names + # @option arguments [String, Array] :name The name of the role. + # You can specify multiple roles as a comma-separated list. + # If you do not specify this parameter, the API returns information about all roles. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-get-role # def get_role(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.get_role' } @@ -46,14 +62,14 @@ def get_role(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _name - "_security/role/#{Utils.__listify(_name)}" + "_security/role/#{Utils.listify(_name)}" else '_security/role' end params = Utils.process_params(arguments) if Array(arguments[:ignore]).include?(404) - Utils.__rescue_from_not_found do + Utils.rescue_from_not_found do Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role_mapping.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role_mapping.rb index 2c6a79f930..342a35a18a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role_mapping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_role_mapping.rb @@ -15,19 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Retrieves role mappings. + # Get role mappings. + # Role mappings define which roles are assigned to each user. + # The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. + # The get role mappings API cannot retrieve role mappings that are defined in role mapping files. # - # @option arguments [List] :name A comma-separated list of role-mapping names + # @option arguments [String, Array] :name The distinct name that identifies the role mapping. The name is used solely as an identifier to facilitate interaction via the API; it does not affect the behavior of the mapping in any way. You can specify multiple mapping names as a comma-separated list. If you do not specify this parameter, the API returns information about all role mappings. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-role-mapping.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-get-role-mapping # def get_role_mapping(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.get_role_mapping' } @@ -46,11 +60,11 @@ def get_role_mapping(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _name - "_security/role_mapping/#{Utils.__listify(_name)}" + "_security/role_mapping/#{Utils.listify(_name)}" else '_security/role_mapping' end - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_service_accounts.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_service_accounts.rb index 4bf5a17cf6..d2305b7e4e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_service_accounts.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_service_accounts.rb @@ -15,25 +15,41 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Retrieves information about service accounts. + # Get service accounts. + # Get a list of service accounts that match the provided path parameters. + # NOTE: Currently, only the `elastic/fleet-server` service account is available. # - # @option arguments [String] :namespace An identifier for the namespace - # @option arguments [String] :service An identifier for the service name + # @option arguments [String] :namespace The name of the namespace. + # Omit this parameter to retrieve information about all service accounts. + # If you omit this parameter, you must also omit the `service` parameter. + # @option arguments [String] :service The service name. + # Omit this parameter to retrieve information about all service accounts that belong to the specified `namespace`. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-accounts.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-get-service-accounts # def get_service_accounts(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.get_service_accounts' } - defined_params = %i[namespace service].each_with_object({}) do |variable, set_variables| + defined_params = [:namespace, :service].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -49,13 +65,13 @@ def get_service_accounts(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _namespace && _service - "_security/service/#{Utils.__listify(_namespace)}/#{Utils.__listify(_service)}" + "_security/service/#{Utils.listify(_namespace)}/#{Utils.listify(_service)}" elsif _namespace - "_security/service/#{Utils.__listify(_namespace)}" + "_security/service/#{Utils.listify(_namespace)}" else '_security/service' end - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_service_credentials.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_service_credentials.rb index b66a44c054..6885b34fa3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_service_credentials.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_service_credentials.rb @@ -15,25 +15,40 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Retrieves information of all service credentials for a service account. + # Get service account credentials. + # To use this API, you must have at least the `read_security` cluster privilege (or a greater privilege such as `manage_service_account` or `manage_security`). + # The response includes service account tokens that were created with the create service account tokens API as well as file-backed tokens from all nodes of the cluster. + # NOTE: For tokens backed by the `service_tokens` file, the API collects them from all nodes of the cluster. + # Tokens with the same name from different nodes are assumed to be the same token and are only counted once towards the total number of service tokens. # - # @option arguments [String] :namespace An identifier for the namespace - # @option arguments [String] :service An identifier for the service name + # @option arguments [String] :namespace The name of the namespace. (*Required*) + # @option arguments [String] :service The service name. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-service-credentials.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-get-service-credentials # def get_service_credentials(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.get_service_credentials' } - defined_params = %i[namespace service].each_with_object({}) do |variable, set_variables| + defined_params = [:namespace, :service].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -51,8 +66,8 @@ def get_service_credentials(arguments = {}) _service = arguments.delete(:service) method = Elasticsearch::API::HTTP_GET - path = "_security/service/#{Utils.__listify(_namespace)}/#{Utils.__listify(_service)}/credential" - params = {} + path = "_security/service/#{Utils.listify(_namespace)}/#{Utils.listify(_service)}/credential" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_settings.rb index ce1a6ba852..37da781bd5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_settings.rb @@ -15,19 +15,36 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Retrieve settings for the security system indices + # Get security index settings. + # Get the user-configurable settings for the security internal index (`.security` and associated indices). + # Only a subset of the index settings — those that are user-configurable—will be shown. + # This includes: + # * `index.auto_expand_replicas` + # * `index.number_of_replicas` # - # @option arguments [Time] :master_timeout Timeout for connection to master + # @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. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-settings.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-get-settings # def get_settings(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.get_settings' } @@ -35,7 +52,7 @@ def get_settings(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_security/settings' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_token.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_token.rb index bbe77102bb..0b992e6c69 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_token.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_token.rb @@ -15,19 +15,39 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Creates a bearer token for access without requiring basic authentication. + # Get a token. + # Create a bearer token for access without requiring basic authentication. + # The tokens are created by the Elasticsearch Token Service, which is automatically enabled when you configure TLS on the HTTP interface. + # Alternatively, you can explicitly enable the `xpack.security.authc.token.enabled` setting. + # When you are running in production mode, a bootstrap check prevents you from enabling the token service unless you also enable TLS on the HTTP interface. + # The get token API takes the same parameters as a typical OAuth 2.0 token API except for the use of a JSON request body. + # A successful get token API call returns a JSON structure that contains the access token, the amount of time (seconds) that the token expires in, the type, and the scope if available. + # The tokens returned by the get token API have a finite period of time for which they are valid and after that time period, they can no longer be used. + # That time period is defined by the `xpack.security.authc.token.timeout` setting. + # If you want to invalidate a token immediately, you can do so by using the invalidate token API. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The token request to get (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-token.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-get-token # def get_token(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.get_token' } @@ -37,11 +57,11 @@ def get_token(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_security/oauth2/token' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user.rb index 94efebad8b..184f01963e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user.rb @@ -15,20 +15,32 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Retrieves information about users in the native realm and built-in users. + # Get users. + # Get information about users in the native realm and built-in users. # - # @option arguments [List] :username A comma-separated list of usernames - # @option arguments [Boolean] :with_profile_uid flag to retrieve profile uid (if exists) associated to the user + # @option arguments [String, Array] :username An identifier for the user. You can specify multiple usernames as a comma-separated list. If you omit this parameter, the API retrieves information about all users. + # @option arguments [Boolean] :with_profile_uid Determines whether to retrieve the user profile UID, if it exists, for the users. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-get-user # def get_user(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.get_user' } @@ -47,14 +59,14 @@ def get_user(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _username - "_security/user/#{Utils.__listify(_username)}" + "_security/user/#{Utils.listify(_username)}" else '_security/user' end params = Utils.process_params(arguments) if Array(arguments[:ignore]).include?(404) - Utils.__rescue_from_not_found do + Utils.rescue_from_not_found do Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_privileges.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_privileges.rb index 926460dc99..ed86b30af0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_privileges.rb @@ -15,18 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Retrieves security privileges for the logged in user. + # Get user privileges. + # Get the security privileges for the logged in user. + # All users can use this API, but only to determine their own privileges. + # To check the privileges of other users, you must use the run as feature. + # To check whether a user has a specific list of privileges, use the has privileges API. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-privileges.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-get-user-privileges # def get_user_privileges(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.get_user_privileges' } @@ -34,11 +49,11 @@ def get_user_privileges(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_security/user/_privileges' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_profile.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_profile.rb new file mode 100644 index 0000000000..4c8575ed7f --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/get_user_profile.rb @@ -0,0 +1,79 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. +module Elasticsearch + module API + module Security + module Actions + # Get a user profile. + # Get a user's profile using the unique profile ID. + # NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. + # Individual users and external applications should not call this API directly. + # Elastic reserves the right to change or remove this feature in future releases without prior notice. + # + # @option arguments [String, Array] :uid A unique identifier for the user profile. (*Required*) + # @option arguments [String, Array] :data A comma-separated list of filters for the `data` field of the profile document. + # To return all content use `data=*`. + # To return a subset of content use `data=` to retrieve content nested under the specified ``. + # By default returns no `data` content. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. + # @option arguments [Hash] :headers Custom HTTP headers + # + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-get-user-profile + # + def get_user_profile(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'security.get_user_profile' } + + defined_params = [:uid].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'uid' missing" unless arguments[:uid] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = nil + + _uid = arguments.delete(:uid) + + method = Elasticsearch::API::HTTP_GET + path = "_security/profile/#{Utils.listify(_uid)}" + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/grant_api_key.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/grant_api_key.rb index 19567099a6..f5bf7d4bf2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/grant_api_key.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/grant_api_key.rb @@ -15,20 +15,49 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Creates an API key on behalf of another user. + # Grant an API key. + # Create an API key on behalf of another user. + # This API is similar to the create API keys API, however it creates the API key for a user that is different than the user that runs the API. + # The caller must have authentication credentials for the user on whose behalf the API key will be created. + # It is not possible to use this API to create an API key without that user's credentials. + # The supported user authentication credential types are: + # * username and password + # * Elasticsearch access tokens + # * JWTs + # The user, for whom the authentication credentials is provided, can optionally "run as" (impersonate) another user. + # In this case, the API key will be created on behalf of the impersonated user. + # This API is intended be used by applications that need to create and manage API keys for end users, but cannot guarantee that those users have permission to create API keys on their own behalf. + # The API keys are created by the Elasticsearch API key service, which is automatically enabled. + # A successful grant API key API call returns a JSON structure that contains the API key, its unique id, and its name. + # If applicable, it also returns expiration information for the API key in milliseconds. + # By default, API keys never expire. You can specify expiration information when you create the API keys. # - # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for) + # @option arguments [String] :refresh If 'true', Elasticsearch refreshes the affected shards to make this operation + # visible to search. + # If 'wait_for', it waits for a refresh to make this operation visible to search. + # If 'false', nothing is done with refreshes. Server default: false. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The api key request to create an API key (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-grant-api-key.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-grant-api-key # def grant_api_key(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.grant_api_key' } @@ -38,7 +67,7 @@ def grant_api_key(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_security/api_key/grant' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/has_privileges.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/has_privileges.rb index db564b4390..bd6c9d66d9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/has_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/has_privileges.rb @@ -15,20 +15,34 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Determines whether the specified user has a specified list of privileges. + # Check user privileges. + # Determine whether the specified user has a specified list of privileges. + # All users can use this API, but only to determine their own privileges. + # To check the privileges of other users, you must use the run as feature. # # @option arguments [String] :user Username + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The privileges to test (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-has-privileges.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-has-privileges # def has_privileges(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.has_privileges' } @@ -49,11 +63,11 @@ def has_privileges(arguments = {}) method = Elasticsearch::API::HTTP_POST path = if _user - "_security/user/#{Utils.__listify(_user)}/_has_privileges" + "_security/user/#{Utils.listify(_user)}/_has_privileges" else '_security/user/_has_privileges' end - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/has_privileges_user_profile.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/has_privileges_user_profile.rb new file mode 100644 index 0000000000..d9d9e6159f --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/has_privileges_user_profile.rb @@ -0,0 +1,67 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. +module Elasticsearch + module API + module Security + module Actions + # Check user profile privileges. + # Determine whether the users associated with the specified user profile IDs have all the requested privileges. + # NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. Individual users and external applications should not call this API directly. + # Elastic reserves the right to change or remove this feature in future releases without prior notice. + # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body request body + # + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-has-privileges-user-profile + # + def has_privileges_user_profile(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'security.has_privileges_user_profile' } + + raise ArgumentError, "Required argument 'body' missing" unless arguments[:body] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + method = Elasticsearch::API::HTTP_POST + path = '_security/profile/_has_privileges' + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/invalidate_api_key.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/invalidate_api_key.rb index 4bc0e103fa..4074b73785 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/invalidate_api_key.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/invalidate_api_key.rb @@ -15,19 +15,40 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Invalidates one or more API keys. + # Invalidate API keys. + # This API invalidates API keys created by the create API key or grant API key APIs. + # Invalidated API keys fail authentication, but they can still be viewed using the get API key information and query API key information APIs, for at least the configured retention period, until they are automatically deleted. + # To use this API, you must have at least the `manage_security`, `manage_api_key`, or `manage_own_api_key` cluster privileges. + # The `manage_security` privilege allows deleting any API key, including both REST and cross cluster API keys. + # The `manage_api_key` privilege allows deleting any REST API key, but not cross cluster API keys. + # The `manage_own_api_key` only allows deleting REST API keys that are owned by the user. + # In addition, with the `manage_own_api_key` privilege, an invalidation request must be issued in one of the three formats: + # - Set the parameter `owner=true`. + # - Or, set both `username` and `realm_name` to match the user's identity. + # - Or, if the request is issued by an API key, that is to say an API key invalidates itself, specify its ID in the `ids` field. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The api key request to invalidate API key(s) (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-api-key.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-invalidate-api-key # def invalidate_api_key(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.invalidate_api_key' } @@ -37,11 +58,11 @@ def invalidate_api_key(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_DELETE path = '_security/api_key' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/invalidate_token.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/invalidate_token.rb index dcae33c44c..c540c24d00 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/invalidate_token.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/invalidate_token.rb @@ -15,19 +15,39 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Invalidates one or more access tokens or refresh tokens. + # Invalidate a token. + # The access tokens returned by the get token API have a finite period of time for which they are valid. + # After that time period, they can no longer be used. + # The time period is defined by the `xpack.security.authc.token.timeout` setting. + # The refresh tokens returned by the get token API are only valid for 24 hours. + # They can also be used exactly once. + # If you want to invalidate one or more access or refresh tokens immediately, use this invalidate token API. + # NOTE: While all parameters are optional, at least one of them is required. + # More specifically, either one of `token` or `refresh_token` parameters is required. + # If none of these two are specified, then `realm_name` and/or `username` need to be specified. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The token to invalidate (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-invalidate-token.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-invalidate-token # def invalidate_token(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.invalidate_token' } @@ -37,11 +57,11 @@ def invalidate_token(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_DELETE path = '_security/oauth2/token' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_authenticate.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_authenticate.rb index e100fc59b2..93bfef8e7f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_authenticate.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_authenticate.rb @@ -15,19 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Exchanges an OpenID Connection authentication response message for an Elasticsearch access token and refresh token pair + # Authenticate OpenID Connect. + # Exchange an OpenID Connect authentication response message for an Elasticsearch internal access token and refresh token that can be subsequently used for authentication. + # Elasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs. + # These APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The OpenID Connect response to authenticate (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-oidc-authenticate.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-oidc-authenticate # def oidc_authenticate(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.oidc_authenticate' } @@ -37,11 +51,11 @@ def oidc_authenticate(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_security/oidc/authenticate' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_logout.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_logout.rb index e39f9d4b34..c7be2fc762 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_logout.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_logout.rb @@ -15,19 +15,34 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Invalidates a refresh token and access token that was generated from the OpenID Connect Authenticate API + # Logout of OpenID Connect. + # Invalidate an access token and a refresh token that were generated as a response to the `/_security/oidc/authenticate` API. + # If the OpenID Connect authentication realm in Elasticsearch is accordingly configured, the response to this call will contain a URI pointing to the end session endpoint of the OpenID Connect Provider in order to perform single logout. + # Elasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs. + # These APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body Access token and refresh token to invalidate (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-oidc-logout.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-oidc-logout # def oidc_logout(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.oidc_logout' } @@ -37,11 +52,11 @@ def oidc_logout(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_security/oidc/logout' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_prepare_authentication.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_prepare_authentication.rb index 2d9247ecd4..6d44eb434c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_prepare_authentication.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/oidc_prepare_authentication.rb @@ -15,19 +15,34 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Creates an OAuth 2.0 authentication request as a URL string + # Prepare OpenID connect authentication. + # Create an oAuth 2.0 authentication request as a URL string based on the configuration of the OpenID Connect authentication realm in Elasticsearch. + # The response of this API is a URL pointing to the Authorization Endpoint of the configured OpenID Connect Provider, which can be used to redirect the browser of the user in order to continue the authentication process. + # Elasticsearch exposes all the necessary OpenID Connect related functionality with the OpenID Connect APIs. + # These APIs are used internally by Kibana in order to provide OpenID Connect based authentication, but can also be used by other, custom web applications or other clients. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The OpenID Connect authentication realm configuration (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-oidc-prepare-authentication.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-oidc-prepare-authentication # def oidc_prepare_authentication(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.oidc_prepare_authentication' } @@ -37,11 +52,11 @@ def oidc_prepare_authentication(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_security/oidc/prepare' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_privileges.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_privileges.rb index 0e4b52836e..3582b5a5ff 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_privileges.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_privileges.rb @@ -15,20 +15,43 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Adds or updates application privileges. + # Create or update application privileges. + # To use this API, you must have one of the following privileges: + # * The `manage_security` cluster privilege (or a greater privilege such as `all`). + # * The "Manage Application Privileges" global privilege for the application being referenced in the request. + # Application names are formed from a prefix, with an optional suffix that conform to the following rules: + # * The prefix must begin with a lowercase ASCII letter. + # * The prefix must contain only ASCII letters or digits. + # * The prefix must be at least 3 characters long. + # * If the suffix exists, it must begin with either a dash `-` or `_`. + # * The suffix cannot contain any of the following characters: `\`, `/`, `*`, `?`, `"`, `<`, `>`, `|`, `,`, `*`. + # * No part of the name can contain whitespace. + # Privilege names must begin with a lowercase ASCII letter and must contain only ASCII letters and digits along with the characters `_`, `-`, and `.`. + # Action names can contain any number of printable ASCII characters and must contain at least one of the following characters: `/`, `*`, `:`. # - # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for) + # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The privilege(s) to add (*Required*) + # @option arguments [Hash] :body privileges # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-privileges.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-put-privileges # def put_privileges(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.put_privileges' } @@ -38,7 +61,7 @@ def put_privileges(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_PUT path = '_security/privilege' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_role.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_role.rb index a0e102ee73..2d283ae404 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_role.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_role.rb @@ -15,21 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Adds and updates roles in the native realm. + # Create or update roles. + # The role management APIs are generally the preferred way to manage roles in the native realm, rather than using file-based role management. + # The create or update roles API cannot update roles that are defined in roles files. + # File-based role management is not available in Elastic Serverless. # - # @option arguments [String] :name Role name - # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for) + # @option arguments [String] :name The name of the role that is being created or updated. On Elasticsearch Serverless, the role name must begin with a letter or digit and can only contain letters, digits and the characters '_', '-', and '.'. Each role must have a unique name, as this will serve as the identifier for that role. (*Required*) + # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The role to add (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-put-role # def put_role(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.put_role' } @@ -50,7 +64,7 @@ def put_role(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_PUT - path = "_security/role/#{Utils.__listify(_name)}" + path = "_security/role/#{Utils.listify(_name)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_role_mapping.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_role_mapping.rb index 4e238c2d0b..7f0e41bb63 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_role_mapping.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_role_mapping.rb @@ -15,21 +15,50 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Creates and updates role mappings. + # Create or update role mappings. + # Role mappings define which roles are assigned to each user. + # Each mapping has rules that identify users and a list of roles that are granted to those users. + # The role mapping APIs are generally the preferred way to manage role mappings rather than using role mapping files. The create or update role mappings API cannot update role mappings that are defined in role mapping files. + # NOTE: This API does not create roles. Rather, it maps users to existing roles. + # Roles can be created by using the create or update roles API or roles files. + # **Role templates** + # The most common use for role mappings is to create a mapping from a known value on the user to a fixed role name. + # For example, all users in the `cn=admin,dc=example,dc=com` LDAP group should be given the superuser role in Elasticsearch. + # The `roles` field is used for this purpose. + # For more complex needs, it is possible to use Mustache templates to dynamically determine the names of the roles that should be granted to the user. + # The `role_templates` field is used for this purpose. + # NOTE: To use role templates successfully, the relevant scripting feature must be enabled. + # Otherwise, all attempts to create a role mapping with role templates fail. + # All of the user fields that are available in the role mapping rules are also available in the role templates. + # Thus it is possible to assign a user to a role that reflects their username, their groups, or the name of the realm to which they authenticated. + # By default a template is evaluated to produce a single string that is the name of the role which should be assigned to the user. + # If the format of the template is set to "json" then the template is expected to produce a JSON string or an array of JSON strings for the role names. # - # @option arguments [String] :name Role-mapping name - # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for) + # @option arguments [String] :name The distinct name that identifies the role mapping. + # The name is used solely as an identifier to facilitate interaction via the API; it does not affect the behavior of the mapping in any way. (*Required*) + # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The role mapping to add (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-role-mapping.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-put-role-mapping # def put_role_mapping(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.put_role_mapping' } @@ -50,7 +79,7 @@ def put_role_mapping(arguments = {}) _name = arguments.delete(:name) method = Elasticsearch::API::HTTP_PUT - path = "_security/role_mapping/#{Utils.__listify(_name)}" + path = "_security/role_mapping/#{Utils.listify(_name)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_user.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_user.rb index 453d00ef59..462e9b0341 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/put_user.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/put_user.rb @@ -15,21 +15,38 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Adds and updates users in the native realm. These users are commonly referred to as native users. + # Create or update users. + # Add and update users in the native realm. + # A password is required for adding a new user but is optional when updating an existing user. + # To change a user's password without updating any other fields, use the change password API. # - # @option arguments [String] :username The username of the User - # @option arguments [String] :refresh If `true` (the default) then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. (options: true, false, wait_for) + # @option arguments [String] :username An identifier for the user.NOTE: Usernames must be at least 1 and no more than 507 characters. + # They can contain alphanumeric characters (a-z, A-Z, 0-9), spaces, punctuation, and printable symbols in the Basic Latin (ASCII) block. + # Leading or trailing whitespace is not allowed. (*Required*) + # @option arguments [String] :refresh Valid values are `true`, `false`, and `wait_for`. + # These values have the same meaning as in the index API, but the default value for this API is true. Server default: true. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The user to add (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-put-user.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-put-user # def put_user(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.put_user' } @@ -50,7 +67,7 @@ def put_user(arguments = {}) _username = arguments.delete(:username) method = Elasticsearch::API::HTTP_PUT - path = "_security/user/#{Utils.__listify(_username)}" + path = "_security/user/#{Utils.listify(_username)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/query_api_keys.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/query_api_keys.rb index 02cf165e18..90290d67ae 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/query_api_keys.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/query_api_keys.rb @@ -15,22 +15,42 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Retrieves information for API keys using a subset of query DSL + # Find API keys with a query. + # Get a paginated list of API keys and their information. + # You can optionally filter the results with a query. + # To use this API, you must have at least the `manage_own_api_key` or the `read_security` cluster privileges. + # If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own. + # If you have the `read_security`, `manage_api_key`, or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership. + # Refer to the linked documentation for examples of how to find API keys: # - # @option arguments [Boolean] :with_limited_by flag to show the limited-by role descriptors of API Keys - # @option arguments [Boolean] :with_profile_uid flag to also retrieve the API Key's owner profile uid, if it exists - # @option arguments [Boolean] :typed_keys flag to prefix aggregation names by their respective types in the response + # @option arguments [Boolean] :with_limited_by Return the snapshot of the owner user's role descriptors associated with the API key. + # An API key's actual permission is the intersection of its assigned role descriptors and the owner user's role descriptors (effectively limited by it). + # An API key cannot retrieve any API key’s limited-by role descriptors (including itself) unless it has `manage_api_key` or higher privileges. + # @option arguments [Boolean] :with_profile_uid Determines whether to also retrieve the profile UID for the API key owner principal. + # If it exists, the profile UID is returned under the `profile_uid` response field for each API key. + # @option arguments [Boolean] :typed_keys Determines whether aggregation names are prefixed by their respective types in the response. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body From, size, query, sort and search_after + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-api-key.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-query-api-keys # def query_api_keys(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.query_api_keys' } @@ -38,7 +58,7 @@ def query_api_keys(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = if body Elasticsearch::API::HTTP_POST @@ -46,7 +66,7 @@ def query_api_keys(arguments = {}) Elasticsearch::API::HTTP_GET end - path = '_security/_query/api_key' + path = '_security/_query/api_key' params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/query_role.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/query_role.rb index c5d84ec159..b4009fa6e5 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/query_role.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/query_role.rb @@ -15,19 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Retrieves information for Roles using a subset of query DSL + # Find roles with a query. + # Get roles in a paginated manner. + # The role management APIs are generally the preferred way to manage roles, rather than using file-based role management. + # The query roles API does not retrieve roles that are defined in roles files, nor built-in ones. + # You can optionally filter the results with a query. + # Also, the results can be paginated and sorted. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body From, size, query, sort and search_after + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-role.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-query-role # def query_role(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.query_role' } @@ -35,7 +51,7 @@ def query_role(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = if body Elasticsearch::API::HTTP_POST @@ -43,8 +59,8 @@ def query_role(arguments = {}) Elasticsearch::API::HTTP_GET end - path = '_security/_query/role' - params = {} + path = '_security/_query/role' + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/query_user.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/query_user.rb index a4df6bb7ee..2d6747e20d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/query_user.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/query_user.rb @@ -15,20 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Retrieves information for Users using a subset of query DSL + # Find users with a query. + # Get information for users in a paginated manner. + # You can optionally filter the results with a query. + # NOTE: As opposed to the get user API, built-in users are excluded from the result. + # This API is only for native users. # - # @option arguments [Boolean] :with_profile_uid flag to retrieve profile uid (if exists) associated with the user + # @option arguments [Boolean] :with_profile_uid Determines whether to retrieve the user profile UID, if it exists, for the users. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body From, size, query, sort and search_after + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-query-user.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-query-user # def query_user(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.query_user' } @@ -36,7 +51,7 @@ def query_user(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = if body Elasticsearch::API::HTTP_POST @@ -44,7 +59,7 @@ def query_user(arguments = {}) Elasticsearch::API::HTTP_GET end - path = '_security/_query/user' + path = '_security/_query/user' params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_authenticate.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_authenticate.rb index 7d0486ca5c..7f6cd297dc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_authenticate.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_authenticate.rb @@ -15,19 +15,39 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Exchanges a SAML Response message for an Elasticsearch access token and refresh token pair + # Authenticate SAML. + # Submit a SAML response message to Elasticsearch for consumption. + # NOTE: This API is intended for use by custom web applications other than Kibana. + # If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack. + # The SAML message that is submitted can be: + # * A response to a SAML authentication request that was previously created using the SAML prepare authentication API. + # * An unsolicited SAML message in the case of an IdP-initiated single sign-on (SSO) flow. + # In either case, the SAML message needs to be a base64 encoded XML document with a root element of ``. + # After successful validation, Elasticsearch responds with an Elasticsearch internal access token and refresh token that can be subsequently used for authentication. + # This API endpoint essentially exchanges SAML responses that indicate successful authentication in the IdP for Elasticsearch access and refresh tokens, which can be used for authentication against Elasticsearch. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The SAML response to authenticate (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-authenticate.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-saml-authenticate # def saml_authenticate(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.saml_authenticate' } @@ -37,11 +57,11 @@ def saml_authenticate(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_security/saml/authenticate' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_complete_logout.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_complete_logout.rb index 7d0db5fec3..bb9f129f9f 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_complete_logout.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_complete_logout.rb @@ -15,19 +15,38 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Verifies the logout response sent from the SAML IdP + # Logout of SAML completely. + # Verifies the logout response sent from the SAML IdP. + # NOTE: This API is intended for use by custom web applications other than Kibana. + # If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack. + # The SAML IdP may send a logout response back to the SP after handling the SP-initiated SAML Single Logout. + # This API verifies the response by ensuring the content is relevant and validating its signature. + # An empty response is returned if the verification process is successful. + # The response can be sent by the IdP with either the HTTP-Redirect or the HTTP-Post binding. + # The caller of this API must prepare the request accordingly so that this API can handle either of them. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The logout response to verify (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-complete-logout.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-saml-complete-logout # def saml_complete_logout(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.saml_complete_logout' } @@ -37,11 +56,11 @@ def saml_complete_logout(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_security/saml/complete_logout' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_invalidate.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_invalidate.rb index 28951664e4..1a529d9e1d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_invalidate.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_invalidate.rb @@ -15,19 +15,37 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Consumes a SAML LogoutRequest + # Invalidate SAML. + # Submit a SAML LogoutRequest message to Elasticsearch for consumption. + # NOTE: This API is intended for use by custom web applications other than Kibana. + # If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack. + # The logout request comes from the SAML IdP during an IdP initiated Single Logout. + # The custom web application can use this API to have Elasticsearch process the `LogoutRequest`. + # After successful validation of the request, Elasticsearch invalidates the access token and refresh token that corresponds to that specific SAML principal and provides a URL that contains a SAML LogoutResponse message. + # Thus the user can be redirected back to their IdP. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The LogoutRequest message (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-invalidate.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-saml-invalidate # def saml_invalidate(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.saml_invalidate' } @@ -37,11 +55,11 @@ def saml_invalidate(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_security/saml/invalidate' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_logout.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_logout.rb index 17bccc2ddd..b30dc30453 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_logout.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_logout.rb @@ -15,19 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Invalidates an access token and a refresh token that were generated via the SAML Authenticate API + # Logout of SAML. + # Submits a request to invalidate an access token and refresh token. + # NOTE: This API is intended for use by custom web applications other than Kibana. + # If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack. + # This API invalidates the tokens that were generated for a user by the SAML authenticate API. + # If the SAML realm in Elasticsearch is configured accordingly and the SAML IdP supports this, the Elasticsearch response contains a URL to redirect the user to the IdP that contains a SAML logout request (starting an SP-initiated SAML Single Logout). # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The tokens to invalidate (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-logout.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-saml-logout # def saml_logout(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.saml_logout' } @@ -37,11 +53,11 @@ def saml_logout(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_security/saml/logout' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_prepare_authentication.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_prepare_authentication.rb index 81bec3685d..94d6ad03d6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_prepare_authentication.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_prepare_authentication.rb @@ -15,19 +15,40 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Creates a SAML authentication request + # Prepare SAML authentication. + # Create a SAML authentication request (``) as a URL string based on the configuration of the respective SAML realm in Elasticsearch. + # NOTE: This API is intended for use by custom web applications other than Kibana. + # If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack. + # This API returns a URL pointing to the SAML Identity Provider. + # You can use the URL to redirect the browser of the user in order to continue the authentication process. + # The URL includes a single parameter named `SAMLRequest`, which contains a SAML Authentication request that is deflated and Base64 encoded. + # If the configuration dictates that SAML authentication requests should be signed, the URL has two extra parameters named `SigAlg` and `Signature`. + # These parameters contain the algorithm used for the signature and the signature value itself. + # It also returns a random string that uniquely identifies this SAML Authentication request. + # The caller of this API needs to store this identifier as it needs to be used in a following step of the authentication process. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The realm for which to create the authentication request, identified by either its name or the ACS URL (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-prepare-authentication.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-saml-prepare-authentication # def saml_prepare_authentication(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.saml_prepare_authentication' } @@ -37,11 +58,11 @@ def saml_prepare_authentication(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_security/saml/prepare' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_service_provider_metadata.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_service_provider_metadata.rb index cecd339eee..8afa9af211 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_service_provider_metadata.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/saml_service_provider_metadata.rb @@ -15,19 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Generates SAML metadata for the Elastic stack SAML 2.0 Service Provider + # Create SAML service provider metadata. + # Generate SAML metadata for a SAML 2.0 Service Provider. + # The SAML 2.0 specification provides a mechanism for Service Providers to describe their capabilities and configuration using a metadata file. + # This API generates Service Provider metadata based on the configuration of a SAML realm in Elasticsearch. # - # @option arguments [String] :realm_name The name of the SAML realm to get the metadata for + # @option arguments [String] :realm_name The name of the SAML realm in Elasticsearch. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-saml-sp-metadata.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-saml-service-provider-metadata # def saml_service_provider_metadata(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.saml_service_provider_metadata' } @@ -47,8 +61,8 @@ def saml_service_provider_metadata(arguments = {}) _realm_name = arguments.delete(:realm_name) method = Elasticsearch::API::HTTP_GET - path = "_security/saml/metadata/#{Utils.__listify(_realm_name)}" - params = {} + path = "_security/saml/metadata/#{Utils.listify(_realm_name)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/suggest_user_profiles.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/suggest_user_profiles.rb new file mode 100644 index 0000000000..feaa40cd93 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/suggest_user_profiles.rb @@ -0,0 +1,76 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. +module Elasticsearch + module API + module Security + module Actions + # Suggest a user profile. + # Get suggestions for user profiles that match specified search criteria. + # NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. + # Individual users and external applications should not call this API directly. + # Elastic reserves the right to change or remove this feature in future releases without prior notice. + # + # @option arguments [String, Array] :data A comma-separated list of filters for the `data` field of the profile document. + # To return all content use `data=*`. + # To return a subset of content, use `data=` to retrieve content nested under the specified ``. + # By default, the API returns no `data` content. + # It is an error to specify `data` as both the query parameter and the request body field. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body request body + # + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-suggest-user-profiles + # + def suggest_user_profiles(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'security.suggest_user_profiles' } + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + method = if body + Elasticsearch::API::HTTP_POST + else + Elasticsearch::API::HTTP_GET + end + + path = '_security/profile/_suggest' + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/update_api_key.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/update_api_key.rb index dad4b51305..aaa5467af4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/update_api_key.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/update_api_key.rb @@ -15,20 +15,44 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Updates attributes of an existing API key. + # Update an API key. + # Update attributes of an existing API key. + # This API supports updates to an API key's access scope, expiration, and metadata. + # To use this API, you must have at least the `manage_own_api_key` cluster privilege. + # Users can only update API keys that they created or that were granted to them. + # To update another user’s API key, use the `run_as` feature to submit a request on behalf of another user. + # IMPORTANT: It's not possible to use an API key as the authentication credential for this API. The owner user’s credentials are required. + # Use this API to update API keys created by the create API key or grant API Key APIs. + # If you need to apply the same update to many API keys, you can use the bulk update API keys API to reduce overhead. + # It's not possible to update expired API keys or API keys that have been invalidated by the invalidate API key API. + # The access scope of an API key is derived from the `role_descriptors` you specify in the request and a snapshot of the owner user's permissions at the time of the request. + # The snapshot of the owner's permissions is updated automatically on every call. + # IMPORTANT: If you don't specify `role_descriptors` in the request, a call to this API might still change the API key's access scope. + # This change can occur if the owner user's permissions have changed since the API key was created or last modified. # - # @option arguments [String] :id The ID of the API key to update + # @option arguments [String] :id The ID of the API key to update. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The API key request to update attributes of an API key. + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-api-key.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-update-api-key # def update_api_key(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.update_api_key' } @@ -48,8 +72,8 @@ def update_api_key(arguments = {}) _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_PUT - path = "_security/api_key/#{Utils.__listify(_id)}" - params = {} + path = "_security/api_key/#{Utils.listify(_id)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/update_cross_cluster_api_key.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/update_cross_cluster_api_key.rb index 141a5cd3af..3210ac126a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/update_cross_cluster_api_key.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/update_cross_cluster_api_key.rb @@ -15,20 +15,42 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Updates attributes of an existing cross-cluster API key. + # Update a cross-cluster API key. + # Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access. + # To use this API, you must have at least the `manage_security` cluster privilege. + # Users can only update API keys that they created. + # To update another user's API key, use the `run_as` feature to submit a request on behalf of another user. + # IMPORTANT: It's not possible to use an API key as the authentication credential for this API. + # To update an API key, the owner user's credentials are required. + # It's not possible to update expired API keys, or API keys that have been invalidated by the invalidate API key API. + # This API supports updates to an API key's access scope, metadata, and expiration. + # The owner user's information, such as the `username` and `realm`, is also updated automatically on every call. + # NOTE: This API cannot update REST API keys, which should be updated by either the update API key or bulk update API keys API. + # To learn more about how to use this API, refer to the {https://www.elastic.co/docs/reference/elasticsearch/rest-apis/update-cc-api-key-examples Update cross cluter API key API examples page}. # - # @option arguments [String] :id The ID of the cross-cluster API key to update + # @option arguments [String] :id The ID of the cross-cluster API key to update. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The request to update attributes of a cross-cluster API key. (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-cross-cluster-api-key.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-update-cross-cluster-api-key # def update_cross_cluster_api_key(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.update_cross_cluster_api_key' } @@ -49,8 +71,8 @@ def update_cross_cluster_api_key(arguments = {}) _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_PUT - path = "_security/cross_cluster/api_key/#{Utils.__listify(_id)}" - params = {} + path = "_security/cross_cluster/api_key/#{Utils.listify(_id)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/update_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/update_settings.rb index bd86ffcbca..3808e5eaaa 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/security/update_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/update_settings.rb @@ -15,21 +15,38 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Security module Actions - # Update settings for the security system index + # Update security index settings. + # Update the user-configurable settings for the security internal index (`.security` and associated indices). Only a subset of settings are allowed to be modified. This includes `index.auto_expand_replicas` and `index.number_of_replicas`. + # NOTE: If `index.auto_expand_replicas` is set, `index.number_of_replicas` will be ignored during updates. + # If a specific index is not in use on the system and settings are provided for it, the request will be rejected. + # This API does not yet support configuring the settings for indices before they are in use. # - # @option arguments [Time] :master_timeout Timeout for connection to master - # @option arguments [Time] :timeout Timeout for acknowledgements from all nodes + # @option arguments [Time] :master_timeout The 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. + # @option arguments [Time] :timeout The period to wait for a response. + # If no response is received before the timeout expires, the request fails and returns an error. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body An object with the new settings for each index, if any (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-update-settings.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-update-settings # def update_settings(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'security.update_settings' } @@ -39,7 +56,7 @@ def update_settings(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_PUT path = '_security/settings' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/security/update_user_profile_data.rb b/elasticsearch-api/lib/elasticsearch/api/actions/security/update_user_profile_data.rb new file mode 100644 index 0000000000..7a31731c03 --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/security/update_user_profile_data.rb @@ -0,0 +1,90 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. +module Elasticsearch + module API + module Security + module Actions + # Update user profile data. + # Update specific data for the user profile that is associated with a unique ID. + # NOTE: The user profile feature is designed only for use by Kibana and Elastic's Observability, Enterprise Search, and Elastic Security solutions. + # Individual users and external applications should not call this API directly. + # Elastic reserves the right to change or remove this feature in future releases without prior notice. + # To use this API, you must have one of the following privileges: + # * The `manage_user_profile` cluster privilege. + # * The `update_profile_data` global privilege for the namespaces that are referenced in the request. + # This API updates the `labels` and `data` fields of an existing user profile document with JSON objects. + # New keys and their values are added to the profile document and conflicting keys are replaced by data that's included in the request. + # For both labels and data, content is namespaced by the top-level fields. + # The `update_profile_data` global privilege grants privileges for updating only the allowed namespaces. + # + # @option arguments [String] :uid A unique identifier for the user profile. (*Required*) + # @option arguments [Integer] :if_seq_no Only perform the operation if the document has this sequence number. + # @option arguments [Integer] :if_primary_term Only perform the operation if the document has this primary term. + # @option arguments [String] :refresh If 'true', Elasticsearch refreshes the affected shards to make this operation + # visible to search. + # If 'wait_for', it waits for a refresh to make this operation visible to search. + # If 'false', nothing is done with refreshes. Server default: false. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. + # @option arguments [Hash] :headers Custom HTTP headers + # @option arguments [Hash] :body request body + # + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-update-user-profile-data + # + def update_user_profile_data(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'security.update_user_profile_data' } + + defined_params = [:uid].each_with_object({}) do |variable, set_variables| + set_variables[variable] = arguments[variable] if arguments.key?(variable) + end + request_opts[:defined_params] = defined_params unless defined_params.empty? + + raise ArgumentError, "Required argument 'body' missing" unless arguments[:body] + raise ArgumentError, "Required argument 'uid' missing" unless arguments[:uid] + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = arguments.delete(:body) + + _uid = arguments.delete(:uid) + + method = Elasticsearch::API::HTTP_PUT + path = "_security/profile/#{Utils.listify(_uid)}/_data" + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/simulate/ingest.rb b/elasticsearch-api/lib/elasticsearch/api/actions/simulate/ingest.rb index 19ee6beeed..49289b286a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/simulate/ingest.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/simulate/ingest.rb @@ -15,25 +15,51 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Simulate module Actions - # Simulates running ingest with example documents. + # Simulate data ingestion. + # Run ingest pipelines against a set of provided documents, optionally with substitute pipeline definitions, to simulate ingesting data into an index. + # This API is meant to be used for troubleshooting or pipeline development, as it does not actually index any data into Elasticsearch. + # The API runs the default and final pipeline for that index against a set of documents provided in the body of the request. + # If a pipeline contains a reroute processor, it follows that reroute processor to the new index, running that index's pipelines as well the same way that a non-simulated ingest would. + # No data is indexed into Elasticsearch. + # Instead, the transformed document is returned, along with the list of pipelines that have been run and the name of the index where the document would have been indexed if this were not a simulation. + # The transformed document is validated against the mappings that would apply to this index, and any validation error is reported in the result. + # This API differs from the simulate pipeline API in that you specify a single pipeline for that API, and it runs only that one pipeline. + # The simulate pipeline API is more useful for developing a single pipeline, while the simulate ingest API is more useful for troubleshooting the interaction of the various pipelines that get applied when ingesting into an index. + # By default, the pipeline definitions that are currently in the system are used. + # However, you can supply substitute pipeline definitions in the body of the request. + # These will be used in place of the pipeline definitions that are already in the system. This can be used to replace existing pipeline definitions or to create new ones. The pipeline substitutions are used only within this request. # 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] :index Default index for docs which don't provide one - # @option arguments [String] :pipeline The pipeline id to preprocess incoming documents with if no pipeline is given for a particular document + # @option arguments [String] :index The index to simulate ingesting into. + # This value can be overridden by specifying an index on each document. + # If you specify this parameter in the request path, it is used for any documents that do not explicitly specify an index argument. + # @option arguments [String] :pipeline The pipeline to use as the default pipeline. + # This value can be used to override the default pipeline of the index. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The simulate definition (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/simulate-ingest-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-simulate-ingest # def ingest(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'simulate.ingest' } @@ -48,13 +74,13 @@ def ingest(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_POST path = if _index - "_ingest/#{Utils.__listify(_index)}/_simulate" + "_ingest/#{Utils.listify(_index)}/_simulate" else '_ingest/_simulate' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb index dfc7b63c8c..a4e0f9b230 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb @@ -15,21 +15,37 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Snapshot module Actions - # Removes stale data from repository. + # Clean up the snapshot repository. + # Trigger the review of the contents of a snapshot repository and delete any stale data not referenced by existing snapshots. # - # @option arguments [String] :repository A repository name - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [Time] :timeout Explicit operation timeout + # @option arguments [String] :repository The name of the snapshot repository to clean up. (*Required*) + # @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 indicate that the request should never timeout, set it to `-1` Server default: 30s. + # @option arguments [Time] :timeout The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. + # If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. + # To indicate that the request should never timeout, set it to `-1`. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/clean-up-snapshot-repo-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-cleanup-repository # def cleanup_repository(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'snapshot.cleanup_repository' } @@ -49,7 +65,7 @@ def cleanup_repository(arguments = {}) _repository = arguments.delete(:repository) method = Elasticsearch::API::HTTP_POST - path = "_snapshot/#{Utils.__listify(_repository)}/_cleanup" + path = "_snapshot/#{Utils.listify(_repository)}/_cleanup" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/clone.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/clone.rb index 4771ebf213..8c8ff4768b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/clone.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/clone.rb @@ -15,28 +15,42 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Snapshot module Actions - # Clones indices from one snapshot into another snapshot in the same repository. + # Clone a snapshot. + # Clone part of all of a snapshot into another snapshot in the same repository. # - # @option arguments [String] :repository A repository name - # @option arguments [String] :snapshot The name of the snapshot to clone from - # @option arguments [String] :target_snapshot The name of the cloned snapshot to create - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node + # @option arguments [String] :repository The name of the snapshot repository that both source and target snapshot belong to. (*Required*) + # @option arguments [String] :snapshot The source snapshot name. (*Required*) + # @option arguments [String] :target_snapshot The target snapshot name. (*Required*) + # @option arguments [Time] :master_timeout The period to wait for the master node. + # If the master node is not available before the timeout expires, the request fails and returns an error. + # To indicate that the request should never timeout, set it to `-1`. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The snapshot clone definition (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-clone # def clone(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'snapshot.clone' } - defined_params = %i[repository snapshot target_snapshot].each_with_object({}) do |variable, set_variables| + defined_params = [:repository, :snapshot, :target_snapshot].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -58,7 +72,7 @@ def clone(arguments = {}) _target_snapshot = arguments.delete(:target_snapshot) method = Elasticsearch::API::HTTP_PUT - path = "_snapshot/#{Utils.__listify(_repository)}/#{Utils.__listify(_snapshot)}/_clone/#{Utils.__listify(_target_snapshot)}" + path = "_snapshot/#{Utils.listify(_repository)}/#{Utils.listify(_snapshot)}/_clone/#{Utils.listify(_target_snapshot)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create.rb index 7b6e01d725..4ebd6711b1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create.rb @@ -15,28 +15,44 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Snapshot module Actions - # Creates a snapshot in a repository. + # Create a snapshot. + # Take a snapshot of a cluster or of data streams and indices. # - # @option arguments [String] :repository A repository name - # @option arguments [String] :snapshot A snapshot name - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning + # @option arguments [String] :repository The name of the repository for the snapshot. (*Required*) + # @option arguments [String] :snapshot The name of the snapshot. + # It supportes date math. + # It must be unique in the repository. (*Required*) + # @option arguments [Time] :master_timeout The 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. + # @option arguments [Boolean] :wait_for_completion If `true`, the request returns a response when the snapshot is complete. + # If `false`, the request returns a response when the snapshot initializes. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The snapshot definition + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-create # def create(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'snapshot.create' } - defined_params = %i[repository snapshot].each_with_object({}) do |variable, set_variables| + defined_params = [:repository, :snapshot].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -54,7 +70,7 @@ def create(arguments = {}) _snapshot = arguments.delete(:snapshot) method = Elasticsearch::API::HTTP_PUT - path = "_snapshot/#{Utils.__listify(_repository)}/#{Utils.__listify(_snapshot)}" + path = "_snapshot/#{Utils.listify(_repository)}/#{Utils.listify(_snapshot)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create_repository.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create_repository.rb index aa94f85ffe..bbf84f6a7d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create_repository.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/create_repository.rb @@ -15,23 +15,45 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Snapshot module Actions - # Creates a repository. + # Create or update a snapshot repository. + # IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters. + # To register a snapshot repository, the cluster's global metadata must be writeable. + # Ensure there are no cluster blocks (for example, `cluster.blocks.read_only` and `clsuter.blocks.read_only_allow_delete` settings) that prevent write access. + # Several options for this API can be specified using a query parameter or a request body parameter. + # If both parameters are specified, only the query parameter is used. # - # @option arguments [String] :repository A repository name - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Boolean] :verify Whether to verify the repository after creation + # @option arguments [String] :repository The name of the snapshot repository to register or update. (*Required*) + # @option arguments [Time] :master_timeout The period to wait for the master node. + # If the master node is not available before the timeout expires, the request fails and returns an error. + # To indicate that the request should never timeout, set it to `-1`. Server default: 30s. + # @option arguments [Time] :timeout The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. + # If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. + # To indicate that the request should never timeout, set it to `-1`. Server default: 30s. + # @option arguments [Boolean] :verify If `true`, the request verifies the repository is functional on all master and data nodes in the cluster. + # If `false`, this verification is skipped. + # You can also perform this verification with the verify snapshot repository API. Server default: true. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The repository definition (*Required*) + # @option arguments [Hash] :body repository # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-create-repository # def create_repository(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'snapshot.create_repository' } @@ -52,7 +74,7 @@ def create_repository(arguments = {}) _repository = arguments.delete(:repository) method = Elasticsearch::API::HTTP_PUT - path = "_snapshot/#{Utils.__listify(_repository)}" + path = "_snapshot/#{Utils.listify(_repository)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete.rb index 3489aad395..3cdea51341 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete.rb @@ -15,27 +15,42 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Snapshot module Actions - # Deletes one or more snapshots. + # Delete snapshots. # - # @option arguments [String] :repository A repository name - # @option arguments [List] :snapshot A comma-separated list of snapshot names - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning + # @option arguments [String] :repository The name of the repository to delete a snapshot from. (*Required*) + # @option arguments [String] :snapshot A comma-separated list of snapshot names to delete. + # It also accepts wildcards (`*`). (*Required*) + # @option arguments [Time] :master_timeout The period to wait for the master node. + # If the master node is not available before the timeout expires, the request fails and returns an error. + # To indicate that the request should never timeout, set it to `-1`. Server default: 30s. + # @option arguments [Boolean] :wait_for_completion If `true`, the request returns a response when the matching snapshots are all deleted. + # If `false`, the request returns a response as soon as the deletes are scheduled. Server default: true. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-delete # def delete(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'snapshot.delete' } - defined_params = %i[repository snapshot].each_with_object({}) do |variable, set_variables| + defined_params = [:repository, :snapshot].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -53,11 +68,11 @@ def delete(arguments = {}) _snapshot = arguments.delete(:snapshot) method = Elasticsearch::API::HTTP_DELETE - path = "_snapshot/#{Utils.__listify(_repository)}/#{Utils.__listify(_snapshot)}" + path = "_snapshot/#{Utils.listify(_repository)}/#{Utils.listify(_snapshot)}" params = Utils.process_params(arguments) if Array(arguments[:ignore]).include?(404) - Utils.__rescue_from_not_found do + Utils.rescue_from_not_found do Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete_repository.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete_repository.rb index c6168a3ff7..b9254b17ac 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete_repository.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/delete_repository.rb @@ -15,21 +15,39 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Snapshot module Actions - # Deletes a repository. + # Delete snapshot repositories. + # When a repository is unregistered, Elasticsearch removes only the reference to the location where the repository is storing the snapshots. + # The snapshots themselves are left untouched and in place. # - # @option arguments [List] :repository Name of the snapshot repository to unregister. Wildcard (`*`) patterns are supported. - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [Time] :timeout Explicit operation timeout + # @option arguments [String, Array] :repository The ame of the snapshot repositories to unregister. + # Wildcard (`*`) patterns are supported. (*Required*) + # @option arguments [Time] :master_timeout The period to wait for the master node. + # If the master node is not available before the timeout expires, the request fails and returns an error. + # To indicate that the request should never timeout, set it to `-1`. Server default: 30s. + # @option arguments [Time] :timeout The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. + # If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. + # To indicate that the request should never timeout, set it to `-1`. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-delete-repository # def delete_repository(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'snapshot.delete_repository' } @@ -49,11 +67,11 @@ def delete_repository(arguments = {}) _repository = arguments.delete(:repository) method = Elasticsearch::API::HTTP_DELETE - path = "_snapshot/#{Utils.__listify(_repository)}" + path = "_snapshot/#{Utils.listify(_repository)}" params = Utils.process_params(arguments) if Array(arguments[:ignore]).include?(404) - Utils.__rescue_from_not_found do + Utils.rescue_from_not_found do Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get.rb index fcb5af696b..79e8d2c81a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get.rb @@ -15,38 +15,67 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Snapshot module Actions - # Returns information about a snapshot. + # Get snapshot information. + # NOTE: The `after` parameter and `next` field enable you to iterate through snapshots with some consistency guarantees regarding concurrent creation or deletion of snapshots. + # It is guaranteed that any snapshot that exists at the beginning of the iteration and is not concurrently deleted will be seen during the iteration. + # Snapshots concurrently created may be seen during an iteration. # - # @option arguments [String] :repository A repository name - # @option arguments [List] :snapshot A comma-separated list of snapshot names - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [Boolean] :ignore_unavailable Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown - # @option arguments [Boolean] :index_names Whether to include the name of each index in the snapshot. Defaults to true. - # @option arguments [Boolean] :index_details Whether to include details of each index in the snapshot, if those details are available. Defaults to false. - # @option arguments [Boolean] :include_repository Whether to include the repository name in the snapshot info. Defaults to true. - # @option arguments [String] :sort Allows setting a sort order for the result. Defaults to start_time (options: start_time, duration, name, repository, index_count, shard_count, failed_shard_count) - # @option arguments [Integer] :size Maximum number of snapshots to return. Defaults to 0 which means return all that match without limit. - # @option arguments [String] :order Sort order (options: asc, desc) - # @option arguments [String] :from_sort_value Value of the current sort column at which to start retrieval. - # @option arguments [String] :after Offset identifier to start pagination from as returned by the 'next' field in the response body. - # @option arguments [Integer] :offset Numeric offset to start pagination based on the snapshots matching the request. Defaults to 0 - # @option arguments [String] :slm_policy_filter Filter snapshots by a comma-separated list of SLM policy names that snapshots belong to. Accepts wildcards. Use the special pattern '_none' to match snapshots without an SLM policy - # @option arguments [Boolean] :verbose Whether to show verbose snapshot info or only show the basic info found in the repository index blob + # @option arguments [String] :repository A comma-separated list of snapshot repository names used to limit the request. + # Wildcard (`*`) expressions are supported. (*Required*) + # @option arguments [String, Array] :snapshot A comma-separated list of snapshot names to retrieve + # Wildcards (`*`) are supported. + # - To get information about all snapshots in a registered repository, use a wildcard (`*`) or `_all`. + # - To get information about any snapshots that are currently running, use `_current`. (*Required*) + # @option arguments [String] :after An offset identifier to start pagination from as returned by the next field in the response body. + # @option arguments [String] :from_sort_value The value of the current sort column at which to start retrieval. + # It can be a string `snapshot-` or a repository name when sorting by snapshot or repository name. + # It can be a millisecond time value or a number when sorting by `index-` or shard count. + # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error for any snapshots that are unavailable. + # @option arguments [Boolean] :index_details If `true`, the response includes additional information about each index in the snapshot comprising the number of shards in the index, the total size of the index in bytes, and the maximum number of segments per shard in the index. + # The default is `false`, meaning that this information is omitted. + # @option arguments [Boolean] :index_names If `true`, the response includes the name of each index in each snapshot. Server default: true. + # @option arguments [Boolean] :include_repository If `true`, the response includes the repository name in each snapshot. Server default: true. + # @option arguments [Time] :master_timeout The 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. + # @option arguments [String] :order The sort order. + # Valid values are `asc` for ascending and `desc` for descending order. + # The default behavior is ascending order. Server default: asc. + # @option arguments [Integer] :offset Numeric offset to start pagination from based on the snapshots matching this request. Using a non-zero value for this parameter is mutually exclusive with using the after parameter. Defaults to 0. Server default: 0. + # @option arguments [Integer] :size The maximum number of snapshots to return. + # The default is 0, which means to return all that match the request without limit. Server default: 0. + # @option arguments [String] :slm_policy_filter Filter snapshots by a comma-separated list of snapshot lifecycle management (SLM) policy names that snapshots belong to.You can use wildcards (`*`) and combinations of wildcards followed by exclude patterns starting with `-`. + # For example, the pattern `*,-policy-a-\*` will return all snapshots except for those that were created by an SLM policy with a name starting with `policy-a-`. + # Note that the wildcard pattern `*` matches all snapshots created by an SLM policy but not those snapshots that were not created by an SLM policy. + # To include snapshots that were not created by an SLM policy, you can use the special pattern `_none` that will match all snapshots without an SLM policy. + # @option arguments [String] :sort The sort order for the result. + # The default behavior is sorting by snapshot start time stamp. Server default: start_time. + # @option arguments [Boolean] :verbose If `true`, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted.NOTE: The parameters `size`, `order`, `after`, `from_sort_value`, `offset`, `slm_policy_filter`, and `sort` are not supported when you set `verbose=false` and the sort order for requests with `verbose=false` is undefined. Server default: true. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-get # def get(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'snapshot.get' } - defined_params = %i[repository snapshot].each_with_object({}) do |variable, set_variables| + defined_params = [:repository, :snapshot].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -64,11 +93,11 @@ def get(arguments = {}) _snapshot = arguments.delete(:snapshot) method = Elasticsearch::API::HTTP_GET - path = "_snapshot/#{Utils.__listify(_repository)}/#{Utils.__listify(_snapshot)}" + path = "_snapshot/#{Utils.listify(_repository)}/#{Utils.listify(_snapshot)}" params = Utils.process_params(arguments) if Array(arguments[:ignore]).include?(404) - Utils.__rescue_from_not_found do + Utils.rescue_from_not_found do Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get_repository.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get_repository.rb index 83f3983f5d..b557285812 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get_repository.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/get_repository.rb @@ -15,21 +15,36 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Snapshot module Actions - # Returns information about a repository. + # Get snapshot repository information. # - # @option arguments [List] :repository A comma-separated list of repository names - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false) + # @option arguments [String, Array] :repository A comma-separated list of snapshot repository names used to limit the request. + # Wildcard (`*`) expressions are supported including combining wildcards with exclude patterns starting with `-`.To get information about all snapshot repositories registered in the cluster, omit this parameter or use `*` or `_all`. + # @option arguments [Boolean] :local If `true`, the request gets information from the local node only. + # If `false`, the request gets information from the master node. + # @option arguments [Time] :master_timeout The period to wait for the master node. + # If the master node is not available before the timeout expires, the request fails and returns an error. + # To indicate that the request should never timeout, set it to `-1`. Server default: to 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-get-repository # def get_repository(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'snapshot.get_repository' } @@ -48,14 +63,14 @@ def get_repository(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _repository - "_snapshot/#{Utils.__listify(_repository)}" + "_snapshot/#{Utils.listify(_repository)}" else '_snapshot' end params = Utils.process_params(arguments) if Array(arguments[:ignore]).include?(404) - Utils.__rescue_from_not_found do + Utils.rescue_from_not_found do Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb index 575313a411..f46df4240a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb @@ -15,30 +15,122 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Snapshot module Actions - # Analyzes a repository for correctness and performance + # Analyze a snapshot repository. + # Analyze the performance characteristics and any incorrect behaviour found in a repository. + # The response exposes implementation details of the analysis which may change from version to version. + # The response body format is therefore not considered stable and may be different in newer versions. + # There are a large number of third-party storage systems available, not all of which are suitable for use as a snapshot repository by Elasticsearch. + # Some storage systems behave incorrectly, or perform poorly, especially when accessed concurrently by multiple clients as the nodes of an Elasticsearch cluster do. This API performs a collection of read and write operations on your repository which are designed to detect incorrect behaviour and to measure the performance characteristics of your storage system. + # The default values for the parameters are deliberately low to reduce the impact of running an analysis inadvertently and to provide a sensible starting point for your investigations. + # Run your first analysis with the default parameter values to check for simple problems. + # If successful, run a sequence of increasingly large analyses until you encounter a failure or you reach a `blob_count` of at least `2000`, a `max_blob_size` of at least `2gb`, a `max_total_data_size` of at least `1tb`, and a `register_operation_count` of at least `100`. + # Always specify a generous timeout, possibly `1h` or longer, to allow time for each analysis to run to completion. + # Perform the analyses using a multi-node cluster of a similar size to your production cluster so that it can detect any problems that only arise when the repository is accessed by many nodes at once. + # If the analysis fails, Elasticsearch detected that your repository behaved unexpectedly. + # This usually means you are using a third-party storage system with an incorrect or incompatible implementation of the API it claims to support. + # If so, this storage system is not suitable for use as a snapshot repository. + # You will need to work with the supplier of your storage system to address the incompatibilities that Elasticsearch detects. + # If the analysis is successful, the API returns details of the testing process, optionally including how long each operation took. + # You can use this information to determine the performance of your storage system. + # If any operation fails or returns an incorrect result, the API returns an error. + # If the API returns an error, it may not have removed all the data it wrote to the repository. + # The error will indicate the location of any leftover data and this path is also recorded in the Elasticsearch logs. + # You should verify that this location has been cleaned up correctly. + # If there is still leftover data at the specified location, you should manually remove it. + # If the connection from your client to Elasticsearch is closed while the client is waiting for the result of the analysis, the test is cancelled. + # Some clients are configured to close their connection if no response is received within a certain timeout. + # An analysis takes a long time to complete so you might need to relax any such client-side timeouts. + # On cancellation the analysis attempts to clean up the data it was writing, but it may not be able to remove it all. + # The path to the leftover data is recorded in the Elasticsearch logs. + # You should verify that this location has been cleaned up correctly. + # If there is still leftover data at the specified location, you should manually remove it. + # If the analysis is successful then it detected no incorrect behaviour, but this does not mean that correct behaviour is guaranteed. + # The analysis attempts to detect common bugs but it does not offer 100% coverage. + # Additionally, it does not test the following: + # * Your repository must perform durable writes. Once a blob has been written it must remain in place until it is deleted, even after a power loss or similar disaster. + # * Your repository must not suffer from silent data corruption. Once a blob has been written, its contents must remain unchanged until it is deliberately modified or deleted. + # * Your repository must behave correctly even if connectivity from the cluster is disrupted. Reads and writes may fail in this case, but they must not return incorrect results. + # IMPORTANT: An analysis writes a substantial amount of data to your repository and then reads it back again. + # This consumes bandwidth on the network between the cluster and the repository, and storage space and I/O bandwidth on the repository itself. + # You must ensure this load does not affect other users of these systems. + # Analyses respect the repository settings `max_snapshot_bytes_per_sec` and `max_restore_bytes_per_sec` if available and the cluster setting `indices.recovery.max_bytes_per_sec` which you can use to limit the bandwidth they consume. + # NOTE: This API is intended for exploratory use by humans. You should expect the request parameters and the response format to vary in future versions. + # NOTE: Different versions of Elasticsearch may perform different checks for repository compatibility, with newer versions typically being stricter than older ones. + # A storage system that passes repository analysis with one version of Elasticsearch may fail with a different version. + # This indicates it behaves incorrectly in ways that the former version did not detect. + # You must work with the supplier of your storage system to address the incompatibilities detected by the repository analysis API in any version of Elasticsearch. + # NOTE: This API may not work correctly in a mixed-version cluster. + # *Implementation details* + # NOTE: This section of documentation describes how the repository analysis API works in this version of Elasticsearch, but you should expect the implementation to vary between versions. The request parameters and response format depend on details of the implementation so may also be different in newer versions. + # The analysis comprises a number of blob-level tasks, as set by the `blob_count` parameter and a number of compare-and-exchange operations on linearizable registers, as set by the `register_operation_count` parameter. + # These tasks are distributed over the data and master-eligible nodes in the cluster for execution. + # For most blob-level tasks, the executing node first writes a blob to the repository and then instructs some of the other nodes in the cluster to attempt to read the data it just wrote. + # The size of the blob is chosen randomly, according to the `max_blob_size` and `max_total_data_size` parameters. + # If any of these reads fails then the repository does not implement the necessary read-after-write semantics that Elasticsearch requires. + # For some blob-level tasks, the executing node will instruct some of its peers to attempt to read the data before the writing process completes. + # These reads are permitted to fail, but must not return partial data. + # If any read returns partial data then the repository does not implement the necessary atomicity semantics that Elasticsearch requires. + # For some blob-level tasks, the executing node will overwrite the blob while its peers are reading it. + # In this case the data read may come from either the original or the overwritten blob, but the read operation must not return partial data or a mix of data from the two blobs. + # If any of these reads returns partial data or a mix of the two blobs then the repository does not implement the necessary atomicity semantics that Elasticsearch requires for overwrites. + # The executing node will use a variety of different methods to write the blob. + # For instance, where applicable, it will use both single-part and multi-part uploads. + # Similarly, the reading nodes will use a variety of different methods to read the data back again. + # For instance they may read the entire blob from start to end or may read only a subset of the data. + # For some blob-level tasks, the executing node will cancel the write before it is complete. + # In this case, it still instructs some of the other nodes in the cluster to attempt to read the blob but all of these reads must fail to find the blob. + # Linearizable registers are special blobs that Elasticsearch manipulates using an atomic compare-and-exchange operation. + # This operation ensures correct and strongly-consistent behavior even when the blob is accessed by multiple nodes at the same time. + # The detailed implementation of the compare-and-exchange operation on linearizable registers varies by repository type. + # Repository analysis verifies that that uncontended compare-and-exchange operations on a linearizable register blob always succeed. + # Repository analysis also verifies that contended operations either succeed or report the contention but do not return incorrect results. + # If an operation fails due to contention, Elasticsearch retries the operation until it succeeds. + # Most of the compare-and-exchange operations performed by repository analysis atomically increment a counter which is represented as an 8-byte blob. + # Some operations also verify the behavior on small blobs with sizes other than 8 bytes. # - # @option arguments [String] :repository A repository name - # @option arguments [Number] :blob_count Number of blobs to create during the test. Defaults to 100. - # @option arguments [Number] :concurrency Number of operations to run concurrently during the test. Defaults to 10. - # @option arguments [Number] :read_node_count Number of nodes on which to read a blob after writing. Defaults to 10. - # @option arguments [Number] :early_read_node_count Number of nodes on which to perform an early read on a blob, i.e. before writing has completed. Early reads are rare actions so the 'rare_action_probability' parameter is also relevant. Defaults to 2. - # @option arguments [Number] :seed Seed for the random number generator used to create the test workload. Defaults to a random value. - # @option arguments [Number] :rare_action_probability Probability of taking a rare action such as an early read or an overwrite. Defaults to 0.02. - # @option arguments [String] :max_blob_size Maximum size of a blob to create during the test, e.g '1gb' or '100mb'. Defaults to '10mb'. - # @option arguments [String] :max_total_data_size Maximum total size of all blobs to create during the test, e.g '1tb' or '100gb'. Defaults to '1gb'. - # @option arguments [Time] :timeout Explicit operation timeout. Defaults to '30s'. - # @option arguments [Boolean] :detailed Whether to return detailed results or a summary. Defaults to 'false' so that only the summary is returned. - # @option arguments [Boolean] :rarely_abort_writes Whether to rarely abort writes before they complete. Defaults to 'true'. + # @option arguments [String] :repository The name of the repository. (*Required*) + # @option arguments [Integer] :blob_count The total number of blobs to write to the repository during the test. + # For realistic experiments, you should set it to at least `2000`. Server default: 100. + # @option arguments [Integer] :concurrency The number of operations to run concurrently during the test. Server default: 10. + # @option arguments [Boolean] :detailed Indicates whether to return detailed results, including timing information for every operation performed during the analysis. + # If false, it returns only a summary of the analysis. + # @option arguments [Integer] :early_read_node_count The number of nodes on which to perform an early read operation while writing each blob. + # Early read operations are only rarely performed. Server default: 2. + # @option arguments [Integer, String] :max_blob_size The maximum size of a blob to be written during the test. + # For realistic experiments, you should set it to at least `2gb`. Server default: 10mb. + # @option arguments [Integer, String] :max_total_data_size An upper limit on the total size of all the blobs written during the test. + # For realistic experiments, you should set it to at least `1tb`. Server default: 1gb. + # @option arguments [Float] :rare_action_probability The probability of performing a rare action such as an early read, an overwrite, or an aborted write on each blob. Server default: 0.02. + # @option arguments [Boolean] :rarely_abort_writes Indicates whether to rarely cancel writes before they complete. Server default: true. + # @option arguments [Integer] :read_node_count The number of nodes on which to read a blob after writing. Server default: 10. + # @option arguments [Integer] :register_operation_count The minimum number of linearizable register operations to perform in total. + # For realistic experiments, you should set it to at least `100`. Server default: 10. + # @option arguments [Integer] :seed The seed for the pseudo-random number generator used to generate the list of operations performed during the test. + # To repeat the same set of operations in multiple experiments, use the same seed in each experiment. + # Note that the operations are performed concurrently so might not always happen in the same order on each run. + # @option arguments [Time] :timeout The period of time to wait for the test to complete. + # If no response is received before the timeout expires, the test is cancelled and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-repository-analyze # def repository_analyze(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'snapshot.repository_analyze' } @@ -58,7 +150,7 @@ def repository_analyze(arguments = {}) _repository = arguments.delete(:repository) method = Elasticsearch::API::HTTP_POST - path = "_snapshot/#{Utils.__listify(_repository)}/_analyze" + path = "_snapshot/#{Utils.listify(_repository)}/_analyze" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/restore.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/restore.rb index 02e05a2114..7f7c947e10 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/restore.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/restore.rb @@ -15,28 +15,56 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Snapshot module Actions - # Restores a snapshot. + # Restore a snapshot. + # Restore a snapshot of a cluster or data streams and indices. + # You can restore a snapshot only to a running cluster with an elected master node. + # The snapshot repository must be registered and available to the cluster. + # The snapshot and cluster versions must be compatible. + # To restore a snapshot, the cluster's global metadata must be writable. Ensure there are't any cluster blocks that prevent writes. The restore operation ignores index blocks. + # Before you restore a data stream, ensure the cluster contains a matching index template with data streams enabled. To check, use the index management feature in Kibana or the get index template API: + # + # ``` + # GET _index_template/*?filter_path=index_templates.name,index_templates.index_template.index_patterns,index_templates.index_template.data_stream + # ``` + # + # If no such template exists, you can create one or restore a cluster state that contains one. Without a matching index template, a data stream can't roll over or create backing indices. + # If your snapshot contains data from App Search or Workplace Search, you must restore the Enterprise Search encryption key before you restore the snapshot. # - # @option arguments [String] :repository A repository name - # @option arguments [String] :snapshot A snapshot name - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [Boolean] :wait_for_completion Should this request wait until the operation has completed before returning + # @option arguments [String] :repository The name of the repository to restore a snapshot from. (*Required*) + # @option arguments [String] :snapshot The name of the snapshot to restore. (*Required*) + # @option arguments [Time] :master_timeout The period to wait for the master node. + # If the master node is not available before the timeout expires, the request fails and returns an error. + # To indicate that the request should never timeout, set it to `-1`. Server default: 30s. + # @option arguments [Boolean] :wait_for_completion If `true`, the request returns a response when the restore operation completes. + # The operation is complete when it finishes all attempts to recover primary shards for restored indices. + # This applies even if one or more of the recovery attempts fail.If `false`, the request returns a response when the restore operation initializes. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body Details of what to restore + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-restore # def restore(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'snapshot.restore' } - defined_params = %i[repository snapshot].each_with_object({}) do |variable, set_variables| + defined_params = [:repository, :snapshot].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -54,7 +82,7 @@ def restore(arguments = {}) _snapshot = arguments.delete(:snapshot) method = Elasticsearch::API::HTTP_POST - path = "_snapshot/#{Utils.__listify(_repository)}/#{Utils.__listify(_snapshot)}/_restore" + path = "_snapshot/#{Utils.listify(_repository)}/#{Utils.listify(_snapshot)}/_restore" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/status.rb index d6fa97d5ea..81c5bc4a52 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/status.rb @@ -15,27 +15,55 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Snapshot module Actions - # Returns information about the status of a snapshot. + # Get the snapshot status. + # Get a detailed description of the current state for each shard participating in the snapshot. + # Note that this API should be used only to obtain detailed shard-level information for ongoing snapshots. + # If this detail is not needed or you want to obtain information about one or more existing snapshots, use the get snapshot API. + # If you omit the `` request path parameter, the request retrieves information only for currently running snapshots. + # This usage is preferred. + # If needed, you can specify `` and `` to retrieve information for specific snapshots, even if they're not currently running. + # WARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive. + # The API requires a read from the repository for each shard in each snapshot. + # For example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards). + # Depending on the latency of your storage, such requests can take an extremely long time to return results. + # These requests can also tax machine resources and, when using cloud storage, incur high processing costs. # - # @option arguments [String] :repository A repository name - # @option arguments [List] :snapshot A comma-separated list of snapshot names - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [Boolean] :ignore_unavailable Whether to ignore unavailable snapshots, defaults to false which means a SnapshotMissingException is thrown + # @option arguments [String] :repository The snapshot repository name used to limit the request. + # It supports wildcards (`*`) if `` isn't specified. + # @option arguments [String, Array] :snapshot A comma-separated list of snapshots to retrieve status for. + # The default is currently running snapshots. + # Wildcards (`*`) are not supported. + # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error for any snapshots that are unavailable. + # If `true`, the request ignores snapshots that are unavailable, such as those that are corrupted or temporarily cannot be returned. + # @option arguments [Time] :master_timeout The period to wait for the master node. + # If the master node is not available before the timeout expires, the request fails and returns an error. + # To indicate that the request should never timeout, set it to `-1`. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-status # def status(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'snapshot.status' } - defined_params = %i[repository snapshot].each_with_object({}) do |variable, set_variables| + defined_params = [:repository, :snapshot].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -51,16 +79,16 @@ def status(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _repository && _snapshot - "_snapshot/#{Utils.__listify(_repository)}/#{Utils.__listify(_snapshot)}/_status" + "_snapshot/#{Utils.listify(_repository)}/#{Utils.listify(_snapshot)}/_status" elsif _repository - "_snapshot/#{Utils.__listify(_repository)}/_status" + "_snapshot/#{Utils.listify(_repository)}/_status" else '_snapshot/_status' end params = Utils.process_params(arguments) if Array(arguments[:ignore]).include?(404) - Utils.__rescue_from_not_found do + Utils.rescue_from_not_found do Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/verify_repository.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/verify_repository.rb index 335d962d3c..95085b5df1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/verify_repository.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot/verify_repository.rb @@ -15,21 +15,37 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Snapshot module Actions - # Verifies a repository. + # Verify a snapshot repository. + # Check for common misconfigurations in a snapshot repository. # - # @option arguments [String] :repository A repository name - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [Time] :timeout Explicit operation timeout + # @option arguments [String] :repository The name of the snapshot repository to verify. (*Required*) + # @option arguments [Time] :master_timeout The period to wait for the master node. + # If the master node is not available before the timeout expires, the request fails and returns an error. + # To indicate that the request should never timeout, set it to `-1`. Server default: 30s. + # @option arguments [Time] :timeout The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. + # If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. + # To indicate that the request should never timeout, set it to `-1`. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-verify-repository # def verify_repository(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'snapshot.verify_repository' } @@ -49,7 +65,7 @@ def verify_repository(arguments = {}) _repository = arguments.delete(:repository) method = Elasticsearch::API::HTTP_POST - path = "_snapshot/#{Utils.__listify(_repository)}/_verify" + path = "_snapshot/#{Utils.listify(_repository)}/_verify" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/delete_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/delete_lifecycle.rb index 96088812ca..3da24ea788 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/delete_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/delete_lifecycle.rb @@ -15,21 +15,36 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module SnapshotLifecycleManagement module Actions - # Deletes an existing snapshot lifecycle policy. + # Delete a policy. + # Delete a snapshot lifecycle policy definition. + # This operation prevents any future snapshots from being taken but does not cancel in-progress snapshots or remove previously-taken snapshots. # - # @option arguments [String] :policy_id The id of the snapshot lifecycle policy to remove - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [Time] :timeout Explicit operation timeout + # @option arguments [String] :policy_id The id of the snapshot lifecycle policy to remove (*Required*) + # @option arguments [Time] :master_timeout The 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. + # @option arguments [Time] :timeout The period to wait for a response. + # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-delete-policy.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-delete-lifecycle # def delete_lifecycle(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'slm.delete_lifecycle' } @@ -49,7 +64,7 @@ def delete_lifecycle(arguments = {}) _policy_id = arguments.delete(:policy_id) method = Elasticsearch::API::HTTP_DELETE - path = "_slm/policy/#{Utils.__listify(_policy_id)}" + path = "_slm/policy/#{Utils.listify(_policy_id)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_lifecycle.rb index de3210fc9a..515b45c3b1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_lifecycle.rb @@ -15,21 +15,36 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module SnapshotLifecycleManagement module Actions - # Immediately creates a snapshot according to the lifecycle policy, without waiting for the scheduled time. + # Run a policy. + # Immediately create a snapshot according to the snapshot lifecycle policy without waiting for the scheduled time. + # The snapshot policy is normally applied according to its schedule, but you might want to manually run a policy before performing an upgrade or other maintenance. # - # @option arguments [String] :policy_id The id of the snapshot lifecycle policy to be executed - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [Time] :timeout Explicit operation timeout + # @option arguments [String] :policy_id The id of the snapshot lifecycle policy to be executed (*Required*) + # @option arguments [Time] :master_timeout The 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. + # @option arguments [Time] :timeout The period to wait for a response. + # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-lifecycle.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-execute-lifecycle # def execute_lifecycle(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'slm.execute_lifecycle' } @@ -49,7 +64,7 @@ def execute_lifecycle(arguments = {}) _policy_id = arguments.delete(:policy_id) method = Elasticsearch::API::HTTP_PUT - path = "_slm/policy/#{Utils.__listify(_policy_id)}/_execute" + path = "_slm/policy/#{Utils.listify(_policy_id)}/_execute" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_retention.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_retention.rb index 6a16a045ef..acfd9a04eb 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_retention.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_retention.rb @@ -15,20 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module SnapshotLifecycleManagement module Actions - # Deletes any snapshots that are expired according to the policy's retention rules. + # Run a retention policy. + # Manually apply the retention policy to force immediate removal of snapshots that are expired according to the snapshot lifecycle policy retention rules. + # The retention policy is normally applied according to its schedule. # - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [Time] :timeout Explicit operation timeout + # @option arguments [Time] :master_timeout The 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. + # @option arguments [Time] :timeout The period to wait for a response. + # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-execute-retention.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-execute-retention # def execute_retention(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'slm.execute_retention' } @@ -36,7 +51,7 @@ def execute_retention(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_POST path = '_slm/_execute_retention' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_lifecycle.rb index a697d0624f..7acea89d98 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_lifecycle.rb @@ -15,21 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module SnapshotLifecycleManagement module Actions - # Retrieves one or more snapshot lifecycle policy definitions and information about the latest snapshot attempts. + # Get policy information. + # Get snapshot lifecycle policy definitions and information about the latest snapshot attempts. # - # @option arguments [List] :policy_id Comma-separated list of snapshot lifecycle policies to retrieve - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [Time] :timeout Explicit operation timeout + # @option arguments [String, Array] :policy_id Comma-separated list of snapshot lifecycle policies to retrieve + # @option arguments [Time] :master_timeout The 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. + # @option arguments [Time] :timeout The period to wait for a response. + # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-policy.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-get-lifecycle # def get_lifecycle(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'slm.get_lifecycle' } @@ -48,7 +62,7 @@ def get_lifecycle(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _policy_id - "_slm/policy/#{Utils.__listify(_policy_id)}" + "_slm/policy/#{Utils.listify(_policy_id)}" else '_slm/policy' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_stats.rb index 2a80670fa1..f0f4b2461c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_stats.rb @@ -15,20 +15,32 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module SnapshotLifecycleManagement module Actions - # Returns global and policy-level statistics about actions taken by snapshot lifecycle management. + # Get snapshot lifecycle management statistics. + # Get global and policy-level statistics about actions taken by snapshot lifecycle management. # - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [Time] :timeout Explicit operation timeout + # @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. + # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-stats.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-get-stats # def get_stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'slm.get_stats' } @@ -36,7 +48,7 @@ def get_stats(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_slm/stats' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_status.rb index 5e2172e4c2..a0d8a8f016 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_status.rb @@ -15,20 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module SnapshotLifecycleManagement module Actions - # Retrieves the status of snapshot lifecycle management (SLM). + # Get the snapshot lifecycle management status. # - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [Time] :timeout Explicit operation timeout + # @option arguments [Time] :master_timeout The 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. + # To indicate that the request should never timeout, set it to `-1`. Server default: 30s. + # @option arguments [Time] :timeout The period to wait for a response. + # If no response is received before the timeout expires, the request fails and returns an error. + # To indicate that the request should never timeout, set it to `-1`. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-get-status.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-get-status # def get_status(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'slm.get_status' } @@ -36,7 +51,7 @@ def get_status(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_slm/status' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/put_lifecycle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/put_lifecycle.rb index 23e3d41bda..0475721e29 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/put_lifecycle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/put_lifecycle.rb @@ -15,22 +15,40 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module SnapshotLifecycleManagement module Actions - # Creates or updates a snapshot lifecycle policy. + # Create or update a policy. + # Create or update a snapshot lifecycle policy. + # If the policy already exists, this request increments the policy version. + # Only the latest version of a policy is stored. # - # @option arguments [String] :policy_id The id of the snapshot lifecycle policy - # @option arguments [Time] :master_timeout Explicit operation timeout for connection to master node - # @option arguments [Time] :timeout Explicit operation timeout + # @option arguments [String] :policy_id The identifier for the snapshot lifecycle policy you want to create or update. (*Required*) + # @option arguments [Time] :master_timeout The 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. + # To indicate that the request should never timeout, set it to `-1`. Server default: 30s. + # @option arguments [Time] :timeout The period to wait for a response. + # If no response is received before the timeout expires, the request fails and returns an error. + # To indicate that the request should never timeout, set it to `-1`. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The snapshot lifecycle policy definition to register + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-put-policy.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-put-lifecycle # def put_lifecycle(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'slm.put_lifecycle' } @@ -50,7 +68,7 @@ def put_lifecycle(arguments = {}) _policy_id = arguments.delete(:policy_id) method = Elasticsearch::API::HTTP_PUT - path = "_slm/policy/#{Utils.__listify(_policy_id)}" + path = "_slm/policy/#{Utils.listify(_policy_id)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/start.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/start.rb index 7e5a1d73bf..2b9a482cba 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/start.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/start.rb @@ -15,20 +15,37 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module SnapshotLifecycleManagement module Actions - # Turns on snapshot lifecycle management (SLM). + # Start snapshot lifecycle management. + # Snapshot lifecycle management (SLM) starts automatically when a cluster is formed. + # Manually starting SLM is necessary only if it has been stopped using the stop SLM API. # - # @option arguments [Time] :master_timeout Timeout for processing on master node - # @option arguments [Time] :timeout Timeout for acknowledgement of update from all nodes in cluster + # @option arguments [Time] :master_timeout The 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. + # To indicate that the request should never timeout, set it to `-1`. Server default: 30s. + # @option arguments [Time] :timeout The period to wait for a response. + # If no response is received before the timeout expires, the request fails and returns an error. + # To indicate that the request should never timeout, set it to `-1`. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-start.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-start # def start(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'slm.start' } @@ -36,7 +53,7 @@ def start(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_POST path = '_slm/start' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/stop.rb b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/stop.rb index d5dbab1d1e..daa3f39b9b 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/stop.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/snapshot_lifecycle_management/stop.rb @@ -15,20 +15,41 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module SnapshotLifecycleManagement module Actions - # Turns off snapshot lifecycle management (SLM). + # Stop snapshot lifecycle management. + # Stop all snapshot lifecycle management (SLM) operations and the SLM plugin. + # This API is useful when you are performing maintenance on a cluster and need to prevent SLM from performing any actions on your data streams or indices. + # Stopping SLM does not stop any snapshots that are in progress. + # You can manually trigger snapshots with the run snapshot lifecycle policy API even if SLM is stopped. + # The API returns a response as soon as the request is acknowledged, but the plugin might continue to run until in-progress operations complete and it can be safely stopped. + # Use the get snapshot lifecycle management status API to see if SLM is running. # - # @option arguments [Time] :master_timeout Timeout for processing on master node - # @option arguments [Time] :timeout Timeout for acknowledgement of update from all nodes in cluster + # @option arguments [Time] :master_timeout The 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. + # To indicate that the request should never timeout, set it to `-1`. Server default: 30s. + # @option arguments [Time] :timeout The period to wait for a response. + # If no response is received before the timeout expires, the request fails and returns an error. + # To indicate that the request should never timeout, set it to `-1`. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-stop.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-slm-stop # def stop(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'slm.stop' } @@ -36,7 +57,7 @@ def stop(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_POST path = '_slm/stop' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/sql/clear_cursor.rb b/elasticsearch-api/lib/elasticsearch/api/actions/sql/clear_cursor.rb index c9ff2560fe..101a9e9730 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/sql/clear_cursor.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/sql/clear_cursor.rb @@ -15,19 +15,30 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module SQL module Actions - # Clears the SQL cursor + # Clear an SQL search cursor. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body Specify the cursor value in the `cursor` element to clean the cursor. (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-sql-cursor-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-sql-clear-cursor # def clear_cursor(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'sql.clear_cursor' } @@ -37,11 +48,11 @@ def clear_cursor(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_sql/close' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/sql/delete_async.rb b/elasticsearch-api/lib/elasticsearch/api/actions/sql/delete_async.rb index 06b0b77f9d..3530269720 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/sql/delete_async.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/sql/delete_async.rb @@ -15,19 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module SQL module Actions - # Deletes an async SQL search or a stored synchronous SQL search. If the search is still running, the API cancels it. + # Delete an async SQL search. + # Delete an async SQL search or a stored synchronous SQL search. + # If the search is still running, the API cancels it. + # If the Elasticsearch security features are enabled, only the following users can use this API to delete a search: + # * Users with the `cancel_task` cluster privilege. + # * The user who first submitted the search. # - # @option arguments [String] :id The async search ID + # @option arguments [String] :id The identifier for the search. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-async-sql-search-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-sql-delete-async # def delete_async(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'sql.delete_async' } @@ -47,8 +63,8 @@ def delete_async(arguments = {}) _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_DELETE - path = "_sql/async/delete/#{Utils.__listify(_id)}" - params = {} + path = "_sql/async/delete/#{Utils.listify(_id)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async.rb b/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async.rb index c1eb5685ea..3c0885b5bd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async.rb @@ -15,23 +15,41 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module SQL module Actions - # Returns the current status and available results for an async SQL search or stored synchronous SQL search + # Get async SQL search results. + # Get the current status and available results for an async SQL search or stored synchronous SQL search. + # If the Elasticsearch security features are enabled, only the user who first submitted the SQL search can retrieve the search using this API. # - # @option arguments [String] :id The async search ID - # @option arguments [String] :delimiter Separator for CSV results - # @option arguments [String] :format Short version of the Accept header, e.g. json, yaml - # @option arguments [Time] :keep_alive Retention period for the search and its results - # @option arguments [Time] :wait_for_completion_timeout Duration to wait for complete results + # @option arguments [String] :id The identifier for the search. (*Required*) + # @option arguments [String] :delimiter The separator for CSV results. + # The API supports this parameter only for CSV responses. Server default: ,. + # @option arguments [String] :format The format for the response. + # You must specify a format using this parameter or the `Accept` HTTP header. + # If you specify both, the API uses this parameter. + # @option arguments [Time] :keep_alive The retention period for the search and its results. + # It defaults to the `keep_alive` period for the original SQL search. + # @option arguments [Time] :wait_for_completion_timeout The period to wait for complete results. + # It defaults to no timeout, meaning the request waits for complete search results. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-async-sql-search-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-sql-get-async # def get_async(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'sql.get_async' } @@ -51,7 +69,7 @@ def get_async(arguments = {}) _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_GET - path = "_sql/async/#{Utils.__listify(_id)}" + path = "_sql/async/#{Utils.listify(_id)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async_status.rb b/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async_status.rb index a217d9fdae..6797798d9c 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async_status.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/sql/get_async_status.rb @@ -15,19 +15,31 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module SQL module Actions - # Returns the current status of an async SQL search or a stored synchronous SQL search + # Get the async SQL search status. + # Get the current status of an async SQL search or a stored synchronous SQL search. # - # @option arguments [String] :id The async search ID + # @option arguments [String] :id The identifier for the search. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-async-sql-search-status-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-sql-get-async-status # def get_async_status(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'sql.get_async_status' } @@ -47,8 +59,8 @@ def get_async_status(arguments = {}) _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_GET - path = "_sql/async/status/#{Utils.__listify(_id)}" - params = {} + path = "_sql/async/status/#{Utils.listify(_id)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/sql/query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/sql/query.rb index 7a187a5107..c8c3266074 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/sql/query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/sql/query.rb @@ -15,20 +15,34 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module SQL module Actions - # Executes a SQL request + # Get SQL search results. + # Run an SQL request. # - # @option arguments [String] :format a short version of the Accept header, e.g. json, yaml + # @option arguments [String] :format The format for the response. + # You can also specify a format using the `Accept` HTTP header. + # If you specify both this parameter and the `Accept` HTTP header, this parameter takes precedence. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body Use the `query` element to start a query. Use the `cursor` element to continue a query. (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-search-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-sql-query # def query(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'sql.query' } @@ -38,7 +52,7 @@ def query(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_sql' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/sql/translate.rb b/elasticsearch-api/lib/elasticsearch/api/actions/sql/translate.rb index 1f872caf67..0701f5c0c0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/sql/translate.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/sql/translate.rb @@ -15,19 +15,32 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module SQL module Actions - # Translates SQL into Elasticsearch queries + # Translate SQL into Elasticsearch queries. + # Translate an SQL search into a search API request containing Query DSL. + # It accepts the same request body parameters as the SQL search API, excluding `cursor`. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body Specify the query in the `query` element. (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/sql-translate-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-sql-translate # def translate(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'sql.translate' } @@ -37,11 +50,11 @@ def translate(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_sql/translate' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/ssl/certificates.rb b/elasticsearch-api/lib/elasticsearch/api/actions/ssl/certificates.rb index 004f33c185..5cbf4b2857 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/ssl/certificates.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/ssl/certificates.rb @@ -15,18 +15,39 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module SSL module Actions - # Retrieves information about the X.509 certificates used to encrypt communications in the cluster. + # Get SSL certificates. + # Get information about the X.509 certificates that are used to encrypt communications in the cluster. + # The API returns a list that includes certificates from all TLS contexts including: + # - Settings for transport and HTTP interfaces + # - TLS settings that are used within authentication realms + # - TLS settings for remote monitoring exporters + # The list includes certificates that are used for configuring trust, such as those configured in the `xpack.security.transport.ssl.truststore` and `xpack.security.transport.ssl.certificate_authorities` settings. + # It also includes certificates that are used for configuring server identity, such as `xpack.security.http.ssl.keystore` and `xpack.security.http.ssl.certificate settings`. + # The list does not include certificates that are sourced from the default SSL context of the Java Runtime Environment (JRE), even if those certificates are in use within Elasticsearch. + # NOTE: When a PKCS#11 token is configured as the truststore of the JRE, the API returns all the certificates that are included in the PKCS#11 token irrespective of whether these are used in the Elasticsearch TLS configuration. + # If Elasticsearch is configured to use a keystore or truststore, the API output includes all certificates in that store, even though some of the certificates might not be in active use within the cluster. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-ssl.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-ssl-certificates # def certificates(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'ssl.certificates' } @@ -34,11 +55,11 @@ def certificates(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_ssl/certificates' - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym.rb b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym.rb index 9d91211e7a..0041feb0e2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym.rb @@ -15,19 +15,42 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Synonyms module Actions - # Deletes a synonym set + # Delete a synonym set. + # You can only delete a synonyms set that is not in use by any index analyzer. + # Synonyms sets can be used in synonym graph token filters and synonym token filters. + # These synonym filters can be used as part of search analyzers. + # Analyzers need to be loaded when an index is restored (such as when a node starts, or the index becomes open). + # Even if the analyzer is not used on any field mapping, it still needs to be loaded on the index recovery phase. + # If any analyzers cannot be loaded, the index becomes unavailable and the cluster status becomes red or yellow as index shards are not available. + # To prevent that, synonyms sets that are used in analyzers can't be deleted. + # A delete request in this case will return a 400 response code. + # To remove a synonyms set, you must first remove all indices that contain analyzers using it. + # You can migrate an index by creating a new index that does not contain the token filter with the synonyms set, and use the reindex API in order to copy over the index data. + # Once finished, you can delete the index. + # When the synonyms set is not used in analyzers, you will be able to delete it. # - # @option arguments [String] :id The id of the synonyms set to be deleted + # @option arguments [String] :id The synonyms set identifier to delete. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-synonyms-set.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-synonyms-delete-synonym # def delete_synonym(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'synonyms.delete_synonym' } @@ -47,8 +70,8 @@ def delete_synonym(arguments = {}) _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_DELETE - path = "_synonyms/#{Utils.__listify(_id)}" - params = {} + path = "_synonyms/#{Utils.listify(_id)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym_rule.rb b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym_rule.rb index 26183609b4..8a0ea527f9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym_rule.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/delete_synonym_rule.rb @@ -15,25 +15,37 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Synonyms module Actions - # Deletes a synonym rule in a synonym set + # Delete a synonym rule. + # Delete a synonym rule from a synonym set. # - # @option arguments [String] :set_id The id of the synonym set to be updated - # @option arguments [String] :rule_id The id of the synonym rule to be deleted + # @option arguments [String] :set_id The ID of the synonym set to update. (*Required*) + # @option arguments [String] :rule_id The ID of the synonym rule to delete. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-synonym-rule.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-synonyms-delete-synonym-rule # def delete_synonym_rule(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'synonyms.delete_synonym_rule' } - defined_params = %i[set_id rule_id].each_with_object({}) do |variable, set_variables| + defined_params = [:set_id, :rule_id].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -51,8 +63,8 @@ def delete_synonym_rule(arguments = {}) _rule_id = arguments.delete(:rule_id) method = Elasticsearch::API::HTTP_DELETE - path = "_synonyms/#{Utils.__listify(_set_id)}/#{Utils.__listify(_rule_id)}" - params = {} + path = "_synonyms/#{Utils.listify(_set_id)}/#{Utils.listify(_rule_id)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym.rb b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym.rb index c09fddeac4..d3dacd6bf4 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym.rb @@ -15,21 +15,32 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Synonyms module Actions - # Retrieves a synonym set + # Get a synonym set. # - # @option arguments [String] :id The name of the synonyms set to be retrieved - # @option arguments [Integer] :from Starting offset - # @option arguments [Integer] :size specifies a max number of results to get + # @option arguments [String] :id The synonyms set identifier to retrieve. (*Required*) + # @option arguments [Integer] :from The starting offset for query rules to retrieve. Server default: 0. + # @option arguments [Integer] :size The max number of query rules to retrieve. Server default: 10. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-synonyms-set.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-synonyms-get-synonym # def get_synonym(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'synonyms.get_synonym' } @@ -49,7 +60,7 @@ def get_synonym(arguments = {}) _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_GET - path = "_synonyms/#{Utils.__listify(_id)}" + path = "_synonyms/#{Utils.listify(_id)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym_rule.rb b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym_rule.rb index 59769ec746..6bcca41e5e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym_rule.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonym_rule.rb @@ -15,25 +15,37 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Synonyms module Actions - # Retrieves a synonym rule from a synonym set + # Get a synonym rule. + # Get a synonym rule from a synonym set. # - # @option arguments [String] :set_id The id of the synonym set to retrieve the synonym rule from - # @option arguments [String] :rule_id The id of the synonym rule to retrieve + # @option arguments [String] :set_id The ID of the synonym set to retrieve the synonym rule from. (*Required*) + # @option arguments [String] :rule_id The ID of the synonym rule to retrieve. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-synonym-rule.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-synonyms-get-synonym-rule # def get_synonym_rule(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'synonyms.get_synonym_rule' } - defined_params = %i[set_id rule_id].each_with_object({}) do |variable, set_variables| + defined_params = [:set_id, :rule_id].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -51,8 +63,8 @@ def get_synonym_rule(arguments = {}) _rule_id = arguments.delete(:rule_id) method = Elasticsearch::API::HTTP_GET - path = "_synonyms/#{Utils.__listify(_set_id)}/#{Utils.__listify(_rule_id)}" - params = {} + path = "_synonyms/#{Utils.listify(_set_id)}/#{Utils.listify(_rule_id)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonyms_sets.rb b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonyms_sets.rb index 3580303fb4..1c49a27122 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonyms_sets.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/get_synonyms_sets.rb @@ -15,20 +15,32 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Synonyms module Actions - # Retrieves a summary of all defined synonym sets + # Get all synonym sets. + # Get a summary of all defined synonym sets. # - # @option arguments [Integer] :from Starting offset - # @option arguments [Integer] :size specifies a max number of results to get + # @option arguments [Integer] :from The starting offset for synonyms sets to retrieve. Server default: 0. + # @option arguments [Integer] :size The maximum number of synonyms sets to retrieve. Server default: 10. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/list-synonyms-sets.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-synonyms-get-synonym # def get_synonyms_sets(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'synonyms.get_synonyms_sets' } @@ -36,7 +48,7 @@ def get_synonyms_sets(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_synonyms' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym.rb b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym.rb index 99a76d6515..3785feca87 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym.rb @@ -15,20 +15,36 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Synonyms module Actions - # Creates or updates a synonyms set + # Create or update a synonym set. + # Synonyms sets are limited to a maximum of 10,000 synonym rules per set. + # If you need to manage more synonym rules, you can create multiple synonym sets. + # When an existing synonyms set is updated, the search analyzers that use the synonyms set are reloaded automatically for all indices. + # This is equivalent to invoking the reload search analyzers API for all indices that use the synonyms set. + # For practical examples of how to create or update a synonyms set, refer to the External documentation. # - # @option arguments [String] :id The id of the synonyms set to be created or updated + # @option arguments [String] :id The ID of the synonyms set to be created or updated. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body Synonyms set rules (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-synonyms-set.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-synonyms-put-synonym # def put_synonym(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'synonyms.put_synonym' } @@ -49,8 +65,8 @@ def put_synonym(arguments = {}) _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_PUT - path = "_synonyms/#{Utils.__listify(_id)}" - params = {} + path = "_synonyms/#{Utils.listify(_id)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym_rule.rb b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym_rule.rb index cc7804380e..6378e937cf 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym_rule.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/synonyms/put_synonym_rule.rb @@ -15,26 +15,40 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Synonyms module Actions - # Creates or updates a synonym rule in a synonym set + # Create or update a synonym rule. + # Create or update a synonym rule in a synonym set. + # If any of the synonym rules included is invalid, the API returns an error. + # When you update a synonym rule, all analyzers using the synonyms set will be reloaded automatically to reflect the new rule. # - # @option arguments [String] :set_id The id of the synonym set to be updated with the synonym rule - # @option arguments [String] :rule_id The id of the synonym rule to be updated or created + # @option arguments [String] :set_id The ID of the synonym set. (*Required*) + # @option arguments [String] :rule_id The ID of the synonym rule to be updated or created. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body Synonym rule (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-synonym-rule.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-synonyms-put-synonym-rule # def put_synonym_rule(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'synonyms.put_synonym_rule' } - defined_params = %i[set_id rule_id].each_with_object({}) do |variable, set_variables| + defined_params = [:set_id, :rule_id].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -53,8 +67,8 @@ def put_synonym_rule(arguments = {}) _rule_id = arguments.delete(:rule_id) method = Elasticsearch::API::HTTP_PUT - path = "_synonyms/#{Utils.__listify(_set_id)}/#{Utils.__listify(_rule_id)}" - params = {} + path = "_synonyms/#{Utils.listify(_set_id)}/#{Utils.listify(_rule_id)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/tasks/cancel.rb b/elasticsearch-api/lib/elasticsearch/api/actions/tasks/cancel.rb index 9ce81d2afc..7f0b641e12 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/tasks/cancel.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/tasks/cancel.rb @@ -15,27 +15,46 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Tasks module Actions - # Cancels a task, if it can be cancelled through an API. + # Cancel a task. + # WARNING: The task management API is new and should still be considered a beta feature. + # The API may change in ways that are not backwards compatible. + # A task may continue to run for some time after it has been cancelled because it may not be able to safely stop its current activity straight away. + # It is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation. + # The get task information API will continue to list these cancelled tasks until they complete. + # The cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible. + # To troubleshoot why a cancelled task does not complete promptly, use the get task information API with the `?detailed` parameter to identify the other tasks the system is running. + # You can also use the node hot threads API to obtain detailed information about the work the system is doing instead of completing the cancelled task. # 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] :task_id Cancel the task with specified task id (node_id:task_number) - # @option arguments [List] :nodes A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes - # @option arguments [List] :actions A comma-separated list of actions that should be cancelled. Leave empty to cancel all. - # @option arguments [String] :parent_task_id Cancel tasks with specified parent task id (node_id:task_number). Set to -1 to cancel all. - # @option arguments [Boolean] :wait_for_completion Should the request block until the cancellation of the task and its descendant tasks is completed. Defaults to false + # @option arguments [String, Integer] :task_id The task identifier. + # @option arguments [String, Array] :actions A comma-separated list or wildcard expression of actions that is used to limit the request. + # @option arguments [Array] :nodes A comma-separated list of node IDs or names that is used to limit the request. + # @option arguments [String] :parent_task_id A parent task ID that is used to limit the tasks. + # @option arguments [Boolean] :wait_for_completion If true, the request blocks until all found tasks are complete. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-tasks # def cancel(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'tasks.cancel' } @@ -54,7 +73,7 @@ def cancel(arguments = {}) method = Elasticsearch::API::HTTP_POST path = if _task_id - "_tasks/#{Utils.__listify(_task_id)}/_cancel" + "_tasks/#{Utils.listify(_task_id)}/_cancel" else '_tasks/_cancel' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/tasks/get.rb b/elasticsearch-api/lib/elasticsearch/api/actions/tasks/get.rb index 49f700537a..ee73ed63db 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/tasks/get.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/tasks/get.rb @@ -15,25 +15,41 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Tasks module Actions - # Returns information about a task. + # Get task information. + # Get information about a task currently running in the cluster. + # WARNING: The task management API is new and should still be considered a beta feature. + # The API may change in ways that are not backwards compatible. + # If the task identifier is not found, a 404 response code indicates that there are no resources that match the request. # 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] :task_id Return the task with specified id (node_id:task_number) - # @option arguments [Boolean] :wait_for_completion Wait for the matching tasks to complete (default: false) - # @option arguments [Time] :timeout Explicit operation timeout + # @option arguments [String] :task_id The task identifier. (*Required*) + # @option arguments [Time] :timeout The period to wait for a response. + # If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :wait_for_completion If `true`, the request blocks until the task has completed. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-tasks # def get(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'tasks.get' } @@ -43,6 +59,8 @@ def get(arguments = {}) end request_opts[:defined_params] = defined_params unless defined_params.empty? + raise ArgumentError, "Required argument 'task_id' missing" unless arguments[:task_id] + arguments = arguments.clone headers = arguments.delete(:headers) || {} @@ -51,7 +69,7 @@ def get(arguments = {}) _task_id = arguments.delete(:task_id) method = Elasticsearch::API::HTTP_GET - path = "_tasks/#{Utils.__listify(_task_id)}" + path = "_tasks/#{Utils.listify(_task_id)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/tasks/list.rb b/elasticsearch-api/lib/elasticsearch/api/actions/tasks/list.rb index 52c522cbea..431af7ad65 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/tasks/list.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/tasks/list.rb @@ -15,29 +15,102 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Tasks module Actions - # Returns a list of tasks. + # Get all tasks. + # Get information about the tasks currently running on one or more nodes in the cluster. + # WARNING: The task management API is new and should still be considered a beta feature. + # The API may change in ways that are not backwards compatible. + # **Identifying running tasks** + # The `X-Opaque-Id header`, when provided on the HTTP request header, is going to be returned as a header in the response as well as in the headers field for in the task information. + # This enables you to track certain calls or associate certain tasks with the client that started them. + # For example: + # + # ``` + # curl -i -H "X-Opaque-Id: 123456" "http://localhost:9200/_tasks?group_by=parents" + # ``` + # + # The API returns the following result: + # + # ``` + # HTTP/1.1 200 OK + # X-Opaque-Id: 123456 + # content-type: application/json; charset=UTF-8 + # content-length: 831 + # { + # "tasks" : { + # "u5lcZHqcQhu-rUoFaqDphA:45" : { + # "node" : "u5lcZHqcQhu-rUoFaqDphA", + # "id" : 45, + # "type" : "transport", + # "action" : "cluster:monitor/tasks/lists", + # "start_time_in_millis" : 1513823752749, + # "running_time_in_nanos" : 293139, + # "cancellable" : false, + # "headers" : { + # "X-Opaque-Id" : "123456" + # }, + # "children" : [ + # { + # "node" : "u5lcZHqcQhu-rUoFaqDphA", + # "id" : 46, + # "type" : "direct", + # "action" : "cluster:monitor/tasks/lists[n]", + # "start_time_in_millis" : 1513823752750, + # "running_time_in_nanos" : 92133, + # "cancellable" : false, + # "parent_task_id" : "u5lcZHqcQhu-rUoFaqDphA:45", + # "headers" : { + # "X-Opaque-Id" : "123456" + # } + # } + # ] + # } + # } + # } + # ``` + # + # In this example, `X-Opaque-Id: 123456` is the ID as a part of the response header. + # The `X-Opaque-Id` in the task `headers` is the ID for the task that was initiated by the REST request. + # The `X-Opaque-Id` in the children `headers` is the child task of the task that was initiated by the REST request. # 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 [List] :nodes A comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes - # @option arguments [List] :actions A comma-separated list of actions that should be returned. Leave empty to return all. - # @option arguments [Boolean] :detailed Return detailed task information (default: false) - # @option arguments [String] :parent_task_id Return tasks with specified parent task id (node_id:task_number). Set to -1 to return all. - # @option arguments [Boolean] :wait_for_completion Wait for the matching tasks to complete (default: false) - # @option arguments [String] :group_by Group tasks by nodes or parent/child relationships (options: nodes, parents, none) - # @option arguments [Time] :timeout Explicit operation timeout + # @option arguments [String, Array] :actions A comma-separated list or wildcard expression of actions used to limit the request. + # For example, you can use `cluser:*` to retrieve all cluster-related tasks. + # @option arguments [Boolean] :detailed If `true`, the response includes detailed information about the running tasks. + # This information is useful to distinguish tasks from each other but is more costly to run. + # @option arguments [String] :group_by A key that is used to group tasks in the response. + # The task lists can be grouped either by nodes or by parent tasks. + # @option arguments [String, Array] :nodes A comma-separated list of node IDs or names that is used to limit the returned information. + # @option arguments [String] :parent_task_id A parent task identifier that is used to limit returned information. + # To return all tasks, omit this parameter or use a value of `-1`. + # If the parent task is not found, the API does not return a 404 response code. + # @option arguments [Time] :timeout The period to wait for each node to respond. + # If a node does not respond before its timeout expires, the response does not include its information. + # However, timed out nodes are included in the `node_failures` property. Server default: 30s. + # @option arguments [Boolean] :wait_for_completion If `true`, the request blocks until the operation is complete. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-tasks # def list(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'tasks.list' } @@ -45,7 +118,7 @@ def list(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_tasks' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/terms_enum.rb b/elasticsearch-api/lib/elasticsearch/api/actions/terms_enum.rb index 93cbc80f7e..cc21f90ae1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/terms_enum.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/terms_enum.rb @@ -15,19 +15,34 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios. + # Get terms in an index. + # Discover terms that match a partial string in an index. + # This API is designed for low-latency look-ups used in auto-complete scenarios. # - # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices + # @option arguments [String] :index A comma-separated list of data streams, indices, and index aliases to search. + # Wildcard (`*`) expressions are supported. + # To search all data streams or indices, omit this parameter or use `*` or `_all`. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body field name, string which is the prefix expected in matching terms, timeout and size for max number of results + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/search-terms-enum.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-terms-enum # def terms_enum(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'terms_enum' } @@ -52,8 +67,8 @@ def terms_enum(arguments = {}) Elasticsearch::API::HTTP_GET end - path = "#{Utils.__listify(_index)}/_terms_enum" - params = {} + path = "#{Utils.listify(_index)}/_terms_enum" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/termvectors.rb b/elasticsearch-api/lib/elasticsearch/api/actions/termvectors.rb index 8b834d9ab6..aa60dd6c1e 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/termvectors.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/termvectors.rb @@ -15,36 +15,76 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Returns information and statistics about terms in the fields of a particular document. + # Get term vector information. + # Get information and statistics about terms in the fields of a particular document. + # You can retrieve term vectors for documents stored in the index or for artificial documents passed in the body of the request. + # You can specify the fields you are interested in through the `fields` parameter or by adding the fields to the request body. + # For example: + # + # ``` + # GET /my-index-000001/_termvectors/1?fields=message + # ``` + # + # Fields can be specified using wildcards, similar to the multi match query. + # Term vectors are real-time by default, not near real-time. + # This can be changed by setting `realtime` parameter to `false`. + # You can request three types of values: _term information_, _term statistics_, and _field statistics_. + # By default, all term information and field statistics are returned for all fields but term statistics are excluded. + # **Term information** + # * term frequency in the field (always returned) + # * term positions (`positions: true`) + # * start and end offsets (`offsets: true`) + # * term payloads (`payloads: true`), as base64 encoded bytes + # If the requested information wasn't stored in the index, it will be computed on the fly if possible. + # Additionally, term vectors could be computed for documents not even existing in the index, but instead provided by the user. # - # @option arguments [String] :index The index in which the document resides. - # @option arguments [String] :id The id of the document, when not specified a doc param should be supplied. - # @option arguments [Boolean] :term_statistics Specifies if total term frequency and document frequency should be returned. - # @option arguments [Boolean] :field_statistics Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. - # @option arguments [List] :fields A comma-separated list of fields to return. - # @option arguments [Boolean] :offsets Specifies if term offsets should be returned. - # @option arguments [Boolean] :positions Specifies if term positions should be returned. - # @option arguments [Boolean] :payloads Specifies if term payloads should be returned. - # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random). - # @option arguments [String] :routing Specific routing value. - # @option arguments [Boolean] :realtime Specifies if request is real-time as opposed to near-real-time (default: true). - # @option arguments [Number] :version Explicit version number for concurrency control - # @option arguments [String] :version_type Specific version type (options: internal, external, external_gte) + # @option arguments [String] :index The name of the index that contains the document. (*Required*) + # @option arguments [String] :id A unique identifier for the document. + # @option arguments [String, Array] :fields A comma-separated list or wildcard expressions of fields to include in the statistics. + # It is used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters. + # @option arguments [Boolean] :field_statistics If `true`, the response includes: + # - The document count (how many documents contain this field). + # - The sum of document frequencies (the sum of document frequencies for all terms in this field). + # - The sum of total term frequencies (the sum of total term frequencies of each term in this field). Server default: true. + # @option arguments [Boolean] :offsets If `true`, the response includes term offsets. Server default: true. + # @option arguments [Boolean] :payloads If `true`, the response includes term payloads. Server default: true. + # @option arguments [Boolean] :positions If `true`, the response includes term positions. Server default: true. + # @option arguments [String] :preference The node or shard the operation should be performed on. + # It is random by default. + # @option arguments [Boolean] :realtime If true, the request is real-time as opposed to near-real-time. Server default: true. + # @option arguments [String] :routing A custom value that is used to route operations to a specific shard. + # @option arguments [Boolean] :term_statistics If `true`, the response includes: + # - The total term frequency (how often a term occurs in all documents). + # - The document frequency (the number of documents containing the current term). + # By default these values are not returned since term statistics can have a serious performance impact. + # @option arguments [Integer] :version If `true`, returns the document version as part of a hit. + # @option arguments [String] :version_type The version type. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body Define parameters and or supply a document to get termvectors for. See documentation. + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-termvectors.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-termvectors # def termvectors(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'termvectors' } - defined_params = %i[index id].each_with_object({}) do |variable, set_variables| + defined_params = [:index, :id].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -68,9 +108,9 @@ def termvectors(arguments = {}) arguments.delete(:endpoint) path = if _index && _id - "#{Utils.__listify(_index)}/_termvectors/#{Utils.__listify(_id)}" + "#{Utils.listify(_index)}/_termvectors/#{Utils.listify(_id)}" else - "#{Utils.__listify(_index)}/_termvectors" + "#{Utils.listify(_index)}/_termvectors" end params = Utils.process_params(arguments) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_field_structure.rb b/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_field_structure.rb index 8464acff62..ae3616c065 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_field_structure.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_field_structure.rb @@ -15,32 +15,106 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module TextStructure module Actions - # Finds the structure of a text field in an index. + # Find the structure of a text field. + # Find the structure of a text field in an Elasticsearch index. + # This API provides a starting point for extracting further information from log messages already ingested into Elasticsearch. + # For example, if you have ingested data into a very simple index that has just `@timestamp` and message fields, you can use this API to see what common structure exists in the message field. + # The response from the API contains: + # * Sample messages. + # * Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. + # * Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. + # * Appropriate mappings for an Elasticsearch index, which you could use to ingest the text. + # All this information can be calculated by the structure finder with no guidance. + # However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters. + # If the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response. + # It helps determine why the returned structure was chosen. # - # @option arguments [String] :index The index containing the analyzed field (*Required*) - # @option arguments [String] :field The field that should be analyzed (*Required*) - # @option arguments [Integer] :documents_to_sample How many documents should be included in the analysis - # @option arguments [Time] :timeout Timeout after which the analysis will be aborted - # @option arguments [String] :format Optional parameter to specify the high level file format (options: ndjson, xml, delimited, semi_structured_text) - # @option arguments [List] :column_names Optional parameter containing a comma separated list of the column names for a delimited file - # @option arguments [String] :delimiter Optional parameter to specify the delimiter character for a delimited file - must be a single character - # @option arguments [String] :quote Optional parameter to specify the quote character for a delimited file - must be a single character - # @option arguments [Boolean] :should_trim_fields Optional parameter to specify whether the values between delimiters in a delimited file should have whitespace trimmed from them - # @option arguments [String] :grok_pattern Optional parameter to specify the Grok pattern that should be used to extract fields from messages in a semi-structured text file - # @option arguments [String] :ecs_compatibility Optional parameter to specify the compatibility mode with ECS Grok patterns - may be either 'v1' or 'disabled' - # @option arguments [String] :timestamp_field Optional parameter to specify the timestamp field in the file - # @option arguments [String] :timestamp_format Optional parameter to specify the timestamp format in the file - may be either a Joda or Java time format - # @option arguments [Boolean] :explain Whether to include a commentary on how the structure was derived + # @option arguments [String] :column_names If `format` is set to `delimited`, you can specify the column names in a comma-separated list. + # If this parameter is not specified, the structure finder uses the column names from the header row of the text. + # If the text does not have a header row, columns are named "column1", "column2", "column3", for example. + # @option arguments [String] :delimiter If you have set `format` to `delimited`, you can specify the character used to delimit the values in each row. + # Only a single character is supported; the delimiter cannot have multiple characters. + # By default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (`|`). + # In this default scenario, all rows must have the same number of fields for the delimited format to be detected. + # If you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row. + # @option arguments [Integer] :documents_to_sample The number of documents to include in the structural analysis. + # The minimum value is 2. Server default: 1000. + # @option arguments [String] :ecs_compatibility The mode of compatibility with ECS compliant Grok patterns. + # Use this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern. + # This setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input. + # If the structure finder identifies a common structure but has no idea of the meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output. + # The intention in that situation is that a user who knows the meanings will rename the fields before using them. Server default: disabled. + # @option arguments [Boolean] :explain If `true`, the response includes a field named `explanation`, which is an array of strings that indicate how the structure finder produced its result. + # @option arguments [String] :field The field that should be analyzed. (*Required*) + # @option arguments [String] :format The high level structure of the text. + # By default, the API chooses the format. + # In this default scenario, all rows must have the same number of fields for a delimited format to be detected. + # If the format is set to delimited and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row. + # @option arguments [String] :grok_pattern If the format is `semi_structured_text`, you can specify a Grok pattern that is used to extract fields from every message in the text. + # The name of the timestamp field in the Grok pattern must match what is specified in the `timestamp_field` parameter. + # If that parameter is not specified, the name of the timestamp field in the Grok pattern must match "timestamp". + # If `grok_pattern` is not specified, the structure finder creates a Grok pattern. + # @option arguments [String] :index The name of the index that contains the analyzed field. (*Required*) + # @option arguments [String] :quote If the format is `delimited`, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character. + # Only a single character is supported. + # If this parameter is not specified, the default value is a double quote (`"`). + # If your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample. + # @option arguments [Boolean] :should_trim_fields If the format is `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them. + # If this parameter is not specified and the delimiter is pipe (`|`), the default value is true. + # Otherwise, the default value is `false`. + # @option arguments [Time] :timeout The maximum amount of time that the structure analysis can take. + # If the analysis is still running when the timeout expires, it will be stopped. Server default: 25s. + # @option arguments [String] :timestamp_field The name of the field that contains the primary timestamp of each record in the text. + # In particular, if the text was ingested into an index, this is the field that would be used to populate the `@timestamp` field.If the format is `semi_structured_text`, this field must match the name of the appropriate extraction in the `grok_pattern`. + # Therefore, for semi-structured text, it is best not to specify this parameter unless `grok_pattern` is also specified.For structured text, if you specify this parameter, the field must exist within the text.If this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field. + # For structured text, it is not compulsory to have a timestamp in the text. + # @option arguments [String] :timestamp_format The Java time format of the timestamp field in the text. + # Only a subset of Java time format letter groups are supported: + # - `a` + # - `d` + # - `dd` + # - `EEE` + # - `EEEE` + # - `H` + # - `HH` + # - `h` + # - `M` + # - `MM` + # - `MMM` + # - `MMMM` + # - `mm` + # - `ss` + # - `XX` + # - `XXX` + # - `yy` + # - `yyyy` + # - `zzz` + # Additionally `S` letter groups (fractional seconds) of length one to nine are supported providing they occur after `ss` and are separated from the `ss` by a period (`.`), comma (`,`), or colon (`:`). + # Spacing and punctuation is also permitted with the exception a question mark (`?`), newline, and carriage return, together with literal text enclosed in single quotes. + # For example, `MM/dd HH.mm.ss,SSSSSS 'in' yyyy` is a valid override format.One valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full `grok_pattern`. + # Another is when the timestamp format is one that the structure finder does not consider by default.If this parameter is not specified, the structure finder chooses the best format from a built-in set.If the special value `null` is specified, the structure finder will not look for a primary timestamp in the text. + # When the format is semi-structured text, this will result in the structure finder treating the text as single-line messages. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/find-field-structure.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-text_structure # def find_field_structure(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'text_structure.find_field_structure' } @@ -48,7 +122,7 @@ def find_field_structure(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_text_structure/find_field_structure' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_message_structure.rb b/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_message_structure.rb index fcd7456472..5bb86bc75d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_message_structure.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_message_structure.rb @@ -15,30 +15,103 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module TextStructure module Actions - # Finds the structure of a list of messages. The messages must contain data that is suitable to be ingested into Elasticsearch. + # Find the structure of text messages. + # Find the structure of a list of text messages. + # The messages must contain data that is suitable to be ingested into Elasticsearch. + # This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality. + # Use this API rather than the find text structure API if your input text has already been split up into separate messages by some other process. + # The response from the API contains: + # * Sample messages. + # * Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. + # * Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. + # Appropriate mappings for an Elasticsearch index, which you could use to ingest the text. + # All this information can be calculated by the structure finder with no guidance. + # However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters. + # If the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response. + # It helps determine why the returned structure was chosen. # - # @option arguments [Time] :timeout Timeout after which the analysis will be aborted - # @option arguments [String] :format Optional parameter to specify the high level file format (options: ndjson, xml, delimited, semi_structured_text) - # @option arguments [List] :column_names Optional parameter containing a comma separated list of the column names for a delimited file - # @option arguments [String] :delimiter Optional parameter to specify the delimiter character for a delimited file - must be a single character - # @option arguments [String] :quote Optional parameter to specify the quote character for a delimited file - must be a single character - # @option arguments [Boolean] :should_trim_fields Optional parameter to specify whether the values between delimiters in a delimited file should have whitespace trimmed from them - # @option arguments [String] :grok_pattern Optional parameter to specify the Grok pattern that should be used to extract fields from messages in a semi-structured text file - # @option arguments [String] :ecs_compatibility Optional parameter to specify the compatibility mode with ECS Grok patterns - may be either 'v1' or 'disabled' - # @option arguments [String] :timestamp_field Optional parameter to specify the timestamp field in the file - # @option arguments [String] :timestamp_format Optional parameter to specify the timestamp format in the file - may be either a Joda or Java time format - # @option arguments [Boolean] :explain Whether to include a commentary on how the structure was derived + # @option arguments [String] :column_names If the format is `delimited`, you can specify the column names in a comma-separated list. + # If this parameter is not specified, the structure finder uses the column names from the header row of the text. + # If the text does not have a header role, columns are named "column1", "column2", "column3", for example. + # @option arguments [String] :delimiter If you the format is `delimited`, you can specify the character used to delimit the values in each row. + # Only a single character is supported; the delimiter cannot have multiple characters. + # By default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (`|`). + # In this default scenario, all rows must have the same number of fields for the delimited format to be detected. + # If you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row. + # @option arguments [String] :ecs_compatibility The mode of compatibility with ECS compliant Grok patterns. + # Use this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern. + # This setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input. + # If the structure finder identifies a common structure but has no idea of meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output, with the intention that a user who knows the meanings rename these fields before using it. Server default: disabled. + # @option arguments [Boolean] :explain If this parameter is set to true, the response includes a field named `explanation`, which is an array of strings that indicate how the structure finder produced its result. + # @option arguments [String] :format The high level structure of the text. + # By default, the API chooses the format. + # In this default scenario, all rows must have the same number of fields for a delimited format to be detected. + # If the format is `delimited` and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row. + # @option arguments [String] :grok_pattern If the format is `semi_structured_text`, you can specify a Grok pattern that is used to extract fields from every message in the text. + # The name of the timestamp field in the Grok pattern must match what is specified in the `timestamp_field` parameter. + # If that parameter is not specified, the name of the timestamp field in the Grok pattern must match "timestamp". + # If `grok_pattern` is not specified, the structure finder creates a Grok pattern. + # @option arguments [String] :quote If the format is `delimited`, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character. + # Only a single character is supported. + # If this parameter is not specified, the default value is a double quote (`"`). + # If your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample. + # @option arguments [Boolean] :should_trim_fields If the format is `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them. + # If this parameter is not specified and the delimiter is pipe (`|`), the default value is true. + # Otherwise, the default value is `false`. + # @option arguments [Time] :timeout The maximum amount of time that the structure analysis can take. + # If the analysis is still running when the timeout expires, it will be stopped. Server default: 25s. + # @option arguments [String] :timestamp_field The name of the field that contains the primary timestamp of each record in the text. + # In particular, if the text was ingested into an index, this is the field that would be used to populate the `@timestamp` field.If the format is `semi_structured_text`, this field must match the name of the appropriate extraction in the `grok_pattern`. + # Therefore, for semi-structured text, it is best not to specify this parameter unless `grok_pattern` is also specified.For structured text, if you specify this parameter, the field must exist within the text.If this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field. + # For structured text, it is not compulsory to have a timestamp in the text. + # @option arguments [String] :timestamp_format The Java time format of the timestamp field in the text. + # Only a subset of Java time format letter groups are supported: + # - `a` + # - `d` + # - `dd` + # - `EEE` + # - `EEEE` + # - `H` + # - `HH` + # - `h` + # - `M` + # - `MM` + # - `MMM` + # - `MMMM` + # - `mm` + # - `ss` + # - `XX` + # - `XXX` + # - `yy` + # - `yyyy` + # - `zzz` + # Additionally `S` letter groups (fractional seconds) of length one to nine are supported providing they occur after `ss` and are separated from the `ss` by a period (`.`), comma (`,`), or colon (`:`). + # Spacing and punctuation is also permitted with the exception a question mark (`?`), newline, and carriage return, together with literal text enclosed in single quotes. + # For example, `MM/dd HH.mm.ss,SSSSSS 'in' yyyy` is a valid override format.One valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full `grok_pattern`. + # Another is when the timestamp format is one that the structure finder does not consider by default.If this parameter is not specified, the structure finder chooses the best format from a built-in set.If the special value `null` is specified, the structure finder will not look for a primary timestamp in the text. + # When the format is semi-structured text, this will result in the structure finder treating the text as single-line messages. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body JSON object with one field [messages], containing an array of messages to be analyzed (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/find-message-structure.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-text-structure-find-message-structure # def find_message_structure(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'text_structure.find_message_structure' } @@ -48,7 +121,7 @@ def find_message_structure(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_text_structure/find_message_structure' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_structure.rb b/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_structure.rb index 099d91ebc5..12f8f8f06d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_structure.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/find_structure.rb @@ -15,34 +15,106 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module TextStructure module Actions - # Finds the structure of a text file. The text file must contain data that is suitable to be ingested into Elasticsearch. + # Find the structure of a text file. + # The text file must contain data that is suitable to be ingested into Elasticsearch. + # This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality. + # Unlike other Elasticsearch endpoints, the data that is posted to this endpoint does not need to be UTF-8 encoded and in JSON format. + # It must, however, be text; binary text formats are not currently supported. + # The size is limited to the Elasticsearch HTTP receive buffer size, which defaults to 100 Mb. + # The response from the API contains: + # * A couple of messages from the beginning of the text. + # * Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields. + # * Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text. + # * Appropriate mappings for an Elasticsearch index, which you could use to ingest the text. + # All this information can be calculated by the structure finder with no guidance. + # However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters. # - # @option arguments [Integer] :lines_to_sample How many lines of the file should be included in the analysis - # @option arguments [Integer] :line_merge_size_limit Maximum number of characters permitted in a single message when lines are merged to create messages. - # @option arguments [Time] :timeout Timeout after which the analysis will be aborted - # @option arguments [String] :charset Optional parameter to specify the character set of the file - # @option arguments [String] :format Optional parameter to specify the high level file format (options: ndjson, xml, delimited, semi_structured_text) - # @option arguments [Boolean] :has_header_row Optional parameter to specify whether a delimited file includes the column names in its first row - # @option arguments [List] :column_names Optional parameter containing a comma separated list of the column names for a delimited file - # @option arguments [String] :delimiter Optional parameter to specify the delimiter character for a delimited file - must be a single character - # @option arguments [String] :quote Optional parameter to specify the quote character for a delimited file - must be a single character - # @option arguments [Boolean] :should_trim_fields Optional parameter to specify whether the values between delimiters in a delimited file should have whitespace trimmed from them - # @option arguments [String] :grok_pattern Optional parameter to specify the Grok pattern that should be used to extract fields from messages in a semi-structured text file - # @option arguments [String] :ecs_compatibility Optional parameter to specify the compatibility mode with ECS Grok patterns - may be either 'v1' or 'disabled' - # @option arguments [String] :timestamp_field Optional parameter to specify the timestamp field in the file - # @option arguments [String] :timestamp_format Optional parameter to specify the timestamp format in the file - may be either a Joda or Java time format - # @option arguments [Boolean] :explain Whether to include a commentary on how the structure was derived + # @option arguments [String] :charset The text's character set. + # It must be a character set that is supported by the JVM that Elasticsearch uses. + # For example, `UTF-8`, `UTF-16LE`, `windows-1252`, or `EUC-JP`. + # If this parameter is not specified, the structure finder chooses an appropriate character set. + # @option arguments [String] :column_names If you have set format to `delimited`, you can specify the column names in a comma-separated list. + # If this parameter is not specified, the structure finder uses the column names from the header row of the text. + # If the text does not have a header role, columns are named "column1", "column2", "column3", for example. + # @option arguments [String] :delimiter If you have set `format` to `delimited`, you can specify the character used to delimit the values in each row. + # Only a single character is supported; the delimiter cannot have multiple characters. + # By default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (`|`). + # In this default scenario, all rows must have the same number of fields for the delimited format to be detected. + # If you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row. + # @option arguments [String] :ecs_compatibility The mode of compatibility with ECS compliant Grok patterns. + # Use this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern. + # Valid values are `disabled` and `v1`. + # This setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input. + # If the structure finder identifies a common structure but has no idea of meaning then generic field names such as `path`, `ipaddress`, `field1`, and `field2` are used in the `grok_pattern` output, with the intention that a user who knows the meanings rename these fields before using it. Server default: disabled. + # @option arguments [Boolean] :explain If this parameter is set to `true`, the response includes a field named explanation, which is an array of strings that indicate how the structure finder produced its result. + # If the structure finder produces unexpected results for some text, use this query parameter to help you determine why the returned structure was chosen. + # @option arguments [String] :format The high level structure of the text. + # Valid values are `ndjson`, `xml`, `delimited`, and `semi_structured_text`. + # By default, the API chooses the format. + # In this default scenario, all rows must have the same number of fields for a delimited format to be detected. + # If the format is set to `delimited` and the delimiter is not set, however, the API tolerates up to 5% of rows that have a different number of columns than the first row. + # @option arguments [String] :grok_pattern If you have set `format` to `semi_structured_text`, you can specify a Grok pattern that is used to extract fields from every message in the text. + # The name of the timestamp field in the Grok pattern must match what is specified in the `timestamp_field` parameter. + # If that parameter is not specified, the name of the timestamp field in the Grok pattern must match "timestamp". + # If `grok_pattern` is not specified, the structure finder creates a Grok pattern. + # @option arguments [Boolean] :has_header_row If you have set `format` to `delimited`, you can use this parameter to indicate whether the column names are in the first row of the text. + # If this parameter is not specified, the structure finder guesses based on the similarity of the first row of the text to other rows. + # @option arguments [Integer] :line_merge_size_limit The maximum number of characters in a message when lines are merged to form messages while analyzing semi-structured text. + # If you have extremely long messages you may need to increase this, but be aware that this may lead to very long processing times if the way to group lines into messages is misdetected. Server default: 10000. + # @option arguments [Integer] :lines_to_sample The number of lines to include in the structural analysis, starting from the beginning of the text. + # The minimum is 2. + # If the value of this parameter is greater than the number of lines in the text, the analysis proceeds (as long as there are at least two lines in the text) for all of the lines.NOTE: The number of lines and the variation of the lines affects the speed of the analysis. + # For example, if you upload text where the first 1000 lines are all variations on the same message, the analysis will find more commonality than would be seen with a bigger sample. + # If possible, however, it is more efficient to upload sample text with more variety in the first 1000 lines than to request analysis of 100000 lines to achieve some variety. Server default: 1000. + # @option arguments [String] :quote If you have set `format` to `delimited`, you can specify the character used to quote the values in each row if they contain newlines or the delimiter character. + # Only a single character is supported. + # If this parameter is not specified, the default value is a double quote (`"`). + # If your delimited text format does not use quoting, a workaround is to set this argument to a character that does not appear anywhere in the sample. + # @option arguments [Boolean] :should_trim_fields If you have set `format` to `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them. + # If this parameter is not specified and the delimiter is pipe (`|`), the default value is `true`. + # Otherwise, the default value is `false`. + # @option arguments [Time] :timeout The maximum amount of time that the structure analysis can take. + # If the analysis is still running when the timeout expires then it will be stopped. Server default: 25s. + # @option arguments [String] :timestamp_field The name of the field that contains the primary timestamp of each record in the text. + # In particular, if the text were ingested into an index, this is the field that would be used to populate the `@timestamp` field.If the `format` is `semi_structured_text`, this field must match the name of the appropriate extraction in the `grok_pattern`. + # Therefore, for semi-structured text, it is best not to specify this parameter unless `grok_pattern` is also specified.For structured text, if you specify this parameter, the field must exist within the text.If this parameter is not specified, the structure finder makes a decision about which field (if any) is the primary timestamp field. + # For structured text, it is not compulsory to have a timestamp in the text. + # @option arguments [String] :timestamp_format The Java time format of the timestamp field in the text.Only a subset of Java time format letter groups are supported: + # - `a` + # - `d` + # - `dd` + # - `EEE` + # - `EEEE` + # - `H` + # - `HH` + # - `h` + # - `M` + # - `MM` + # - `MMM` + # - `MMMM` + # - `mm` + # - `ss` + # - `XX` + # - `XXX` + # - `yy` + # - `yyyy` + # - `zzz` + # Additionally `S` letter groups (fractional seconds) of length one to nine are supported providing they occur after `ss` and separated from the `ss` by a `.`, `,` or `:`. + # Spacing and punctuation is also permitted with the exception of `?`, newline and carriage return, together with literal text enclosed in single quotes. + # For example, `MM/dd HH.mm.ss,SSSSSS 'in' yyyy` is a valid override format.One valuable use case for this parameter is when the format is semi-structured text, there are multiple timestamp formats in the text, and you know which format corresponds to the primary timestamp, but you do not want to specify the full `grok_pattern`. + # Another is when the timestamp format is one that the structure finder does not consider by default.If this parameter is not specified, the structure finder chooses the best format from a built-in set.If the special value `null` is specified the structure finder will not look for a primary timestamp in the text. + # When the format is semi-structured text this will result in the structure finder treating the text as single-line messages. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The contents of the file to be analyzed (*Required*) + # @option arguments [Hash] :body text_files # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/find-structure.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-text-structure-find-structure # def find_structure(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'text_structure.find_structure' } @@ -52,19 +124,19 @@ def find_structure(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_text_structure/find_structure' params = Utils.process_params(arguments) payload = if body.is_a? Array - Elasticsearch::API::Utils.__bulkify(body) + Elasticsearch::API::Utils.bulkify(body) else body end - headers.merge!('Content-Type' => 'application/x-ndjson') + Utils.update_ndjson_headers!(headers, client.transport.options.dig(:transport_options, :headers)) Elasticsearch::API::Response.new( perform_request(method, path, params, payload, headers, request_opts) ) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/test_grok_pattern.rb b/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/test_grok_pattern.rb index 49fad35ecd..da4a862e79 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/test_grok_pattern.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/text_structure/test_grok_pattern.rb @@ -15,20 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module TextStructure module Actions - # Tests a Grok pattern on some text. + # Test a Grok pattern. + # Test a Grok pattern on one or more lines of text. + # The API indicates whether the lines match the pattern together with the offsets and lengths of the matched substrings. # - # @option arguments [String] :ecs_compatibility Optional parameter to specify the compatibility mode with ECS Grok patterns - may be either 'v1' or 'disabled' + # @option arguments [String] :ecs_compatibility The mode of compatibility with ECS compliant Grok patterns. + # Use this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern. + # Valid values are `disabled` and `v1`. Server default: disabled. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The Grok pattern and text. (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/test-grok-pattern.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-text-structure-test-grok-pattern # def test_grok_pattern(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'text_structure.test_grok_pattern' } @@ -38,7 +53,7 @@ def test_grok_pattern(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_POST path = '_text_structure/test_grok_pattern' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/delete_transform.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/delete_transform.rb index 9bf20808c6..51d458e5fd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/delete_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/delete_transform.rb @@ -15,22 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Transform module Actions - # Deletes an existing transform. + # Delete a transform. # - # @option arguments [String] :transform_id The id of the transform to delete - # @option arguments [Boolean] :force When `true`, the transform is deleted regardless of its current state. The default value is `false`, meaning that the transform must be `stopped` before it can be deleted. - # @option arguments [Boolean] :delete_dest_index When `true`, the destination index is deleted together with the transform. The default value is `false`, meaning that the destination index will not be deleted. - # @option arguments [Time] :timeout Controls the time to wait for the transform deletion + # @option arguments [String] :transform_id Identifier for the transform. (*Required*) + # @option arguments [Boolean] :force If this value is false, the transform must be stopped before it can be deleted. If true, the transform is + # deleted regardless of its current state. + # @option arguments [Boolean] :delete_dest_index If this value is true, the destination index is deleted together with the transform. If false, the destination + # index will not be deleted + # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-delete-transform # def delete_transform(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'transform.delete_transform' } @@ -50,7 +63,7 @@ def delete_transform(arguments = {}) _transform_id = arguments.delete(:transform_id) method = Elasticsearch::API::HTTP_DELETE - path = "_transform/#{Utils.__listify(_transform_id)}" + path = "_transform/#{Utils.listify(_transform_id)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_node_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_node_stats.rb index 69d76d7474..b87f76f425 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_node_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_node_stats.rb @@ -15,14 +15,14 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Transform module Actions - # Retrieves transform usage information for transform nodes. + # Retrieves transform usage information for transform nodes # # @option arguments [Hash] :headers Custom HTTP headers # @@ -34,7 +34,7 @@ def get_node_stats(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_transform/_node_stats' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform.rb index 5065124f1e..7796418bdd 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform.rb @@ -15,23 +15,45 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Transform module Actions - # Retrieves configuration information for transforms. + # Get transforms. + # Get configuration information for transforms. # - # @option arguments [String] :transform_id The id or comma delimited list of id expressions of the transforms to get, '_all' or '*' implies get all transforms - # @option arguments [Integer] :from skips a number of transform configs, defaults to 0 - # @option arguments [Integer] :size specifies a max number of transforms to get, defaults to 100 - # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified) - # @option arguments [Boolean] :exclude_generated Omits fields that are illegal to set on transform PUT + # @option arguments [String, Array] :transform_id Identifier for the transform. It can be a transform identifier or a + # wildcard expression. You can get information for all transforms by using + # `_all`, by specifying `*` as the ``, or by omitting the + # ``. + # @option arguments [Boolean] :allow_no_match Specifies what to do when the request: + # - Contains wildcard expressions and there are no transforms that match. + # - Contains the _all string or no identifiers and there are no matches. + # - Contains wildcard expressions and there are only partial matches. + # If this parameter is false, the request returns a 404 status code when + # there are no matches or only partial matches. Server default: true. + # @option arguments [Integer] :from Skips the specified number of transforms. Server default: 0. + # @option arguments [Integer] :size Specifies the maximum number of transforms to obtain. Server default: 100. + # @option arguments [Boolean] :exclude_generated Excludes fields that were automatically added when creating the + # transform. This allows the configuration to be in an acceptable format to + # be retrieved and then added to another cluster. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-get-transform # def get_transform(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'transform.get_transform' } @@ -50,7 +72,7 @@ def get_transform(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _transform_id - "_transform/#{Utils.__listify(_transform_id)}" + "_transform/#{Utils.listify(_transform_id)}" else '_transform' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform_stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform_stats.rb index abdf7014d8..020e55a9e2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform_stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/get_transform_stats.rb @@ -15,23 +15,43 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Transform module Actions - # Retrieves usage information for transforms. + # Get transform stats. + # Get usage information for transforms. # - # @option arguments [String] :transform_id The id of the transform for which to get stats. '_all' or '*' implies all transforms - # @option arguments [Number] :from skips a number of transform stats, defaults to 0 - # @option arguments [Number] :size specifies a max number of transform stats to get, defaults to 100 + # @option arguments [String, Array] :transform_id Identifier for the transform. It can be a transform identifier or a + # wildcard expression. You can get information for all transforms by using + # `_all`, by specifying `*` as the ``, or by omitting the + # ``. (*Required*) + # @option arguments [Boolean] :allow_no_match Specifies what to do when the request: + # - Contains wildcard expressions and there are no transforms that match. + # - Contains the _all string or no identifiers and there are no matches. + # - Contains wildcard expressions and there are only partial matches. + # If this parameter is false, the request returns a 404 status code when + # there are no matches or only partial matches. Server default: true. + # @option arguments [Integer] :from Skips the specified number of transforms. Server default: 0. + # @option arguments [Integer] :size Specifies the maximum number of transforms to obtain. Server default: 100. # @option arguments [Time] :timeout Controls the time to wait for the stats - # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/get-transform-stats.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-get-transform-stats # def get_transform_stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'transform.get_transform_stats' } @@ -51,7 +71,7 @@ def get_transform_stats(arguments = {}) _transform_id = arguments.delete(:transform_id) method = Elasticsearch::API::HTTP_GET - path = "_transform/#{Utils.__listify(_transform_id)}/_stats" + path = "_transform/#{Utils.listify(_transform_id)}/_stats" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/preview_transform.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/preview_transform.rb index 8ab4f59a7c..077ff06911 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/preview_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/preview_transform.rb @@ -15,21 +15,38 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Transform module Actions - # Previews a transform. + # Preview a transform. + # Generates a preview of the results that you will get when you create a transform with the same configuration. + # It returns a maximum of 100 results. The calculations are based on all the current data in the source index. It also + # generates a list of mappings and settings for the destination index. These values are determined based on the field + # types of the source index and the transform aggregations. # - # @option arguments [String] :transform_id The id of the transform to preview. - # @option arguments [Time] :timeout Controls the time to wait for the preview + # @option arguments [String] :transform_id Identifier for the transform to preview. If you specify this path parameter, you cannot provide transform + # configuration details in the request body. + # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the + # timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The definition for the transform to preview + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/preview-transform.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-preview-transform # def preview_transform(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'transform.preview_transform' } @@ -52,11 +69,11 @@ def preview_transform(arguments = {}) Elasticsearch::API::HTTP_GET end - path = if _transform_id - "_transform/#{Utils.__listify(_transform_id)}/_preview" - else - '_transform/_preview' - end + path = if _transform_id + "_transform/#{Utils.listify(_transform_id)}/_preview" + else + '_transform/_preview' + end params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/put_transform.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/put_transform.rb index 222912fe22..2b51958fe9 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/put_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/put_transform.rb @@ -15,22 +15,55 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Transform module Actions - # Instantiates a transform. + # Create a transform. + # Creates a transform. + # A transform copies data from source indices, transforms it, and persists it into an entity-centric destination index. You can also think of the destination index as a two-dimensional tabular data structure (known as + # a data frame). The ID for each document in the data frame is generated from a hash of the entity, so there is a + # unique row per entity. + # You must choose either the latest or pivot method for your transform; you cannot use both in a single transform. If + # you choose to use the pivot method for your transform, the entities are defined by the set of `group_by` fields in + # the pivot object. If you choose to use the latest method, the entities are defined by the `unique_key` field values + # in the latest object. + # You must have `create_index`, `index`, and `read` privileges on the destination index and `read` and + # `view_index_metadata` privileges on the source indices. When Elasticsearch security features are enabled, the + # transform remembers which roles the user that created it had at the time of creation and uses those same roles. If + # those roles do not have the required privileges on the source and destination indices, the transform fails when it + # attempts unauthorized operations. + # NOTE: You must use Kibana or this API to create a transform. Do not add a transform directly into any + # `.transform-internal*` indices using the Elasticsearch index API. If Elasticsearch security features are enabled, do + # not give users any privileges on `.transform-internal*` indices. If you used transforms prior to 7.5, also do not + # give users any privileges on `.data-frame-internal*` indices. # - # @option arguments [String] :transform_id The id of the new transform. - # @option arguments [Boolean] :defer_validation If validations should be deferred until transform starts, defaults to false. - # @option arguments [Time] :timeout Controls the time to wait for the transform to start + # @option arguments [String] :transform_id Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), + # hyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters. (*Required*) + # @option arguments [Boolean] :defer_validation When the transform is created, a series of validations occur to ensure its success. For example, there is a + # check for the existence of the source indices and a check that the destination index is not part of the source + # index pattern. You can use this parameter to skip the checks, for example when the source index does not exist + # until after the transform is created. The validations are always run when you start the transform, however, with + # the exception of privilege checks. + # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The transform definition (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/put-transform.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-put-transform # def put_transform(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'transform.put_transform' } @@ -51,7 +84,7 @@ def put_transform(arguments = {}) _transform_id = arguments.delete(:transform_id) method = Elasticsearch::API::HTTP_PUT - path = "_transform/#{Utils.__listify(_transform_id)}" + path = "_transform/#{Utils.listify(_transform_id)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/reset_transform.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/reset_transform.rb index dab3b5e94e..2cb8e26228 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/reset_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/reset_transform.rb @@ -15,21 +15,36 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Transform module Actions - # Resets an existing transform. + # Reset a transform. + # Before you can reset it, you must stop it; alternatively, use the `force` query parameter. + # If the destination index was created by the transform, it is deleted. # - # @option arguments [String] :transform_id The id of the transform to reset - # @option arguments [Boolean] :force When `true`, the transform is reset regardless of its current state. The default value is `false`, meaning that the transform must be `stopped` before it can be reset. - # @option arguments [Time] :timeout Controls the time to wait for the transform to reset + # @option arguments [String] :transform_id Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), + # hyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters. (*Required*) + # @option arguments [Boolean] :force If this value is `true`, the transform is reset regardless of its current state. If it's `false`, the transform + # must be stopped before it can be reset. + # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/reset-transform.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-reset-transform # def reset_transform(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'transform.reset_transform' } @@ -49,7 +64,7 @@ def reset_transform(arguments = {}) _transform_id = arguments.delete(:transform_id) method = Elasticsearch::API::HTTP_POST - path = "_transform/#{Utils.__listify(_transform_id)}/_reset" + path = "_transform/#{Utils.listify(_transform_id)}/_reset" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/schedule_now_transform.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/schedule_now_transform.rb index 74716246b6..dd78d9f9e8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/schedule_now_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/schedule_now_transform.rb @@ -15,20 +15,36 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Transform module Actions - # Schedules now a transform. + # Schedule a transform to start now. + # Instantly run a transform to process data. + # If you run this API, the transform will process the new data instantly, + # without waiting for the configured frequency interval. After the API is called, + # the transform will be processed again at `now + frequency` unless the API + # is called again in the meantime. # - # @option arguments [String] :transform_id The id of the transform. (*Required*) - # @option arguments [Time] :timeout Controls the time to wait for the scheduling to take place + # @option arguments [String] :transform_id Identifier for the transform. (*Required*) + # @option arguments [Time] :timeout Controls the time to wait for the scheduling to take place Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/schedule-now-transform.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-schedule-now-transform # def schedule_now_transform(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'transform.schedule_now_transform' } @@ -48,7 +64,7 @@ def schedule_now_transform(arguments = {}) _transform_id = arguments.delete(:transform_id) method = Elasticsearch::API::HTTP_POST - path = "_transform/#{Utils.__listify(_transform_id)}/_schedule_now" + path = "_transform/#{Utils.listify(_transform_id)}/_schedule_now" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/set_upgrade_mode.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/set_upgrade_mode.rb new file mode 100644 index 0000000000..a44651f67a --- /dev/null +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/set_upgrade_mode.rb @@ -0,0 +1,77 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. +module Elasticsearch + module API + module Transform + module Actions + # Set upgrade_mode for transform indices. + # Sets a cluster wide upgrade_mode setting that prepares transform + # indices for an upgrade. + # When upgrading your cluster, in some circumstances you must restart your + # nodes and reindex your transform indices. In those circumstances, + # there must be no transforms running. You can close the transforms, + # do the upgrade, then open all the transforms again. Alternatively, + # you can use this API to temporarily halt tasks associated with the transforms + # and prevent new transforms from opening. You can also use this API + # during upgrades that do not require you to reindex your transform + # indices, though stopping transforms is not a requirement in that case. + # You can see the current value for the upgrade_mode setting by using the get + # transform info API. + # + # @option arguments [Boolean] :enabled When `true`, it enables `upgrade_mode` which temporarily halts all + # transform tasks and prohibits new transform tasks from + # starting. + # @option arguments [Time] :timeout The time to wait for the request to be completed. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. + # @option arguments [Hash] :headers Custom HTTP headers + # + # @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-transform-set-upgrade-mode + # + def set_upgrade_mode(arguments = {}) + request_opts = { endpoint: arguments[:endpoint] || 'transform.set_upgrade_mode' } + + arguments = arguments.clone + headers = arguments.delete(:headers) || {} + + body = nil + + method = Elasticsearch::API::HTTP_POST + path = '_transform/set_upgrade_mode' + params = Utils.process_params(arguments) + + Elasticsearch::API::Response.new( + perform_request(method, path, params, body, headers, request_opts) + ) + end + end + end + end +end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/start_transform.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/start_transform.rb index 4f18b6a0b7..03e7a65e25 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/start_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/start_transform.rb @@ -15,21 +15,45 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Transform module Actions - # Starts one or more transforms. + # Start a transform. + # When you start a transform, it creates the destination index if it does not already exist. The `number_of_shards` is + # set to `1` and the `auto_expand_replicas` is set to `0-1`. If it is a pivot transform, it deduces the mapping + # definitions for the destination index from the source indices and the transform aggregations. If fields in the + # destination index are derived from scripts (as in the case of `scripted_metric` or `bucket_script` aggregations), + # the transform uses dynamic mappings unless an index template exists. If it is a latest transform, it does not deduce + # mapping definitions; it uses dynamic mappings. To use explicit mappings, create the destination index before you + # start the transform. Alternatively, you can create an index template, though it does not affect the deduced mappings + # in a pivot transform. + # When the transform starts, a series of validations occur to ensure its success. If you deferred validation when you + # created the transform, they occur when you start the transform—​with the exception of privilege checks. When + # Elasticsearch security features are enabled, the transform remembers which roles the user that created it had at the + # time of creation and uses those same roles. If those roles do not have the required privileges on the source and + # destination indices, the transform fails when it attempts unauthorized operations. # - # @option arguments [String] :transform_id The id of the transform to start - # @option arguments [String] :from Restricts the set of transformed entities to those changed after this time - # @option arguments [Time] :timeout Controls the time to wait for the transform to start + # @option arguments [String] :transform_id Identifier for the transform. (*Required*) + # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [String] :from Restricts the set of transformed entities to those changed after this time. Relative times like now-30d are supported. Only applicable for continuous transforms. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/start-transform.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-start-transform # def start_transform(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'transform.start_transform' } @@ -49,7 +73,7 @@ def start_transform(arguments = {}) _transform_id = arguments.delete(:transform_id) method = Elasticsearch::API::HTTP_POST - path = "_transform/#{Utils.__listify(_transform_id)}/_start" + path = "_transform/#{Utils.listify(_transform_id)}/_start" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/stop_transform.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/stop_transform.rb index 00a4c41355..020c3471c8 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/stop_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/stop_transform.rb @@ -15,24 +15,44 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Transform module Actions + # Stop transforms. # Stops one or more transforms. # - # @option arguments [String] :transform_id The id of the transform to stop - # @option arguments [Boolean] :force Whether to force stop a failed transform or not. Default to false - # @option arguments [Boolean] :wait_for_completion Whether to wait for the transform to fully stop before returning or not. Default to false - # @option arguments [Time] :timeout Controls the time to wait until the transform has stopped. Default to 30 seconds - # @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified) - # @option arguments [Boolean] :wait_for_checkpoint Whether to wait for the transform to reach a checkpoint before stopping. Default to false + # @option arguments [String] :transform_id Identifier for the transform. To stop multiple transforms, use a comma-separated list or a wildcard expression. + # To stop all transforms, use `_all` or `*` as the identifier. (*Required*) + # @option arguments [Boolean] :allow_no_match Specifies what to do when the request: contains wildcard expressions and there are no transforms that match; + # contains the `_all` string or no identifiers and there are no matches; contains wildcard expressions and there + # are only partial matches.If it is true, the API returns a successful acknowledgement message when there are no matches. When there are + # only partial matches, the API stops the appropriate transforms.If it is false, the request returns a 404 status code when there are no matches or only partial matches. Server default: true. + # @option arguments [Boolean] :force If it is true, the API forcefully stops the transforms. + # @option arguments [Time] :timeout Period to wait for a response when `wait_for_completion` is `true`. If no response is received before the + # timeout expires, the request returns a timeout exception. However, the request continues processing and + # eventually moves the transform to a STOPPED state. Server default: 30s. + # @option arguments [Boolean] :wait_for_checkpoint If it is true, the transform does not completely stop until the current checkpoint is completed. If it is false, + # the transform stops as soon as possible. + # @option arguments [Boolean] :wait_for_completion If it is true, the API blocks until the indexer state completely stops. If it is false, the API returns + # immediately and the indexer is stopped asynchronously in the background. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-transform.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-stop-transform # def stop_transform(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'transform.stop_transform' } @@ -52,7 +72,7 @@ def stop_transform(arguments = {}) _transform_id = arguments.delete(:transform_id) method = Elasticsearch::API::HTTP_POST - path = "_transform/#{Utils.__listify(_transform_id)}/_stop" + path = "_transform/#{Utils.listify(_transform_id)}/_stop" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/update_transform.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/update_transform.rb index 44e04a7ee1..5d85f6ac82 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/update_transform.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/update_transform.rb @@ -15,22 +15,42 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Transform module Actions + # Update a transform. # Updates certain properties of a transform. + # All updated properties except `description` do not take effect until after the transform starts the next checkpoint, + # thus there is data consistency in each checkpoint. To use this API, you must have `read` and `view_index_metadata` + # privileges for the source indices. You must also have `index` and `read` privileges for the destination index. When + # Elasticsearch security features are enabled, the transform remembers which roles the user who updated it had at the + # time of update and runs with those privileges. # - # @option arguments [String] :transform_id The id of the transform. (*Required*) - # @option arguments [Boolean] :defer_validation If validations should be deferred until transform starts, defaults to false. - # @option arguments [Time] :timeout Controls the time to wait for the update + # @option arguments [String] :transform_id Identifier for the transform. (*Required*) + # @option arguments [Boolean] :defer_validation When true, deferrable validations are not run. This behavior may be + # desired if the source index does not exist until after the transform is + # created. + # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the + # timeout expires, the request fails and returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The update transform definition (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/update-transform.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-update-transform # def update_transform(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'transform.update_transform' } @@ -51,7 +71,7 @@ def update_transform(arguments = {}) _transform_id = arguments.delete(:transform_id) method = Elasticsearch::API::HTTP_POST - path = "_transform/#{Utils.__listify(_transform_id)}/_update" + path = "_transform/#{Utils.listify(_transform_id)}/_update" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/transform/upgrade_transforms.rb b/elasticsearch-api/lib/elasticsearch/api/actions/transform/upgrade_transforms.rb index b2d1a84cd6..5f8137718d 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/transform/upgrade_transforms.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/transform/upgrade_transforms.rb @@ -15,20 +15,43 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Transform module Actions - # Upgrades all transforms. + # Upgrade all transforms. + # Transforms are compatible across minor versions and between supported major versions. + # However, over time, the format of transform configuration information may change. + # This API identifies transforms that have a legacy configuration format and upgrades them to the latest version. + # It also cleans up the internal data structures that store the transform state and checkpoints. + # The upgrade does not affect the source and destination indices. + # The upgrade also does not affect the roles that transforms use when Elasticsearch security features are enabled; the role used to read source data and write to the destination index remains unchanged. + # If a transform upgrade step fails, the upgrade stops and an error is returned about the underlying issue. + # Resolve the issue then re-run the process again. + # A summary is returned when the upgrade is finished. + # To ensure continuous transforms remain running during a major version upgrade of the cluster – for example, from 7.16 to 8.0 – it is recommended to upgrade transforms before upgrading the cluster. + # You may want to perform a recent cluster backup prior to the upgrade. # - # @option arguments [Boolean] :dry_run Whether to only check for updates but don't execute - # @option arguments [Time] :timeout Controls the time to wait for the upgrade + # @option arguments [Boolean] :dry_run When true, the request checks for updates but does not run them. + # @option arguments [Time] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and + # returns an error. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/upgrade-transforms.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-transform-upgrade-transforms # def upgrade_transforms(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'transform.upgrade_transforms' } @@ -36,7 +59,7 @@ def upgrade_transforms(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_POST path = '_transform/_upgrade' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/update.rb b/elasticsearch-api/lib/elasticsearch/api/actions/update.rb index 1454a5e592..bfb99599c3 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/update.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/update.rb @@ -15,38 +15,70 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Updates a document with a script or partial document. + # Update a document. + # Update a document by running a script or passing a partial document. + # If the Elasticsearch security features are enabled, you must have the `index` or `write` index privilege for the target index or index alias. + # The script can update, delete, or skip modifying the document. + # The API also supports passing a partial document, which is merged into the existing document. + # To fully replace an existing document, use the index API. + # This operation: + # * Gets the document (collocated with the shard) from the index. + # * Runs the specified script. + # * Indexes the result. + # The document must still be reindexed, but using this API removes some network roundtrips and reduces chances of version conflicts between the GET and the index operation. + # The `_source` field must be enabled to use this API. + # In addition to `_source`, you can access the following variables through the `ctx` map: `_index`, `_type`, `_id`, `_version`, `_routing`, and `_now` (the current timestamp). + # For usage examples such as partial updates, upserts, and scripted updates, see the External documentation. # - # @option arguments [String] :id Document ID - # @option arguments [String] :index The name of the index - # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the update operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) - # @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return - # @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field - # @option arguments [List] :_source_includes A list of fields to extract and return from the _source field - # @option arguments [String] :lang The script language (default: painless) - # @option arguments [String] :refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes. (options: true, false, wait_for) - # @option arguments [Number] :retry_on_conflict Specify how many times should the operation be retried when a conflict occurs (default: 0) - # @option arguments [String] :routing Specific routing value - # @option arguments [Time] :timeout Explicit operation timeout - # @option arguments [Number] :if_seq_no only perform the update operation if the last operation that has changed the document has the specified sequence number - # @option arguments [Number] :if_primary_term only perform the update operation if the last operation that has changed the document has the specified primary term - # @option arguments [Boolean] :require_alias When true, requires destination is an alias. Default is false - # @option arguments [Boolean] :include_source_on_error True or false if to include the document source in the error message in case of parsing errors. Defaults to true. + # @option arguments [String] :id A unique identifier for the document to be updated. (*Required*) + # @option arguments [String] :index The name of the target index. + # By default, the index is created automatically if it doesn't exist. (*Required*) + # @option arguments [Integer] :if_primary_term Only perform the operation if the document has this primary term. + # @option arguments [Integer] :if_seq_no Only perform the operation if the document has this sequence number. + # @option arguments [Boolean] :include_source_on_error True or false if to include the document source in the error message in case of parsing errors. Server default: true. + # @option arguments [String] :lang The script language. Server default: painless. + # @option arguments [String] :refresh If 'true', Elasticsearch refreshes the affected shards to make this operation visible to search. + # If 'wait_for', it waits for a refresh to make this operation visible to search. + # If 'false', it does nothing with refreshes. Server default: false. + # @option arguments [Boolean] :require_alias If `true`, the destination must be an index alias. + # @option arguments [Integer] :retry_on_conflict The number of times the operation should be retried when a conflict occurs. Server default: 0. + # @option arguments [String] :routing A custom value used to route operations to a specific shard. + # @option arguments [Time] :timeout The period to wait for the following operations: dynamic mapping updates and waiting for active shards. + # Elasticsearch waits for at least the timeout period before failing. + # The actual wait time could be longer, particularly when multiple waits occur. Server default: 1m. + # @option arguments [Integer, String] :wait_for_active_shards The number of copies of each shard that must be active before proceeding with the operation. + # Set to 'all' or any positive integer up to the total number of shards in the index (`number_of_replicas`+1). + # The default value of `1` means it waits for each primary shard to be active. Server default: 1. + # @option arguments [Boolean, String, Array] :_source If `false`, source retrieval is turned off. + # You can also specify a comma-separated list of the fields you want to retrieve. Server default: true. + # @option arguments [String, Array] :_source_excludes The source fields you want to exclude. + # @option arguments [String, Array] :_source_includes The source fields you want to retrieve. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The request definition requires either `script` or partial `doc` (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-update # def update(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'update' } - defined_params = %i[index id].each_with_object({}) do |variable, set_variables| + defined_params = [:index, :id].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -65,11 +97,11 @@ def update(arguments = {}) _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_POST - path = "#{Utils.__listify(_index)}/_update/#{Utils.__listify(_id)}" + path = "#{Utils.listify(_index)}/_update/#{Utils.listify(_id)}" params = Utils.process_params(arguments) if Array(arguments[:ignore]).include?(404) - Utils.__rescue_from_not_found do + Utils.rescue_from_not_found do Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query.rb b/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query.rb index fb65ca3564..25ceae015a 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query.rb @@ -15,51 +15,162 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Performs an update on every document in the index without changing the source, - # for example to pick up a mapping change. + # Update documents. + # Updates documents that match the specified query. + # If no query is specified, performs an update on every document in the data stream or index without modifying the source, which is useful for picking up mapping changes. + # If the Elasticsearch security features are enabled, you must have the following index privileges for the target data stream, index, or alias: + # * `read` + # * `index` or `write` + # You can specify the query criteria in the request URI or the request body using the same syntax as the search API. + # When you submit an update by query request, Elasticsearch gets a snapshot of the data stream or index when it begins processing the request and updates matching documents using internal versioning. + # When the versions match, the document is updated and the version number is incremented. + # If a document changes between the time that the snapshot is taken and the update operation is processed, it results in a version conflict and the operation fails. + # You can opt to count version conflicts instead of halting and returning by setting `conflicts` to `proceed`. + # Note that if you opt to count version conflicts, the operation could attempt to update more documents from the source than `max_docs` until it has successfully updated `max_docs` documents or it has gone through every document in the source query. + # NOTE: Documents with a version equal to 0 cannot be updated using update by query because internal versioning does not support 0 as a valid version number. + # While processing an update by query request, Elasticsearch performs multiple search requests sequentially to find all of the matching documents. + # A bulk update request is performed for each batch of matching documents. + # Any query or update failures cause the update by query request to fail and the failures are shown in the response. + # Any update requests that completed successfully still stick, they are not rolled back. + # **Refreshing shards** + # Specifying the `refresh` parameter refreshes all shards once the request completes. + # This is different to the update API's `refresh` parameter, which causes only the shard + # that received the request to be refreshed. Unlike the update API, it does not support + # `wait_for`. + # **Running update by query asynchronously** + # If the request contains `wait_for_completion=false`, Elasticsearch + # performs some preflight checks, launches the request, and returns a + # {https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks task} you can use to cancel or get the status of the task. + # Elasticsearch creates a record of this task as a document at `.tasks/task/${taskId}`. + # **Waiting for active shards** + # `wait_for_active_shards` controls how many copies of a shard must be active + # before proceeding with the request. See {https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-create#operation-create-wait_for_active_shards `wait_for_active_shards`} + # for details. `timeout` controls how long each write request waits for unavailable + # shards to become available. Both work exactly the way they work in the + # {https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-bulk Bulk API}. Update by query uses scrolled searches, so you can also + # specify the `scroll` parameter to control how long it keeps the search context + # alive, for example `?scroll=10m`. The default is 5 minutes. + # **Throttling update requests** + # To control the rate at which update by query issues batches of update operations, you can set `requests_per_second` to any positive decimal number. + # This pads each batch with a wait time to throttle the rate. + # Set `requests_per_second` to `-1` to turn off throttling. + # Throttling uses a wait time between batches so that the internal scroll requests can be given a timeout that takes the request padding into account. + # The padding time is the difference between the batch size divided by the `requests_per_second` and the time spent writing. + # By default the batch size is 1000, so if `requests_per_second` is set to `500`: + # + # ``` + # target_time = 1000 / 500 per second = 2 seconds + # wait_time = target_time - write_time = 2 seconds - .5 seconds = 1.5 seconds + # ``` + # + # Since the batch is issued as a single _bulk request, large batch sizes cause Elasticsearch to create many requests and wait before starting the next set. + # This is "bursty" instead of "smooth". + # **Slicing** + # Update by query supports sliced scroll to parallelize the update process. + # This can improve efficiency and provide a convenient way to break the request down into smaller parts. + # Setting `slices` to `auto` chooses a reasonable number for most data streams and indices. + # This setting will use one slice per shard, up to a certain limit. + # If there are multiple source data streams or indices, it will choose the number of slices based on the index or backing index with the smallest number of shards. + # Adding `slices` to `_update_by_query` just automates the manual process of creating sub-requests, which means it has some quirks: + # * You can see these requests in the tasks APIs. These sub-requests are "child" tasks of the task for the request with slices. + # * Fetching the status of the task for the request with `slices` only contains the status of completed slices. + # * These sub-requests are individually addressable for things like cancellation and rethrottling. + # * Rethrottling the request with `slices` will rethrottle the unfinished sub-request proportionally. + # * Canceling the request with slices will cancel each sub-request. + # * Due to the nature of slices each sub-request won't get a perfectly even portion of the documents. All documents will be addressed, but some slices may be larger than others. Expect larger slices to have a more even distribution. + # * Parameters like `requests_per_second` and `max_docs` on a request with slices are distributed proportionally to each sub-request. Combine that with the point above about distribution being uneven and you should conclude that using `max_docs` with `slices` might not result in exactly `max_docs` documents being updated. + # * Each sub-request gets a slightly different snapshot of the source data stream or index though these are all taken at approximately the same time. + # If you're slicing manually or otherwise tuning automatic slicing, keep in mind that: + # * Query performance is most efficient when the number of slices is equal to the number of shards in the index or backing index. If that number is large (for example, 500), choose a lower number as too many slices hurts performance. Setting slices higher than the number of shards generally does not improve efficiency and adds overhead. + # * Update performance scales linearly across available resources with the number of slices. + # Whether query or update performance dominates the runtime depends on the documents being reindexed and cluster resources. + # Refer to the linked documentation for examples of how to update documents using the `_update_by_query` API: # - # @option arguments [List] :index A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices - # @option arguments [String] :analyzer The analyzer to use for the query string - # @option arguments [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed (default: false) - # @option arguments [String] :default_operator The default operator for query string query (AND or OR) (options: AND, OR) - # @option arguments [String] :df The field to use as default where no field prefix is given in the query string - # @option arguments [Number] :from Starting offset (default: 0) - # @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) - # @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) - # @option arguments [String] :conflicts What to do when the update by query hits version conflicts? (options: abort, proceed) - # @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all) - # @option arguments [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored - # @option arguments [String] :pipeline Ingest pipeline to set on index requests made by this action. (default: none) - # @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random) - # @option arguments [String] :q Query in the Lucene query string syntax - # @option arguments [List] :routing A comma-separated list of specific routing values - # @option arguments [Time] :scroll Specify how long a consistent view of the index should be maintained for scrolled search - # @option arguments [String] :search_type Search operation type (options: query_then_fetch, dfs_query_then_fetch) - # @option arguments [Time] :search_timeout Explicit timeout for each search request. Defaults to no timeout. - # @option arguments [Number] :max_docs Maximum number of documents to process (default: all documents) - # @option arguments [List] :sort A comma-separated list of : pairs - # @option arguments [Number] :terminate_after The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early. - # @option arguments [List] :stats Specific 'tag' of the request for logging and statistical purposes - # @option arguments [Boolean] :version Specify whether to return document version as part of a hit + # @option arguments [String, Array] :index A comma-separated list of data streams, indices, and aliases to search. + # It supports wildcards (`*`). + # To search all data streams or indices, omit this parameter or use `*` or `_all`. (*Required*) + # @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`. Server default: true. + # @option arguments [String] :analyzer The analyzer to use for the query string. + # This parameter can be used only when the `q` query string parameter is specified. + # @option arguments [Boolean] :analyze_wildcard If `true`, wildcard and prefix queries are analyzed. + # This parameter can be used only when the `q` query string parameter is specified. + # @option arguments [String] :conflicts The preferred behavior when update by query hits version conflicts: `abort` or `proceed`. Server default: abort. + # @option arguments [String] :default_operator The default operator for query string query: `AND` or `OR`. + # This parameter can be used only when the `q` query string parameter is specified. Server default: OR. + # @option arguments [String] :df The field to use as default where no field prefix is given in the query string. + # This parameter can be used only when the `q` query string parameter is specified. + # @option arguments [String, Array] :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`. + # @option arguments [Integer] :from Skips the specified number of documents. Server default: 0. + # @option arguments [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index. + # @option arguments [Boolean] :lenient If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. + # This parameter can be used only when the `q` query string parameter is specified. + # @option arguments [Integer] :max_docs The maximum number of documents to process. + # It defaults to all documents. + # When set to a value less then or equal to `scroll_size` then a scroll will not be used to retrieve the results for the operation. + # @option arguments [String] :pipeline The ID of the pipeline to use to preprocess incoming documents. + # If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request. + # If a final pipeline is configured it will always run, regardless of the value of this parameter. + # @option arguments [String] :preference The node or shard the operation should be performed on. + # It is random by default. + # @option arguments [String] :q A query in the Lucene query string syntax. + # @option arguments [Boolean] :refresh If `true`, Elasticsearch refreshes affected shards to make the operation visible to search after the request completes. + # This is different than the update API's `refresh` parameter, which causes just the shard that received the request to be refreshed. + # @option arguments [Boolean] :request_cache If `true`, the request cache is used for this request. + # It defaults to the index-level setting. + # @option arguments [Float] :requests_per_second The throttle for this request in sub-requests per second. Server default: -1. + # @option arguments [String] :routing A custom value used to route operations to a specific shard. + # @option arguments [Time] :scroll The period to retain the search context for scrolling. Server default: 5m. + # @option arguments [Integer] :scroll_size The size of the scroll request that powers the operation. Server default: 1000. + # @option arguments [Time] :search_timeout An explicit timeout for each search request. + # By default, there is no timeout. + # @option arguments [String] :search_type The type of the search operation. Available options include `query_then_fetch` and `dfs_query_then_fetch`. + # @option arguments [Integer, String] :slices The number of slices this task should be divided into. Server default: 1. + # @option arguments [Array] :sort A comma-separated list of : pairs. + # @option arguments [Array] :stats The specific `tag` of the request for logging and statistical purposes. + # @option arguments [Integer] :terminate_after The maximum number of documents to collect for each shard. + # If a query reaches this limit, Elasticsearch terminates the query early. + # Elasticsearch collects documents before sorting.IMPORTANT: Use with caution. + # Elasticsearch applies this parameter to each shard handling the request. + # When possible, let Elasticsearch perform early termination automatically. + # Avoid specifying this parameter for requests that target data streams with backing indices across multiple data tiers. + # @option arguments [Time] :timeout The period each update request waits for the following operations: dynamic mapping updates, waiting for active shards. + # By default, it is one minute. + # This guarantees Elasticsearch waits for at least the timeout before failing. + # The actual wait time could be longer, particularly when multiple waits occur. Server default: 1m. + # @option arguments [Boolean] :version If `true`, returns the document version as part of a hit. # @option arguments [Boolean] :version_type Should the document increment the version number (internal) on hit or not (reindex) - # @option arguments [Boolean] :request_cache Specify if request cache should be used for this request or not, defaults to index level setting - # @option arguments [Boolean] :refresh Should the affected indexes be refreshed? - # @option arguments [Time] :timeout Time each individual bulk request should wait for shards that are unavailable. - # @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the update by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1) - # @option arguments [Number] :scroll_size Size on the scroll request powering the update by query - # @option arguments [Boolean] :wait_for_completion Should the request should block until the update by query operation is complete. - # @option arguments [Number] :requests_per_second The throttle to set on this request in sub-requests per second. -1 means no throttle. - # @option arguments [Number|string] :slices The number of slices this task should be divided into. Defaults to 1, meaning the task isn't sliced into subtasks. Can be set to `auto`. + # @option arguments [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operation. + # Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). + # The `timeout` parameter controls how long each write request waits for unavailable shards to become available. + # Both work exactly the way they work in the bulk API. Server default: 1. + # @option arguments [Boolean] :wait_for_completion If `true`, the request blocks until the operation is complete. + # If `false`, Elasticsearch performs some preflight checks, launches the request, and returns a task ID that you can use to cancel or get the status of the task. + # Elasticsearch creates a record of this task as a document at `.tasks/task/${taskId}`. Server default: true. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The search definition using the Query DSL + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-update-by-query # def update_by_query(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'update_by_query' } @@ -74,12 +185,12 @@ def update_by_query(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) _index = arguments.delete(:index) method = Elasticsearch::API::HTTP_POST - path = "#{Utils.__listify(_index)}/_update_by_query" + path = "#{Utils.listify(_index)}/_update_by_query" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb b/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb index 801ed1bcd4..b7414b54a1 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb @@ -15,19 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Actions - # Changes the number of requests per second for a particular Update By Query operation. + # Throttle an update by query operation. + # Change the number of requests per second for a particular update by query operation. + # Rethrottling that speeds up the query takes effect immediately but rethrotting that slows down the query takes effect after completing the current batch to prevent scroll timeouts. # - # @option arguments [String] :task_id The task id to rethrottle - # @option arguments [Number] :requests_per_second The throttle to set on this request in floating sub-requests per second. -1 means set no throttle. (*Required*) + # @option arguments [String] :task_id The ID for the task. (*Required*) + # @option arguments [Float] :requests_per_second The throttle for this request in sub-requests per second. + # To turn off throttling, set it to `-1`. Server default: -1. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-update-by-query.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-update-by-query-rethrottle # def update_by_query_rethrottle(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'update_by_query_rethrottle' } @@ -47,7 +61,7 @@ def update_by_query_rethrottle(arguments = {}) _task_id = arguments.delete(:task_id) method = Elasticsearch::API::HTTP_POST - path = "_update_by_query/#{Utils.__listify(_task_id)}/_rethrottle" + path = "_update_by_query/#{Utils.listify(_task_id)}/_rethrottle" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/ack_watch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/ack_watch.rb index 6539662686..4a8664af64 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/ack_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/ack_watch.rb @@ -15,25 +15,44 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Watcher module Actions - # Acknowledges a watch, manually throttling the execution of the watch's actions. + # Acknowledge a watch. + # Acknowledging a watch enables you to manually throttle the execution of the watch's actions. + # The acknowledgement state of an action is stored in the `status.actions..ack.state` structure. + # IMPORTANT: If the specified watch is currently being executed, this API will return an error + # The reason for this behavior is to prevent overwriting the watch status from a watch execution. + # Acknowledging an action throttles further executions of that action until its `ack.state` is reset to `awaits_successful_execution`. + # This happens when the condition of the watch is not met (the condition evaluates to false). + # To demonstrate how throttling works in practice and how it can be configured for individual actions within a watch, refer to External documentation. # - # @option arguments [String] :watch_id Watch ID - # @option arguments [List] :action_id A comma-separated list of the action ids to be acked + # @option arguments [String] :watch_id The watch identifier. (*Required*) + # @option arguments [String, Array] :action_id A comma-separated list of the action identifiers to acknowledge. + # If you omit this parameter, all of the actions of the watch are acknowledged. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-ack-watch.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-ack-watch # def ack_watch(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.ack_watch' } - defined_params = %i[watch_id action_id].each_with_object({}) do |variable, set_variables| + defined_params = [:watch_id, :action_id].each_with_object({}) do |variable, set_variables| set_variables[variable] = arguments[variable] if arguments.key?(variable) end request_opts[:defined_params] = defined_params unless defined_params.empty? @@ -51,11 +70,11 @@ def ack_watch(arguments = {}) method = Elasticsearch::API::HTTP_PUT path = if _watch_id && _action_id - "_watcher/watch/#{Utils.__listify(_watch_id)}/_ack/#{Utils.__listify(_action_id)}" + "_watcher/watch/#{Utils.listify(_watch_id)}/_ack/#{Utils.listify(_action_id)}" else - "_watcher/watch/#{Utils.__listify(_watch_id)}/_ack" + "_watcher/watch/#{Utils.listify(_watch_id)}/_ack" end - params = {} + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/activate_watch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/activate_watch.rb index 739a1d774d..3207cfa2b6 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/activate_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/activate_watch.rb @@ -15,19 +15,31 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Watcher module Actions - # Activates a currently inactive watch. + # Activate a watch. + # A watch can be either active or inactive. # - # @option arguments [String] :watch_id Watch ID + # @option arguments [String] :watch_id The watch identifier. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-activate-watch.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-activate-watch # def activate_watch(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.activate_watch' } @@ -47,8 +59,8 @@ def activate_watch(arguments = {}) _watch_id = arguments.delete(:watch_id) method = Elasticsearch::API::HTTP_PUT - path = "_watcher/watch/#{Utils.__listify(_watch_id)}/_activate" - params = {} + path = "_watcher/watch/#{Utils.listify(_watch_id)}/_activate" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/deactivate_watch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/deactivate_watch.rb index 645558f549..2d8d560619 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/deactivate_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/deactivate_watch.rb @@ -15,19 +15,31 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Watcher module Actions - # Deactivates a currently active watch. + # Deactivate a watch. + # A watch can be either active or inactive. # - # @option arguments [String] :watch_id Watch ID + # @option arguments [String] :watch_id The watch identifier. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-deactivate-watch.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-deactivate-watch # def deactivate_watch(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.deactivate_watch' } @@ -47,8 +59,8 @@ def deactivate_watch(arguments = {}) _watch_id = arguments.delete(:watch_id) method = Elasticsearch::API::HTTP_PUT - path = "_watcher/watch/#{Utils.__listify(_watch_id)}/_deactivate" - params = {} + path = "_watcher/watch/#{Utils.listify(_watch_id)}/_deactivate" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/delete_watch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/delete_watch.rb index 8a6ae856d7..b5c289bc94 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/delete_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/delete_watch.rb @@ -15,19 +15,35 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Watcher module Actions - # Removes a watch from Watcher. + # Delete a watch. + # When the watch is removed, the document representing the watch in the `.watches` index is gone and it will never be run again. + # Deleting a watch does not delete any watch execution records related to this watch from the watch history. + # IMPORTANT: Deleting a watch must be done by using only this API. + # Do not delete the watch directly from the `.watches` index using the Elasticsearch delete document API + # When Elasticsearch security features are enabled, make sure no write privileges are granted to anyone for the `.watches` index. # - # @option arguments [String] :id Watch ID + # @option arguments [String] :id The watch identifier. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-delete-watch.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-delete-watch # def delete_watch(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.delete_watch' } @@ -47,11 +63,11 @@ def delete_watch(arguments = {}) _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_DELETE - path = "_watcher/watch/#{Utils.__listify(_id)}" + path = "_watcher/watch/#{Utils.listify(_id)}" params = Utils.process_params(arguments) if Array(arguments[:ignore]).include?(404) - Utils.__rescue_from_not_found do + Utils.rescue_from_not_found do Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) ) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/execute_watch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/execute_watch.rb index 72d49ad08b..bad1741e89 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/execute_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/execute_watch.rb @@ -15,21 +15,42 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Watcher module Actions - # Forces the execution of a stored watch. + # Run a watch. + # This API can be used to force execution of the watch outside of its triggering logic or to simulate the watch execution for debugging purposes. + # For testing and debugging purposes, you also have fine-grained control on how the watch runs. + # You can run the watch without running all of its actions or alternatively by simulating them. + # You can also force execution by ignoring the watch condition and control whether a watch record would be written to the watch history after it runs. + # You can use the run watch API to run watches that are not yet registered by specifying the watch definition inline. + # This serves as great tool for testing and debugging your watches prior to adding them to Watcher. + # When Elasticsearch security features are enabled on your cluster, watches are run with the privileges of the user that stored the watches. + # If your user is allowed to read index `a`, but not index `b`, then the exact same set of rules will apply during execution of a watch. + # When using the run watch API, the authorization data of the user that called the API will be used as a base, instead of the information who stored the watch. + # Refer to the external documentation for examples of watch execution requests, including existing, customized, and inline watches. # - # @option arguments [String] :id Watch ID - # @option arguments [Boolean] :debug indicates whether the watch should execute in debug mode + # @option arguments [String] :id The watch identifier. + # @option arguments [Boolean] :debug Defines whether the watch runs in debug mode. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body Execution control + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-execute-watch.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-execute-watch # def execute_watch(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.execute_watch' } @@ -48,7 +69,7 @@ def execute_watch(arguments = {}) method = Elasticsearch::API::HTTP_PUT path = if _id - "_watcher/watch/#{Utils.__listify(_id)}/_execute" + "_watcher/watch/#{Utils.listify(_id)}/_execute" else '_watcher/watch/_execute' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_settings.rb index 00eb7f13f6..38a032cfdc 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_settings.rb @@ -15,19 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Watcher module Actions - # Retrieve settings for the watcher system index + # Get Watcher index settings. + # Get settings for the Watcher internal index (`.watches`). + # Only a subset of settings are shown, for example `index.auto_expand_replicas` and `index.number_of_replicas`. # - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [Time] :master_timeout The 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. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-get-settings.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-get-settings # def get_settings(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.get_settings' } @@ -35,7 +49,7 @@ def get_settings(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_watcher/settings' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_watch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_watch.rb index bb2f184baa..781d01c9b2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/get_watch.rb @@ -15,19 +15,30 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Watcher module Actions - # Retrieves a watch by its ID. + # Get a watch. # - # @option arguments [String] :id Watch ID + # @option arguments [String] :id The watch identifier. (*Required*) + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-get-watch.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-get-watch # def get_watch(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.get_watch' } @@ -47,8 +58,8 @@ def get_watch(arguments = {}) _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_GET - path = "_watcher/watch/#{Utils.__listify(_id)}" - params = {} + path = "_watcher/watch/#{Utils.listify(_id)}" + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/put_watch.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/put_watch.rb index 111294f4e5..a2a1c77aa0 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/put_watch.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/put_watch.rb @@ -15,24 +15,44 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Watcher module Actions - # Creates a new watch, or updates an existing one. + # Create or update a watch. + # When a watch is registered, a new document that represents the watch is added to the `.watches` index and its trigger is immediately registered with the relevant trigger engine. + # Typically for the `schedule` trigger, the scheduler is the trigger engine. + # IMPORTANT: You must use Kibana or this API to create a watch. + # Do not add a watch directly to the `.watches` index by using the Elasticsearch index API. + # If Elasticsearch security features are enabled, do not give users write privileges on the `.watches` index. + # When you add a watch you can also define its initial active state by setting the *active* parameter. + # When Elasticsearch security features are enabled, your watch can index or search only on indices for which the user that stored the watch has privileges. + # If the user is able to read index `a`, but not index `b`, the same will apply when the watch runs. # - # @option arguments [String] :id Watch ID - # @option arguments [Boolean] :active Specify whether the watch is in/active by default - # @option arguments [Number] :version Explicit version number for concurrency control - # @option arguments [Number] :if_seq_no only update the watch if the last operation that has changed the watch has the specified sequence number - # @option arguments [Number] :if_primary_term only update the watch if the last operation that has changed the watch has the specified primary term + # @option arguments [String] :id The identifier for the watch. (*Required*) + # @option arguments [Boolean] :active The initial state of the watch. + # The default value is `true`, which means the watch is active by default. Server default: true. + # @option arguments [Integer] :if_primary_term only update the watch if the last operation that has changed the watch has the specified primary term + # @option arguments [Integer] :if_seq_no only update the watch if the last operation that has changed the watch has the specified sequence number + # @option arguments [Integer] :version Explicit version number for concurrency control + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body The watch + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-put-watch.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-put-watch # def put_watch(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.put_watch' } @@ -52,7 +72,7 @@ def put_watch(arguments = {}) _id = arguments.delete(:id) method = Elasticsearch::API::HTTP_PUT - path = "_watcher/watch/#{Utils.__listify(_id)}" + path = "_watcher/watch/#{Utils.listify(_id)}" params = Utils.process_params(arguments) Elasticsearch::API::Response.new( diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/query_watches.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/query_watches.rb index 83d9bc0570..e7f2c23fce 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/query_watches.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/query_watches.rb @@ -15,19 +15,32 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Watcher module Actions - # Retrieves stored watches. + # Query watches. + # Get all registered watches in a paginated manner and optionally filter watches by a query. + # Note that only the `_id` and `metadata.*` fields are queryable or sortable. # + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body From, size, query, sort and search_after + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-query-watches.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-query-watches # def query_watches(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.query_watches' } @@ -35,7 +48,7 @@ def query_watches(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = if body Elasticsearch::API::HTTP_POST @@ -43,8 +56,8 @@ def query_watches(arguments = {}) Elasticsearch::API::HTTP_GET end - path = '_watcher/_query/watches' - params = {} + path = '_watcher/_query/watches' + params = Utils.process_params(arguments) Elasticsearch::API::Response.new( perform_request(method, path, params, body, headers, request_opts) diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/start.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/start.rb index ef2b8ea8e3..125744fb89 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/start.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/start.rb @@ -15,19 +15,31 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Watcher module Actions - # Starts Watcher if it is not already running. + # Start the watch service. + # Start the Watcher service if it is not already running. # - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @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 + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-start.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-start # def start(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.start' } @@ -35,7 +47,7 @@ def start(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_POST path = '_watcher/_start' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stats.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stats.rb index 4ef01863df..18c88727b2 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stats.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stats.rb @@ -15,20 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Watcher module Actions - # Retrieves the current Watcher metrics. + # Get Watcher statistics. + # This API always returns basic metrics. + # You retrieve more metrics by using the metric parameter. # - # @option arguments [List] :metric Controls what additional stat metrics should be include in the response (options: _all, queued_watches, current_watches, pending_watches) - # @option arguments [Boolean] :emit_stacktraces Emits stack traces of currently running watches + # @option arguments [String, Array] :metric Defines which additional metrics are included in the response. + # @option arguments [Boolean] :emit_stacktraces Defines whether stack traces are generated for each watch that is running. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stats.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-stats # def stats(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.stats' } @@ -47,7 +60,7 @@ def stats(arguments = {}) method = Elasticsearch::API::HTTP_GET path = if _metric - "_watcher/stats/#{Utils.__listify(_metric)}" + "_watcher/stats/#{Utils.listify(_metric)}" else '_watcher/stats' end diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stop.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stop.rb index 2f112aedd6..dba184e7de 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stop.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/stop.rb @@ -15,19 +15,33 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Watcher module Actions - # Stops Watcher if it is running. + # Stop the watch service. + # Stop the Watcher service if it is running. # - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [Time] :master_timeout The period to wait for the master node. + # If the master node is not available before the timeout expires, the request fails and returns an error. + # To indicate that the request should never timeout, set it to `-1`. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-stop.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-stop # def stop(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.stop' } @@ -35,7 +49,7 @@ def stop(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_POST path = '_watcher/_stop' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/update_settings.rb b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/update_settings.rb index b316761c9e..95cc9cbcac 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/watcher/update_settings.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/watcher/update_settings.rb @@ -15,21 +15,40 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module Watcher module Actions - # Update settings for the watcher system index + # Update Watcher index settings. + # Update settings for the Watcher internal index (`.watches`). + # Only a subset of settings can be modified. + # This includes `index.auto_expand_replicas`, `index.number_of_replicas`, `index.routing.allocation.exclude.*`, + # `index.routing.allocation.include.*` and `index.routing.allocation.require.*`. + # Modification of `index.routing.allocation.include._tier_preference` is an exception and is not allowed as the + # Watcher shards must always be in the `data_content` tier. # - # @option arguments [Time] :timeout Specify timeout for waiting for acknowledgement from all nodes - # @option arguments [Time] :master_timeout Specify timeout for connection to master + # @option arguments [Time] :master_timeout The 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. + # @option arguments [Time] :timeout The period to wait for a response. + # If no response is received before the timeout expires, the request fails and returns an error. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers - # @option arguments [Hash] :body An object with the new index settings (*Required*) + # @option arguments [Hash] :body request body # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/watcher-api-update-settings.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-watcher-update-settings # def update_settings(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'watcher.update_settings' } @@ -39,7 +58,7 @@ def update_settings(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = arguments.delete(:body) + body = arguments.delete(:body) method = Elasticsearch::API::HTTP_PUT path = '_watcher/settings' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/xpack/info.rb b/elasticsearch-api/lib/elasticsearch/api/actions/xpack/info.rb index 89cb118784..ece2cda8ab 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/xpack/info.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/xpack/info.rb @@ -15,21 +15,38 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module XPack module Actions - # Retrieves information about the installed X-Pack features. + # Get information. + # The information provided by the API includes: + # * Build information including the build number and timestamp. + # * License information about the currently installed license. + # * Feature information for the features that are currently enabled and available under the current license. # - # @option arguments [Boolean] :human Defines whether additional human-readable information is included in the response. In particular, it adds descriptions and a tag line. The default value is true. - # @option arguments [List] :categories Comma-separated list of info categories. Can be any of: build, license, features - # @option arguments [Boolean] :accept_enterprise If this param is used it must be set to true *Deprecated* + # @option arguments [Array] :categories A comma-separated list of the information categories to include in the response. + # For example, `build,license,features`. + # @option arguments [Boolean] :accept_enterprise If this param is used it must be set to true + # @option arguments [Boolean] :human Defines whether additional human-readable information is included in the response. + # In particular, it adds descriptions and a tag line. Server default: true. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/info-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-info # def info(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'xpack.info' } @@ -37,7 +54,7 @@ def info(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_xpack' diff --git a/elasticsearch-api/lib/elasticsearch/api/actions/xpack/usage.rb b/elasticsearch-api/lib/elasticsearch/api/actions/xpack/usage.rb index 2317ef931e..ba802d91ee 100644 --- a/elasticsearch-api/lib/elasticsearch/api/actions/xpack/usage.rb +++ b/elasticsearch-api/lib/elasticsearch/api/actions/xpack/usage.rb @@ -15,19 +15,34 @@ # specific language governing permissions and limitations # under the License. # -# Auto generated from build hash f284cc16f4d4b4289bc679aa1529bb504190fe80 -# @see https://github.com/elastic/elasticsearch/tree/main/rest-api-spec -# +# This code was automatically generated from the Elasticsearch Specification +# See https://github.com/elastic/elasticsearch-specification +# See Elasticsearch::ES_SPECIFICATION_COMMIT for commit hash. module Elasticsearch module API module XPack module Actions - # Retrieves usage information about the installed X-Pack features. + # Get usage information. + # Get information about the features that are currently enabled and available under the current license. + # The API also provides some usage statistics. # - # @option arguments [Time] :master_timeout Specify timeout for watch write operation + # @option arguments [Time] :master_timeout The 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. + # To indicate that the request should never timeout, set it to `-1`. Server default: 30s. + # @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors + # when they occur. + # @option arguments [String, Array] :filter_path Comma-separated list of filters in dot notation which reduce the response + # returned by Elasticsearch. + # @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans. + # For example `"exists_time": "1h"` for humans and + # `"eixsts_time_in_millis": 3600000` for computers. When disabled the human + # readable values will be omitted. This makes sense for responses being consumed + # only by machines. + # @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use + # this option for debugging only. # @option arguments [Hash] :headers Custom HTTP headers # - # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/usage-api.html + # @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/group/endpoint-xpack # def usage(arguments = {}) request_opts = { endpoint: arguments[:endpoint] || 'xpack.usage' } @@ -35,7 +50,7 @@ def usage(arguments = {}) arguments = arguments.clone headers = arguments.delete(:headers) || {} - body = nil + body = nil method = Elasticsearch::API::HTTP_GET path = '_xpack/usage' diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/async_search.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/async_search.rb deleted file mode 100644 index af5f5eafc6..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/async_search.rb +++ /dev/null @@ -1,36 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module AsyncSearch - module Actions; end - - # Client for the "async_search" namespace (includes the {AsyncSearch::Actions} methods) - # - class AsyncSearchClient - include Common::Client, Common::Client::Base, AsyncSearch::Actions - end - - # Proxy method for {AsyncSearchClient}, available in the receiving object - # - def async_search - @async_search ||= AsyncSearchClient.new(self) - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/autoscaling.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/autoscaling.rb deleted file mode 100644 index 0ded4d5e42..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/autoscaling.rb +++ /dev/null @@ -1,36 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module Autoscaling - module Actions; end - - # Client for the "autoscaling" namespace (includes the {Autoscaling::Actions} methods) - # - class AutoscalingClient - include Common::Client, Common::Client::Base, Autoscaling::Actions - end - - # Proxy method for {AutoscalingClient}, available in the receiving object - # - def autoscaling - @autoscaling ||= AutoscalingClient.new(self) - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/cat.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/cat.rb deleted file mode 100644 index ba3952e3bd..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/cat.rb +++ /dev/null @@ -1,36 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module Cat - module Actions; end - - # Client for the "cat" namespace (includes the {Cat::Actions} methods) - # - class CatClient - include Common::Client, Common::Client::Base, Cat::Actions - end - - # Proxy method for {CatClient}, available in the receiving object - # - def cat - @cat ||= CatClient.new(self) - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/cluster.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/cluster.rb deleted file mode 100644 index e2eb15f707..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/cluster.rb +++ /dev/null @@ -1,37 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module Cluster - module Actions; end - - # Client for the "cluster" namespace (includes the {Cluster::Actions} methods) - # - class ClusterClient - include Common::Client, Common::Client::Base, Cluster::Actions - end - - # Proxy method for {ClusterClient}, available in the receiving object - # - def cluster - @cluster ||= ClusterClient.new(self) - end - - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/common.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/common.rb deleted file mode 100644 index 789aca2514..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/common.rb +++ /dev/null @@ -1,42 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module Common - module Actions; end - - module Client - # Base client wrapper - # - module Base - attr_reader :client - - def initialize(client) - @client = client - end - end - - # Delegates the `perform_request` method to the wrapped client - # - def perform_request(method, path, params={}, body=nil, headers=nil, request_opts={}) - client.perform_request method, path, params, body, headers, request_opts - end - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/connector.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/connector.rb deleted file mode 100644 index b9bed44085..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/connector.rb +++ /dev/null @@ -1,36 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module Connector - module Actions; end - - # Client for the "connector" namespace (includes the {Connector::Actions} methods) - # - class ConnectorClient - include Common::Client, Common::Client::Base, Connector::Actions - end - - # Proxy method for {ConnectorClient}, available in the receiving object - # - def connector - @connector ||= ConnectorClient.new(self) - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/cross_cluster_replication.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/cross_cluster_replication.rb deleted file mode 100644 index d9cb230653..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/cross_cluster_replication.rb +++ /dev/null @@ -1,38 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module CrossClusterReplication - module Actions; end - - # Client for the "cross_cluster_replication" namespace (includes the {CrossClusterReplication::Actions} methods) - # - class CrossClusterReplicationClient - include Common::Client, Common::Client::Base, CrossClusterReplication::Actions - end - - # Proxy method for {CrossClusterReplicationClient}, available in the receiving object - # - def cross_cluster_replication - @cross_cluster_replication ||= CrossClusterReplicationClient.new(self) - end - - alias ccr cross_cluster_replication - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/dangling_indices.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/dangling_indices.rb deleted file mode 100644 index 76291aaede..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/dangling_indices.rb +++ /dev/null @@ -1,35 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module DanglingIndices - module Actions; end - # Client for the "dangling_indices" namespace (includes the {DanglingIndices::Actions} methods) - # - class DanglingIndicesClient - include Common::Client, Common::Client::Base, DanglingIndices::Actions - end - - # Proxy method for {DanglingIndicesClient}, available in the receiving object - # - def dangling_indices - @dangling_indices ||= DanglingIndicesClient.new(self) - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/data_frame_transform_deprecated.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/data_frame_transform_deprecated.rb deleted file mode 100644 index 8487199af4..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/data_frame_transform_deprecated.rb +++ /dev/null @@ -1,36 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module DataFrameTransformDeprecated - module Actions; end - - # Client for the "data_frame_transform_deprecated" namespace (includes the {DataFrameTransformDeprecated::Actions} methods) - # - class DataFrameTransformDeprecatedClient - include Common::Client, Common::Client::Base, DataFrameTransformDeprecated::Actions - end - - # Proxy method for {DataFrameTransformDeprecatedClient}, available in the receiving object - # - def data_frame_transform_deprecated - @data_frame_transform_deprecated ||= DataFrameTransformDeprecatedClient.new(self) - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/enrich.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/enrich.rb deleted file mode 100644 index d591cc99ac..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/enrich.rb +++ /dev/null @@ -1,36 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module Enrich - module Actions; end - - # Client for the "enrich" namespace (includes the {Enrich::Actions} methods) - # - class EnrichClient - include Common::Client, Common::Client::Base, Enrich::Actions - end - - # Proxy method for {EnrichClient}, available in the receiving object - # - def enrich - @enrich ||= EnrichClient.new(self) - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/eql.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/eql.rb deleted file mode 100644 index 38c9f891e2..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/eql.rb +++ /dev/null @@ -1,36 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module Eql - module Actions; end - - # Client for the "eql" namespace (includes the {Eql::Actions} methods) - # - class EqlClient - include Common::Client, Common::Client::Base, Eql::Actions - end - - # Proxy method for {EqlClient}, available in the receiving object - # - def eql - @eql ||= EqlClient.new(self) - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/esql.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/esql.rb deleted file mode 100644 index e41c6c7128..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/esql.rb +++ /dev/null @@ -1,36 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module Esql - module Actions; end - - # Client for the "esql" namespace (includes the {Esql::Actions} methods) - # - class EsqlClient - include Common::Client, Common::Client::Base, Esql::Actions - end - - # Proxy method for {EsqlClient}, available in the receiving object - # - def esql - @esql ||= EsqlClient.new(self) - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/features.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/features.rb deleted file mode 100644 index 8b968f167e..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/features.rb +++ /dev/null @@ -1,36 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module Features - module Actions; end - - # Client for the "features" namespace (includes the {Features::Actions} methods) - # - class FeaturesClient - include Common::Client, Common::Client::Base, Features::Actions - end - - # Proxy method for {FeaturesClient}, available in the receiving object - # - def features - @features ||= FeaturesClient.new(self) - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/fleet.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/fleet.rb deleted file mode 100644 index 81f8cc369e..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/fleet.rb +++ /dev/null @@ -1,36 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module Fleet - module Actions; end - - # Client for the "fleet" namespace (includes the {Fleet::Actions} methods) - # - class FleetClient - include Common::Client, Common::Client::Base, Fleet::Actions - end - - # Proxy method for {FleetClient}, available in the receiving object - # - def fleet - @fleet ||= FleetClient.new(self) - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/graph.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/graph.rb deleted file mode 100644 index 04fd1d08a5..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/graph.rb +++ /dev/null @@ -1,36 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module Graph - module Actions; end - - # Client for the "graph" namespace (includes the {Graph::Actions} methods) - # - class GraphClient - include Common::Client, Common::Client::Base, Graph::Actions - end - - # Proxy method for {GraphClient}, available in the receiving object - # - def graph - @graph ||= GraphClient.new(self) - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/index_lifecycle_management.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/index_lifecycle_management.rb deleted file mode 100644 index 23077edeb3..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/index_lifecycle_management.rb +++ /dev/null @@ -1,38 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module IndexLifecycleManagement - module Actions; end - - # Client for the "index_lifecycle_management" namespace (includes the {IndexLifecycleManagement::Actions} methods) - # - class IndexLifecycleManagementClient - include Common::Client, Common::Client::Base, IndexLifecycleManagement::Actions - end - - # Proxy method for {IndexLifecycleManagementClient}, available in the receiving object - # - def ilm - @ilm ||= IndexLifecycleManagementClient.new(self) - end - - alias index_lifecycle_management ilm - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/indices.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/indices.rb deleted file mode 100644 index 75a3c0f290..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/indices.rb +++ /dev/null @@ -1,37 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module Indices - module Actions; end - - # Client for the "indices" namespace (includes the {Indices::Actions} methods) - # - class IndicesClient - include Common::Client, Common::Client::Base, Indices::Actions - end - - # Proxy method for {IndicesClient}, available in the receiving object - # - def indices - @indices ||= IndicesClient.new(self) - end - - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/inference.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/inference.rb deleted file mode 100644 index 84b3983649..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/inference.rb +++ /dev/null @@ -1,36 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module Inference - module Actions; end - - # Client for the "inference" namespace (includes the {Inference::Actions} methods) - # - class InferenceClient - include Common::Client, Common::Client::Base, Inference::Actions - end - - # Proxy method for {InferenceClient}, available in the receiving object - # - def inference - @inference ||= InferenceClient.new(self) - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/ingest.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/ingest.rb deleted file mode 100644 index 6e5e57af1f..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/ingest.rb +++ /dev/null @@ -1,36 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module Ingest - module Actions; end - - # Client for the "ingest" namespace (includes the {Ingest::Actions} methods) - # - class IngestClient - include Common::Client, Common::Client::Base, Ingest::Actions - end - - # Proxy method for {IngestClient}, available in the receiving object - # - def ingest - @ingest ||= IngestClient.new(self) - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/license.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/license.rb deleted file mode 100644 index e6fbd83676..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/license.rb +++ /dev/null @@ -1,36 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module License - module Actions; end - - # Client for the "license" namespace (includes the {License::Actions} methods) - # - class LicenseClient - include Common::Client, Common::Client::Base, License::Actions - end - - # Proxy method for {LicenseClient}, available in the receiving object - # - def license - @license ||= LicenseClient.new(self) - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/logstash.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/logstash.rb deleted file mode 100644 index 2a0dd34871..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/logstash.rb +++ /dev/null @@ -1,36 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module Logstash - module Actions; end - - # Client for the "logstash" namespace (includes the {Logstash::Actions} methods) - # - class LogstashClient - include Common::Client, Common::Client::Base, Logstash::Actions - end - - # Proxy method for {LogstashClient}, available in the receiving object - # - def logstash - @logstash ||= LogstashClient.new(self) - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/machine_learning.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/machine_learning.rb deleted file mode 100644 index 63ada11f03..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/machine_learning.rb +++ /dev/null @@ -1,38 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module MachineLearning - module Actions; end - - # Client for the "machine_learning" namespace (includes the {MachineLearning::Actions} methods) - # - class MachineLearningClient - include Common::Client, Common::Client::Base, MachineLearning::Actions - end - - # Proxy method for {MachineLearningClient}, available in the receiving object - # - def machine_learning - @machine_learning ||= MachineLearningClient.new(self) - end - - alias ml machine_learning - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/migration.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/migration.rb deleted file mode 100644 index 05685adf49..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/migration.rb +++ /dev/null @@ -1,36 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module Migration - module Actions; end - - # Client for the "migration" namespace (includes the {Migration::Actions} methods) - # - class MigrationClient - include Common::Client, Common::Client::Base, Migration::Actions - end - - # Proxy method for {MigrationClient}, available in the receiving object - # - def migration - @migration ||= MigrationClient.new(self) - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/nodes.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/nodes.rb deleted file mode 100644 index e717db05b2..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/nodes.rb +++ /dev/null @@ -1,37 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module Nodes - module Actions; end - - # Client for the "nodes" namespace (includes the {Nodes::Actions} methods) - # - class NodesClient - include Common::Client, Common::Client::Base, Nodes::Actions - end - - # Proxy method for {NodesClient}, available in the receiving object - # - def nodes - @nodes ||= NodesClient.new(self) - end - - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/query_rules.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/query_rules.rb deleted file mode 100644 index efff86c635..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/query_rules.rb +++ /dev/null @@ -1,36 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module QueryRules - module Actions; end - - # Client for the "query_rules" namespace (includes the {QueryRules::Actions} methods) - # - class QueryRulesClient - include Common::Client, Common::Client::Base, QueryRules::Actions - end - - # Proxy method for {QueryRulesClient}, available in the receiving object - # - def query_rules - @query_rules ||= QueryRulesClient.new(self) - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/query_ruleset.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/query_ruleset.rb deleted file mode 100644 index c77d50dbcc..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/query_ruleset.rb +++ /dev/null @@ -1,36 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module QueryRuleset - module Actions; end - - # Client for the "query_ruleset" namespace (includes the {QueryRuleset::Actions} methods) - # - class QueryRulesetClient - include Common::Client, Common::Client::Base, QueryRuleset::Actions - end - - # Proxy method for {QueryRulesetClient}, available in the receiving object - # - def query_ruleset - @query_ruleset ||= QueryRulesetClient.new(self) - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/remote.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/remote.rb deleted file mode 100644 index bcf5e4265f..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/remote.rb +++ /dev/null @@ -1,37 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module Remote - module Actions; end - - # Client for the "remote" namespace (includes the {Remote::Actions} methods) - # - class RemoteClient - include Common::Client, Common::Client::Base, Remote::Actions - end - - # Proxy method for {RemoteClient}, available in the receiving object - # - def remote - @remote ||= RemoteClient.new(self) - end - - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/rollup.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/rollup.rb deleted file mode 100644 index 1e0e4b1c8e..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/rollup.rb +++ /dev/null @@ -1,36 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module Rollup - module Actions; end - - # Client for the "rollup" namespace (includes the {Rollup::Actions} methods) - # - class RollupClient - include Common::Client, Common::Client::Base, Rollup::Actions - end - - # Proxy method for {RollupClient}, available in the receiving object - # - def rollup - @rollup ||= RollupClient.new(self) - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/search_application.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/search_application.rb deleted file mode 100644 index 962bf15b5e..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/search_application.rb +++ /dev/null @@ -1,36 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module SearchApplication - module Actions; end - - # Client for the "searchable_snapshots" namespace (includes the {SearchableSnapshots::Actions} methods) - # - class SearchApplicationClient - include Common::Client, Common::Client::Base, SearchApplication::Actions - end - - # Proxy method for {SearchApplicationClient}, available in the receiving object - # - def search_application - @search_application ||= SearchApplicationClient.new(self) - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/searchable_snapshots.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/searchable_snapshots.rb deleted file mode 100644 index 0a2add26b5..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/searchable_snapshots.rb +++ /dev/null @@ -1,36 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module SearchableSnapshots - module Actions; end - - # Client for the "searchable_snapshots" namespace (includes the {SearchableSnapshots::Actions} methods) - # - class SearchableSnapshotsClient - include Common::Client, Common::Client::Base, SearchableSnapshots::Actions - end - - # Proxy method for {SearchableSnapshotsClient}, available in the receiving object - # - def searchable_snapshots - @searchable_snapshots ||= SearchableSnapshotsClient.new(self) - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/security.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/security.rb deleted file mode 100644 index 61f9efba1f..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/security.rb +++ /dev/null @@ -1,36 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module Security - module Actions; end - - # Client for the "security" namespace (includes the {Security::Actions} methods) - # - class SecurityClient - include Common::Client, Common::Client::Base, Security::Actions - end - - # Proxy method for {SecurityClient}, available in the receiving object - # - def security - @security ||= SecurityClient.new(self) - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/simulate.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/simulate.rb deleted file mode 100644 index b5e6eb88e4..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/simulate.rb +++ /dev/null @@ -1,36 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module Simulate - module Actions; end - - # Client for the "simulate" namespace (includes the {Simulate::Actions} methods) - # - class SimulateClient - include Common::Client, Common::Client::Base, Simulate::Actions - end - - # Proxy method for {SimulateClient}, available in the receiving object - # - def simulate - @simulate ||= SimulateClient.new(self) - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/snapshot.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/snapshot.rb deleted file mode 100644 index 35853de862..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/snapshot.rb +++ /dev/null @@ -1,37 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module Snapshot - module Actions; end - - # Client for the "snapshot" namespace (includes the {Snapshot::Actions} methods) - # - class SnapshotClient - include Common::Client, Common::Client::Base, Snapshot::Actions - end - - # Proxy method for {SnapshotClient}, available in the receiving object - # - def snapshot - @snapshot ||= SnapshotClient.new(self) - end - - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/snapshot_lifecycle_management.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/snapshot_lifecycle_management.rb deleted file mode 100644 index 29b74ac932..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/snapshot_lifecycle_management.rb +++ /dev/null @@ -1,38 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module SnapshotLifecycleManagement - module Actions; end - - # Client for the "snapshot_lifecycle_management" namespace (includes the {SnapshotLifecycleManagement::Actions} methods) - # - class SnapshotLifecycleManagementClient - include Common::Client, Common::Client::Base, SnapshotLifecycleManagement::Actions - end - - # Proxy method for {SnapshotLifecycleManagementClient}, available in the receiving object - # - def snapshot_lifecycle_management - @snapshot_lifecycle_management ||= SnapshotLifecycleManagementClient.new(self) - end - - alias slm snapshot_lifecycle_management - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/sql.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/sql.rb deleted file mode 100644 index f0a5c7939e..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/sql.rb +++ /dev/null @@ -1,36 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module SQL - module Actions; end - - # Client for the "sql" namespace (includes the {SQL::Actions} methods) - # - class SQLClient - include Common::Client, Common::Client::Base, SQL::Actions - end - - # Proxy method for {SQLClient}, available in the receiving object - # - def sql - @sql ||= SQLClient.new(self) - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/ssl.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/ssl.rb deleted file mode 100644 index d298fce678..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/ssl.rb +++ /dev/null @@ -1,36 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module SSL - module Actions; end - - # Client for the "ssl" namespace (includes the {SSL::Actions} methods) - # - class SSLClient - include Common::Client, Common::Client::Base, SSL::Actions - end - - # Proxy method for {SSLClient}, available in the receiving object - # - def ssl - @ssl ||= SSLClient.new(self) - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/synonyms.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/synonyms.rb deleted file mode 100644 index 083a215203..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/synonyms.rb +++ /dev/null @@ -1,36 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module Synonyms - module Actions; end - - # Client for the "synonyms" namespace (includes the {Synonyms::Actions} methods) - # - class SynonymsClient - include Common::Client, Common::Client::Base, Synonyms::Actions - end - - # Proxy method for {SynonymsClient}, available in the receiving object - # - def synonyms - @synonyms ||= SynonymsClient.new(self) - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/tasks.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/tasks.rb deleted file mode 100644 index 9c4809dce2..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/tasks.rb +++ /dev/null @@ -1,37 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module Tasks - module Actions; end - - # Client for the "tasks" namespace (includes the {Tasks::Actions} methods) - # - class TasksClient - include Common::Client, Common::Client::Base, Tasks::Actions - end - - # Proxy method for {TasksClient}, available in the receiving object - # - def tasks - @tasks ||= TasksClient.new(self) - end - - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/text_structure.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/text_structure.rb deleted file mode 100644 index 0d1f5b7636..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/text_structure.rb +++ /dev/null @@ -1,36 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module TextStructure - module Actions; end - - # Client for the "text_structure" namespace (includes the {TextStructure::Actions} methods) - # - class TextStructureClient - include Common::Client, Common::Client::Base, TextStructure::Actions - end - - # Proxy method for {TextStructureClient}, available in the receiving object - # - def text_structure - @text_structure ||= TextStructureClient.new(self) - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/transform.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/transform.rb deleted file mode 100644 index 0c9040adfb..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/transform.rb +++ /dev/null @@ -1,36 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module Transform - module Actions; end - - # Client for the "transform" namespace (includes the {Transform::Actions} methods) - # - class TransformClient - include Common::Client, Common::Client::Base, Transform::Actions - end - - # Proxy method for {TransformClient}, available in the receiving object - # - def transform - @transform ||= TransformClient.new(self) - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/watcher.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/watcher.rb deleted file mode 100644 index 554e401361..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/watcher.rb +++ /dev/null @@ -1,36 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module Watcher - module Actions; end - - # Client for the "watcher" namespace (includes the {Watcher::Actions} methods) - # - class WatcherClient - include Common::Client, Common::Client::Base, Watcher::Actions - end - - # Proxy method for {WatcherClient}, available in the receiving object - # - def watcher - @watcher ||= WatcherClient.new(self) - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/namespace/xpack.rb b/elasticsearch-api/lib/elasticsearch/api/namespace/xpack.rb deleted file mode 100644 index 74d8f9bb13..0000000000 --- a/elasticsearch-api/lib/elasticsearch/api/namespace/xpack.rb +++ /dev/null @@ -1,36 +0,0 @@ -# Licensed to Elasticsearch B.V. under one or more contributor -# license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright -# ownership. Elasticsearch B.V. licenses this file to you under -# the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, -# software distributed under the License is distributed on an -# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -# KIND, either express or implied. See the License for the -# specific language governing permissions and limitations -# under the License. - -module Elasticsearch - module API - module XPack - module Actions; end - - # Client for the "xpack" namespace (includes the {XPack::Actions} methods) - # - class XPackClient - include Common::Client, Common::Client::Base, XPack::Actions - end - - # Proxy method for {XPackClient}, available in the receiving object - # - def xpack - @xpack ||= XPackClient.new(self) - end - end - end -end diff --git a/elasticsearch-api/lib/elasticsearch/api/utils.rb b/elasticsearch-api/lib/elasticsearch/api/utils.rb index fc53cb1d49..8414c82ec7 100644 --- a/elasticsearch-api/lib/elasticsearch/api/utils.rb +++ b/elasticsearch-api/lib/elasticsearch/api/utils.rb @@ -24,60 +24,62 @@ module Utils # URL-escape a string # # @example - # __escape('foo/bar') # => 'foo%2Fbar' - # __escape('bar^bam') # => 'bar%5Ebam' + # escape('foo/bar') # => 'foo%2Fbar' + # escape('bar^bam') # => 'bar%5Ebam' # # @api private - def __escape(string) + def escape(string) return string if string == '*' + ERB::Util.url_encode(string.to_s) end # Create a "list" of values from arguments, ignoring nil values and encoding special characters. # # @example Create a list from array - # __listify(['A','B']) # => 'A,B' + # listify(['A','B']) # => 'A,B' # # @example Create a list from arguments - # __listify('A','B') # => 'A,B' + # listify('A','B') # => 'A,B' # # @example Escape values - # __listify('foo','bar^bam') # => 'foo,bar%5Ebam' + # listify('foo','bar^bam') # => 'foo,bar%5Ebam' # # @example Do not escape the values - # __listify('foo','bar^bam', escape: false) # => 'foo,bar^bam' + # listify('foo','bar^bam', escape: false) # => 'foo,bar^bam' # # @api private - def __listify(*list) + def listify(*list) options = list.last.is_a?(Hash) ? list.pop : {} escape = options[:escape] - Array(list). - flat_map { |e| e.respond_to?(:split) ? e.split(',') : e }. - flatten. - compact. - map { |e| escape == false ? e : __escape(e) }. - join(',') + Array(list) + .flat_map { |e| e.respond_to?(:split) ? e.split(',') : e } + .flatten + .compact + .map { |e| escape == false ? e : escape(e) } + .join(',') end # Create a path (URL part) from arguments, ignoring nil values and empty strings. # # @example Create a path from array - # __pathify(['foo', '', nil, 'bar']) # => 'foo/bar' + # pathify(['foo', '', nil, 'bar']) # => 'foo/bar' # # @example Create a path from arguments - # __pathify('foo', '', nil, 'bar') # => 'foo/bar' + # pathify('foo', '', nil, 'bar') # => 'foo/bar' # # # @example Encode special characters - # __pathify(['foo', 'bar^bam']) # => 'foo/bar%5Ebam' + # pathify(['foo', 'bar^bam']) # => 'foo/bar%5Ebam' # # @api private - def __pathify(*segments) - Array(segments).flatten. - compact. - reject { |s| s.to_s.strip.empty? }. - join('/'). - squeeze('/') + def pathify(*segments) + Array(segments) + .flatten + .compact + .reject { |s| s.to_s.strip.empty? } + .join('/') + .squeeze('/') end # Convert an array of payloads into Elasticsearch `header\ndata` format @@ -86,7 +88,7 @@ def __pathify(*segments) # or the conveniency "combined" format where data is passed along with the header # in a single item. # - # Elasticsearch::API::Utils.__bulkify [ + # Elasticsearch::API::Utils.bulkify [ # { :index => { :_index => 'myindexA', :_type => 'mytype', :_id => '1', :data => { :title => 'Test' } } }, # { :update => { :_index => 'myindexB', :_type => 'mytype', :_id => '2', :data => { :doc => { :title => 'Update' } } } } # ] @@ -96,7 +98,7 @@ def __pathify(*segments) # # => {"update":{"_index":"myindexB","_type":"mytype","_id":"2"}} # # => {"doc":{"title":"Update"}} # - def __bulkify(payload) + def bulkify(payload) operations = %w[index create delete update] case @@ -131,7 +133,7 @@ def __bulkify(payload) def process_params(arguments) arguments = Hash[arguments] unless arguments.is_a?(Hash) - Hash[arguments.map { |k, v| v.is_a?(Array) ? [k, __listify(v, { escape: false })] : [k, v] }] # Listify Arrays + Hash[arguments.map { |k, v| v.is_a?(Array) ? [k, listify(v, { escape: false })] : [k, v] }] # Listify Arrays end # Extracts the valid parts of the URL from the arguments @@ -144,14 +146,14 @@ def process_params(arguments) # @return [Array] Valid parts of the URL as an array of strings # # @example Extract parts - # __extract_parts { :foo => true }, [:foo, :bar] + # extract_parts { :foo => true }, [:foo, :bar] # # => [:foo] # # # @api private # - def __extract_parts(arguments, valid_parts=[]) - Hash[arguments].reduce([]) { |sum, item| k, v = item; v.is_a?(TrueClass) ? sum << k.to_s : sum << v } + def extract_parts(arguments, _valid_parts = []) + Hash[arguments].reduce([]) { |sum, item| k, v = item; v.is_a?(TrueClass) ? sum << k.to_s : sum << v } end # Calls the given block, rescuing from `StandardError`. @@ -165,7 +167,7 @@ def __extract_parts(arguments, valid_parts=[]) # # @api private # - def __rescue_from_not_found(&block) + def rescue_from_not_found(&block) yield rescue StandardError => e if e.class.to_s =~ /NotFound/ || e.message =~ /Not\s*Found/i @@ -175,61 +177,19 @@ def __rescue_from_not_found(&block) end end - def __report_unsupported_parameters(arguments, params=[]) - messages = [] - unsupported_params = params.select {|d| d.is_a?(Hash) ? arguments.include?(d.keys.first) : arguments.include?(d) } - - unsupported_params.each do |param| - name = case param - when Symbol - param - when Hash - param.keys.first - else - raise ArgumentError, "The param must be a Symbol or a Hash" - end - - explanation = if param.is_a?(Hash) - ". #{param.values.first[:explanation]}." - else - ". This parameter is not supported in the version you're using: #{Elasticsearch::API::VERSION}, and will be removed in the next release." - end - - message = "[!] You are using unsupported parameter [:#{name}]" - - if source = caller && caller.last - message += " in `#{source}`" - end - - message += explanation - - messages << message - end - - unless messages.empty? - messages << "Suppress this warning by the `-WO` command line flag." - - if STDERR.tty? - Kernel.warn messages.map { |m| "\e[31;1m#{m}\e[0m" }.join("\n") - else - Kernel.warn messages.join("\n") - end - end - end - - def __report_unsupported_method(name) - message = "[!] You are using unsupported method [#{name}]" - if source = caller && caller.last - message += " in `#{source}`" - end - - message += ". This method is not supported in the version you're using: #{Elasticsearch::API::VERSION}, and will be removed in the next release. Suppress this warning by the `-WO` command line flag." + # Updates ndjson headers for msearch, bulk, and others + # + def update_ndjson_headers!(headers, client_headers) + current_content = client_headers.keys.find { |c| c.match?(/content-?_?type/i) } || 'content-type' + current_accept = client_headers.keys.find { |c| c.match?(/accept/i) } || 'accept' + version = client_headers[current_content].match(/compatible-with=([0-9]+)/)[1] || 9 - if STDERR.tty? - Kernel.warn "\e[31;1m#{message}\e[0m" - else - Kernel.warn message - end + headers.merge!( + { + current_content => "application/vnd.elasticsearch+x-ndjson; compatible-with=#{version}", + current_accept => "application/vnd.elasticsearch+x-ndjson; compatible-with=#{version}" + } + ) end extend self diff --git a/elasticsearch-api/lib/elasticsearch/api/version.rb b/elasticsearch-api/lib/elasticsearch/api/version.rb index a8d55bf703..b527ec2564 100644 --- a/elasticsearch-api/lib/elasticsearch/api/version.rb +++ b/elasticsearch-api/lib/elasticsearch/api/version.rb @@ -17,6 +17,7 @@ module Elasticsearch module API - VERSION = '9.0.0'.freeze + VERSION = '9.0.5'.freeze + ES_SPECIFICATION_COMMIT = 'e194c704d2949312ed19e0582c29a873beee68db'.freeze end end diff --git a/elasticsearch-api/spec/spec_helper.rb b/elasticsearch-api/spec/spec_helper.rb index 420a4aecd3..426e70af6e 100644 --- a/elasticsearch-api/spec/spec_helper.rb +++ b/elasticsearch-api/spec/spec_helper.rb @@ -59,6 +59,13 @@ def self.included(context) end end +Transport ||= Struct.new('Transport', :options) + +def dummy_ndjson_headers + allow(client_double).to receive(:transport).and_return Transport.new({ transport_options: { headers: {} } }) + allow(Elasticsearch::API::Utils).to receive(:update_ndjson_headers!).and_return({}) +end + RSpec.configure do |config| config.include(HelperModule) config.filter_run_excluding skip: true diff --git a/elasticsearch-api/spec/unit/actions/bulk_spec.rb b/elasticsearch-api/spec/unit/actions/bulk_spec.rb index 0d18d0ee9a..4709c48e66 100644 --- a/elasticsearch-api/spec/unit/actions/bulk_spec.rb +++ b/elasticsearch-api/spec/unit/actions/bulk_spec.rb @@ -25,11 +25,17 @@ params, body, headers, - {:endpoint=>"bulk"} + { endpoint: 'bulk' } ] end - let(:headers) { { 'Content-Type' => 'application/x-ndjson' } } + let(:headers) { {} } + + # This test only cares about the body, there's another test for the ndjson headers. + before do + dummy_ndjson_headers + end + let(:params) { {} } let(:url) { '_bulk' } let(:body) { '' } @@ -48,12 +54,16 @@ end it 'performs the request' do - expect(client_double.bulk(:body => [ - { :index => { :_index => 'myindexA', :_id => '1', :data => { :title => 'Test' } } }, - { :update => { :_index => 'myindexB', :_id => '2', :data => { :doc => { :title => 'Update' } } } }, - { :delete => { :_index => 'myindexC', :_id => '3' } }, - { :index => { :_index => 'myindexD', :_id => '1', :data => { :data => 'MYDATA' } } }, - ])).to be_a Elasticsearch::API::Response + expect( + client_double.bulk( + body: [ + { index: { _index: 'myindexA', _id: '1', data: { title: 'Test' } } }, + { update: { _index: 'myindexB', _id: '2', data: { doc: { title: 'Update' } } } }, + { delete: { _index: 'myindexC', _id: '3' } }, + { index: { _index: 'myindexD', _id: '1', data: { data: 'MYDATA' } } } + ] + ) + ).to be_a Elasticsearch::API::Response end end @@ -67,7 +77,7 @@ params, body, headers, - { defined_params: { index: 'myindex' }, :endpoint=>"bulk"} + { defined_params: { index: 'myindex' }, endpoint: 'bulk' } ] end @@ -85,8 +95,14 @@ end it 'performs the request' do - expect(client_double.bulk(body:[ { :update => { :_index => 'myindex', :_id => '1' } }, - { :doc => { :data => { :title => 'Update' } } } ])).to be_a Elasticsearch::API::Response + expect( + client_double.bulk( + body: [ + { update: { _index: 'myindex', _id: '1' } }, + { doc: { data: { title: 'Update' } } } + ] + ) + ).to be_a Elasticsearch::API::Response end end @@ -132,7 +148,7 @@ params, body, headers, - { defined_params: { index: 'foo^bar' }, :endpoint=>"bulk"} + { defined_params: { index: 'foo^bar' }, endpoint: 'bulk'} ] end diff --git a/elasticsearch-api/spec/unit/actions/clear_scroll_spec.rb b/elasticsearch-api/spec/unit/actions/clear_scroll_spec.rb index 041c13d832..1f1f2d4969 100644 --- a/elasticsearch-api/spec/unit/actions/clear_scroll_spec.rb +++ b/elasticsearch-api/spec/unit/actions/clear_scroll_spec.rb @@ -22,33 +22,15 @@ let(:expected_args) do [ 'DELETE', - '_search/scroll/abc123', + '_search/scroll', {}, - nil, + { scroll_id: 'abc123' }, {}, - { defined_params: { scroll_id: 'abc123' }, endpoint: 'clear_scroll' } + { endpoint: 'clear_scroll' } ] end it 'performs the request' do - expect(client_double.clear_scroll(scroll_id: 'abc123')).to be_a Elasticsearch::API::Response - end - - context 'when a list of scroll ids is provided' do - - let(:expected_args) do - [ - 'DELETE', - '_search/scroll/abc123,def456', - {}, - nil, - {}, - { defined_params: { scroll_id: ['abc123', 'def456'] }, endpoint: 'clear_scroll' } - ] - end - - it 'performs the request' do - expect(client_double.clear_scroll(scroll_id: ['abc123', 'def456'])).to be_a Elasticsearch::API::Response - end + expect(client_double.clear_scroll(body: { scroll_id: 'abc123' })).to be_a Elasticsearch::API::Response end end diff --git a/elasticsearch-api/spec/unit/actions/cluster/reroute_spec.rb b/elasticsearch-api/spec/unit/actions/cluster/reroute_spec.rb index 49848ce103..b0d770d055 100644 --- a/elasticsearch-api/spec/unit/actions/cluster/reroute_spec.rb +++ b/elasticsearch-api/spec/unit/actions/cluster/reroute_spec.rb @@ -21,12 +21,12 @@ let(:expected_args) do [ - 'POST', - '_cluster/reroute', - {}, - {}, - {}, - { endpoint: 'cluster.reroute' } + 'POST', + '_cluster/reroute', + {}, + nil, + {}, + { endpoint: 'cluster.reroute' } ] end @@ -38,12 +38,12 @@ let(:expected_args) do [ - 'POST', - '_cluster/reroute', - {}, - { commands: [ move: { index: 'myindex', shard: 0 }] }, - {}, - { endpoint: 'cluster.reroute' } + 'POST', + '_cluster/reroute', + {}, + { commands: [ move: { index: 'myindex', shard: 0 }] }, + {}, + { endpoint: 'cluster.reroute' } ] end diff --git a/elasticsearch-api/spec/unit/actions/connector/post_spec.rb b/elasticsearch-api/spec/unit/actions/connector/post_spec.rb index 587a1fa0a5..f849b0b178 100644 --- a/elasticsearch-api/spec/unit/actions/connector/post_spec.rb +++ b/elasticsearch-api/spec/unit/actions/connector/post_spec.rb @@ -22,7 +22,7 @@ [ 'POST', '_connector', - {}, + { connector_id: 'foo' }, {}, {}, { endpoint: 'connector.post' } diff --git a/elasticsearch-api/spec/unit/actions/connector/update_active_filtering_spec.rb b/elasticsearch-api/spec/unit/actions/connector/update_active_filtering_spec.rb index 7d91535e2c..b2d4a259b0 100644 --- a/elasticsearch-api/spec/unit/actions/connector/update_active_filtering_spec.rb +++ b/elasticsearch-api/spec/unit/actions/connector/update_active_filtering_spec.rb @@ -33,6 +33,6 @@ end it 'performs the request' do - expect(client_double.connector.update_active_filtering(body: {}, connector_id: 'foo')).to be_a Elasticsearch::API::Response + expect(client_double.connector.update_active_filtering(connector_id: 'foo')).to be_a Elasticsearch::API::Response end end diff --git a/elasticsearch-api/spec/unit/actions/create_document_spec.rb b/elasticsearch-api/spec/unit/actions/create_document_spec.rb index 7175e4f15b..f3c24c26e8 100644 --- a/elasticsearch-api/spec/unit/actions/create_document_spec.rb +++ b/elasticsearch-api/spec/unit/actions/create_document_spec.rb @@ -18,42 +18,40 @@ require 'spec_helper' describe 'client#create_document' do - let(:expected_args) do [ - 'PUT', - 'foo/_doc/123', - { op_type: 'create' }, - { foo: 'bar' }, - {}, - { defined_params: { id: '123', index: 'foo' }, endpoint: 'index' } + 'PUT', + 'foo/_create/123', + {}, + { foo: 'bar' }, + {}, + { defined_params: { id: '123', index: 'foo' }, endpoint: 'create' } ] end it 'performs the request' do - expect(client_double.create(index: 'foo', id: '123', body: { foo: 'bar'})).to be_a Elasticsearch::API::Response + expect(client_double.create(index: 'foo', id: '123', body: { foo: 'bar' })).to be_a Elasticsearch::API::Response end context 'when the request needs to be URL-escaped' do - let(:expected_args) do [ - 'PUT', - 'foo/_doc/123', - { op_type: 'create' }, - {}, - {} + 'PUT', + 'foo/_doc/123', + {}, + {}, + {} ] end let(:expected_args) do [ 'PUT', - 'foo/_doc/123', - { op_type: 'create' }, + 'foo/_create/123', + {}, {}, {}, - { defined_params: { id: '123', index: 'foo' }, endpoint: 'index' } + { defined_params: { id: '123', index: 'foo' }, endpoint: 'create' } ] end @@ -63,58 +61,29 @@ end context 'when an id is provided as an integer' do - - let(:expected_args) do - [ - 'PUT', - 'foo/_doc/1', - { op_type: 'create' }, - { foo: 'bar' }, - {} - ] - end - let(:expected_args) do [ 'PUT', 'foo/_doc/1', { op_type: 'create' }, { foo: 'bar' }, - {}, - { defined_params: { id: 1, index: 'foo' }, endpoint: 'index' } + {} ] end - it 'updates the arguments with the `op_type`' do - expect(client_double.create(index: 'foo', id: 1, body: { foo: 'bar' })).to be_a Elasticsearch::API::Response - end - end - - context 'when an id is not provided' do - let(:expected_args) do [ - 'POST', - 'foo/_doc', - { }, - { foo: 'bar' }, - {} - ] - end - - let(:expected_args) do - [ - 'POST', - 'foo/_doc', - { }, + 'PUT', + 'foo/_create/1', + {}, { foo: 'bar' }, {}, - { defined_params: { index: 'foo' }, endpoint: 'index' } + { defined_params: { id: 1, index: 'foo' }, endpoint: 'create' } ] end - it 'updates the arguments with the `op_type`' do - expect(client_double.create(index: 'foo', body: { foo: 'bar' })).to be_a Elasticsearch::API::Response + it 'performs the request' do + expect(client_double.create(index: 'foo', id: 1, body: { foo: 'bar' })).to be_a Elasticsearch::API::Response end end end diff --git a/elasticsearch-api/spec/unit/actions/fleet/msearch_spec.rb b/elasticsearch-api/spec/unit/actions/fleet/msearch_spec.rb index af44de93e8..5f786d969d 100644 --- a/elasticsearch-api/spec/unit/actions/fleet/msearch_spec.rb +++ b/elasticsearch-api/spec/unit/actions/fleet/msearch_spec.rb @@ -24,22 +24,17 @@ '_fleet/_fleet_msearch', {}, {}, - { 'Content-Type' => 'application/x-ndjson' }, + {}, { endpoint: 'fleet.msearch' } ] end - it 'performs the request' do - expect(client_double.fleet.msearch(body: {})).to be_a Elasticsearch::API::Response + # This test only cares about the body, there's another test for the ndjson headers. + before do + dummy_ndjson_headers end - let(:client) do - Class.new { include Elasticsearch::API }.new - end - - it 'requires the :body argument' do - expect { - client.fleet.msearch - }.to raise_exception(ArgumentError) + it 'performs the request' do + expect(client_double.fleet.msearch(body: {})).to be_a Elasticsearch::API::Response end end diff --git a/elasticsearch-api/spec/unit/actions/index_lifecycle_management/get_status_spec.rb b/elasticsearch-api/spec/unit/actions/index_lifecycle_management/get_status_spec.rb index fd72263150..a5fd5a430f 100644 --- a/elasticsearch-api/spec/unit/actions/index_lifecycle_management/get_status_spec.rb +++ b/elasticsearch-api/spec/unit/actions/index_lifecycle_management/get_status_spec.rb @@ -22,7 +22,7 @@ [ 'GET', '_ilm/status', - {}, + { index: 'foo' }, nil, {}, { endpoint: 'ilm.get_status' } diff --git a/elasticsearch-api/spec/unit/actions/indices/get_field_mapping_spec.rb b/elasticsearch-api/spec/unit/actions/indices/get_field_mapping_spec.rb index cd12bf16bc..e9550b65e9 100644 --- a/elasticsearch-api/spec/unit/actions/indices/get_field_mapping_spec.rb +++ b/elasticsearch-api/spec/unit/actions/indices/get_field_mapping_spec.rb @@ -26,7 +26,7 @@ {}, nil, {}, - { endpoint: 'indices.get_field_mapping' } + { endpoint: 'indices.get_field_mapping', defined_params: { fields: 'foo' } } ] end @@ -35,11 +35,10 @@ end it 'performs the request' do - expect(client_double.indices.get_field_mapping(field: 'foo')).to be_a Elasticsearch::API::Response + expect(client_double.indices.get_field_mapping(fields: 'foo')).to be_a Elasticsearch::API::Response end context 'when an index is specified' do - let(:url) do 'foo/_mapping/field/bam' end @@ -51,12 +50,12 @@ {}, nil, {}, - { defined_params: { index: 'foo' }, endpoint: 'indices.get_field_mapping' } + { defined_params: { index: 'foo', fields: 'bam' }, endpoint: 'indices.get_field_mapping' } ] end it 'performs the request' do - expect(client_double.indices.get_field_mapping(index: 'foo', field: 'bam')).to be_a Elasticsearch::API::Response + expect(client_double.indices.get_field_mapping(index: 'foo', fields: 'bam')).to be_a Elasticsearch::API::Response end end end diff --git a/elasticsearch-api/spec/unit/actions/indices/indices_migrate_spec.rb b/elasticsearch-api/spec/unit/actions/indices/indices_migrate_spec.rb new file mode 100644 index 0000000000..7a53de9155 --- /dev/null +++ b/elasticsearch-api/spec/unit/actions/indices/indices_migrate_spec.rb @@ -0,0 +1,88 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client.indices' do + context 'migrate_reindex' do + let(:expected_args) do + [ + 'POST', + '_migration/reindex', + {}, + {}, + {}, + { endpoint: 'indices.migrate_reindex' } + ] + end + + it 'performs the request' do + expect(client_double.indices.migrate_reindex(body: {})).to be_a Elasticsearch::API::Response + end + end + + context 'get_migrate_reindex_status' do + let(:expected_args) do + [ + 'GET', + '_migration/reindex/foo/_status', + {}, + nil, + {}, + { endpoint: 'indices.get_migrate_reindex_status', defined_params: { index: 'foo' } } + ] + end + + it 'performs the request' do + expect(client_double.indices.get_migrate_reindex_status(index: 'foo')).to be_a Elasticsearch::API::Response + end + end + + context 'cancel_migrate_reindex' do + let(:expected_args) do + [ + 'POST', + '_migration/reindex/foo/_cancel', + {}, + nil, + {}, + { endpoint: 'indices.cancel_migrate_reindex', defined_params: { index: 'foo' } } + ] + end + + it 'performs the request' do + expect(client_double.indices.cancel_migrate_reindex(index: 'foo')).to be_a Elasticsearch::API::Response + end + end + + context 'create_from' do + let(:expected_args) do + [ + 'PUT', + '_create_from/foo/bar', + {}, + {}, + {}, + { endpoint: 'indices.create_from', defined_params: { source: 'foo', dest: 'bar' } } + ] + end + + it 'performs the request' do + expect(client_double.indices.create_from(body: {}, source: 'foo', dest: 'bar')).to be_a Elasticsearch::API::Response + end + end +end diff --git a/elasticsearch-api/spec/unit/actions/indices/resolve_cluster_spec.rb b/elasticsearch-api/spec/unit/actions/indices/resolve_cluster_spec.rb index 3da0771413..f20bca9264 100644 --- a/elasticsearch-api/spec/unit/actions/indices/resolve_cluster_spec.rb +++ b/elasticsearch-api/spec/unit/actions/indices/resolve_cluster_spec.rb @@ -30,19 +30,6 @@ ] end - context 'when there is no name specified' do - let(:client) do - Class.new { include Elasticsearch::API }.new - end - - it 'raises an exception' do - expect { - client.indices.resolve_cluster - }.to raise_exception(ArgumentError) - end - end - - context 'when name is specified' do it 'performs the request' do expect(client_double.indices.resolve_cluster(name: 'foo')).to be_a Elasticsearch::API::Response diff --git a/elasticsearch-api/spec/unit/actions/inference/unified_inference_spec.rb b/elasticsearch-api/spec/unit/actions/inference/chat_completion_unified_spec.rb similarity index 72% rename from elasticsearch-api/spec/unit/actions/inference/unified_inference_spec.rb rename to elasticsearch-api/spec/unit/actions/inference/chat_completion_unified_spec.rb index daed8332d7..180bcb3f64 100644 --- a/elasticsearch-api/spec/unit/actions/inference/unified_inference_spec.rb +++ b/elasticsearch-api/spec/unit/actions/inference/chat_completion_unified_spec.rb @@ -17,20 +17,20 @@ require 'spec_helper' -describe 'client#inference.unified_inference' do +describe 'client#inference.chat_completion_unified' do let(:expected_args) do [ 'POST', - '_inference/foo/bar/_unified', + '_inference/chat_completion/bar/_stream', {}, - nil, {}, - { defined_params: { inference_id: 'bar', task_type: 'foo' }, - endpoint: 'inference.unified_inference' } + {}, + { defined_params: { inference_id: 'bar' }, + endpoint: 'inference.chat_completion_unified' } ] end it 'performs the request' do - expect(client_double.inference.unified_inference(task_type: 'foo', inference_id: 'bar')).to be_a Elasticsearch::API::Response + expect(client_double.inference.chat_completion_unified(inference_id: 'bar', body: {})).to be_a Elasticsearch::API::Response end end diff --git a/elasticsearch-api/spec/unit/actions/inference/completion_spec.rb b/elasticsearch-api/spec/unit/actions/inference/completion_spec.rb new file mode 100644 index 0000000000..8817e72a32 --- /dev/null +++ b/elasticsearch-api/spec/unit/actions/inference/completion_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.completion' do + let(:expected_args) do + [ + 'POST', + '_inference/completion/bar', + {}, + nil, + {}, + { defined_params: { inference_id: 'bar' }, + endpoint: 'inference.completion' } + ] + end + + it 'performs the request' do + expect(client_double.inference.completion(inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/unit/actions/inference/inference_spec.rb b/elasticsearch-api/spec/unit/actions/inference/inference_spec.rb index c87efa07b4..dfa2a51890 100644 --- a/elasticsearch-api/spec/unit/actions/inference/inference_spec.rb +++ b/elasticsearch-api/spec/unit/actions/inference/inference_spec.rb @@ -21,16 +21,16 @@ let(:expected_args) do [ 'POST', - '_inference/foo/bar', + '_inference/bar', {}, nil, {}, - { defined_params: { inference_id: 'bar', task_type: 'foo' }, + { defined_params: { inference_id: 'bar' }, endpoint: 'inference.inference' } ] end it 'performs the request' do - expect(client_double.inference.inference(task_type: 'foo', inference_id: 'bar')).to be_a Elasticsearch::API::Response + expect(client_double.inference.inference(inference_id: 'bar')).to be_a Elasticsearch::API::Response end end diff --git a/elasticsearch-api/spec/unit/actions/inference/put_alibabacloud_spec.rb b/elasticsearch-api/spec/unit/actions/inference/put_alibabacloud_spec.rb new file mode 100644 index 0000000000..0ac550822f --- /dev/null +++ b/elasticsearch-api/spec/unit/actions/inference/put_alibabacloud_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.put_alibabacloud' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/bar', + {}, + nil, + {}, + { defined_params: { alibabacloud_inference_id: 'bar', task_type: 'foo' }, + endpoint: 'inference.put_alibabacloud' } + ] + end + + it 'performs the request' do + expect(client_double.inference.put_alibabacloud(task_type: 'foo', alibabacloud_inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/unit/actions/inference/put_amazonbedrock_spec.rb b/elasticsearch-api/spec/unit/actions/inference/put_amazonbedrock_spec.rb new file mode 100644 index 0000000000..23d5b57c39 --- /dev/null +++ b/elasticsearch-api/spec/unit/actions/inference/put_amazonbedrock_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.put_amazonbedrock' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/bar', + {}, + nil, + {}, + { defined_params: { amazonbedrock_inference_id: 'bar', task_type: 'foo' }, + endpoint: 'inference.put_amazonbedrock' } + ] + end + + it 'performs the request' do + expect(client_double.inference.put_amazonbedrock(task_type: 'foo', amazonbedrock_inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/unit/actions/inference/put_anthropic_spec.rb b/elasticsearch-api/spec/unit/actions/inference/put_anthropic_spec.rb new file mode 100644 index 0000000000..3f4c22cbba --- /dev/null +++ b/elasticsearch-api/spec/unit/actions/inference/put_anthropic_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.put_anthropic' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/bar', + {}, + nil, + {}, + { defined_params: { anthropic_inference_id: 'bar', task_type: 'foo' }, + endpoint: 'inference.put_anthropic' } + ] + end + + it 'performs the request' do + expect(client_double.inference.put_anthropic(task_type: 'foo', anthropic_inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/unit/actions/inference/put_azureaistudio_spec.rb b/elasticsearch-api/spec/unit/actions/inference/put_azureaistudio_spec.rb new file mode 100644 index 0000000000..add3ed7eec --- /dev/null +++ b/elasticsearch-api/spec/unit/actions/inference/put_azureaistudio_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.put_azureaistudio' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/bar', + {}, + nil, + {}, + { defined_params: { azureaistudio_inference_id: 'bar', task_type: 'foo' }, + endpoint: 'inference.put_azureaistudio' } + ] + end + + it 'performs the request' do + expect(client_double.inference.put_azureaistudio(task_type: 'foo', azureaistudio_inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/unit/actions/inference/put_azureopenai_spec.rb b/elasticsearch-api/spec/unit/actions/inference/put_azureopenai_spec.rb new file mode 100644 index 0000000000..ca0ade65b7 --- /dev/null +++ b/elasticsearch-api/spec/unit/actions/inference/put_azureopenai_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.put_azureopenai' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/bar', + {}, + nil, + {}, + { defined_params: { azureopenai_inference_id: 'bar', task_type: 'foo' }, + endpoint: 'inference.put_azureopenai' } + ] + end + + it 'performs the request' do + expect(client_double.inference.put_azureopenai(task_type: 'foo', azureopenai_inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/unit/actions/inference/put_cohere_spec.rb b/elasticsearch-api/spec/unit/actions/inference/put_cohere_spec.rb new file mode 100644 index 0000000000..7eb82de752 --- /dev/null +++ b/elasticsearch-api/spec/unit/actions/inference/put_cohere_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.put_cohere' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/bar', + {}, + nil, + {}, + { defined_params: { cohere_inference_id: 'bar', task_type: 'foo' }, + endpoint: 'inference.put_cohere' } + ] + end + + it 'performs the request' do + expect(client_double.inference.put_cohere(task_type: 'foo', cohere_inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/unit/actions/inference/put_custom_spec.rb b/elasticsearch-api/spec/unit/actions/inference/put_custom_spec.rb new file mode 100644 index 0000000000..a409676f1b --- /dev/null +++ b/elasticsearch-api/spec/unit/actions/inference/put_custom_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.put_custom' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/baz', + {}, + nil, + {}, + { defined_params: { custom_inference_id: 'baz', task_type: 'foo' }, + endpoint: 'inference.put_custom' } + ] + end + + it 'performs the request' do + expect(client_double.inference.put_custom(task_type: 'foo', custom_inference_id: 'baz')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/unit/actions/inference/put_elasticsearch_spec.rb b/elasticsearch-api/spec/unit/actions/inference/put_elasticsearch_spec.rb new file mode 100644 index 0000000000..e91a89c850 --- /dev/null +++ b/elasticsearch-api/spec/unit/actions/inference/put_elasticsearch_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.put_elasticsearch' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/bar', + {}, + nil, + {}, + { defined_params: { elasticsearch_inference_id: 'bar', task_type: 'foo' }, + endpoint: 'inference.put_elasticsearch' } + ] + end + + it 'performs the request' do + expect(client_double.inference.put_elasticsearch(task_type: 'foo', elasticsearch_inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/unit/actions/inference/put_elser_spec.rb b/elasticsearch-api/spec/unit/actions/inference/put_elser_spec.rb new file mode 100644 index 0000000000..1862e22721 --- /dev/null +++ b/elasticsearch-api/spec/unit/actions/inference/put_elser_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.put_elser' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/bar', + {}, + nil, + {}, + { defined_params: { elser_inference_id: 'bar', task_type: 'foo' }, + endpoint: 'inference.put_elser' } + ] + end + + it 'performs the request' do + expect(client_double.inference.put_elser(task_type: 'foo', elser_inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/unit/actions/inference/put_googleaistudio_spec.rb b/elasticsearch-api/spec/unit/actions/inference/put_googleaistudio_spec.rb new file mode 100644 index 0000000000..22c5284990 --- /dev/null +++ b/elasticsearch-api/spec/unit/actions/inference/put_googleaistudio_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.put_googleaistudio' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/bar', + {}, + nil, + {}, + { defined_params: { googleaistudio_inference_id: 'bar', task_type: 'foo' }, + endpoint: 'inference.put_googleaistudio' } + ] + end + + it 'performs the request' do + expect(client_double.inference.put_googleaistudio(task_type: 'foo', googleaistudio_inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/unit/actions/inference/put_googlevertexai_spec.rb b/elasticsearch-api/spec/unit/actions/inference/put_googlevertexai_spec.rb new file mode 100644 index 0000000000..ccf6c883bf --- /dev/null +++ b/elasticsearch-api/spec/unit/actions/inference/put_googlevertexai_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.put_googlevertexai' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/bar', + {}, + nil, + {}, + { defined_params: { googlevertexai_inference_id: 'bar', task_type: 'foo' }, + endpoint: 'inference.put_googlevertexai' } + ] + end + + it 'performs the request' do + expect(client_double.inference.put_googlevertexai(task_type: 'foo', googlevertexai_inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/unit/actions/inference/put_hugging_face_spec.rb b/elasticsearch-api/spec/unit/actions/inference/put_hugging_face_spec.rb new file mode 100644 index 0000000000..8feb11c28e --- /dev/null +++ b/elasticsearch-api/spec/unit/actions/inference/put_hugging_face_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.put_hugging_face' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/bar', + {}, + nil, + {}, + { defined_params: { huggingface_inference_id: 'bar', task_type: 'foo' }, + endpoint: 'inference.put_hugging_face' } + ] + end + + it 'performs the request' do + expect(client_double.inference.put_hugging_face(task_type: 'foo', huggingface_inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/unit/actions/inference/put_jinaai_spec.rb b/elasticsearch-api/spec/unit/actions/inference/put_jinaai_spec.rb new file mode 100644 index 0000000000..bcbf0e0f00 --- /dev/null +++ b/elasticsearch-api/spec/unit/actions/inference/put_jinaai_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.put_jinaai' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/bar', + {}, + nil, + {}, + { defined_params: { jinaai_inference_id: 'bar', task_type: 'foo' }, + endpoint: 'inference.put_jinaai' } + ] + end + + it 'performs the request' do + expect(client_double.inference.put_jinaai(task_type: 'foo', jinaai_inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/unit/actions/inference/put_mistral_spec.rb b/elasticsearch-api/spec/unit/actions/inference/put_mistral_spec.rb new file mode 100644 index 0000000000..2d8d8dbd3f --- /dev/null +++ b/elasticsearch-api/spec/unit/actions/inference/put_mistral_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.put_mistral' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/bar', + {}, + nil, + {}, + { defined_params: { mistral_inference_id: 'bar', task_type: 'foo' }, + endpoint: 'inference.put_mistral' } + ] + end + + it 'performs the request' do + expect(client_double.inference.put_mistral(task_type: 'foo', mistral_inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/unit/actions/inference/put_openai_spec.rb b/elasticsearch-api/spec/unit/actions/inference/put_openai_spec.rb new file mode 100644 index 0000000000..b58dd6e568 --- /dev/null +++ b/elasticsearch-api/spec/unit/actions/inference/put_openai_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.put_openai' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/bar', + {}, + nil, + {}, + { defined_params: { openai_inference_id: 'bar', task_type: 'foo' }, + endpoint: 'inference.put_openai' } + ] + end + + it 'performs the request' do + expect(client_double.inference.put_openai(task_type: 'foo', openai_inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/unit/actions/inference/put_spec.rb b/elasticsearch-api/spec/unit/actions/inference/put_spec.rb index e06f205437..bdd6393727 100644 --- a/elasticsearch-api/spec/unit/actions/inference/put_spec.rb +++ b/elasticsearch-api/spec/unit/actions/inference/put_spec.rb @@ -21,16 +21,16 @@ let(:expected_args) do [ 'PUT', - '_inference/foo/bar', + '_inference/bar', {}, - nil, {}, - { defined_params: { inference_id: 'bar', task_type: 'foo' }, + {}, + { defined_params: { inference_id: 'bar' }, endpoint: 'inference.put' } ] end it 'performs the request' do - expect(client_double.inference.put(task_type: 'foo', inference_id: 'bar')).to be_a Elasticsearch::API::Response + expect(client_double.inference.put(body: {}, inference_id: 'bar')).to be_a Elasticsearch::API::Response end end diff --git a/elasticsearch-api/spec/unit/actions/inference/put_voyageai_spec.rb b/elasticsearch-api/spec/unit/actions/inference/put_voyageai_spec.rb new file mode 100644 index 0000000000..8bac99b82d --- /dev/null +++ b/elasticsearch-api/spec/unit/actions/inference/put_voyageai_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.put_voyageai' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/bar', + {}, + nil, + {}, + { defined_params: { voyageai_inference_id: 'bar', task_type: 'foo' }, + endpoint: 'inference.put_voyageai' } + ] + end + + it 'performs the request' do + expect(client_double.inference.put_voyageai(task_type: 'foo', voyageai_inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/unit/actions/inference/put_watsonx_spec.rb b/elasticsearch-api/spec/unit/actions/inference/put_watsonx_spec.rb new file mode 100644 index 0000000000..44245b8b02 --- /dev/null +++ b/elasticsearch-api/spec/unit/actions/inference/put_watsonx_spec.rb @@ -0,0 +1,36 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.put_watsonx' do + let(:expected_args) do + [ + 'PUT', + '_inference/foo/bar', + {}, + nil, + {}, + { defined_params: { watsonx_inference_id: 'bar', task_type: 'foo' }, + endpoint: 'inference.put_watsonx' } + ] + end + + it 'performs the request' do + expect(client_double.inference.put_watsonx(task_type: 'foo', watsonx_inference_id: 'bar')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/unit/actions/inference/rerank_spec.rb b/elasticsearch-api/spec/unit/actions/inference/rerank_spec.rb new file mode 100644 index 0000000000..7417cd74fa --- /dev/null +++ b/elasticsearch-api/spec/unit/actions/inference/rerank_spec.rb @@ -0,0 +1,35 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.rerank' do + let(:expected_args) do + [ + 'POST', + '_inference/rerank/foo', + {}, + nil, + {}, + { defined_params: { inference_id: 'foo' }, endpoint: 'inference.rerank' } + ] + end + + it 'performs the request' do + expect(client_double.inference.rerank(inference_id: 'foo')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/unit/actions/inference/stream_inference_spec.rb b/elasticsearch-api/spec/unit/actions/inference/sparse_embedding_spec.rb similarity index 85% rename from elasticsearch-api/spec/unit/actions/inference/stream_inference_spec.rb rename to elasticsearch-api/spec/unit/actions/inference/sparse_embedding_spec.rb index 191ad643d5..856dface5a 100644 --- a/elasticsearch-api/spec/unit/actions/inference/stream_inference_spec.rb +++ b/elasticsearch-api/spec/unit/actions/inference/sparse_embedding_spec.rb @@ -17,19 +17,19 @@ require 'spec_helper' -describe 'client#inference.stream_inference' do +describe 'client#inference.sparse_embedding' do let(:expected_args) do [ 'POST', - '_inference/foo/_stream', + '_inference/sparse_embedding/foo', {}, nil, {}, - { defined_params: { inference_id: 'foo' }, endpoint: 'inference.stream_inference' } + { defined_params: { inference_id: 'foo' }, endpoint: 'inference.sparse_embedding' } ] end it 'performs the request' do - expect(client_double.inference.stream_inference(inference_id: 'foo')).to be_a Elasticsearch::API::Response + expect(client_double.inference.sparse_embedding(inference_id: 'foo')).to be_a Elasticsearch::API::Response end end diff --git a/elasticsearch-api/spec/unit/actions/inference/stream_completion_spec.rb b/elasticsearch-api/spec/unit/actions/inference/stream_completion_spec.rb new file mode 100644 index 0000000000..542b1d9941 --- /dev/null +++ b/elasticsearch-api/spec/unit/actions/inference/stream_completion_spec.rb @@ -0,0 +1,35 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.stream_completion' do + let(:expected_args) do + [ + 'POST', + '_inference/completion/foo/_stream', + {}, + nil, + {}, + { defined_params: { inference_id: 'foo' }, endpoint: 'inference.stream_completion' } + ] + end + + it 'performs the request' do + expect(client_double.inference.stream_completion(inference_id: 'foo')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/unit/actions/inference/text_embedding_spec.rb b/elasticsearch-api/spec/unit/actions/inference/text_embedding_spec.rb new file mode 100644 index 0000000000..e97fda5865 --- /dev/null +++ b/elasticsearch-api/spec/unit/actions/inference/text_embedding_spec.rb @@ -0,0 +1,35 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#inference.text_embedding' do + let(:expected_args) do + [ + 'POST', + '_inference/text_embedding/foo', + {}, + nil, + {}, + { defined_params: { inference_id: 'foo' }, endpoint: 'inference.text_embedding' } + ] + end + + it 'performs the request' do + expect(client_double.inference.text_embedding(inference_id: 'foo')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/unit/actions/inference/update_spec.rb b/elasticsearch-api/spec/unit/actions/inference/update_spec.rb index 6f29cd0b58..0ee998ee5b 100644 --- a/elasticsearch-api/spec/unit/actions/inference/update_spec.rb +++ b/elasticsearch-api/spec/unit/actions/inference/update_spec.rb @@ -23,7 +23,7 @@ 'PUT', '_inference/foo/bar/_update', {}, - nil, + {}, {}, { defined_params: { inference_id: 'bar', task_type: 'foo' }, endpoint: 'inference.update' } @@ -31,6 +31,6 @@ end it 'performs the request' do - expect(client_double.inference.update(task_type: 'foo', inference_id: 'bar')).to be_a Elasticsearch::API::Response + expect(client_double.inference.update(task_type: 'foo', body: {}, inference_id: 'bar')).to be_a Elasticsearch::API::Response end end diff --git a/elasticsearch-api/spec/unit/actions/ingest/get_geoip_database_spec.rb b/elasticsearch-api/spec/unit/actions/ingest/get_geoip_database_spec.rb index 535d653839..a46430d948 100644 --- a/elasticsearch-api/spec/unit/actions/ingest/get_geoip_database_spec.rb +++ b/elasticsearch-api/spec/unit/actions/ingest/get_geoip_database_spec.rb @@ -34,6 +34,6 @@ end it 'performs the request' do - expect(client_double.ingest.get_geoip_database(id: 'foo', body: {})).to be_a Elasticsearch::API::Response + expect(client_double.ingest.get_geoip_database(id: 'foo')).to be_a Elasticsearch::API::Response end end diff --git a/elasticsearch-api/spec/unit/actions/ingest/get_ip_location_database_spec.rb b/elasticsearch-api/spec/unit/actions/ingest/get_ip_location_database_spec.rb index 41c356c3d3..7f12bddcf8 100644 --- a/elasticsearch-api/spec/unit/actions/ingest/get_ip_location_database_spec.rb +++ b/elasticsearch-api/spec/unit/actions/ingest/get_ip_location_database_spec.rb @@ -22,7 +22,7 @@ [ 'GET', '_ingest/ip_location/database/foo', - {}, + { body: {}}, nil, {}, { defined_params: { id: 'foo' }, endpoint: 'ingest.get_ip_location_database' } diff --git a/elasticsearch-api/spec/unit/actions/machine_learning/infer_trained_model_deployment_spec.rb b/elasticsearch-api/spec/unit/actions/machine_learning/infer_trained_model_deployment_spec.rb index fccbe878bd..77964040e4 100644 --- a/elasticsearch-api/spec/unit/actions/machine_learning/infer_trained_model_deployment_spec.rb +++ b/elasticsearch-api/spec/unit/actions/machine_learning/infer_trained_model_deployment_spec.rb @@ -21,7 +21,7 @@ let(:expected_args) do [ 'POST', - '_ml/trained_models/foo/deployment/_infer', + '_ml/trained_models/foo/_infer', {}, {}, {}, diff --git a/elasticsearch-api/spec/unit/actions/msearch_spec.rb b/elasticsearch-api/spec/unit/actions/msearch_spec.rb index 3c56a6a46c..2be0a06272 100644 --- a/elasticsearch-api/spec/unit/actions/msearch_spec.rb +++ b/elasticsearch-api/spec/unit/actions/msearch_spec.rb @@ -42,21 +42,15 @@ end let(:headers) do - { 'Content-Type' => 'application/x-ndjson' } - end - - let(:client) do - Class.new { include Elasticsearch::API }.new + {} end - it 'requires the :body argument' do - expect { - client.msearch - }.to raise_exception(ArgumentError) + # This test only cares about the body, there's another test for the ndjson headers. + before do + dummy_ndjson_headers end context 'when the body is an object' do - let(:body) do <<-PAYLOAD.gsub(/^\s+/, '') {"index":"foo"} @@ -70,7 +64,7 @@ it 'performs the request' do expect(client_double.msearch body: [ - { index: 'foo', search: { query: { match_all: {} } } }, + { index: 'foo', search: { query: { match_all: {} } } }, { index: 'bar', search: { query: { match: { foo: 'bar' } } } }, { search_type: 'count', search: { facets: { tags: {} } } } ]) @@ -78,7 +72,6 @@ end context 'when the body is a string' do - let(:body) do %Q|{"foo":"bar"}\n{"moo":"lam"}| end @@ -89,7 +82,6 @@ end context 'when an index is specified' do - let(:url) do 'foo/_msearch' end @@ -115,7 +107,6 @@ end context 'when multiple indices are specified' do - let(:url) do 'foo,bar/_msearch' end @@ -141,7 +132,6 @@ end context 'when the request needs to be URL-escaped' do - let(:url) do 'foo%5Ebar/_msearch' end @@ -167,7 +157,6 @@ end context 'when the URL params need to be URL-encoded' do - let(:url) do '_msearch' end diff --git a/elasticsearch-api/spec/unit/actions/msearch_template_spec.rb b/elasticsearch-api/spec/unit/actions/msearch_template_spec.rb index 5ec1af4dbc..b62af31b2e 100644 --- a/elasticsearch-api/spec/unit/actions/msearch_template_spec.rb +++ b/elasticsearch-api/spec/unit/actions/msearch_template_spec.rb @@ -37,8 +37,11 @@ {} end - let(:headers) do - { 'Content-Type' => 'application/x-ndjson' } + let(:headers) {{}} + + # This test only cares about the body, there's another test for the ndjson headers. + before do + dummy_ndjson_headers end let(:url) do @@ -46,7 +49,6 @@ end context 'when a body is provided as a document' do - let(:body) do <<-PAYLOAD.gsub(/^\s+/, '') {"index":"foo"} @@ -67,7 +69,6 @@ end context 'when a body is provided as a string' do - let(:body) do %Q|{"foo":"bar"}\n{"moo":"lam"}| end @@ -78,7 +79,6 @@ end context 'when an index is provided' do - let(:url) do 'foo/_msearch/template' end diff --git a/elasticsearch-api/spec/unit/actions/mtermvectors_spec.rb b/elasticsearch-api/spec/unit/actions/mtermvectors_spec.rb index 1bbc458fb4..4913ab2de0 100644 --- a/elasticsearch-api/spec/unit/actions/mtermvectors_spec.rb +++ b/elasticsearch-api/spec/unit/actions/mtermvectors_spec.rb @@ -23,21 +23,28 @@ 'POST', 'my-index/_mtermvectors', {}, - body, + { ids: [1,2,3] }, {}, { defined_params: { index: 'my-index' }, endpoint: 'mtermvectors' } ] end - let(:body) do - { ids: [1, 2, 3] } - end - it 'performs the request' do expect(client_double.mtermvectors(index: 'my-index', body: { ids: [1, 2, 3] })).to be_a Elasticsearch::API::Response end context 'when a list of ids is passed instead of a body' do + let(:expected_args) do + [ + 'GET', + 'my-index/_mtermvectors', + {ids: '1,2,3'}, + nil, + {}, + { defined_params: { index: 'my-index' }, endpoint: 'mtermvectors' } + ] + end + it 'performs the request' do expect(client_double.mtermvectors(index: 'my-index', ids: [1, 2, 3])).to be_a Elasticsearch::API::Response end diff --git a/elasticsearch-api/spec/unit/actions/nodes/get_repositories_metering_info_spec.rb b/elasticsearch-api/spec/unit/actions/nodes/get_repositories_metering_info_spec.rb index 56bfdbe3c9..276967f504 100644 --- a/elasticsearch-api/spec/unit/actions/nodes/get_repositories_metering_info_spec.rb +++ b/elasticsearch-api/spec/unit/actions/nodes/get_repositories_metering_info_spec.rb @@ -22,10 +22,10 @@ [ 'GET', '_nodes/foo/_repositories_metering', - {}, + { max_archive_version: 'bar' }, nil, {}, - { defined_params: {node_id: 'foo' }, + { defined_params: { node_id: 'foo' }, endpoint: 'nodes.get_repositories_metering_info' } ] end diff --git a/elasticsearch-api/spec/unit/actions/scroll_spec.rb b/elasticsearch-api/spec/unit/actions/scroll_spec.rb index 36ba031209..d7b2b3aee4 100644 --- a/elasticsearch-api/spec/unit/actions/scroll_spec.rb +++ b/elasticsearch-api/spec/unit/actions/scroll_spec.rb @@ -22,11 +22,11 @@ let(:expected_args) do [ 'GET', - '_search/scroll/cXVlcn...', + '_search/scroll', {}, nil, {}, - { defined_params: { scroll_id: 'cXVlcn...' }, endpoint: 'scroll' } + { endpoint: 'scroll' } ] end diff --git a/elasticsearch-api/spec/unit/actions/security/activate_user_profile_spec.rb b/elasticsearch-api/spec/unit/actions/security/activate_user_profile_spec.rb new file mode 100644 index 0000000000..030bbeef79 --- /dev/null +++ b/elasticsearch-api/spec/unit/actions/security/activate_user_profile_spec.rb @@ -0,0 +1,35 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#security#activate_user_profile' do + let(:expected_args) do + [ + 'POST', + '_security/profile/_activate', + {}, + {}, + {}, + { endpoint: 'security.activate_user_profile' } + ] + end + + it 'performs the request' do + expect(client_double.security.activate_user_profile(body: {})).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/unit/actions/security/disable_user_profile_spec.rb b/elasticsearch-api/spec/unit/actions/security/disable_user_profile_spec.rb new file mode 100644 index 0000000000..67aa731cbf --- /dev/null +++ b/elasticsearch-api/spec/unit/actions/security/disable_user_profile_spec.rb @@ -0,0 +1,35 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#security#disable_user_profile' do + let(:expected_args) do + [ + 'PUT', + '_security/profile/foo/_disable', + {}, + nil, + {}, + { endpoint: 'security.disable_user_profile', defined_params: { uid: 'foo' } } + ] + end + + it 'performs the request' do + expect(client_double.security.disable_user_profile(uid: 'foo')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/unit/actions/security/enable_user_profile_spec.rb b/elasticsearch-api/spec/unit/actions/security/enable_user_profile_spec.rb new file mode 100644 index 0000000000..e5bf0dafab --- /dev/null +++ b/elasticsearch-api/spec/unit/actions/security/enable_user_profile_spec.rb @@ -0,0 +1,35 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#security#enable_user_profile' do + let(:expected_args) do + [ + 'PUT', + '_security/profile/foo/_enable', + {}, + nil, + {}, + { endpoint: 'security.enable_user_profile', defined_params: { uid: 'foo' } } + ] + end + + it 'performs the request' do + expect(client_double.security.enable_user_profile(uid: 'foo')).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/unit/actions/security/get_api_key_spec.rb b/elasticsearch-api/spec/unit/actions/security/get_api_key_spec.rb index 082d249109..508cd23dde 100644 --- a/elasticsearch-api/spec/unit/actions/security/get_api_key_spec.rb +++ b/elasticsearch-api/spec/unit/actions/security/get_api_key_spec.rb @@ -18,15 +18,14 @@ require 'spec_helper' describe 'client#security#get_api_key' do - let(:expected_args) do [ - 'GET', - '_security/api_key', - params, - nil, - {}, - { endpoint: 'security.get_api_key' } + 'GET', + '_security/api_key', + params, + nil, + {}, + { endpoint: 'security.get_api_key' } ] end @@ -39,7 +38,6 @@ end context 'when params are specified' do - let(:params) do { id: '1', username: 'user', @@ -49,9 +47,9 @@ it 'performs the request' do expect(client_double.security.get_api_key(id: '1', - username: 'user', - name: 'my-api-key', - realm_name: '_es_api_key')).to be_a Elasticsearch::API::Response + username: 'user', + name: 'my-api-key', + realm_name: '_es_api_key')).to be_a Elasticsearch::API::Response end end end diff --git a/elasticsearch-api/spec/unit/actions/rollup/get_rollup_index_caps_spec.rb b/elasticsearch-api/spec/unit/actions/security/get_user_profile_spec.rb similarity index 77% rename from elasticsearch-api/spec/unit/actions/rollup/get_rollup_index_caps_spec.rb rename to elasticsearch-api/spec/unit/actions/security/get_user_profile_spec.rb index 240a98be4b..4d528ae1fa 100644 --- a/elasticsearch-api/spec/unit/actions/rollup/get_rollup_index_caps_spec.rb +++ b/elasticsearch-api/spec/unit/actions/security/get_user_profile_spec.rb @@ -17,19 +17,19 @@ require 'spec_helper' -describe 'client#rollup.get_rollup_index_caps' do +describe 'client#security#get_user_profile' do let(:expected_args) do [ 'GET', - 'foo/_rollup/data', + '_security/profile/foo', {}, nil, {}, - { endpoint: 'rollup.get_rollup_index_caps', defined_params: { index: 'foo' } } + { endpoint: 'security.get_user_profile', defined_params: { uid: 'foo' } } ] end it 'performs the request' do - expect(client_double.rollup.get_rollup_index_caps(index: 'foo')).to be_a Elasticsearch::API::Response + expect(client_double.security.get_user_profile(uid: 'foo')).to be_a Elasticsearch::API::Response end end diff --git a/elasticsearch-api/spec/unit/actions/security/has_privilege_user_profile_spec.rb b/elasticsearch-api/spec/unit/actions/security/has_privilege_user_profile_spec.rb new file mode 100644 index 0000000000..a124ca0142 --- /dev/null +++ b/elasticsearch-api/spec/unit/actions/security/has_privilege_user_profile_spec.rb @@ -0,0 +1,35 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#security#has_privileges_user_profile' do + let(:expected_args) do + [ + 'POST', + '_security/profile/_has_privileges', + {}, + {}, + {}, + { endpoint: 'security.has_privileges_user_profile' } + ] + end + + it 'performs the request' do + expect(client_double.security.has_privileges_user_profile(body: {})).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/unit/actions/security/suggest_user_profile_spec.rb b/elasticsearch-api/spec/unit/actions/security/suggest_user_profile_spec.rb new file mode 100644 index 0000000000..dcf0ba20b1 --- /dev/null +++ b/elasticsearch-api/spec/unit/actions/security/suggest_user_profile_spec.rb @@ -0,0 +1,35 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'client#security#suggest_user_profiles' do + let(:expected_args) do + [ + 'POST', + '_security/profile/_suggest', + {}, + {}, + {}, + { endpoint: 'security.suggest_user_profiles' } + ] + end + + it 'performs the request' do + expect(client_double.security.suggest_user_profiles(body: {})).to be_a Elasticsearch::API::Response + end +end diff --git a/elasticsearch-api/spec/unit/actions/connector/last_sync_spec.rb b/elasticsearch-api/spec/unit/actions/security/update_user_profile_spec.rb similarity index 75% rename from elasticsearch-api/spec/unit/actions/connector/last_sync_spec.rb rename to elasticsearch-api/spec/unit/actions/security/update_user_profile_spec.rb index 68cb2b635e..1682a97fb5 100644 --- a/elasticsearch-api/spec/unit/actions/connector/last_sync_spec.rb +++ b/elasticsearch-api/spec/unit/actions/security/update_user_profile_spec.rb @@ -17,22 +17,19 @@ require 'spec_helper' -describe 'client.connector#last_sync' do +describe 'client#security#update_user_profile_data' do let(:expected_args) do [ 'PUT', - '_connector/foo/_last_sync', + '_security/profile/foo/_data', {}, {}, {}, - { - :defined_params=>{ connector_id: 'foo' }, - endpoint: 'connector.last_sync' - } + { endpoint: 'security.update_user_profile_data', defined_params: { uid: 'foo' } } ] end it 'performs the request' do - expect(client_double.connector.last_sync(connector_id: 'foo', body: {})).to be_a Elasticsearch::API::Response + expect(client_double.security.update_user_profile_data(uid: 'foo', body: {})).to be_a Elasticsearch::API::Response end end diff --git a/elasticsearch-api/spec/unit/actions/ssl/certificates_spec.rb b/elasticsearch-api/spec/unit/actions/ssl/certificates_spec.rb index 7ff7f7a7af..0472e5b6df 100644 --- a/elasticsearch-api/spec/unit/actions/ssl/certificates_spec.rb +++ b/elasticsearch-api/spec/unit/actions/ssl/certificates_spec.rb @@ -22,7 +22,7 @@ [ 'GET', '_ssl/certificates', - {}, + { index: 'foo' }, nil, {}, { endpoint: 'ssl.certificates' } diff --git a/elasticsearch-api/spec/unit/actions/text_structure/find_structure_spec.rb b/elasticsearch-api/spec/unit/actions/text_structure/find_structure_spec.rb index e6d18a9ad7..3798068f35 100644 --- a/elasticsearch-api/spec/unit/actions/text_structure/find_structure_spec.rb +++ b/elasticsearch-api/spec/unit/actions/text_structure/find_structure_spec.rb @@ -17,18 +17,24 @@ require 'spec_helper' -describe 'client.text_structure#test_grok_pattern' do +describe 'client.text_structure#find_structure' do let(:expected_args) do [ 'POST', '_text_structure/find_structure', {}, {}, - { 'Content-Type' => 'application/x-ndjson' }, + {}, { endpoint: 'text_structure.find_structure' } ] end + # This test only cares about the body, there's another test for the ndjson headers. + before do + dummy_ndjson_headers + allow(client_double.text_structure.client).to receive(:transport).and_return Transport.new({ transport_options: { headers: {} } }) + end + it 'performs the request' do expect(client_double.text_structure.find_structure(body: {})).to be_a Elasticsearch::API::Response end diff --git a/elasticsearch-api/spec/unit/actions/knn_search_spec.rb b/elasticsearch-api/spec/unit/actions/transform/set_upgrade_mode_spec.rb similarity index 78% rename from elasticsearch-api/spec/unit/actions/knn_search_spec.rb rename to elasticsearch-api/spec/unit/actions/transform/set_upgrade_mode_spec.rb index 2400b84238..9dd1b158c1 100644 --- a/elasticsearch-api/spec/unit/actions/knn_search_spec.rb +++ b/elasticsearch-api/spec/unit/actions/transform/set_upgrade_mode_spec.rb @@ -17,19 +17,19 @@ require 'spec_helper' -describe 'client#knn_search' do +describe 'client.transform#set_upgrade_mode' do let(:expected_args) do [ - 'GET', - 'foo/_knn_search', - { }, + 'POST', + '_transform/set_upgrade_mode', + {}, nil, {}, - { endpoint: 'knn_search', defined_params: { index: 'foo' } } + { endpoint: 'transform.set_upgrade_mode' } ] end it 'performs the request' do - expect(client_double.knn_search(index: 'foo')).to be_a Elasticsearch::API::Response + expect(client_double.transform.set_upgrade_mode).to be_a Elasticsearch::API::Response end end diff --git a/elasticsearch-api/spec/unit/client_spec.rb b/elasticsearch-api/spec/unit/client_spec.rb index 9b4ade1af6..1021878543 100644 --- a/elasticsearch-api/spec/unit/client_spec.rb +++ b/elasticsearch-api/spec/unit/client_spec.rb @@ -39,4 +39,26 @@ expect(client.respond_to?(:bulk)).to be(true) end end + + describe 'aliases' do + it 'uses ml alias' do + expect(client.machine_learning).to be_a MachineLearningClient + expect(client.ml).to be_a MachineLearningClient + end + + it 'uses ilm alias' do + expect(client.index_lifecycle_management).to be_a IndexLifecycleManagementClient + expect(client.ilm).to be_a IndexLifecycleManagementClient + end + + it 'uses ccr alias' do + expect(client.cross_cluster_replication).to be_a CrossClusterReplicationClient + expect(client.ccr).to be_a CrossClusterReplicationClient + end + + it 'uses slm alias' do + expect(client.snapshot_lifecycle_management).to be_a SnapshotLifecycleManagementClient + expect(client.slm).to be_a SnapshotLifecycleManagementClient + end + end end diff --git a/elasticsearch-api/spec/unit/ndjson_endpoints/bulk_spec.rb b/elasticsearch-api/spec/unit/ndjson_endpoints/bulk_spec.rb new file mode 100644 index 0000000000..d775c4e12c --- /dev/null +++ b/elasticsearch-api/spec/unit/ndjson_endpoints/bulk_spec.rb @@ -0,0 +1,124 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'bulk headers test' do + context 'when not setting headers' do + let(:client) do + Elasticsearch::Client.new + end + + let(:expected_headers) do + { + 'accept' => 'application/vnd.elasticsearch+x-ndjson; compatible-with=9', + 'content-type' => 'application/vnd.elasticsearch+x-ndjson; compatible-with=9' + } + end + + it 'does not override headers' do + allow(client) + .to receive(:perform_request) + .with( + Elasticsearch::API::HTTP_POST, + '_bulk', + {}, + {}, + expected_headers, + { endpoint: 'bulk' } + ) + expect(client.bulk(body: {})).to be_a Elasticsearch::API::Response + end + end + + context 'when using compatibility headers for version 8' do + let(:client) do + Elasticsearch::Client.new( + transport_options: { + headers: custom_headers + } + ) + end + + let(:custom_headers) do + { + accept: 'application/vnd.elasticsearch+json; compatible-with=8', + content_type: 'application/vnd.elasticsearch+json; compatible-with=8' + } + end + + let(:expected_headers) do + { + accept: 'application/vnd.elasticsearch+x-ndjson; compatible-with=8', + content_type: 'application/vnd.elasticsearch+x-ndjson; compatible-with=8' + } + end + + it 'does not override version in headers' do + allow(client) + .to receive(:perform_request) + .with( + Elasticsearch::API::HTTP_POST, + '_bulk', + {}, + {}, + expected_headers, + { endpoint: 'bulk' } + ) + expect(client.bulk(body: {})).to be_a Elasticsearch::API::Response + end + end + + context 'when using custom headers in request' do + let(:client) do + Elasticsearch::Client.new( + transport_options: { + headers: custom_headers + } + ) + end + + let(:custom_headers) do + { + accept: 'application/vnd.elasticsearch+json; compatible-with=8', + content_type: 'application/vnd.elasticsearch+json; compatible-with=8' + } + end + + let(:expected_headers) do + { + accept: 'application/vnd.elasticsearch+x-ndjson; compatible-with=8', + content_type: 'application/vnd.elasticsearch+x-ndjson; compatible-with=8', + x_custom: 'Custom header' + } + end + + it 'does not override version in headers' do + allow(client) + .to receive(:perform_request) + .with( + Elasticsearch::API::HTTP_POST, + '_bulk', + {}, + {}, + expected_headers, + { endpoint: 'bulk' } + ) + expect(client.bulk(body: {}, headers: { x_custom: 'Custom header' })).to be_a Elasticsearch::API::Response + end + end +end diff --git a/elasticsearch-api/spec/unit/ndjson_endpoints/find_structure_spec.rb b/elasticsearch-api/spec/unit/ndjson_endpoints/find_structure_spec.rb new file mode 100644 index 0000000000..3b49f059a2 --- /dev/null +++ b/elasticsearch-api/spec/unit/ndjson_endpoints/find_structure_spec.rb @@ -0,0 +1,124 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'text_structure.find_structure headers test' do + context 'when not setting headers' do + let(:client) do + Elasticsearch::Client.new + end + + let(:expected_headers) do + { + 'accept' => 'application/vnd.elasticsearch+x-ndjson; compatible-with=9', + 'content-type' => 'application/vnd.elasticsearch+x-ndjson; compatible-with=9' + } + end + + it 'does not override headers' do + allow(client) + .to receive(:perform_request) + .with( + Elasticsearch::API::HTTP_POST, + '_text_structure/find_structure', + {}, + {}, + expected_headers, + { endpoint: 'text_structure.find_structure' } + ) + expect(client.text_structure.find_structure(body: {})).to be_a Elasticsearch::API::Response + end + end + + context 'when using compatibility headers for version 8' do + let(:client) do + Elasticsearch::Client.new( + transport_options: { + headers: custom_headers + } + ) + end + + let(:custom_headers) do + { + accept: 'application/vnd.elasticsearch+json; compatible-with=8', + content_type: 'application/vnd.elasticsearch+json; compatible-with=8' + } + end + + let(:expected_headers) do + { + accept: 'application/vnd.elasticsearch+x-ndjson; compatible-with=8', + content_type: 'application/vnd.elasticsearch+x-ndjson; compatible-with=8' + } + end + + it 'does not override version in headers' do + allow(client) + .to receive(:perform_request) + .with( + Elasticsearch::API::HTTP_POST, + '_text_structure/find_structure', + {}, + {}, + expected_headers, + { endpoint: 'text_structure.find_structure' } + ) + expect(client.text_structure.find_structure(body: {})).to be_a Elasticsearch::API::Response + end + end + + context 'when using custom headers in request' do + let(:client) do + Elasticsearch::Client.new( + transport_options: { + headers: custom_headers + } + ) + end + + let(:custom_headers) do + { + accept: 'application/vnd.elasticsearch+json; compatible-with=8', + content_type: 'application/vnd.elasticsearch+json; compatible-with=8' + } + end + + let(:expected_headers) do + { + accept: 'application/vnd.elasticsearch+x-ndjson; compatible-with=8', + content_type: 'application/vnd.elasticsearch+x-ndjson; compatible-with=8', + x_custom: 'Custom header' + } + end + + it 'does not override version in headers' do + allow(client) + .to receive(:perform_request) + .with( + Elasticsearch::API::HTTP_POST, + '_text_structure/find_structure', + {}, + {}, + expected_headers, + { endpoint: 'text_structure.find_structure' } + ) + expect(client.text_structure.find_structure(body: {}, headers: { x_custom: 'Custom header' })).to be_a Elasticsearch::API::Response + end + end +end diff --git a/elasticsearch-api/spec/unit/ndjson_endpoints/fleet_msearch_spec.rb b/elasticsearch-api/spec/unit/ndjson_endpoints/fleet_msearch_spec.rb new file mode 100644 index 0000000000..ddd416a526 --- /dev/null +++ b/elasticsearch-api/spec/unit/ndjson_endpoints/fleet_msearch_spec.rb @@ -0,0 +1,136 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'fleet.msearch exception' do + let(:client) do + Class.new { include Elasticsearch::API }.new + end + + it 'requires the :body argument' do + expect { + client.fleet.msearch + }.to raise_exception(ArgumentError) + end +end + +describe 'fleet.msearch headers test' do + context 'when not setting headers' do + let(:client) do + Elasticsearch::Client.new + end + + let(:expected_headers) do + { + 'accept' => 'application/vnd.elasticsearch+x-ndjson; compatible-with=9', + 'content-type' => 'application/vnd.elasticsearch+x-ndjson; compatible-with=9' + } + end + + it 'does not override headers' do + allow(client) + .to receive(:perform_request) + .with( + Elasticsearch::API::HTTP_POST, + '_fleet/_fleet_msearch', + {}, + {}, + expected_headers, + { endpoint: 'fleet.msearch' } + ) + expect(client.fleet.msearch(body: {})).to be_a Elasticsearch::API::Response + end + end + + context 'when using compatibility headers for version 8' do + let(:client) do + Elasticsearch::Client.new( + transport_options: { + headers: custom_headers + } + ) + end + + let(:custom_headers) do + { + accept: 'application/vnd.elasticsearch+json; compatible-with=8', + content_type: 'application/vnd.elasticsearch+json; compatible-with=8' + } + end + + let(:expected_headers) do + { + accept: 'application/vnd.elasticsearch+x-ndjson; compatible-with=8', + content_type: 'application/vnd.elasticsearch+x-ndjson; compatible-with=8' + } + end + + it 'does not override version in headers' do + allow(client) + .to receive(:perform_request) + .with( + Elasticsearch::API::HTTP_POST, + '_fleet/_fleet_msearch', + {}, + {}, + expected_headers, + { endpoint: 'fleet.msearch' } + ) + expect(client.fleet.msearch(body: {})).to be_a Elasticsearch::API::Response + end + end + + context 'when using custom headers in request' do + let(:client) do + Elasticsearch::Client.new( + transport_options: { + headers: custom_headers + } + ) + end + + let(:custom_headers) do + { + accept: 'application/vnd.elasticsearch+json; compatible-with=8', + content_type: 'application/vnd.elasticsearch+json; compatible-with=8' + } + end + + let(:expected_headers) do + { + accept: 'application/vnd.elasticsearch+x-ndjson; compatible-with=8', + content_type: 'application/vnd.elasticsearch+x-ndjson; compatible-with=8', + x_custom: 'Custom header' + } + end + + it 'does not override version in headers' do + allow(client) + .to receive(:perform_request) + .with( + Elasticsearch::API::HTTP_POST, + '_fleet/_fleet_msearch', + {}, + {}, + expected_headers, + { endpoint: 'fleet.msearch' } + ) + expect(client.fleet.msearch(body: {}, headers: { x_custom: 'Custom header' })).to be_a Elasticsearch::API::Response + end + end +end diff --git a/elasticsearch-api/spec/unit/ndjson_endpoints/msearch_spec.rb b/elasticsearch-api/spec/unit/ndjson_endpoints/msearch_spec.rb new file mode 100644 index 0000000000..d1d63c586c --- /dev/null +++ b/elasticsearch-api/spec/unit/ndjson_endpoints/msearch_spec.rb @@ -0,0 +1,132 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'msearch custom' do + context 'raise exception' do + it 'requires the :body argument' do + expect do + Elasticsearch::Client.new.msearch + end.to raise_exception(ArgumentError) + end + end + + context 'when not setting headers' do + let(:client) do + Elasticsearch::Client.new + end + + let(:expected_headers) do + { + 'accept' => 'application/vnd.elasticsearch+x-ndjson; compatible-with=9', + 'content-type' => 'application/vnd.elasticsearch+x-ndjson; compatible-with=9' + } + end + + it 'does not override headers' do + allow(client) + .to receive(:perform_request) + .with( + Elasticsearch::API::HTTP_POST, + '_msearch', + {}, + {}, + expected_headers, + { endpoint: 'msearch' } + ) + expect(client.msearch(body: {})).to be_a Elasticsearch::API::Response + end + end + + context 'when using compatibility headers for version 8' do + let(:client) do + Elasticsearch::Client.new( + transport_options: { + headers: custom_headers + } + ) + end + + let(:custom_headers) do + { + accept: 'application/vnd.elasticsearch+json; compatible-with=8', + content_type: 'application/vnd.elasticsearch+json; compatible-with=8' + } + end + + let(:expected_headers) do + { + accept: 'application/vnd.elasticsearch+x-ndjson; compatible-with=8', + content_type: 'application/vnd.elasticsearch+x-ndjson; compatible-with=8' + } + end + + it 'does not override version in headers' do + allow(client) + .to receive(:perform_request) + .with( + Elasticsearch::API::HTTP_POST, + '_msearch', + {}, + {}, + expected_headers, + { endpoint: 'msearch' } + ) + expect(client.msearch(body: {})).to be_a Elasticsearch::API::Response + end + end + + context 'when using custom headers in request' do + let(:client) do + Elasticsearch::Client.new( + transport_options: { + headers: custom_headers + } + ) + end + + let(:custom_headers) do + { + accept: 'application/vnd.elasticsearch+json; compatible-with=8', + content_type: 'application/vnd.elasticsearch+json; compatible-with=8' + } + end + + let(:expected_headers) do + { + accept: 'application/vnd.elasticsearch+x-ndjson; compatible-with=8', + content_type: 'application/vnd.elasticsearch+x-ndjson; compatible-with=8', + x_custom: 'Custom header' + } + end + + it 'does not override version in headers' do + allow(client) + .to receive(:perform_request) + .with( + Elasticsearch::API::HTTP_POST, + '_msearch', + {}, + {}, + expected_headers, + { endpoint: 'msearch' } + ) + expect(client.msearch(body: {}, headers: { x_custom: 'Custom header' })).to be_a Elasticsearch::API::Response + end + end +end diff --git a/elasticsearch-api/spec/unit/ndjson_endpoints/msearch_template_spec.rb b/elasticsearch-api/spec/unit/ndjson_endpoints/msearch_template_spec.rb new file mode 100644 index 0000000000..915d906de7 --- /dev/null +++ b/elasticsearch-api/spec/unit/ndjson_endpoints/msearch_template_spec.rb @@ -0,0 +1,124 @@ +# Licensed to Elasticsearch B.V. under one or more contributor +# license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright +# ownership. Elasticsearch B.V. licenses this file to you under +# the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. + +require 'spec_helper' + +describe 'msearrch_template headers test' do + context 'when not setting headers' do + let(:client) do + Elasticsearch::Client.new + end + + let(:expected_headers) do + { + 'accept' => 'application/vnd.elasticsearch+x-ndjson; compatible-with=9', + 'content-type' => 'application/vnd.elasticsearch+x-ndjson; compatible-with=9' + } + end + + it 'does not override headers' do + allow(client) + .to receive(:perform_request) + .with( + Elasticsearch::API::HTTP_POST, + '_msearch/template', + {}, + {}, + expected_headers, + { endpoint: 'msearch_template' } + ) + expect(client.msearch_template(body: {})).to be_a Elasticsearch::API::Response + end + end + + context 'when using compatibility headers for version 8' do + let(:client) do + Elasticsearch::Client.new( + transport_options: { + headers: custom_headers + } + ) + end + + let(:custom_headers) do + { + accept: 'application/vnd.elasticsearch+json; compatible-with=8', + content_type: 'application/vnd.elasticsearch+json; compatible-with=8' + } + end + + let(:expected_headers) do + { + accept: 'application/vnd.elasticsearch+x-ndjson; compatible-with=8', + content_type: 'application/vnd.elasticsearch+x-ndjson; compatible-with=8' + } + end + + it 'does not override version in headers' do + allow(client) + .to receive(:perform_request) + .with( + Elasticsearch::API::HTTP_POST, + '_msearch/template', + {}, + {}, + expected_headers, + { endpoint: 'msearch_template' } + ) + expect(client.msearch_template(body: {})).to be_a Elasticsearch::API::Response + end + end + + context 'when using custom headers in request' do + let(:client) do + Elasticsearch::Client.new( + transport_options: { + headers: custom_headers + } + ) + end + + let(:custom_headers) do + { + accept: 'application/vnd.elasticsearch+json; compatible-with=8', + content_type: 'application/vnd.elasticsearch+json; compatible-with=8' + } + end + + let(:expected_headers) do + { + accept: 'application/vnd.elasticsearch+x-ndjson; compatible-with=8', + content_type: 'application/vnd.elasticsearch+x-ndjson; compatible-with=8', + x_custom: 'Custom header' + } + end + + it 'does not override version in headers' do + allow(client) + .to receive(:perform_request) + .with( + Elasticsearch::API::HTTP_POST, + '_msearch/template', + {}, + {}, + expected_headers, + { endpoint: 'msearch_template' } + ) + expect(client.msearch_template(body: {}, headers: { x_custom: 'Custom header' })).to be_a Elasticsearch::API::Response + end + end +end diff --git a/elasticsearch-api/spec/unit/perform_request_spec.rb b/elasticsearch-api/spec/unit/perform_request_spec.rb index 154e19bd90..9d1901c148 100644 --- a/elasticsearch-api/spec/unit/perform_request_spec.rb +++ b/elasticsearch-api/spec/unit/perform_request_spec.rb @@ -23,7 +23,11 @@ describe 'Perform request args' do Elasticsearch::API::FilesHelper.files.each do |filepath| spec = Elasticsearch::API::EndpointSpec.new(filepath) - next if spec.module_namespace.flatten.first == '_internal' || spec.visibility != 'public' + next if spec.module_namespace.flatten.first == '_internal' || + spec.visibility != 'public' || + # TODO: Once the test suite is migrated to elasticsearch-specification, these should be removed + spec.module_namespace.flatten.first == 'rollup' || + ['scroll', 'clear_scroll', 'connector.last_sync', 'knn_search'].include?(spec.endpoint_name) # These are the path parts defined by the user in the method argument defined_path_parts = spec.path_params.inject({}) do |params, part| @@ -35,13 +39,11 @@ params.merge(part.to_sym => 'testing') end + required_params.merge!(body: {}) if ['inference.put', 'inference.update', 'inference.chat_completion_unified'].include? spec.endpoint_name + let(:client_double) do Class.new { include Elasticsearch::API }.new.tap do |client| expect(client).to receive(:perform_request) do |_, _, _, _, _, request_params| - # The create method ends up becoming an 'index' request - if expected_perform_request_params[:endpoint] == 'create' - expected_perform_request_params[:endpoint] = 'index' - end # Check that the expected hash is passed to the perform_request method expect(request_params).to eq(expected_perform_request_params) end.and_return(response_double) @@ -52,6 +54,16 @@ double('response', status: 200, body: {}, headers: {}) end + let(:transport_double) do + Transport ||= Struct.new('Transport', :options) + Transport.new({ transport_options: { headers: {} } }) + end + + before do + allow(client_double).to receive(:transport).and_return transport_double + allow(Elasticsearch::API::Utils).to receive(:update_ndjson_headers!).and_return({}) + end + context("'#{spec.endpoint_name}'") do # The expected hash passed to perform_request contains the endpoint name and any defined path parts let(:expected_perform_request_params) do diff --git a/elasticsearch-api/spec/unit/utils_spec.rb b/elasticsearch-api/spec/unit/utils_spec.rb index 63eba22f13..93680796cb 100644 --- a/elasticsearch-api/spec/unit/utils_spec.rb +++ b/elasticsearch-api/spec/unit/utils_spec.rb @@ -22,72 +22,72 @@ Class.new { include Elasticsearch::API::Utils }.new end - describe '#__escape' do + describe '#escape' do it 'encodes Unicode characters' do - expect(utils.__escape('中文')).to eq('%E4%B8%AD%E6%96%87') + expect(utils.escape('中文')).to eq('%E4%B8%AD%E6%96%87') end it 'encodes special characters' do - expect(utils.__escape('foo bar')).to eq('foo%20bar') - expect(utils.__escape('foo/bar')).to eq('foo%2Fbar') - expect(utils.__escape('foo^bar')).to eq('foo%5Ebar') + expect(utils.escape('foo bar')).to eq('foo%20bar') + expect(utils.escape('foo/bar')).to eq('foo%2Fbar') + expect(utils.escape('foo^bar')).to eq('foo%5Ebar') end it 'does not encode asterisks' do - expect(utils.__escape('*')).to eq('*') + expect(utils.escape('*')).to eq('*') end end - describe '#__listify' do + describe '#listify' do it 'creates a list from a single value' do - expect(utils.__listify('foo')).to eq('foo') + expect(utils.listify('foo')).to eq('foo') end it 'creates a list from an array' do - expect(utils.__listify(['foo', 'bar'])).to eq('foo,bar') + expect(utils.listify(['foo', 'bar'])).to eq('foo,bar') end it 'creates a list from multiple arguments' do - expect(utils.__listify('foo', 'bar')).to eq('foo,bar') + expect(utils.listify('foo', 'bar')).to eq('foo,bar') end it 'ignores nil values' do - expect(utils.__listify(['foo', nil, 'bar'])).to eq('foo,bar') + expect(utils.listify(['foo', nil, 'bar'])).to eq('foo,bar') end it 'ignores special characters' do - expect(utils.__listify(['foo', 'bar^bam'])).to eq('foo,bar%5Ebam') + expect(utils.listify(['foo', 'bar^bam'])).to eq('foo,bar%5Ebam') end context 'when the escape option is set to false' do it 'does not escape the characters' do - expect(utils.__listify(['foo', 'bar^bam'], escape: false)).to eq('foo,bar^bam') + expect(utils.listify(['foo', 'bar^bam'], escape: false)).to eq('foo,bar^bam') end end end - describe '#__pathify' do + describe '#pathify' do it 'creates a path from a single value' do - expect(utils.__pathify('foo')).to eq('foo') + expect(utils.pathify('foo')).to eq('foo') end it 'creates a path from an array' do - expect(utils.__pathify(['foo', 'bar'])).to eq('foo/bar') + expect(utils.pathify(['foo', 'bar'])).to eq('foo/bar') end it 'ignores nil values' do - expect(utils.__pathify(['foo', nil, 'bar'])).to eq('foo/bar') + expect(utils.pathify(['foo', nil, 'bar'])).to eq('foo/bar') end it 'ignores empty string values' do - expect(utils.__pathify(['foo', '', 'bar'])).to eq('foo/bar') + expect(utils.pathify(['foo', '', 'bar'])).to eq('foo/bar') end end - describe '#__bulkify' do + describe '#bulkify' do context 'when the input is an array of hashes' do let(:result) do - utils.__bulkify [ + utils.bulkify [ { index: { _index: 'myindexA', _id: '1', data: { title: 'Test' } } }, { update: { _index: 'myindexB', _id: '2', data: { doc: { title: 'Update' } } } }, { delete: { _index: 'myindexC', _id: '3' } } @@ -112,7 +112,7 @@ context 'when the input is an array of strings' do let(:result) do - utils.__bulkify(['{"foo":"bar"}','{"moo":"bam"}']) + utils.bulkify(['{"foo":"bar"}','{"moo":"bam"}']) end let(:expected_string) do @@ -130,7 +130,7 @@ context 'when the input is an array of header/data pairs' do let(:result) do - utils.__bulkify([{ foo: 'bar' }, { moo: 'bam' },{ foo: 'baz' }]) + utils.bulkify([{ foo: 'bar' }, { moo: 'bam' },{ foo: 'baz' }]) end let(:expected_string) do @@ -153,7 +153,7 @@ end let(:result) do - utils.__bulkify([input]) + utils.bulkify([input]) end let(:expected_string) do @@ -178,7 +178,7 @@ end let(:result) do - utils.__bulkify([{ index: { foo: 'bar'} } , data]) + utils.bulkify([{ index: { foo: 'bar'} } , data]) end let(:lines) do @@ -221,135 +221,30 @@ end end - describe '#__extract_parts' do + describe '#extract_parts' do it 'extracts parts with true value from a Hash' do - expect(utils.__extract_parts({ foo: true, moo: 'blah' })).to eq(['foo', 'blah']) + expect(utils.extract_parts({ foo: true, moo: 'blah' })).to eq(['foo', 'blah']) end it 'extracts parts with string value from a Hash' do - expect(utils.__extract_parts({ foo: 'qux', moo: 'blah' })).to eq(['qux', 'blah']) + expect(utils.extract_parts({ foo: 'qux', moo: 'blah' })).to eq(['qux', 'blah']) end end - context '#__rescue_from_not_found' do - + context '#rescue_from_not_found' do it 'returns false if exception class name contains \'NotFound\'' do - expect(utils.__rescue_from_not_found { raise NotFound }).to be(false) + expect(utils.rescue_from_not_found { raise NotFound }).to be(false) end it 'returns false if exception message contains \'Not Found\'' do - expect(utils.__rescue_from_not_found { raise StandardError.new "Not Found" }).to be(false) - expect(utils.__rescue_from_not_found { raise StandardError.new "NotFound" }).to be(false) + expect(utils.rescue_from_not_found { raise StandardError.new "Not Found" }).to be(false) + expect(utils.rescue_from_not_found { raise StandardError.new "NotFound" }).to be(false) end it 'raises the exception if the class name and message do not include \'NotFound\'' do expect { - utils.__rescue_from_not_found { raise StandardError.new "Any other exception" } + utils.rescue_from_not_found { raise StandardError.new "Any other exception" } }.to raise_exception(StandardError) end end - - context '#__report_unsupported_parameters' do - - context 'when the parameters are passed as Symbols' do - - let(:arguments) do - { foo: 'bar', moo: 'bam', baz: 'qux' } - end - - let(:unsupported_params) do - [ :foo, :moo] - end - - let(:message) do - message = '' - expect(Kernel).to receive(:warn) { |msg| message = msg } - utils.__report_unsupported_parameters(arguments, unsupported_params) - message - end - - it 'prints the unsupported parameters' do - expect(message).to match(/You are using unsupported parameter \[\:foo\]/) - expect(message).to match(/You are using unsupported parameter \[\:moo\]/) - end - end - - context 'when the parameters are passed as Hashes' do - - let(:arguments) do - { foo: 'bar', moo: 'bam', baz: 'qux' } - end - - let(:unsupported_params) do - [ :foo, :moo] - end - - let(:message) do - message = '' - expect(Kernel).to receive(:warn) { |msg| message = msg } - utils.__report_unsupported_parameters(arguments, unsupported_params) - message - end - - it 'prints the unsupported parameters' do - expect(message).to match(/You are using unsupported parameter \[\:foo\]/) - expect(message).to match(/You are using unsupported parameter \[\:moo\]/) - end - end - - context 'when the parameters are passed as a mix of Hashes and Symbols' do - - let(:arguments) do - { foo: 'bar', moo: 'bam', baz: 'qux' } - end - - let(:unsupported_params) do - [ { foo: { explanation: 'NOT_SUPPORTED'} }, :moo ] - end - - - let(:message) do - message = '' - expect(Kernel).to receive(:warn) { |msg| message = msg } - utils.__report_unsupported_parameters(arguments, unsupported_params) - message - end - - it 'prints the unsupported parameters' do - expect(message).to match(/You are using unsupported parameter \[\:foo\]/) - expect(message).to match(/You are using unsupported parameter \[\:moo\]/) - expect(message).to match(/NOT_SUPPORTED/) - end - end - - context 'when unsupported parameters are unused' do - - let(:arguments) do - { moo: 'bam', baz: 'qux' } - end - - let(:unsupported_params) do - [ :foo ] - end - - it 'prints the unsupported parameters' do - expect(Kernel).not_to receive(:warn) - utils.__report_unsupported_parameters(arguments, unsupported_params) - end - end - end - - describe '#__report_unsupported_method' do - - let(:message) do - message = '' - expect(Kernel).to receive(:warn) { |msg| message = msg } - utils.__report_unsupported_method(:foo) - message - end - - it 'prints a warning' do - expect(message).to match(/foo/) - end - end end diff --git a/elasticsearch-api/spec/yaml-test-runner/run.rb b/elasticsearch-api/spec/yaml-test-runner/run.rb index 701d26b801..ad8b9a89db 100644 --- a/elasticsearch-api/spec/yaml-test-runner/run.rb +++ b/elasticsearch-api/spec/yaml-test-runner/run.rb @@ -62,9 +62,9 @@ def serverless? if serverless? options.merge!( { - retry_on_status: [409], - retry_on_failure: 10, - delay_on_retry: 60_000, + retry_on_status: [408, 409, 400, 503], + retry_on_failure: 20, + delay_on_retry: 10_000, request_timeout: 120 } ) @@ -81,9 +81,8 @@ def serverless? # If we're running in a release branch, download the corresponding branch for tests current_branch = `git rev-parse --abbrev-ref HEAD`.strip -branch = current_branch.match(/[0-9]\.[0-9]+/)&.[](0) || ENV['ES_YAML_TESTS_BRANCH'] || nil +branch = ENV['ES_YAML_TESTS_BRANCH'] || current_branch.match(/[0-9]\.[0-9]+/)&.[](0) || nil Elasticsearch::Tests::Downloader::run(tests_path, branch) runner = Elasticsearch::Tests::TestRunner.new(CLIENT, tests_path, logger) -runner.add_tests_to_skip('knn_search.yml') # TODO: Extract into file runner.run(ENV['SINGLE_TEST'] || []) diff --git a/elasticsearch-api/utils/Gemfile b/elasticsearch-api/utils/Gemfile index 6f6f061b67..d7a0fe4d5a 100644 --- a/elasticsearch-api/utils/Gemfile +++ b/elasticsearch-api/utils/Gemfile @@ -24,5 +24,5 @@ gem 'multi_json' gem 'pry' gem 'thor' -gem 'rubocop', '>= 1.51' unless defined?(JRUBY_VERSION) && Gem::Version.new(JRUBY_VERSION) <= Gem::Version.new('9.4') +gem 'rubocop', '>= 1.51' unless defined?(JRUBY_VERSION) gem 'debug' unless defined?(JRUBY_VERSION) diff --git a/elasticsearch-api/utils/thor/endpoint_specifics.rb b/elasticsearch-api/utils/thor/endpoint_specifics.rb index eea5f46cdd..d521b5160b 100644 --- a/elasticsearch-api/utils/thor/endpoint_specifics.rb +++ b/elasticsearch-api/utils/thor/endpoint_specifics.rb @@ -136,7 +136,7 @@ def msearch_template_body_helper def bulk_body_helper <<~SRC payload = if body.is_a? Array - Elasticsearch::API::Utils.__bulkify(body) + Elasticsearch::API::Utils.bulkify(body) else body end @@ -150,7 +150,7 @@ def find_structure_body_helper def bulk_doc_helper(info) <<~SRC # @option arguments [String|Array] :body #{info}. Array of Strings, Header/Data pairs, - # or the conveniency "combined" format can be passed, refer to Elasticsearch::API::Utils.__bulkify documentation. + # or the conveniency "combined" format can be passed, refer to Elasticsearch::API::Utils.bulkify documentation. SRC end end diff --git a/elasticsearch-api/utils/thor/templates/_body.erb b/elasticsearch-api/utils/thor/templates/_body.erb index 6e8072b6be..458bebeae1 100644 --- a/elasticsearch-api/utils/thor/templates/_body.erb +++ b/elasticsearch-api/utils/thor/templates/_body.erb @@ -28,7 +28,7 @@ when 'mtermvectors' <%- when 'cluster.reroute', 'cluster.put_settings' %> body = arguments.delete(:body) || {} <%- when 'ml.find_file_structure' %> - body = Utils.__bulkify(arguments.delete(:body)) + body = Utils.bulkify(arguments.delete(:body)) <%- else -%> body = <%= @spec.body.nil? ? 'nil' : 'arguments.delete(:body)' %> <%- end -%> diff --git a/elasticsearch/elasticsearch.gemspec b/elasticsearch/elasticsearch.gemspec index c9159c6be4..b8ebddda45 100644 --- a/elasticsearch/elasticsearch.gemspec +++ b/elasticsearch/elasticsearch.gemspec @@ -46,7 +46,7 @@ Gem::Specification.new do |s| s.rdoc_options = ['--charset=UTF-8'] s.required_ruby_version = '>= 2.6' # For compatibility with JRuby 9.3 - s.add_dependency 'elasticsearch-api', '9.0.0' + s.add_dependency 'elasticsearch-api', '9.0.5' s.add_dependency 'elastic-transport', '~> 8.3' s.add_development_dependency 'base64' diff --git a/elasticsearch/lib/elasticsearch.rb b/elasticsearch/lib/elasticsearch.rb index 77b2ba0ffc..fc54bae1c8 100644 --- a/elasticsearch/lib/elasticsearch.rb +++ b/elasticsearch/lib/elasticsearch.rb @@ -52,6 +52,7 @@ def initialize(arguments = {}, &block) api_key(arguments) if arguments[:api_key] setup_cloud(arguments) if arguments[:cloud_id] set_user_agent!(arguments) unless sent_user_agent?(arguments) + set_content_type!(arguments) @transport = Elastic::Transport::Client.new(arguments, &block) end @@ -175,9 +176,25 @@ def set_user_agent!(arguments) if RbConfig::CONFIG && RbConfig::CONFIG['host_os'] user_agent << "#{RbConfig::CONFIG['host_os'].split('_').first[/[a-z]+/i].downcase} #{RbConfig::CONFIG['target_cpu']}" end + set_header({ user_agent: user_agent.join('; ') }, arguments) + end + + def set_content_type!(arguments) + headers = {} + user_headers = arguments&.[](:transport_options)&.[](:headers) + unless user_headers&.keys&.detect { |h| h =~ /content-?_?type/ } + headers['content-type'] = 'application/vnd.elasticsearch+json; compatible-with=9' + end + unless user_headers&.keys&.detect { |h| h =~ /accept/ } + headers['accept'] = 'application/vnd.elasticsearch+json; compatible-with=9' + end + set_header(headers, arguments) unless headers.empty? + end + + def set_header(header, arguments) arguments[:transport_options] ||= {} arguments[:transport_options][:headers] ||= {} - arguments[:transport_options][:headers].merge!({ user_agent: user_agent.join('; ') }) + arguments[:transport_options][:headers].merge!(header) end end diff --git a/elasticsearch/lib/elasticsearch/version.rb b/elasticsearch/lib/elasticsearch/version.rb index 33758a0941..177e3239a8 100644 --- a/elasticsearch/lib/elasticsearch/version.rb +++ b/elasticsearch/lib/elasticsearch/version.rb @@ -16,5 +16,5 @@ # under the License. module Elasticsearch - VERSION = '9.0.0'.freeze + VERSION = '9.0.5'.freeze end diff --git a/elasticsearch/spec/unit/headers_spec.rb b/elasticsearch/spec/unit/headers_spec.rb index 48a072b2fc..3751c74488 100644 --- a/elasticsearch/spec/unit/headers_spec.rb +++ b/elasticsearch/spec/unit/headers_spec.rb @@ -52,4 +52,73 @@ client.search(headers: param_headers) end end + + context 'when accept header is changed' do + let!(:client) do + described_class.new( + host: 'http://localhost:9200/', + transport_options: { headers: instance_headers } + ).tap do |client| + client.instance_variable_set('@verified', true) + end + end + let(:instance_headers) do + { accept: 'application/json' } + end + + it 'performs the request with the header' do + connection_headers = client.transport.connections.connections.first.connection.headers + expect(connection_headers['Accept']).to eq 'application/json' + expect(connection_headers['Content-Type']).to eq 'application/vnd.elasticsearch+json; compatible-with=9' + + expect_any_instance_of(Faraday::Connection) + .to receive(:run_request) + .with(:get, 'http://localhost:9200/_search', nil, connection_headers) { OpenStruct.new(body: '') } + client.search + end + end + + context 'when content-type header is changed' do + let!(:client) do + described_class.new( + host: 'http://localhost:9200/', + transport_options: { headers: instance_headers } + ).tap do |client| + client.instance_variable_set('@verified', true) + end + end + let(:instance_headers) do + { content_type: 'application/json' } + end + + it 'performs the request with the header' do + connection_headers = client.transport.connections.connections.first.connection.headers + expect(connection_headers['Accept']).to eq 'application/vnd.elasticsearch+json; compatible-with=9' + expect(connection_headers['Content-Type']).to eq 'application/json' + + expect_any_instance_of(Faraday::Connection) + .to receive(:run_request) + .with(:get, 'http://localhost:9200/_search', nil, connection_headers) { OpenStruct.new(body: '') } + client.search + end + end + + context 'when no header is set, uses v9 content-type and accept' do + let!(:client) do + described_class.new(host: 'http://localhost:9200/').tap do |client| + client.instance_variable_set('@verified', true) + end + end + + it 'performs the request with the header' do + expected_headers = client.transport.connections.connections.first.connection.headers + expect(expected_headers['Accept']).to eq 'application/vnd.elasticsearch+json; compatible-with=9' + expect(expected_headers['Content-Type']).to eq 'application/vnd.elasticsearch+json; compatible-with=9' + + expect_any_instance_of(Faraday::Connection) + .to receive(:run_request) + .with(:get, 'http://localhost:9200/_search', nil, expected_headers) { OpenStruct.new(body: '') } + client.search + end + end end diff --git a/rake_tasks/automation.rake b/rake_tasks/automation.rake index 1f7dfe77f9..8076005a60 100644 --- a/rake_tasks/automation.rake +++ b/rake_tasks/automation.rake @@ -38,12 +38,19 @@ namespace :automation do desc 'Generate API code' task :codegen do - version = YAML.load_file(File.expand_path("#{__dir__}/../.buildkite/pipeline.yml"))['steps'].first['env']['STACK_VERSION'] + path = File.expand_path('../elasticsearch-api/', __dir__) + branch = YAML.load_file(File.expand_path("#{__dir__}/../.buildkite/pipeline.yml"))['steps'].first['env']['ES_YAML_TESTS_BRANCH'] + unless File.exist?(File.expand_path('elastic-client-generator-ruby', __dir__)) + sh "git clone https://#{ENV['CLIENTS_GITHUB_TOKEN']}@github.com/elastic/elastic-client-generator-ruby.git " + end - Rake::Task['es:download_artifacts'].invoke(version) - sh "cd #{CURRENT_PATH.join('elasticsearch-api/utils')} \ - && BUNDLE_GEMFILE=`pwd`/Gemfile \ - && bundle exec thor code:generate" + sh "export ES_RUBY_CLIENT_PATH=#{path} " \ + ' && cd elastic-client-generator-ruby/elasticsearch ' \ + ' && sudo bundle install ' \ + " && bundle exec rake update[#{branch}]" \ + ' && bundle exec rake gen_es' \ + ' && cd ../../ ' \ + ' && rm -rf elastic-client-generator-ruby ' end desc <<-DESC @@ -107,11 +114,16 @@ namespace :automation do if file == '.buildkite/pipeline.yml' require 'yaml' yaml = YAML.safe_load(content) - branch = version.match(/([0-9]+\.[0-9]+)\.[0-9]+.*/)[1] yaml_tests_branch = yaml['steps'][0]['env']['ES_YAML_TESTS_BRANCH'] - next if yaml_tests_branch == 'main' - content.gsub!(yaml_tests_branch, branch) + if yaml_tests_branch == 'main' + old = content.match(/STACK_VERSION: (.*)/)[1] + new = "STACK_VERSION: #{version}" + content.gsub!(new, old) + else + branch = version.match(/([0-9]+\.[0-9]+)\.[0-9]+.*/)[1] + content.gsub!(yaml_tests_branch, branch) + end puts "[#{yaml_tests_branch}] -> [#{branch}] in #{file.gsub('./', '')}" end match = content.match(regexp) diff --git a/rake_tasks/elasticsearch_tasks.rake b/rake_tasks/elasticsearch_tasks.rake index 9d7deb50a5..316cbb71ae 100644 --- a/rake_tasks/elasticsearch_tasks.rake +++ b/rake_tasks/elasticsearch_tasks.rake @@ -73,7 +73,8 @@ namespace :es do abort e.message end - desc 'Download artifacts (tests and REST spec) for currently running cluster' + # Deprecated + desc 'Download Elasticsearch artifacts (tests and REST spec) for currently running cluster' task :download_artifacts, :version do |_, args| json_filename = CURRENT_PATH.join('tmp/artifacts.json')