elasticsearch-xpack 7.8.1 → 7.9.0.pre

data/lib/elasticsearch/xpack/api/actions/searchable_snapshots/mount.rb

@@ -21,10 +21,6 @@ module Elasticsearch
       module SearchableSnapshots
         module Actions
           # Mount a snapshot as a searchable index.
-          # This functionality is Experimental and may be changed or removed
-          # completely in a future release. Elastic will take a best effort approach
-          # to fix any issues, but experimental features are not subject to the
-          # support SLA of official GA features.
           #
           # @option arguments [String] :repository The name of the repository containing the snapshot of the index to mount
           # @option arguments [String] :snapshot The name of the snapshot of the index to mount
@@ -33,7 +29,7 @@ module Elasticsearch
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The restore configuration for mounting the snapshot as searchable (*Required*)
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/searchable-snapshots-api-mount-snapshot.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/searchable-snapshots-api-mount-snapshot.html
           #
           def mount(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -63,8 +59,8 @@ module Elasticsearch
             :master_timeout,
             :wait_for_completion
           ].freeze)
+        end
       end
     end
-    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/searchable_snapshots/repository_stats.rb

@@ -21,15 +21,11 @@ module Elasticsearch
       module SearchableSnapshots
         module Actions
           # Retrieve usage statistics about a snapshot repository.
-          # This functionality is Experimental and may be changed or removed
-          # completely in a future release. Elastic will take a best effort approach
-          # to fix any issues, but experimental features are not subject to the
-          # support SLA of official GA features.
           #
           # @option arguments [String] :repository The repository for which to get the stats for
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/searchable-snapshots-repository-stats.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/searchable-snapshots-repository-stats.html
           #
           def repository_stats(arguments = {})
             raise ArgumentError, "Required argument 'repository' missing" unless arguments[:repository]
@@ -47,8 +43,8 @@ module Elasticsearch
             body = nil
             perform_request(method, path, params, body, headers).body
           end
+        end
       end
     end
-    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/searchable_snapshots/stats.rb

@@ -21,15 +21,11 @@ module Elasticsearch
       module SearchableSnapshots
         module Actions
           # Retrieve various statistics about searchable snapshots.
-          # This functionality is Experimental and may be changed or removed
-          # completely in a future release. Elastic will take a best effort approach
-          # to fix any issues, but experimental features are not subject to the
-          # support SLA of official GA features.
           #
           # @option arguments [List] :index A comma-separated list of index names
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/searchable-snapshots-api-stats.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/searchable-snapshots-api-stats.html
           #
           def stats(arguments = {})
             headers = arguments.delete(:headers) || {}
@@ -43,14 +39,14 @@ module Elasticsearch
                        "#{Elasticsearch::API::Utils.__listify(_index)}/_searchable_snapshots/stats"
                      else
                        "_searchable_snapshots/stats"
-            end
+                     end
             params = {}
 
             body = nil
             perform_request(method, path, params, body, headers).body
           end
+        end
       end
     end
-    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/security/authenticate.rb

@@ -24,7 +24,7 @@ module Elasticsearch
           #
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/security-api-authenticate.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-authenticate.html
           #
           def authenticate(arguments = {})
             headers = arguments.delete(:headers) || {}
@@ -38,8 +38,8 @@ module Elasticsearch
             body = nil
             perform_request(method, path, params, body, headers).body
           end
+        end
       end
     end
-    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/security/change_password.rb

@@ -25,10 +25,11 @@ module Elasticsearch
           # @option arguments [String] :username The username of the user to change the password for
           # @option arguments [String] :refresh If `true` (the default) 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` then do nothing with refreshes.
           #   (options: true,false,wait_for)
+
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body the new password for the user (*Required*)
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/security-api-change-password.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-change-password.html
           #
           def change_password(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -44,7 +45,7 @@ module Elasticsearch
                        "_security/user/#{Elasticsearch::API::Utils.__listify(_username)}/_password"
                      else
                        "_security/user/_password"
-  end
+                     end
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = arguments[:body]
@@ -57,8 +58,8 @@ module Elasticsearch
           ParamsRegistry.register(:change_password, [
             :refresh
           ].freeze)
+        end
       end
     end
-    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/security/clear_cached_privileges.rb

@@ -0,0 +1,50 @@
+# Licensed to Elasticsearch B.V. under one or more contributor
+# license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright
+# ownership. Elasticsearch B.V. licenses this file to you under
+# the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+module Elasticsearch
+  module XPack
+    module API
+      module Security
+        module Actions
+          # Evicts application privileges from the native application privileges cache.
+          #
+          # @option arguments [List] :application A comma-separated list of application names
+          # @option arguments [Hash] :headers Custom HTTP headers
+          #
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-clear-privilege-cache.html
+          #
+          def clear_cached_privileges(arguments = {})
+            raise ArgumentError, "Required argument 'application' missing" unless arguments[:application]
+
+            headers = arguments.delete(:headers) || {}
+
+            arguments = arguments.clone
+
+            _application = arguments.delete(:application)
+
+            method = Elasticsearch::API::HTTP_POST
+            path   = "_security/privilege/#{Elasticsearch::API::Utils.__listify(_application)}/_clear_cache"
+            params = {}
+
+            body = nil
+            perform_request(method, path, params, body, headers).body
+          end
+        end
+      end
+    end
+  end
+end

data/lib/elasticsearch/xpack/api/actions/security/clear_cached_realms.rb

@@ -26,7 +26,7 @@ module Elasticsearch
           # @option arguments [List] :usernames Comma-separated list of usernames to clear from the cache
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/security-api-clear-cache.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-clear-cache.html
           #
           def clear_cached_realms(arguments = {})
             raise ArgumentError, "Required argument 'realms' missing" unless arguments[:realms]
@@ -51,8 +51,8 @@ module Elasticsearch
           ParamsRegistry.register(:clear_cached_realms, [
             :usernames
           ].freeze)
+        end
       end
     end
-    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/security/clear_cached_roles.rb

@@ -25,7 +25,7 @@ module Elasticsearch
           # @option arguments [List] :name Role name
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/security-api-clear-role-cache.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-clear-role-cache.html
           #
           def clear_cached_roles(arguments = {})
             raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
@@ -43,8 +43,8 @@ module Elasticsearch
             body = nil
             perform_request(method, path, params, body, headers).body
           end
+        end
       end
     end
-    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/security/create_api_key.rb

@@ -24,10 +24,11 @@ module Elasticsearch
           #
           # @option arguments [String] :refresh If `true` (the default) 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` then do nothing with refreshes.
           #   (options: true,false,wait_for)
+
           # @option arguments [Hash] :headers Custom HTTP headers
           # @option arguments [Hash] :body The api key request to create an API key (*Required*)
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/security-api-create-api-key.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-create-api-key.html
           #
           def create_api_key(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
@@ -50,8 +51,8 @@ module Elasticsearch
           ParamsRegistry.register(:create_api_key, [
             :refresh
           ].freeze)
+        end
       end
     end
-    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/security/delete_privileges.rb

@@ -26,9 +26,10 @@ module Elasticsearch
           # @option arguments [String] :name Privilege name
           # @option arguments [String] :refresh If `true` (the default) 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` then do nothing with refreshes.
           #   (options: true,false,wait_for)
+
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/security-api-delete-privilege.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-delete-privilege.html
           #
           def delete_privileges(arguments = {})
             raise ArgumentError, "Required argument 'application' missing" unless arguments[:application]
@@ -56,8 +57,8 @@ module Elasticsearch
           ParamsRegistry.register(:delete_privileges, [
             :refresh
           ].freeze)
+        end
       end
     end
-    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/security/delete_role.rb

@@ -25,9 +25,10 @@ module Elasticsearch
           # @option arguments [String] :name Role name
           # @option arguments [String] :refresh If `true` (the default) 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` then do nothing with refreshes.
           #   (options: true,false,wait_for)
+
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/security-api-delete-role.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-delete-role.html
           #
           def delete_role(arguments = {})
             raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
@@ -52,8 +53,8 @@ module Elasticsearch
           ParamsRegistry.register(:delete_role, [
             :refresh
           ].freeze)
+        end
       end
     end
-    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/security/delete_role_mapping.rb

@@ -25,9 +25,10 @@ module Elasticsearch
           # @option arguments [String] :name Role-mapping name
           # @option arguments [String] :refresh If `true` (the default) 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` then do nothing with refreshes.
           #   (options: true,false,wait_for)
+
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/security-api-delete-role-mapping.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-delete-role-mapping.html
           #
           def delete_role_mapping(arguments = {})
             raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
@@ -52,8 +53,8 @@ module Elasticsearch
           ParamsRegistry.register(:delete_role_mapping, [
             :refresh
           ].freeze)
+        end
       end
     end
-    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/security/delete_user.rb

@@ -25,9 +25,10 @@ module Elasticsearch
           # @option arguments [String] :username username
           # @option arguments [String] :refresh If `true` (the default) 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` then do nothing with refreshes.
           #   (options: true,false,wait_for)
+
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/security-api-delete-user.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-delete-user.html
           #
           def delete_user(arguments = {})
             raise ArgumentError, "Required argument 'username' missing" unless arguments[:username]
@@ -52,8 +53,8 @@ module Elasticsearch
           ParamsRegistry.register(:delete_user, [
             :refresh
           ].freeze)
+        end
       end
     end
-    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/security/disable_user.rb

@@ -25,9 +25,10 @@ module Elasticsearch
           # @option arguments [String] :username The username of the user to disable
           # @option arguments [String] :refresh If `true` (the default) 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` then do nothing with refreshes.
           #   (options: true,false,wait_for)
+
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/security-api-disable-user.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-disable-user.html
           #
           def disable_user(arguments = {})
             raise ArgumentError, "Required argument 'username' missing" unless arguments[:username]
@@ -52,8 +53,8 @@ module Elasticsearch
           ParamsRegistry.register(:disable_user, [
             :refresh
           ].freeze)
+        end
       end
     end
-    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/security/enable_user.rb

@@ -25,9 +25,10 @@ module Elasticsearch
           # @option arguments [String] :username The username of the user to enable
           # @option arguments [String] :refresh If `true` (the default) 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` then do nothing with refreshes.
           #   (options: true,false,wait_for)
+
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/security-api-enable-user.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-enable-user.html
           #
           def enable_user(arguments = {})
             raise ArgumentError, "Required argument 'username' missing" unless arguments[:username]
@@ -52,8 +53,8 @@ module Elasticsearch
           ParamsRegistry.register(:enable_user, [
             :refresh
           ].freeze)
+        end
       end
     end
-    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/security/get_api_key.rb

@@ -29,7 +29,7 @@ module Elasticsearch
           # @option arguments [Boolean] :owner flag to query API keys owned by the currently authenticated user
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/security-api-get-api-key.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-get-api-key.html
           #
           def get_api_key(arguments = {})
             headers = arguments.delete(:headers) || {}
@@ -54,8 +54,8 @@ module Elasticsearch
             :realm_name,
             :owner
           ].freeze)
+        end
       end
     end
-    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/security/get_builtin_privileges.rb

@@ -24,7 +24,7 @@ module Elasticsearch
           #
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/security-api-get-builtin-privileges.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-get-builtin-privileges.html
           #
           def get_builtin_privileges(arguments = {})
             headers = arguments.delete(:headers) || {}
@@ -38,8 +38,8 @@ module Elasticsearch
             body = nil
             perform_request(method, path, params, body, headers).body
           end
+        end
       end
     end
-    end
   end
 end

data/lib/elasticsearch/xpack/api/actions/security/get_privileges.rb

@@ -26,7 +26,7 @@ module Elasticsearch
           # @option arguments [String] :name Privilege name
           # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/security-api-get-privileges.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/security-api-get-privileges.html
           #
           def get_privileges(arguments = {})
             headers = arguments.delete(:headers) || {}
@@ -44,14 +44,14 @@ module Elasticsearch
                        "_security/privilege/#{Elasticsearch::API::Utils.__listify(_application)}"
                      else
                        "_security/privilege"
-            end
+                     end
             params = {}
 
             body = nil
             perform_request(method, path, params, body, headers).body
           end
+        end
       end
     end
-    end
   end
 end