elasticsearch-api 9.0.3 → 9.1.0
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/.gitignore +1 -0
- data/lib/elasticsearch/api/actions/async_search/delete.rb +14 -3
- data/lib/elasticsearch/api/actions/async_search/get.rb +13 -2
- data/lib/elasticsearch/api/actions/async_search/status.rb +13 -2
- data/lib/elasticsearch/api/actions/async_search/submit.rb +17 -6
- data/lib/elasticsearch/api/actions/bulk.rb +86 -63
- data/lib/elasticsearch/api/actions/cat/aliases.rb +20 -9
- data/lib/elasticsearch/api/actions/cat/allocation.rb +19 -8
- data/lib/elasticsearch/api/actions/cat/component_templates.rb +19 -8
- data/lib/elasticsearch/api/actions/cat/count.rb +19 -8
- data/lib/elasticsearch/api/actions/cat/fielddata.rb +17 -6
- data/lib/elasticsearch/api/actions/cat/health.rb +20 -9
- data/lib/elasticsearch/api/actions/cat/help.rb +1 -1
- data/lib/elasticsearch/api/actions/cat/indices.rb +18 -7
- data/lib/elasticsearch/api/actions/cat/master.rb +19 -8
- data/lib/elasticsearch/api/actions/cat/ml_data_frame_analytics.rb +16 -5
- data/lib/elasticsearch/api/actions/cat/ml_datafeeds.rb +19 -8
- data/lib/elasticsearch/api/actions/cat/ml_jobs.rb +20 -9
- data/lib/elasticsearch/api/actions/cat/ml_trained_models.rb +18 -7
- data/lib/elasticsearch/api/actions/cat/nodeattrs.rb +19 -8
- data/lib/elasticsearch/api/actions/cat/nodes.rb +23 -11
- data/lib/elasticsearch/api/actions/cat/pending_tasks.rb +19 -8
- data/lib/elasticsearch/api/actions/cat/plugins.rb +19 -8
- data/lib/elasticsearch/api/actions/cat/recovery.rb +24 -12
- data/lib/elasticsearch/api/actions/cat/repositories.rb +19 -8
- data/lib/elasticsearch/api/actions/cat/segments.rb +24 -12
- data/lib/elasticsearch/api/actions/cat/shards.rb +22 -11
- data/lib/elasticsearch/api/actions/cat/snapshots.rb +21 -9
- data/lib/elasticsearch/api/actions/cat/tasks.rb +19 -8
- data/lib/elasticsearch/api/actions/cat/templates.rb +19 -8
- data/lib/elasticsearch/api/actions/cat/thread_pool.rb +21 -10
- data/lib/elasticsearch/api/actions/cat/transforms.rb +18 -7
- data/lib/elasticsearch/api/actions/clear_scroll.rb +13 -2
- data/lib/elasticsearch/api/actions/close_point_in_time.rb +15 -4
- data/lib/elasticsearch/api/actions/cluster/allocation_explain.rb +13 -1
- data/lib/elasticsearch/api/actions/cluster/delete_component_template.rb +12 -1
- data/lib/elasticsearch/api/actions/cluster/delete_voting_config_exclusions.rb +12 -1
- data/lib/elasticsearch/api/actions/cluster/exists_component_template.rb +12 -1
- data/lib/elasticsearch/api/actions/cluster/get_component_template.rb +17 -5
- data/lib/elasticsearch/api/actions/cluster/get_settings.rb +14 -3
- data/lib/elasticsearch/api/actions/cluster/health.rb +13 -2
- data/lib/elasticsearch/api/actions/cluster/info.rb +13 -2
- data/lib/elasticsearch/api/actions/cluster/pending_tasks.rb +14 -3
- data/lib/elasticsearch/api/actions/cluster/post_voting_config_exclusions.rb +16 -5
- data/lib/elasticsearch/api/actions/cluster/put_component_template.rb +20 -8
- data/lib/elasticsearch/api/actions/cluster/put_settings.rb +17 -6
- data/lib/elasticsearch/api/actions/cluster/remote_info.rb +13 -2
- data/lib/elasticsearch/api/actions/cluster/reroute.rb +16 -5
- data/lib/elasticsearch/api/actions/cluster/state.rb +15 -4
- data/lib/elasticsearch/api/actions/cluster/stats.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/check_in.rb +14 -3
- data/lib/elasticsearch/api/actions/connector/delete.rb +12 -1
- data/lib/elasticsearch/api/actions/connector/get.rb +12 -1
- data/lib/elasticsearch/api/actions/connector/list.rb +12 -1
- data/lib/elasticsearch/api/actions/connector/post.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/put.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/sync_job_cancel.rb +14 -3
- data/lib/elasticsearch/api/actions/connector/sync_job_check_in.rb +14 -3
- data/lib/elasticsearch/api/actions/connector/sync_job_claim.rb +15 -4
- data/lib/elasticsearch/api/actions/connector/sync_job_delete.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/sync_job_error.rb +14 -3
- data/lib/elasticsearch/api/actions/connector/sync_job_get.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/sync_job_list.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/sync_job_post.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/sync_job_update_stats.rb +15 -4
- data/lib/elasticsearch/api/actions/connector/update_active_filtering.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/update_api_key_id.rb +14 -3
- data/lib/elasticsearch/api/actions/connector/update_configuration.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/update_error.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/update_features.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/update_filtering.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/update_filtering_validation.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/update_index_name.rb +14 -3
- data/lib/elasticsearch/api/actions/connector/update_name.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/update_native.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/update_pipeline.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/update_scheduling.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/update_service_type.rb +13 -2
- data/lib/elasticsearch/api/actions/connector/update_status.rb +13 -2
- data/lib/elasticsearch/api/actions/count.rb +29 -18
- data/lib/elasticsearch/api/actions/create.rb +44 -41
- data/lib/elasticsearch/api/actions/cross_cluster_replication/delete_auto_follow_pattern.rb +13 -2
- data/lib/elasticsearch/api/actions/cross_cluster_replication/follow.rb +12 -1
- data/lib/elasticsearch/api/actions/cross_cluster_replication/follow_info.rb +13 -2
- data/lib/elasticsearch/api/actions/cross_cluster_replication/follow_stats.rb +12 -1
- data/lib/elasticsearch/api/actions/cross_cluster_replication/forget_follower.rb +12 -1
- data/lib/elasticsearch/api/actions/cross_cluster_replication/get_auto_follow_pattern.rb +13 -2
- data/lib/elasticsearch/api/actions/cross_cluster_replication/pause_auto_follow_pattern.rb +13 -2
- data/lib/elasticsearch/api/actions/cross_cluster_replication/pause_follow.rb +13 -2
- data/lib/elasticsearch/api/actions/cross_cluster_replication/put_auto_follow_pattern.rb +12 -1
- data/lib/elasticsearch/api/actions/cross_cluster_replication/resume_auto_follow_pattern.rb +13 -2
- data/lib/elasticsearch/api/actions/cross_cluster_replication/resume_follow.rb +12 -1
- data/lib/elasticsearch/api/actions/cross_cluster_replication/stats.rb +13 -2
- data/lib/elasticsearch/api/actions/cross_cluster_replication/unfollow.rb +13 -2
- data/lib/elasticsearch/api/actions/dangling_indices/delete_dangling_index.rb +13 -2
- data/lib/elasticsearch/api/actions/dangling_indices/import_dangling_index.rb +13 -2
- data/lib/elasticsearch/api/actions/dangling_indices/list_dangling_indices.rb +14 -3
- data/lib/elasticsearch/api/actions/delete.rb +25 -12
- data/lib/elasticsearch/api/actions/delete_by_query.rb +63 -48
- data/lib/elasticsearch/api/actions/delete_by_query_rethrottle.rb +14 -3
- data/lib/elasticsearch/api/actions/delete_script.rb +14 -3
- data/lib/elasticsearch/api/actions/enrich/delete_policy.rb +12 -1
- data/lib/elasticsearch/api/actions/enrich/execute_policy.rb +13 -2
- data/lib/elasticsearch/api/actions/enrich/get_policy.rb +12 -1
- data/lib/elasticsearch/api/actions/enrich/put_policy.rb +12 -1
- data/lib/elasticsearch/api/actions/enrich/stats.rb +12 -1
- data/lib/elasticsearch/api/actions/eql/delete.rb +14 -3
- data/lib/elasticsearch/api/actions/eql/get.rb +12 -1
- data/lib/elasticsearch/api/actions/eql/get_status.rb +13 -2
- data/lib/elasticsearch/api/actions/eql/search.rb +15 -3
- data/lib/elasticsearch/api/actions/esql/async_query.rb +17 -14
- data/lib/elasticsearch/api/actions/esql/async_query_delete.rb +15 -4
- data/lib/elasticsearch/api/actions/esql/async_query_get.rb +17 -5
- data/lib/elasticsearch/api/actions/esql/async_query_stop.rb +15 -4
- data/lib/elasticsearch/api/actions/esql/get_query.rb +76 -0
- data/lib/elasticsearch/api/actions/esql/list_queries.rb +66 -0
- data/lib/elasticsearch/api/actions/esql/query.rb +15 -2
- data/lib/elasticsearch/api/actions/exists.rb +31 -18
- data/lib/elasticsearch/api/actions/exists_source.rb +21 -8
- data/lib/elasticsearch/api/actions/explain.rb +25 -14
- data/lib/elasticsearch/api/actions/features/get_features.rb +13 -2
- data/lib/elasticsearch/api/actions/features/reset_features.rb +12 -1
- data/lib/elasticsearch/api/actions/field_caps.rb +18 -7
- data/lib/elasticsearch/api/actions/fleet/global_checkpoints.rb +17 -6
- data/lib/elasticsearch/api/actions/fleet/msearch.rb +15 -4
- data/lib/elasticsearch/api/actions/fleet/search.rb +15 -4
- data/lib/elasticsearch/api/actions/get.rb +48 -29
- data/lib/elasticsearch/api/actions/get_script.rb +13 -2
- data/lib/elasticsearch/api/actions/get_script_context.rb +13 -2
- data/lib/elasticsearch/api/actions/get_script_languages.rb +13 -2
- data/lib/elasticsearch/api/actions/get_source.rb +24 -11
- data/lib/elasticsearch/api/actions/graph/explore.rb +13 -2
- data/lib/elasticsearch/api/actions/health_report.rb +13 -2
- data/lib/elasticsearch/api/actions/index.rb +55 -43
- data/lib/elasticsearch/api/actions/index_lifecycle_management/delete_lifecycle.rb +12 -1
- data/lib/elasticsearch/api/actions/index_lifecycle_management/explain_lifecycle.rb +14 -3
- data/lib/elasticsearch/api/actions/index_lifecycle_management/get_lifecycle.rb +12 -1
- data/lib/elasticsearch/api/actions/index_lifecycle_management/get_status.rb +13 -2
- data/lib/elasticsearch/api/actions/index_lifecycle_management/migrate_to_data_tiers.rb +14 -3
- data/lib/elasticsearch/api/actions/index_lifecycle_management/move_to_step.rb +14 -3
- data/lib/elasticsearch/api/actions/index_lifecycle_management/put_lifecycle.rb +12 -1
- data/lib/elasticsearch/api/actions/index_lifecycle_management/remove_policy.rb +13 -2
- data/lib/elasticsearch/api/actions/index_lifecycle_management/retry.rb +13 -2
- data/lib/elasticsearch/api/actions/index_lifecycle_management/start.rb +12 -1
- data/lib/elasticsearch/api/actions/index_lifecycle_management/stop.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/add_block.rb +20 -9
- data/lib/elasticsearch/api/actions/indices/analyze.rb +15 -4
- data/lib/elasticsearch/api/actions/indices/cancel_migrate_reindex.rb +13 -2
- data/lib/elasticsearch/api/actions/indices/clear_cache.rb +24 -14
- data/lib/elasticsearch/api/actions/indices/clone.rb +17 -6
- data/lib/elasticsearch/api/actions/indices/close.rb +19 -9
- data/lib/elasticsearch/api/actions/indices/create.rb +24 -13
- data/lib/elasticsearch/api/actions/indices/create_data_stream.rb +15 -4
- data/lib/elasticsearch/api/actions/indices/create_from.rb +13 -2
- data/lib/elasticsearch/api/actions/indices/data_streams_stats.rb +15 -4
- data/lib/elasticsearch/api/actions/indices/delete.rb +17 -7
- data/lib/elasticsearch/api/actions/indices/delete_alias.rb +14 -3
- data/lib/elasticsearch/api/actions/indices/delete_data_lifecycle.rb +13 -2
- data/lib/elasticsearch/api/actions/indices/delete_data_stream.rb +14 -3
- data/lib/elasticsearch/api/actions/indices/delete_data_stream_options.rb +75 -0
- data/lib/elasticsearch/api/actions/indices/delete_index_template.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/delete_template.rb +14 -2
- data/lib/elasticsearch/api/actions/indices/disk_usage.rb +21 -10
- data/lib/elasticsearch/api/actions/indices/downsample.rb +15 -4
- data/lib/elasticsearch/api/actions/indices/exists.rb +19 -9
- data/lib/elasticsearch/api/actions/indices/exists_alias.rb +18 -8
- data/lib/elasticsearch/api/actions/indices/exists_index_template.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/exists_template.rb +14 -3
- data/lib/elasticsearch/api/actions/indices/explain_data_lifecycle.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/field_usage_stats.rb +16 -5
- data/lib/elasticsearch/api/actions/indices/flush.rb +20 -10
- data/lib/elasticsearch/api/actions/indices/forcemerge.rb +23 -11
- data/lib/elasticsearch/api/actions/indices/get.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/get_alias.rb +19 -9
- data/lib/elasticsearch/api/actions/indices/get_data_lifecycle.rb +16 -6
- data/lib/elasticsearch/api/actions/indices/get_data_lifecycle_stats.rb +13 -2
- data/lib/elasticsearch/api/actions/indices/get_data_stream.rb +14 -3
- data/lib/elasticsearch/api/actions/indices/get_data_stream_options.rb +77 -0
- data/lib/elasticsearch/api/actions/indices/get_data_stream_settings.rb +75 -0
- data/lib/elasticsearch/api/actions/indices/get_field_mapping.rb +19 -10
- data/lib/elasticsearch/api/actions/indices/get_index_template.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/get_mapping.rb +18 -8
- data/lib/elasticsearch/api/actions/indices/get_migrate_reindex_status.rb +13 -2
- data/lib/elasticsearch/api/actions/indices/get_settings.rb +24 -13
- data/lib/elasticsearch/api/actions/indices/get_template.rb +17 -6
- data/lib/elasticsearch/api/actions/indices/migrate_reindex.rb +13 -2
- data/lib/elasticsearch/api/actions/indices/migrate_to_data_stream.rb +13 -2
- data/lib/elasticsearch/api/actions/indices/modify_data_stream.rb +13 -2
- data/lib/elasticsearch/api/actions/indices/open.rb +23 -13
- data/lib/elasticsearch/api/actions/indices/promote_data_stream.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/put_alias.rb +13 -2
- data/lib/elasticsearch/api/actions/indices/put_data_lifecycle.rb +15 -5
- data/lib/elasticsearch/api/actions/indices/put_data_stream_options.rb +82 -0
- data/lib/elasticsearch/api/actions/indices/put_data_stream_settings.rb +85 -0
- data/lib/elasticsearch/api/actions/indices/put_index_template.rb +17 -6
- data/lib/elasticsearch/api/actions/indices/put_mapping.rb +26 -25
- data/lib/elasticsearch/api/actions/indices/put_settings.rb +66 -14
- data/lib/elasticsearch/api/actions/indices/put_template.rb +14 -3
- data/lib/elasticsearch/api/actions/indices/recovery.rb +22 -5
- data/lib/elasticsearch/api/actions/indices/refresh.rb +19 -9
- data/lib/elasticsearch/api/actions/indices/reload_search_analyzers.rb +15 -4
- data/lib/elasticsearch/api/actions/indices/remove_block.rb +93 -0
- data/lib/elasticsearch/api/actions/indices/resolve_cluster.rb +35 -25
- data/lib/elasticsearch/api/actions/indices/resolve_index.rb +17 -7
- data/lib/elasticsearch/api/actions/indices/rollover.rb +22 -11
- data/lib/elasticsearch/api/actions/indices/segments.rb +17 -7
- data/lib/elasticsearch/api/actions/indices/shard_stores.rb +13 -2
- data/lib/elasticsearch/api/actions/indices/shrink.rb +14 -3
- data/lib/elasticsearch/api/actions/indices/simulate_index_template.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/simulate_template.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/split.rb +19 -6
- data/lib/elasticsearch/api/actions/indices/stats.rb +19 -8
- data/lib/elasticsearch/api/actions/indices/update_aliases.rb +12 -1
- data/lib/elasticsearch/api/actions/indices/validate_query.rb +25 -15
- data/lib/elasticsearch/api/actions/inference/chat_completion_unified.rb +18 -1
- data/lib/elasticsearch/api/actions/inference/completion.rb +12 -1
- data/lib/elasticsearch/api/actions/inference/delete.rb +12 -1
- data/lib/elasticsearch/api/actions/inference/get.rb +13 -2
- data/lib/elasticsearch/api/actions/inference/inference.rb +12 -1
- data/lib/elasticsearch/api/actions/inference/put.rb +33 -8
- data/lib/elasticsearch/api/actions/inference/put_alibabacloud.rb +15 -8
- data/lib/elasticsearch/api/actions/inference/put_amazonbedrock.rb +15 -3
- data/lib/elasticsearch/api/actions/inference/put_anthropic.rb +16 -9
- data/lib/elasticsearch/api/actions/inference/put_azureaistudio.rb +15 -8
- data/lib/elasticsearch/api/actions/inference/put_azureopenai.rb +16 -9
- data/lib/elasticsearch/api/actions/inference/put_cohere.rb +15 -8
- data/lib/elasticsearch/api/actions/inference/put_custom.rb +112 -0
- data/lib/elasticsearch/api/actions/inference/put_deepseek.rb +82 -0
- data/lib/elasticsearch/api/actions/inference/put_elasticsearch.rb +16 -4
- data/lib/elasticsearch/api/actions/inference/put_elser.rb +15 -3
- data/lib/elasticsearch/api/actions/inference/put_googleaistudio.rb +15 -8
- data/lib/elasticsearch/api/actions/inference/put_googlevertexai.rb +15 -8
- data/lib/elasticsearch/api/actions/inference/put_hugging_face.rb +43 -19
- data/lib/elasticsearch/api/actions/inference/put_jinaai.rb +17 -10
- data/lib/elasticsearch/api/actions/inference/put_mistral.rb +16 -10
- data/lib/elasticsearch/api/actions/inference/put_openai.rb +16 -9
- data/lib/elasticsearch/api/actions/inference/put_voyageai.rb +15 -3
- data/lib/elasticsearch/api/actions/inference/put_watsonx.rb +17 -11
- data/lib/elasticsearch/api/actions/inference/rerank.rb +13 -2
- data/lib/elasticsearch/api/actions/inference/sparse_embedding.rb +12 -1
- data/lib/elasticsearch/api/actions/inference/stream_completion.rb +15 -3
- data/lib/elasticsearch/api/actions/inference/text_embedding.rb +12 -1
- data/lib/elasticsearch/api/actions/inference/update.rb +14 -3
- data/lib/elasticsearch/api/actions/info.rb +14 -2
- data/lib/elasticsearch/api/actions/ingest/delete_geoip_database.rb +12 -1
- data/lib/elasticsearch/api/actions/ingest/delete_ip_location_database.rb +14 -3
- data/lib/elasticsearch/api/actions/ingest/delete_pipeline.rb +13 -2
- data/lib/elasticsearch/api/actions/ingest/geo_ip_stats.rb +12 -1
- data/lib/elasticsearch/api/actions/ingest/get_geoip_database.rb +15 -4
- data/lib/elasticsearch/api/actions/ingest/get_ip_location_database.rb +14 -6
- data/lib/elasticsearch/api/actions/ingest/get_pipeline.rb +14 -3
- data/lib/elasticsearch/api/actions/ingest/processor_grok.rb +12 -1
- data/lib/elasticsearch/api/actions/ingest/put_geoip_database.rb +12 -1
- data/lib/elasticsearch/api/actions/ingest/put_ip_location_database.rb +14 -3
- data/lib/elasticsearch/api/actions/ingest/put_pipeline.rb +11 -0
- data/lib/elasticsearch/api/actions/ingest/simulate.rb +14 -3
- data/lib/elasticsearch/api/actions/license/delete.rb +12 -1
- data/lib/elasticsearch/api/actions/license/get.rb +14 -3
- data/lib/elasticsearch/api/actions/license/get_basic_status.rb +13 -2
- data/lib/elasticsearch/api/actions/license/get_trial_status.rb +13 -2
- data/lib/elasticsearch/api/actions/license/post.rb +12 -1
- data/lib/elasticsearch/api/actions/license/post_start_basic.rb +13 -2
- data/lib/elasticsearch/api/actions/license/post_start_trial.rb +13 -2
- data/lib/elasticsearch/api/actions/logstash/delete_pipeline.rb +13 -2
- data/lib/elasticsearch/api/actions/logstash/get_pipeline.rb +13 -2
- data/lib/elasticsearch/api/actions/logstash/put_pipeline.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/clear_trained_model_deployment_cache.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/close_job.rb +16 -5
- data/lib/elasticsearch/api/actions/machine_learning/delete_calendar.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/delete_calendar_event.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/delete_calendar_job.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/delete_data_frame_analytics.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/delete_datafeed.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/delete_expired_data.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/delete_filter.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/delete_forecast.rb +15 -4
- data/lib/elasticsearch/api/actions/machine_learning/delete_job.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/delete_model_snapshot.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/delete_trained_model.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/delete_trained_model_alias.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/estimate_model_memory.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/evaluate_data_frame.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/explain_data_frame_analytics.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/flush_job.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/forecast.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/get_buckets.rb +16 -5
- data/lib/elasticsearch/api/actions/machine_learning/get_calendar_events.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/get_calendars.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/get_categories.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/get_data_frame_analytics.rb +14 -3
- 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 +18 -7
- data/lib/elasticsearch/api/actions/machine_learning/get_filters.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/get_influencers.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/get_job_stats.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/get_jobs.rb +15 -4
- data/lib/elasticsearch/api/actions/machine_learning/get_memory_stats.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/get_model_snapshot_upgrade_stats.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/get_model_snapshots.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/get_overall_buckets.rb +31 -20
- data/lib/elasticsearch/api/actions/machine_learning/get_records.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/get_trained_models.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/get_trained_models_stats.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/infer_trained_model.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/info.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/open_job.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/post_calendar_events.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/post_data.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/preview_data_frame_analytics.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/preview_datafeed.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/put_calendar.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/put_calendar_job.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/put_data_frame_analytics.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/put_datafeed.rb +25 -6
- data/lib/elasticsearch/api/actions/machine_learning/put_filter.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/put_job.rb +19 -13
- data/lib/elasticsearch/api/actions/machine_learning/put_trained_model.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/put_trained_model_alias.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/put_trained_model_definition_part.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/put_trained_model_vocabulary.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/reset_job.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/revert_model_snapshot.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/set_upgrade_mode.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/start_data_frame_analytics.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/start_datafeed.rb +19 -8
- data/lib/elasticsearch/api/actions/machine_learning/start_trained_model_deployment.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/stop_data_frame_analytics.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/stop_datafeed.rb +17 -6
- data/lib/elasticsearch/api/actions/machine_learning/stop_trained_model_deployment.rb +14 -3
- data/lib/elasticsearch/api/actions/machine_learning/update_data_frame_analytics.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/update_datafeed.rb +17 -11
- data/lib/elasticsearch/api/actions/machine_learning/update_filter.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/update_job.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/update_model_snapshot.rb +13 -2
- data/lib/elasticsearch/api/actions/machine_learning/update_trained_model_deployment.rb +12 -1
- data/lib/elasticsearch/api/actions/machine_learning/upgrade_job_snapshot.rb +12 -1
- data/lib/elasticsearch/api/actions/mget.rb +25 -14
- data/lib/elasticsearch/api/actions/migration/deprecations.rb +13 -2
- data/lib/elasticsearch/api/actions/migration/get_feature_upgrade_status.rb +13 -2
- data/lib/elasticsearch/api/actions/migration/post_feature_upgrade.rb +13 -2
- data/lib/elasticsearch/api/actions/msearch.rb +28 -11
- data/lib/elasticsearch/api/actions/msearch_template.rb +22 -10
- data/lib/elasticsearch/api/actions/mtermvectors.rb +21 -10
- data/lib/elasticsearch/api/actions/nodes/clear_repositories_metering_archive.rb +14 -3
- data/lib/elasticsearch/api/actions/nodes/get_repositories_metering_info.rb +13 -2
- data/lib/elasticsearch/api/actions/nodes/hot_threads.rb +12 -1
- data/lib/elasticsearch/api/actions/nodes/info.rb +12 -1
- data/lib/elasticsearch/api/actions/nodes/reload_secure_settings.rb +12 -1
- data/lib/elasticsearch/api/actions/nodes/stats.rb +13 -2
- data/lib/elasticsearch/api/actions/nodes/usage.rb +14 -3
- data/lib/elasticsearch/api/actions/open_point_in_time.rb +23 -12
- data/lib/elasticsearch/api/actions/ping.rb +13 -2
- data/lib/elasticsearch/api/actions/put_script.rb +14 -3
- data/lib/elasticsearch/api/actions/query_rules/delete_rule.rb +13 -2
- data/lib/elasticsearch/api/actions/query_rules/delete_ruleset.rb +12 -1
- data/lib/elasticsearch/api/actions/query_rules/get_rule.rb +13 -2
- data/lib/elasticsearch/api/actions/query_rules/get_ruleset.rb +13 -2
- data/lib/elasticsearch/api/actions/query_rules/list_rulesets.rb +12 -1
- data/lib/elasticsearch/api/actions/query_rules/put_rule.rb +13 -2
- data/lib/elasticsearch/api/actions/query_rules/put_ruleset.rb +15 -4
- data/lib/elasticsearch/api/actions/query_rules/test.rb +13 -2
- data/lib/elasticsearch/api/actions/rank_eval.rb +16 -5
- data/lib/elasticsearch/api/actions/reindex.rb +35 -123
- data/lib/elasticsearch/api/actions/reindex_rethrottle.rb +17 -4
- data/lib/elasticsearch/api/actions/render_search_template.rb +14 -3
- data/lib/elasticsearch/api/actions/scripts_painless_execute.rb +12 -1
- data/lib/elasticsearch/api/actions/scroll.rb +16 -5
- data/lib/elasticsearch/api/actions/search.rb +71 -60
- data/lib/elasticsearch/api/actions/search_application/delete.rb +13 -2
- data/lib/elasticsearch/api/actions/search_application/delete_behavioral_analytics.rb +13 -2
- data/lib/elasticsearch/api/actions/search_application/get.rb +13 -2
- data/lib/elasticsearch/api/actions/search_application/get_behavioral_analytics.rb +13 -2
- data/lib/elasticsearch/api/actions/search_application/list.rb +12 -1
- data/lib/elasticsearch/api/actions/search_application/post_behavioral_analytics_event.rb +12 -1
- data/lib/elasticsearch/api/actions/search_application/put.rb +13 -2
- data/lib/elasticsearch/api/actions/search_application/put_behavioral_analytics.rb +13 -2
- data/lib/elasticsearch/api/actions/search_application/render_query.rb +15 -4
- data/lib/elasticsearch/api/actions/search_application/search.rb +12 -1
- data/lib/elasticsearch/api/actions/search_mvt.rb +39 -70
- data/lib/elasticsearch/api/actions/search_shards.rb +22 -12
- data/lib/elasticsearch/api/actions/search_template.rb +24 -14
- data/lib/elasticsearch/api/actions/searchable_snapshots/cache_stats.rb +12 -1
- data/lib/elasticsearch/api/actions/searchable_snapshots/clear_cache.rb +14 -3
- data/lib/elasticsearch/api/actions/searchable_snapshots/mount.rb +13 -2
- data/lib/elasticsearch/api/actions/searchable_snapshots/stats.rb +12 -1
- data/lib/elasticsearch/api/actions/security/activate_user_profile.rb +17 -6
- data/lib/elasticsearch/api/actions/security/authenticate.rb +13 -2
- data/lib/elasticsearch/api/actions/security/bulk_delete_role.rb +13 -2
- data/lib/elasticsearch/api/actions/security/bulk_put_role.rb +13 -2
- data/lib/elasticsearch/api/actions/security/bulk_update_api_keys.rb +15 -4
- data/lib/elasticsearch/api/actions/security/change_password.rb +13 -2
- data/lib/elasticsearch/api/actions/security/clear_api_key_cache.rb +14 -3
- data/lib/elasticsearch/api/actions/security/clear_cached_privileges.rb +14 -3
- data/lib/elasticsearch/api/actions/security/clear_cached_realms.rb +13 -2
- data/lib/elasticsearch/api/actions/security/clear_cached_roles.rb +14 -3
- data/lib/elasticsearch/api/actions/security/clear_cached_service_tokens.rb +17 -6
- data/lib/elasticsearch/api/actions/security/create_api_key.rb +13 -2
- data/lib/elasticsearch/api/actions/security/create_cross_cluster_api_key.rb +16 -5
- data/lib/elasticsearch/api/actions/security/create_service_token.rb +15 -4
- data/lib/elasticsearch/api/actions/security/delegate_pki.rb +15 -4
- data/lib/elasticsearch/api/actions/security/delete_privileges.rb +14 -3
- data/lib/elasticsearch/api/actions/security/delete_role.rb +13 -2
- data/lib/elasticsearch/api/actions/security/delete_role_mapping.rb +13 -2
- data/lib/elasticsearch/api/actions/security/delete_service_token.rb +13 -2
- data/lib/elasticsearch/api/actions/security/delete_user.rb +13 -2
- data/lib/elasticsearch/api/actions/security/disable_user.rb +13 -2
- data/lib/elasticsearch/api/actions/security/disable_user_profile.rb +12 -1
- data/lib/elasticsearch/api/actions/security/enable_user.rb +13 -2
- data/lib/elasticsearch/api/actions/security/enable_user_profile.rb +12 -1
- data/lib/elasticsearch/api/actions/security/enroll_kibana.rb +13 -2
- data/lib/elasticsearch/api/actions/security/enroll_node.rb +13 -2
- data/lib/elasticsearch/api/actions/security/get_api_key.rb +20 -9
- data/lib/elasticsearch/api/actions/security/get_builtin_privileges.rb +13 -2
- data/lib/elasticsearch/api/actions/security/get_privileges.rb +14 -3
- data/lib/elasticsearch/api/actions/security/get_role.rb +12 -1
- data/lib/elasticsearch/api/actions/security/get_role_mapping.rb +13 -2
- data/lib/elasticsearch/api/actions/security/get_service_accounts.rb +16 -5
- data/lib/elasticsearch/api/actions/security/get_service_credentials.rb +15 -4
- data/lib/elasticsearch/api/actions/security/get_settings.rb +15 -4
- data/lib/elasticsearch/api/actions/security/get_token.rb +15 -4
- data/lib/elasticsearch/api/actions/security/get_user.rb +13 -2
- data/lib/elasticsearch/api/actions/security/get_user_privileges.rb +12 -4
- data/lib/elasticsearch/api/actions/security/get_user_profile.rb +17 -6
- data/lib/elasticsearch/api/actions/security/grant_api_key.rb +17 -2
- data/lib/elasticsearch/api/actions/security/has_privileges.rb +13 -2
- data/lib/elasticsearch/api/actions/security/has_privileges_user_profile.rb +13 -2
- data/lib/elasticsearch/api/actions/security/invalidate_api_key.rb +21 -10
- data/lib/elasticsearch/api/actions/security/invalidate_token.rb +16 -5
- data/lib/elasticsearch/api/actions/security/oidc_authenticate.rb +13 -2
- data/lib/elasticsearch/api/actions/security/oidc_logout.rb +14 -3
- data/lib/elasticsearch/api/actions/security/oidc_prepare_authentication.rb +13 -2
- data/lib/elasticsearch/api/actions/security/put_privileges.rb +18 -7
- data/lib/elasticsearch/api/actions/security/put_role.rb +13 -2
- data/lib/elasticsearch/api/actions/security/put_role_mapping.rb +16 -5
- data/lib/elasticsearch/api/actions/security/put_user.rb +13 -2
- data/lib/elasticsearch/api/actions/security/query_api_keys.rb +18 -6
- data/lib/elasticsearch/api/actions/security/query_role.rb +13 -2
- data/lib/elasticsearch/api/actions/security/query_user.rb +12 -1
- data/lib/elasticsearch/api/actions/security/saml_authenticate.rb +14 -3
- data/lib/elasticsearch/api/actions/security/saml_complete_logout.rb +13 -2
- data/lib/elasticsearch/api/actions/security/saml_invalidate.rb +14 -3
- data/lib/elasticsearch/api/actions/security/saml_logout.rb +13 -2
- data/lib/elasticsearch/api/actions/security/saml_prepare_authentication.rb +16 -5
- data/lib/elasticsearch/api/actions/security/saml_service_provider_metadata.rb +13 -2
- data/lib/elasticsearch/api/actions/security/suggest_user_profiles.rb +17 -6
- data/lib/elasticsearch/api/actions/security/update_api_key.rb +17 -6
- data/lib/elasticsearch/api/actions/security/update_cross_cluster_api_key.rb +17 -5
- data/lib/elasticsearch/api/actions/security/update_settings.rb +14 -3
- data/lib/elasticsearch/api/actions/security/update_user_profile_data.rb +16 -5
- data/lib/elasticsearch/api/actions/simulate/ingest.rb +12 -1
- data/lib/elasticsearch/api/actions/snapshot/cleanup_repository.rb +14 -3
- data/lib/elasticsearch/api/actions/snapshot/clone.rb +13 -2
- data/lib/elasticsearch/api/actions/snapshot/create.rb +14 -3
- data/lib/elasticsearch/api/actions/snapshot/create_repository.rb +17 -6
- data/lib/elasticsearch/api/actions/snapshot/delete.rb +16 -3
- data/lib/elasticsearch/api/actions/snapshot/delete_repository.rb +15 -4
- data/lib/elasticsearch/api/actions/snapshot/get.rb +32 -19
- data/lib/elasticsearch/api/actions/snapshot/get_repository.rb +16 -5
- data/lib/elasticsearch/api/actions/snapshot/repository_analyze.rb +38 -16
- data/lib/elasticsearch/api/actions/snapshot/repository_verify_integrity.rb +113 -0
- data/lib/elasticsearch/api/actions/snapshot/restore.rb +19 -6
- data/lib/elasticsearch/api/actions/snapshot/status.rb +19 -8
- data/lib/elasticsearch/api/actions/snapshot/verify_repository.rb +14 -3
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/delete_lifecycle.rb +12 -1
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_lifecycle.rb +12 -1
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/execute_retention.rb +12 -1
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_lifecycle.rb +12 -1
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_stats.rb +12 -1
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/get_status.rb +14 -3
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/put_lifecycle.rb +14 -3
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/start.rb +14 -3
- data/lib/elasticsearch/api/actions/snapshot_lifecycle_management/stop.rb +14 -3
- data/lib/elasticsearch/api/actions/sql/clear_cursor.rb +13 -2
- data/lib/elasticsearch/api/actions/sql/delete_async.rb +14 -3
- data/lib/elasticsearch/api/actions/sql/get_async.rb +14 -3
- data/lib/elasticsearch/api/actions/sql/get_async_status.rb +13 -2
- data/lib/elasticsearch/api/actions/sql/query.rb +14 -3
- data/lib/elasticsearch/api/actions/sql/translate.rb +14 -3
- data/lib/elasticsearch/api/actions/ssl/certificates.rb +15 -4
- data/lib/elasticsearch/api/actions/streams/logs_disable.rb +50 -0
- data/lib/elasticsearch/api/actions/streams/logs_enable.rb +50 -0
- data/lib/elasticsearch/api/actions/streams/status.rb +50 -0
- data/lib/elasticsearch/api/actions/synonyms/delete_synonym.rb +13 -2
- data/lib/elasticsearch/api/actions/synonyms/delete_synonym_rule.rb +15 -2
- data/lib/elasticsearch/api/actions/synonyms/get_synonym.rb +12 -1
- data/lib/elasticsearch/api/actions/synonyms/get_synonym_rule.rb +13 -2
- data/lib/elasticsearch/api/actions/synonyms/get_synonyms_sets.rb +12 -1
- data/lib/elasticsearch/api/actions/synonyms/put_synonym.rb +16 -2
- data/lib/elasticsearch/api/actions/synonyms/put_synonym_rule.rb +15 -2
- data/lib/elasticsearch/api/actions/tasks/cancel.rb +15 -4
- data/lib/elasticsearch/api/actions/tasks/get.rb +13 -2
- data/lib/elasticsearch/api/actions/tasks/list.rb +30 -15
- data/lib/elasticsearch/api/actions/terms_enum.rb +15 -4
- data/lib/elasticsearch/api/actions/termvectors.rb +28 -15
- data/lib/elasticsearch/api/actions/text_structure/find_field_structure.rb +53 -42
- data/lib/elasticsearch/api/actions/text_structure/find_message_structure.rb +53 -42
- data/lib/elasticsearch/api/actions/text_structure/find_structure.rb +45 -45
- data/lib/elasticsearch/api/actions/text_structure/test_grok_pattern.rb +13 -2
- data/lib/elasticsearch/api/actions/transform/delete_transform.rb +12 -1
- data/lib/elasticsearch/api/actions/transform/get_node_stats.rb +2 -7
- data/lib/elasticsearch/api/actions/transform/get_transform.rb +14 -3
- data/lib/elasticsearch/api/actions/transform/get_transform_stats.rb +14 -3
- data/lib/elasticsearch/api/actions/transform/preview_transform.rb +12 -1
- data/lib/elasticsearch/api/actions/transform/put_transform.rb +19 -8
- data/lib/elasticsearch/api/actions/transform/reset_transform.rb +14 -3
- data/lib/elasticsearch/api/actions/transform/schedule_now_transform.rb +13 -2
- data/lib/elasticsearch/api/actions/transform/start_transform.rb +15 -4
- data/lib/elasticsearch/api/actions/transform/stop_transform.rb +15 -4
- data/lib/elasticsearch/api/actions/transform/update_transform.rb +15 -4
- data/lib/elasticsearch/api/actions/transform/upgrade_transforms.rb +12 -1
- data/lib/elasticsearch/api/actions/update.rb +20 -8
- data/lib/elasticsearch/api/actions/update_by_query.rb +76 -56
- data/lib/elasticsearch/api/actions/update_by_query_rethrottle.rb +13 -2
- data/lib/elasticsearch/api/actions/watcher/ack_watch.rb +16 -4
- data/lib/elasticsearch/api/actions/watcher/activate_watch.rb +13 -2
- data/lib/elasticsearch/api/actions/watcher/deactivate_watch.rb +13 -2
- data/lib/elasticsearch/api/actions/watcher/delete_watch.rb +15 -4
- data/lib/elasticsearch/api/actions/watcher/execute_watch.rb +14 -2
- data/lib/elasticsearch/api/actions/watcher/get_settings.rb +14 -3
- data/lib/elasticsearch/api/actions/watcher/get_watch.rb +13 -2
- data/lib/elasticsearch/api/actions/watcher/put_watch.rb +18 -7
- data/lib/elasticsearch/api/actions/watcher/query_watches.rb +14 -3
- data/lib/elasticsearch/api/actions/watcher/start.rb +12 -1
- data/lib/elasticsearch/api/actions/watcher/stats.rb +13 -2
- data/lib/elasticsearch/api/actions/watcher/stop.rb +13 -2
- data/lib/elasticsearch/api/actions/watcher/update_settings.rb +17 -6
- data/lib/elasticsearch/api/actions/xpack/info.rb +13 -2
- data/lib/elasticsearch/api/actions/xpack/usage.rb +13 -2
- data/lib/elasticsearch/api/version.rb +2 -2
- data/lib/elasticsearch/api.rb +1 -0
- metadata +18 -4
@@ -29,21 +29,32 @@ module Elasticsearch
|
|
29
29
|
# It is also possible that Elasticsearch must complete its work on other tasks before it can process the cancellation.
|
30
30
|
# The get task information API will continue to list these cancelled tasks until they complete.
|
31
31
|
# The cancelled flag in the response indicates that the cancellation command has been processed and the task will stop as soon as possible.
|
32
|
-
# To troubleshoot why a cancelled task does not complete promptly, use the get task information API with the
|
32
|
+
# 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.
|
33
33
|
# 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.
|
34
34
|
# This functionality is Experimental and may be changed or removed
|
35
35
|
# completely in a future release. Elastic will take a best effort approach
|
36
36
|
# to fix any issues, but experimental features are not subject to the
|
37
37
|
# support SLA of official GA features.
|
38
38
|
#
|
39
|
-
# @option arguments [String
|
40
|
-
# @option arguments [String] :actions A comma-separated list or wildcard expression of actions that is used to limit the request.
|
39
|
+
# @option arguments [String] :task_id The task identifier.
|
40
|
+
# @option arguments [String, Array<String>] :actions A comma-separated list or wildcard expression of actions that is used to limit the request.
|
41
41
|
# @option arguments [Array<String>] :nodes A comma-separated list of node IDs or names that is used to limit the request.
|
42
42
|
# @option arguments [String] :parent_task_id A parent task ID that is used to limit the tasks.
|
43
43
|
# @option arguments [Boolean] :wait_for_completion If true, the request blocks until all found tasks are complete.
|
44
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
45
|
+
# when they occur.
|
46
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
47
|
+
# returned by Elasticsearch.
|
48
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
49
|
+
# For example `"exists_time": "1h"` for humans and
|
50
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
51
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
52
|
+
# only by machines.
|
53
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
54
|
+
# this option for debugging only.
|
44
55
|
# @option arguments [Hash] :headers Custom HTTP headers
|
45
56
|
#
|
46
|
-
# @see https://www.elastic.co/docs/api/doc/elasticsearch/
|
57
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks
|
47
58
|
#
|
48
59
|
def cancel(arguments = {})
|
49
60
|
request_opts = { endpoint: arguments[:endpoint] || 'tasks.cancel' }
|
@@ -35,10 +35,21 @@ module Elasticsearch
|
|
35
35
|
# @option arguments [String] :task_id The task identifier. (*Required*)
|
36
36
|
# @option arguments [Time] :timeout The period to wait for a response.
|
37
37
|
# If no response is received before the timeout expires, the request fails and returns an error. Server default: 30s.
|
38
|
-
# @option arguments [Boolean] :wait_for_completion If
|
38
|
+
# @option arguments [Boolean] :wait_for_completion If `true`, the request blocks until the task has completed.
|
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
|
+
# `"exists_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.
|
39
50
|
# @option arguments [Hash] :headers Custom HTTP headers
|
40
51
|
#
|
41
|
-
# @see https://www.elastic.co/docs/api/doc/elasticsearch/
|
52
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks
|
42
53
|
#
|
43
54
|
def get(arguments = {})
|
44
55
|
request_opts = { endpoint: arguments[:endpoint] || 'tasks.get' }
|
@@ -27,14 +27,17 @@ module Elasticsearch
|
|
27
27
|
# WARNING: The task management API is new and should still be considered a beta feature.
|
28
28
|
# The API may change in ways that are not backwards compatible.
|
29
29
|
# **Identifying running tasks**
|
30
|
-
# The
|
30
|
+
# 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.
|
31
31
|
# This enables you to track certain calls or associate certain tasks with the client that started them.
|
32
32
|
# For example:
|
33
|
-
#
|
33
|
+
#
|
34
|
+
# ```
|
34
35
|
# curl -i -H "X-Opaque-Id: 123456" "http://localhost:9200/_tasks?group_by=parents"
|
35
|
-
#
|
36
|
+
# ```
|
37
|
+
#
|
36
38
|
# The API returns the following result:
|
37
|
-
#
|
39
|
+
#
|
40
|
+
# ```
|
38
41
|
# HTTP/1.1 200 OK
|
39
42
|
# X-Opaque-Id: 123456
|
40
43
|
# content-type: application/json; charset=UTF-8
|
@@ -70,32 +73,44 @@ module Elasticsearch
|
|
70
73
|
# }
|
71
74
|
# }
|
72
75
|
# }
|
73
|
-
#
|
74
|
-
#
|
75
|
-
#
|
76
|
-
# The
|
76
|
+
# ```
|
77
|
+
#
|
78
|
+
# In this example, `X-Opaque-Id: 123456` is the ID as a part of the response header.
|
79
|
+
# The `X-Opaque-Id` in the task `headers` is the ID for the task that was initiated by the REST request.
|
80
|
+
# The `X-Opaque-Id` in the children `headers` is the child task of the task that was initiated by the REST request.
|
77
81
|
# This functionality is Experimental and may be changed or removed
|
78
82
|
# completely in a future release. Elastic will take a best effort approach
|
79
83
|
# to fix any issues, but experimental features are not subject to the
|
80
84
|
# support SLA of official GA features.
|
81
85
|
#
|
82
|
-
# @option arguments [String] :actions A comma-separated list or wildcard expression of actions used to limit the request.
|
83
|
-
# For example, you can use
|
84
|
-
# @option arguments [Boolean] :detailed If
|
86
|
+
# @option arguments [String, Array<String>] :actions A comma-separated list or wildcard expression of actions used to limit the request.
|
87
|
+
# For example, you can use `cluser:*` to retrieve all cluster-related tasks.
|
88
|
+
# @option arguments [Boolean] :detailed If `true`, the response includes detailed information about the running tasks.
|
85
89
|
# This information is useful to distinguish tasks from each other but is more costly to run.
|
86
90
|
# @option arguments [String] :group_by A key that is used to group tasks in the response.
|
87
91
|
# The task lists can be grouped either by nodes or by parent tasks.
|
88
92
|
# @option arguments [String, Array] :nodes A comma-separated list of node IDs or names that is used to limit the returned information.
|
89
93
|
# @option arguments [String] :parent_task_id A parent task identifier that is used to limit returned information.
|
90
|
-
# To return all tasks, omit this parameter or use a value of
|
94
|
+
# To return all tasks, omit this parameter or use a value of `-1`.
|
91
95
|
# If the parent task is not found, the API does not return a 404 response code.
|
92
96
|
# @option arguments [Time] :timeout The period to wait for each node to respond.
|
93
97
|
# If a node does not respond before its timeout expires, the response does not include its information.
|
94
|
-
# However, timed out nodes are included in the
|
95
|
-
# @option arguments [Boolean] :wait_for_completion If
|
98
|
+
# However, timed out nodes are included in the `node_failures` property. Server default: 30s.
|
99
|
+
# @option arguments [Boolean] :wait_for_completion If `true`, the request blocks until the operation is complete.
|
100
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
101
|
+
# when they occur.
|
102
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
103
|
+
# returned by Elasticsearch.
|
104
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
105
|
+
# For example `"exists_time": "1h"` for humans and
|
106
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
107
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
108
|
+
# only by machines.
|
109
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
110
|
+
# this option for debugging only.
|
96
111
|
# @option arguments [Hash] :headers Custom HTTP headers
|
97
112
|
#
|
98
|
-
# @see https://www.elastic.co/docs/api/doc/elasticsearch/
|
113
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-tasks
|
99
114
|
#
|
100
115
|
def list(arguments = {})
|
101
116
|
request_opts = { endpoint: arguments[:endpoint] || 'tasks.list' }
|
@@ -26,12 +26,23 @@ module Elasticsearch
|
|
26
26
|
# This API is designed for low-latency look-ups used in auto-complete scenarios.
|
27
27
|
#
|
28
28
|
# @option arguments [String] :index A comma-separated list of data streams, indices, and index aliases to search.
|
29
|
-
# Wildcard (
|
30
|
-
# To search all data streams or indices, omit this parameter or use
|
29
|
+
# Wildcard (`*`) expressions are supported.
|
30
|
+
# To search all data streams or indices, omit this parameter or use `*` or `_all`. (*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
|
+
# `"exists_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
|
# @option arguments [Hash] :body request body
|
33
44
|
#
|
34
|
-
# @see https://www.elastic.co/docs/api/doc/elasticsearch/
|
45
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-terms-enum
|
35
46
|
#
|
36
47
|
def terms_enum(arguments = {})
|
37
48
|
request_opts = { endpoint: arguments[:endpoint] || 'terms_enum' }
|
@@ -57,7 +68,7 @@ module Elasticsearch
|
|
57
68
|
end
|
58
69
|
|
59
70
|
path = "#{Utils.listify(_index)}/_terms_enum"
|
60
|
-
params =
|
71
|
+
params = Utils.process_params(arguments)
|
61
72
|
|
62
73
|
Elasticsearch::API::Response.new(
|
63
74
|
perform_request(method, path, params, body, headers, request_opts)
|
@@ -24,49 +24,62 @@ module Elasticsearch
|
|
24
24
|
# Get term vector information.
|
25
25
|
# Get information and statistics about terms in the fields of a particular document.
|
26
26
|
# You can retrieve term vectors for documents stored in the index or for artificial documents passed in the body of the request.
|
27
|
-
# You can specify the fields you are interested in through the
|
27
|
+
# You can specify the fields you are interested in through the `fields` parameter or by adding the fields to the request body.
|
28
28
|
# For example:
|
29
|
-
#
|
29
|
+
#
|
30
|
+
# ```
|
30
31
|
# GET /my-index-000001/_termvectors/1?fields=message
|
31
|
-
#
|
32
|
+
# ```
|
33
|
+
#
|
32
34
|
# Fields can be specified using wildcards, similar to the multi match query.
|
33
35
|
# Term vectors are real-time by default, not near real-time.
|
34
|
-
# This can be changed by setting
|
36
|
+
# This can be changed by setting `realtime` parameter to `false`.
|
35
37
|
# You can request three types of values: _term information_, _term statistics_, and _field statistics_.
|
36
38
|
# By default, all term information and field statistics are returned for all fields but term statistics are excluded.
|
37
39
|
# **Term information**
|
38
40
|
# * term frequency in the field (always returned)
|
39
|
-
# * term positions (
|
40
|
-
# * start and end offsets (
|
41
|
-
# * term payloads (
|
41
|
+
# * term positions (`positions: true`)
|
42
|
+
# * start and end offsets (`offsets: true`)
|
43
|
+
# * term payloads (`payloads: true`), as base64 encoded bytes
|
42
44
|
# If the requested information wasn't stored in the index, it will be computed on the fly if possible.
|
43
45
|
# Additionally, term vectors could be computed for documents not even existing in the index, but instead provided by the user.
|
44
46
|
#
|
45
47
|
# @option arguments [String] :index The name of the index that contains the document. (*Required*)
|
46
48
|
# @option arguments [String] :id A unique identifier for the document.
|
47
49
|
# @option arguments [String, Array<String>] :fields A comma-separated list or wildcard expressions of fields to include in the statistics.
|
48
|
-
# It is used as the default list unless a specific field list is provided in the
|
49
|
-
# @option arguments [Boolean] :field_statistics If
|
50
|
+
# It is used as the default list unless a specific field list is provided in the `completion_fields` or `fielddata_fields` parameters.
|
51
|
+
# @option arguments [Boolean] :field_statistics If `true`, the response includes:
|
50
52
|
# - The document count (how many documents contain this field).
|
51
53
|
# - The sum of document frequencies (the sum of document frequencies for all terms in this field).
|
52
54
|
# - The sum of total term frequencies (the sum of total term frequencies of each term in this field). Server default: true.
|
53
|
-
# @option arguments [Boolean] :offsets If
|
54
|
-
# @option arguments [Boolean] :payloads If
|
55
|
-
# @option arguments [Boolean] :positions If
|
55
|
+
# @option arguments [Boolean] :offsets If `true`, the response includes term offsets. Server default: true.
|
56
|
+
# @option arguments [Boolean] :payloads If `true`, the response includes term payloads. Server default: true.
|
57
|
+
# @option arguments [Boolean] :positions If `true`, the response includes term positions. Server default: true.
|
56
58
|
# @option arguments [String] :preference The node or shard the operation should be performed on.
|
57
59
|
# It is random by default.
|
58
60
|
# @option arguments [Boolean] :realtime If true, the request is real-time as opposed to near-real-time. Server default: true.
|
59
61
|
# @option arguments [String] :routing A custom value that is used to route operations to a specific shard.
|
60
|
-
# @option arguments [Boolean] :term_statistics If
|
62
|
+
# @option arguments [Boolean] :term_statistics If `true`, the response includes:
|
61
63
|
# - The total term frequency (how often a term occurs in all documents).
|
62
64
|
# - The document frequency (the number of documents containing the current term).
|
63
65
|
# By default these values are not returned since term statistics can have a serious performance impact.
|
64
|
-
# @option arguments [Integer] :version If
|
66
|
+
# @option arguments [Integer] :version If `true`, returns the document version as part of a hit.
|
65
67
|
# @option arguments [String] :version_type The version type.
|
68
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
69
|
+
# when they occur.
|
70
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
71
|
+
# returned by Elasticsearch.
|
72
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
73
|
+
# For example `"exists_time": "1h"` for humans and
|
74
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
75
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
76
|
+
# only by machines.
|
77
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
78
|
+
# this option for debugging only.
|
66
79
|
# @option arguments [Hash] :headers Custom HTTP headers
|
67
80
|
# @option arguments [Hash] :body request body
|
68
81
|
#
|
69
|
-
# @see https://www.elastic.co/docs/api/doc/elasticsearch/
|
82
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-termvectors
|
70
83
|
#
|
71
84
|
def termvectors(arguments = {})
|
72
85
|
request_opts = { endpoint: arguments[:endpoint] || 'termvectors' }
|
@@ -25,7 +25,7 @@ module Elasticsearch
|
|
25
25
|
# Find the structure of a text field.
|
26
26
|
# Find the structure of a text field in an Elasticsearch index.
|
27
27
|
# This API provides a starting point for extracting further information from log messages already ingested into Elasticsearch.
|
28
|
-
# For example, if you have ingested data into a very simple index that has just
|
28
|
+
# 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.
|
29
29
|
# The response from the API contains:
|
30
30
|
# * Sample messages.
|
31
31
|
# * Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields.
|
@@ -33,77 +33,88 @@ module Elasticsearch
|
|
33
33
|
# * Appropriate mappings for an Elasticsearch index, which you could use to ingest the text.
|
34
34
|
# All this information can be calculated by the structure finder with no guidance.
|
35
35
|
# However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.
|
36
|
-
# If the structure finder produces unexpected results, specify the
|
36
|
+
# If the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response.
|
37
37
|
# It helps determine why the returned structure was chosen.
|
38
38
|
#
|
39
|
-
# @option arguments [String] :column_names If
|
39
|
+
# @option arguments [String] :column_names If `format` is set to `delimited`, you can specify the column names in a comma-separated list.
|
40
40
|
# If this parameter is not specified, the structure finder uses the column names from the header row of the text.
|
41
41
|
# If the text does not have a header row, columns are named "column1", "column2", "column3", for example.
|
42
|
-
# @option arguments [String] :delimiter If you have set
|
42
|
+
# @option arguments [String] :delimiter If you have set `format` to `delimited`, you can specify the character used to delimit the values in each row.
|
43
43
|
# Only a single character is supported; the delimiter cannot have multiple characters.
|
44
|
-
# By default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (
|
44
|
+
# By default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (`|`).
|
45
45
|
# In this default scenario, all rows must have the same number of fields for the delimited format to be detected.
|
46
46
|
# If you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row.
|
47
47
|
# @option arguments [Integer] :documents_to_sample The number of documents to include in the structural analysis.
|
48
48
|
# The minimum value is 2. Server default: 1000.
|
49
49
|
# @option arguments [String] :ecs_compatibility The mode of compatibility with ECS compliant Grok patterns.
|
50
50
|
# Use this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern.
|
51
|
-
# This setting primarily has an impact when a whole message Grok pattern such as
|
52
|
-
# If the structure finder identifies a common structure but has no idea of the meaning then generic field names such as
|
51
|
+
# This setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input.
|
52
|
+
# 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.
|
53
53
|
# The intention in that situation is that a user who knows the meanings will rename the fields before using them. Server default: disabled.
|
54
|
-
# @option arguments [Boolean] :explain If
|
54
|
+
# @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.
|
55
55
|
# @option arguments [String] :field The field that should be analyzed. (*Required*)
|
56
56
|
# @option arguments [String] :format The high level structure of the text.
|
57
57
|
# By default, the API chooses the format.
|
58
58
|
# In this default scenario, all rows must have the same number of fields for a delimited format to be detected.
|
59
59
|
# 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.
|
60
|
-
# @option arguments [String] :grok_pattern If the format is
|
61
|
-
# The name of the timestamp field in the Grok pattern must match what is specified in the
|
60
|
+
# @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.
|
61
|
+
# The name of the timestamp field in the Grok pattern must match what is specified in the `timestamp_field` parameter.
|
62
62
|
# If that parameter is not specified, the name of the timestamp field in the Grok pattern must match "timestamp".
|
63
|
-
# If
|
63
|
+
# If `grok_pattern` is not specified, the structure finder creates a Grok pattern.
|
64
64
|
# @option arguments [String] :index The name of the index that contains the analyzed field. (*Required*)
|
65
|
-
# @option arguments [String] :quote If the format is
|
65
|
+
# @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.
|
66
66
|
# Only a single character is supported.
|
67
|
-
# If this parameter is not specified, the default value is a double quote (
|
67
|
+
# If this parameter is not specified, the default value is a double quote (`"`).
|
68
68
|
# 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.
|
69
|
-
# @option arguments [Boolean] :should_trim_fields If the format is
|
70
|
-
# If this parameter is not specified and the delimiter is pipe (
|
71
|
-
# Otherwise, the default value is
|
69
|
+
# @option arguments [Boolean] :should_trim_fields If the format is `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them.
|
70
|
+
# If this parameter is not specified and the delimiter is pipe (`|`), the default value is true.
|
71
|
+
# Otherwise, the default value is `false`.
|
72
72
|
# @option arguments [Time] :timeout The maximum amount of time that the structure analysis can take.
|
73
73
|
# If the analysis is still running when the timeout expires, it will be stopped. Server default: 25s.
|
74
74
|
# @option arguments [String] :timestamp_field The name of the field that contains the primary timestamp of each record in the text.
|
75
|
-
# In particular, if the text was ingested into an index, this is the field that would be used to populate the
|
76
|
-
# Therefore, for semi-structured text, it is best not to specify this parameter unless
|
75
|
+
# 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`.
|
76
|
+
# 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.
|
77
77
|
# For structured text, it is not compulsory to have a timestamp in the text.
|
78
78
|
# @option arguments [String] :timestamp_format The Java time format of the timestamp field in the text.
|
79
79
|
# Only a subset of Java time format letter groups are supported:
|
80
|
-
# -
|
81
|
-
# -
|
82
|
-
# -
|
83
|
-
# -
|
84
|
-
# -
|
85
|
-
# -
|
86
|
-
# -
|
87
|
-
# -
|
88
|
-
# -
|
89
|
-
# -
|
90
|
-
# -
|
91
|
-
# -
|
92
|
-
# -
|
93
|
-
# -
|
94
|
-
# -
|
95
|
-
# -
|
96
|
-
# -
|
97
|
-
# -
|
98
|
-
# -
|
99
|
-
# Additionally
|
100
|
-
# Spacing and punctuation is also permitted with the exception a question mark (
|
101
|
-
# For example,
|
102
|
-
# 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
|
80
|
+
# - `a`
|
81
|
+
# - `d`
|
82
|
+
# - `dd`
|
83
|
+
# - `EEE`
|
84
|
+
# - `EEEE`
|
85
|
+
# - `H`
|
86
|
+
# - `HH`
|
87
|
+
# - `h`
|
88
|
+
# - `M`
|
89
|
+
# - `MM`
|
90
|
+
# - `MMM`
|
91
|
+
# - `MMMM`
|
92
|
+
# - `mm`
|
93
|
+
# - `ss`
|
94
|
+
# - `XX`
|
95
|
+
# - `XXX`
|
96
|
+
# - `yy`
|
97
|
+
# - `yyyy`
|
98
|
+
# - `zzz`
|
99
|
+
# 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 (`:`).
|
100
|
+
# Spacing and punctuation is also permitted with the exception a question mark (`?`), newline, and carriage return, together with literal text enclosed in single quotes.
|
101
|
+
# 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`.
|
102
|
+
# 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.
|
103
103
|
# When the format is semi-structured text, this will result in the structure finder treating the text as single-line messages.
|
104
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
105
|
+
# when they occur.
|
106
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
107
|
+
# returned by Elasticsearch.
|
108
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
109
|
+
# For example `"exists_time": "1h"` for humans and
|
110
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
111
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
112
|
+
# only by machines.
|
113
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
114
|
+
# this option for debugging only.
|
104
115
|
# @option arguments [Hash] :headers Custom HTTP headers
|
105
116
|
#
|
106
|
-
# @see https://www.elastic.co/docs/api/doc/elasticsearch/
|
117
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-text_structure
|
107
118
|
#
|
108
119
|
def find_field_structure(arguments = {})
|
109
120
|
request_opts = { endpoint: arguments[:endpoint] || 'text_structure.find_field_structure' }
|
@@ -34,73 +34,84 @@ module Elasticsearch
|
|
34
34
|
# Appropriate mappings for an Elasticsearch index, which you could use to ingest the text.
|
35
35
|
# All this information can be calculated by the structure finder with no guidance.
|
36
36
|
# However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.
|
37
|
-
# If the structure finder produces unexpected results, specify the
|
37
|
+
# If the structure finder produces unexpected results, specify the `explain` query parameter and an explanation will appear in the response.
|
38
38
|
# It helps determine why the returned structure was chosen.
|
39
39
|
#
|
40
|
-
# @option arguments [String] :column_names If the format is
|
40
|
+
# @option arguments [String] :column_names If the format is `delimited`, you can specify the column names in a comma-separated list.
|
41
41
|
# If this parameter is not specified, the structure finder uses the column names from the header row of the text.
|
42
42
|
# If the text does not have a header role, columns are named "column1", "column2", "column3", for example.
|
43
|
-
# @option arguments [String] :delimiter If you the format is
|
43
|
+
# @option arguments [String] :delimiter If you the format is `delimited`, you can specify the character used to delimit the values in each row.
|
44
44
|
# Only a single character is supported; the delimiter cannot have multiple characters.
|
45
|
-
# By default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (
|
45
|
+
# By default, the API considers the following possibilities: comma, tab, semi-colon, and pipe (`|`).
|
46
46
|
# In this default scenario, all rows must have the same number of fields for the delimited format to be detected.
|
47
47
|
# If you specify a delimiter, up to 10% of the rows can have a different number of columns than the first row.
|
48
48
|
# @option arguments [String] :ecs_compatibility The mode of compatibility with ECS compliant Grok patterns.
|
49
49
|
# Use this parameter to specify whether to use ECS Grok patterns instead of legacy ones when the structure finder creates a Grok pattern.
|
50
|
-
# This setting primarily has an impact when a whole message Grok pattern such as
|
51
|
-
# If the structure finder identifies a common structure but has no idea of meaning then generic field names such as
|
52
|
-
# @option arguments [Boolean] :explain If this parameter is set to true, the response includes a field named
|
50
|
+
# This setting primarily has an impact when a whole message Grok pattern such as `%{CATALINALOG}` matches the input.
|
51
|
+
# 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.
|
52
|
+
# @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.
|
53
53
|
# @option arguments [String] :format The high level structure of the text.
|
54
54
|
# By default, the API chooses the format.
|
55
55
|
# In this default scenario, all rows must have the same number of fields for a delimited format to be detected.
|
56
|
-
# If the format is
|
57
|
-
# @option arguments [String] :grok_pattern If the format is
|
58
|
-
# The name of the timestamp field in the Grok pattern must match what is specified in the
|
56
|
+
# 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.
|
57
|
+
# @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.
|
58
|
+
# The name of the timestamp field in the Grok pattern must match what is specified in the `timestamp_field` parameter.
|
59
59
|
# If that parameter is not specified, the name of the timestamp field in the Grok pattern must match "timestamp".
|
60
|
-
# If
|
61
|
-
# @option arguments [String] :quote If the format is
|
60
|
+
# If `grok_pattern` is not specified, the structure finder creates a Grok pattern.
|
61
|
+
# @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.
|
62
62
|
# Only a single character is supported.
|
63
|
-
# If this parameter is not specified, the default value is a double quote (
|
63
|
+
# If this parameter is not specified, the default value is a double quote (`"`).
|
64
64
|
# 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.
|
65
|
-
# @option arguments [Boolean] :should_trim_fields If the format is
|
66
|
-
# If this parameter is not specified and the delimiter is pipe (
|
67
|
-
# Otherwise, the default value is
|
65
|
+
# @option arguments [Boolean] :should_trim_fields If the format is `delimited`, you can specify whether values between delimiters should have whitespace trimmed from them.
|
66
|
+
# If this parameter is not specified and the delimiter is pipe (`|`), the default value is true.
|
67
|
+
# Otherwise, the default value is `false`.
|
68
68
|
# @option arguments [Time] :timeout The maximum amount of time that the structure analysis can take.
|
69
69
|
# If the analysis is still running when the timeout expires, it will be stopped. Server default: 25s.
|
70
70
|
# @option arguments [String] :timestamp_field The name of the field that contains the primary timestamp of each record in the text.
|
71
|
-
# In particular, if the text was ingested into an index, this is the field that would be used to populate the
|
72
|
-
# Therefore, for semi-structured text, it is best not to specify this parameter unless
|
71
|
+
# 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`.
|
72
|
+
# 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.
|
73
73
|
# For structured text, it is not compulsory to have a timestamp in the text.
|
74
74
|
# @option arguments [String] :timestamp_format The Java time format of the timestamp field in the text.
|
75
75
|
# Only a subset of Java time format letter groups are supported:
|
76
|
-
# -
|
77
|
-
# -
|
78
|
-
# -
|
79
|
-
# -
|
80
|
-
# -
|
81
|
-
# -
|
82
|
-
# -
|
83
|
-
# -
|
84
|
-
# -
|
85
|
-
# -
|
86
|
-
# -
|
87
|
-
# -
|
88
|
-
# -
|
89
|
-
# -
|
90
|
-
# -
|
91
|
-
# -
|
92
|
-
# -
|
93
|
-
# -
|
94
|
-
# -
|
95
|
-
# Additionally
|
96
|
-
# Spacing and punctuation is also permitted with the exception a question mark (
|
97
|
-
# For example,
|
98
|
-
# 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
|
76
|
+
# - `a`
|
77
|
+
# - `d`
|
78
|
+
# - `dd`
|
79
|
+
# - `EEE`
|
80
|
+
# - `EEEE`
|
81
|
+
# - `H`
|
82
|
+
# - `HH`
|
83
|
+
# - `h`
|
84
|
+
# - `M`
|
85
|
+
# - `MM`
|
86
|
+
# - `MMM`
|
87
|
+
# - `MMMM`
|
88
|
+
# - `mm`
|
89
|
+
# - `ss`
|
90
|
+
# - `XX`
|
91
|
+
# - `XXX`
|
92
|
+
# - `yy`
|
93
|
+
# - `yyyy`
|
94
|
+
# - `zzz`
|
95
|
+
# 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 (`:`).
|
96
|
+
# Spacing and punctuation is also permitted with the exception a question mark (`?`), newline, and carriage return, together with literal text enclosed in single quotes.
|
97
|
+
# 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`.
|
98
|
+
# 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.
|
99
99
|
# When the format is semi-structured text, this will result in the structure finder treating the text as single-line messages.
|
100
|
+
# @option arguments [Boolean] :error_trace When set to `true` Elasticsearch will include the full stack trace of errors
|
101
|
+
# when they occur.
|
102
|
+
# @option arguments [String, Array<String>] :filter_path Comma-separated list of filters in dot notation which reduce the response
|
103
|
+
# returned by Elasticsearch.
|
104
|
+
# @option arguments [Boolean] :human When set to `true` will return statistics in a format suitable for humans.
|
105
|
+
# For example `"exists_time": "1h"` for humans and
|
106
|
+
# `"exists_time_in_millis": 3600000` for computers. When disabled the human
|
107
|
+
# readable values will be omitted. This makes sense for responses being consumed
|
108
|
+
# only by machines.
|
109
|
+
# @option arguments [Boolean] :pretty If set to `true` the returned JSON will be "pretty-formatted". Only use
|
110
|
+
# this option for debugging only.
|
100
111
|
# @option arguments [Hash] :headers Custom HTTP headers
|
101
112
|
# @option arguments [Hash] :body request body
|
102
113
|
#
|
103
|
-
# @see https://www.elastic.co/docs/api/doc/elasticsearch/
|
114
|
+
# @see https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-text-structure-find-message-structure
|
104
115
|
#
|
105
116
|
def find_message_structure(arguments = {})
|
106
117
|
request_opts = { endpoint: arguments[:endpoint] || 'text_structure.find_message_structure' }
|