Skip to content

Commit

Permalink
[API] Auto-generated code, updates source code documentation url
Browse files Browse the repository at this point in the history
Co-authored-by: Fernando Briano <fernando.briano@elastic.co>
  • Loading branch information
elasticmachine and picandocodigo committed Mar 13, 2023
1 parent ff0a6b9 commit 8dd560b
Showing 410 changed files with 410 additions and 410 deletions.
Original file line number Diff line number Diff line change
@@ -27,7 +27,7 @@ module Actions
# @option arguments [String] :id The async search ID
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.7/async-search.html
#
def delete(arguments = {})
raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
Original file line number Diff line number Diff line change
@@ -30,7 +30,7 @@ module Actions
# @option arguments [Boolean] :typed_keys Specify whether aggregation and suggester names should be prefixed by their respective types in the response
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.7/async-search.html
#
def get(arguments = {})
raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
Original file line number Diff line number Diff line change
@@ -27,7 +27,7 @@ module Actions
# @option arguments [String] :id The async search ID
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.7/async-search.html
#
def status(arguments = {})
raise ArgumentError, "Required argument 'id' missing" unless arguments[:id]
Original file line number Diff line number Diff line change
@@ -69,7 +69,7 @@ module Actions
# @option arguments [Hash] :headers Custom HTTP headers
# @option arguments [Hash] :body The search definition using the Query DSL
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/async-search.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.7/async-search.html
#
def submit(arguments = {})
arguments = arguments.clone
Original file line number Diff line number Diff line change
@@ -27,7 +27,7 @@ module Actions
# @option arguments [String] :name the name of the autoscaling policy
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-delete-autoscaling-policy.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.7/autoscaling-delete-autoscaling-policy.html
#
def delete_autoscaling_policy(arguments = {})
raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
Original file line number Diff line number Diff line change
@@ -26,7 +26,7 @@ module Actions
#
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-capacity.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.7/autoscaling-get-autoscaling-capacity.html
#
def get_autoscaling_capacity(arguments = {})
arguments = arguments.clone
Original file line number Diff line number Diff line change
@@ -27,7 +27,7 @@ module Actions
# @option arguments [String] :name the name of the autoscaling policy
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-get-autoscaling-policy.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.7/autoscaling-get-autoscaling-policy.html
#
def get_autoscaling_policy(arguments = {})
raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
Original file line number Diff line number Diff line change
@@ -28,7 +28,7 @@ module Actions
# @option arguments [Hash] :headers Custom HTTP headers
# @option arguments [Hash] :body the specification of the autoscaling policy (*Required*)
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/autoscaling-put-autoscaling-policy.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.7/autoscaling-put-autoscaling-policy.html
#
def put_autoscaling_policy(arguments = {})
raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
2 changes: 1 addition & 1 deletion elasticsearch-api/lib/elasticsearch/api/actions/bulk.rb
Original file line number Diff line number Diff line change
@@ -38,7 +38,7 @@ module Actions
# @option arguments [String|Array] :body The operation definition and data (action-data pairs), separated by newlines. Array of Strings, Header/Data pairs,
# or the conveniency "combined" format can be passed, refer to Elasticsearch::API::Utils.__bulkify documentation.
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.7/docs-bulk.html
#
def bulk(arguments = {})
raise ArgumentError, "Required argument 'body' missing" unless arguments[:body]
Original file line number Diff line number Diff line change
@@ -34,7 +34,7 @@ module Actions
# @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)
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-alias.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-alias.html
#
def aliases(arguments = {})
arguments = arguments.clone
Original file line number Diff line number Diff line change
@@ -35,7 +35,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-allocation.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-allocation.html
#
def allocation(arguments = {})
arguments = arguments.clone
Original file line number Diff line number Diff line change
@@ -34,7 +34,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-compoentn-templates.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-compoentn-templates.html
#
def component_templates(arguments = {})
arguments = arguments.clone
Original file line number Diff line number Diff line change
@@ -32,7 +32,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-count.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-count.html
#
def count(arguments = {})
arguments = arguments.clone
Original file line number Diff line number Diff line change
@@ -33,7 +33,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-fielddata.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-fielddata.html
#
def fielddata(arguments = {})
arguments = arguments.clone
Original file line number Diff line number Diff line change
@@ -33,7 +33,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-health.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-health.html
#
def health(arguments = {})
arguments = arguments.clone
Original file line number Diff line number Diff line change
@@ -28,7 +28,7 @@ module Actions
# @option arguments [List] :s Comma-separated list of column names or column aliases to sort by
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat.html
#
def help(arguments = {})
arguments = arguments.clone
Original file line number Diff line number Diff line change
@@ -39,7 +39,7 @@ module Actions
# @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)
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-indices.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-indices.html
#
def indices(arguments = {})
arguments = arguments.clone
Original file line number Diff line number Diff line change
@@ -33,7 +33,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-master.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-master.html
#
def master(arguments = {})
arguments = arguments.clone
Original file line number Diff line number Diff line change
@@ -35,7 +35,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-dfanalytics.html
# @see http://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-dfanalytics.html
#
def ml_data_frame_analytics(arguments = {})
arguments = arguments.clone
Original file line number Diff line number Diff line change
@@ -34,7 +34,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-datafeeds.html
# @see http://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-datafeeds.html
#
def ml_datafeeds(arguments = {})
arguments = arguments.clone
Original file line number Diff line number Diff line change
@@ -35,7 +35,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see http://www.elastic.co/guide/en/elasticsearch/reference/current/cat-anomaly-detectors.html
# @see http://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-anomaly-detectors.html
#
def ml_jobs(arguments = {})
arguments = arguments.clone
Original file line number Diff line number Diff line change
@@ -37,7 +37,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-trained-model.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-trained-model.html
#
def ml_trained_models(arguments = {})
arguments = arguments.clone
Original file line number Diff line number Diff line change
@@ -33,7 +33,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-nodeattrs.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-nodeattrs.html
#
def nodeattrs(arguments = {})
arguments = arguments.clone
Original file line number Diff line number Diff line change
@@ -36,7 +36,7 @@ module Actions
# @option arguments [Boolean] :include_unloaded_segments If set to true segment stats will include stats for segments that are not currently loaded into memory
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-nodes.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-nodes.html
#
def nodes(arguments = {})
arguments = arguments.clone
Original file line number Diff line number Diff line change
@@ -34,7 +34,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-pending-tasks.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-pending-tasks.html
#
def pending_tasks(arguments = {})
arguments = arguments.clone
Original file line number Diff line number Diff line change
@@ -34,7 +34,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-plugins.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-plugins.html
#
def plugins(arguments = {})
arguments = arguments.clone
Original file line number Diff line number Diff line change
@@ -36,7 +36,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-recovery.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-recovery.html
#
def recovery(arguments = {})
arguments = arguments.clone
Original file line number Diff line number Diff line change
@@ -33,7 +33,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-repositories.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-repositories.html
#
def repositories(arguments = {})
arguments = arguments.clone
Original file line number Diff line number Diff line change
@@ -33,7 +33,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-segments.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-segments.html
#
def segments(arguments = {})
arguments = arguments.clone
Original file line number Diff line number Diff line change
@@ -35,7 +35,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-shards.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-shards.html
#
def shards(arguments = {})
arguments = arguments.clone
Original file line number Diff line number Diff line change
@@ -35,7 +35,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-snapshots.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-snapshots.html
#
def snapshots(arguments = {})
arguments = arguments.clone
Original file line number Diff line number Diff line change
@@ -40,7 +40,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.7/tasks.html
#
def tasks(arguments = {})
arguments = arguments.clone
Original file line number Diff line number Diff line change
@@ -34,7 +34,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-templates.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-templates.html
#
def templates(arguments = {})
arguments = arguments.clone
Original file line number Diff line number Diff line change
@@ -36,7 +36,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-thread-pool.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-thread-pool.html
#
def thread_pool(arguments = {})
arguments = arguments.clone
Original file line number Diff line number Diff line change
@@ -36,7 +36,7 @@ module Actions
# @option arguments [Boolean] :v Verbose mode. Display column headers
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cat-transforms.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cat-transforms.html
#
def transforms(arguments = {})
arguments = arguments.clone
Original file line number Diff line number Diff line change
@@ -32,7 +32,7 @@ module Actions
# Deprecated since version 7.0.0
#
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-scroll-api.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.7/clear-scroll-api.html
#
def clear_scroll(arguments = {})
arguments = arguments.clone
Original file line number Diff line number Diff line change
@@ -26,7 +26,7 @@ module Actions
# @option arguments [Hash] :headers Custom HTTP headers
# @option arguments [Hash] :body a point-in-time id to close
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/point-in-time-api.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.7/point-in-time-api.html
#
def close_point_in_time(arguments = {})
arguments = arguments.clone
Original file line number Diff line number Diff line change
@@ -29,7 +29,7 @@ module Actions
# @option arguments [Hash] :headers Custom HTTP headers
# @option arguments [Hash] :body The index, shard, and primary flag to explain. Empty means 'explain a randomly-chosen unassigned shard'
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-allocation-explain.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.7/cluster-allocation-explain.html
#
def allocation_explain(arguments = {})
arguments = arguments.clone
Original file line number Diff line number Diff line change
@@ -29,7 +29,7 @@ module Actions
# @option arguments [Time] :master_timeout Specify timeout for connection to master
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-component-template.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.7/indices-component-template.html
#
def delete_component_template(arguments = {})
raise ArgumentError, "Required argument 'name' missing" unless arguments[:name]
Original file line number Diff line number Diff line change
@@ -28,7 +28,7 @@ module Actions
# @option arguments [Time] :master_timeout Timeout for submitting request to master
# @option arguments [Hash] :headers Custom HTTP headers
#
# @see https://www.elastic.co/guide/en/elasticsearch/reference/current/voting-config-exclusions.html
# @see https://www.elastic.co/guide/en/elasticsearch/reference/8.7/voting-config-exclusions.html
#
def delete_voting_config_exclusions(arguments = {})
arguments = arguments.clone
Loading

0 comments on commit 8dd560b

Please sign in to comment.