Skip to content

Commit fdd13bb

Browse files
committed
[XPACK] Updates API: Adds exclude_generated parameter
1 parent 5a97d83 commit fdd13bb

17 files changed

+69
-59
lines changed

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/data_frame_transform_deprecated/get_transform.rb

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ module Actions
3030
# @option arguments [Int] :from skips a number of transform configs, defaults to 0
3131
# @option arguments [Int] :size specifies a max number of transforms to get, defaults to 100
3232
# @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no transforms. (This includes `_all` string or when no transforms have been specified)
33+
# @option arguments [Boolean] :exclude_generated Omits generated fields. Allows transform configurations to be easily copied between clusters and within the same cluster
3334
# @option arguments [Hash] :headers Custom HTTP headers
3435
#
3536
# *Deprecation notice*:
@@ -64,7 +65,8 @@ def get_transform(arguments = {})
6465
ParamsRegistry.register(:get_transform, [
6566
:from,
6667
:size,
67-
:allow_no_match
68+
:allow_no_match,
69+
:exclude_generated
6870
].freeze)
6971
end
7072
end

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/delete_data_frame_analytics.rb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ module API
2121
module MachineLearning
2222
module Actions
2323
# Deletes an existing data frame analytics job.
24-
# This functionality is Experimental and may be changed or removed
25-
# completely in a future release. Elastic will take a best effort approach
26-
# to fix any issues, but experimental features are not subject to the
27-
# support SLA of official GA features.
24+
# This functionality is in Beta and is subject to change. The design and
25+
# code is less mature than official GA features and is being provided
26+
# as-is with no warranties. Beta features are not subject to the support
27+
# SLA of official GA features.
2828
#
2929
# @option arguments [String] :id The ID of the data frame analytics to delete
3030
# @option arguments [Boolean] :force True if the job should be forcefully deleted

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/delete_trained_model.rb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ module API
2121
module MachineLearning
2222
module Actions
2323
# Deletes an existing trained inference model that is currently not referenced by an ingest pipeline.
24-
# This functionality is Experimental and may be changed or removed
25-
# completely in a future release. Elastic will take a best effort approach
26-
# to fix any issues, but experimental features are not subject to the
27-
# support SLA of official GA features.
24+
# This functionality is in Beta and is subject to change. The design and
25+
# code is less mature than official GA features and is being provided
26+
# as-is with no warranties. Beta features are not subject to the support
27+
# SLA of official GA features.
2828
#
2929
# @option arguments [String] :model_id The ID of the trained model to delete
3030
# @option arguments [Hash] :headers Custom HTTP headers

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/evaluate_data_frame.rb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ module API
2121
module MachineLearning
2222
module Actions
2323
# Evaluates the data frame analytics for an annotated index.
24-
# This functionality is Experimental and may be changed or removed
25-
# completely in a future release. Elastic will take a best effort approach
26-
# to fix any issues, but experimental features are not subject to the
27-
# support SLA of official GA features.
24+
# This functionality is in Beta and is subject to change. The design and
25+
# code is less mature than official GA features and is being provided
26+
# as-is with no warranties. Beta features are not subject to the support
27+
# SLA of official GA features.
2828
#
2929
# @option arguments [Hash] :headers Custom HTTP headers
3030
# @option arguments [Hash] :body The evaluation definition (*Required*)

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/explain_data_frame_analytics.rb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ module API
2121
module MachineLearning
2222
module Actions
2323
# Explains a data frame analytics config.
24-
# This functionality is Experimental and may be changed or removed
25-
# completely in a future release. Elastic will take a best effort approach
26-
# to fix any issues, but experimental features are not subject to the
27-
# support SLA of official GA features.
24+
# This functionality is in Beta and is subject to change. The design and
25+
# code is less mature than official GA features and is being provided
26+
# as-is with no warranties. Beta features are not subject to the support
27+
# SLA of official GA features.
2828
#
2929
# @option arguments [String] :id The ID of the data frame analytics to explain
3030
# @option arguments [Hash] :headers Custom HTTP headers

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/get_data_frame_analytics.rb

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,16 @@ module API
2121
module MachineLearning
2222
module Actions
2323
# Retrieves configuration information for data frame analytics jobs.
24-
# This functionality is Experimental and may be changed or removed
25-
# completely in a future release. Elastic will take a best effort approach
26-
# to fix any issues, but experimental features are not subject to the
27-
# support SLA of official GA features.
24+
# This functionality is in Beta and is subject to change. The design and
25+
# code is less mature than official GA features and is being provided
26+
# as-is with no warranties. Beta features are not subject to the support
27+
# SLA of official GA features.
2828
#
2929
# @option arguments [String] :id The ID of the data frame analytics to fetch
3030
# @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified)
3131
# @option arguments [Int] :from skips a number of analytics
3232
# @option arguments [Int] :size specifies a max number of analytics to get
33+
# @option arguments [Boolean] :exclude_generated Omits fields that are illegal to set on data frame analytics PUT
3334
# @option arguments [Hash] :headers Custom HTTP headers
3435
#
3536
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/get-dfanalytics.html
@@ -59,7 +60,8 @@ def get_data_frame_analytics(arguments = {})
5960
ParamsRegistry.register(:get_data_frame_analytics, [
6061
:allow_no_match,
6162
:from,
62-
:size
63+
:size,
64+
:exclude_generated
6365
].freeze)
6466
end
6567
end

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/get_data_frame_analytics_stats.rb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ module API
2121
module MachineLearning
2222
module Actions
2323
# Retrieves usage information for data frame analytics jobs.
24-
# This functionality is Experimental and may be changed or removed
25-
# completely in a future release. Elastic will take a best effort approach
26-
# to fix any issues, but experimental features are not subject to the
27-
# support SLA of official GA features.
24+
# This functionality is in Beta and is subject to change. The design and
25+
# code is less mature than official GA features and is being provided
26+
# as-is with no warranties. Beta features are not subject to the support
27+
# SLA of official GA features.
2828
#
2929
# @option arguments [String] :id The ID of the data frame analytics stats to fetch
3030
# @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no data frame analytics. (This includes `_all` string or when no data frame analytics have been specified)

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/get_datafeeds.rb

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ module Actions
2525
# @option arguments [String] :datafeed_id The ID of the datafeeds to fetch
2626
# @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)
2727
# @option arguments [Boolean] :allow_no_datafeeds Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified) *Deprecated*
28+
# @option arguments [Boolean] :exclude_generated Omits fields that are illegal to set on datafeed PUT
2829
# @option arguments [Hash] :headers Custom HTTP headers
2930
#
3031
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-get-datafeed.html
@@ -53,7 +54,8 @@ def get_datafeeds(arguments = {})
5354
# @since 6.2.0
5455
ParamsRegistry.register(:get_datafeeds, [
5556
:allow_no_match,
56-
:allow_no_datafeeds
57+
:allow_no_datafeeds,
58+
:exclude_generated
5759
].freeze)
5860
end
5961
end

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/get_jobs.rb

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ module Actions
2525
# @option arguments [String] :job_id The ID of the jobs to fetch
2626
# @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)
2727
# @option arguments [Boolean] :allow_no_jobs Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified) *Deprecated*
28+
# @option arguments [Boolean] :exclude_generated Omits fields that are illegal to set on job PUT
2829
# @option arguments [Hash] :headers Custom HTTP headers
2930
#
3031
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/ml-get-job.html
@@ -53,7 +54,8 @@ def get_jobs(arguments = {})
5354
# @since 6.2.0
5455
ParamsRegistry.register(:get_jobs, [
5556
:allow_no_match,
56-
:allow_no_jobs
57+
:allow_no_jobs,
58+
:exclude_generated
5759
].freeze)
5860
end
5961
end

elasticsearch-xpack/lib/elasticsearch/xpack/api/actions/machine_learning/get_trained_models.rb

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@ module API
2121
module MachineLearning
2222
module Actions
2323
# Retrieves configuration information for a trained inference model.
24-
# This functionality is Experimental and may be changed or removed
25-
# completely in a future release. Elastic will take a best effort approach
26-
# to fix any issues, but experimental features are not subject to the
27-
# support SLA of official GA features.
24+
# This functionality is in Beta and is subject to change. The design and
25+
# code is less mature than official GA features and is being provided
26+
# as-is with no warranties. Beta features are not subject to the support
27+
# SLA of official GA features.
2828
#
2929
# @option arguments [String] :model_id The ID of the trained models to fetch
3030
# @option arguments [Boolean] :allow_no_match Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified)
@@ -34,7 +34,7 @@ module Actions
3434
# @option arguments [Int] :from skips a number of trained models
3535
# @option arguments [Int] :size specifies a max number of trained models to get
3636
# @option arguments [List] :tags A comma-separated list of tags that the model must have.
37-
# @option arguments [Boolean] :for_export Omits fields that are illegal to set on model PUT
37+
# @option arguments [Boolean] :exclude_generated Omits fields that are illegal to set on model PUT
3838
# @option arguments [Hash] :headers Custom HTTP headers
3939
#
4040
# @see https://www.elastic.co/guide/en/elasticsearch/reference/7.x/get-trained-models.html
@@ -69,7 +69,7 @@ def get_trained_models(arguments = {})
6969
:from,
7070
:size,
7171
:tags,
72-
:for_export
72+
:exclude_generated
7373
].freeze)
7474
end
7575
end

0 commit comments

Comments
 (0)