elastic-enterprise-search 7.12.1 → 7.15.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.ci/functions/imports.sh +1 -0
- data/.ci/jobs/defaults.yml +4 -0
- data/.ci/jobs/elastic+enterprise-search-ruby+7.10.0.beta.1.yml +12 -0
- data/.ci/jobs/{elastic+enterprise-search-ruby+7.11.yml → elastic+enterprise-search-ruby+main.yml} +4 -4
- data/.ci/make.sh +162 -0
- data/.ci/run-repository.sh +2 -1
- data/.ci/test-matrix.yml +5 -3
- data/{spec/app-search/api_logs_spec.rb → .github/check_license_headers.rb} +13 -16
- data/.github/license-header.txt +16 -0
- data/.github/workflows/license.yml +13 -0
- data/.github/workflows/testing.yml +1 -1
- data/CONTRIBUTING.md +1 -1
- data/README.md +1 -1
- data/Rakefile +20 -0
- data/docs/guide/app-search-api.asciidoc +157 -1
- data/docs/guide/connecting.asciidoc +47 -1
- data/docs/guide/overview.asciidoc +3 -3
- data/docs/guide/release_notes/712.asciidoc +0 -10
- data/docs/guide/release_notes/713.asciidoc +21 -0
- data/docs/guide/release_notes/714.asciidoc +21 -0
- data/docs/guide/release_notes/715.asciidoc +36 -0
- data/docs/guide/release_notes/index.asciidoc +6 -0
- data/docs/guide/workplace-search-api.asciidoc +115 -2
- data/elastic-enterprise-search.gemspec +1 -1
- data/lib/elastic/app-search/api/add_meta_engine_source.rb +3 -2
- data/lib/elastic/app-search/api/api_key.rb +52 -0
- data/lib/elastic/app-search/api/api_logs.rb +14 -13
- data/lib/elastic/app-search/api/count_analytics.rb +7 -6
- data/lib/elastic/app-search/api/crawler_active_crawl_request.rb +51 -0
- data/lib/elastic/app-search/api/crawler_crawl_request.rb +54 -0
- data/lib/elastic/app-search/api/crawler_crawl_schedule.rb +51 -0
- data/lib/elastic/app-search/api/crawler_domain.rb +54 -0
- data/lib/elastic/app-search/api/crawler_domain_validation_result.rb +48 -0
- data/lib/elastic/app-search/api/crawler_metrics.rb +48 -0
- data/lib/elastic/app-search/api/crawler_overview.rb +51 -0
- data/lib/elastic/app-search/api/crawler_process_crawl.rb +54 -0
- data/lib/elastic/app-search/api/crawler_process_crawl_denied_urls.rb +54 -0
- data/lib/elastic/app-search/api/crawler_url_extraction_result.rb +52 -0
- data/lib/elastic/app-search/api/crawler_url_tracing_result.rb +52 -0
- data/lib/elastic/app-search/api/crawler_url_validation_result.rb +52 -0
- data/lib/elastic/app-search/api/crawler_user_agent.rb +48 -0
- data/lib/elastic/app-search/api/create_api_key.rb +57 -0
- data/lib/elastic/app-search/api/create_crawler_crawl_request.rb +51 -0
- data/lib/elastic/app-search/api/create_crawler_crawl_rule.rb +59 -0
- data/lib/elastic/app-search/api/create_crawler_domain.rb +55 -0
- data/lib/elastic/app-search/api/create_crawler_entry_point.rb +56 -0
- data/lib/elastic/app-search/api/create_crawler_process_crawl.rb +53 -0
- data/lib/elastic/app-search/api/create_crawler_sitemap.rb +56 -0
- data/lib/elastic/app-search/api/create_curation.rb +7 -6
- data/lib/elastic/app-search/api/create_engine.rb +9 -7
- data/lib/elastic/app-search/api/create_synonym_set.rb +7 -4
- data/lib/elastic/app-search/api/curation.rb +4 -3
- data/lib/elastic/app-search/api/delete_active_crawl_request.rb +51 -0
- data/lib/elastic/app-search/api/delete_api_key.rb +52 -0
- data/lib/elastic/app-search/api/delete_crawler_active_crawl_request.rb +51 -0
- data/lib/elastic/app-search/api/delete_crawler_crawl_rule.rb +57 -0
- data/lib/elastic/app-search/api/delete_crawler_crawl_schedule.rb +51 -0
- data/lib/elastic/app-search/api/delete_crawler_domain.rb +54 -0
- data/lib/elastic/app-search/api/delete_crawler_entry_point.rb +57 -0
- data/lib/elastic/app-search/api/delete_crawler_sitemap.rb +57 -0
- data/lib/elastic/app-search/api/delete_curation.rb +4 -3
- data/lib/elastic/app-search/api/delete_documents.rb +2 -1
- data/lib/elastic/app-search/api/delete_engine.rb +3 -2
- data/lib/elastic/app-search/api/delete_meta_engine_source.rb +3 -3
- data/lib/elastic/app-search/api/delete_synonym_set.rb +4 -3
- data/lib/elastic/app-search/api/denied_urls.rb +54 -0
- data/lib/elastic/app-search/api/documents.rb +3 -2
- data/lib/elastic/app-search/api/engine.rb +3 -2
- data/lib/elastic/app-search/api/index_documents.rb +3 -2
- data/lib/elastic/app-search/api/list_api_keys.rb +50 -0
- data/lib/elastic/app-search/api/list_crawler_crawl_requests.rb +52 -0
- data/lib/elastic/app-search/api/list_crawler_process_crawls.rb +51 -0
- data/lib/elastic/app-search/api/list_curations.rb +3 -2
- data/lib/elastic/app-search/api/list_documents.rb +3 -2
- data/lib/elastic/app-search/api/list_engines.rb +2 -1
- data/lib/elastic/app-search/api/list_synonym_sets.rb +3 -2
- data/lib/elastic/app-search/api/log_clickthrough.rb +8 -10
- data/lib/elastic/app-search/api/put_api_key.rb +59 -0
- data/lib/elastic/app-search/api/put_crawler_crawl_rule.rb +62 -0
- data/lib/elastic/app-search/api/put_crawler_crawl_schedule.rb +53 -0
- data/lib/elastic/app-search/api/put_crawler_domain.rb +58 -0
- data/lib/elastic/app-search/api/put_crawler_entry_point.rb +59 -0
- data/lib/elastic/app-search/api/put_crawler_sitemap.rb +59 -0
- data/lib/elastic/app-search/api/put_curation.rb +9 -8
- data/lib/elastic/app-search/api/put_documents.rb +3 -3
- data/lib/elastic/app-search/api/put_schema.rb +4 -4
- data/lib/elastic/app-search/api/put_search_settings.rb +6 -2
- data/lib/elastic/app-search/api/put_synonym_set.rb +8 -5
- data/lib/elastic/app-search/api/query_suggestion.rb +7 -7
- data/lib/elastic/app-search/api/reset_search_settings.rb +3 -2
- data/lib/elastic/app-search/api/schema.rb +3 -2
- data/lib/elastic/app-search/api/search.rb +14 -3
- data/lib/elastic/app-search/api/search_settings.rb +3 -2
- data/lib/elastic/app-search/api/synonym_set.rb +4 -3
- data/lib/elastic/app-search/api/top_clicks_analytics.rb +8 -8
- data/lib/elastic/app-search/api/top_queries_analytics.rb +7 -7
- data/lib/elastic/app-search/app_search.rb +0 -10
- data/lib/elastic/enterprise-search/api/health.rb +1 -0
- data/lib/elastic/enterprise-search/api/put_read_only.rb +3 -0
- data/lib/elastic/enterprise-search/api/read_only.rb +1 -0
- data/lib/elastic/enterprise-search/api/version.rb +1 -0
- data/lib/elastic/enterprise-search/client.rb +0 -16
- data/lib/elastic/enterprise-search/request.rb +14 -3
- data/lib/elastic/enterprise-search/version.rb +1 -1
- data/lib/elastic/enterprise_search.rb +11 -0
- data/lib/elastic/workplace-search/api/auto_query_refinement_details.rb +49 -0
- data/lib/elastic/workplace-search/api/command_sync_jobs.rb +53 -0
- data/lib/elastic/workplace-search/api/content_source.rb +49 -0
- data/lib/elastic/workplace-search/api/create_analytics_event.rb +8 -8
- data/lib/elastic/workplace-search/api/create_batch_synonym_sets.rb +50 -0
- data/lib/elastic/workplace-search/api/create_content_source.rb +55 -0
- data/lib/elastic/workplace-search/api/create_external_identity.rb +3 -1
- data/lib/elastic/workplace-search/api/current_user.rb +47 -0
- data/lib/elastic/workplace-search/api/delete_all_documents.rb +49 -0
- data/lib/elastic/workplace-search/api/delete_content_source.rb +49 -0
- data/lib/elastic/workplace-search/api/delete_documents.rb +1 -1
- data/lib/elastic/workplace-search/api/delete_documents_by_query.rb +50 -0
- data/lib/elastic/workplace-search/api/delete_synonym_set.rb +51 -0
- data/lib/elastic/workplace-search/api/document.rb +53 -0
- data/lib/elastic/workplace-search/api/list_content_sources.rb +48 -0
- data/lib/elastic/workplace-search/api/list_synonym_sets.rb +51 -0
- data/lib/elastic/workplace-search/api/put_content_source.rb +58 -0
- data/lib/elastic/workplace-search/api/put_content_source_icons.rb +53 -0
- data/lib/elastic/workplace-search/api/put_external_identity.rb +3 -1
- data/lib/elastic/workplace-search/api/put_synonym_set.rb +53 -0
- data/lib/elastic/workplace-search/api/put_triggers_blocklist.rb +47 -0
- data/lib/elastic/workplace-search/api/search.rb +4 -1
- data/lib/elastic/workplace-search/api/synonym_set.rb +51 -0
- data/lib/elastic/workplace-search/api/triggers_blocklist.rb +45 -0
- data/lib/elastic/workplace-search/workplace_search.rb +0 -10
- data/rake_tasks/unified_release_tasks.rake +46 -0
- data/spec/enterprise-search/client_spec.rb +0 -1
- data/spec/enterprise-search/request_spec.rb +26 -0
- data/spec/integration/app-search/api_key_spec.rb +110 -0
- data/spec/integration/app-search/api_logs_spec.rb +59 -0
- data/spec/integration/app-search/app_search_helper.rb +39 -0
- data/spec/integration/app-search/count_analytics_spec.rb +47 -0
- data/spec/integration/app-search/crawl_requests_spec.rb +86 -0
- data/spec/integration/app-search/crawler_crawl_rule_spec.rb +73 -0
- data/spec/integration/app-search/crawler_domain_spec.rb +82 -0
- data/spec/integration/app-search/crawler_entry_point_spec.rb +89 -0
- data/spec/integration/app-search/crawler_metrics_spec.rb +46 -0
- data/spec/integration/app-search/crawler_overview_spec.rb +45 -0
- data/spec/integration/app-search/crawler_process_crawl_denied_urls_spec.rb +50 -0
- data/spec/integration/app-search/crawler_process_crawl_spec.rb +66 -0
- data/spec/integration/app-search/crawler_scheduling_spec.rb +81 -0
- data/spec/integration/app-search/crawler_sitemap_spec.rb +72 -0
- data/spec/integration/app-search/crawler_urls_spec.rb +60 -0
- data/spec/{app-search/api_count_analytics_spec.rb → integration/app-search/crawler_user_agent_spec.rb} +6 -9
- data/spec/integration/app-search/curations_spec.rb +118 -0
- data/spec/integration/app-search/documents_spec.rb +123 -0
- data/spec/integration/app-search/engines_spec.rb +77 -0
- data/spec/{app-search/api_log_clickthrough_spec.rb → integration/app-search/log_clickthrough_spec.rb} +14 -7
- data/spec/integration/app-search/meta_engines_spec.rb +75 -0
- data/spec/integration/app-search/query_suggestion_spec.rb +50 -0
- data/spec/{app-search/api_schema_spec.rb → integration/app-search/schema_spec.rb} +21 -16
- data/spec/integration/app-search/search_and_multiple_search_spec.rb +67 -0
- data/spec/integration/app-search/search_settings_spec.rb +87 -0
- data/spec/integration/app-search/synonyms_spec.rb +79 -0
- data/spec/{app-search/api_top_clicks_analytics_spec.rb → integration/app-search/top_clicks_analytics_spec.rb} +20 -14
- data/spec/{app-search/api_top_queries_analytics_spec.rb → integration/app-search/top_queries_analytics_spec.rb} +16 -8
- data/spec/integration/enterprise_search_api_spec.rb +4 -0
- data/spec/integration/workplace-search/content_sources_spec.rb +106 -0
- data/spec/integration/workplace-search/documents_spec.rb +95 -0
- data/spec/{workplace-search → integration/workplace-search}/external_identities_spec.rb +37 -24
- data/spec/integration/workplace-search/icon.png +0 -0
- data/spec/integration/workplace-search/permissions_spec.rb +77 -0
- data/spec/integration/workplace-search/synonym_sets_spec.rb +92 -0
- data/spec/integration/workplace-search/triggers_spec.rb +43 -0
- data/spec/{app-search/api_query_suggestion_spec.rb → integration/workplace-search/users_spec.rb} +12 -15
- data/spec/integration/workplace-search/workplace_search_helper.rb +39 -0
- data/spec/webmock_requires.rb +16 -0
- data/spec/workplace-search/client_spec.rb +24 -2
- metadata +112 -83
- data/.ci/jobs/elastic+enterprise-search-ruby+master.yml +0 -12
- data/spec/app-search/api_curations_spec.rb +0 -97
- data/spec/app-search/api_documents_spec.rb +0 -102
- data/spec/app-search/api_engines_spec.rb +0 -67
- data/spec/app-search/api_meta_engines_spec.rb +0 -72
- data/spec/app-search/api_search_and_multi_search_spec.rb +0 -48
- data/spec/app-search/api_search_settings_spec.rb +0 -76
- data/spec/app-search/api_spec_helper.rb +0 -14
- data/spec/app-search/api_synonyms_spec.rb +0 -79
- data/spec/fixtures/vcr/app_search/add_meta_engine_source.yml +0 -109
- data/spec/fixtures/vcr/app_search/api_documents.yml +0 -56
- data/spec/fixtures/vcr/app_search/api_index_documents.yml +0 -57
- data/spec/fixtures/vcr/app_search/api_log_clickthrough.yml +0 -54
- data/spec/fixtures/vcr/app_search/api_logs.yml +0 -70
- data/spec/fixtures/vcr/app_search/api_put_schema.yml +0 -109
- data/spec/fixtures/vcr/app_search/api_put_search_settings.yml +0 -56
- data/spec/fixtures/vcr/app_search/api_query_suggestion.yml +0 -59
- data/spec/fixtures/vcr/app_search/api_reset_search_settings.yml +0 -56
- data/spec/fixtures/vcr/app_search/api_schema.yml +0 -56
- data/spec/fixtures/vcr/app_search/api_search_settings.yml +0 -56
- data/spec/fixtures/vcr/app_search/api_top_clicks_analytics.yml +0 -55
- data/spec/fixtures/vcr/app_search/api_top_clicks_analytics_query.yml +0 -55
- data/spec/fixtures/vcr/app_search/api_top_queries_analytics.yml +0 -55
- data/spec/fixtures/vcr/app_search/count_analytics.yml +0 -55
- data/spec/fixtures/vcr/app_search/create_and_update_document.yml +0 -107
- data/spec/fixtures/vcr/app_search/create_curation.yml +0 -113
- data/spec/fixtures/vcr/app_search/create_engine.yml +0 -55
- data/spec/fixtures/vcr/app_search/create_meta_engine.yml +0 -56
- data/spec/fixtures/vcr/app_search/create_synonym_set.yml +0 -56
- data/spec/fixtures/vcr/app_search/delete_curation.yml +0 -56
- data/spec/fixtures/vcr/app_search/delete_engine.yml +0 -55
- data/spec/fixtures/vcr/app_search/delete_meta_engine_source.yml +0 -56
- data/spec/fixtures/vcr/app_search/delete_synonym_set.yml +0 -56
- data/spec/fixtures/vcr/app_search/get_curation.yml +0 -56
- data/spec/fixtures/vcr/app_search/get_engine.yml +0 -55
- data/spec/fixtures/vcr/app_search/index_and_delete_document.yml +0 -107
- data/spec/fixtures/vcr/app_search/list_curations.yml +0 -56
- data/spec/fixtures/vcr/app_search/list_documents.yml +0 -57
- data/spec/fixtures/vcr/app_search/list_engines.yml +0 -55
- data/spec/fixtures/vcr/app_search/list_synonym_sets.yml +0 -56
- data/spec/fixtures/vcr/app_search/multi_query_search.yml +0 -63
- data/spec/fixtures/vcr/app_search/put_curation.yml +0 -113
- data/spec/fixtures/vcr/app_search/put_synonym_set.yml +0 -56
- data/spec/fixtures/vcr/app_search/search.yml +0 -57
- data/spec/fixtures/vcr/app_search/single_query_search.yml +0 -60
- data/spec/fixtures/vcr/app_search/synonym_set.yml +0 -56
- data/spec/fixtures/vcr/workplace_search/add_user_permissions.yml +0 -53
- data/spec/fixtures/vcr/workplace_search/clear_user_permissions.yml +0 -53
- data/spec/fixtures/vcr/workplace_search/create_external_identity.yml +0 -53
- data/spec/fixtures/vcr/workplace_search/delete_documents.yml +0 -53
- data/spec/fixtures/vcr/workplace_search/delete_external_identity.yml +0 -53
- data/spec/fixtures/vcr/workplace_search/index_documents.yml +0 -55
- data/spec/fixtures/vcr/workplace_search/list_external_identities.yml +0 -53
- data/spec/fixtures/vcr/workplace_search/list_permissions.yml +0 -53
- data/spec/fixtures/vcr/workplace_search/put_external_identity.yml +0 -53
- data/spec/fixtures/vcr/workplace_search/put_user_permissions.yml +0 -103
- data/spec/fixtures/vcr/workplace_search/remove_user_permissions.yml +0 -53
- data/spec/fixtures/vcr/workplace_search/retrieve_external_identity.yml +0 -53
- data/spec/fixtures/vcr/workplace_search/user_permissions_empty.yml +0 -53
- data/spec/workplace-search/documents_spec.rb +0 -80
- data/spec/workplace-search/permissions_spec.rb +0 -136
@@ -0,0 +1,57 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Licensed to Elasticsearch B.V. under one or more contributor
|
4
|
+
# license agreements. See the NOTICE file distributed with
|
5
|
+
# this work for additional information regarding copyright
|
6
|
+
# ownership. Elasticsearch B.V. licenses this file to you under
|
7
|
+
# the Apache License, Version 2.0 (the "License"); you may
|
8
|
+
# not use this file except in compliance with the License.
|
9
|
+
# You may obtain a copy of the License at
|
10
|
+
#
|
11
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
12
|
+
#
|
13
|
+
# Unless required by applicable law or agreed to in writing,
|
14
|
+
# software distributed under the License is distributed on an
|
15
|
+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
16
|
+
# KIND, either express or implied. See the License for the
|
17
|
+
# specific language governing permissions and limitations
|
18
|
+
# under the License.
|
19
|
+
|
20
|
+
module Elastic
|
21
|
+
module EnterpriseSearch
|
22
|
+
module AppSearch
|
23
|
+
module Actions
|
24
|
+
# Crawler - Delete a sitemap
|
25
|
+
# Deletes a sitemap from a given domain
|
26
|
+
#
|
27
|
+
# @param engine_name [String] Name of the engine (*Required*)
|
28
|
+
# @param arguments [Hash] endpoint arguments
|
29
|
+
# @option arguments [String] :domain_id Crawler Domain ID (*Required*)
|
30
|
+
# @option arguments [String] :sitemap_id Sitemap ID (*Required*)
|
31
|
+
# @option arguments [Hash] :body The request body
|
32
|
+
# @option arguments [Hash] :headers optional HTTP headers to send with the request
|
33
|
+
#
|
34
|
+
# @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-delete-sitemap
|
35
|
+
#
|
36
|
+
def delete_crawler_sitemap(engine_name, arguments = {})
|
37
|
+
raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
|
38
|
+
raise ArgumentError, "Required parameter 'domain_id' missing" unless arguments[:domain_id]
|
39
|
+
raise ArgumentError, "Required parameter 'sitemap_id' missing" unless arguments[:sitemap_id]
|
40
|
+
|
41
|
+
domain_id = arguments[:domain_id]
|
42
|
+
sitemap_id = arguments[:sitemap_id]
|
43
|
+
body = arguments.delete(:body) || {}
|
44
|
+
headers = arguments.delete(:headers) || {}
|
45
|
+
|
46
|
+
request(
|
47
|
+
:delete,
|
48
|
+
"api/as/v0/engines/#{engine_name}/crawler/domains/#{domain_id}/sitemaps/#{sitemap_id}/",
|
49
|
+
arguments,
|
50
|
+
body,
|
51
|
+
headers
|
52
|
+
)
|
53
|
+
end
|
54
|
+
end
|
55
|
+
end
|
56
|
+
end
|
57
|
+
end
|
@@ -21,11 +21,12 @@ module Elastic
|
|
21
21
|
module EnterpriseSearch
|
22
22
|
module AppSearch
|
23
23
|
module Actions
|
24
|
-
# Curations - Delete a curation
|
24
|
+
# Curations - Delete a curation
|
25
|
+
# Deletes a curation set by ID
|
25
26
|
#
|
26
|
-
# @param engine_name [String]
|
27
|
+
# @param engine_name [String] Name of the engine (*Required*)
|
27
28
|
# @param arguments [Hash] endpoint arguments
|
28
|
-
# @option arguments [String] :curation_id
|
29
|
+
# @option arguments [String] :curation_id Curation ID (*Required*)
|
29
30
|
# @option arguments [Hash] :body The request body
|
30
31
|
# @option arguments [Hash] :headers optional HTTP headers to send with the request
|
31
32
|
#
|
@@ -22,8 +22,9 @@ module Elastic
|
|
22
22
|
module AppSearch
|
23
23
|
module Actions
|
24
24
|
# Documents - Delete documents by ID
|
25
|
+
# Deletes documents for given Document IDs
|
25
26
|
#
|
26
|
-
# @param engine_name [String]
|
27
|
+
# @param engine_name [String] Name of the engine (*Required*)
|
27
28
|
# @param arguments [Hash] endpoint arguments
|
28
29
|
# @option arguments [Array] :document_ids List of document IDs (*Required*)
|
29
30
|
# @option arguments [Hash] :headers optional HTTP headers to send with the request
|
@@ -21,9 +21,10 @@ module Elastic
|
|
21
21
|
module EnterpriseSearch
|
22
22
|
module AppSearch
|
23
23
|
module Actions
|
24
|
-
#
|
24
|
+
# Engines - Delete an Engine
|
25
|
+
# Delete an engine by name
|
25
26
|
#
|
26
|
-
# @param engine_name [String]
|
27
|
+
# @param engine_name [String] Name of the engine (*Required*)
|
27
28
|
# @param arguments [Hash] endpoint arguments
|
28
29
|
# @option arguments [Hash] :body The request body
|
29
30
|
# @option arguments [Hash] :headers optional HTTP headers to send with the request
|
@@ -21,9 +21,10 @@ module Elastic
|
|
21
21
|
module EnterpriseSearch
|
22
22
|
module AppSearch
|
23
23
|
module Actions
|
24
|
-
#
|
24
|
+
# Engines - Delete a source engine
|
25
|
+
# Deletes a source engine from a given meta engine
|
25
26
|
#
|
26
|
-
# @param engine_name [String]
|
27
|
+
# @param engine_name [String] Name of the engine (*Required*)
|
27
28
|
# @param arguments [Hash] endpoint arguments
|
28
29
|
# @option arguments [Array] :source_engines List of engine names (*Required*)
|
29
30
|
# @option arguments [Hash] :headers optional HTTP headers to send with the request
|
@@ -32,7 +33,6 @@ module Elastic
|
|
32
33
|
#
|
33
34
|
def delete_meta_engine_source(engine_name, arguments = {})
|
34
35
|
raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
|
35
|
-
raise ArgumentError, "Required parameter 'source_engines' missing" unless arguments[:source_engines]
|
36
36
|
|
37
37
|
source_engines = arguments.delete(:source_engines) || {}
|
38
38
|
headers = arguments.delete(:headers) || {}
|
@@ -21,11 +21,12 @@ module Elastic
|
|
21
21
|
module EnterpriseSearch
|
22
22
|
module AppSearch
|
23
23
|
module Actions
|
24
|
-
# Synonyms - Delete a synonym set
|
24
|
+
# Synonyms - Delete a synonym set
|
25
|
+
# Deletes a synonym set by ID
|
25
26
|
#
|
26
|
-
# @param engine_name [String]
|
27
|
+
# @param engine_name [String] Name of the engine (*Required*)
|
27
28
|
# @param arguments [Hash] endpoint arguments
|
28
|
-
# @option arguments [String] :synonym_set_id
|
29
|
+
# @option arguments [String] :synonym_set_id Synonym Set ID (*Required*)
|
29
30
|
# @option arguments [Hash] :body The request body
|
30
31
|
# @option arguments [Hash] :headers optional HTTP headers to send with the request
|
31
32
|
#
|
@@ -0,0 +1,54 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Licensed to Elasticsearch B.V. under one or more contributor
|
4
|
+
# license agreements. See the NOTICE file distributed with
|
5
|
+
# this work for additional information regarding copyright
|
6
|
+
# ownership. Elasticsearch B.V. licenses this file to you under
|
7
|
+
# the Apache License, Version 2.0 (the "License"); you may
|
8
|
+
# not use this file except in compliance with the License.
|
9
|
+
# You may obtain a copy of the License at
|
10
|
+
#
|
11
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
12
|
+
#
|
13
|
+
# Unless required by applicable law or agreed to in writing,
|
14
|
+
# software distributed under the License is distributed on an
|
15
|
+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
16
|
+
# KIND, either express or implied. See the License for the
|
17
|
+
# specific language governing permissions and limitations
|
18
|
+
# under the License.
|
19
|
+
|
20
|
+
module Elastic
|
21
|
+
module EnterpriseSearch
|
22
|
+
module AppSearch
|
23
|
+
module Actions
|
24
|
+
# Crawler - View denied urls for Process Crawl
|
25
|
+
# Provides a sample list of urls identified for deletion by the given process crawl id.
|
26
|
+
#
|
27
|
+
# @param engine_name [String] Name of the engine (*Required*)
|
28
|
+
# @param arguments [Hash] endpoint arguments
|
29
|
+
# @option arguments [String] :process_crawl_id Process Crawl identifier (*Required*)
|
30
|
+
# @option arguments [Hash] :body The request body
|
31
|
+
# @option arguments [Hash] :headers optional HTTP headers to send with the request
|
32
|
+
#
|
33
|
+
# @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html
|
34
|
+
#
|
35
|
+
def denied_urls(engine_name, arguments = {})
|
36
|
+
raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
|
37
|
+
raise ArgumentError, "Required parameter 'process_crawl_id' missing" unless arguments[:process_crawl_id]
|
38
|
+
|
39
|
+
process_crawl_id = arguments[:process_crawl_id]
|
40
|
+
body = arguments.delete(:body) || {}
|
41
|
+
headers = arguments.delete(:headers) || {}
|
42
|
+
|
43
|
+
request(
|
44
|
+
:get,
|
45
|
+
"api/as/v0/engines/#{engine_name}/crawler/process_crawls/#{process_crawl_id}/denied_urls/",
|
46
|
+
arguments,
|
47
|
+
body,
|
48
|
+
headers
|
49
|
+
)
|
50
|
+
end
|
51
|
+
end
|
52
|
+
end
|
53
|
+
end
|
54
|
+
end
|
@@ -21,9 +21,10 @@ module Elastic
|
|
21
21
|
module EnterpriseSearch
|
22
22
|
module AppSearch
|
23
23
|
module Actions
|
24
|
-
# Documents -
|
24
|
+
# Documents - Retrieve one or more documents
|
25
|
+
# Retrieves one or more documents by id
|
25
26
|
#
|
26
|
-
# @param engine_name [String]
|
27
|
+
# @param engine_name [String] Name of the engine (*Required*)
|
27
28
|
# @param arguments [Hash] endpoint arguments
|
28
29
|
# @option arguments [Array] :document_ids List of document IDs (*Required*)
|
29
30
|
# @option arguments [Hash] :headers optional HTTP headers to send with the request
|
@@ -21,9 +21,10 @@ module Elastic
|
|
21
21
|
module EnterpriseSearch
|
22
22
|
module AppSearch
|
23
23
|
module Actions
|
24
|
-
#
|
24
|
+
# Engines - Retrieve an engine
|
25
|
+
# Retrieves details of a given engine by its name
|
25
26
|
#
|
26
|
-
# @param engine_name [String]
|
27
|
+
# @param engine_name [String] Name of the engine (*Required*)
|
27
28
|
# @param arguments [Hash] endpoint arguments
|
28
29
|
# @option arguments [Hash] :body The request body
|
29
30
|
# @option arguments [Hash] :headers optional HTTP headers to send with the request
|
@@ -21,9 +21,10 @@ module Elastic
|
|
21
21
|
module EnterpriseSearch
|
22
22
|
module AppSearch
|
23
23
|
module Actions
|
24
|
-
# Documents - Create
|
24
|
+
# Documents - Create a new document
|
25
|
+
# Create or update documents
|
25
26
|
#
|
26
|
-
# @param engine_name [String]
|
27
|
+
# @param engine_name [String] Name of the engine (*Required*)
|
27
28
|
# @param arguments [Hash] endpoint arguments
|
28
29
|
# @option arguments [Array] :documents List of document to index (*Required*)
|
29
30
|
# @option arguments [Hash] :headers optional HTTP headers to send with the request
|
@@ -0,0 +1,50 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Licensed to Elasticsearch B.V. under one or more contributor
|
4
|
+
# license agreements. See the NOTICE file distributed with
|
5
|
+
# this work for additional information regarding copyright
|
6
|
+
# ownership. Elasticsearch B.V. licenses this file to you under
|
7
|
+
# the Apache License, Version 2.0 (the "License"); you may
|
8
|
+
# not use this file except in compliance with the License.
|
9
|
+
# You may obtain a copy of the License at
|
10
|
+
#
|
11
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
12
|
+
#
|
13
|
+
# Unless required by applicable law or agreed to in writing,
|
14
|
+
# software distributed under the License is distributed on an
|
15
|
+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
16
|
+
# KIND, either express or implied. See the License for the
|
17
|
+
# specific language governing permissions and limitations
|
18
|
+
# under the License.
|
19
|
+
|
20
|
+
module Elastic
|
21
|
+
module EnterpriseSearch
|
22
|
+
module AppSearch
|
23
|
+
module Actions
|
24
|
+
# Credentials - Retrieve all API keys
|
25
|
+
# List the details of all API keys
|
26
|
+
#
|
27
|
+
# @param arguments [Hash] endpoint arguments
|
28
|
+
# @option arguments [Integer] :current_page The page to fetch. Defaults to 1
|
29
|
+
# @option arguments [Integer] :page_size The number of results per page
|
30
|
+
# @option arguments [Hash] :body The request body
|
31
|
+
# @option arguments [Hash] :headers optional HTTP headers to send with the request
|
32
|
+
#
|
33
|
+
# @see https://www.elastic.co/guide/en/app-search/current/credentials.html#credentials-all
|
34
|
+
#
|
35
|
+
def list_api_keys(arguments = {})
|
36
|
+
body = arguments.delete(:body) || {}
|
37
|
+
headers = arguments.delete(:headers) || {}
|
38
|
+
|
39
|
+
request(
|
40
|
+
:get,
|
41
|
+
'api/as/v1/credentials/',
|
42
|
+
arguments,
|
43
|
+
body,
|
44
|
+
headers
|
45
|
+
)
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
50
|
+
end
|
@@ -0,0 +1,52 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Licensed to Elasticsearch B.V. under one or more contributor
|
4
|
+
# license agreements. See the NOTICE file distributed with
|
5
|
+
# this work for additional information regarding copyright
|
6
|
+
# ownership. Elasticsearch B.V. licenses this file to you under
|
7
|
+
# the Apache License, Version 2.0 (the "License"); you may
|
8
|
+
# not use this file except in compliance with the License.
|
9
|
+
# You may obtain a copy of the License at
|
10
|
+
#
|
11
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
12
|
+
#
|
13
|
+
# Unless required by applicable law or agreed to in writing,
|
14
|
+
# software distributed under the License is distributed on an
|
15
|
+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
16
|
+
# KIND, either express or implied. See the License for the
|
17
|
+
# specific language governing permissions and limitations
|
18
|
+
# under the License.
|
19
|
+
|
20
|
+
module Elastic
|
21
|
+
module EnterpriseSearch
|
22
|
+
module AppSearch
|
23
|
+
module Actions
|
24
|
+
# Crawler - List crawl requests
|
25
|
+
# Returns a list of latest crawl requests for a given engine.
|
26
|
+
#
|
27
|
+
# @param engine_name [String] Name of the engine (*Required*)
|
28
|
+
# @param arguments [Hash] endpoint arguments
|
29
|
+
# @option arguments [Integer] :limit The number of results
|
30
|
+
# @option arguments [Hash] :body The request body
|
31
|
+
# @option arguments [Hash] :headers optional HTTP headers to send with the request
|
32
|
+
#
|
33
|
+
# @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-get-crawler-crawl-requests
|
34
|
+
#
|
35
|
+
def list_crawler_crawl_requests(engine_name, arguments = {})
|
36
|
+
raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
|
37
|
+
|
38
|
+
body = arguments.delete(:body) || {}
|
39
|
+
headers = arguments.delete(:headers) || {}
|
40
|
+
|
41
|
+
request(
|
42
|
+
:get,
|
43
|
+
"api/as/v0/engines/#{engine_name}/crawler/crawl_requests/",
|
44
|
+
arguments,
|
45
|
+
body,
|
46
|
+
headers
|
47
|
+
)
|
48
|
+
end
|
49
|
+
end
|
50
|
+
end
|
51
|
+
end
|
52
|
+
end
|
@@ -0,0 +1,51 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Licensed to Elasticsearch B.V. under one or more contributor
|
4
|
+
# license agreements. See the NOTICE file distributed with
|
5
|
+
# this work for additional information regarding copyright
|
6
|
+
# ownership. Elasticsearch B.V. licenses this file to you under
|
7
|
+
# the Apache License, Version 2.0 (the "License"); you may
|
8
|
+
# not use this file except in compliance with the License.
|
9
|
+
# You may obtain a copy of the License at
|
10
|
+
#
|
11
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
12
|
+
#
|
13
|
+
# Unless required by applicable law or agreed to in writing,
|
14
|
+
# software distributed under the License is distributed on an
|
15
|
+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
16
|
+
# KIND, either express or implied. See the License for the
|
17
|
+
# specific language governing permissions and limitations
|
18
|
+
# under the License.
|
19
|
+
|
20
|
+
module Elastic
|
21
|
+
module EnterpriseSearch
|
22
|
+
module AppSearch
|
23
|
+
module Actions
|
24
|
+
# Crawler - List process crawls
|
25
|
+
# Returns a list of latest process crawls for a given engine
|
26
|
+
#
|
27
|
+
# @param engine_name [String] Name of the engine (*Required*)
|
28
|
+
# @param arguments [Hash] endpoint arguments
|
29
|
+
# @option arguments [Hash] :body The request body
|
30
|
+
# @option arguments [Hash] :headers optional HTTP headers to send with the request
|
31
|
+
#
|
32
|
+
# @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-get-crawler-process-crawls
|
33
|
+
#
|
34
|
+
def list_crawler_process_crawls(engine_name, arguments = {})
|
35
|
+
raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
|
36
|
+
|
37
|
+
body = arguments.delete(:body) || {}
|
38
|
+
headers = arguments.delete(:headers) || {}
|
39
|
+
|
40
|
+
request(
|
41
|
+
:get,
|
42
|
+
"api/as/v0/engines/#{engine_name}/crawler/process_crawls/",
|
43
|
+
arguments,
|
44
|
+
body,
|
45
|
+
headers
|
46
|
+
)
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
50
|
+
end
|
51
|
+
end
|
@@ -21,9 +21,10 @@ module Elastic
|
|
21
21
|
module EnterpriseSearch
|
22
22
|
module AppSearch
|
23
23
|
module Actions
|
24
|
-
# Curations - Retrieve
|
24
|
+
# Curations - Retrieve all curations
|
25
|
+
# Retrieve available curations for the given engine
|
25
26
|
#
|
26
|
-
# @param engine_name [String]
|
27
|
+
# @param engine_name [String] Name of the engine (*Required*)
|
27
28
|
# @param arguments [Hash] endpoint arguments
|
28
29
|
# @option arguments [Integer] :current_page The page to fetch. Defaults to 1
|
29
30
|
# @option arguments [Integer] :page_size The number of results per page
|
@@ -21,9 +21,10 @@ module Elastic
|
|
21
21
|
module EnterpriseSearch
|
22
22
|
module AppSearch
|
23
23
|
module Actions
|
24
|
-
# Documents -
|
24
|
+
# Documents - Retrieve all documents
|
25
|
+
# Lists up to 10,000 documents
|
25
26
|
#
|
26
|
-
# @param engine_name [String]
|
27
|
+
# @param engine_name [String] Name of the engine (*Required*)
|
27
28
|
# @param arguments [Hash] endpoint arguments
|
28
29
|
# @option arguments [Integer] :current_page The page to fetch. Defaults to 1
|
29
30
|
# @option arguments [Integer] :page_size The number of results per page
|
@@ -21,7 +21,8 @@ module Elastic
|
|
21
21
|
module EnterpriseSearch
|
22
22
|
module AppSearch
|
23
23
|
module Actions
|
24
|
-
#
|
24
|
+
# Engines - Retrieve all engines
|
25
|
+
# Retrieves all engines with optional pagination support
|
25
26
|
#
|
26
27
|
# @param arguments [Hash] endpoint arguments
|
27
28
|
# @option arguments [Integer] :current_page The page to fetch. Defaults to 1
|
@@ -21,9 +21,10 @@ module Elastic
|
|
21
21
|
module EnterpriseSearch
|
22
22
|
module AppSearch
|
23
23
|
module Actions
|
24
|
-
# Synonyms - Retrieve
|
24
|
+
# Synonyms - Retrieve all synonym sets
|
25
|
+
# Retrieves all available synonym sets for the engine
|
25
26
|
#
|
26
|
-
# @param engine_name [String]
|
27
|
+
# @param engine_name [String] Name of the engine (*Required*)
|
27
28
|
# @param arguments [Hash] endpoint arguments
|
28
29
|
# @option arguments [Integer] :current_page The page to fetch. Defaults to 1
|
29
30
|
# @option arguments [Integer] :page_size The number of results per page
|
@@ -21,27 +21,25 @@ module Elastic
|
|
21
21
|
module EnterpriseSearch
|
22
22
|
module AppSearch
|
23
23
|
module Actions
|
24
|
-
# Click -
|
24
|
+
# Click - Tracks results that were clicked after a query
|
25
|
+
# Tracks results that were clicked after a query
|
25
26
|
#
|
26
|
-
# @param engine_name [String]
|
27
|
+
# @param engine_name [String] Name of the engine (*Required*)
|
27
28
|
# @param arguments [Hash] endpoint arguments
|
28
|
-
# @option arguments
|
29
|
-
# @option
|
30
|
-
# @option
|
31
|
-
# @option
|
32
|
-
# @option
|
29
|
+
# @option arguments :body Search request parameters
|
30
|
+
# @option body [String] :query Search query text (*Required*)
|
31
|
+
# @option body [String] :document_id The id of the document that was clicked on (*Required*)
|
32
|
+
# @option body [String] :request_id The request id returned in the meta tag of a search API response
|
33
|
+
# @option body [Array] :tags Array of strings representing additional information you wish to track with the clickthrough. You may submit up to 16 tags, and each may be up to 64 characters in length.
|
33
34
|
# @option arguments [Hash] :headers optional HTTP headers to send with the request
|
34
35
|
#
|
35
36
|
# @see https://www.elastic.co/guide/en/app-search/current/clickthrough.html
|
36
37
|
#
|
37
38
|
def log_clickthrough(engine_name, arguments = {})
|
38
|
-
raise ArgumentError, "Required parameter 'query_text' missing" unless arguments[:query_text]
|
39
|
-
raise ArgumentError, "Required parameter 'document_id' missing" unless arguments[:document_id]
|
40
39
|
raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
|
41
40
|
|
42
41
|
body = arguments.delete(:body) || {}
|
43
42
|
headers = arguments.delete(:headers) || {}
|
44
|
-
arguments['query'] = arguments.delete(:query_text)
|
45
43
|
|
46
44
|
request(
|
47
45
|
:post,
|
@@ -0,0 +1,59 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Licensed to Elasticsearch B.V. under one or more contributor
|
4
|
+
# license agreements. See the NOTICE file distributed with
|
5
|
+
# this work for additional information regarding copyright
|
6
|
+
# ownership. Elasticsearch B.V. licenses this file to you under
|
7
|
+
# the Apache License, Version 2.0 (the "License"); you may
|
8
|
+
# not use this file except in compliance with the License.
|
9
|
+
# You may obtain a copy of the License at
|
10
|
+
#
|
11
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
12
|
+
#
|
13
|
+
# Unless required by applicable law or agreed to in writing,
|
14
|
+
# software distributed under the License is distributed on an
|
15
|
+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
16
|
+
# KIND, either express or implied. See the License for the
|
17
|
+
# specific language governing permissions and limitations
|
18
|
+
# under the License.
|
19
|
+
|
20
|
+
module Elastic
|
21
|
+
module EnterpriseSearch
|
22
|
+
module AppSearch
|
23
|
+
module Actions
|
24
|
+
# Credentials - Update an API key
|
25
|
+
# Updates an API key
|
26
|
+
#
|
27
|
+
# @param arguments [Hash] endpoint arguments
|
28
|
+
# @option arguments [String] :api_key_name Name of an API key (*Required*)
|
29
|
+
# @option arguments [Hash] :body Details of an API key (Required: name, type)
|
30
|
+
# @option body [String] :id
|
31
|
+
# @option body [String] :name (*Required)
|
32
|
+
# @option body [String] :type (*Required)
|
33
|
+
# @option body [Boolean] :access_all_engines
|
34
|
+
# @option body :engines
|
35
|
+
# @option body [Boolean] :write
|
36
|
+
# @option body [Boolean] :read
|
37
|
+
# @option arguments [Hash] :headers optional HTTP headers to send with the request
|
38
|
+
#
|
39
|
+
# @see https://www.elastic.co/guide/en/app-search/current/credentials.html#credentials-update
|
40
|
+
#
|
41
|
+
def put_api_key(arguments = {})
|
42
|
+
raise ArgumentError, "Required parameter 'api_key_name' missing" unless arguments[:api_key_name]
|
43
|
+
|
44
|
+
api_key_name = arguments[:api_key_name]
|
45
|
+
body = arguments.delete(:body) || {}
|
46
|
+
headers = arguments.delete(:headers) || {}
|
47
|
+
|
48
|
+
request(
|
49
|
+
:put,
|
50
|
+
"api/as/v1/credentials/#{api_key_name}/",
|
51
|
+
arguments,
|
52
|
+
body,
|
53
|
+
headers
|
54
|
+
)
|
55
|
+
end
|
56
|
+
end
|
57
|
+
end
|
58
|
+
end
|
59
|
+
end
|
@@ -0,0 +1,62 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Licensed to Elasticsearch B.V. under one or more contributor
|
4
|
+
# license agreements. See the NOTICE file distributed with
|
5
|
+
# this work for additional information regarding copyright
|
6
|
+
# ownership. Elasticsearch B.V. licenses this file to you under
|
7
|
+
# the Apache License, Version 2.0 (the "License"); you may
|
8
|
+
# not use this file except in compliance with the License.
|
9
|
+
# You may obtain a copy of the License at
|
10
|
+
#
|
11
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
12
|
+
#
|
13
|
+
# Unless required by applicable law or agreed to in writing,
|
14
|
+
# software distributed under the License is distributed on an
|
15
|
+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
16
|
+
# KIND, either express or implied. See the License for the
|
17
|
+
# specific language governing permissions and limitations
|
18
|
+
# under the License.
|
19
|
+
|
20
|
+
module Elastic
|
21
|
+
module EnterpriseSearch
|
22
|
+
module AppSearch
|
23
|
+
module Actions
|
24
|
+
# Crawler - Update a crawl rule
|
25
|
+
# Updates crawl rule configuration
|
26
|
+
#
|
27
|
+
# @param engine_name [String] Name of the engine (*Required*)
|
28
|
+
# @param arguments [Hash] endpoint arguments
|
29
|
+
# @option arguments [String] :domain_id Crawler Domain ID (*Required*)
|
30
|
+
# @option arguments [String] :crawl_rule_id Crawl Rule ID (*Required*)
|
31
|
+
# @option arguments [Hash] :body (Required: order, policy, rule, pattern)
|
32
|
+
# @option body [String] :id
|
33
|
+
# @option body [Integer] :order (*Required)
|
34
|
+
# @option body [String] :policy (*Required)
|
35
|
+
# @option body [String] :rule (*Required)
|
36
|
+
# @option body [String] :pattern (*Required)
|
37
|
+
# @option arguments [Hash] :headers optional HTTP headers to send with the request
|
38
|
+
#
|
39
|
+
# @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-put-crawl-rule
|
40
|
+
#
|
41
|
+
def put_crawler_crawl_rule(engine_name, arguments = {})
|
42
|
+
raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
|
43
|
+
raise ArgumentError, "Required parameter 'domain_id' missing" unless arguments[:domain_id]
|
44
|
+
raise ArgumentError, "Required parameter 'crawl_rule_id' missing" unless arguments[:crawl_rule_id]
|
45
|
+
|
46
|
+
domain_id = arguments[:domain_id]
|
47
|
+
crawl_rule_id = arguments[:crawl_rule_id]
|
48
|
+
body = arguments.delete(:body) || {}
|
49
|
+
headers = arguments.delete(:headers) || {}
|
50
|
+
|
51
|
+
request(
|
52
|
+
:put,
|
53
|
+
"api/as/v0/engines/#{engine_name}/crawler/domains/#{domain_id}/crawl_rules/#{crawl_rule_id}/",
|
54
|
+
arguments,
|
55
|
+
body,
|
56
|
+
headers
|
57
|
+
)
|
58
|
+
end
|
59
|
+
end
|
60
|
+
end
|
61
|
+
end
|
62
|
+
end
|
@@ -0,0 +1,53 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Licensed to Elasticsearch B.V. under one or more contributor
|
4
|
+
# license agreements. See the NOTICE file distributed with
|
5
|
+
# this work for additional information regarding copyright
|
6
|
+
# ownership. Elasticsearch B.V. licenses this file to you under
|
7
|
+
# the Apache License, Version 2.0 (the "License"); you may
|
8
|
+
# not use this file except in compliance with the License.
|
9
|
+
# You may obtain a copy of the License at
|
10
|
+
#
|
11
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
12
|
+
#
|
13
|
+
# Unless required by applicable law or agreed to in writing,
|
14
|
+
# software distributed under the License is distributed on an
|
15
|
+
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
16
|
+
# KIND, either express or implied. See the License for the
|
17
|
+
# specific language governing permissions and limitations
|
18
|
+
# under the License.
|
19
|
+
|
20
|
+
module Elastic
|
21
|
+
module EnterpriseSearch
|
22
|
+
module AppSearch
|
23
|
+
module Actions
|
24
|
+
# Crawler - Set crawl schedule
|
25
|
+
# Sets up a crawl schedule for a given engine
|
26
|
+
#
|
27
|
+
# @param engine_name [String] Name of the engine (*Required*)
|
28
|
+
# @param arguments [Hash] endpoint arguments
|
29
|
+
# @option arguments [Hash] :body (Required: frequency, unit)
|
30
|
+
# @option body [Integer] :frequency (*Required)
|
31
|
+
# @option body [String] :unit (*Required)
|
32
|
+
# @option arguments [Hash] :headers optional HTTP headers to send with the request
|
33
|
+
#
|
34
|
+
# @see https://www.elastic.co/guide/en/app-search/current/web-crawler-api-reference.html#web-crawler-apis-put-crawler-crawl-schedule
|
35
|
+
#
|
36
|
+
def put_crawler_crawl_schedule(engine_name, arguments = {})
|
37
|
+
raise ArgumentError, "Required parameter 'engine_name' missing" unless engine_name
|
38
|
+
|
39
|
+
body = arguments.delete(:body) || {}
|
40
|
+
headers = arguments.delete(:headers) || {}
|
41
|
+
|
42
|
+
request(
|
43
|
+
:put,
|
44
|
+
"api/as/v0/engines/#{engine_name}/crawler/crawl_schedule/",
|
45
|
+
arguments,
|
46
|
+
body,
|
47
|
+
headers
|
48
|
+
)
|
49
|
+
end
|
50
|
+
end
|
51
|
+
end
|
52
|
+
end
|
53
|
+
end
|