elasticsearch-api 9.0.2 → 9.0.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/elasticsearch/api/actions/async_search/delete.rb +13 -2
- data/lib/elasticsearch/api/actions/async_search/get.rb +12 -1
- data/lib/elasticsearch/api/actions/async_search/status.rb +12 -1
- data/lib/elasticsearch/api/actions/async_search/submit.rb +16 -5
- data/lib/elasticsearch/api/actions/bulk.rb +85 -62
- data/lib/elasticsearch/api/actions/cat/aliases.rb +19 -8
- data/lib/elasticsearch/api/actions/cat/allocation.rb +18 -7
- data/lib/elasticsearch/api/actions/cat/component_templates.rb +18 -7
- data/lib/elasticsearch/api/actions/cat/count.rb +18 -7
- data/lib/elasticsearch/api/actions/cat/fielddata.rb +16 -5
- data/lib/elasticsearch/api/actions/cat/health.rb +19 -8
- data/lib/elasticsearch/api/actions/cat/indices.rb +17 -6
- data/lib/elasticsearch/api/actions/cat/master.rb +18 -7
- data/lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb +15 -4
- data/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb +18 -7
- data/lib/elasticsearch/api/actions/cat/ml_jobs.rb +19 -8
- data/lib/elasticsearch/api/actions/cat/ml_trained_models.rb +17 -6
- data/lib/elasticsearch/api/actions/cat/nodeattrs.rb +18 -7
- data/lib/elasticsearch/api/actions/cat/nodes.rb +22 -10
- data/lib/elasticsearch/api/actions/cat/pending_tasks.rb +18 -7
- data/lib/elasticsearch/api/actions/cat/plugins.rb +18 -7
- data/lib/elasticsearch/api/actions/cat/recovery.rb +23 -11
- data/lib/elasticsearch/api/actions/cat/repositories.rb +18 -7
- data/lib/elasticsearch/api/actions/cat/segments.rb +23 -11
- data/lib/elasticsearch/api/actions/cat/shards.rb +21 -10
- data/lib/elasticsearch/api/actions/cat/snapshots.rb +20 -8
- data/lib/elasticsearch/api/actions/cat/tasks.rb +18 -7
- data/lib/elasticsearch/api/actions/cat/templates.rb +18 -7
- data/lib/elasticsearch/api/actions/cat/thread_pool.rb +20 -9
- data/lib/elasticsearch/api/actions/cat/transforms.rb +17 -6
- data/lib/elasticsearch/api/actions/clear_scroll.rb +12 -1
- data/lib/elasticsearch/api/actions/close_point_in_time.rb +14 -3
- data/lib/elasticsearch/api/actions/cluster/allocation_explain.rb +12 -0
- data/lib/elasticsearch/api/actions/cluster/delete_component_template.rb +11 -0
- data/lib/elasticsearch/api/actions/cluster/delete_voting_config_exclusions.rb +11 -0
- data/lib/elasticsearch/api/actions/cluster/exists_component_template.rb +11 -0
- data/lib/elasticsearch/api/actions/cluster/get_component_template.rb +16 -4
- data/lib/elasticsearch/api/actions/cluster/get_settings.rb +13 -2
- data/lib/elasticsearch/api/actions/cluster/health.rb +12 -1
- data/lib/elasticsearch/api/actions/cluster/info.rb +12 -1
- data/lib/elasticsearch/api/actions/cluster/pending_tasks.rb +13 -2
- data/lib/elasticsearch/api/actions/cluster/post_voting_config_exclusions.rb +15 -4
- data/lib/elasticsearch/api/actions/cluster/put_component_template.rb +19 -7
- data/lib/elasticsearch/api/actions/cluster/put_settings.rb +16 -5
- data/lib/elasticsearch/api/actions/cluster/remote_info.rb +12 -1
- data/lib/elasticsearch/api/actions/cluster/reroute.rb +15 -4
- data/lib/elasticsearch/api/actions/cluster/state.rb +14 -3
- data/lib/elasticsearch/api/actions/cluster/stats.rb +12 -1
- data/lib/elasticsearch/api/actions/connector/check_in.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/delete.rb +11 -0
- data/lib/elasticsearch/api/actions/connector/get.rb +11 -0
- data/lib/elasticsearch/api/actions/connector/list.rb +11 -0
- data/lib/elasticsearch/api/actions/connector/post.rb +12 -1
- data/lib/elasticsearch/api/actions/connector/put.rb +12 -1
- data/lib/elasticsearch/api/actions/connector/sync_job_cancel.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/sync_job_check_in.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/sync_job_claim.rb +14 -3
- data/lib/elasticsearch/api/actions/connector/sync_job_delete.rb +12 -1
- data/lib/elasticsearch/api/actions/connector/sync_job_error.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/sync_job_get.rb +12 -1
- data/lib/elasticsearch/api/actions/connector/sync_job_list.rb +12 -1
- data/lib/elasticsearch/api/actions/connector/sync_job_post.rb +12 -1
- data/lib/elasticsearch/api/actions/connector/sync_job_update_stats.rb +14 -3
- data/lib/elasticsearch/api/actions/connector/update_active_filtering.rb +12 -1
- data/lib/elasticsearch/api/actions/connector/update_api_key_id.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/update_configuration.rb +12 -1
- data/lib/elasticsearch/api/actions/connector/update_error.rb +12 -1
- data/lib/elasticsearch/api/actions/connector/update_features.rb +12 -1
- data/lib/elasticsearch/api/actions/connector/update_filtering.rb +12 -1
- data/lib/elasticsearch/api/actions/connector/update_filtering_validation.rb +12 -1
- data/lib/elasticsearch/api/actions/connector/update_index_name.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/update_name.rb +12 -1
- data/lib/elasticsearch/api/actions/connector/update_native.rb +12 -1
- data/lib/elasticsearch/api/actions/connector/update_pipeline.rb +12 -1
- data/lib/elasticsearch/api/actions/connector/update_scheduling.rb +12 -1
- data/lib/elasticsearch/api/actions/connector/update_service_type.rb +12 -1
- data/lib/elasticsearch/api/actions/connector/update_status.rb +12 -1
- data/lib/elasticsearch/api/actions/count.rb +28 -17
- data/lib/elasticsearch/api/actions/create.rb +43 -40
- data/lib/elasticsearch/api/actions/cross_cluster_replication/delete_auto_follow_pattern.rb +12 -1
- data/lib/elasticsearch/api/actions/cross_cluster_replication/follow.rb +11 -0
- data/lib/elasticsearch/api/actions/cross_cluster_replication/follow_info.rb +12 -1
- data/lib/elasticsearch/api/actions/cross_cluster_replication/follow_stats.rb +11 -0
- data/lib/elasticsearch/api/actions/cross_cluster_replication/forget_follower.rb +11 -0
- data/lib/elasticsearch/api/actions/cross_cluster_replication/get_auto_follow_pattern.rb +12 -1
- data/lib/elasticsearch/api/actions/cross_cluster_replication/pause_auto_follow_pattern.rb +12 -1
- data/lib/elasticsearch/api/actions/cross_cluster_replication/pause_follow.rb +12 -1
- data/lib/elasticsearch/api/actions/cross_cluster_replication/put_auto_follow_pattern.rb +11 -0
- data/lib/elasticsearch/api/actions/cross_cluster_replication/resume_auto_follow_pattern.rb +12 -1
- data/lib/elasticsearch/api/actions/cross_cluster_replication/resume_follow.rb +11 -0
- data/lib/elasticsearch/api/actions/cross_cluster_replication/stats.rb +12 -1
- data/lib/elasticsearch/api/actions/cross_cluster_replication/unfollow.rb +12 -1
- data/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb +12 -1
- data/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb +12 -1
- data/lib/elasticsearch/api/actions/dangling_indices/list_dangling_indices.rb +13 -2
- data/lib/elasticsearch/api/actions/delete.rb +24 -11
- data/lib/elasticsearch/api/actions/delete_by_query.rb +62 -47
- data/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb +12 -1
- data/lib/elasticsearch/api/actions/delete_script.rb +13 -2
- data/lib/elasticsearch/api/actions/enrich/delete_policy.rb +11 -0
- data/lib/elasticsearch/api/actions/enrich/execute_policy.rb +12 -1
- data/lib/elasticsearch/api/actions/enrich/get_policy.rb +11 -0
- data/lib/elasticsearch/api/actions/enrich/put_policy.rb +11 -0
- data/lib/elasticsearch/api/actions/enrich/stats.rb +11 -0
- data/lib/elasticsearch/api/actions/eql/delete.rb +13 -2
- data/lib/elasticsearch/api/actions/eql/get.rb +11 -0
- data/lib/elasticsearch/api/actions/eql/get_status.rb +12 -1
- data/lib/elasticsearch/api/actions/eql/search.rb +14 -2
- data/lib/elasticsearch/api/actions/esql/async_query.rb +14 -13
- data/lib/elasticsearch/api/actions/esql/async_query_delete.rb +14 -3
- data/lib/elasticsearch/api/actions/esql/async_query_get.rb +16 -4
- data/lib/elasticsearch/api/actions/esql/async_query_stop.rb +14 -3
- data/lib/elasticsearch/api/actions/esql/query.rb +13 -2
- data/lib/elasticsearch/api/actions/exists.rb +30 -17
- data/lib/elasticsearch/api/actions/exists_source.rb +20 -7
- data/lib/elasticsearch/api/actions/explain.rb +24 -13
- data/lib/elasticsearch/api/actions/features/get_features.rb +12 -1
- data/lib/elasticsearch/api/actions/features/reset_features.rb +11 -0
- data/lib/elasticsearch/api/actions/field_caps.rb +17 -6
- data/lib/elasticsearch/api/actions/fleet/global_checkpoints.rb +16 -5
- data/lib/elasticsearch/api/actions/fleet/msearch.rb +14 -3
- data/lib/elasticsearch/api/actions/fleet/search.rb +14 -3
- data/lib/elasticsearch/api/actions/get.rb +47 -28
- data/lib/elasticsearch/api/actions/get_script.rb +12 -1
- data/lib/elasticsearch/api/actions/get_script_context.rb +12 -1
- data/lib/elasticsearch/api/actions/get_script_languages.rb +12 -1
- data/lib/elasticsearch/api/actions/get_source.rb +23 -10
- data/lib/elasticsearch/api/actions/graph/explore.rb +12 -1
- data/lib/elasticsearch/api/actions/health_report.rb +12 -1
- data/lib/elasticsearch/api/actions/index.rb +54 -42
- data/lib/elasticsearch/api/actions/index_lifecycle_management/delete_lifecycle.rb +11 -0
- data/lib/elasticsearch/api/actions/index_lifecycle_management/explain_lifecycle.rb +13 -2
- data/lib/elasticsearch/api/actions/index_lifecycle_management/get_lifecycle.rb +11 -0
- data/lib/elasticsearch/api/actions/index_lifecycle_management/get_status.rb +12 -1
- data/lib/elasticsearch/api/actions/index_lifecycle_management/migrate_to_data_tiers.rb +13 -2
- data/lib/elasticsearch/api/actions/index_lifecycle_management/move_to_step.rb +13 -2
- data/lib/elasticsearch/api/actions/index_lifecycle_management/put_lifecycle.rb +11 -0
- data/lib/elasticsearch/api/actions/index_lifecycle_management/remove_policy.rb +12 -1
- data/lib/elasticsearch/api/actions/index_lifecycle_management/retry.rb +12 -1
- data/lib/elasticsearch/api/actions/index_lifecycle_management/start.rb +11 -0
- data/lib/elasticsearch/api/actions/index_lifecycle_management/stop.rb +11 -0
- data/lib/elasticsearch/api/actions/indices/add_block.rb +19 -8
- data/lib/elasticsearch/api/actions/indices/analyze.rb +14 -3
- data/lib/elasticsearch/api/actions/indices/cancel_migrate_reindex.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/clear_cache.rb +23 -13
- data/lib/elasticsearch/api/actions/indices/clone.rb +16 -5
- data/lib/elasticsearch/api/actions/indices/close.rb +18 -8
- data/lib/elasticsearch/api/actions/indices/create.rb +27 -8
- data/lib/elasticsearch/api/actions/indices/create_data_stream.rb +14 -3
- data/lib/elasticsearch/api/actions/indices/create_from.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/data_streams_stats.rb +14 -3
- data/lib/elasticsearch/api/actions/indices/delete.rb +16 -6
- data/lib/elasticsearch/api/actions/indices/delete_alias.rb +13 -2
- data/lib/elasticsearch/api/actions/indices/delete_data_lifecycle.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/delete_data_stream.rb +13 -2
- data/lib/elasticsearch/api/actions/indices/delete_index_template.rb +11 -0
- data/lib/elasticsearch/api/actions/indices/delete_template.rb +13 -1
- data/lib/elasticsearch/api/actions/indices/disk_usage.rb +20 -9
- data/lib/elasticsearch/api/actions/indices/downsample.rb +14 -3
- data/lib/elasticsearch/api/actions/indices/exists.rb +18 -8
- data/lib/elasticsearch/api/actions/indices/exists_alias.rb +17 -7
- data/lib/elasticsearch/api/actions/indices/exists_index_template.rb +11 -0
- data/lib/elasticsearch/api/actions/indices/exists_template.rb +13 -2
- data/lib/elasticsearch/api/actions/indices/explain_data_lifecycle.rb +11 -0
- data/lib/elasticsearch/api/actions/indices/field_usage_stats.rb +15 -4
- data/lib/elasticsearch/api/actions/indices/flush.rb +19 -9
- data/lib/elasticsearch/api/actions/indices/forcemerge.rb +22 -10
- data/lib/elasticsearch/api/actions/indices/get.rb +11 -0
- data/lib/elasticsearch/api/actions/indices/get_alias.rb +18 -8
- data/lib/elasticsearch/api/actions/indices/get_data_lifecycle.rb +15 -5
- data/lib/elasticsearch/api/actions/indices/get_data_lifecycle_stats.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/get_data_stream.rb +13 -2
- data/lib/elasticsearch/api/actions/indices/get_field_mapping.rb +19 -9
- data/lib/elasticsearch/api/actions/indices/get_index_template.rb +11 -0
- data/lib/elasticsearch/api/actions/indices/get_mapping.rb +17 -7
- data/lib/elasticsearch/api/actions/indices/get_migrate_reindex_status.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/get_settings.rb +23 -12
- data/lib/elasticsearch/api/actions/indices/get_template.rb +16 -5
- data/lib/elasticsearch/api/actions/indices/migrate_reindex.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/migrate_to_data_stream.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/modify_data_stream.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/open.rb +22 -12
- data/lib/elasticsearch/api/actions/indices/promote_data_stream.rb +11 -0
- data/lib/elasticsearch/api/actions/indices/put_alias.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/put_data_lifecycle.rb +14 -4
- data/lib/elasticsearch/api/actions/indices/put_index_template.rb +16 -5
- data/lib/elasticsearch/api/actions/indices/put_mapping.rb +25 -24
- data/lib/elasticsearch/api/actions/indices/put_settings.rb +65 -13
- data/lib/elasticsearch/api/actions/indices/put_template.rb +13 -2
- data/lib/elasticsearch/api/actions/indices/recovery.rb +21 -4
- data/lib/elasticsearch/api/actions/indices/refresh.rb +18 -8
- data/lib/elasticsearch/api/actions/indices/reload_search_analyzers.rb +14 -3
- data/lib/elasticsearch/api/actions/indices/resolve_cluster.rb +34 -24
- data/lib/elasticsearch/api/actions/indices/resolve_index.rb +16 -6
- data/lib/elasticsearch/api/actions/indices/rollover.rb +21 -10
- data/lib/elasticsearch/api/actions/indices/segments.rb +16 -6
- data/lib/elasticsearch/api/actions/indices/shard_stores.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/shrink.rb +13 -2
- data/lib/elasticsearch/api/actions/indices/simulate_index_template.rb +11 -0
- data/lib/elasticsearch/api/actions/indices/simulate_template.rb +11 -0
- data/lib/elasticsearch/api/actions/indices/split.rb +18 -5
- data/lib/elasticsearch/api/actions/indices/stats.rb +18 -7
- data/lib/elasticsearch/api/actions/indices/update_aliases.rb +11 -0
- data/lib/elasticsearch/api/actions/indices/validate_query.rb +24 -14
- data/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb +17 -0
- data/lib/elasticsearch/api/actions/inference/completion.rb +11 -0
- data/lib/elasticsearch/api/actions/inference/delete.rb +11 -0
- data/lib/elasticsearch/api/actions/inference/get.rb +12 -1
- data/lib/elasticsearch/api/actions/inference/inference.rb +11 -0
- data/lib/elasticsearch/api/actions/inference/put.rb +31 -7
- data/lib/elasticsearch/api/actions/inference/put_alibabacloud.rb +14 -7
- data/lib/elasticsearch/api/actions/inference/put_amazonbedrock.rb +14 -2
- data/lib/elasticsearch/api/actions/inference/put_anthropic.rb +15 -8
- data/lib/elasticsearch/api/actions/inference/put_azureaistudio.rb +14 -7
- data/lib/elasticsearch/api/actions/inference/put_azureopenai.rb +15 -8
- data/lib/elasticsearch/api/actions/inference/put_cohere.rb +14 -7
- data/lib/elasticsearch/api/actions/inference/put_custom.rb +112 -0
- data/lib/elasticsearch/api/actions/inference/put_elasticsearch.rb +15 -3
- data/lib/elasticsearch/api/actions/inference/put_elser.rb +14 -2
- data/lib/elasticsearch/api/actions/inference/put_googleaistudio.rb +14 -7
- data/lib/elasticsearch/api/actions/inference/put_googlevertexai.rb +14 -7
- data/lib/elasticsearch/api/actions/inference/put_hugging_face.rb +22 -15
- data/lib/elasticsearch/api/actions/inference/put_jinaai.rb +16 -9
- data/lib/elasticsearch/api/actions/inference/put_mistral.rb +15 -8
- data/lib/elasticsearch/api/actions/inference/put_openai.rb +15 -8
- data/lib/elasticsearch/api/actions/inference/put_voyageai.rb +14 -2
- data/lib/elasticsearch/api/actions/inference/put_watsonx.rb +16 -9
- data/lib/elasticsearch/api/actions/inference/rerank.rb +12 -1
- data/lib/elasticsearch/api/actions/inference/sparse_embedding.rb +11 -0
- data/lib/elasticsearch/api/actions/inference/stream_completion.rb +14 -2
- data/lib/elasticsearch/api/actions/inference/text_embedding.rb +11 -0
- data/lib/elasticsearch/api/actions/inference/update.rb +13 -2
- data/lib/elasticsearch/api/actions/info.rb +13 -1
- data/lib/elasticsearch/api/actions/ingest/delete_geoip_database.rb +11 -0
- data/lib/elasticsearch/api/actions/ingest/delete_ip_location_database.rb +13 -2
- data/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb +12 -1
- data/lib/elasticsearch/api/actions/ingest/geo_ip_stats.rb +12 -1
- data/lib/elasticsearch/api/actions/ingest/get_geoip_database.rb +14 -3
- data/lib/elasticsearch/api/actions/ingest/get_ip_location_database.rb +13 -5
- data/lib/elasticsearch/api/actions/ingest/get_pipeline.rb +13 -2
- data/lib/elasticsearch/api/actions/ingest/processor_grok.rb +12 -1
- data/lib/elasticsearch/api/actions/ingest/put_geoip_database.rb +11 -0
- data/lib/elasticsearch/api/actions/ingest/put_ip_location_database.rb +13 -2
- data/lib/elasticsearch/api/actions/ingest/put_pipeline.rb +11 -0
- data/lib/elasticsearch/api/actions/ingest/simulate.rb +13 -2
- data/lib/elasticsearch/api/actions/license/delete.rb +11 -0
- data/lib/elasticsearch/api/actions/license/get.rb +13 -2
- data/lib/elasticsearch/api/actions/license/get_basic_status.rb +12 -1
- data/lib/elasticsearch/api/actions/license/get_trial_status.rb +12 -1
- data/lib/elasticsearch/api/actions/license/post.rb +11 -0
- data/lib/elasticsearch/api/actions/license/post_start_basic.rb +12 -1
- data/lib/elasticsearch/api/actions/license/post_start_trial.rb +12 -1
- data/lib/elasticsearch/api/actions/logstash/delete_pipeline.rb +12 -1
- data/lib/elasticsearch/api/actions/logstash/get_pipeline.rb +12 -1
- data/lib/elasticsearch/api/actions/logstash/put_pipeline.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/clear_trained_model_deployment_cache.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/close_job.rb +15 -4
- data/lib/elasticsearch/api/actions/machine_learning/delete_calendar.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/delete_calendar_event.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/delete_calendar_job.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/delete_data_frame_analytics.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/delete_datafeed.rb +11 -0
- data/lib/elasticsearch/api/actions/machine_learning/delete_expired_data.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/delete_filter.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/delete_forecast.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/delete_job.rb +11 -0
- data/lib/elasticsearch/api/actions/machine_learning/delete_model_snapshot.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/delete_trained_model.rb +11 -0
- data/lib/elasticsearch/api/actions/machine_learning/delete_trained_model_alias.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/estimate_model_memory.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/evaluate_data_frame.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/explain_data_frame_analytics.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/flush_job.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/forecast.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/get_buckets.rb +15 -4
- data/lib/elasticsearch/api/actions/machine_learning/get_calendar_events.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/get_calendars.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/get_categories.rb +11 -0
- data/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics_stats.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/get_datafeed_stats.rb +19 -8
- data/lib/elasticsearch/api/actions/machine_learning/get_datafeeds.rb +17 -6
- data/lib/elasticsearch/api/actions/machine_learning/get_filters.rb +11 -0
- data/lib/elasticsearch/api/actions/machine_learning/get_influencers.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/get_job_stats.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/get_jobs.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/get_memory_stats.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/get_model_snapshot_upgrade_stats.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/get_model_snapshots.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/get_overall_buckets.rb +30 -19
- data/lib/elasticsearch/api/actions/machine_learning/get_records.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/get_trained_models.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/get_trained_models_stats.rb +11 -0
- data/lib/elasticsearch/api/actions/machine_learning/infer_trained_model.rb +11 -0
- data/lib/elasticsearch/api/actions/machine_learning/info.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/open_job.rb +11 -0
- data/lib/elasticsearch/api/actions/machine_learning/post_calendar_events.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/post_data.rb +11 -0
- data/lib/elasticsearch/api/actions/machine_learning/preview_data_frame_analytics.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/preview_datafeed.rb +11 -0
- data/lib/elasticsearch/api/actions/machine_learning/put_calendar.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/put_calendar_job.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/put_data_frame_analytics.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/put_datafeed.rb +16 -5
- data/lib/elasticsearch/api/actions/machine_learning/put_filter.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/put_job.rb +18 -12
- data/lib/elasticsearch/api/actions/machine_learning/put_trained_model.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/put_trained_model_alias.rb +11 -0
- data/lib/elasticsearch/api/actions/machine_learning/put_trained_model_definition_part.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/put_trained_model_vocabulary.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/reset_job.rb +11 -0
- data/lib/elasticsearch/api/actions/machine_learning/revert_model_snapshot.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/set_upgrade_mode.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/start_data_frame_analytics.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/start_datafeed.rb +18 -7
- data/lib/elasticsearch/api/actions/machine_learning/start_trained_model_deployment.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/stop_data_frame_analytics.rb +11 -0
- data/lib/elasticsearch/api/actions/machine_learning/stop_datafeed.rb +16 -5
- data/lib/elasticsearch/api/actions/machine_learning/stop_trained_model_deployment.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/update_data_frame_analytics.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/update_datafeed.rb +16 -10
- data/lib/elasticsearch/api/actions/machine_learning/update_filter.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/update_job.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/update_model_snapshot.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/update_trained_model_deployment.rb +11 -0
- data/lib/elasticsearch/api/actions/machine_learning/upgrade_job_snapshot.rb +11 -0
- data/lib/elasticsearch/api/actions/mget.rb +24 -13
- data/lib/elasticsearch/api/actions/migration/deprecations.rb +12 -1
- data/lib/elasticsearch/api/actions/migration/get_feature_upgrade_status.rb +12 -1
- data/lib/elasticsearch/api/actions/migration/post_feature_upgrade.rb +12 -1
- data/lib/elasticsearch/api/actions/msearch.rb +27 -10
- data/lib/elasticsearch/api/actions/msearch_template.rb +21 -9
- data/lib/elasticsearch/api/actions/mtermvectors.rb +20 -9
- data/lib/elasticsearch/api/actions/nodes/clear_repositories_metering_archive.rb +13 -2
- data/lib/elasticsearch/api/actions/nodes/get_repositories_metering_info.rb +12 -1
- data/lib/elasticsearch/api/actions/nodes/hot_threads.rb +11 -0
- data/lib/elasticsearch/api/actions/nodes/info.rb +11 -0
- data/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb +11 -0
- data/lib/elasticsearch/api/actions/nodes/stats.rb +12 -1
- data/lib/elasticsearch/api/actions/nodes/usage.rb +13 -2
- data/lib/elasticsearch/api/actions/open_point_in_time.rb +22 -11
- data/lib/elasticsearch/api/actions/ping.rb +12 -1
- data/lib/elasticsearch/api/actions/put_script.rb +13 -2
- data/lib/elasticsearch/api/actions/query_rules/delete_rule.rb +12 -1
- data/lib/elasticsearch/api/actions/query_rules/delete_ruleset.rb +11 -0
- data/lib/elasticsearch/api/actions/query_rules/get_rule.rb +12 -1
- data/lib/elasticsearch/api/actions/query_rules/get_ruleset.rb +12 -1
- data/lib/elasticsearch/api/actions/query_rules/list_rulesets.rb +11 -0
- data/lib/elasticsearch/api/actions/query_rules/put_rule.rb +12 -1
- data/lib/elasticsearch/api/actions/query_rules/put_ruleset.rb +14 -3
- data/lib/elasticsearch/api/actions/query_rules/test.rb +12 -1
- data/lib/elasticsearch/api/actions/rank_eval.rb +15 -4
- data/lib/elasticsearch/api/actions/reindex.rb +34 -122
- data/lib/elasticsearch/api/actions/reindex_rethrottle.rb +16 -3
- data/lib/elasticsearch/api/actions/render_search_template.rb +13 -2
- data/lib/elasticsearch/api/actions/scripts_painless_execute.rb +12 -1
- data/lib/elasticsearch/api/actions/scroll.rb +15 -4
- data/lib/elasticsearch/api/actions/search.rb +70 -59
- data/lib/elasticsearch/api/actions/search_application/delete.rb +12 -1
- data/lib/elasticsearch/api/actions/search_application/delete_behavioral_analytics.rb +12 -1
- data/lib/elasticsearch/api/actions/search_application/get.rb +12 -1
- data/lib/elasticsearch/api/actions/search_application/get_behavioral_analytics.rb +12 -1
- data/lib/elasticsearch/api/actions/search_application/list.rb +11 -0
- data/lib/elasticsearch/api/actions/search_application/post_behavioral_analytics_event.rb +11 -0
- data/lib/elasticsearch/api/actions/search_application/put.rb +12 -1
- data/lib/elasticsearch/api/actions/search_application/put_behavioral_analytics.rb +12 -1
- data/lib/elasticsearch/api/actions/search_application/render_query.rb +14 -3
- data/lib/elasticsearch/api/actions/search_application/search.rb +11 -0
- data/lib/elasticsearch/api/actions/search_mvt.rb +38 -69
- data/lib/elasticsearch/api/actions/search_shards.rb +21 -11
- data/lib/elasticsearch/api/actions/search_template.rb +23 -13
- data/lib/elasticsearch/api/actions/searchable_snapshots/cache_stats.rb +11 -0
- data/lib/elasticsearch/api/actions/searchable_snapshots/clear_cache.rb +13 -2
- data/lib/elasticsearch/api/actions/searchable_snapshots/mount.rb +12 -1
- data/lib/elasticsearch/api/actions/searchable_snapshots/stats.rb +11 -0
- data/lib/elasticsearch/api/actions/security/activate_user_profile.rb +16 -5
- data/lib/elasticsearch/api/actions/security/authenticate.rb +12 -1
- data/lib/elasticsearch/api/actions/security/bulk_delete_role.rb +12 -1
- data/lib/elasticsearch/api/actions/security/bulk_put_role.rb +12 -1
- data/lib/elasticsearch/api/actions/security/bulk_update_api_keys.rb +14 -3
- data/lib/elasticsearch/api/actions/security/change_password.rb +12 -1
- data/lib/elasticsearch/api/actions/security/clear_api_key_cache.rb +13 -2
- data/lib/elasticsearch/api/actions/security/clear_cached_privileges.rb +13 -2
- data/lib/elasticsearch/api/actions/security/clear_cached_realms.rb +12 -1
- data/lib/elasticsearch/api/actions/security/clear_cached_roles.rb +13 -2
- data/lib/elasticsearch/api/actions/security/clear_cached_service_tokens.rb +16 -5
- data/lib/elasticsearch/api/actions/security/create_api_key.rb +12 -1
- data/lib/elasticsearch/api/actions/security/create_cross_cluster_api_key.rb +15 -4
- data/lib/elasticsearch/api/actions/security/create_service_token.rb +14 -3
- data/lib/elasticsearch/api/actions/security/delegate_pki.rb +14 -3
- data/lib/elasticsearch/api/actions/security/delete_privileges.rb +13 -2
- data/lib/elasticsearch/api/actions/security/delete_role.rb +12 -1
- data/lib/elasticsearch/api/actions/security/delete_role_mapping.rb +12 -1
- data/lib/elasticsearch/api/actions/security/delete_service_token.rb +12 -1
- data/lib/elasticsearch/api/actions/security/delete_user.rb +12 -1
- data/lib/elasticsearch/api/actions/security/disable_user.rb +12 -1
- data/lib/elasticsearch/api/actions/security/disable_user_profile.rb +11 -0
- data/lib/elasticsearch/api/actions/security/enable_user.rb +12 -1
- data/lib/elasticsearch/api/actions/security/enable_user_profile.rb +11 -0
- data/lib/elasticsearch/api/actions/security/enroll_kibana.rb +12 -1
- data/lib/elasticsearch/api/actions/security/enroll_node.rb +12 -1
- data/lib/elasticsearch/api/actions/security/get_api_key.rb +19 -8
- data/lib/elasticsearch/api/actions/security/get_builtin_privileges.rb +12 -1
- data/lib/elasticsearch/api/actions/security/get_privileges.rb +13 -2
- data/lib/elasticsearch/api/actions/security/get_role.rb +11 -0
- data/lib/elasticsearch/api/actions/security/get_role_mapping.rb +12 -1
- data/lib/elasticsearch/api/actions/security/get_service_accounts.rb +15 -4
- data/lib/elasticsearch/api/actions/security/get_service_credentials.rb +14 -3
- data/lib/elasticsearch/api/actions/security/get_settings.rb +14 -3
- data/lib/elasticsearch/api/actions/security/get_token.rb +14 -3
- data/lib/elasticsearch/api/actions/security/get_user.rb +12 -1
- data/lib/elasticsearch/api/actions/security/get_user_privileges.rb +11 -3
- data/lib/elasticsearch/api/actions/security/get_user_profile.rb +16 -5
- data/lib/elasticsearch/api/actions/security/grant_api_key.rb +16 -1
- data/lib/elasticsearch/api/actions/security/has_privileges.rb +12 -1
- data/lib/elasticsearch/api/actions/security/has_privileges_user_profile.rb +12 -1
- data/lib/elasticsearch/api/actions/security/invalidate_api_key.rb +20 -9
- data/lib/elasticsearch/api/actions/security/invalidate_token.rb +15 -4
- data/lib/elasticsearch/api/actions/security/oidc_authenticate.rb +12 -1
- data/lib/elasticsearch/api/actions/security/oidc_logout.rb +13 -2
- data/lib/elasticsearch/api/actions/security/oidc_prepare_authentication.rb +12 -1
- data/lib/elasticsearch/api/actions/security/put_privileges.rb +17 -6
- data/lib/elasticsearch/api/actions/security/put_role.rb +12 -1
- data/lib/elasticsearch/api/actions/security/put_role_mapping.rb +15 -4
- data/lib/elasticsearch/api/actions/security/put_user.rb +12 -1
- data/lib/elasticsearch/api/actions/security/query_api_keys.rb +17 -5
- data/lib/elasticsearch/api/actions/security/query_role.rb +12 -1
- data/lib/elasticsearch/api/actions/security/query_user.rb +11 -0
- data/lib/elasticsearch/api/actions/security/saml_authenticate.rb +13 -2
- data/lib/elasticsearch/api/actions/security/saml_complete_logout.rb +12 -1
- data/lib/elasticsearch/api/actions/security/saml_invalidate.rb +13 -2
- data/lib/elasticsearch/api/actions/security/saml_logout.rb +12 -1
- data/lib/elasticsearch/api/actions/security/saml_prepare_authentication.rb +15 -4
- data/lib/elasticsearch/api/actions/security/saml_service_provider_metadata.rb +12 -1
- data/lib/elasticsearch/api/actions/security/suggest_user_profiles.rb +16 -5
- data/lib/elasticsearch/api/actions/security/update_api_key.rb +16 -5
- data/lib/elasticsearch/api/actions/security/update_cross_cluster_api_key.rb +16 -4
- data/lib/elasticsearch/api/actions/security/update_settings.rb +13 -2
- data/lib/elasticsearch/api/actions/security/update_user_profile_data.rb +15 -4
- data/lib/elasticsearch/api/actions/simulate/ingest.rb +11 -0
- data/lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb +13 -2
- data/lib/elasticsearch/api/actions/snapshot/clone.rb +12 -1
- data/lib/elasticsearch/api/actions/snapshot/create.rb +13 -2
- data/lib/elasticsearch/api/actions/snapshot/create_repository.rb +16 -5
- data/lib/elasticsearch/api/actions/snapshot/delete.rb +15 -2
- data/lib/elasticsearch/api/actions/snapshot/delete_repository.rb +14 -3
- data/lib/elasticsearch/api/actions/snapshot/get.rb +29 -18
- data/lib/elasticsearch/api/actions/snapshot/get_repository.rb +15 -4
- data/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb +20 -9
- data/lib/elasticsearch/api/actions/snapshot/restore.rb +18 -5
- data/lib/elasticsearch/api/actions/snapshot/status.rb +18 -7
- data/lib/elasticsearch/api/actions/snapshot/verify_repository.rb +13 -2
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/delete_lifecycle.rb +11 -0
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_lifecycle.rb +11 -0
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_retention.rb +11 -0
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_lifecycle.rb +11 -0
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_stats.rb +11 -0
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_status.rb +13 -2
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/put_lifecycle.rb +13 -2
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/start.rb +13 -2
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/stop.rb +13 -2
- data/lib/elasticsearch/api/actions/sql/clear_cursor.rb +12 -1
- data/lib/elasticsearch/api/actions/sql/delete_async.rb +13 -2
- data/lib/elasticsearch/api/actions/sql/get_async.rb +13 -2
- data/lib/elasticsearch/api/actions/sql/get_async_status.rb +12 -1
- data/lib/elasticsearch/api/actions/sql/query.rb +13 -2
- data/lib/elasticsearch/api/actions/sql/translate.rb +13 -2
- data/lib/elasticsearch/api/actions/ssl/certificates.rb +14 -3
- data/lib/elasticsearch/api/actions/synonyms/delete_synonym.rb +12 -1
- data/lib/elasticsearch/api/actions/synonyms/delete_synonym_rule.rb +12 -1
- data/lib/elasticsearch/api/actions/synonyms/get_synonym.rb +11 -0
- data/lib/elasticsearch/api/actions/synonyms/get_synonym_rule.rb +12 -1
- data/lib/elasticsearch/api/actions/synonyms/get_synonyms_sets.rb +11 -0
- data/lib/elasticsearch/api/actions/synonyms/put_synonym.rb +13 -1
- data/lib/elasticsearch/api/actions/synonyms/put_synonym_rule.rb +12 -1
- data/lib/elasticsearch/api/actions/tasks/cancel.rb +13 -2
- data/lib/elasticsearch/api/actions/tasks/get.rb +12 -1
- data/lib/elasticsearch/api/actions/tasks/list.rb +29 -14
- data/lib/elasticsearch/api/actions/terms_enum.rb +14 -3
- data/lib/elasticsearch/api/actions/termvectors.rb +27 -14
- data/lib/elasticsearch/api/actions/text_structure/find_field_structure.rb +52 -41
- data/lib/elasticsearch/api/actions/text_structure/find_message_structure.rb +52 -41
- data/lib/elasticsearch/api/actions/text_structure/find_structure.rb +44 -44
- data/lib/elasticsearch/api/actions/text_structure/test_grok_pattern.rb +12 -1
- data/lib/elasticsearch/api/actions/transform/delete_transform.rb +11 -0
- data/lib/elasticsearch/api/actions/transform/get_node_stats.rb +2 -7
- data/lib/elasticsearch/api/actions/transform/get_transform.rb +13 -2
- data/lib/elasticsearch/api/actions/transform/get_transform_stats.rb +13 -2
- data/lib/elasticsearch/api/actions/transform/preview_transform.rb +11 -0
- data/lib/elasticsearch/api/actions/transform/put_transform.rb +18 -7
- data/lib/elasticsearch/api/actions/transform/reset_transform.rb +13 -2
- data/lib/elasticsearch/api/actions/transform/schedule_now_transform.rb +12 -1
- data/lib/elasticsearch/api/actions/transform/start_transform.rb +14 -3
- data/lib/elasticsearch/api/actions/transform/stop_transform.rb +14 -3
- data/lib/elasticsearch/api/actions/transform/update_transform.rb +14 -3
- data/lib/elasticsearch/api/actions/transform/upgrade_transforms.rb +11 -0
- data/lib/elasticsearch/api/actions/update.rb +19 -7
- data/lib/elasticsearch/api/actions/update_by_query.rb +75 -55
- data/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb +12 -1
- data/lib/elasticsearch/api/actions/watcher/ack_watch.rb +15 -3
- data/lib/elasticsearch/api/actions/watcher/activate_watch.rb +12 -1
- data/lib/elasticsearch/api/actions/watcher/deactivate_watch.rb +12 -1
- data/lib/elasticsearch/api/actions/watcher/delete_watch.rb +14 -3
- data/lib/elasticsearch/api/actions/watcher/execute_watch.rb +13 -1
- data/lib/elasticsearch/api/actions/watcher/get_settings.rb +13 -2
- data/lib/elasticsearch/api/actions/watcher/get_watch.rb +12 -1
- data/lib/elasticsearch/api/actions/watcher/put_watch.rb +17 -6
- data/lib/elasticsearch/api/actions/watcher/query_watches.rb +13 -2
- data/lib/elasticsearch/api/actions/watcher/start.rb +11 -0
- data/lib/elasticsearch/api/actions/watcher/stats.rb +12 -1
- data/lib/elasticsearch/api/actions/watcher/stop.rb +12 -1
- data/lib/elasticsearch/api/actions/watcher/update_settings.rb +16 -5
- data/lib/elasticsearch/api/actions/xpack/info.rb +12 -1
- data/lib/elasticsearch/api/actions/xpack/usage.rb +12 -1
- data/lib/elasticsearch/api/version.rb +2 -2
- data/lib/elasticsearch/api.rb +2 -0
- metadata +5 -4
@@ -30,8 +30,19 @@ module Elasticsearch
|
|
30
30
|
# @option arguments [String] :username An identifier for the user.NOTE: Usernames must be at least 1 and no more than 507 characters.
|
31
31
|
# They can contain alphanumeric characters (a-z, A-Z, 0-9), spaces, punctuation, and printable symbols in the Basic Latin (ASCII) block.
|
32
32
|
# Leading or trailing whitespace is not allowed. (*Required*)
|
33
|
-
# @option arguments [String] :refresh Valid values are
|
33
|
+
# @option arguments [String] :refresh Valid values are `true`, `false`, and `wait_for`.
|
34
34
|
# These values have the same meaning as in the index API, but the default value for this API is true. Server default: true.
|
35
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
36
|
+
# when they occur.
|
37
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
38
|
+
# returned by Elasticsearch.
|
39
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
40
|
+
# For example `"exists_time": "1h"` for humans and
|
41
|
+
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
|
42
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
43
|
+
# only by machines.
|
44
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
45
|
+
# this option for debugging only.
|
35
46
|
# @option arguments [Hash] :headers Custom HTTP headers
|
36
47
|
# @option arguments [Hash] :body request body
|
37
48
|
#
|
@@ -25,16 +25,28 @@ module Elasticsearch
|
|
25
25
|
# Find API keys with a query.
|
26
26
|
# Get a paginated list of API keys and their information.
|
27
27
|
# You can optionally filter the results with a query.
|
28
|
-
# To use this API, you must have at least the
|
29
|
-
# If you have only the
|
30
|
-
# If you have the
|
28
|
+
# To use this API, you must have at least the `manage_own_api_key` or the `read_security` cluster privileges.
|
29
|
+
# If you have only the `manage_own_api_key` privilege, this API returns only the API keys that you own.
|
30
|
+
# If you have the `read_security`, `manage_api_key`, or greater privileges (including `manage_security`), this API returns all API keys regardless of ownership.
|
31
|
+
# Refer to the linked documentation for examples of how to find API keys:
|
31
32
|
#
|
32
33
|
# @option arguments [Boolean] :with_limited_by Return the snapshot of the owner user's role descriptors associated with the API key.
|
33
34
|
# 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).
|
34
|
-
# An API key cannot retrieve any API key’s limited-by role descriptors (including itself) unless it has
|
35
|
+
# An API key cannot retrieve any API key’s limited-by role descriptors (including itself) unless it has `manage_api_key` or higher privileges.
|
35
36
|
# @option arguments [Boolean] :with_profile_uid Determines whether to also retrieve the profile UID for the API key owner principal.
|
36
|
-
# If it exists, the profile UID is returned under the
|
37
|
+
# If it exists, the profile UID is returned under the `profile_uid` response field for each API key.
|
37
38
|
# @option arguments [Boolean] :typed_keys Determines whether aggregation names are prefixed by their respective types in the response.
|
39
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
40
|
+
# when they occur.
|
41
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
42
|
+
# returned by Elasticsearch.
|
43
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
44
|
+
# For example `"exists_time": "1h"` for humans and
|
45
|
+
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
|
46
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
47
|
+
# only by machines.
|
48
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
49
|
+
# this option for debugging only.
|
38
50
|
# @option arguments [Hash] :headers Custom HTTP headers
|
39
51
|
# @option arguments [Hash] :body request body
|
40
52
|
#
|
@@ -29,6 +29,17 @@ module Elasticsearch
|
|
29
29
|
# You can optionally filter the results with a query.
|
30
30
|
# Also, the results can be paginated and sorted.
|
31
31
|
#
|
32
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
33
|
+
# when they occur.
|
34
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
35
|
+
# returned by Elasticsearch.
|
36
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
37
|
+
# For example `"exists_time": "1h"` for humans and
|
38
|
+
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
|
39
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
40
|
+
# only by machines.
|
41
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
42
|
+
# this option for debugging only.
|
32
43
|
# @option arguments [Hash] :headers Custom HTTP headers
|
33
44
|
# @option arguments [Hash] :body request body
|
34
45
|
#
|
@@ -49,7 +60,7 @@ module Elasticsearch
|
|
49
60
|
end
|
50
61
|
|
51
62
|
path = '_security/_query/role'
|
52
|
-
params =
|
63
|
+
params = Utils.process_params(arguments)
|
53
64
|
|
54
65
|
Elasticsearch::API::Response.new(
|
55
66
|
perform_request(method, path, params, body, headers, request_opts)
|
@@ -29,6 +29,17 @@ module Elasticsearch
|
|
29
29
|
# This API is only for native users.
|
30
30
|
#
|
31
31
|
# @option arguments [Boolean] :with_profile_uid Determines whether to retrieve the user profile UID, if it exists, for the users.
|
32
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
33
|
+
# when they occur.
|
34
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
35
|
+
# returned by Elasticsearch.
|
36
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
37
|
+
# For example `"exists_time": "1h"` for humans and
|
38
|
+
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
|
39
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
40
|
+
# only by machines.
|
41
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
42
|
+
# this option for debugging only.
|
32
43
|
# @option arguments [Hash] :headers Custom HTTP headers
|
33
44
|
# @option arguments [Hash] :body request body
|
34
45
|
#
|
@@ -29,10 +29,21 @@ module Elasticsearch
|
|
29
29
|
# The SAML message that is submitted can be:
|
30
30
|
# * A response to a SAML authentication request that was previously created using the SAML prepare authentication API.
|
31
31
|
# * An unsolicited SAML message in the case of an IdP-initiated single sign-on (SSO) flow.
|
32
|
-
# In either case, the SAML message needs to be a base64 encoded XML document with a root element of
|
32
|
+
# In either case, the SAML message needs to be a base64 encoded XML document with a root element of `<Response>`.
|
33
33
|
# After successful validation, Elasticsearch responds with an Elasticsearch internal access token and refresh token that can be subsequently used for authentication.
|
34
34
|
# 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.
|
35
35
|
#
|
36
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
37
|
+
# when they occur.
|
38
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
39
|
+
# returned by Elasticsearch.
|
40
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
41
|
+
# For example `"exists_time": "1h"` for humans and
|
42
|
+
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
|
43
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
44
|
+
# only by machines.
|
45
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
46
|
+
# this option for debugging only.
|
36
47
|
# @option arguments [Hash] :headers Custom HTTP headers
|
37
48
|
# @option arguments [Hash] :body request body
|
38
49
|
#
|
@@ -50,7 +61,7 @@ module Elasticsearch
|
|
50
61
|
|
51
62
|
method = Elasticsearch::API::HTTP_POST
|
52
63
|
path = '_security/saml/authenticate'
|
53
|
-
params =
|
64
|
+
params = Utils.process_params(arguments)
|
54
65
|
|
55
66
|
Elasticsearch::API::Response.new(
|
56
67
|
perform_request(method, path, params, body, headers, request_opts)
|
@@ -32,6 +32,17 @@ module Elasticsearch
|
|
32
32
|
# The response can be sent by the IdP with either the HTTP-Redirect or the HTTP-Post binding.
|
33
33
|
# The caller of this API must prepare the request accordingly so that this API can handle either of them.
|
34
34
|
#
|
35
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
36
|
+
# when they occur.
|
37
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
38
|
+
# returned by Elasticsearch.
|
39
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
40
|
+
# For example `"exists_time": "1h"` for humans and
|
41
|
+
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
|
42
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
43
|
+
# only by machines.
|
44
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
45
|
+
# this option for debugging only.
|
35
46
|
# @option arguments [Hash] :headers Custom HTTP headers
|
36
47
|
# @option arguments [Hash] :body request body
|
37
48
|
#
|
@@ -49,7 +60,7 @@ module Elasticsearch
|
|
49
60
|
|
50
61
|
method = Elasticsearch::API::HTTP_POST
|
51
62
|
path = '_security/saml/complete_logout'
|
52
|
-
params =
|
63
|
+
params = Utils.process_params(arguments)
|
53
64
|
|
54
65
|
Elasticsearch::API::Response.new(
|
55
66
|
perform_request(method, path, params, body, headers, request_opts)
|
@@ -27,10 +27,21 @@ module Elasticsearch
|
|
27
27
|
# NOTE: This API is intended for use by custom web applications other than Kibana.
|
28
28
|
# If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.
|
29
29
|
# The logout request comes from the SAML IdP during an IdP initiated Single Logout.
|
30
|
-
# The custom web application can use this API to have Elasticsearch process the
|
30
|
+
# The custom web application can use this API to have Elasticsearch process the `LogoutRequest`.
|
31
31
|
# 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.
|
32
32
|
# Thus the user can be redirected back to their IdP.
|
33
33
|
#
|
34
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
35
|
+
# when they occur.
|
36
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
37
|
+
# returned by Elasticsearch.
|
38
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
39
|
+
# For example `"exists_time": "1h"` for humans and
|
40
|
+
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
|
41
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
42
|
+
# only by machines.
|
43
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
44
|
+
# this option for debugging only.
|
34
45
|
# @option arguments [Hash] :headers Custom HTTP headers
|
35
46
|
# @option arguments [Hash] :body request body
|
36
47
|
#
|
@@ -48,7 +59,7 @@ module Elasticsearch
|
|
48
59
|
|
49
60
|
method = Elasticsearch::API::HTTP_POST
|
50
61
|
path = '_security/saml/invalidate'
|
51
|
-
params =
|
62
|
+
params = Utils.process_params(arguments)
|
52
63
|
|
53
64
|
Elasticsearch::API::Response.new(
|
54
65
|
perform_request(method, path, params, body, headers, request_opts)
|
@@ -29,6 +29,17 @@ module Elasticsearch
|
|
29
29
|
# This API invalidates the tokens that were generated for a user by the SAML authenticate API.
|
30
30
|
# 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).
|
31
31
|
#
|
32
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
33
|
+
# when they occur.
|
34
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
35
|
+
# returned by Elasticsearch.
|
36
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
37
|
+
# For example `"exists_time": "1h"` for humans and
|
38
|
+
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
|
39
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
40
|
+
# only by machines.
|
41
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
42
|
+
# this option for debugging only.
|
32
43
|
# @option arguments [Hash] :headers Custom HTTP headers
|
33
44
|
# @option arguments [Hash] :body request body
|
34
45
|
#
|
@@ -46,7 +57,7 @@ module Elasticsearch
|
|
46
57
|
|
47
58
|
method = Elasticsearch::API::HTTP_POST
|
48
59
|
path = '_security/saml/logout'
|
49
|
-
params =
|
60
|
+
params = Utils.process_params(arguments)
|
50
61
|
|
51
62
|
Elasticsearch::API::Response.new(
|
52
63
|
perform_request(method, path, params, body, headers, request_opts)
|
@@ -23,17 +23,28 @@ module Elasticsearch
|
|
23
23
|
module Security
|
24
24
|
module Actions
|
25
25
|
# Prepare SAML authentication.
|
26
|
-
# Create a SAML authentication request (
|
26
|
+
# Create a SAML authentication request (`<AuthnRequest>`) as a URL string based on the configuration of the respective SAML realm in Elasticsearch.
|
27
27
|
# NOTE: This API is intended for use by custom web applications other than Kibana.
|
28
28
|
# If you are using Kibana, refer to the documentation for configuring SAML single-sign-on on the Elastic Stack.
|
29
29
|
# This API returns a URL pointing to the SAML Identity Provider.
|
30
30
|
# You can use the URL to redirect the browser of the user in order to continue the authentication process.
|
31
|
-
# The URL includes a single parameter named
|
32
|
-
# If the configuration dictates that SAML authentication requests should be signed, the URL has two extra parameters named
|
31
|
+
# The URL includes a single parameter named `SAMLRequest`, which contains a SAML Authentication request that is deflated and Base64 encoded.
|
32
|
+
# If the configuration dictates that SAML authentication requests should be signed, the URL has two extra parameters named `SigAlg` and `Signature`.
|
33
33
|
# These parameters contain the algorithm used for the signature and the signature value itself.
|
34
34
|
# It also returns a random string that uniquely identifies this SAML Authentication request.
|
35
35
|
# The caller of this API needs to store this identifier as it needs to be used in a following step of the authentication process.
|
36
36
|
#
|
37
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
38
|
+
# when they occur.
|
39
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
40
|
+
# returned by Elasticsearch.
|
41
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
42
|
+
# For example `"exists_time": "1h"` for humans and
|
43
|
+
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
|
44
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
45
|
+
# only by machines.
|
46
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
47
|
+
# this option for debugging only.
|
37
48
|
# @option arguments [Hash] :headers Custom HTTP headers
|
38
49
|
# @option arguments [Hash] :body request body
|
39
50
|
#
|
@@ -51,7 +62,7 @@ module Elasticsearch
|
|
51
62
|
|
52
63
|
method = Elasticsearch::API::HTTP_POST
|
53
64
|
path = '_security/saml/prepare'
|
54
|
-
params =
|
65
|
+
params = Utils.process_params(arguments)
|
55
66
|
|
56
67
|
Elasticsearch::API::Response.new(
|
57
68
|
perform_request(method, path, params, body, headers, request_opts)
|
@@ -28,6 +28,17 @@ module Elasticsearch
|
|
28
28
|
# This API generates Service Provider metadata based on the configuration of a SAML realm in Elasticsearch.
|
29
29
|
#
|
30
30
|
# @option arguments [String] :realm_name The name of the SAML realm in Elasticsearch. (*Required*)
|
31
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
32
|
+
# when they occur.
|
33
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
34
|
+
# returned by Elasticsearch.
|
35
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
36
|
+
# For example `"exists_time": "1h"` for humans and
|
37
|
+
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
|
38
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
39
|
+
# only by machines.
|
40
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
41
|
+
# this option for debugging only.
|
31
42
|
# @option arguments [Hash] :headers Custom HTTP headers
|
32
43
|
#
|
33
44
|
# @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-security-saml-service-provider-metadata
|
@@ -51,7 +62,7 @@ module Elasticsearch
|
|
51
62
|
|
52
63
|
method = Elasticsearch::API::HTTP_GET
|
53
64
|
path = "_security/saml/metadata/#{Utils.listify(_realm_name)}"
|
54
|
-
params =
|
65
|
+
params = Utils.process_params(arguments)
|
55
66
|
|
56
67
|
Elasticsearch::API::Response.new(
|
57
68
|
perform_request(method, path, params, body, headers, request_opts)
|
@@ -28,11 +28,22 @@ module Elasticsearch
|
|
28
28
|
# Individual users and external applications should not call this API directly.
|
29
29
|
# Elastic reserves the right to change or remove this feature in future releases without prior notice.
|
30
30
|
#
|
31
|
-
# @option arguments [String] :data A comma-separated list of filters for the
|
32
|
-
# To return all content use
|
33
|
-
# To return a subset of content, use
|
34
|
-
# By default, the API returns no
|
35
|
-
# It is an error to specify
|
31
|
+
# @option arguments [String, Array<String>] :data A comma-separated list of filters for the `data` field of the profile document.
|
32
|
+
# To return all content use `data=*`.
|
33
|
+
# To return a subset of content, use `data=<key>` to retrieve content nested under the specified `<key>`.
|
34
|
+
# By default, the API returns no `data` content.
|
35
|
+
# It is an error to specify `data` as both the query parameter and the request body field.
|
36
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
37
|
+
# when they occur.
|
38
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
39
|
+
# returned by Elasticsearch.
|
40
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
41
|
+
# For example `"exists_time": "1h"` for humans and
|
42
|
+
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
|
43
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
44
|
+
# only by machines.
|
45
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
46
|
+
# this option for debugging only.
|
36
47
|
# @option arguments [Hash] :headers Custom HTTP headers
|
37
48
|
# @option arguments [Hash] :body request body
|
38
49
|
#
|
@@ -25,19 +25,30 @@ module Elasticsearch
|
|
25
25
|
# Update an API key.
|
26
26
|
# Update attributes of an existing API key.
|
27
27
|
# This API supports updates to an API key's access scope, expiration, and metadata.
|
28
|
-
# To use this API, you must have at least the
|
28
|
+
# To use this API, you must have at least the `manage_own_api_key` cluster privilege.
|
29
29
|
# Users can only update API keys that they created or that were granted to them.
|
30
|
-
# To update another user’s API key, use the
|
30
|
+
# To update another user’s API key, use the `run_as` feature to submit a request on behalf of another user.
|
31
31
|
# IMPORTANT: It's not possible to use an API key as the authentication credential for this API. The owner user’s credentials are required.
|
32
32
|
# Use this API to update API keys created by the create API key or grant API Key APIs.
|
33
33
|
# If you need to apply the same update to many API keys, you can use the bulk update API keys API to reduce overhead.
|
34
34
|
# It's not possible to update expired API keys or API keys that have been invalidated by the invalidate API key API.
|
35
|
-
# The access scope of an API key is derived from the
|
35
|
+
# 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.
|
36
36
|
# The snapshot of the owner's permissions is updated automatically on every call.
|
37
|
-
# IMPORTANT: If you don't specify
|
37
|
+
# 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.
|
38
38
|
# This change can occur if the owner user's permissions have changed since the API key was created or last modified.
|
39
39
|
#
|
40
40
|
# @option arguments [String] :id The ID of the API key to update. (*Required*)
|
41
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
42
|
+
# when they occur.
|
43
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
44
|
+
# returned by Elasticsearch.
|
45
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
46
|
+
# For example `"exists_time": "1h"` for humans and
|
47
|
+
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
|
48
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
49
|
+
# only by machines.
|
50
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
51
|
+
# this option for debugging only.
|
41
52
|
# @option arguments [Hash] :headers Custom HTTP headers
|
42
53
|
# @option arguments [Hash] :body request body
|
43
54
|
#
|
@@ -62,7 +73,7 @@ module Elasticsearch
|
|
62
73
|
|
63
74
|
method = Elasticsearch::API::HTTP_PUT
|
64
75
|
path = "_security/api_key/#{Utils.listify(_id)}"
|
65
|
-
params =
|
76
|
+
params = Utils.process_params(arguments)
|
66
77
|
|
67
78
|
Elasticsearch::API::Response.new(
|
68
79
|
perform_request(method, path, params, body, headers, request_opts)
|
@@ -24,17 +24,29 @@ module Elasticsearch
|
|
24
24
|
module Actions
|
25
25
|
# Update a cross-cluster API key.
|
26
26
|
# Update the attributes of an existing cross-cluster API key, which is used for API key based remote cluster access.
|
27
|
-
# To use this API, you must have at least the
|
27
|
+
# To use this API, you must have at least the `manage_security` cluster privilege.
|
28
28
|
# Users can only update API keys that they created.
|
29
|
-
# To update another user's API key, use the
|
29
|
+
# To update another user's API key, use the `run_as` feature to submit a request on behalf of another user.
|
30
30
|
# IMPORTANT: It's not possible to use an API key as the authentication credential for this API.
|
31
31
|
# To update an API key, the owner user's credentials are required.
|
32
32
|
# It's not possible to update expired API keys, or API keys that have been invalidated by the invalidate API key API.
|
33
33
|
# This API supports updates to an API key's access scope, metadata, and expiration.
|
34
|
-
# The owner user's information, such as the
|
34
|
+
# The owner user's information, such as the `username` and `realm`, is also updated automatically on every call.
|
35
35
|
# NOTE: This API cannot update REST API keys, which should be updated by either the update API key or bulk update API keys API.
|
36
|
+
# 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}.
|
36
37
|
#
|
37
38
|
# @option arguments [String] :id The ID of the cross-cluster API key to update. (*Required*)
|
39
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
40
|
+
# when they occur.
|
41
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
42
|
+
# returned by Elasticsearch.
|
43
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
44
|
+
# For example `"exists_time": "1h"` for humans and
|
45
|
+
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
|
46
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
47
|
+
# only by machines.
|
48
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
49
|
+
# this option for debugging only.
|
38
50
|
# @option arguments [Hash] :headers Custom HTTP headers
|
39
51
|
# @option arguments [Hash] :body request body
|
40
52
|
#
|
@@ -60,7 +72,7 @@ module Elasticsearch
|
|
60
72
|
|
61
73
|
method = Elasticsearch::API::HTTP_PUT
|
62
74
|
path = "_security/cross_cluster/api_key/#{Utils.listify(_id)}"
|
63
|
-
params =
|
75
|
+
params = Utils.process_params(arguments)
|
64
76
|
|
65
77
|
Elasticsearch::API::Response.new(
|
66
78
|
perform_request(method, path, params, body, headers, request_opts)
|
@@ -23,8 +23,8 @@ module Elasticsearch
|
|
23
23
|
module Security
|
24
24
|
module Actions
|
25
25
|
# Update security index settings.
|
26
|
-
# Update the user-configurable settings for the security internal index (
|
27
|
-
# NOTE: If
|
26
|
+
# 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`.
|
27
|
+
# NOTE: If `index.auto_expand_replicas` is set, `index.number_of_replicas` will be ignored during updates.
|
28
28
|
# If a specific index is not in use on the system and settings are provided for it, the request will be rejected.
|
29
29
|
# This API does not yet support configuring the settings for indices before they are in use.
|
30
30
|
#
|
@@ -32,6 +32,17 @@ module Elasticsearch
|
|
32
32
|
# If no response is received before the timeout expires, the request fails and returns an error.
|
33
33
|
# @option arguments [Time] :timeout The period to wait for a response.
|
34
34
|
# If no response is received before the timeout expires, the request fails and returns an error.
|
35
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
36
|
+
# when they occur.
|
37
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
38
|
+
# returned by Elasticsearch.
|
39
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
40
|
+
# For example `"exists_time": "1h"` for humans and
|
41
|
+
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
|
42
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
43
|
+
# only by machines.
|
44
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
45
|
+
# this option for debugging only.
|
35
46
|
# @option arguments [Hash] :headers Custom HTTP headers
|
36
47
|
# @option arguments [Hash] :body request body
|
37
48
|
#
|
@@ -28,12 +28,12 @@ module Elasticsearch
|
|
28
28
|
# Individual users and external applications should not call this API directly.
|
29
29
|
# Elastic reserves the right to change or remove this feature in future releases without prior notice.
|
30
30
|
# To use this API, you must have one of the following privileges:
|
31
|
-
# * The
|
32
|
-
# * The
|
33
|
-
# This API updates the
|
31
|
+
# * The `manage_user_profile` cluster privilege.
|
32
|
+
# * The `update_profile_data` global privilege for the namespaces that are referenced in the request.
|
33
|
+
# This API updates the `labels` and `data` fields of an existing user profile document with JSON objects.
|
34
34
|
# New keys and their values are added to the profile document and conflicting keys are replaced by data that's included in the request.
|
35
35
|
# For both labels and data, content is namespaced by the top-level fields.
|
36
|
-
# The
|
36
|
+
# The `update_profile_data` global privilege grants privileges for updating only the allowed namespaces.
|
37
37
|
#
|
38
38
|
# @option arguments [String] :uid A unique identifier for the user profile. (*Required*)
|
39
39
|
# @option arguments [Integer] :if_seq_no Only perform the operation if the document has this sequence number.
|
@@ -42,6 +42,17 @@ module Elasticsearch
|
|
42
42
|
# visible to search.
|
43
43
|
# If 'wait_for', it waits for a refresh to make this operation visible to search.
|
44
44
|
# If 'false', nothing is done with refreshes. Server default: false.
|
45
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
46
|
+
# when they occur.
|
47
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
48
|
+
# returned by Elasticsearch.
|
49
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
50
|
+
# For example `"exists_time": "1h"` for humans and
|
51
|
+
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
|
52
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
53
|
+
# only by machines.
|
54
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
55
|
+
# this option for debugging only.
|
45
56
|
# @option arguments [Hash] :headers Custom HTTP headers
|
46
57
|
# @option arguments [Hash] :body request body
|
47
58
|
#
|
@@ -45,6 +45,17 @@ module Elasticsearch
|
|
45
45
|
# If you specify this parameter in the request path, it is used for any documents that do not explicitly specify an index argument.
|
46
46
|
# @option arguments [String] :pipeline The pipeline to use as the default pipeline.
|
47
47
|
# This value can be used to override the default pipeline of the index.
|
48
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
49
|
+
# when they occur.
|
50
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
51
|
+
# returned by Elasticsearch.
|
52
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
53
|
+
# For example `"exists_time": "1h"` for humans and
|
54
|
+
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
|
55
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
56
|
+
# only by machines.
|
57
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
58
|
+
# this option for debugging only.
|
48
59
|
# @option arguments [Hash] :headers Custom HTTP headers
|
49
60
|
# @option arguments [Hash] :body request body
|
50
61
|
#
|
@@ -28,10 +28,21 @@ module Elasticsearch
|
|
28
28
|
# @option arguments [String] :repository The name of the snapshot repository to clean up. (*Required*)
|
29
29
|
# @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
|
30
30
|
# If the master node is not available before the timeout expires, the request fails and returns an error.
|
31
|
-
# To indicate that the request should never timeout, set it to
|
31
|
+
# To indicate that the request should never timeout, set it to `-1` Server default: 30s.
|
32
32
|
# @option arguments [Time] :timeout The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.
|
33
33
|
# 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.
|
34
|
-
# To indicate that the request should never timeout, set it to
|
34
|
+
# To indicate that the request should never timeout, set it to `-1`. Server default: 30s.
|
35
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
36
|
+
# when they occur.
|
37
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
38
|
+
# returned by Elasticsearch.
|
39
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
40
|
+
# For example `"exists_time": "1h"` for humans and
|
41
|
+
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
|
42
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
43
|
+
# only by machines.
|
44
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
45
|
+
# this option for debugging only.
|
35
46
|
# @option arguments [Hash] :headers Custom HTTP headers
|
36
47
|
#
|
37
48
|
# @see https://www.elastic.co/docs/api/doc/elasticsearch/v9/operation/operation-snapshot-cleanup-repository
|
@@ -30,7 +30,18 @@ module Elasticsearch
|
|
30
30
|
# @option arguments [String] :target_snapshot The target snapshot name. (*Required*)
|
31
31
|
# @option arguments [Time] :master_timeout The period to wait for the master node.
|
32
32
|
# If the master node is not available before the timeout expires, the request fails and returns an error.
|
33
|
-
# To indicate that the request should never timeout, set it to
|
33
|
+
# To indicate that the request should never timeout, set it to `-1`. Server default: 30s.
|
34
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
35
|
+
# when they occur.
|
36
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
37
|
+
# returned by Elasticsearch.
|
38
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
39
|
+
# For example `"exists_time": "1h"` for humans and
|
40
|
+
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
|
41
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
42
|
+
# only by machines.
|
43
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
44
|
+
# this option for debugging only.
|
34
45
|
# @option arguments [Hash] :headers Custom HTTP headers
|
35
46
|
# @option arguments [Hash] :body request body
|
36
47
|
#
|
@@ -31,8 +31,19 @@ module Elasticsearch
|
|
31
31
|
# It must be unique in the repository. (*Required*)
|
32
32
|
# @option arguments [Time] :master_timeout The period to wait for a connection to the master node.
|
33
33
|
# If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
|
34
|
-
# @option arguments [Boolean] :wait_for_completion If
|
35
|
-
# If
|
34
|
+
# @option arguments [Boolean] :wait_for_completion If `true`, the request returns a response when the snapshot is complete.
|
35
|
+
# If `false`, the request returns a response when the snapshot initializes.
|
36
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
37
|
+
# when they occur.
|
38
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
39
|
+
# returned by Elasticsearch.
|
40
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
41
|
+
# For example `"exists_time": "1h"` for humans and
|
42
|
+
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
|
43
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
44
|
+
# only by machines.
|
45
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
46
|
+
# this option for debugging only.
|
36
47
|
# @option arguments [Hash] :headers Custom HTTP headers
|
37
48
|
# @option arguments [Hash] :body request body
|
38
49
|
#
|
@@ -25,20 +25,31 @@ module Elasticsearch
|
|
25
25
|
# Create or update a snapshot repository.
|
26
26
|
# IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters.
|
27
27
|
# To register a snapshot repository, the cluster's global metadata must be writeable.
|
28
|
-
# Ensure there are no cluster blocks (for example,
|
28
|
+
# Ensure there are no cluster blocks (for example, `cluster.blocks.read_only` and `clsuter.blocks.read_only_allow_delete` settings) that prevent write access.
|
29
29
|
# Several options for this API can be specified using a query parameter or a request body parameter.
|
30
30
|
# If both parameters are specified, only the query parameter is used.
|
31
31
|
#
|
32
32
|
# @option arguments [String] :repository The name of the snapshot repository to register or update. (*Required*)
|
33
33
|
# @option arguments [Time] :master_timeout The period to wait for the master node.
|
34
34
|
# If the master node is not available before the timeout expires, the request fails and returns an error.
|
35
|
-
# To indicate that the request should never timeout, set it to
|
35
|
+
# To indicate that the request should never timeout, set it to `-1`. Server default: 30s.
|
36
36
|
# @option arguments [Time] :timeout The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata.
|
37
37
|
# 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.
|
38
|
-
# To indicate that the request should never timeout, set it to
|
39
|
-
# @option arguments [Boolean] :verify If
|
40
|
-
# If
|
38
|
+
# To indicate that the request should never timeout, set it to `-1`. Server default: 30s.
|
39
|
+
# @option arguments [Boolean] :verify If `true`, the request verifies the repository is functional on all master and data nodes in the cluster.
|
40
|
+
# If `false`, this verification is skipped.
|
41
41
|
# You can also perform this verification with the verify snapshot repository API. Server default: true.
|
42
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
43
|
+
# when they occur.
|
44
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
45
|
+
# returned by Elasticsearch.
|
46
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
47
|
+
# For example `"exists_time": "1h"` for humans and
|
48
|
+
# `"eixsts_time_in_millis": 3600000` for computers. When disabled the human
|
49
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
50
|
+
# only by machines.
|
51
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
52
|
+
# this option for debugging only.
|
42
53
|
# @option arguments [Hash] :headers Custom HTTP headers
|
43
54
|
# @option arguments [Hash] :body repository
|
44
55
|
#
|