Lines Matching refs:params
86 .`closeJob(array $params = [])`
91 $params['job_id'] = (string) The name of the job to close
92 $params['allow_no_match'] = (boolean) Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)
93 $params['allow_no_jobs'] = (boolean) Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)
94 $params['force'] = (boolean) True if the job should be forcefully closed
95 $params['timeout'] = (time) Controls the time to wait until a job has closed. Default to 30 minutes
96 $params['body'] = (array) The URL params optionally sent in the body
104 .`deleteCalendar(array $params = [])`
109 $params['calendar_id'] = (string) The ID of the calendar to delete
117 .`deleteCalendarEvent(array $params = [])`
122 $params['calendar_id'] = (string) The ID of the calendar to modify
123 $params['event_id'] = (string) The ID of the event to remove from the calendar
131 .`deleteCalendarJob(array $params = [])`
136 $params['calendar_id'] = (string) The ID of the calendar to modify
137 $params['job_id'] = (string) The ID of the job to remove from the calendar
145 .`deleteDataFrameAnalytics(array $params = [])`
151 $params['id'] = (string) The ID of the data frame analytics to delete
152 $params['force'] = (boolean) True if the job should be forcefully deleted (Default = false)
153 $params['timeout'] = (time) Controls the time to wait until a job is deleted. Defaults to 1 minute
161 .`deleteDatafeed(array $params = [])`
166 $params['datafeed_id'] = (string) The ID of the datafeed to delete
167 $params['force'] = (boolean) True if the datafeed should be forcefully deleted
175 .`deleteExpiredData(array $params = [])`
180 $params['job_id'] = (string) The ID of the job(s) to perform expired data hygiene for
181 $params['requests_per_second'] = (number) The desired requests per second for the deletion processes.
189 .`deleteFilter(array $params = [])`
194 $params['filter_id'] = (string) The ID of the filter to delete
202 .`deleteForecast(array $params = [])`
207 $params['job_id'] = (string) The ID of the job from which to delete forecasts (Required)
208 $params['forecast_id'] = (string) The ID of the forecast to delete, can be comma delimited list. Leaving blank implies `_all`
209 $params['allow_no_forecasts'] = (boolean) Whether to ignore if `_all` matches no forecasts
210 $params['timeout'] = (time) Controls the time to wait until the forecast(s) are deleted. Default to 30 seconds
218 .`deleteJob(array $params = [])`
223 $params['job_id'] = (string) The ID of the job to delete
224 $params['force'] = (boolean) True if the job should be forcefully deleted (Default = false)
225 $params['wait_for_completion'] = (boolean) Should this request wait until the operation has completed before returning (Default = true)
233 .`deleteModelSnapshot(array $params = [])`
238 $params['job_id'] = (string) The ID of the job to fetch
239 $params['snapshot_id'] = (string) The ID of the snapshot to delete
247 .`deleteTrainedModel(array $params = [])`
253 $params['model_id'] = (string) The ID of the trained model to delete
261 .`estimateModelMemory(array $params = [])`
266 $params['body'] = (array) The analysis config, plus cardinality estimates for fields it references (Required)
274 .`evaluateDataFrame(array $params = [])`
286 .`explainDataFrameAnalytics(array $params = [])`
292 $params['id'] = (string) The ID of the data frame analytics to explain
293 $params['body'] = (array) The data frame analytics config to explain
301 .`findFileStructure(array $params = [])`
307 $params['lines_to_sample'] = (int) How many lines of the file should be included in the analysis (Default = 1000)
308 $params['line_merge_size_limit'] = (int) Maximum number of characters permitted in a single message when lines are merged to create messages. (Default = 10000)
309 $params['timeout'] = (time) Timeout after which the analysis will be aborted (Default = 25s)
310 $params['charset'] = (string) Optional parameter to specify the character set of the file
311 $params['format'] = (enum) Optional parameter to specify the high level file format (Options = ndjson,xml,delimited,semi_structured_text)
312 $params['has_header_row'] = (boolean) Optional parameter to specify whether a delimited file includes the column names in its first row
313 $params['column_names'] = (list) Optional parameter containing a comma separated list of the column names for a delimited file
314 $params['delimiter'] = (string) Optional parameter to specify the delimiter character for a delimited file - must be a single character
315 $params['quote'] = (string) Optional parameter to specify the quote character for a delimited file - must be a single character
316 $params['should_trim_fields'] = (boolean) Optional parameter to specify whether the values between delimiters in a delimited file should have whitespace trimmed from them
317 $params['grok_pattern'] = (string) Optional parameter to specify the Grok pattern that should be used to extract fields from messages in a semi-structured text file
318 $params['timestamp_field'] = (string) Optional parameter to specify the timestamp field in the file
319 $params['timestamp_format'] = (string) Optional parameter to specify the timestamp format in the file - may be either a Joda or Java time format
320 $params['explain'] = (boolean) Whether to include a commentary on how the structure was derived (Default = false)
321 $params['body'] = (array) The contents of the file to be analyzed (Required)
329 .`flushJob(array $params = [])`
334 $params['job_id'] = (string) The name of the job to flush
335 $params['calc_interim'] = (boolean) Calculates interim results for the most recent bucket or all buckets within the latency period
336 $params['start'] = (string) When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results
337 $params['end'] = (string) When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results
338 $params['advance_time'] = (string) Advances time to the given value generating results and updating the model for the advanced interval
339 $params['skip_time'] = (string) Skips time to the given value without generating results or updating the model for the skipped interval
340 $params['body'] = (array) Flush parameters
348 .`forecast(array $params = [])`
353 $params['job_id'] = (string) The ID of the job to forecast for
354 $params['duration'] = (time) The duration of the forecast
355 $params['expires_in'] = (time) The time interval after which the forecast expires. Expired forecasts will be deleted at the first opportunity.
363 .`getBuckets(array $params = [])`
368 $params['job_id'] = (string) ID of the job to get bucket results from (Required)
369 $params['timestamp'] = (string) The timestamp of the desired single bucket result
370 $params['expand'] = (boolean) Include anomaly records
371 $params['exclude_interim'] = (boolean) Exclude interim results
372 $params['from'] = (int) skips a number of buckets
373 $params['size'] = (int) specifies a max number of buckets to get
374 $params['start'] = (string) Start time filter for buckets
375 $params['end'] = (string) End time filter for buckets
376 $params['anomaly_score'] = (double) Filter for the most anomalous buckets
377 $params['sort'] = (string) Sort buckets by a particular field
378 $params['desc'] = (boolean) Set the sort direction
379 $params['body'] = (array) Bucket selection details if not provided in URI
387 .`getCalendarEvents(array $params = [])`
392 $params['calendar_id'] = (string) The ID of the calendar containing the events
393 $params['job_id'] = (string) Get events for the job. When this option is used calendar_id must be '_all'
394 $params['start'] = (string) Get events after this time
395 $params['end'] = (date) Get events before this time
396 $params['from'] = (int) Skips a number of events
397 $params['size'] = (int) Specifies a max number of events to get
405 .`getCalendars(array $params = [])`
410 $params['calendar_id'] = (string) The ID of the calendar to fetch
411 $params['from'] = (int) skips a number of calendars
412 $params['size'] = (int) specifies a max number of calendars to get
413 $params['body'] = (array) The from and size parameters optionally sent in the body
421 .`getCategories(array $params = [])`
426 $params['job_id'] = (string) The name of the job (Required)
427 $params['category_id'] = (long) The identifier of the category definition of interest
428 $params['from'] = (int) skips a number of categories
429 $params['size'] = (int) specifies a max number of categories to get
430 $params['partition_field_value'] = (string) Specifies the partition to retrieve categories for. This is optional, and should never be used for jobs where per-partition categorization is disabled.
438 .`getDataFrameAnalytics(array $params = [])`
444 $params['id'] = (string) The ID of the data frame analytics to fetch
445 $params['allow_no_match'] = (boolean) 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) (Default = true)
446 $params['from'] = (int) skips a number of analytics (Default = 0)
447 $params['size'] = (int) specifies a max number of analytics to get (Default = 100)
448 $params['exclude_generated'] = (boolean) Omits fields that are illegal to set on data frame analytics PUT (Default = false)
456 .`getDataFrameAnalyticsStats(array $params = [])`
462 $params['id'] = (string) The ID of the data frame analytics stats to fetch
463 $params['allow_no_match'] = (boolean) 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) (Default = true)
464 $params['from'] = (int) skips a number of analytics (Default = 0)
465 $params['size'] = (int) specifies a max number of analytics to get (Default = 100)
466 $params['verbose'] = (boolean) whether the stats response should be verbose (Default = false)
474 .`getDatafeedStats(array $params = [])`
479 $params['datafeed_id'] = (string) The ID of the datafeeds stats to fetch
480 $params['allow_no_match'] = (boolean) Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)
481 $params['allow_no_datafeeds'] = (boolean) Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)
489 .`getDatafeeds(array $params = [])`
494 $params['datafeed_id'] = (string) The ID of the datafeeds to fetch
495 $params['allow_no_match'] = (boolean) Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)
496 $params['allow_no_datafeeds'] = (boolean) Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)
497 $params['exclude_generated'] = (boolean) Omits fields that are illegal to set on datafeed PUT (Default = false)
505 .`getFilters(array $params = [])`
510 $params['filter_id'] = (string) The ID of the filter to fetch
511 $params['from'] = (int) skips a number of filters
512 $params['size'] = (int) specifies a max number of filters to get
520 .`getInfluencers(array $params = [])`
525 $params['job_id'] = (string) Identifier for the anomaly detection job
526 $params['exclude_interim'] = (boolean) Exclude interim results
527 $params['from'] = (int) skips a number of influencers
528 $params['size'] = (int) specifies a max number of influencers to get
529 $params['start'] = (string) start timestamp for the requested influencers
530 $params['end'] = (string) end timestamp for the requested influencers
531 $params['influencer_score'] = (double) influencer score threshold for the requested influencers
532 $params['sort'] = (string) sort field for the requested influencers
533 $params['desc'] = (boolean) whether the results should be sorted in decending order
534 $params['body'] = (array) Influencer selection criteria
542 .`getJobStats(array $params = [])`
547 $params['job_id'] = (string) The ID of the jobs stats to fetch
548 $params['allow_no_match'] = (boolean) Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)
549 $params['allow_no_jobs'] = (boolean) Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)
557 .`getJobs(array $params = [])`
562 $params['job_id'] = (string) The ID of the jobs to fetch
563 $params['allow_no_match'] = (boolean) Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)
564 $params['allow_no_jobs'] = (boolean) Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)
565 $params['exclude_generated'] = (boolean) Omits fields that are illegal to set on job PUT (Default = false)
573 .`getModelSnapshots(array $params = [])`
578 $params['job_id'] = (string) The ID of the job to fetch (Required)
579 $params['snapshot_id'] = (string) The ID of the snapshot to fetch
580 $params['from'] = (int) Skips a number of documents
581 $params['size'] = (int) The default number of documents returned in queries as a string.
589 .`getOverallBuckets(array $params = [])`
594 $params['job_id'] = (string) The job IDs for which to calculate overall bucket results
595 $params['top_n'] = (int) The number of top job bucket scores to be used in the overall_score calculation
596 $params['bucket_span'] = (string) The span of the overall buckets. Defaults to the longest job bucket_span
597 $params['overall_score'] = (double) Returns overall buckets with overall scores higher than this value
598 $params['exclude_interim'] = (boolean) If true overall buckets that include interim buckets will be excluded
599 $params['start'] = (string) Returns overall buckets with timestamps after this time
600 $params['end'] = (string) Returns overall buckets with timestamps earlier than this time
601 $params['allow_no_match'] = (boolean) Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)
602 $params['allow_no_jobs'] = (boolean) Whether to ignore if a wildcard expression matches no jobs. (This includes `_all` string or when no jobs have been specified)
603 $params['body'] = (array) Overall bucket selection details if not provided in URI
611 .`getRecords(array $params = [])`
616 $params['job_id'] = (string) The ID of the job
617 $params['exclude_interim'] = (boolean) Exclude interim results
618 $params['from'] = (int) skips a number of records
619 $params['size'] = (int) specifies a max number of records to get
620 $params['start'] = (string) Start time filter for records
621 $params['end'] = (string) End time filter for records
622 $params['record_score'] = (double) Returns records with anomaly scores greater or equal than this value
623 $params['sort'] = (string) Sort records by a particular field
624 $params['desc'] = (boolean) Set the sort direction
625 $params['body'] = (array) Record selection criteria
633 .`getTrainedModels(array $params = [])`
639 $params['model_id'] = (string) The ID of the trained models to fetch
640 $params['allow_no_match'] = (boolean) Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified) (Default = true)
641 $params['include'] = (string) A comma-separate list of fields to optionally include. Valid options are 'definition' and 'total_feature_importance'. Default is none.
649 .`getTrainedModelsStats(array $params = [])`
655 $params['model_id'] = (string) The ID of the trained models stats to fetch
656 $params['allow_no_match'] = (boolean) Whether to ignore if a wildcard expression matches no trained models. (This includes `_all` string or when no trained models have been specified) (Default = true)
657 $params['from'] = (int) skips a number of trained models (Default = 0)
658 $params['size'] = (int) specifies a max number of trained models to get (Default = 100)
666 .`info(array $params = [])`
678 .`openJob(array $params = [])`
683 $params['job_id'] = (string) The ID of the job to open
691 .`postCalendarEvents(array $params = [])`
696 $params['calendar_id'] = (string) The ID of the calendar to modify
697 $params['body'] = (array) A list of events (Required)
705 .`postData(array $params = [])`
710 $params['job_id'] = (string) The name of the job receiving the data
711 $params['reset_start'] = (string) Optional parameter to specify the start of the bucket resetting range
712 $params['reset_end'] = (string) Optional parameter to specify the end of the bucket resetting range
713 $params['body'] = (array) The data to process (Required)
721 .`previewDatafeed(array $params = [])`
726 $params['datafeed_id'] = (string) The ID of the datafeed to preview
734 .`putCalendar(array $params = [])`
739 $params['calendar_id'] = (string) The ID of the calendar to create
740 $params['body'] = (array) The calendar details
748 .`putCalendarJob(array $params = [])`
753 $params['calendar_id'] = (string) The ID of the calendar to modify
754 $params['job_id'] = (string) The ID of the job to add to the calendar
762 .`putDataFrameAnalytics(array $params = [])`
768 $params['id'] = (string) The ID of the data frame analytics to create
769 $params['body'] = (array) The data frame analytics configuration (Required)
777 .`putDatafeed(array $params = [])`
782 $params['datafeed_id'] = (string) The ID of the datafeed to create
783 $params['ignore_unavailable'] = (boolean) Ignore unavailable indexes (default: false)
784 $params['allow_no_indices'] = (boolean) Ignore if the source indices expressions resolves to no concrete indices (default: true)
785 $params['ignore_throttled'] = (boolean) Ignore indices that are marked as throttled (default: true)
786 $params['expand_wildcards'] = (enum) Whether source index expressions should get expanded to open or closed indices (default: open) (Options = open,closed,hidden,none,all)
787 $params['body'] = (array) The datafeed config (Required)
795 .`putFilter(array $params = [])`
800 $params['filter_id'] = (string) The ID of the filter to create
801 $params['body'] = (array) The filter details (Required)
809 .`putJob(array $params = [])`
814 $params['job_id'] = (string) The ID of the job to create
815 $params['body'] = (array) The job (Required)
823 .`putTrainedModel(array $params = [])`
829 $params['model_id'] = (string) The ID of the trained models to store
830 $params['body'] = (array) The trained model configuration (Required)
838 .`revertModelSnapshot(array $params = [])`
843 $params['job_id'] = (string) The ID of the job to fetch
844 $params['snapshot_id'] = (string) The ID of the snapshot to revert to
845 $params['delete_intervening_results'] = (boolean) Should we reset the results back to the time of the snapshot?
846 $params['body'] = (array) Reversion options
854 .`setUpgradeMode(array $params = [])`
859 $params['enabled'] = (boolean) Whether to enable upgrade_mode ML setting or not. Defaults to false.
867 .`startDataFrameAnalytics(array $params = [])`
873 $params['id'] = (string) The ID of the data frame analytics to start
874 $params['timeout'] = (time) Controls the time to wait until the task has started. Defaults to 20 seconds
875 $params['body'] = (array) The start data frame analytics parameters
883 .`startDatafeed(array $params = [])`
888 $params['datafeed_id'] = (string) The ID of the datafeed to start
889 $params['start'] = (string) The start time from where the datafeed should begin
890 $params['end'] = (string) The end time when the datafeed should stop. When not set, the datafeed continues in real time
891 $params['timeout'] = (time) Controls the time to wait until a datafeed has started. Default to 20 seconds
892 $params['body'] = (array) The start datafeed parameters
900 .`stopDataFrameAnalytics(array $params = [])`
906 $params['id'] = (string) The ID of the data frame analytics to stop
907 $params['allow_no_match'] = (boolean) 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)
908 $params['force'] = (boolean) True if the data frame analytics should be forcefully stopped
909 $params['timeout'] = (time) Controls the time to wait until the task has stopped. Defaults to 20 seconds
910 $params['body'] = (array) The stop data frame analytics parameters
918 .`stopDatafeed(array $params = [])`
923 $params['datafeed_id'] = (string) The ID of the datafeed to stop
924 $params['allow_no_match'] = (boolean) Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)
925 $params['allow_no_datafeeds'] = (boolean) Whether to ignore if a wildcard expression matches no datafeeds. (This includes `_all` string or when no datafeeds have been specified)
926 $params['force'] = (boolean) True if the datafeed should be forcefully stopped.
934 .`updateDataFrameAnalytics(array $params = [])`
940 $params['id'] = (string) The ID of the data frame analytics to update
941 $params['body'] = (array) The data frame analytics settings to update (Required)
949 .`updateDatafeed(array $params = [])`
954 $params['datafeed_id'] = (string) The ID of the datafeed to update
955 $params['ignore_unavailable'] = (boolean) Ignore unavailable indexes (default: false)
956 $params['allow_no_indices'] = (boolean) Ignore if the source indices expressions resolves to no concrete indices (default: true)
957 $params['ignore_throttled'] = (boolean) Ignore indices that are marked as throttled (default: true)
958 $params['expand_wildcards'] = (enum) Whether source index expressions should get expanded to open or closed indices (default: open) (Options = open,closed,hidden,none,all)
959 $params['body'] = (array) The datafeed update settings (Required)
967 .`updateFilter(array $params = [])`
972 $params['filter_id'] = (string) The ID of the filter to update
973 $params['body'] = (array) The filter update (Required)
981 .`updateJob(array $params = [])`
986 $params['job_id'] = (string) The ID of the job to create
987 $params['body'] = (array) The job update settings (Required)
995 .`updateModelSnapshot(array $params = [])`
1000 $params['job_id'] = (string) The ID of the job to fetch
1001 $params['snapshot_id'] = (string) The ID of the snapshot to update
1002 $params['body'] = (array) The model snapshot properties to update (Required)
1010 .`upgradeJobSnapshot(array $params = [])`
1015 $params['job_id'] = (string) The ID of the job
1016 $params['snapshot_id'] = (string) The ID of the snapshot
1017 $params['timeout'] = (time) How long should the API wait for the job to be opened and the old snapshot to be loaded.
1025 .`validate(array $params = [])`
1030 $params['body'] = (array) The job config (Required)
1038 .`validateDetector(array $params = [])`
1043 $params['body'] = (array) The detector (Required)