Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,10 @@ module Actions
#
# @option arguments [String] :job_id The name of the job to flush
# @option arguments [Boolean] :calc_interim Calculates interim results for the most recent bucket or all buckets within the latency period
# @option arguments [String] :start When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results
# @option arguments [String] :end When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results
# @option arguments [String] :advance_time Advances time to the given value generating results and updating the model for the advanced interval
# @option arguments [String] :skip_time Skips time to the given value without generating results or updating the model for the skipped interval
# @option arguments [Date] :start When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results
# @option arguments [Date] :end When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results
# @option arguments [Date] :advance_time Advances time to the given value generating results and updating the model for the advanced interval
# @option arguments [Date] :skip_time Skips time to the given value without generating results or updating the model for the skipped interval
# @option arguments [Hash] :headers Custom HTTP headers
# @option arguments [Hash] :body Flush parameters
#
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ module Actions
# @option arguments [Boolean] :exclude_interim Exclude interim results
# @option arguments [Integer] :from skips a number of buckets
# @option arguments [Integer] :size specifies a max number of buckets to get
# @option arguments [String] :start Start time filter for buckets
# @option arguments [String] :end End time filter for buckets
# @option arguments [Date] :start Start time filter for buckets
# @option arguments [Date] :end End time filter for buckets
# @option arguments [Double] :anomaly_score Filter for the most anomalous buckets
# @option arguments [String] :sort Sort buckets by a particular field
# @option arguments [Boolean] :desc Set the sort direction
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ module Actions
#
# @option arguments [String] :calendar_id The ID of the calendar containing the events
# @option arguments [String] :job_id Get events for the job. When this option is used calendar_id must be '_all'
# @option arguments [String] :start Get events after this time
# @option arguments [Date] :start Get events after this time
# @option arguments [Date] :end Get events before this time
# @option arguments [Integer] :from Skips a number of events
# @option arguments [Integer] :size Specifies a max number of events to get
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ module Actions
# @option arguments [Boolean] :exclude_interim Exclude interim results
# @option arguments [Integer] :from skips a number of influencers
# @option arguments [Integer] :size specifies a max number of influencers to get
# @option arguments [String] :start start timestamp for the requested influencers
# @option arguments [String] :end end timestamp for the requested influencers
# @option arguments [Date] :start start timestamp for the requested influencers
# @option arguments [Date] :end end timestamp for the requested influencers
# @option arguments [Double] :influencer_score influencer score threshold for the requested influencers
# @option arguments [String] :sort sort field for the requested influencers
# @option arguments [Boolean] :desc whether the results should be sorted in decending order
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ module Actions
# @option arguments [String] :bucket_span The span of the overall buckets. Defaults to the longest job bucket_span
# @option arguments [Double] :overall_score Returns overall buckets with overall scores higher than this value
# @option arguments [Boolean] :exclude_interim If true overall buckets that include interim buckets will be excluded
# @option arguments [String] :start Returns overall buckets with timestamps after this time
# @option arguments [String] :end Returns overall buckets with timestamps earlier than this time
# @option arguments [Date] :start Returns overall buckets with timestamps after this time
# @option arguments [Date] :end Returns overall buckets with timestamps earlier than this time
# @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)
# @option arguments [Hash] :headers Custom HTTP headers
# @option arguments [Hash] :body Overall bucket selection details if not provided in URI
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ module Actions
# @option arguments [Boolean] :exclude_interim Exclude interim results
# @option arguments [Integer] :from skips a number of records
# @option arguments [Integer] :size specifies a max number of records to get
# @option arguments [String] :start Start time filter for records
# @option arguments [String] :end End time filter for records
# @option arguments [Date] :start Start time filter for records
# @option arguments [Date] :end End time filter for records
# @option arguments [Double] :record_score Returns records with anomaly scores greater or equal than this value
# @option arguments [String] :sort Sort records by a particular field
# @option arguments [Boolean] :desc Set the sort direction
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ module Actions
# Send data to an anomaly detection job for analysis
#
# @option arguments [String] :job_id The name of the job receiving the data
# @option arguments [String] :reset_start Optional parameter to specify the start of the bucket resetting range
# @option arguments [String] :reset_end Optional parameter to specify the end of the bucket resetting range
# @option arguments [Date] :reset_start Optional parameter to specify the start of the bucket resetting range
# @option arguments [Date] :reset_end Optional parameter to specify the end of the bucket resetting range
# @option arguments [Hash] :headers Custom HTTP headers
# @option arguments [Hash] :body The data to process (*Required*)
#
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ module Actions
# Preview a datafeed
#
# @option arguments [String] :datafeed_id The ID of the datafeed to preview
# @option arguments [String] :start The start time from where the datafeed preview should begin
# @option arguments [String] :end The end time when the datafeed preview should stop
# @option arguments [Date] :start The start time from where the datafeed preview should begin
# @option arguments [Date] :end The end time when the datafeed preview should stop
# @option arguments [Hash] :headers Custom HTTP headers
# @option arguments [Hash] :body The datafeed config and job config with which to execute the preview
#
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ module Actions
# Start datafeeds
#
# @option arguments [String] :datafeed_id The ID of the datafeed to start
# @option arguments [String] :start The start time from where the datafeed should begin
# @option arguments [String] :end The end time when the datafeed should stop. When not set, the datafeed continues in real time
# @option arguments [Date] :start The start time from where the datafeed should begin
# @option arguments [Date] :end The end time when the datafeed should stop. When not set, the datafeed continues in real time
# @option arguments [Time] :timeout Controls the time to wait until a datafeed has started. Default to 20 seconds
# @option arguments [Hash] :headers Custom HTTP headers
# @option arguments [Hash] :body The start datafeed parameters
Expand Down