opensearch-ruby 3.4.0 → 4.0.0.pre.beta.2
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
- checksums.yaml.gz.sig +0 -0
- data/lib/opensearch/api/actions/asynchronous_search/delete.rb +36 -0
- data/lib/opensearch/api/actions/asynchronous_search/get.rb +36 -0
- data/lib/opensearch/api/actions/asynchronous_search/search.rb +43 -0
- data/lib/opensearch/api/actions/asynchronous_search/stats.rb +31 -0
- data/lib/opensearch/api/actions/bulk.rb +48 -79
- data/lib/opensearch/api/actions/bulk_stream.rb +64 -0
- data/lib/opensearch/api/actions/cat/aliases.rb +27 -55
- data/lib/opensearch/api/actions/cat/all_pit_segments.rb +23 -22
- data/lib/opensearch/api/actions/cat/allocation.rb +29 -57
- data/lib/opensearch/api/actions/cat/cluster_manager.rb +27 -31
- data/lib/opensearch/api/actions/cat/count.rb +23 -51
- data/lib/opensearch/api/actions/cat/fielddata.rb +25 -53
- data/lib/opensearch/api/actions/cat/health.rb +22 -46
- data/lib/opensearch/api/actions/cat/help.rb +13 -43
- data/lib/opensearch/api/actions/cat/indices.rb +37 -65
- data/lib/opensearch/api/actions/cat/master.rb +27 -50
- data/lib/opensearch/api/actions/cat/nodeattrs.rb +26 -49
- data/lib/opensearch/api/actions/cat/nodes.rb +30 -56
- data/lib/opensearch/api/actions/cat/pending_tasks.rb +28 -52
- data/lib/opensearch/api/actions/cat/pit_segments.rb +24 -25
- data/lib/opensearch/api/actions/cat/plugins.rb +27 -52
- data/lib/opensearch/api/actions/cat/recovery.rb +28 -57
- data/lib/opensearch/api/actions/cat/repositories.rb +27 -50
- data/lib/opensearch/api/actions/cat/segment_replication.rb +70 -0
- data/lib/opensearch/api/actions/cat/segments.rb +28 -51
- data/lib/opensearch/api/actions/cat/shards.rb +31 -59
- data/lib/opensearch/api/actions/cat/snapshots.rb +31 -56
- data/lib/opensearch/api/actions/cat/tasks.rb +29 -52
- data/lib/opensearch/api/actions/cat/templates.rb +29 -56
- data/lib/opensearch/api/actions/cat/thread_pool.rb +31 -59
- data/lib/opensearch/api/actions/clear_scroll.rb +21 -48
- data/lib/opensearch/api/actions/cluster/allocation_explain.rb +20 -48
- data/lib/opensearch/api/actions/cluster/delete_component_template.rb +24 -47
- data/lib/opensearch/api/actions/cluster/delete_decommission_awareness.rb +31 -0
- data/lib/opensearch/api/actions/cluster/delete_voting_config_exclusions.rb +18 -41
- data/lib/opensearch/api/actions/cluster/delete_weighted_routing.rb +32 -0
- data/lib/opensearch/api/actions/cluster/exists_component_template.rb +26 -51
- data/lib/opensearch/api/actions/cluster/get_component_template.rb +24 -49
- data/lib/opensearch/api/actions/cluster/get_decommission_awareness.rb +36 -0
- data/lib/opensearch/api/actions/cluster/get_settings.rb +22 -45
- data/lib/opensearch/api/actions/cluster/get_weighted_routing.rb +36 -0
- data/lib/opensearch/api/actions/cluster/health.rb +34 -59
- data/lib/opensearch/api/actions/cluster/pending_tasks.rb +21 -44
- data/lib/opensearch/api/actions/cluster/post_voting_config_exclusions.rb +19 -42
- data/lib/opensearch/api/actions/cluster/put_component_template.rb +27 -50
- data/lib/opensearch/api/actions/cluster/put_decommission_awareness.rb +39 -0
- data/lib/opensearch/api/actions/cluster/put_settings.rb +22 -45
- data/lib/opensearch/api/actions/cluster/put_weighted_routing.rb +37 -0
- data/lib/opensearch/api/actions/cluster/remote_info.rb +13 -33
- data/lib/opensearch/api/actions/cluster/reroute.rb +26 -49
- data/lib/opensearch/api/actions/cluster/state.rb +34 -64
- data/lib/opensearch/api/actions/cluster/stats.rb +24 -47
- data/lib/opensearch/api/actions/count.rb +51 -81
- data/lib/opensearch/api/actions/create.rb +46 -47
- data/lib/opensearch/api/actions/create_pit.rb +34 -30
- data/lib/opensearch/api/actions/dangling_indices/delete_dangling_index.rb +26 -48
- data/lib/opensearch/api/actions/dangling_indices/import_dangling_index.rb +26 -47
- data/lib/opensearch/api/actions/dangling_indices/list_dangling_indices.rb +14 -34
- data/lib/opensearch/api/actions/delete.rb +45 -76
- data/lib/opensearch/api/actions/delete_all_pits.rb +18 -13
- data/lib/opensearch/api/actions/delete_by_query.rb +91 -117
- data/lib/opensearch/api/actions/delete_by_query_rethrottle.rb +25 -46
- data/lib/opensearch/api/actions/delete_pit.rb +19 -17
- data/lib/opensearch/api/actions/delete_script.rb +29 -50
- data/lib/opensearch/api/actions/exists.rb +49 -81
- data/lib/opensearch/api/actions/exists_source.rb +48 -77
- data/lib/opensearch/api/actions/explain.rb +51 -83
- data/lib/opensearch/api/actions/field_caps.rb +33 -63
- data/lib/opensearch/api/actions/flow_framework/create.rb +45 -0
- data/lib/opensearch/api/actions/flow_framework/delete.rb +41 -0
- data/lib/opensearch/api/actions/flow_framework/deprovision.rb +41 -0
- data/lib/opensearch/api/actions/flow_framework/get.rb +36 -0
- data/lib/opensearch/api/actions/flow_framework/get_status.rb +41 -0
- data/lib/opensearch/api/actions/flow_framework/get_steps.rb +36 -0
- data/lib/opensearch/api/actions/flow_framework/provision.rb +37 -0
- data/lib/opensearch/api/actions/flow_framework/search.rb +34 -0
- data/lib/opensearch/api/actions/flow_framework/search_state.rb +34 -0
- data/lib/opensearch/api/actions/flow_framework/update.rb +50 -0
- data/lib/opensearch/api/actions/get.rb +49 -80
- data/lib/opensearch/api/actions/get_all_pits.rb +18 -13
- data/lib/opensearch/api/actions/get_script.rb +27 -48
- data/lib/opensearch/api/actions/get_script_context.rb +18 -40
- data/lib/opensearch/api/actions/get_script_languages.rb +18 -40
- data/lib/opensearch/api/actions/get_source.rb +48 -75
- data/lib/opensearch/api/actions/index.rb +49 -80
- data/lib/opensearch/api/actions/indices/add_block.rb +34 -58
- data/lib/opensearch/api/actions/indices/analyze.rb +16 -52
- data/lib/opensearch/api/actions/indices/clear_cache.rb +30 -56
- data/lib/opensearch/api/actions/indices/clone.rb +36 -56
- data/lib/opensearch/api/actions/indices/close.rb +29 -52
- data/lib/opensearch/api/actions/indices/create.rb +26 -49
- data/lib/opensearch/api/actions/indices/create_data_stream.rb +37 -0
- data/lib/opensearch/api/actions/indices/data_streams_stats.rb +34 -0
- data/lib/opensearch/api/actions/indices/delete.rb +28 -55
- data/lib/opensearch/api/actions/indices/delete_alias.rb +29 -53
- data/lib/opensearch/api/actions/indices/delete_data_stream.rb +36 -0
- data/lib/opensearch/api/actions/indices/delete_index_template.rb +23 -46
- data/lib/opensearch/api/actions/indices/delete_template.rb +23 -50
- data/lib/opensearch/api/actions/indices/exists.rb +31 -57
- data/lib/opensearch/api/actions/indices/exists_alias.rb +28 -61
- data/lib/opensearch/api/actions/indices/exists_index_template.rb +27 -52
- data/lib/opensearch/api/actions/indices/exists_template.rb +27 -55
- data/lib/opensearch/api/actions/indices/flush.rb +26 -53
- data/lib/opensearch/api/actions/indices/forcemerge.rb +30 -53
- data/lib/opensearch/api/actions/indices/get.rb +30 -53
- data/lib/opensearch/api/actions/indices/get_alias.rb +24 -56
- data/lib/opensearch/api/actions/indices/get_data_stream.rb +34 -0
- data/lib/opensearch/api/actions/indices/get_field_mapping.rb +27 -59
- data/lib/opensearch/api/actions/indices/get_index_template.rb +23 -50
- data/lib/opensearch/api/actions/indices/get_mapping.rb +27 -59
- data/lib/opensearch/api/actions/indices/get_settings.rb +32 -64
- data/lib/opensearch/api/actions/indices/get_template.rb +23 -50
- data/lib/opensearch/api/actions/indices/get_upgrade.rb +22 -54
- data/lib/opensearch/api/actions/indices/open.rb +33 -52
- data/lib/opensearch/api/actions/indices/put_alias.rb +27 -54
- data/lib/opensearch/api/actions/indices/put_index_template.rb +26 -49
- data/lib/opensearch/api/actions/indices/put_mapping.rb +31 -58
- data/lib/opensearch/api/actions/indices/put_settings.rb +32 -59
- data/lib/opensearch/api/actions/indices/put_template.rb +26 -49
- data/lib/opensearch/api/actions/indices/recovery.rb +20 -47
- data/lib/opensearch/api/actions/indices/refresh.rb +22 -49
- data/lib/opensearch/api/actions/indices/resolve_index.rb +21 -48
- data/lib/opensearch/api/actions/indices/rollover.rb +31 -59
- data/lib/opensearch/api/actions/indices/segments.rb +22 -49
- data/lib/opensearch/api/actions/indices/shard_stores.rb +24 -51
- data/lib/opensearch/api/actions/indices/shrink.rb +36 -56
- data/lib/opensearch/api/actions/indices/simulate_index_template.rb +23 -50
- data/lib/opensearch/api/actions/indices/simulate_template.rb +25 -52
- data/lib/opensearch/api/actions/indices/split.rb +36 -56
- data/lib/opensearch/api/actions/indices/stats.rb +31 -74
- data/lib/opensearch/api/actions/indices/update_aliases.rb +22 -45
- data/lib/opensearch/api/actions/indices/upgrade.rb +24 -56
- data/lib/opensearch/api/actions/indices/validate_query.rb +36 -73
- data/lib/opensearch/api/actions/info.rb +18 -36
- data/lib/opensearch/api/actions/ingest/delete_pipeline.rb +22 -45
- data/lib/opensearch/api/actions/ingest/get_pipeline.rb +20 -49
- data/lib/opensearch/api/actions/ingest/processor_grok.rb +18 -33
- data/lib/opensearch/api/actions/ingest/put_pipeline.rb +24 -47
- data/lib/opensearch/api/actions/ingest/simulate.rb +21 -48
- data/lib/opensearch/api/actions/insights/top_queries.rb +38 -0
- data/lib/opensearch/api/actions/ism/add_policy.rb +37 -0
- data/lib/opensearch/api/actions/ism/change_policy.rb +37 -0
- data/lib/opensearch/api/actions/ism/delete_policy.rb +36 -0
- data/lib/opensearch/api/actions/ism/exists_policy.rb +36 -0
- data/lib/opensearch/api/actions/ism/explain_policy.rb +35 -0
- data/lib/opensearch/api/actions/ism/get_policies.rb +31 -0
- data/lib/opensearch/api/actions/ism/get_policy.rb +36 -0
- data/lib/opensearch/api/actions/ism/put_policies.rb +43 -0
- data/lib/opensearch/api/actions/ism/put_policy.rb +44 -0
- data/lib/opensearch/api/actions/ism/refresh_search_analyzers.rb +36 -0
- data/lib/opensearch/api/actions/ism/remove_policy.rb +36 -0
- data/lib/opensearch/api/actions/ism/retry_index.rb +37 -0
- data/lib/opensearch/api/actions/knn/delete_model.rb +36 -0
- data/lib/opensearch/api/actions/knn/get_model.rb +36 -0
- data/lib/opensearch/api/actions/knn/search_models.rb +119 -0
- data/lib/opensearch/api/actions/knn/stats.rb +41 -0
- data/lib/opensearch/api/actions/knn/train_model.rb +40 -0
- data/lib/opensearch/api/actions/knn/warmup.rb +36 -0
- data/lib/opensearch/api/actions/list/help.rb +31 -0
- data/lib/opensearch/api/actions/list/indices.rb +71 -0
- data/lib/opensearch/api/actions/list/shards.rb +63 -0
- data/lib/opensearch/api/actions/mget.rb +40 -70
- data/lib/opensearch/api/actions/ml/chunk_model.rb +40 -0
- data/lib/opensearch/api/actions/ml/create_connector.rb +32 -0
- data/lib/opensearch/api/actions/ml/create_controller.rb +37 -0
- data/lib/opensearch/api/actions/ml/create_memory.rb +32 -0
- data/lib/opensearch/api/actions/ml/create_message.rb +37 -0
- data/lib/opensearch/api/actions/ml/create_model_meta.rb +32 -0
- data/lib/opensearch/api/actions/ml/delete_agent.rb +36 -0
- data/lib/opensearch/api/actions/ml/delete_connector.rb +36 -0
- data/lib/opensearch/api/actions/ml/delete_controller.rb +36 -0
- data/lib/opensearch/api/actions/ml/delete_memory.rb +36 -0
- data/lib/opensearch/api/actions/ml/delete_model.rb +36 -0
- data/lib/opensearch/api/actions/ml/delete_model_group.rb +36 -0
- data/lib/opensearch/api/actions/ml/delete_task.rb +36 -0
- data/lib/opensearch/api/actions/ml/deploy_model.rb +36 -0
- data/lib/opensearch/api/actions/ml/execute_agent.rb +37 -0
- data/lib/opensearch/api/actions/ml/execute_algorithm.rb +37 -0
- data/lib/opensearch/api/actions/ml/get_agent.rb +36 -0
- data/lib/opensearch/api/actions/ml/get_all_memories.rb +38 -0
- data/lib/opensearch/api/actions/ml/get_all_messages.rb +43 -0
- data/lib/opensearch/api/actions/ml/get_all_tools.rb +31 -0
- data/lib/opensearch/api/actions/ml/get_connector.rb +36 -0
- data/lib/opensearch/api/actions/ml/get_controller.rb +36 -0
- data/lib/opensearch/api/actions/ml/get_memory.rb +36 -0
- data/lib/opensearch/api/actions/ml/get_message.rb +36 -0
- data/lib/opensearch/api/actions/ml/get_message_traces.rb +43 -0
- data/lib/opensearch/api/actions/ml/get_model.rb +36 -0
- data/lib/opensearch/api/actions/ml/get_model_group.rb +36 -0
- data/lib/opensearch/api/actions/ml/get_profile.rb +32 -0
- data/lib/opensearch/api/actions/ml/get_profile_models.rb +35 -0
- data/lib/opensearch/api/actions/ml/get_profile_tasks.rb +35 -0
- data/lib/opensearch/api/actions/ml/get_stats.rb +36 -0
- data/lib/opensearch/api/actions/ml/get_task.rb +36 -0
- data/lib/opensearch/api/actions/ml/get_tool.rb +36 -0
- data/lib/opensearch/api/actions/ml/load_model.rb +36 -0
- data/lib/opensearch/api/actions/ml/predict.rb +40 -0
- data/lib/opensearch/api/actions/ml/predict_model.rb +37 -0
- data/lib/opensearch/api/actions/ml/register_agents.rb +32 -0
- data/lib/opensearch/api/actions/ml/register_model.rb +32 -0
- data/lib/opensearch/api/actions/ml/register_model_group.rb +32 -0
- data/lib/opensearch/api/actions/ml/register_model_meta.rb +32 -0
- data/lib/opensearch/api/actions/ml/search_agents.rb +32 -0
- data/lib/opensearch/api/actions/ml/search_connectors.rb +32 -0
- data/lib/opensearch/api/actions/ml/search_memory.rb +32 -0
- data/lib/opensearch/api/actions/ml/search_message.rb +37 -0
- data/lib/opensearch/api/actions/ml/search_model_group.rb +32 -0
- data/lib/opensearch/api/actions/ml/search_models.rb +32 -0
- data/lib/opensearch/api/actions/ml/search_tasks.rb +32 -0
- data/lib/opensearch/api/actions/ml/train.rb +37 -0
- data/lib/opensearch/api/actions/ml/train_predict.rb +37 -0
- data/lib/opensearch/api/actions/ml/undeploy_model.rb +35 -0
- data/lib/opensearch/api/actions/ml/unload_model.rb +35 -0
- data/lib/opensearch/api/actions/ml/update_connector.rb +37 -0
- data/lib/opensearch/api/actions/ml/update_controller.rb +37 -0
- data/lib/opensearch/api/actions/ml/update_memory.rb +37 -0
- data/lib/opensearch/api/actions/ml/update_message.rb +37 -0
- data/lib/opensearch/api/actions/ml/update_model.rb +37 -0
- data/lib/opensearch/api/actions/ml/update_model_group.rb +37 -0
- data/lib/opensearch/api/actions/ml/upload_chunk.rb +40 -0
- data/lib/opensearch/api/actions/ml/upload_model.rb +32 -0
- data/lib/opensearch/api/actions/msearch.rb +40 -91
- data/lib/opensearch/api/actions/msearch_template.rb +36 -75
- data/lib/opensearch/api/actions/mtermvectors.rb +47 -87
- data/lib/opensearch/api/actions/nodes/hot_threads.rb +25 -57
- data/lib/opensearch/api/actions/nodes/info.rb +23 -53
- data/lib/opensearch/api/actions/nodes/reload_secure_settings.rb +20 -47
- data/lib/opensearch/api/actions/nodes/stats.rb +33 -72
- data/lib/opensearch/api/actions/nodes/usage.rb +21 -53
- data/lib/opensearch/api/actions/notifications/create_config.rb +34 -0
- data/lib/opensearch/api/actions/notifications/delete_config.rb +36 -0
- data/lib/opensearch/api/actions/notifications/delete_configs.rb +40 -0
- data/lib/opensearch/api/actions/notifications/get_config.rb +36 -0
- data/lib/opensearch/api/actions/notifications/get_configs.rb +115 -0
- data/lib/opensearch/api/actions/notifications/list_channels.rb +31 -0
- data/lib/opensearch/api/actions/notifications/list_features.rb +31 -0
- data/lib/opensearch/api/actions/notifications/send_test.rb +36 -0
- data/lib/opensearch/api/actions/notifications/update_config.rb +38 -0
- data/lib/opensearch/api/actions/observability/create_object.rb +32 -0
- data/lib/opensearch/api/actions/observability/delete_object.rb +36 -0
- data/lib/opensearch/api/actions/observability/delete_objects.rb +38 -0
- data/lib/opensearch/api/actions/observability/get_localstats.rb +31 -0
- data/lib/opensearch/api/actions/observability/get_object.rb +36 -0
- data/lib/opensearch/api/actions/observability/list_objects.rb +31 -0
- data/lib/opensearch/api/actions/observability/update_object.rb +37 -0
- data/lib/opensearch/api/actions/ping.rb +17 -40
- data/lib/opensearch/api/actions/ppl/explain.rb +41 -0
- data/lib/opensearch/api/actions/ppl/get_stats.rb +38 -0
- data/lib/opensearch/api/actions/ppl/post_stats.rb +41 -0
- data/lib/opensearch/api/actions/ppl/query.rb +41 -0
- data/lib/opensearch/api/actions/put_script.rb +37 -64
- data/lib/opensearch/api/actions/query/datasource_delete.rb +36 -0
- data/lib/opensearch/api/actions/query/datasource_retrieve.rb +36 -0
- data/lib/opensearch/api/actions/query/datasources_create.rb +32 -0
- data/lib/opensearch/api/actions/query/datasources_list.rb +31 -0
- data/lib/opensearch/api/actions/query/datasources_update.rb +32 -0
- data/lib/opensearch/api/actions/rank_eval.rb +32 -61
- data/lib/opensearch/api/actions/reindex.rb +42 -61
- data/lib/opensearch/api/actions/reindex_rethrottle.rb +25 -46
- data/lib/opensearch/api/actions/remote_store/restore.rb +19 -21
- data/lib/opensearch/api/actions/render_search_template.rb +21 -48
- data/lib/opensearch/api/actions/replication/autofollow_stats.rb +31 -0
- data/lib/opensearch/api/actions/replication/create_replication_rule.rb +34 -0
- data/lib/opensearch/api/actions/replication/delete_replication_rule.rb +34 -0
- data/lib/opensearch/api/actions/replication/follower_stats.rb +31 -0
- data/lib/opensearch/api/actions/replication/leader_stats.rb +31 -0
- data/lib/opensearch/api/actions/replication/pause.rb +38 -0
- data/lib/opensearch/api/actions/replication/resume.rb +38 -0
- data/lib/opensearch/api/actions/replication/start.rb +38 -0
- data/lib/opensearch/api/actions/replication/status.rb +36 -0
- data/lib/opensearch/api/actions/replication/stop.rb +38 -0
- data/lib/opensearch/api/actions/replication/update_settings.rb +38 -0
- data/lib/opensearch/api/actions/rollups/delete.rb +36 -0
- data/lib/opensearch/api/actions/rollups/explain.rb +36 -0
- data/lib/opensearch/api/actions/rollups/get.rb +36 -0
- data/lib/opensearch/api/actions/rollups/put.rb +44 -0
- data/lib/opensearch/api/actions/rollups/start.rb +36 -0
- data/lib/opensearch/api/actions/rollups/stop.rb +36 -0
- data/lib/opensearch/api/actions/scripts_painless_execute.rb +19 -46
- data/lib/opensearch/api/actions/scroll.rb +27 -63
- data/lib/opensearch/api/actions/search.rb +115 -146
- data/lib/opensearch/api/actions/search_pipeline/delete.rb +43 -0
- data/lib/opensearch/api/actions/search_pipeline/get.rb +39 -0
- data/lib/opensearch/api/actions/search_pipeline/put.rb +45 -0
- data/lib/opensearch/api/actions/search_shards.rb +34 -59
- data/lib/opensearch/api/actions/search_template.rb +50 -80
- data/lib/opensearch/api/actions/security/authinfo.rb +38 -0
- data/lib/opensearch/api/actions/security/authtoken.rb +31 -0
- data/lib/opensearch/api/actions/security/change_password.rb +12 -17
- data/lib/opensearch/api/actions/security/config_upgrade_check.rb +31 -0
- data/lib/opensearch/api/actions/security/config_upgrade_perform.rb +32 -0
- data/lib/opensearch/api/actions/security/create_action_group.rb +15 -19
- data/lib/opensearch/api/actions/security/create_allowlist.rb +34 -0
- data/lib/opensearch/api/actions/security/create_role.rb +15 -20
- data/lib/opensearch/api/actions/security/create_role_mapping.rb +15 -20
- data/lib/opensearch/api/actions/security/create_tenant.rb +15 -19
- data/lib/opensearch/api/actions/security/create_update_tenancy_config.rb +34 -0
- data/lib/opensearch/api/actions/security/create_user.rb +15 -20
- data/lib/opensearch/api/actions/security/create_user_legacy.rb +38 -0
- data/lib/opensearch/api/actions/security/delete_action_group.rb +14 -19
- data/lib/opensearch/api/actions/security/delete_distinguished_name.rb +36 -0
- data/lib/opensearch/api/actions/security/delete_role.rb +14 -19
- data/lib/opensearch/api/actions/security/delete_role_mapping.rb +13 -18
- data/lib/opensearch/api/actions/security/delete_tenant.rb +14 -19
- data/lib/opensearch/api/actions/security/delete_user.rb +14 -19
- data/lib/opensearch/api/actions/security/delete_user_legacy.rb +36 -0
- data/lib/opensearch/api/actions/security/flush_cache.rb +11 -16
- data/lib/opensearch/api/actions/security/generate_obo_token.rb +34 -0
- data/lib/opensearch/api/actions/security/generate_user_token.rb +36 -0
- data/lib/opensearch/api/actions/security/generate_user_token_legacy.rb +36 -0
- data/lib/opensearch/api/actions/security/get_account_details.rb +11 -16
- data/lib/opensearch/api/actions/security/get_action_group.rb +13 -18
- data/lib/opensearch/api/actions/security/get_action_groups.rb +10 -15
- data/lib/opensearch/api/actions/security/get_all_certificates.rb +38 -0
- data/lib/opensearch/api/actions/security/get_allowlist.rb +31 -0
- data/lib/opensearch/api/actions/security/get_audit_configuration.rb +10 -15
- data/lib/opensearch/api/actions/security/get_certificates.rb +11 -16
- data/lib/opensearch/api/actions/security/get_configuration.rb +11 -16
- data/lib/opensearch/api/actions/security/get_dashboards_info.rb +31 -0
- data/lib/opensearch/api/actions/security/get_distinguished_name.rb +41 -0
- data/lib/opensearch/api/actions/security/get_distinguished_names.rb +16 -19
- data/lib/opensearch/api/actions/security/get_node_certificates.rb +43 -0
- data/lib/opensearch/api/actions/security/get_permissions_info.rb +31 -0
- data/lib/opensearch/api/actions/security/get_role.rb +13 -18
- data/lib/opensearch/api/actions/security/get_role_mapping.rb +14 -19
- data/lib/opensearch/api/actions/security/get_role_mappings.rb +10 -15
- data/lib/opensearch/api/actions/security/get_roles.rb +10 -15
- data/lib/opensearch/api/actions/security/get_sslinfo.rb +36 -0
- data/lib/opensearch/api/actions/security/get_tenancy_config.rb +31 -0
- data/lib/opensearch/api/actions/security/get_tenant.rb +14 -19
- data/lib/opensearch/api/actions/security/get_tenants.rb +10 -15
- data/lib/opensearch/api/actions/security/get_user.rb +14 -19
- data/lib/opensearch/api/actions/security/get_user_legacy.rb +36 -0
- data/lib/opensearch/api/actions/security/get_users.rb +10 -15
- data/lib/opensearch/api/actions/security/get_users_legacy.rb +31 -0
- data/lib/opensearch/api/actions/security/health.rb +16 -16
- data/lib/opensearch/api/actions/security/migrate.rb +31 -0
- data/lib/opensearch/api/actions/security/patch_action_group.rb +16 -20
- data/lib/opensearch/api/actions/security/patch_action_groups.rb +14 -17
- data/lib/opensearch/api/actions/security/patch_allowlist.rb +34 -0
- data/lib/opensearch/api/actions/security/patch_audit_configuration.rb +13 -18
- data/lib/opensearch/api/actions/security/patch_configuration.rb +13 -18
- data/lib/opensearch/api/actions/security/patch_distinguished_name.rb +37 -0
- data/lib/opensearch/api/actions/security/patch_distinguished_names.rb +13 -18
- data/lib/opensearch/api/actions/security/patch_role.rb +16 -21
- data/lib/opensearch/api/actions/security/patch_role_mapping.rb +16 -21
- data/lib/opensearch/api/actions/security/patch_role_mappings.rb +13 -18
- data/lib/opensearch/api/actions/security/patch_roles.rb +12 -17
- data/lib/opensearch/api/actions/security/patch_tenant.rb +16 -21
- data/lib/opensearch/api/actions/security/patch_tenants.rb +13 -18
- data/lib/opensearch/api/actions/security/patch_user.rb +16 -21
- data/lib/opensearch/api/actions/security/patch_users.rb +13 -18
- data/lib/opensearch/api/actions/security/post_dashboards_info.rb +31 -0
- data/lib/opensearch/api/actions/security/reload_http_certificates.rb +11 -16
- data/lib/opensearch/api/actions/security/reload_transport_certificates.rb +11 -16
- data/lib/opensearch/api/actions/security/tenant_info.rb +31 -0
- data/lib/opensearch/api/actions/security/update_audit_configuration.rb +12 -17
- data/lib/opensearch/api/actions/security/update_configuration.rb +13 -18
- data/lib/opensearch/api/actions/security/update_distinguished_name.rb +37 -0
- data/lib/opensearch/api/actions/security/validate.rb +36 -0
- data/lib/opensearch/api/actions/security/who_am_i.rb +31 -0
- data/lib/opensearch/api/actions/security/who_am_i_protected.rb +31 -0
- data/lib/opensearch/api/actions/sm/create_policy.rb +37 -0
- data/lib/opensearch/api/actions/sm/delete_policy.rb +36 -0
- data/lib/opensearch/api/actions/sm/explain_policy.rb +36 -0
- data/lib/opensearch/api/actions/sm/get_policies.rb +44 -0
- data/lib/opensearch/api/actions/sm/get_policy.rb +36 -0
- data/lib/opensearch/api/actions/sm/start_policy.rb +36 -0
- data/lib/opensearch/api/actions/sm/stop_policy.rb +36 -0
- data/lib/opensearch/api/actions/sm/update_policy.rb +46 -0
- data/lib/opensearch/api/actions/snapshot/cleanup_repository.rb +22 -45
- data/lib/opensearch/api/actions/snapshot/clone.rb +33 -58
- data/lib/opensearch/api/actions/snapshot/create.rb +29 -53
- data/lib/opensearch/api/actions/snapshot/create_repository.rb +25 -48
- data/lib/opensearch/api/actions/snapshot/delete.rb +27 -55
- data/lib/opensearch/api/actions/snapshot/delete_repository.rb +22 -49
- data/lib/opensearch/api/actions/snapshot/get.rb +29 -61
- data/lib/opensearch/api/actions/snapshot/get_repository.rb +21 -51
- data/lib/opensearch/api/actions/snapshot/restore.rb +29 -53
- data/lib/opensearch/api/actions/snapshot/status.rb +23 -57
- data/lib/opensearch/api/actions/snapshot/verify_repository.rb +22 -45
- data/lib/opensearch/api/actions/sql/close.rb +39 -0
- data/lib/opensearch/api/actions/sql/explain.rb +39 -0
- data/lib/opensearch/api/actions/sql/get_stats.rb +38 -0
- data/lib/opensearch/api/actions/sql/post_stats.rb +39 -0
- data/lib/opensearch/api/actions/sql/query.rb +39 -0
- data/lib/opensearch/api/actions/sql/settings.rb +37 -0
- data/lib/opensearch/api/actions/tasks/cancel.rb +22 -53
- data/lib/opensearch/api/actions/tasks/get.rb +21 -46
- data/lib/opensearch/api/actions/tasks/list.rb +25 -52
- data/lib/opensearch/api/actions/termvectors.rb +48 -92
- data/lib/opensearch/api/actions/transforms/delete.rb +36 -0
- data/lib/opensearch/api/actions/transforms/explain.rb +36 -0
- data/lib/opensearch/api/actions/transforms/get.rb +36 -0
- data/lib/opensearch/api/actions/transforms/preview.rb +32 -0
- data/lib/opensearch/api/actions/transforms/put.rb +44 -0
- data/lib/opensearch/api/actions/transforms/search.rb +44 -0
- data/lib/opensearch/api/actions/transforms/start.rb +36 -0
- data/lib/opensearch/api/actions/transforms/stop.rb +36 -0
- data/lib/opensearch/api/actions/update.rb +52 -83
- data/lib/opensearch/api/actions/update_by_query.rb +93 -121
- data/lib/opensearch/api/actions/update_by_query_rethrottle.rb +25 -46
- data/lib/opensearch/api/actions/wlm/create_query_group.rb +34 -0
- data/lib/opensearch/api/actions/wlm/delete_query_group.rb +36 -0
- data/lib/opensearch/api/actions/wlm/get_query_group.rb +34 -0
- data/lib/opensearch/api/actions/wlm/update_query_group.rb +38 -0
- data/lib/opensearch/api/http.rb +94 -0
- data/lib/opensearch/api/namespace.rb +23 -0
- data/lib/opensearch/api/utils.rb +41 -236
- data/lib/opensearch/api.rb +10 -82
- data/lib/opensearch/dsl/search.rb +2 -2
- data/lib/opensearch/dsl.rb +3 -3
- data/lib/opensearch/transport/client.rb +30 -2
- data/lib/opensearch/transport/transport/base.rb +3 -8
- data/lib/opensearch/transport/transport/http/faraday.rb +3 -1
- data/lib/opensearch/version.rb +1 -1
- data/lib/opensearch.rb +106 -68
- data/opensearch-ruby.gemspec +2 -1
- data/spec/spec_helper.rb +3 -18
- data/test/transport/unit/transport_base_test.rb +0 -26
- data.tar.gz.sig +0 -0
- metadata +240 -67
- metadata.gz.sig +0 -0
- data/lib/opensearch/api/actions/abort_benchmark.rb +0 -49
- data/lib/opensearch/api/actions/benchmark.rb +0 -88
- data/lib/opensearch/api/actions/cat/params_registry.rb +0 -69
- data/lib/opensearch/api/actions/cluster/params_registry.rb +0 -69
- data/lib/opensearch/api/actions/dangling_indices/params_registry.rb +0 -69
- data/lib/opensearch/api/actions/features/get_features.rb +0 -61
- data/lib/opensearch/api/actions/features/params_registry.rb +0 -69
- data/lib/opensearch/api/actions/features/reset_features.rb +0 -55
- data/lib/opensearch/api/actions/http/connect.rb +0 -28
- data/lib/opensearch/api/actions/http/delete.rb +0 -28
- data/lib/opensearch/api/actions/http/get.rb +0 -28
- data/lib/opensearch/api/actions/http/head.rb +0 -28
- data/lib/opensearch/api/actions/http/options.rb +0 -28
- data/lib/opensearch/api/actions/http/patch.rb +0 -28
- data/lib/opensearch/api/actions/http/post.rb +0 -28
- data/lib/opensearch/api/actions/http/put.rb +0 -28
- data/lib/opensearch/api/actions/http/request.rb +0 -27
- data/lib/opensearch/api/actions/http/trace.rb +0 -28
- data/lib/opensearch/api/actions/indices/disk_usage.rb +0 -76
- data/lib/opensearch/api/actions/indices/field_usage_stats.rb +0 -74
- data/lib/opensearch/api/actions/indices/params_registry.rb +0 -69
- data/lib/opensearch/api/actions/ingest/geo_ip_stats.rb +0 -51
- data/lib/opensearch/api/actions/ingest/params_registry.rb +0 -69
- data/lib/opensearch/api/actions/nodes/params_registry.rb +0 -69
- data/lib/opensearch/api/actions/nodes/shutdown.rb +0 -65
- data/lib/opensearch/api/actions/params_registry.rb +0 -67
- data/lib/opensearch/api/actions/remote/info.rb +0 -45
- data/lib/opensearch/api/actions/security/delete_distinguished_names.rb +0 -41
- data/lib/opensearch/api/actions/security/update_distinguished_names.rb +0 -42
- data/lib/opensearch/api/actions/shutdown/delete_node.rb +0 -60
- data/lib/opensearch/api/actions/shutdown/get_node.rb +0 -62
- data/lib/opensearch/api/actions/shutdown/params_registry.rb +0 -69
- data/lib/opensearch/api/actions/shutdown/put_node.rb +0 -62
- data/lib/opensearch/api/actions/snapshot/get_features.rb +0 -61
- data/lib/opensearch/api/actions/snapshot/params_registry.rb +0 -69
- data/lib/opensearch/api/actions/snapshot/repository_analyze.rb +0 -84
- data/lib/opensearch/api/actions/tasks/params_registry.rb +0 -69
- data/lib/opensearch/api/namespace/cat.rb +0 -47
- data/lib/opensearch/api/namespace/cluster.rb +0 -47
- data/lib/opensearch/api/namespace/common.rb +0 -72
- data/lib/opensearch/api/namespace/dangling_indices.rb +0 -47
- data/lib/opensearch/api/namespace/features.rb +0 -47
- data/lib/opensearch/api/namespace/http.rb +0 -30
- data/lib/opensearch/api/namespace/indices.rb +0 -47
- data/lib/opensearch/api/namespace/ingest.rb +0 -47
- data/lib/opensearch/api/namespace/nodes.rb +0 -47
- data/lib/opensearch/api/namespace/remote.rb +0 -47
- data/lib/opensearch/api/namespace/remote_store.rb +0 -30
- data/lib/opensearch/api/namespace/security.rb +0 -30
- data/lib/opensearch/api/namespace/shutdown.rb +0 -47
- data/lib/opensearch/api/namespace/snapshot.rb +0 -47
- data/lib/opensearch/api/namespace/tasks.rb +0 -47
@@ -3,26 +3,11 @@
|
|
3
3
|
# The OpenSearch Contributors require contributions made to
|
4
4
|
# this file be licensed under the Apache-2.0 license or a
|
5
5
|
# compatible open source license.
|
6
|
-
|
7
|
-
#
|
8
|
-
#
|
9
|
-
|
10
|
-
#
|
11
|
-
# license agreements. See the NOTICE file distributed with
|
12
|
-
# this work for additional information regarding copyright
|
13
|
-
# ownership. Elasticsearch B.V. licenses this file to you under
|
14
|
-
# the Apache License, Version 2.0 (the "License"); you may
|
15
|
-
# not use this file except in compliance with the License.
|
16
|
-
# You may obtain a copy of the License at
|
17
|
-
#
|
18
|
-
# http://www.apache.org/licenses/LICENSE-2.0
|
19
|
-
#
|
20
|
-
# Unless required by applicable law or agreed to in writing,
|
21
|
-
# software distributed under the License is distributed on an
|
22
|
-
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
23
|
-
# KIND, either express or implied. See the License for the
|
24
|
-
# specific language governing permissions and limitations
|
25
|
-
# under the License.
|
6
|
+
|
7
|
+
# This file is generated from the OpenSearch REST API spec.
|
8
|
+
# Do not modify it by hand. Instead, modify the generator or the spec.
|
9
|
+
|
10
|
+
# frozen_string_literal: true
|
26
11
|
|
27
12
|
module OpenSearch
|
28
13
|
module API
|
@@ -30,42 +15,30 @@ module OpenSearch
|
|
30
15
|
module Actions
|
31
16
|
# Returns an index template.
|
32
17
|
#
|
33
|
-
# @option
|
34
|
-
# @option
|
35
|
-
# @option
|
36
|
-
# @option
|
37
|
-
# @option
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
def get_index_template(arguments = {})
|
42
|
-
headers = arguments.delete(:headers) || {}
|
18
|
+
# @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
|
19
|
+
# @option args [Boolean] :flat_settings If `true`, returns settings in flat format.
|
20
|
+
# @option args [Boolean] :local If `true`, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the cluster-manager node.
|
21
|
+
# @option args [String] :master_timeout DEPRECATED Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.
|
22
|
+
# @option args [String] :name Name of the index template to retrieve. Wildcard (*) expressions are supported.
|
23
|
+
def get_index_template(args = {})
|
24
|
+
args = Utils.clone_and_normalize_arguments(args)
|
25
|
+
_name = args.delete('name')
|
43
26
|
|
44
|
-
|
27
|
+
headers = args.delete('headers') || {}
|
28
|
+
body = args.delete('body')
|
29
|
+
method = 'GET'
|
30
|
+
url = Utils.build_url('_index_template', _name)
|
45
31
|
|
46
|
-
|
47
|
-
|
48
|
-
method = OpenSearch::API::HTTP_GET
|
49
|
-
path = if _name
|
50
|
-
"_index_template/#{Utils.__listify(_name)}"
|
51
|
-
else
|
52
|
-
'_index_template'
|
53
|
-
end
|
54
|
-
params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
|
55
|
-
|
56
|
-
body = nil
|
57
|
-
perform_request(method, path, params, body, headers).body
|
32
|
+
Utils.validate_query_params! args, GET_INDEX_TEMPLATE_QUERY_PARAMS
|
33
|
+
transport.perform_request(method, url, args, body, headers).body
|
58
34
|
end
|
59
35
|
|
60
|
-
|
61
|
-
#
|
62
|
-
# @since 6.2.0
|
63
|
-
ParamsRegistry.register(:get_index_template, %i[
|
64
|
-
flat_settings
|
65
|
-
master_timeout
|
36
|
+
GET_INDEX_TEMPLATE_QUERY_PARAMS = Set.new(%w[
|
66
37
|
cluster_manager_timeout
|
38
|
+
flat_settings
|
67
39
|
local
|
68
|
-
|
40
|
+
master_timeout
|
41
|
+
]).freeze
|
69
42
|
end
|
70
43
|
end
|
71
44
|
end
|
@@ -3,78 +3,46 @@
|
|
3
3
|
# The OpenSearch Contributors require contributions made to
|
4
4
|
# this file be licensed under the Apache-2.0 license or a
|
5
5
|
# compatible open source license.
|
6
|
-
|
7
|
-
#
|
8
|
-
#
|
9
|
-
|
10
|
-
#
|
11
|
-
# license agreements. See the NOTICE file distributed with
|
12
|
-
# this work for additional information regarding copyright
|
13
|
-
# ownership. Elasticsearch B.V. licenses this file to you under
|
14
|
-
# the Apache License, Version 2.0 (the "License"); you may
|
15
|
-
# not use this file except in compliance with the License.
|
16
|
-
# You may obtain a copy of the License at
|
17
|
-
#
|
18
|
-
# http://www.apache.org/licenses/LICENSE-2.0
|
19
|
-
#
|
20
|
-
# Unless required by applicable law or agreed to in writing,
|
21
|
-
# software distributed under the License is distributed on an
|
22
|
-
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
23
|
-
# KIND, either express or implied. See the License for the
|
24
|
-
# specific language governing permissions and limitations
|
25
|
-
# under the License.
|
6
|
+
|
7
|
+
# This file is generated from the OpenSearch REST API spec.
|
8
|
+
# Do not modify it by hand. Instead, modify the generator or the spec.
|
9
|
+
|
10
|
+
# frozen_string_literal: true
|
26
11
|
|
27
12
|
module OpenSearch
|
28
13
|
module API
|
29
14
|
module Indices
|
30
15
|
module Actions
|
31
|
-
# Returns mappings for one or more
|
32
|
-
#
|
33
|
-
# @option arguments [List] :index A comma-separated list of index names
|
34
|
-
# @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
35
|
-
# @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
|
36
|
-
# @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
|
37
|
-
# @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master
|
38
|
-
# @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager
|
39
|
-
# @option arguments [Boolean] :local Return local information, do not retrieve the state from cluster_manager node (default: false) *Deprecated*
|
40
|
-
# @option arguments [Hash] :headers Custom HTTP headers
|
41
|
-
#
|
42
|
-
# *Deprecation notice*:
|
43
|
-
# Specifying types in urls has been deprecated
|
44
|
-
# Deprecated since version 7.0.0
|
45
|
-
#
|
46
|
-
#
|
16
|
+
# Returns mappings for one or more indexes.
|
47
17
|
#
|
48
|
-
|
49
|
-
|
18
|
+
# @option args [Boolean] :allow_no_indices If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes.
|
19
|
+
# @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
|
20
|
+
# @option args [Enumerable<String>, String] :expand_wildcards Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
|
21
|
+
# @option args [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index.
|
22
|
+
# @option args [Enumerable<String>, String] :index Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`.
|
23
|
+
# @option args [Boolean] :local If `true`, the request retrieves information from the local node only.
|
24
|
+
# @option args [String] :master_timeout DEPRECATED Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.
|
25
|
+
def get_mapping(args = {})
|
26
|
+
args = Utils.clone_and_normalize_arguments(args)
|
27
|
+
_index = args.delete('index')
|
50
28
|
|
51
|
-
|
29
|
+
headers = args.delete('headers') || {}
|
30
|
+
body = args.delete('body')
|
31
|
+
method = 'GET'
|
32
|
+
url = Utils.build_url(_index, '_mapping')
|
52
33
|
|
53
|
-
|
54
|
-
|
55
|
-
method = OpenSearch::API::HTTP_GET
|
56
|
-
path = if _index
|
57
|
-
"#{Utils.__listify(_index)}/_mapping"
|
58
|
-
else
|
59
|
-
'_mapping'
|
60
|
-
end
|
61
|
-
params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
|
62
|
-
|
63
|
-
body = nil
|
64
|
-
perform_request(method, path, params, body, headers).body
|
34
|
+
Utils.validate_query_params! args, GET_MAPPING_QUERY_PARAMS
|
35
|
+
transport.perform_request(method, url, args, body, headers).body
|
65
36
|
end
|
66
37
|
|
67
|
-
|
68
|
-
#
|
69
|
-
# @since 6.2.0
|
70
|
-
ParamsRegistry.register(:get_mapping, %i[
|
71
|
-
ignore_unavailable
|
38
|
+
GET_MAPPING_QUERY_PARAMS = Set.new(%w[
|
72
39
|
allow_no_indices
|
73
|
-
expand_wildcards
|
74
|
-
master_timeout
|
75
40
|
cluster_manager_timeout
|
41
|
+
expand_wildcards
|
42
|
+
ignore_unavailable
|
76
43
|
local
|
77
|
-
|
44
|
+
master_timeout
|
45
|
+
]).freeze
|
78
46
|
end
|
79
47
|
end
|
80
48
|
end
|
@@ -3,84 +3,52 @@
|
|
3
3
|
# The OpenSearch Contributors require contributions made to
|
4
4
|
# this file be licensed under the Apache-2.0 license or a
|
5
5
|
# compatible open source license.
|
6
|
-
|
7
|
-
#
|
8
|
-
#
|
9
|
-
|
10
|
-
#
|
11
|
-
# license agreements. See the NOTICE file distributed with
|
12
|
-
# this work for additional information regarding copyright
|
13
|
-
# ownership. Elasticsearch B.V. licenses this file to you under
|
14
|
-
# the Apache License, Version 2.0 (the "License"); you may
|
15
|
-
# not use this file except in compliance with the License.
|
16
|
-
# You may obtain a copy of the License at
|
17
|
-
#
|
18
|
-
# http://www.apache.org/licenses/LICENSE-2.0
|
19
|
-
#
|
20
|
-
# Unless required by applicable law or agreed to in writing,
|
21
|
-
# software distributed under the License is distributed on an
|
22
|
-
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
23
|
-
# KIND, either express or implied. See the License for the
|
24
|
-
# specific language governing permissions and limitations
|
25
|
-
# under the License.
|
6
|
+
|
7
|
+
# This file is generated from the OpenSearch REST API spec.
|
8
|
+
# Do not modify it by hand. Instead, modify the generator or the spec.
|
9
|
+
|
10
|
+
# frozen_string_literal: true
|
26
11
|
|
27
12
|
module OpenSearch
|
28
13
|
module API
|
29
14
|
module Indices
|
30
15
|
module Actions
|
31
|
-
# Returns settings for one or more
|
32
|
-
#
|
33
|
-
# @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
34
|
-
# @option arguments [List] :name The name of the settings that should be included
|
35
|
-
# @option arguments [Time] :master_timeout (DEPRECATED: use cluster_manager_timeout instead) Specify timeout for connection to master
|
36
|
-
# @option arguments [Time] :cluster_manager_timeout Specify timeout for connection to cluster_manager
|
37
|
-
# @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
38
|
-
# @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
|
39
|
-
# @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
|
40
|
-
# @option arguments [Boolean] :flat_settings Return settings in flat format (default: false)
|
41
|
-
# @option arguments [Boolean] :local Return local information, do not retrieve the state from master node (default: false)
|
42
|
-
# @option arguments [Boolean] :include_defaults Whether to return all default setting for each of the indices.
|
43
|
-
# @option arguments [Hash] :headers Custom HTTP headers
|
44
|
-
#
|
16
|
+
# Returns settings for one or more indexes.
|
45
17
|
#
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
18
|
+
# @option args [Boolean] :allow_no_indices If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes. For example, a request targeting `foo*,bar*` returns an error if an index starts with foo but no index starts with `bar`.
|
19
|
+
# @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
|
20
|
+
# @option args [Enumerable<String>, String] :expand_wildcards Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`.
|
21
|
+
# @option args [Boolean] :flat_settings If `true`, returns settings in flat format.
|
22
|
+
# @option args [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index.
|
23
|
+
# @option args [Boolean] :include_defaults If `true`, return all default settings in the response.
|
24
|
+
# @option args [Boolean] :local If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the cluster-manager node.
|
25
|
+
# @option args [String] :master_timeout DEPRECATED Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.
|
26
|
+
# @option args [Enumerable<String>, String] :name Comma-separated list or wildcard expression of settings to retrieve.
|
27
|
+
# @option args [Enumerable<String>, String] :index Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indexes, omit this parameter or use `*` or `_all`.
|
28
|
+
def get_settings(args = {})
|
29
|
+
args = Utils.clone_and_normalize_arguments(args)
|
30
|
+
_name = args.delete('name')
|
31
|
+
_index = args.delete('index')
|
52
32
|
|
53
|
-
|
33
|
+
headers = args.delete('headers') || {}
|
34
|
+
body = args.delete('body')
|
35
|
+
method = 'GET'
|
36
|
+
url = Utils.build_url(_index, '_settings', _name)
|
54
37
|
|
55
|
-
|
56
|
-
|
57
|
-
"#{Utils.__listify(_index)}/_settings/#{Utils.__listify(_name)}"
|
58
|
-
elsif _index
|
59
|
-
"#{Utils.__listify(_index)}/_settings"
|
60
|
-
elsif _name
|
61
|
-
"_settings/#{Utils.__listify(_name)}"
|
62
|
-
else
|
63
|
-
'_settings'
|
64
|
-
end
|
65
|
-
params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
|
66
|
-
|
67
|
-
body = nil
|
68
|
-
perform_request(method, path, params, body, headers).body
|
38
|
+
Utils.validate_query_params! args, GET_SETTINGS_QUERY_PARAMS
|
39
|
+
transport.perform_request(method, url, args, body, headers).body
|
69
40
|
end
|
70
41
|
|
71
|
-
|
72
|
-
#
|
73
|
-
# @since 6.2.0
|
74
|
-
ParamsRegistry.register(:get_settings, %i[
|
75
|
-
master_timeout
|
76
|
-
cluster_manager_timeout
|
77
|
-
ignore_unavailable
|
42
|
+
GET_SETTINGS_QUERY_PARAMS = Set.new(%w[
|
78
43
|
allow_no_indices
|
44
|
+
cluster_manager_timeout
|
79
45
|
expand_wildcards
|
80
46
|
flat_settings
|
81
|
-
|
47
|
+
ignore_unavailable
|
82
48
|
include_defaults
|
83
|
-
|
49
|
+
local
|
50
|
+
master_timeout
|
51
|
+
]).freeze
|
84
52
|
end
|
85
53
|
end
|
86
54
|
end
|
@@ -3,26 +3,11 @@
|
|
3
3
|
# The OpenSearch Contributors require contributions made to
|
4
4
|
# this file be licensed under the Apache-2.0 license or a
|
5
5
|
# compatible open source license.
|
6
|
-
|
7
|
-
#
|
8
|
-
#
|
9
|
-
|
10
|
-
#
|
11
|
-
# license agreements. See the NOTICE file distributed with
|
12
|
-
# this work for additional information regarding copyright
|
13
|
-
# ownership. Elasticsearch B.V. licenses this file to you under
|
14
|
-
# the Apache License, Version 2.0 (the "License"); you may
|
15
|
-
# not use this file except in compliance with the License.
|
16
|
-
# You may obtain a copy of the License at
|
17
|
-
#
|
18
|
-
# http://www.apache.org/licenses/LICENSE-2.0
|
19
|
-
#
|
20
|
-
# Unless required by applicable law or agreed to in writing,
|
21
|
-
# software distributed under the License is distributed on an
|
22
|
-
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
23
|
-
# KIND, either express or implied. See the License for the
|
24
|
-
# specific language governing permissions and limitations
|
25
|
-
# under the License.
|
6
|
+
|
7
|
+
# This file is generated from the OpenSearch REST API spec.
|
8
|
+
# Do not modify it by hand. Instead, modify the generator or the spec.
|
9
|
+
|
10
|
+
# frozen_string_literal: true
|
26
11
|
|
27
12
|
module OpenSearch
|
28
13
|
module API
|
@@ -30,42 +15,30 @@ module OpenSearch
|
|
30
15
|
module Actions
|
31
16
|
# Returns an index template.
|
32
17
|
#
|
33
|
-
# @option
|
34
|
-
# @option
|
35
|
-
# @option
|
36
|
-
# @option
|
37
|
-
# @option
|
38
|
-
|
39
|
-
|
40
|
-
|
41
|
-
def get_template(arguments = {})
|
42
|
-
headers = arguments.delete(:headers) || {}
|
18
|
+
# @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
|
19
|
+
# @option args [Boolean] :flat_settings If `true`, returns settings in flat format.
|
20
|
+
# @option args [Boolean] :local If `true`, the request retrieves information from the local node only.
|
21
|
+
# @option args [String] :master_timeout DEPRECATED Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.
|
22
|
+
# @option args [Enumerable<String>, String] :name Comma-separated list of index template names used to limit the request. Wildcard (`*`) expressions are supported. To return all index templates, omit this parameter or use a value of `_all` or `*`.
|
23
|
+
def get_template(args = {})
|
24
|
+
args = Utils.clone_and_normalize_arguments(args)
|
25
|
+
_name = args.delete('name')
|
43
26
|
|
44
|
-
|
27
|
+
headers = args.delete('headers') || {}
|
28
|
+
body = args.delete('body')
|
29
|
+
method = 'GET'
|
30
|
+
url = Utils.build_url('_template', _name)
|
45
31
|
|
46
|
-
|
47
|
-
|
48
|
-
method = OpenSearch::API::HTTP_GET
|
49
|
-
path = if _name
|
50
|
-
"_template/#{Utils.__listify(_name)}"
|
51
|
-
else
|
52
|
-
'_template'
|
53
|
-
end
|
54
|
-
params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
|
55
|
-
|
56
|
-
body = nil
|
57
|
-
perform_request(method, path, params, body, headers).body
|
32
|
+
Utils.validate_query_params! args, GET_TEMPLATE_QUERY_PARAMS
|
33
|
+
transport.perform_request(method, url, args, body, headers).body
|
58
34
|
end
|
59
35
|
|
60
|
-
|
61
|
-
#
|
62
|
-
# @since 6.2.0
|
63
|
-
ParamsRegistry.register(:get_template, %i[
|
64
|
-
flat_settings
|
65
|
-
master_timeout
|
36
|
+
GET_TEMPLATE_QUERY_PARAMS = Set.new(%w[
|
66
37
|
cluster_manager_timeout
|
38
|
+
flat_settings
|
67
39
|
local
|
68
|
-
|
40
|
+
master_timeout
|
41
|
+
]).freeze
|
69
42
|
end
|
70
43
|
end
|
71
44
|
end
|
@@ -3,72 +3,40 @@
|
|
3
3
|
# The OpenSearch Contributors require contributions made to
|
4
4
|
# this file be licensed under the Apache-2.0 license or a
|
5
5
|
# compatible open source license.
|
6
|
-
|
7
|
-
#
|
8
|
-
#
|
9
|
-
|
10
|
-
#
|
11
|
-
# license agreements. See the NOTICE file distributed with
|
12
|
-
# this work for additional information regarding copyright
|
13
|
-
# ownership. Elasticsearch B.V. licenses this file to you under
|
14
|
-
# the Apache License, Version 2.0 (the "License"); you may
|
15
|
-
# not use this file except in compliance with the License.
|
16
|
-
# You may obtain a copy of the License at
|
17
|
-
#
|
18
|
-
# http://www.apache.org/licenses/LICENSE-2.0
|
19
|
-
#
|
20
|
-
# Unless required by applicable law or agreed to in writing,
|
21
|
-
# software distributed under the License is distributed on an
|
22
|
-
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
23
|
-
# KIND, either express or implied. See the License for the
|
24
|
-
# specific language governing permissions and limitations
|
25
|
-
# under the License.
|
6
|
+
|
7
|
+
# This file is generated from the OpenSearch REST API spec.
|
8
|
+
# Do not modify it by hand. Instead, modify the generator or the spec.
|
9
|
+
|
10
|
+
# frozen_string_literal: true
|
26
11
|
|
27
12
|
module OpenSearch
|
28
13
|
module API
|
29
14
|
module Indices
|
30
15
|
module Actions
|
31
|
-
#
|
32
|
-
#
|
33
|
-
# @option arguments [List] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
|
34
|
-
# @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
35
|
-
# @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
|
36
|
-
# @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
|
37
|
-
# @option arguments [Hash] :headers Custom HTTP headers
|
38
|
-
#
|
39
|
-
# *Deprecation notice*:
|
40
|
-
# The _upgrade API is no longer useful and will be removed. Instead, see _reindex API.
|
41
|
-
# Deprecated since version 8.0.0
|
16
|
+
# The `_upgrade` API is no longer useful and will be removed.
|
42
17
|
#
|
43
|
-
#
|
44
|
-
#
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
_index = arguments.delete(:index)
|
18
|
+
# @option args [Boolean] :allow_no_indices Whether to ignore if a wildcard indexes expression resolves into no concrete indexes. (This includes `_all` string or when no indexes have been specified).
|
19
|
+
# @option args [Enumerable<String>, String] :expand_wildcards Whether to expand wildcard expression to concrete indexes that are open, closed or both.
|
20
|
+
# @option args [Boolean] :ignore_unavailable Whether specified concrete indexes should be ignored when unavailable (missing or closed).
|
21
|
+
# @option args [Enumerable<String>] :index Comma-separated list of indexes; use `_all` or empty string to perform the operation on all indexes.
|
22
|
+
def get_upgrade(args = {})
|
23
|
+
args = Utils.clone_and_normalize_arguments(args)
|
24
|
+
_index = args.delete('index')
|
51
25
|
|
52
|
-
|
53
|
-
|
54
|
-
|
55
|
-
|
56
|
-
'_upgrade'
|
57
|
-
end
|
58
|
-
params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
|
26
|
+
headers = args.delete('headers') || {}
|
27
|
+
body = args.delete('body')
|
28
|
+
method = 'GET'
|
29
|
+
url = Utils.build_url(_index, '_upgrade')
|
59
30
|
|
60
|
-
|
61
|
-
perform_request(method,
|
31
|
+
Utils.validate_query_params! args, GET_UPGRADE_QUERY_PARAMS
|
32
|
+
transport.perform_request(method, url, args, body, headers).body
|
62
33
|
end
|
63
34
|
|
64
|
-
|
65
|
-
#
|
66
|
-
# @since 6.2.0
|
67
|
-
ParamsRegistry.register(:get_upgrade, %i[
|
68
|
-
ignore_unavailable
|
35
|
+
GET_UPGRADE_QUERY_PARAMS = Set.new(%w[
|
69
36
|
allow_no_indices
|
70
37
|
expand_wildcards
|
71
|
-
|
38
|
+
ignore_unavailable
|
39
|
+
]).freeze
|
72
40
|
end
|
73
41
|
end
|
74
42
|
end
|
@@ -3,26 +3,11 @@
|
|
3
3
|
# The OpenSearch Contributors require contributions made to
|
4
4
|
# this file be licensed under the Apache-2.0 license or a
|
5
5
|
# compatible open source license.
|
6
|
-
|
7
|
-
#
|
8
|
-
#
|
9
|
-
|
10
|
-
#
|
11
|
-
# license agreements. See the NOTICE file distributed with
|
12
|
-
# this work for additional information regarding copyright
|
13
|
-
# ownership. Elasticsearch B.V. licenses this file to you under
|
14
|
-
# the Apache License, Version 2.0 (the "License"); you may
|
15
|
-
# not use this file except in compliance with the License.
|
16
|
-
# You may obtain a copy of the License at
|
17
|
-
#
|
18
|
-
# http://www.apache.org/licenses/LICENSE-2.0
|
19
|
-
#
|
20
|
-
# Unless required by applicable law or agreed to in writing,
|
21
|
-
# software distributed under the License is distributed on an
|
22
|
-
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
23
|
-
# KIND, either express or implied. See the License for the
|
24
|
-
# specific language governing permissions and limitations
|
25
|
-
# under the License.
|
6
|
+
|
7
|
+
# This file is generated from the OpenSearch REST API spec.
|
8
|
+
# Do not modify it by hand. Instead, modify the generator or the spec.
|
9
|
+
|
10
|
+
# frozen_string_literal: true
|
26
11
|
|
27
12
|
module OpenSearch
|
28
13
|
module API
|
@@ -30,46 +15,42 @@ module OpenSearch
|
|
30
15
|
module Actions
|
31
16
|
# Opens an index.
|
32
17
|
#
|
33
|
-
# @option
|
34
|
-
# @option
|
35
|
-
# @option
|
36
|
-
# @option
|
37
|
-
# @option
|
38
|
-
# @option
|
39
|
-
# @option
|
40
|
-
# @option
|
41
|
-
# @option
|
42
|
-
#
|
43
|
-
|
44
|
-
|
45
|
-
raise ArgumentError, "Required argument 'index' missing"
|
46
|
-
|
47
|
-
headers = arguments.delete(:headers) || {}
|
48
|
-
|
49
|
-
arguments = arguments.clone
|
18
|
+
# @option args [Enumerable<String>, String] :index *Required* Comma-separated list of data streams, indexes, and aliases used to limit the request. Supports wildcards (`*`). By default, you must explicitly name the indexes you using to limit the request. To limit a request using `_all`, `*`, or other wildcard expressions, change the `action.destructive_requires_name` setting to false. You can update this setting in the `opensearch.yml` file or using the cluster update settings API.
|
19
|
+
# @option args [Boolean] :allow_no_indices If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indexes. This behavior applies even if the request targets other open indexes.
|
20
|
+
# @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
|
21
|
+
# @option args [Enumerable<String>, String] :expand_wildcards Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
|
22
|
+
# @option args [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index.
|
23
|
+
# @option args [String] :master_timeout DEPRECATED Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error.
|
24
|
+
# @option args [String] :task_execution_timeout Explicit task execution timeout, only useful when `wait_for_completion` is false, defaults to `1h`.
|
25
|
+
# @option args [String] :timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
|
26
|
+
# @option args [Integer, String] :wait_for_active_shards The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`).
|
27
|
+
# @option args [Boolean] :wait_for_completion (default: true) Should this request wait until the operation has completed before returning.
|
28
|
+
def open(args = {})
|
29
|
+
args = Utils.clone_and_normalize_arguments(args)
|
30
|
+
raise ArgumentError, "Required argument 'index' missing" if args['index'].nil?
|
50
31
|
|
51
|
-
_index =
|
32
|
+
_index = args.delete('index')
|
52
33
|
|
53
|
-
|
54
|
-
|
55
|
-
|
34
|
+
headers = args.delete('headers') || {}
|
35
|
+
body = args.delete('body')
|
36
|
+
method = 'POST'
|
37
|
+
url = Utils.build_url(_index, '_open')
|
56
38
|
|
57
|
-
|
58
|
-
perform_request(method,
|
39
|
+
Utils.validate_query_params! args, OPEN_QUERY_PARAMS
|
40
|
+
transport.perform_request(method, url, args, body, headers).body
|
59
41
|
end
|
60
42
|
|
61
|
-
|
62
|
-
#
|
63
|
-
# @since 6.2.0
|
64
|
-
ParamsRegistry.register(:open, %i[
|
65
|
-
timeout
|
66
|
-
master_timeout
|
67
|
-
cluster_manager_timeout
|
68
|
-
ignore_unavailable
|
43
|
+
OPEN_QUERY_PARAMS = Set.new(%w[
|
69
44
|
allow_no_indices
|
45
|
+
cluster_manager_timeout
|
70
46
|
expand_wildcards
|
47
|
+
ignore_unavailable
|
48
|
+
master_timeout
|
49
|
+
task_execution_timeout
|
50
|
+
timeout
|
71
51
|
wait_for_active_shards
|
72
|
-
|
52
|
+
wait_for_completion
|
53
|
+
]).freeze
|
73
54
|
end
|
74
55
|
end
|
75
56
|
end
|