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
@@ -3,85 +3,58 @@
|
|
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
|
-
# Modifications Copyright OpenSearch Contributors. See
|
8
|
-
# GitHub history for details.
|
9
|
-
#
|
10
|
-
# Licensed to Elasticsearch B.V. under one or more contributor
|
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.
|
26
|
-
|
27
|
-
module OpenSearch
|
28
|
-
module API
|
29
|
-
module Actions
|
30
|
-
# Returns the source of a document.
|
31
|
-
#
|
32
|
-
# @option arguments [String] :id The document ID
|
33
|
-
# @option arguments [String] :index The name of the index
|
34
|
-
# @option arguments [String] :preference Specify the node or shard the operation should be performed on (default: random)
|
35
|
-
# @option arguments [Boolean] :realtime Specify whether to perform the operation in realtime or search mode
|
36
|
-
# @option arguments [Boolean] :refresh Refresh the shard containing the document before performing the operation
|
37
|
-
# @option arguments [String] :routing Specific routing value
|
38
|
-
# @option arguments [List] :_source True or false to return the _source field or not, or a list of fields to return
|
39
|
-
# @option arguments [List] :_source_excludes A list of fields to exclude from the returned _source field
|
40
|
-
# @option arguments [List] :_source_includes A list of fields to extract and return from the _source field
|
41
|
-
# @option arguments [Number] :version Explicit version number for concurrency control
|
42
|
-
# @option arguments [String] :version_type Specific version type (options: internal, external, external_gte, force)
|
43
|
-
# @option arguments [Hash] :headers Custom HTTP headers
|
44
|
-
#
|
45
|
-
# *Deprecation notice*:
|
46
|
-
# Specifying types in urls has been deprecated
|
47
|
-
# Deprecated since version 7.0.0
|
48
|
-
#
|
49
|
-
#
|
50
|
-
#
|
51
|
-
def get_source(arguments = {})
|
52
|
-
raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
|
53
|
-
raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
|
54
6
|
|
55
|
-
|
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.
|
56
9
|
|
57
|
-
|
10
|
+
# frozen_string_literal: true
|
58
11
|
|
59
|
-
|
60
|
-
|
61
|
-
|
62
|
-
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
|
67
|
-
|
68
|
-
|
12
|
+
module OpenSearch
|
13
|
+
module API
|
14
|
+
module Root
|
15
|
+
module Actions
|
16
|
+
# Returns the source of a document.
|
17
|
+
#
|
18
|
+
# @option args [String] :id *Required* Unique identifier of the document.
|
19
|
+
# @option args [String] :index *Required* Name of the index that contains the document.
|
20
|
+
# @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.
|
21
|
+
# @option args [Enumerable<String>, String] :_source_excludes A comma-separated list of source fields to exclude in the response.
|
22
|
+
# @option args [Enumerable<String>, String] :_source_includes A comma-separated list of source fields to include in the response.
|
23
|
+
# @option args [String] :preference (default: random) Specifies the node or shard the operation should be performed on. Random by default.
|
24
|
+
# @option args [Boolean] :realtime Boolean) If `true`, the request is real-time as opposed to near-real-time.
|
25
|
+
# @option args [Boolean, String] :refresh If `true`, OpenSearch refreshes the affected shards to make this operation visible to search. If `false`, do nothing with refreshes.
|
26
|
+
# @option args [Enumerable<String>, String] :routing Target the specified primary shard.
|
27
|
+
# @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.
|
28
|
+
# @option args [String] :version_type Specific version type. One of `internal`, `external`, `external_gte`.
|
29
|
+
def get_source(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
|
+
|
34
|
+
_id = args.delete('id')
|
35
|
+
_index = args.delete('index')
|
36
|
+
|
37
|
+
headers = args.delete('headers') || {}
|
38
|
+
body = args.delete('body')
|
39
|
+
method = 'GET'
|
40
|
+
url = Utils.build_url(_index, '_source', _id)
|
41
|
+
|
42
|
+
Utils.validate_query_params! args, GET_SOURCE_QUERY_PARAMS
|
43
|
+
transport.perform_request(method, url, args, body, headers).body
|
44
|
+
end
|
45
|
+
|
46
|
+
GET_SOURCE_QUERY_PARAMS = Set.new(%w[
|
47
|
+
_source
|
48
|
+
_source_excludes
|
49
|
+
_source_includes
|
50
|
+
preference
|
51
|
+
realtime
|
52
|
+
refresh
|
53
|
+
routing
|
54
|
+
version
|
55
|
+
version_type
|
56
|
+
]).freeze
|
69
57
|
end
|
70
|
-
|
71
|
-
# Register this action with its valid params when the module is loaded.
|
72
|
-
#
|
73
|
-
# @since 6.2.0
|
74
|
-
ParamsRegistry.register(:get_source, %i[
|
75
|
-
preference
|
76
|
-
realtime
|
77
|
-
refresh
|
78
|
-
routing
|
79
|
-
_source
|
80
|
-
_source_excludes
|
81
|
-
_source_includes
|
82
|
-
version
|
83
|
-
version_type
|
84
|
-
].freeze)
|
85
58
|
end
|
86
59
|
end
|
87
60
|
end
|
@@ -3,94 +3,63 @@
|
|
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
|
-
# Modifications Copyright OpenSearch Contributors. See
|
8
|
-
# GitHub history for details.
|
9
|
-
#
|
10
|
-
# Licensed to Elasticsearch B.V. under one or more contributor
|
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.
|
26
6
|
|
27
|
-
|
28
|
-
|
29
|
-
module Actions
|
30
|
-
# Creates or updates a document in an index.
|
31
|
-
#
|
32
|
-
# @option arguments [String] :id Document ID
|
33
|
-
# @option arguments [String] :index The name of the index
|
34
|
-
# @option arguments [String] :wait_for_active_shards Sets the number of shard copies that must be active before proceeding with the index operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
|
35
|
-
# @option arguments [String] :op_type Explicit operation type. Defaults to `index` for requests with an explicit document ID, and to `create`for requests without an explicit document ID (options: index, create)
|
36
|
-
# @option arguments [String] :refresh If `true` then refresh 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` (the default) then do nothing with refreshes. (options: true, false, wait_for)
|
37
|
-
# @option arguments [String] :routing Specific routing value
|
38
|
-
# @option arguments [Time] :timeout Explicit operation timeout
|
39
|
-
# @option arguments [Number] :version Explicit version number for concurrency control
|
40
|
-
# @option arguments [String] :version_type Specific version type (options: internal, external, external_gte)
|
41
|
-
# @option arguments [Number] :if_seq_no only perform the index operation if the last operation that has changed the document has the specified sequence number
|
42
|
-
# @option arguments [Number] :if_primary_term only perform the index operation if the last operation that has changed the document has the specified primary term
|
43
|
-
# @option arguments [String] :pipeline The pipeline id to preprocess incoming documents with
|
44
|
-
# @option arguments [Boolean] :require_alias When true, requires destination to be an alias. Default is false
|
45
|
-
# @option arguments [Hash] :headers Custom HTTP headers
|
46
|
-
# @option arguments [Hash] :body The document (*Required*)
|
47
|
-
#
|
48
|
-
# *Deprecation notice*:
|
49
|
-
# Specifying types in urls has been deprecated
|
50
|
-
# Deprecated since version 7.0.0
|
51
|
-
#
|
52
|
-
#
|
53
|
-
#
|
54
|
-
def index(arguments = {})
|
55
|
-
raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
|
56
|
-
raise ArgumentError, "Required argument 'index' missing" unless arguments[:index]
|
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.
|
57
9
|
|
58
|
-
|
10
|
+
# frozen_string_literal: true
|
59
11
|
|
60
|
-
|
12
|
+
module OpenSearch
|
13
|
+
module API
|
14
|
+
module Root
|
15
|
+
module Actions
|
16
|
+
# Creates or updates a document in an index.
|
17
|
+
#
|
18
|
+
# @option args [String] :index *Required* Name of the data stream or index to target.
|
19
|
+
# @option args [Integer] :if_primary_term Only perform the operation if the document has this primary term.
|
20
|
+
# @option args [Integer] :if_seq_no Only perform the operation if the document has this sequence number.
|
21
|
+
# @option args [String] :op_type Set to create to only index the document if it does not already exist (put if absent). If a document with the specified `_id` already exists, the indexing operation will fail. Same as using the `<index>/_create` endpoint. Valid values: `index`, `create`. If document id is specified, it defaults to `index`. Otherwise, it defaults to `create`.
|
22
|
+
# @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.
|
23
|
+
# @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`.
|
24
|
+
# @option args [Boolean] :require_alias If `true`, the destination must be an index alias.
|
25
|
+
# @option args [Enumerable<String>, String] :routing Custom value used to route operations to a specific shard.
|
26
|
+
# @option args [String] :timeout Period the request waits for the following operations: automatic index creation, dynamic mapping updates, waiting for active shards.
|
27
|
+
# @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.
|
28
|
+
# @option args [String] :version_type Specific version type: `external`, `external_gte`.
|
29
|
+
# @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`).
|
30
|
+
# @option args [String] :id Unique identifier for the document.
|
31
|
+
# @option args [Hash] :body *Required* The document
|
32
|
+
def index(args = {})
|
33
|
+
args = Utils.clone_and_normalize_arguments(args)
|
34
|
+
raise ArgumentError, "Required argument 'index' missing" if args['index'].nil?
|
35
|
+
raise ArgumentError, "Required argument 'body' missing" if args['body'].nil?
|
61
36
|
|
62
|
-
|
37
|
+
_index = args.delete('index')
|
38
|
+
_id = args.delete('id')
|
63
39
|
|
64
|
-
|
40
|
+
headers = args.delete('headers') || {}
|
41
|
+
body = args.delete('body')
|
42
|
+
method = _id.nil? ? 'POST' : 'PUT'
|
43
|
+
url = Utils.build_url(_index, '_doc', _id)
|
65
44
|
|
66
|
-
|
67
|
-
|
68
|
-
|
69
|
-
else
|
70
|
-
"#{Utils.__listify(_index)}/_doc"
|
71
|
-
end
|
72
|
-
params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
|
45
|
+
Utils.validate_query_params! args, INDEX_QUERY_PARAMS
|
46
|
+
transport.perform_request(method, url, args, body, headers).body
|
47
|
+
end
|
73
48
|
|
74
|
-
|
75
|
-
|
49
|
+
INDEX_QUERY_PARAMS = Set.new(%w[
|
50
|
+
if_primary_term
|
51
|
+
if_seq_no
|
52
|
+
op_type
|
53
|
+
pipeline
|
54
|
+
refresh
|
55
|
+
require_alias
|
56
|
+
routing
|
57
|
+
timeout
|
58
|
+
version
|
59
|
+
version_type
|
60
|
+
wait_for_active_shards
|
61
|
+
]).freeze
|
76
62
|
end
|
77
|
-
|
78
|
-
# Register this action with its valid params when the module is loaded.
|
79
|
-
#
|
80
|
-
# @since 6.2.0
|
81
|
-
ParamsRegistry.register(:index, %i[
|
82
|
-
wait_for_active_shards
|
83
|
-
op_type
|
84
|
-
refresh
|
85
|
-
routing
|
86
|
-
timeout
|
87
|
-
version
|
88
|
-
version_type
|
89
|
-
if_seq_no
|
90
|
-
if_primary_term
|
91
|
-
pipeline
|
92
|
-
require_alias
|
93
|
-
].freeze)
|
94
63
|
end
|
95
64
|
end
|
96
65
|
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,48 +15,39 @@ module OpenSearch
|
|
30
15
|
module Actions
|
31
16
|
# Adds a block to an index.
|
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
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
52
|
-
|
53
|
-
|
54
|
-
|
55
|
-
|
56
|
-
method = OpenSearch::API::HTTP_PUT
|
57
|
-
path = "#{Utils.__listify(_index)}/_block/#{Utils.__listify(_block)}"
|
58
|
-
params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
|
59
|
-
|
60
|
-
body = nil
|
61
|
-
perform_request(method, path, params, body, headers).body
|
18
|
+
# @option args [String] :block *Required* The block to add (one of `read`, `write`, `read_only` or `metadata`).
|
19
|
+
# @option args [Enumerable<String>, String] :index *Required* A comma separated list of indexes to add a block to.
|
20
|
+
# @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).
|
21
|
+
# @option args [String] :cluster_manager_timeout Operation timeout for connection to cluster-manager node.
|
22
|
+
# @option args [Enumerable<String>, String] :expand_wildcards Whether to expand wildcard expression to concrete indexes that are open, closed or both.
|
23
|
+
# @option args [Boolean] :ignore_unavailable Whether specified concrete indexes should be ignored when unavailable (missing or closed).
|
24
|
+
# @option args [String] :master_timeout DEPRECATED Specify timeout for connection to cluster manager.
|
25
|
+
# @option args [String] :timeout Explicit operation timeout
|
26
|
+
def add_block(args = {})
|
27
|
+
args = Utils.clone_and_normalize_arguments(args)
|
28
|
+
raise ArgumentError, "Required argument 'block' missing" if args['block'].nil?
|
29
|
+
raise ArgumentError, "Required argument 'index' missing" if args['index'].nil?
|
30
|
+
|
31
|
+
_block = args.delete('block')
|
32
|
+
_index = args.delete('index')
|
33
|
+
|
34
|
+
headers = args.delete('headers') || {}
|
35
|
+
body = args.delete('body')
|
36
|
+
method = 'PUT'
|
37
|
+
url = Utils.build_url(_index, '_block', _block)
|
38
|
+
|
39
|
+
Utils.validate_query_params! args, ADD_BLOCK_QUERY_PARAMS
|
40
|
+
transport.perform_request(method, url, args, body, headers).body
|
62
41
|
end
|
63
42
|
|
64
|
-
|
65
|
-
#
|
66
|
-
# @since 6.2.0
|
67
|
-
ParamsRegistry.register(:add_block, %i[
|
68
|
-
timeout
|
69
|
-
master_timeout
|
70
|
-
cluster_manager_timeout
|
71
|
-
ignore_unavailable
|
43
|
+
ADD_BLOCK_QUERY_PARAMS = Set.new(%w[
|
72
44
|
allow_no_indices
|
45
|
+
cluster_manager_timeout
|
73
46
|
expand_wildcards
|
74
|
-
|
47
|
+
ignore_unavailable
|
48
|
+
master_timeout
|
49
|
+
timeout
|
50
|
+
]).freeze
|
75
51
|
end
|
76
52
|
end
|
77
53
|
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,41 +15,20 @@ module OpenSearch
|
|
30
15
|
module Actions
|
31
16
|
# Performs the analysis process on a text and return the tokens breakdown of the text.
|
32
17
|
#
|
33
|
-
# @option
|
34
|
-
# @option
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
def analyze(arguments = {})
|
39
|
-
headers = arguments.delete(:headers) || {}
|
40
|
-
|
41
|
-
arguments = arguments.clone
|
42
|
-
|
43
|
-
_index = arguments.delete(:index)
|
18
|
+
# @option args [String] :index The name of the index to scope the operation.
|
19
|
+
# @option args [Hash] :body Define analyzer/tokenizer parameters and the text on which the analysis should be performed
|
20
|
+
def analyze(args = {})
|
21
|
+
args = Utils.clone_and_normalize_arguments(args)
|
22
|
+
_index = args.delete('index')
|
44
23
|
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
end
|
24
|
+
headers = args.delete('headers') || {}
|
25
|
+
body = args.delete('body')
|
26
|
+
method = body ? 'POST' : 'GET'
|
27
|
+
url = Utils.build_url(_index, '_analyze')
|
50
28
|
|
51
|
-
|
52
|
-
|
53
|
-
else
|
54
|
-
'_analyze'
|
55
|
-
end
|
56
|
-
params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
|
57
|
-
|
58
|
-
body = arguments[:body]
|
59
|
-
perform_request(method, path, params, body, headers).body
|
29
|
+
Utils.validate_query_params! args
|
30
|
+
transport.perform_request(method, url, args, body, headers).body
|
60
31
|
end
|
61
|
-
|
62
|
-
# Register this action with its valid params when the module is loaded.
|
63
|
-
#
|
64
|
-
# @since 6.2.0
|
65
|
-
ParamsRegistry.register(:analyze, [
|
66
|
-
:index
|
67
|
-
].freeze)
|
68
32
|
end
|
69
33
|
end
|
70
34
|
end
|
@@ -3,76 +3,50 @@
|
|
3
3
|
# The OpenSearch Contributors require contributions made to
|
4
4
|
# this file be licensed under the Apache-2.0 license or a
|
5
5
|
# compatible open source license.
|
6
|
-
|
7
|
-
#
|
8
|
-
#
|
9
|
-
|
10
|
-
#
|
11
|
-
# license agreements. See the NOTICE file distributed with
|
12
|
-
# this work for additional information regarding copyright
|
13
|
-
# ownership. Elasticsearch B.V. licenses this file to you under
|
14
|
-
# the Apache License, Version 2.0 (the "License"); you may
|
15
|
-
# not use this file except in compliance with the License.
|
16
|
-
# You may obtain a copy of the License at
|
17
|
-
#
|
18
|
-
# http://www.apache.org/licenses/LICENSE-2.0
|
19
|
-
#
|
20
|
-
# Unless required by applicable law or agreed to in writing,
|
21
|
-
# software distributed under the License is distributed on an
|
22
|
-
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
23
|
-
# KIND, either express or implied. See the License for the
|
24
|
-
# specific language governing permissions and limitations
|
25
|
-
# under the License.
|
6
|
+
|
7
|
+
# This file is generated from the OpenSearch REST API spec.
|
8
|
+
# Do not modify it by hand. Instead, modify the generator or the spec.
|
9
|
+
|
10
|
+
# frozen_string_literal: true
|
26
11
|
|
27
12
|
module OpenSearch
|
28
13
|
module API
|
29
14
|
module Indices
|
30
15
|
module Actions
|
31
|
-
# Clears all or specific caches for one or more
|
32
|
-
#
|
33
|
-
# @option arguments [List] :index A comma-separated list of index name to limit the operation
|
34
|
-
# @option arguments [Boolean] :fielddata Clear field data
|
35
|
-
# @option arguments [List] :fields A comma-separated list of fields to clear when using the `fielddata` parameter (default: all)
|
36
|
-
# @option arguments [Boolean] :query Clear query caches
|
37
|
-
# @option arguments [Boolean] :ignore_unavailable Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
38
|
-
# @option arguments [Boolean] :allow_no_indices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
|
39
|
-
# @option arguments [String] :expand_wildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. (options: open, closed, hidden, none, all)
|
40
|
-
# @option arguments [Boolean] :request Clear request cache
|
41
|
-
# @option arguments [Hash] :headers Custom HTTP headers
|
16
|
+
# Clears all or specific caches for one or more indexes.
|
42
17
|
#
|
43
|
-
#
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
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 [Enumerable<String>, String] :expand_wildcards Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`.
|
20
|
+
# @option args [Boolean] :fielddata If `true`, clears the fields cache. Use the `fields` parameter to clear the cache of specific fields only.
|
21
|
+
# @option args [Enumerable<String>, String] :fields Comma-separated list of field names used to limit the `fielddata` parameter.
|
22
|
+
# @option args [Boolean] :file If `true`, clears the unused entries from the file cache on nodes with the Search role.
|
23
|
+
# @option args [Boolean] :ignore_unavailable If `false`, the request returns an error if it targets a missing or closed index.
|
24
|
+
# @option args [Enumerable<String>] :index Comma-separated list of indexes; use `_all` or empty string to perform the operation on all indexes.
|
25
|
+
# @option args [Boolean] :query If `true`, clears the query cache.
|
26
|
+
# @option args [Boolean] :request If `true`, clears the request cache.
|
27
|
+
def clear_cache(args = {})
|
28
|
+
args = Utils.clone_and_normalize_arguments(args)
|
29
|
+
_index = args.delete('index')
|
48
30
|
|
49
|
-
|
31
|
+
headers = args.delete('headers') || {}
|
32
|
+
body = args.delete('body')
|
33
|
+
method = 'POST'
|
34
|
+
url = Utils.build_url(_index, '_cache/clear')
|
50
35
|
|
51
|
-
|
52
|
-
|
53
|
-
"#{Utils.__listify(_index)}/_cache/clear"
|
54
|
-
else
|
55
|
-
'_cache/clear'
|
56
|
-
end
|
57
|
-
params = Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
|
58
|
-
|
59
|
-
body = nil
|
60
|
-
perform_request(method, path, params, body, headers).body
|
36
|
+
Utils.validate_query_params! args, CLEAR_CACHE_QUERY_PARAMS
|
37
|
+
transport.perform_request(method, url, args, body, headers).body
|
61
38
|
end
|
62
39
|
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
ParamsRegistry.register(:clear_cache, %i[
|
40
|
+
CLEAR_CACHE_QUERY_PARAMS = Set.new(%w[
|
41
|
+
allow_no_indices
|
42
|
+
expand_wildcards
|
67
43
|
fielddata
|
68
44
|
fields
|
69
|
-
|
45
|
+
file
|
70
46
|
ignore_unavailable
|
71
|
-
|
72
|
-
expand_wildcards
|
73
|
-
index
|
47
|
+
query
|
74
48
|
request
|
75
|
-
].freeze
|
49
|
+
]).freeze
|
76
50
|
end
|
77
51
|
end
|
78
52
|
end
|