opensearch-ruby 3.4.0 → 4.0.0.pre.beta.1
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 +38 -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 +29 -55
- data/lib/opensearch/api/actions/cat/pending_tasks.rb +27 -51
- data/lib/opensearch/api/actions/cat/pit_segments.rb +24 -25
- data/lib/opensearch/api/actions/cat/plugins.rb +26 -51
- data/lib/opensearch/api/actions/cat/recovery.rb +27 -56
- data/lib/opensearch/api/actions/cat/repositories.rb +26 -49
- data/lib/opensearch/api/actions/cat/segment_replication.rb +69 -0
- data/lib/opensearch/api/actions/cat/segments.rb +28 -51
- data/lib/opensearch/api/actions/cat/shards.rb +30 -58
- data/lib/opensearch/api/actions/cat/snapshots.rb +30 -55
- data/lib/opensearch/api/actions/cat/tasks.rb +28 -51
- data/lib/opensearch/api/actions/cat/templates.rb +28 -55
- data/lib/opensearch/api/actions/cat/thread_pool.rb +30 -58
- data/lib/opensearch/api/actions/clear_scroll.rb +23 -48
- data/lib/opensearch/api/actions/cluster/allocation_explain.rb +19 -47
- data/lib/opensearch/api/actions/cluster/delete_component_template.rb +26 -47
- data/lib/opensearch/api/actions/cluster/delete_decommission_awareness.rb +33 -0
- data/lib/opensearch/api/actions/cluster/delete_voting_config_exclusions.rb +19 -40
- data/lib/opensearch/api/actions/cluster/delete_weighted_routing.rb +34 -0
- data/lib/opensearch/api/actions/cluster/exists_component_template.rb +26 -51
- data/lib/opensearch/api/actions/cluster/get_component_template.rb +22 -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 +19 -42
- data/lib/opensearch/api/actions/cluster/post_voting_config_exclusions.rb +18 -41
- 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 +33 -63
- data/lib/opensearch/api/actions/cluster/stats.rb +23 -46
- 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 +28 -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 +47 -76
- data/lib/opensearch/api/actions/delete_all_pits.rb +20 -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 +21 -17
- data/lib/opensearch/api/actions/delete_script.rb +31 -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 +43 -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 +30 -55
- data/lib/opensearch/api/actions/indices/delete_alias.rb +31 -53
- data/lib/opensearch/api/actions/indices/delete_data_stream.rb +38 -0
- data/lib/opensearch/api/actions/indices/delete_index_template.rb +25 -46
- data/lib/opensearch/api/actions/indices/delete_template.rb +25 -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 +25 -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 +24 -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 +38 -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 +38 -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/create_connector.rb +32 -0
- data/lib/opensearch/api/actions/ml/delete_agent.rb +38 -0
- data/lib/opensearch/api/actions/ml/delete_connector.rb +38 -0
- data/lib/opensearch/api/actions/ml/delete_model.rb +38 -0
- data/lib/opensearch/api/actions/ml/delete_model_group.rb +38 -0
- data/lib/opensearch/api/actions/ml/delete_task.rb +38 -0
- data/lib/opensearch/api/actions/ml/deploy_model.rb +36 -0
- data/lib/opensearch/api/actions/ml/get_model_group.rb +36 -0
- data/lib/opensearch/api/actions/ml/get_task.rb +36 -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/search_models.rb +32 -0
- data/lib/opensearch/api/actions/ml/undeploy_model.rb +36 -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 +38 -0
- data/lib/opensearch/api/actions/notifications/delete_configs.rb +42 -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 +38 -0
- data/lib/opensearch/api/actions/observability/delete_objects.rb +40 -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 +38 -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 +40 -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 +36 -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 +38 -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 +45 -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 +35 -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 +15 -18
- data/lib/opensearch/api/actions/security/delete_distinguished_name.rb +38 -0
- data/lib/opensearch/api/actions/security/delete_role.rb +15 -18
- data/lib/opensearch/api/actions/security/delete_role_mapping.rb +15 -18
- data/lib/opensearch/api/actions/security/delete_tenant.rb +15 -18
- data/lib/opensearch/api/actions/security/delete_user.rb +15 -18
- data/lib/opensearch/api/actions/security/delete_user_legacy.rb +38 -0
- data/lib/opensearch/api/actions/security/flush_cache.rb +12 -15
- 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 +10 -15
- 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 +10 -15
- 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 +13 -18
- 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 +13 -18
- data/lib/opensearch/api/actions/security/get_tenants.rb +10 -15
- data/lib/opensearch/api/actions/security/get_user.rb +13 -18
- 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 +15 -15
- data/lib/opensearch/api/actions/security/migrate.rb +31 -0
- data/lib/opensearch/api/actions/security/patch_action_group.rb +15 -19
- data/lib/opensearch/api/actions/security/patch_action_groups.rb +13 -16
- data/lib/opensearch/api/actions/security/patch_allowlist.rb +34 -0
- data/lib/opensearch/api/actions/security/patch_audit_configuration.rb +12 -17
- 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 +15 -20
- data/lib/opensearch/api/actions/security/patch_role_mapping.rb +15 -20
- data/lib/opensearch/api/actions/security/patch_role_mappings.rb +12 -17
- data/lib/opensearch/api/actions/security/patch_roles.rb +12 -17
- data/lib/opensearch/api/actions/security/patch_tenant.rb +15 -20
- data/lib/opensearch/api/actions/security/patch_tenants.rb +12 -17
- data/lib/opensearch/api/actions/security/patch_user.rb +15 -20
- data/lib/opensearch/api/actions/security/patch_users.rb +12 -17
- data/lib/opensearch/api/actions/security/post_dashboards_info.rb +31 -0
- data/lib/opensearch/api/actions/security/reload_http_certificates.rb +10 -15
- 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 +38 -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 +29 -55
- data/lib/opensearch/api/actions/snapshot/delete_repository.rb +24 -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 +38 -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 +38 -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 +26 -1
- 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 +1 -1
- data/spec/spec_helper.rb +3 -18
- data.tar.gz.sig +0 -0
- metadata +181 -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,34 @@ module OpenSearch
|
|
|
30
15
|
module Actions
|
|
31
16
|
# Allows to manually change the allocation of individual shards in the cluster.
|
|
32
17
|
#
|
|
33
|
-
# @option
|
|
34
|
-
# @option
|
|
35
|
-
# @option
|
|
36
|
-
# @option
|
|
37
|
-
# @option
|
|
38
|
-
# @option
|
|
39
|
-
# @option
|
|
40
|
-
# @option
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
arguments = arguments.clone
|
|
18
|
+
# @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
|
|
19
|
+
# @option args [Boolean] :dry_run If `true`, then the request simulates the operation only and returns the resulting state.
|
|
20
|
+
# @option args [Boolean] :explain If `true`, then the response contains an explanation of why the commands can or cannot be executed.
|
|
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] :metric Limits the information returned to the specified metrics.
|
|
23
|
+
# @option args [Boolean] :retry_failed If `true`, then retries allocation of shards that are blocked due to too many subsequent allocation failures.
|
|
24
|
+
# @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.
|
|
25
|
+
# @option args [Hash] :body The definition of `commands` to perform (`move`, `cancel`, `allocate`)
|
|
26
|
+
def reroute(args = {})
|
|
27
|
+
args = Utils.clone_and_normalize_arguments(args)
|
|
28
|
+
headers = args.delete('headers') || {}
|
|
29
|
+
body = args.delete('body')
|
|
30
|
+
method = 'POST'
|
|
31
|
+
url = '_cluster/reroute'
|
|
48
32
|
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
|
|
52
|
-
|
|
53
|
-
body = arguments[:body] || {}
|
|
54
|
-
perform_request(method, path, params, body, headers).body
|
|
33
|
+
Utils.validate_query_params! args, REROUTE_QUERY_PARAMS
|
|
34
|
+
transport.perform_request(method, url, args, body, headers).body
|
|
55
35
|
end
|
|
56
36
|
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
# @since 6.2.0
|
|
60
|
-
ParamsRegistry.register(:reroute, %i[
|
|
37
|
+
REROUTE_QUERY_PARAMS = Set.new(%w[
|
|
38
|
+
cluster_manager_timeout
|
|
61
39
|
dry_run
|
|
62
40
|
explain
|
|
63
|
-
retry_failed
|
|
64
|
-
metric
|
|
65
41
|
master_timeout
|
|
66
|
-
|
|
42
|
+
metric
|
|
43
|
+
retry_failed
|
|
67
44
|
timeout
|
|
68
|
-
].freeze
|
|
45
|
+
]).freeze
|
|
69
46
|
end
|
|
70
47
|
end
|
|
71
48
|
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,57 +15,42 @@ module OpenSearch
|
|
|
30
15
|
module Actions
|
|
31
16
|
# Returns a comprehensive information about the state of the cluster.
|
|
32
17
|
#
|
|
33
|
-
# @option
|
|
34
|
-
# @option
|
|
35
|
-
# @option
|
|
36
|
-
# @option
|
|
37
|
-
# @option
|
|
38
|
-
# @option
|
|
39
|
-
# @option
|
|
40
|
-
# @option
|
|
41
|
-
# @option
|
|
42
|
-
# @option
|
|
43
|
-
# @option
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
headers = arguments.delete(:headers) || {}
|
|
49
|
-
|
|
50
|
-
arguments = arguments.clone
|
|
51
|
-
|
|
52
|
-
_metric = arguments.delete(:metric)
|
|
53
|
-
|
|
54
|
-
_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 [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
|
|
20
|
+
# @option args [Enumerable<String>, String] :expand_wildcards Whether to expand wildcard expression to concrete indexes that are open, closed or both.
|
|
21
|
+
# @option args [Boolean] :flat_settings Return settings in flat format.
|
|
22
|
+
# @option args [Boolean] :ignore_unavailable Whether specified concrete indexes should be ignored when unavailable (missing or closed)
|
|
23
|
+
# @option args [Boolean] :local Return local information, do not retrieve the state from cluster-manager node.
|
|
24
|
+
# @option args [String] :master_timeout DEPRECATED Specify timeout for connection to cluster manager.
|
|
25
|
+
# @option args [Integer] :wait_for_metadata_version Wait for the metadata version to be equal or greater than the specified metadata version.
|
|
26
|
+
# @option args [String] :wait_for_timeout The maximum time to wait for `wait_for_metadata_version` before timing out.
|
|
27
|
+
# @option args [Enumerable<String>] :metric Limit the information returned to the specified metrics
|
|
28
|
+
# @option args [Enumerable<String>, String] :index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indexes
|
|
29
|
+
def state(args = {})
|
|
30
|
+
args = Utils.clone_and_normalize_arguments(args)
|
|
31
|
+
_metric = args.delete('metric')
|
|
32
|
+
_index = args.delete('index')
|
|
55
33
|
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
"_cluster/state/#{Utils.__listify(_metric)}"
|
|
61
|
-
else
|
|
62
|
-
'_cluster/state'
|
|
63
|
-
end
|
|
64
|
-
params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
|
|
34
|
+
headers = args.delete('headers') || {}
|
|
35
|
+
body = args.delete('body')
|
|
36
|
+
method = 'GET'
|
|
37
|
+
url = Utils.build_url('_cluster/state', _metric, _index)
|
|
65
38
|
|
|
66
|
-
|
|
67
|
-
perform_request(method,
|
|
39
|
+
Utils.validate_query_params! args, STATE_QUERY_PARAMS
|
|
40
|
+
transport.perform_request(method, url, args, body, headers).body
|
|
68
41
|
end
|
|
69
42
|
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
# @since 6.2.0
|
|
73
|
-
ParamsRegistry.register(:state, %i[
|
|
74
|
-
local
|
|
75
|
-
master_timeout
|
|
43
|
+
STATE_QUERY_PARAMS = Set.new(%w[
|
|
44
|
+
allow_no_indices
|
|
76
45
|
cluster_manager_timeout
|
|
46
|
+
expand_wildcards
|
|
77
47
|
flat_settings
|
|
48
|
+
ignore_unavailable
|
|
49
|
+
local
|
|
50
|
+
master_timeout
|
|
78
51
|
wait_for_metadata_version
|
|
79
52
|
wait_for_timeout
|
|
80
|
-
|
|
81
|
-
allow_no_indices
|
|
82
|
-
expand_wildcards
|
|
83
|
-
].freeze)
|
|
53
|
+
]).freeze
|
|
84
54
|
end
|
|
85
55
|
end
|
|
86
56
|
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,38 +15,30 @@ module OpenSearch
|
|
|
30
15
|
module Actions
|
|
31
16
|
# Returns high-level overview of cluster statistics.
|
|
32
17
|
#
|
|
33
|
-
# @option
|
|
34
|
-
# @option
|
|
35
|
-
# @option
|
|
36
|
-
# @option
|
|
37
|
-
#
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
18
|
+
# @option args [Boolean] :flat_settings If `true`, returns settings in flat format.
|
|
19
|
+
# @option args [String] :timeout Period to wait for each node to respond. If a node does not respond before its timeout expires, the response does not include its stats. However, timed out nodes are included in the response's `_nodes.failed` property. Defaults to no timeout.
|
|
20
|
+
# @option args [Enumerable<String>] :index_metric Limit the information returned for indexes metric to the specific index metrics. It can be used only if indexes (or all) metric is specified.
|
|
21
|
+
# @option args [Enumerable<String>] :metric Limit the information returned to the specified metrics.
|
|
22
|
+
# @option args [Enumerable<String>, String] :node_id Comma-separated list of node filters used to limit returned information. Defaults to all nodes in the cluster.
|
|
23
|
+
def stats(args = {})
|
|
24
|
+
args = Utils.clone_and_normalize_arguments(args)
|
|
25
|
+
_index_metric = args.delete('index_metric')
|
|
26
|
+
_metric = args.delete('metric')
|
|
27
|
+
_node_id = args.delete('node_id')
|
|
43
28
|
|
|
44
|
-
|
|
29
|
+
headers = args.delete('headers') || {}
|
|
30
|
+
body = args.delete('body')
|
|
31
|
+
method = 'GET'
|
|
32
|
+
url = Utils.build_url('_cluster/stats', _metric, _index_metric, 'nodes', _node_id)
|
|
45
33
|
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
"_cluster/stats/nodes/#{Utils.__listify(_node_id)}"
|
|
49
|
-
else
|
|
50
|
-
'_cluster/stats'
|
|
51
|
-
end
|
|
52
|
-
params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
|
|
53
|
-
|
|
54
|
-
body = nil
|
|
55
|
-
perform_request(method, path, params, body, headers).body
|
|
34
|
+
Utils.validate_query_params! args, STATS_QUERY_PARAMS
|
|
35
|
+
transport.perform_request(method, url, args, body, headers).body
|
|
56
36
|
end
|
|
57
37
|
|
|
58
|
-
|
|
59
|
-
#
|
|
60
|
-
# @since 6.2.0
|
|
61
|
-
ParamsRegistry.register(:stats, %i[
|
|
38
|
+
STATS_QUERY_PARAMS = Set.new(%w[
|
|
62
39
|
flat_settings
|
|
63
40
|
timeout
|
|
64
|
-
].freeze
|
|
41
|
+
]).freeze
|
|
65
42
|
end
|
|
66
43
|
end
|
|
67
44
|
end
|
|
@@ -3,94 +3,64 @@
|
|
|
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
|
-
module
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
# Deprecated since version 7.0.0
|
|
53
|
-
#
|
|
54
|
-
#
|
|
55
|
-
#
|
|
56
|
-
def count(arguments = {})
|
|
57
|
-
headers = arguments.delete(:headers) || {}
|
|
14
|
+
module Root
|
|
15
|
+
module Actions
|
|
16
|
+
# Returns number of documents matching a query.
|
|
17
|
+
#
|
|
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 [Boolean] :analyze_wildcard If `true`, wildcard and prefix queries are analyzed. This parameter can only be used when the `q` query string parameter is specified.
|
|
20
|
+
# @option args [String] :analyzer Analyzer to use for the query string. This parameter can only be used when the `q` query string parameter is specified.
|
|
21
|
+
# @option args [String] :default_operator The default operator for query string query: `AND` or `OR`. This parameter can only be used when the `q` query string parameter is specified.
|
|
22
|
+
# @option args [String] :df Field to use as default where no field prefix is given in the query string. This parameter can only be used when the `q` query string parameter is specified.
|
|
23
|
+
# @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`.
|
|
24
|
+
# @option args [Boolean] :ignore_throttled If `true`, concrete, expanded or aliased indexes are ignored when frozen.
|
|
25
|
+
# @option args [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index.
|
|
26
|
+
# @option args [Boolean] :lenient If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.
|
|
27
|
+
# @option args [Float] :min_score Sets the minimum `_score` value that documents must have to be included in the result.
|
|
28
|
+
# @option args [String] :preference (default: random) Specifies the node or shard the operation should be performed on. Random by default.
|
|
29
|
+
# @option args [String] :q Query in the Lucene query string syntax.
|
|
30
|
+
# @option args [Enumerable<String>, String] :routing Custom value used to route operations to a specific shard.
|
|
31
|
+
# @option args [Integer] :terminate_after Maximum number of documents to collect for each shard. If a query reaches this limit, OpenSearch terminates the query early. OpenSearch collects documents before sorting.
|
|
32
|
+
# @option args [Enumerable<String>, String] :index Comma-separated list of data streams, indexes, and aliases to search. Supports wildcards (`*`). To search all data streams and indexes, omit this parameter or use `*` or `_all`.
|
|
33
|
+
# @option args [Hash] :body Query to restrict the results specified with the Query DSL (optional)
|
|
34
|
+
def count(args = {})
|
|
35
|
+
args = Utils.clone_and_normalize_arguments(args)
|
|
36
|
+
_index = args.delete('index')
|
|
58
37
|
|
|
59
|
-
|
|
38
|
+
headers = args.delete('headers') || {}
|
|
39
|
+
body = args.delete('body')
|
|
40
|
+
method = body ? 'POST' : 'GET'
|
|
41
|
+
url = Utils.build_url(_index, '_count')
|
|
60
42
|
|
|
61
|
-
|
|
43
|
+
Utils.validate_query_params! args, COUNT_QUERY_PARAMS
|
|
44
|
+
transport.perform_request(method, url, args, body, headers).body
|
|
45
|
+
end
|
|
62
46
|
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
47
|
+
COUNT_QUERY_PARAMS = Set.new(%w[
|
|
48
|
+
allow_no_indices
|
|
49
|
+
analyze_wildcard
|
|
50
|
+
analyzer
|
|
51
|
+
default_operator
|
|
52
|
+
df
|
|
53
|
+
expand_wildcards
|
|
54
|
+
ignore_throttled
|
|
55
|
+
ignore_unavailable
|
|
56
|
+
lenient
|
|
57
|
+
min_score
|
|
58
|
+
preference
|
|
59
|
+
q
|
|
60
|
+
routing
|
|
61
|
+
terminate_after
|
|
62
|
+
]).freeze
|
|
73
63
|
end
|
|
74
|
-
|
|
75
|
-
# Register this action with its valid params when the module is loaded.
|
|
76
|
-
#
|
|
77
|
-
# @since 6.2.0
|
|
78
|
-
ParamsRegistry.register(:count, %i[
|
|
79
|
-
ignore_unavailable
|
|
80
|
-
ignore_throttled
|
|
81
|
-
allow_no_indices
|
|
82
|
-
expand_wildcards
|
|
83
|
-
min_score
|
|
84
|
-
preference
|
|
85
|
-
routing
|
|
86
|
-
q
|
|
87
|
-
analyzer
|
|
88
|
-
analyze_wildcard
|
|
89
|
-
default_operator
|
|
90
|
-
df
|
|
91
|
-
lenient
|
|
92
|
-
terminate_after
|
|
93
|
-
].freeze)
|
|
94
64
|
end
|
|
95
65
|
end
|
|
96
66
|
end
|
|
@@ -3,57 +3,56 @@
|
|
|
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
|
-
module
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
14
|
+
module Root
|
|
15
|
+
module Actions
|
|
16
|
+
# Creates a new document in the index.
|
|
17
|
+
# Returns a 409 response when a document with a same ID already exists in the index.
|
|
18
|
+
#
|
|
19
|
+
# @option args [String] :id *Required* Unique identifier for the document.
|
|
20
|
+
# @option args [String] :index *Required* Name of the data stream or index to target. If the target doesn't exist and matches the name or wildcard (`*`) pattern of an index template with a `data_stream` definition, this request creates the data stream. If the target doesn't exist and doesn't match a data stream template, this request creates the index.
|
|
21
|
+
# @option args [String] :pipeline ID of the pipeline to use to preprocess incoming documents. If the index has a default ingest pipeline specified, then setting the value to `_none` disables the default ingest pipeline for this request. If a final pipeline is configured it will always run, regardless of the value of this parameter.
|
|
22
|
+
# @option args [Boolean, String] :refresh If `true`, OpenSearch refreshes the affected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` do nothing with refreshes. Valid values: `true`, `false`, `wait_for`.
|
|
23
|
+
# @option args [Enumerable<String>, String] :routing Custom value used to route operations to a specific shard.
|
|
24
|
+
# @option args [String] :timeout Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.
|
|
25
|
+
# @option args [Integer] :version Explicit version number for concurrency control. The specified version must match the current version of the document for the request to succeed.
|
|
26
|
+
# @option args [String] :version_type Specific version type: `external`, `external_gte`.
|
|
27
|
+
# @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`).
|
|
28
|
+
# @option args [Hash] :body *Required* The document
|
|
29
|
+
def create(args = {})
|
|
30
|
+
args = Utils.clone_and_normalize_arguments(args)
|
|
31
|
+
raise ArgumentError, "Required argument 'id' missing" if args['id'].nil?
|
|
32
|
+
raise ArgumentError, "Required argument 'index' missing" if args['index'].nil?
|
|
33
|
+
raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
|
|
34
|
+
|
|
35
|
+
_id = args.delete('id')
|
|
36
|
+
_index = args.delete('index')
|
|
37
|
+
|
|
38
|
+
headers = args.delete('headers') || {}
|
|
39
|
+
body = args.delete('body')
|
|
40
|
+
method = 'POST'
|
|
41
|
+
url = Utils.build_url(_index, '_create', _id)
|
|
42
|
+
|
|
43
|
+
Utils.validate_query_params! args, CREATE_QUERY_PARAMS
|
|
44
|
+
transport.perform_request(method, url, args, body, headers).body
|
|
56
45
|
end
|
|
46
|
+
|
|
47
|
+
CREATE_QUERY_PARAMS = Set.new(%w[
|
|
48
|
+
pipeline
|
|
49
|
+
refresh
|
|
50
|
+
routing
|
|
51
|
+
timeout
|
|
52
|
+
version
|
|
53
|
+
version_type
|
|
54
|
+
wait_for_active_shards
|
|
55
|
+
]).freeze
|
|
57
56
|
end
|
|
58
57
|
end
|
|
59
58
|
end
|