elasticsearch-xpack 7.5.0 → 7.8.0.pre

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

@@ -1,24 +1,38 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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
-          # TODO: Description
-
+          # Evicts users from the user cache. Can completely clear the cache or evict specific users.
           #
           # @option arguments [List] :realms Comma-separated list of realms to clear
           # @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/current/security-api-clear-cache.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/security-api-clear-cache.html
           #
           def clear_cached_realms(arguments = {})
             raise ArgumentError, "Required argument 'realms' missing" unless arguments[:realms]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _realms = arguments.delete(:realms)
@@ -28,7 +42,7 @@ module Elasticsearch
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = nil
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
 
           # Register this action with its valid params when the module is loaded.

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

@@ -1,23 +1,37 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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
-          # TODO: Description
-
+          # Evicts roles from the native role cache.
           #
           # @option arguments [List] :name Role name
-
+          # @option arguments [Hash] :headers Custom HTTP headers
           #
-          # @see https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-clear-role-cache.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/security-api-clear-role-cache.html
           #
           def clear_cached_roles(arguments = {})
             raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _name = arguments.delete(:name)
@@ -27,7 +41,7 @@ module Elasticsearch
             params = {}
 
             body = nil
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
       end
     end

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

@@ -1,25 +1,40 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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
-          # TODO: Description
-
+          # Creates an API key for access without requiring basic authentication.
           #
           # @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/current/security-api-create-api-key.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/security-api-create-api-key.html
           #
           def create_api_key(arguments = {})
             raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             method = Elasticsearch::API::HTTP_PUT
@@ -27,7 +42,7 @@ module Elasticsearch
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = arguments[:body]
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
 
           # Register this action with its valid params when the module is loaded.

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

@@ -1,27 +1,42 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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
-          # TODO: Description
-
+          # Removes application privileges.
           #
           # @option arguments [String] :application Application name
           # @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 TODO
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/security-api-delete-privilege.html
           #
           def delete_privileges(arguments = {})
             raise ArgumentError, "Required argument 'application' missing" unless arguments[:application]
             raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _application = arguments.delete(:application)
@@ -33,7 +48,7 @@ module Elasticsearch
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = nil
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
 
           # Register this action with its valid params when the module is loaded.

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

@@ -1,25 +1,40 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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
-          # TODO: Description
-
+          # Removes roles in the native realm.
           #
           # @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/current/security-api-delete-role.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/security-api-delete-role.html
           #
           def delete_role(arguments = {})
             raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _name = arguments.delete(:name)
@@ -29,7 +44,7 @@ module Elasticsearch
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = nil
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
 
           # Register this action with its valid params when the module is loaded.

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

@@ -1,25 +1,40 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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
-          # TODO: Description
-
+          # Removes role mappings.
           #
           # @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/current/security-api-delete-role-mapping.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/security-api-delete-role-mapping.html
           #
           def delete_role_mapping(arguments = {})
             raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _name = arguments.delete(:name)
@@ -29,7 +44,7 @@ module Elasticsearch
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = nil
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
 
           # Register this action with its valid params when the module is loaded.

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

@@ -1,25 +1,40 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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
-          # TODO: Description
-
+          # Deletes users from the native realm.
           #
           # @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/current/security-api-delete-user.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/security-api-delete-user.html
           #
           def delete_user(arguments = {})
             raise ArgumentError, "Required argument 'username' missing" unless arguments[:username]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _username = arguments.delete(:username)
@@ -29,7 +44,7 @@ module Elasticsearch
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = nil
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
 
           # Register this action with its valid params when the module is loaded.

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

@@ -1,25 +1,40 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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
-          # TODO: Description
-
+          # Disables users in the native realm.
           #
           # @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/current/security-api-disable-user.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/security-api-disable-user.html
           #
           def disable_user(arguments = {})
             raise ArgumentError, "Required argument 'username' missing" unless arguments[:username]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _username = arguments.delete(:username)
@@ -29,7 +44,7 @@ module Elasticsearch
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = nil
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
 
           # Register this action with its valid params when the module is loaded.

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

@@ -1,25 +1,40 @@
-# Licensed to Elasticsearch B.V under one or more agreements.
-# Elasticsearch B.V licenses this file to you under the Apache 2.0 License.
-# See the LICENSE file in the project root for more information
+# 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
-          # TODO: Description
-
+          # Enables users in the native realm.
           #
           # @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/current/security-api-enable-user.html
+          # @see https://www.elastic.co/guide/en/elasticsearch/reference/7.8/security-api-enable-user.html
           #
           def enable_user(arguments = {})
             raise ArgumentError, "Required argument 'username' missing" unless arguments[:username]
 
+            headers = arguments.delete(:headers) || {}
+
             arguments = arguments.clone
 
             _username = arguments.delete(:username)
@@ -29,7 +44,7 @@ module Elasticsearch
             params = Elasticsearch::API::Utils.__validate_and_extract_params arguments, ParamsRegistry.get(__method__)
 
             body = nil
-            perform_request(method, path, params, body).body
+            perform_request(method, path, params, body, headers).body
           end
 
           # Register this action with its valid params when the module is loaded.