Skip to content

Commit 6ed4224

Browse files
committed
[API] Auto-generated code - updates source code docs for ml apis
1 parent db1a329 commit 6ed4224

File tree

9 files changed

+19
-19
lines changed

9 files changed

+19
-19
lines changed

elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/flush_job.rb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,10 @@ module Actions
2626
#
2727
# @option arguments [String] :job_id The name of the job to flush
2828
# @option arguments [Boolean] :calc_interim Calculates interim results for the most recent bucket or all buckets within the latency period
29-
# @option arguments [String] :start When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results
30-
# @option arguments [String] :end When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results
31-
# @option arguments [String] :advance_time Advances time to the given value generating results and updating the model for the advanced interval
32-
# @option arguments [String] :skip_time Skips time to the given value without generating results or updating the model for the skipped interval
29+
# @option arguments [Date] :start When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results
30+
# @option arguments [Date] :end When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results
31+
# @option arguments [Date] :advance_time Advances time to the given value generating results and updating the model for the advanced interval
32+
# @option arguments [Date] :skip_time Skips time to the given value without generating results or updating the model for the skipped interval
3333
# @option arguments [Hash] :headers Custom HTTP headers
3434
# @option arguments [Hash] :body Flush parameters
3535
#

elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_buckets.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ module Actions
3030
# @option arguments [Boolean] :exclude_interim Exclude interim results
3131
# @option arguments [Integer] :from skips a number of buckets
3232
# @option arguments [Integer] :size specifies a max number of buckets to get
33-
# @option arguments [String] :start Start time filter for buckets
34-
# @option arguments [String] :end End time filter for buckets
33+
# @option arguments [Date] :start Start time filter for buckets
34+
# @option arguments [Date] :end End time filter for buckets
3535
# @option arguments [Double] :anomaly_score Filter for the most anomalous buckets
3636
# @option arguments [String] :sort Sort buckets by a particular field
3737
# @option arguments [Boolean] :desc Set the sort direction

elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_calendar_events.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ module Actions
2626
#
2727
# @option arguments [String] :calendar_id The ID of the calendar containing the events
2828
# @option arguments [String] :job_id Get events for the job. When this option is used calendar_id must be '_all'
29-
# @option arguments [String] :start Get events after this time
29+
# @option arguments [Date] :start Get events after this time
3030
# @option arguments [Date] :end Get events before this time
3131
# @option arguments [Integer] :from Skips a number of events
3232
# @option arguments [Integer] :size Specifies a max number of events to get

elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_influencers.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ module Actions
2828
# @option arguments [Boolean] :exclude_interim Exclude interim results
2929
# @option arguments [Integer] :from skips a number of influencers
3030
# @option arguments [Integer] :size specifies a max number of influencers to get
31-
# @option arguments [String] :start start timestamp for the requested influencers
32-
# @option arguments [String] :end end timestamp for the requested influencers
31+
# @option arguments [Date] :start start timestamp for the requested influencers
32+
# @option arguments [Date] :end end timestamp for the requested influencers
3333
# @option arguments [Double] :influencer_score influencer score threshold for the requested influencers
3434
# @option arguments [String] :sort sort field for the requested influencers
3535
# @option arguments [Boolean] :desc whether the results should be sorted in decending order

elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_overall_buckets.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ module Actions
2929
# @option arguments [String] :bucket_span The span of the overall buckets. Defaults to the longest job bucket_span
3030
# @option arguments [Double] :overall_score Returns overall buckets with overall scores higher than this value
3131
# @option arguments [Boolean] :exclude_interim If true overall buckets that include interim buckets will be excluded
32-
# @option arguments [String] :start Returns overall buckets with timestamps after this time
33-
# @option arguments [String] :end Returns overall buckets with timestamps earlier than this time
32+
# @option arguments [Date] :start Returns overall buckets with timestamps after this time
33+
# @option arguments [Date] :end Returns overall buckets with timestamps earlier than this time
3434
# @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)
3535
# @option arguments [Hash] :headers Custom HTTP headers
3636
# @option arguments [Hash] :body Overall bucket selection details if not provided in URI

elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/get_records.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ module Actions
2828
# @option arguments [Boolean] :exclude_interim Exclude interim results
2929
# @option arguments [Integer] :from skips a number of records
3030
# @option arguments [Integer] :size specifies a max number of records to get
31-
# @option arguments [String] :start Start time filter for records
32-
# @option arguments [String] :end End time filter for records
31+
# @option arguments [Date] :start Start time filter for records
32+
# @option arguments [Date] :end End time filter for records
3333
# @option arguments [Double] :record_score Returns records with anomaly scores greater or equal than this value
3434
# @option arguments [String] :sort Sort records by a particular field
3535
# @option arguments [Boolean] :desc Set the sort direction

elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/post_data.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ module Actions
2525
# Send data to an anomaly detection job for analysis
2626
#
2727
# @option arguments [String] :job_id The name of the job receiving the data
28-
# @option arguments [String] :reset_start Optional parameter to specify the start of the bucket resetting range
29-
# @option arguments [String] :reset_end Optional parameter to specify the end of the bucket resetting range
28+
# @option arguments [Date] :reset_start Optional parameter to specify the start of the bucket resetting range
29+
# @option arguments [Date] :reset_end Optional parameter to specify the end of the bucket resetting range
3030
# @option arguments [Hash] :headers Custom HTTP headers
3131
# @option arguments [Hash] :body The data to process (*Required*)
3232
#

elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/preview_datafeed.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ module Actions
2525
# Preview a datafeed
2626
#
2727
# @option arguments [String] :datafeed_id The ID of the datafeed to preview
28-
# @option arguments [String] :start The start time from where the datafeed preview should begin
29-
# @option arguments [String] :end The end time when the datafeed preview should stop
28+
# @option arguments [Date] :start The start time from where the datafeed preview should begin
29+
# @option arguments [Date] :end The end time when the datafeed preview should stop
3030
# @option arguments [Hash] :headers Custom HTTP headers
3131
# @option arguments [Hash] :body The datafeed config and job config with which to execute the preview
3232
#

elasticsearch-api/lib/elasticsearch/api/actions/machine_learning/start_datafeed.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ module Actions
2525
# Start datafeeds
2626
#
2727
# @option arguments [String] :datafeed_id The ID of the datafeed to start
28-
# @option arguments [String] :start The start time from where the datafeed should begin
29-
# @option arguments [String] :end The end time when the datafeed should stop. When not set, the datafeed continues in real time
28+
# @option arguments [Date] :start The start time from where the datafeed should begin
29+
# @option arguments [Date] :end The end time when the datafeed should stop. When not set, the datafeed continues in real time
3030
# @option arguments [Time] :timeout Controls the time to wait until a datafeed has started. Default to 20 seconds
3131
# @option arguments [Hash] :headers Custom HTTP headers
3232
# @option arguments [Hash] :body The start datafeed parameters

0 commit comments

Comments
 (0)