opensearch-ruby 3.3.0 → 4.0.0.pre.beta.1
Sign up to get free protection for your applications and to get access to all the features.
- 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/queries/script_score.rb +62 -0
- 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 +182 -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
@@ -0,0 +1,119 @@
|
|
1
|
+
# SPDX-License-Identifier: Apache-2.0
|
2
|
+
#
|
3
|
+
# The OpenSearch Contributors require contributions made to
|
4
|
+
# this file be licensed under the Apache-2.0 license or a
|
5
|
+
# compatible open source 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
|
11
|
+
|
12
|
+
module OpenSearch
|
13
|
+
module API
|
14
|
+
module Knn
|
15
|
+
module Actions
|
16
|
+
# Use an OpenSearch query to search for models in the index.
|
17
|
+
#
|
18
|
+
# @option args [Enumerable<String>] :_source Set to `true` or `false` to return the `_source` field or not, or a list of fields to return.
|
19
|
+
# @option args [Enumerable<String>] :_source_excludes List of fields to exclude from the returned `_source` field.
|
20
|
+
# @option args [Enumerable<String>] :_source_includes List of fields to extract and return from the `_source` field.
|
21
|
+
# @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).
|
22
|
+
# @option args [Boolean] :allow_partial_search_results (default: true) Indicate if an error should be returned if there is a partial search failure or timeout.
|
23
|
+
# @option args [Boolean] :analyze_wildcard Specify whether wildcard and prefix queries should be analyzed.
|
24
|
+
# @option args [String] :analyzer The analyzer to use for the query string.
|
25
|
+
# @option args [Integer] :batched_reduce_size (default: 512) The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.
|
26
|
+
# @option args [Boolean] :ccs_minimize_roundtrips (default: true) Indicates whether network round-trips should be minimized as part of cross-cluster search requests execution.
|
27
|
+
# @option args [String] :default_operator The default operator for query string query (AND or OR).
|
28
|
+
# @option args [String] :df The field to use as default where no field prefix is given in the query string.
|
29
|
+
# @option args [Enumerable<String>] :docvalue_fields Comma-separated list of fields to return as the docvalue representation of a field for each hit.
|
30
|
+
# @option args [Enumerable<String>, String] :expand_wildcards Whether to expand wildcard expression to concrete indexes that are open, closed or both.
|
31
|
+
# @option args [Boolean] :explain Specify whether to return detailed information about score computation as part of a hit.
|
32
|
+
# @option args [Integer] :from (default: 0) Starting offset.
|
33
|
+
# @option args [Boolean] :ignore_throttled Whether specified concrete, expanded or aliased indexes should be ignored when throttled.
|
34
|
+
# @option args [Boolean] :ignore_unavailable Whether specified concrete indexes should be ignored when unavailable (missing or closed).
|
35
|
+
# @option args [Boolean] :lenient Specify whether format-based query failures (such as providing text to a numeric field) should be ignored.
|
36
|
+
# @option args [Integer] :max_concurrent_shard_requests (default: 5) The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests.
|
37
|
+
# @option args [Integer] :pre_filter_shard_size Threshold that enforces a pre-filter round-trip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter round-trip can limit the number of shards significantly if for instance a shard can not match any documents based on its rewrite method, that is if date filters are mandatory to match but the shard bounds and the query are disjoint.
|
38
|
+
# @option args [String] :preference (default: random) Specify the node or shard the operation should be performed on.
|
39
|
+
# @option args [String] :q Query in the Lucene query string syntax.
|
40
|
+
# @option args [Boolean] :request_cache Specify if request cache should be used for this request or not, defaults to index level setting.
|
41
|
+
# @option args [Boolean] :rest_total_hits_as_int Indicates whether `hits.total` should be rendered as an integer or an object in the rest search response.
|
42
|
+
# @option args [Enumerable<String>, String] :routing Comma-separated list of specific routing values.
|
43
|
+
# @option args [String] :scroll Specify how long a consistent view of the index should be maintained for scrolled search.
|
44
|
+
# @option args [String] :search_type Search operation type.
|
45
|
+
# @option args [Boolean] :seq_no_primary_term Specify whether to return sequence number and primary term of the last modification of each hit.
|
46
|
+
# @option args [Integer] :size (default: 10) Number of hits to return.
|
47
|
+
# @option args [Enumerable<String>] :sort Comma-separated list of <field>:<direction> pairs.
|
48
|
+
# @option args [Enumerable<String>] :stats Specific 'tag' of the request for logging and statistical purposes.
|
49
|
+
# @option args [Enumerable<String>] :stored_fields Comma-separated list of stored fields to return.
|
50
|
+
# @option args [String] :suggest_field Specify which field to use for suggestions.
|
51
|
+
# @option args [String] :suggest_mode Specify suggest mode.
|
52
|
+
# @option args [Integer] :suggest_size How many suggestions to return in response.
|
53
|
+
# @option args [String] :suggest_text The source text for which the suggestions should be returned.
|
54
|
+
# @option args [Integer] :terminate_after The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
|
55
|
+
# @option args [String] :timeout Operation timeout.
|
56
|
+
# @option args [Boolean] :track_scores Whether to calculate and return scores even if they are not used for sorting.
|
57
|
+
# @option args [Boolean] :track_total_hits Indicate if the number of documents that match the query should be tracked.
|
58
|
+
# @option args [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response.
|
59
|
+
# @option args [Boolean] :version Whether to return document version as part of a hit.
|
60
|
+
# @option args [Hash] :body
|
61
|
+
def search_models(args = {})
|
62
|
+
args = Utils.clone_and_normalize_arguments(args)
|
63
|
+
headers = args.delete('headers') || {}
|
64
|
+
body = args.delete('body')
|
65
|
+
method = body ? 'POST' : 'GET'
|
66
|
+
url = '_plugins/_knn/models/_search'
|
67
|
+
|
68
|
+
Utils.validate_query_params! args, SEARCH_MODELS_QUERY_PARAMS
|
69
|
+
transport.perform_request(method, url, args, body, headers).body
|
70
|
+
end
|
71
|
+
|
72
|
+
SEARCH_MODELS_QUERY_PARAMS = Set.new(%w[
|
73
|
+
_source
|
74
|
+
_source_excludes
|
75
|
+
_source_includes
|
76
|
+
allow_no_indices
|
77
|
+
allow_partial_search_results
|
78
|
+
analyze_wildcard
|
79
|
+
analyzer
|
80
|
+
batched_reduce_size
|
81
|
+
ccs_minimize_roundtrips
|
82
|
+
default_operator
|
83
|
+
df
|
84
|
+
docvalue_fields
|
85
|
+
expand_wildcards
|
86
|
+
explain
|
87
|
+
from
|
88
|
+
ignore_throttled
|
89
|
+
ignore_unavailable
|
90
|
+
lenient
|
91
|
+
max_concurrent_shard_requests
|
92
|
+
pre_filter_shard_size
|
93
|
+
preference
|
94
|
+
q
|
95
|
+
request_cache
|
96
|
+
rest_total_hits_as_int
|
97
|
+
routing
|
98
|
+
scroll
|
99
|
+
search_type
|
100
|
+
seq_no_primary_term
|
101
|
+
size
|
102
|
+
sort
|
103
|
+
stats
|
104
|
+
stored_fields
|
105
|
+
suggest_field
|
106
|
+
suggest_mode
|
107
|
+
suggest_size
|
108
|
+
suggest_text
|
109
|
+
terminate_after
|
110
|
+
timeout
|
111
|
+
track_scores
|
112
|
+
track_total_hits
|
113
|
+
typed_keys
|
114
|
+
version
|
115
|
+
]).freeze
|
116
|
+
end
|
117
|
+
end
|
118
|
+
end
|
119
|
+
end
|
@@ -0,0 +1,41 @@
|
|
1
|
+
# SPDX-License-Identifier: Apache-2.0
|
2
|
+
#
|
3
|
+
# The OpenSearch Contributors require contributions made to
|
4
|
+
# this file be licensed under the Apache-2.0 license or a
|
5
|
+
# compatible open source 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
|
11
|
+
|
12
|
+
module OpenSearch
|
13
|
+
module API
|
14
|
+
module Knn
|
15
|
+
module Actions
|
16
|
+
# Provides information about the current status of the k-NN plugin.
|
17
|
+
#
|
18
|
+
# @option args [Enumerable<String>] :node_id Comma-separated list of node IDs or names to limit the returned information; use `_local` to return information from the node you're connecting to, leave empty to get information from all nodes.
|
19
|
+
# @option args [String] :timeout Operation timeout.
|
20
|
+
# @option args [Enumerable<String>] :stat Comma-separated list of stats to retrieve; use `_all` or empty string to retrieve all stats.
|
21
|
+
def stats(args = {})
|
22
|
+
args = Utils.clone_and_normalize_arguments(args)
|
23
|
+
_node_id = args.delete('node_id')
|
24
|
+
_stat = args.delete('stat')
|
25
|
+
|
26
|
+
headers = args.delete('headers') || {}
|
27
|
+
body = args.delete('body')
|
28
|
+
method = 'GET'
|
29
|
+
url = Utils.build_url('_plugins/_knn', _node_id, 'stats', _stat)
|
30
|
+
|
31
|
+
Utils.validate_query_params! args, STATS_QUERY_PARAMS
|
32
|
+
transport.perform_request(method, url, args, body, headers).body
|
33
|
+
end
|
34
|
+
|
35
|
+
STATS_QUERY_PARAMS = Set.new(%w[
|
36
|
+
timeout
|
37
|
+
]).freeze
|
38
|
+
end
|
39
|
+
end
|
40
|
+
end
|
41
|
+
end
|
@@ -0,0 +1,40 @@
|
|
1
|
+
# SPDX-License-Identifier: Apache-2.0
|
2
|
+
#
|
3
|
+
# The OpenSearch Contributors require contributions made to
|
4
|
+
# this file be licensed under the Apache-2.0 license or a
|
5
|
+
# compatible open source 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
|
11
|
+
|
12
|
+
module OpenSearch
|
13
|
+
module API
|
14
|
+
module Knn
|
15
|
+
module Actions
|
16
|
+
# Create and train a model that can be used for initializing k-NN native library indexes during indexing.
|
17
|
+
#
|
18
|
+
# @option args [String] :preference Preferred node to execute training.
|
19
|
+
# @option args [String] :model_id The id of the model.
|
20
|
+
# @option args [Hash] :body
|
21
|
+
def train_model(args = {})
|
22
|
+
args = Utils.clone_and_normalize_arguments(args)
|
23
|
+
_model_id = args.delete('model_id')
|
24
|
+
|
25
|
+
headers = args.delete('headers') || {}
|
26
|
+
body = args.delete('body')
|
27
|
+
method = 'POST'
|
28
|
+
url = Utils.build_url('_plugins/_knn/models', _model_id, '_train')
|
29
|
+
|
30
|
+
Utils.validate_query_params! args, TRAIN_MODEL_QUERY_PARAMS
|
31
|
+
transport.perform_request(method, url, args, body, headers).body
|
32
|
+
end
|
33
|
+
|
34
|
+
TRAIN_MODEL_QUERY_PARAMS = Set.new(%w[
|
35
|
+
preference
|
36
|
+
]).freeze
|
37
|
+
end
|
38
|
+
end
|
39
|
+
end
|
40
|
+
end
|
@@ -0,0 +1,36 @@
|
|
1
|
+
# SPDX-License-Identifier: Apache-2.0
|
2
|
+
#
|
3
|
+
# The OpenSearch Contributors require contributions made to
|
4
|
+
# this file be licensed under the Apache-2.0 license or a
|
5
|
+
# compatible open source 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
|
11
|
+
|
12
|
+
module OpenSearch
|
13
|
+
module API
|
14
|
+
module Knn
|
15
|
+
module Actions
|
16
|
+
# Preloads native library files into memory, reducing initial search latency for specified indexes.
|
17
|
+
#
|
18
|
+
# @option args [Enumerable<String>] :index *Required* Comma-separated list of indexes; use `_all` or empty string to perform the operation on all indexes.
|
19
|
+
def warmup(args = {})
|
20
|
+
args = Utils.clone_and_normalize_arguments(args)
|
21
|
+
raise ArgumentError, "Required argument 'index' missing" if args['index'].nil?
|
22
|
+
|
23
|
+
_index = args.delete('index')
|
24
|
+
|
25
|
+
headers = args.delete('headers') || {}
|
26
|
+
body = args.delete('body')
|
27
|
+
method = 'GET'
|
28
|
+
url = Utils.build_url('_plugins/_knn/warmup', _index)
|
29
|
+
|
30
|
+
Utils.validate_query_params! args
|
31
|
+
transport.perform_request(method, url, args, body, headers).body
|
32
|
+
end
|
33
|
+
end
|
34
|
+
end
|
35
|
+
end
|
36
|
+
end
|
@@ -0,0 +1,31 @@
|
|
1
|
+
# SPDX-License-Identifier: Apache-2.0
|
2
|
+
#
|
3
|
+
# The OpenSearch Contributors require contributions made to
|
4
|
+
# this file be licensed under the Apache-2.0 license or a
|
5
|
+
# compatible open source 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
|
11
|
+
|
12
|
+
module OpenSearch
|
13
|
+
module API
|
14
|
+
module List
|
15
|
+
module Actions
|
16
|
+
# Returns help for the List APIs.
|
17
|
+
#
|
18
|
+
def help(args = {})
|
19
|
+
args = Utils.clone_and_normalize_arguments(args)
|
20
|
+
headers = args.delete('headers') || {}
|
21
|
+
body = args.delete('body')
|
22
|
+
method = 'GET'
|
23
|
+
url = '_list'
|
24
|
+
|
25
|
+
Utils.validate_query_params! args
|
26
|
+
transport.perform_request(method, url, args, body, headers).body
|
27
|
+
end
|
28
|
+
end
|
29
|
+
end
|
30
|
+
end
|
31
|
+
end
|
@@ -0,0 +1,71 @@
|
|
1
|
+
# SPDX-License-Identifier: Apache-2.0
|
2
|
+
#
|
3
|
+
# The OpenSearch Contributors require contributions made to
|
4
|
+
# this file be licensed under the Apache-2.0 license or a
|
5
|
+
# compatible open source 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
|
11
|
+
|
12
|
+
module OpenSearch
|
13
|
+
module API
|
14
|
+
module List
|
15
|
+
module Actions
|
16
|
+
# Returns paginated information about indexes including number of primaries and replicas, document counts, disk size.
|
17
|
+
#
|
18
|
+
# @option args [String] :bytes The unit used to display byte values.
|
19
|
+
# @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
|
20
|
+
# @option args [Enumerable<String>, String] :expand_wildcards The type of index that wildcard patterns can match.
|
21
|
+
# @option args [String] :format A short version of the Accept header, such as `JSON`, `YAML`.
|
22
|
+
# @option args [Enumerable<String>] :h Comma-separated list of column names to display.
|
23
|
+
# @option args [String] :health The health status used to limit returned indexes. By default, the response includes indexes of any health status.
|
24
|
+
# @option args [Boolean] :help Return help information.
|
25
|
+
# @option args [Boolean] :include_unloaded_segments If `true`, the response includes information from segments that are not loaded into memory.
|
26
|
+
# @option args [Boolean] :local Return local information, do not retrieve the state from cluster-manager node.
|
27
|
+
# @option args [String] :master_timeout DEPRECATED Operation timeout for connection to cluster-manager node.
|
28
|
+
# @option args [Hash] :next_token Token to retrieve next page of indexes.
|
29
|
+
# @option args [Boolean] :pri If `true`, the response only includes information from primary shards.
|
30
|
+
# @option args [Enumerable<String>] :s Comma-separated list of column names or column aliases to sort by.
|
31
|
+
# @option args [Integer] :size Maximum number of indexes to be displayed in a page.
|
32
|
+
# @option args [String] :sort Defines order in which indexes will be displayed. Accepted values are `asc` and `desc`. If `desc`, most recently created indexes would be displayed first.
|
33
|
+
# @option args [String] :time The unit used to display time values.
|
34
|
+
# @option args [Boolean] :v Verbose mode. Display column headers.
|
35
|
+
# @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`.
|
36
|
+
def indices(args = {})
|
37
|
+
args = Utils.clone_and_normalize_arguments(args)
|
38
|
+
_index = args.delete('index')
|
39
|
+
|
40
|
+
headers = args.delete('headers') || {}
|
41
|
+
body = args.delete('body')
|
42
|
+
method = 'GET'
|
43
|
+
url = Utils.build_url('_list/indices', _index)
|
44
|
+
|
45
|
+
Utils.validate_query_params! args, INDICES_QUERY_PARAMS
|
46
|
+
transport.perform_request(method, url, args, body, headers).body
|
47
|
+
end
|
48
|
+
|
49
|
+
INDICES_QUERY_PARAMS = Set.new(%w[
|
50
|
+
bytes
|
51
|
+
cluster_manager_timeout
|
52
|
+
expand_wildcards
|
53
|
+
format
|
54
|
+
h
|
55
|
+
health
|
56
|
+
help
|
57
|
+
include_unloaded_segments
|
58
|
+
local
|
59
|
+
master_timeout
|
60
|
+
next_token
|
61
|
+
pri
|
62
|
+
s
|
63
|
+
size
|
64
|
+
sort
|
65
|
+
time
|
66
|
+
v
|
67
|
+
]).freeze
|
68
|
+
end
|
69
|
+
end
|
70
|
+
end
|
71
|
+
end
|
@@ -0,0 +1,63 @@
|
|
1
|
+
# SPDX-License-Identifier: Apache-2.0
|
2
|
+
#
|
3
|
+
# The OpenSearch Contributors require contributions made to
|
4
|
+
# this file be licensed under the Apache-2.0 license or a
|
5
|
+
# compatible open source 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
|
11
|
+
|
12
|
+
module OpenSearch
|
13
|
+
module API
|
14
|
+
module List
|
15
|
+
module Actions
|
16
|
+
# Returns paginated details of shard allocation on nodes.
|
17
|
+
#
|
18
|
+
# @option args [String] :bytes The unit used to display byte values.
|
19
|
+
# @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
|
20
|
+
# @option args [String] :format A short version of the Accept header, such as `JSON`, `YAML`.
|
21
|
+
# @option args [Enumerable<String>] :h Comma-separated list of column names to display.
|
22
|
+
# @option args [Boolean] :help Return help information.
|
23
|
+
# @option args [Boolean] :local Return local information, do not retrieve the state from cluster-manager node.
|
24
|
+
# @option args [String] :master_timeout DEPRECATED Operation timeout for connection to cluster-manager node.
|
25
|
+
# @option args [Hash] :next_token Token to retrieve next page of shards.
|
26
|
+
# @option args [Enumerable<String>] :s Comma-separated list of column names or column aliases to sort by.
|
27
|
+
# @option args [Integer] :size Maximum number of shards to be displayed in a page.
|
28
|
+
# @option args [String] :sort Defines order in which shards will be displayed. Accepted values are `asc` and `desc`. If `desc`, most recently created shards would be displayed first.
|
29
|
+
# @option args [String] :time The unit in which to display time values.
|
30
|
+
# @option args [Boolean] :v Verbose mode. Display column headers.
|
31
|
+
# @option args [Enumerable<String>, String] :index A 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`.
|
32
|
+
def shards(args = {})
|
33
|
+
args = Utils.clone_and_normalize_arguments(args)
|
34
|
+
_index = args.delete('index')
|
35
|
+
|
36
|
+
headers = args.delete('headers') || {}
|
37
|
+
body = args.delete('body')
|
38
|
+
method = 'GET'
|
39
|
+
url = Utils.build_url('_list/shards', _index)
|
40
|
+
|
41
|
+
Utils.validate_query_params! args, SHARDS_QUERY_PARAMS
|
42
|
+
transport.perform_request(method, url, args, body, headers).body
|
43
|
+
end
|
44
|
+
|
45
|
+
SHARDS_QUERY_PARAMS = Set.new(%w[
|
46
|
+
bytes
|
47
|
+
cluster_manager_timeout
|
48
|
+
format
|
49
|
+
h
|
50
|
+
help
|
51
|
+
local
|
52
|
+
master_timeout
|
53
|
+
next_token
|
54
|
+
s
|
55
|
+
size
|
56
|
+
sort
|
57
|
+
time
|
58
|
+
v
|
59
|
+
]).freeze
|
60
|
+
end
|
61
|
+
end
|
62
|
+
end
|
63
|
+
end
|
@@ -3,84 +3,54 @@
|
|
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
|
-
# Deprecated since version 7.0.0
|
47
|
-
#
|
48
|
-
#
|
49
|
-
#
|
50
|
-
def mget(arguments = {})
|
51
|
-
raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
|
14
|
+
module Root
|
15
|
+
module Actions
|
16
|
+
# Allows to get multiple documents in one request.
|
17
|
+
#
|
18
|
+
# @option args [Boolean, Enumerable<String>, String] :_source Set to `true` or `false` to return the `_source` field or not, or a list of fields to return.
|
19
|
+
# @option args [Enumerable<String>, String] :_source_excludes A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in `_source_includes` query parameter.
|
20
|
+
# @option args [Enumerable<String>, String] :_source_includes A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the `_source_excludes` query parameter. If the `_source` parameter is `false`, this parameter is ignored.
|
21
|
+
# @option args [String] :preference (default: random) Specifies the node or shard the operation should be performed on. Random by default.
|
22
|
+
# @option args [Boolean] :realtime If `true`, the request is real-time as opposed to near-real-time.
|
23
|
+
# @option args [Boolean, String] :refresh If `true`, the request refreshes relevant shards before retrieving documents.
|
24
|
+
# @option args [Enumerable<String>, String] :routing Custom value used to route operations to a specific shard.
|
25
|
+
# @option args [Enumerable<String>, String] :stored_fields If `true`, retrieves the document fields stored in the index rather than the document `_source`.
|
26
|
+
# @option args [String] :index Name of the index to retrieve documents from when `ids` are specified, or when a document in the `docs` array does not specify an index.
|
27
|
+
# @option args [Hash] :body *Required* Document identifiers; can be either `docs` (containing full document information) or `ids` (when index is provided in the URL.
|
28
|
+
def mget(args = {})
|
29
|
+
args = Utils.clone_and_normalize_arguments(args)
|
30
|
+
raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
|
52
31
|
|
53
|
-
|
32
|
+
_index = args.delete('index')
|
54
33
|
|
55
|
-
|
34
|
+
headers = args.delete('headers') || {}
|
35
|
+
body = args.delete('body')
|
36
|
+
method = body ? 'POST' : 'GET'
|
37
|
+
url = Utils.build_url(_index, '_mget')
|
56
38
|
|
57
|
-
|
39
|
+
Utils.validate_query_params! args, MGET_QUERY_PARAMS
|
40
|
+
transport.perform_request(method, url, args, body, headers).body
|
41
|
+
end
|
58
42
|
|
59
|
-
|
60
|
-
|
61
|
-
|
62
|
-
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
|
67
|
-
|
68
|
-
|
43
|
+
MGET_QUERY_PARAMS = Set.new(%w[
|
44
|
+
_source
|
45
|
+
_source_excludes
|
46
|
+
_source_includes
|
47
|
+
preference
|
48
|
+
realtime
|
49
|
+
refresh
|
50
|
+
routing
|
51
|
+
stored_fields
|
52
|
+
]).freeze
|
69
53
|
end
|
70
|
-
|
71
|
-
# Register this action with its valid params when the module is loaded.
|
72
|
-
#
|
73
|
-
# @since 6.2.0
|
74
|
-
ParamsRegistry.register(:mget, %i[
|
75
|
-
stored_fields
|
76
|
-
preference
|
77
|
-
realtime
|
78
|
-
refresh
|
79
|
-
routing
|
80
|
-
_source
|
81
|
-
_source_excludes
|
82
|
-
_source_includes
|
83
|
-
].freeze)
|
84
54
|
end
|
85
55
|
end
|
86
56
|
end
|
@@ -0,0 +1,32 @@
|
|
1
|
+
# SPDX-License-Identifier: Apache-2.0
|
2
|
+
#
|
3
|
+
# The OpenSearch Contributors require contributions made to
|
4
|
+
# this file be licensed under the Apache-2.0 license or a
|
5
|
+
# compatible open source 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
|
11
|
+
|
12
|
+
module OpenSearch
|
13
|
+
module API
|
14
|
+
module Ml
|
15
|
+
module Actions
|
16
|
+
# Creates a standalone connector.
|
17
|
+
#
|
18
|
+
# @option args [Hash] :body
|
19
|
+
def create_connector(args = {})
|
20
|
+
args = Utils.clone_and_normalize_arguments(args)
|
21
|
+
headers = args.delete('headers') || {}
|
22
|
+
body = args.delete('body')
|
23
|
+
method = 'POST'
|
24
|
+
url = '_plugins/_ml/connectors/_create'
|
25
|
+
|
26
|
+
Utils.validate_query_params! args
|
27
|
+
transport.perform_request(method, url, args, body, headers).body
|
28
|
+
end
|
29
|
+
end
|
30
|
+
end
|
31
|
+
end
|
32
|
+
end
|
@@ -0,0 +1,38 @@
|
|
1
|
+
# SPDX-License-Identifier: Apache-2.0
|
2
|
+
#
|
3
|
+
# The OpenSearch Contributors require contributions made to
|
4
|
+
# this file be licensed under the Apache-2.0 license or a
|
5
|
+
# compatible open source 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
|
11
|
+
|
12
|
+
module OpenSearch
|
13
|
+
module API
|
14
|
+
module Ml
|
15
|
+
module Actions
|
16
|
+
# Delete an agent.
|
17
|
+
#
|
18
|
+
# @option args [String] :agent_id *Required*
|
19
|
+
# @option args [List] :ignore set to [404] to ignore server's NOT FOUND error for this request
|
20
|
+
def delete_agent(args = {})
|
21
|
+
args = Utils.clone_and_normalize_arguments(args)
|
22
|
+
raise ArgumentError, "Required argument 'agent_id' missing" if args['agent_id'].nil?
|
23
|
+
|
24
|
+
_agent_id = args.delete('agent_id')
|
25
|
+
|
26
|
+
ignore = args.delete('ignore') || []
|
27
|
+
headers = args.delete('headers') || {}
|
28
|
+
body = args.delete('body')
|
29
|
+
method = 'DELETE'
|
30
|
+
url = Utils.build_url('_plugins/_ml/agents', _agent_id)
|
31
|
+
|
32
|
+
Utils.validate_query_params! args
|
33
|
+
transport.perform_delete_request method, url, args, body, headers, ignore.include?(404)
|
34
|
+
end
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
38
|
+
end
|
@@ -0,0 +1,38 @@
|
|
1
|
+
# SPDX-License-Identifier: Apache-2.0
|
2
|
+
#
|
3
|
+
# The OpenSearch Contributors require contributions made to
|
4
|
+
# this file be licensed under the Apache-2.0 license or a
|
5
|
+
# compatible open source 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
|
11
|
+
|
12
|
+
module OpenSearch
|
13
|
+
module API
|
14
|
+
module Ml
|
15
|
+
module Actions
|
16
|
+
# Deletes a standalone connector.
|
17
|
+
#
|
18
|
+
# @option args [String] :connector_id *Required*
|
19
|
+
# @option args [List] :ignore set to [404] to ignore server's NOT FOUND error for this request
|
20
|
+
def delete_connector(args = {})
|
21
|
+
args = Utils.clone_and_normalize_arguments(args)
|
22
|
+
raise ArgumentError, "Required argument 'connector_id' missing" if args['connector_id'].nil?
|
23
|
+
|
24
|
+
_connector_id = args.delete('connector_id')
|
25
|
+
|
26
|
+
ignore = args.delete('ignore') || []
|
27
|
+
headers = args.delete('headers') || {}
|
28
|
+
body = args.delete('body')
|
29
|
+
method = 'DELETE'
|
30
|
+
url = Utils.build_url('_plugins/_ml/connectors', _connector_id)
|
31
|
+
|
32
|
+
Utils.validate_query_params! args
|
33
|
+
transport.perform_delete_request method, url, args, body, headers, ignore.include?(404)
|
34
|
+
end
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
38
|
+
end
|