Lines Matching defs:params
33 * $params['job_id'] = (string) The name of the job to close
34 * $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)
35 * $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)
36 * $params['force'] = (boolean) True if the job should be forcefully closed
37 * $params['timeout'] = (time) Controls the time to wait until a job has closed. Default to 30 minutes
38 * $params['body'] = (array) The URL params optionally sent in the body
40 * @param array $params Associative array of parameters
44 public function closeJob(array $params = [])
46 $job_id = $this->extractArgument($params, 'job_id');
47 $body = $this->extractArgument($params, 'body');
51 $endpoint->setParams($params);
60 * $params['calendar_id'] = (string) The ID of the calendar to delete
62 * @param array $params Associative array of parameters
66 public function deleteCalendar(array $params = [])
68 $calendar_id = $this->extractArgument($params, 'calendar_id');
72 $endpoint->setParams($params);
80 * $params['calendar_id'] = (string) The ID of the calendar to modify
81 * $params['event_id'] = (string) The ID of the event to remove from the calendar
83 * @param array $params Associative array of parameters
87 public function deleteCalendarEvent(array $params = [])
89 $calendar_id = $this->extractArgument($params, 'calendar_id');
90 $event_id = $this->extractArgument($params, 'event_id');
94 $endpoint->setParams($params);
103 * $params['calendar_id'] = (string) The ID of the calendar to modify
104 * $params['job_id'] = (string) The ID of the job to remove from the calendar
106 * @param array $params Associative array of parameters
110 public function deleteCalendarJob(array $params = [])
112 $calendar_id = $this->extractArgument($params, 'calendar_id');
113 $job_id = $this->extractArgument($params, 'job_id');
117 $endpoint->setParams($params);
126 * $params['id'] = (string) The ID of the data frame analytics to delete
127 * $params['force'] = (boolean) True if the job should be forcefully deleted (Default = false)
128 * $params['timeout'] = (time) Controls the time to wait until a job is deleted. Defaults to 1 minute
130 * @param array $params Associative array of parameters
134 public function deleteDataFrameAnalytics(array $params = [])
136 $id = $this->extractArgument($params, 'id');
140 $endpoint->setParams($params);
148 * $params['datafeed_id'] = (string) The ID of the datafeed to delete
149 * $params['force'] = (boolean) True if the datafeed should be forcefully deleted
151 * @param array $params Associative array of parameters
155 public function deleteDatafeed(array $params = [])
157 $datafeed_id = $this->extractArgument($params, 'datafeed_id');
161 $endpoint->setParams($params);
169 * $params['job_id'] = (string) The ID of the job(s) to perform expired data hygiene for
170 * $params['requests_per_second'] = (number) The desired requests per second for the deletion processes.
171 * $params['timeout'] = (time) How long can the underlying delete processes run until they are canceled
172 * $params['body'] = (array) deleting expired data parameters
174 * @param array $params Associative array of parameters
178 public function deleteExpiredData(array $params = [])
180 $job_id = $this->extractArgument($params, 'job_id');
181 $body = $this->extractArgument($params, 'body');
185 $endpoint->setParams($params);
194 * $params['filter_id'] = (string) The ID of the filter to delete
196 * @param array $params Associative array of parameters
200 public function deleteFilter(array $params = [])
202 $filter_id = $this->extractArgument($params, 'filter_id');
206 $endpoint->setParams($params);
214 * $params['job_id'] = (string) The ID of the job from which to delete forecasts (Required)
215 * $params['forecast_id'] = (string) The ID of the forecast to delete, can be comma delimited list. Leaving blank implies `_all`
216 * $params['allow_no_forecasts'] = (boolean) Whether to ignore if `_all` matches no forecasts
217 * $params['timeout'] = (time) Controls the time to wait until the forecast(s) are deleted. Default to 30 seconds
219 * @param array $params Associative array of parameters
223 public function deleteForecast(array $params = [])
225 $job_id = $this->extractArgument($params, 'job_id');
226 $forecast_id = $this->extractArgument($params, 'forecast_id');
230 $endpoint->setParams($params);
239 * $params['job_id'] = (string) The ID of the job to delete
240 * $params['force'] = (boolean) True if the job should be forcefully deleted (Default = false)
241 * $params['wait_for_completion'] = (boolean) Should this request wait until the operation has completed before returning (Default = true)
243 * @param array $params Associative array of parameters
247 public function deleteJob(array $params = [])
249 $job_id = $this->extractArgument($params, 'job_id');
253 $endpoint->setParams($params);
261 * $params['job_id'] = (string) The ID of the job to fetch
262 * $params['snapshot_id'] = (string) The ID of the snapshot to delete
264 * @param array $params Associative array of parameters
268 public function deleteModelSnapshot(array $params = [])
270 $job_id = $this->extractArgument($params, 'job_id');
271 $snapshot_id = $this->extractArgument($params, 'snapshot_id');
275 $endpoint->setParams($params);
284 * $params['model_id'] = (string) The ID of the trained model to delete
286 * @param array $params Associative array of parameters
290 public function deleteTrainedModel(array $params = [])
292 $model_id = $this->extractArgument($params, 'model_id');
296 $endpoint->setParams($params);
304 * $params['model_alias'] = (string) The trained model alias to delete
305 * $params['model_id'] = (string) The trained model where the model alias is assigned
307 * @param array $params Associative array of parameters
311 public function deleteTrainedModelAlias(array $params = [])
313 $model_alias = $this->extractArgument($params, 'model_alias');
314 $model_id = $this->extractArgument($params, 'model_id');
318 $endpoint->setParams($params);
327 * $params['body'] = (array) The analysis config, plus cardinality estimates for fields it references (Required)
329 * @param array $params Associative array of parameters
333 public function estimateModelMemory(array $params = [])
335 $body = $this->extractArgument($params, 'body');
339 $endpoint->setParams($params);
347 * $params['body'] = (array) The evaluation definition (Required)
349 * @param array $params Associative array of parameters
353 public function evaluateDataFrame(array $params = [])
355 $body = $this->extractArgument($params, 'body');
359 $endpoint->setParams($params);
367 * $params['id'] = (string) The ID of the data frame analytics to explain
368 * $params['body'] = (array) The data frame analytics config to explain
370 * @param array $params Associative array of parameters
374 public function explainDataFrameAnalytics(array $params = [])
376 $id = $this->extractArgument($params, 'id');
377 $body = $this->extractArgument($params, 'body');
381 $endpoint->setParams($params);
390 * $params['lines_to_sample'] = (int) How many lines of the file should be included in the analysis (Default = 1000)
391 * $params['line_merge_size_limit'] = (int) Maximum number of characters permitted in a single message when lines are merged to create messages. (Default = 10000)
392 * $params['timeout'] = (time) Timeout after which the analysis will be aborted (Default = 25s)
393 * $params['charset'] = (string) Optional parameter to specify the character set of the file
394 * $params['format'] = (enum) Optional parameter to specify the high level file format (Options = ndjson,xml,delimited,semi_structured_text)
395 * $params['has_header_row'] = (boolean) Optional parameter to specify whether a delimited file includes the column names in its first row
396 * $params['column_names'] = (list) Optional parameter containing a comma separated list of the column names for a delimited file
397 * $params['delimiter'] = (string) Optional parameter to specify the delimiter character for a delimited file - must be a single character
398 * $params['quote'] = (string) Optional parameter to specify the quote character for a delimited file - must be a single character
399 * $params['should_trim_fields'] = (boolean) Optional parameter to specify whether the values between delimiters in a delimited file should have whitespace trimmed from them
400 * $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
401 * $params['timestamp_field'] = (string) Optional parameter to specify the timestamp field in the file
402 * $params['timestamp_format'] = (string) Optional parameter to specify the timestamp format in the file - may be either a Joda or Java time format
403 * $params['explain'] = (boolean) Whether to include a commentary on how the structure was derived (Default = false)
404 * $params['body'] = (array) The contents of the file to be analyzed (Required)
406 * @param array $params Associative array of parameters
413 public function findFileStructure(array $params = [])
415 $body = $this->extractArgument($params, 'body');
419 $endpoint->setParams($params);
427 * $params['job_id'] = (string) The name of the job to flush
428 * $params['calc_interim'] = (boolean) Calculates interim results for the most recent bucket or all buckets within the latency period
429 * $params['start'] = (string) When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results
430 * $params['end'] = (string) When used in conjunction with calc_interim, specifies the range of buckets on which to calculate interim results
431 * $params['advance_time'] = (string) Advances time to the given value generating results and updating the model for the advanced interval
432 * $params['skip_time'] = (string) Skips time to the given value without generating results or updating the model for the skipped interval
433 * $params['body'] = (array) Flush parameters
435 * @param array $params Associative array of parameters
439 public function flushJob(array $params = [])
441 $job_id = $this->extractArgument($params, 'job_id');
442 $body = $this->extractArgument($params, 'body');
446 $endpoint->setParams($params);
455 * $params['job_id'] = (string) The ID of the job to forecast for
456 * $params['duration'] = (time) The duration of the forecast
457 * $params['expires_in'] = (time) The time interval after which the forecast expires. Expired forecasts will be deleted at the first opportunity.
458 * $params['max_model_memory'] = (string) The max memory able to be used by the forecast. Default is 20mb.
460 * @param array $params Associative array of parameters
464 public function forecast(array $params = [])
466 $job_id = $this->extractArgument($params, 'job_id');
470 $endpoint->setParams($params);
478 * $params['job_id'] = (string) ID of the job to get bucket results from (Required)
479 * $params['timestamp'] = (string) The timestamp of the desired single bucket result
480 * $params['expand'] = (boolean) Include anomaly records
481 * $params['exclude_interim'] = (boolean) Exclude interim results
482 * $params['from'] = (int) skips a number of buckets
483 * $params['size'] = (int) specifies a max number of buckets to get
484 * $params['start'] = (string) Start time filter for buckets
485 * $params['end'] = (string) End time filter for buckets
486 * $params['anomaly_score'] = (double) Filter for the most anomalous buckets
487 * $params['sort'] = (string) Sort buckets by a particular field
488 * $params['desc'] = (boolean) Set the sort direction
489 * $params['body'] = (array) Bucket selection details if not provided in URI
491 * @param array $params Associative array of parameters
495 public function getBuckets(array $params = [])
497 $job_id = $this->extractArgument($params, 'job_id');
498 $timestamp = $this->extractArgument($params, 'timestamp');
499 $body = $this->extractArgument($params, 'body');
503 $endpoint->setParams($params);
513 * $params['calendar_id'] = (string) The ID of the calendar containing the events
514 * $params['job_id'] = (string) Get events for the job. When this option is used calendar_id must be '_all'
515 * $params['start'] = (string) Get events after this time
516 * $params['end'] = (date) Get events before this time
517 * $params['from'] = (int) Skips a number of events
518 * $params['size'] = (int) Specifies a max number of events to get
520 * @param array $params Associative array of parameters
524 public function getCalendarEvents(array $params = [])
526 $calendar_id = $this->extractArgument($params, 'calendar_id');
530 $endpoint->setParams($params);
538 * $params['calendar_id'] = (string) The ID of the calendar to fetch
539 * $params['from'] = (int) skips a number of calendars
540 * $params['size'] = (int) specifies a max number of calendars to get
541 * $params['body'] = (array) The from and size parameters optionally sent in the body
543 * @param array $params Associative array of parameters
547 public function getCalendars(array $params = [])
549 $calendar_id = $this->extractArgument($params, 'calendar_id');
550 $body = $this->extractArgument($params, 'body');
554 $endpoint->setParams($params);
563 * $params['job_id'] = (string) The name of the job (Required)
564 * $params['category_id'] = (long) The identifier of the category definition of interest
565 * $params['from'] = (int) skips a number of categories
566 * $params['size'] = (int) specifies a max number of categories to get
567 * $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.
568 * $params['body'] = (array) Category selection details if not provided in URI
570 * @param array $params Associative array of parameters
574 public function getCategories(array $params = [])
576 $job_id = $this->extractArgument($params, 'job_id');
577 $category_id = $this->extractArgument($params, 'category_id');
578 $body = $this->extractArgument($params, 'body');
582 $endpoint->setParams($params);
592 * $params['id'] = (string) The ID of the data frame analytics to fetch
593 * $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)
594 * $params['from'] = (int) skips a number of analytics (Default = 0)
595 * $params['size'] = (int) specifies a max number of analytics to get (Default = 100)
596 * $params['exclude_generated'] = (boolean) Omits fields that are illegal to set on data frame analytics PUT (Default = false)
598 * @param array $params Associative array of parameters
602 public function getDataFrameAnalytics(array $params = [])
604 $id = $this->extractArgument($params, 'id');
608 $endpoint->setParams($params);
616 * $params['id'] = (string) The ID of the data frame analytics stats to fetch
617 * $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)
618 * $params['from'] = (int) skips a number of analytics (Default = 0)
619 * $params['size'] = (int) specifies a max number of analytics to get (Default = 100)
620 * $params['verbose'] = (boolean) whether the stats response should be verbose (Default = false)
622 * @param array $params Associative array of parameters
626 public function getDataFrameAnalyticsStats(array $params = [])
628 $id = $this->extractArgument($params, 'id');
632 $endpoint->setParams($params);
640 * $params['datafeed_id'] = (string) The ID of the datafeeds stats to fetch
641 * $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)
642 * $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)
644 * @param array $params Associative array of parameters
648 public function getDatafeedStats(array $params = [])
650 $datafeed_id = $this->extractArgument($params, 'datafeed_id');
654 $endpoint->setParams($params);
662 * $params['datafeed_id'] = (string) The ID of the datafeeds to fetch
663 * $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)
664 * $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)
665 * $params['exclude_generated'] = (boolean) Omits fields that are illegal to set on datafeed PUT (Default = false)
667 * @param array $params Associative array of parameters
671 public function getDatafeeds(array $params = [])
673 $datafeed_id = $this->extractArgument($params, 'datafeed_id');
677 $endpoint->setParams($params);
685 * $params['filter_id'] = (string) The ID of the filter to fetch
686 * $params['from'] = (int) skips a number of filters
687 * $params['size'] = (int) specifies a max number of filters to get
689 * @param array $params Associative array of parameters
693 public function getFilters(array $params = [])
695 $filter_id = $this->extractArgument($params, 'filter_id');
699 $endpoint->setParams($params);
707 * $params['job_id'] = (string) Identifier for the anomaly detection job
708 * $params['exclude_interim'] = (boolean) Exclude interim results
709 * $params['from'] = (int) skips a number of influencers
710 * $params['size'] = (int) specifies a max number of influencers to get
711 * $params['start'] = (string) start timestamp for the requested influencers
712 * $params['end'] = (string) end timestamp for the requested influencers
713 * $params['influencer_score'] = (double) influencer score threshold for the requested influencers
714 * $params['sort'] = (string) sort field for the requested influencers
715 * $params['desc'] = (boolean) whether the results should be sorted in decending order
716 * $params['body'] = (array) Influencer selection criteria
718 * @param array $params Associative array of parameters
722 public function getInfluencers(array $params = [])
724 $job_id = $this->extractArgument($params, 'job_id');
725 $body = $this->extractArgument($params, 'body');
729 $endpoint->setParams($params);
738 * $params['job_id'] = (string) The ID of the jobs stats to fetch
739 * $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)
740 * $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)
742 * @param array $params Associative array of parameters
746 public function getJobStats(array $params = [])
748 $job_id = $this->extractArgument($params, 'job_id');
752 $endpoint->setParams($params);
760 * $params['job_id'] = (string) The ID of the jobs to fetch
761 * $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)
762 * $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)
763 * $params['exclude_generated'] = (boolean) Omits fields that are illegal to set on job PUT (Default = false)
765 * @param array $params Associative array of parameters
769 public function getJobs(array $params = [])
771 $job_id = $this->extractArgument($params, 'job_id');
775 $endpoint->setParams($params);
783 * $params['job_id'] = (string) The ID of the job to fetch (Required)
784 * $params['snapshot_id'] = (string) The ID of the snapshot to fetch
785 * $params['from'] = (int) Skips a number of documents
786 * $params['size'] = (int) The default number of documents returned in queries as a string.
787 * $params['start'] = (date) The filter 'start' query parameter
788 * $params['end'] = (date) The filter 'end' query parameter
789 * $params['sort'] = (string) Name of the field to sort on
790 * $params['desc'] = (boolean) True if the results should be sorted in descending order
791 * $params['body'] = (array) Model snapshot selection criteria
793 * @param array $params Associative array of parameters
797 public function getModelSnapshots(array $params = [])
799 $job_id = $this->extractArgument($params, 'job_id');
800 $snapshot_id = $this->extractArgument($params, 'snapshot_id');
801 $body = $this->extractArgument($params, 'body');
805 $endpoint->setParams($params);
815 * $params['job_id'] = (string) The job IDs for which to calculate overall bucket results
816 * $params['top_n'] = (int) The number of top job bucket scores to be used in the overall_score calculation
817 * $params['bucket_span'] = (string) The span of the overall buckets. Defaults to the longest job bucket_span
818 * $params['overall_score'] = (double) Returns overall buckets with overall scores higher than this value
819 * $params['exclude_interim'] = (boolean) If true overall buckets that include interim buckets will be excluded
820 * $params['start'] = (string) Returns overall buckets with timestamps after this time
821 * $params['end'] = (string) Returns overall buckets with timestamps earlier than this time
822 * $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)
823 * $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)
824 * $params['body'] = (array) Overall bucket selection details if not provided in URI
826 * @param array $params Associative array of parameters
830 public function getOverallBuckets(array $params = [])
832 $job_id = $this->extractArgument($params, 'job_id');
833 $body = $this->extractArgument($params, 'body');
837 $endpoint->setParams($params);
846 * $params['job_id'] = (string) The ID of the job
847 * $params['exclude_interim'] = (boolean) Exclude interim results
848 * $params['from'] = (int) skips a number of records
849 * $params['size'] = (int) specifies a max number of records to get
850 * $params['start'] = (string) Start time filter for records
851 * $params['end'] = (string) End time filter for records
852 * $params['record_score'] = (double) Returns records with anomaly scores greater or equal than this value
853 * $params['sort'] = (string) Sort records by a particular field
854 * $params['desc'] = (boolean) Set the sort direction
855 * $params['body'] = (array) Record selection criteria
857 * @param array $params Associative array of parameters
861 public function getRecords(array $params = [])
863 $job_id = $this->extractArgument($params, 'job_id');
864 $body = $this->extractArgument($params, 'body');
868 $endpoint->setParams($params);
877 * $params['model_id'] = (string) The ID of the trained models to fetch
878 * $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)
879 * $params['include'] = (string) A comma-separate list of fields to optionally include. Valid options are 'definition' and 'total_feature_importance'. Default is none.
880 * $params['include_model_definition'] = (boolean) Should the full model definition be included in the results. These definitions can be large. So be cautious when including them. Defaults to false. (Default = false)
881 * $params['decompress_definition'] = (boolean) Should the model definition be decompressed into valid JSON or returned in a custom compressed format. Defaults to true. (Default = true)
882 * $params['from'] = (int) skips a number of trained models (Default = 0)
883 * $params['size'] = (int) specifies a max number of trained models to get (Default = 100)
884 * $params['tags'] = (list) A comma-separated list of tags that the model must have.
885 * $params['exclude_generated'] = (boolean) Omits fields that are illegal to set on model PUT (Default = false)
887 * @param array $params Associative array of parameters
891 public function getTrainedModels(array $params = [])
893 $model_id = $this->extractArgument($params, 'model_id');
897 $endpoint->setParams($params);
905 * $params['model_id'] = (string) The ID of the trained models stats to fetch
906 * $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)
907 * $params['from'] = (int) skips a number of trained models (Default = 0)
908 * $params['size'] = (int) specifies a max number of trained models to get (Default = 100)
910 * @param array $params Associative array of parameters
914 public function getTrainedModelsStats(array $params = [])
916 $model_id = $this->extractArgument($params, 'model_id');
920 $endpoint->setParams($params);
929 * @param array $params Associative array of parameters
933 public function info(array $params = [])
938 $endpoint->setParams($params);
945 * $params['job_id'] = (string) The ID of the job to open
947 * @param array $params Associative array of parameters
951 public function openJob(array $params = [])
953 $job_id = $this->extractArgument($params, 'job_id');
957 $endpoint->setParams($params);
965 * $params['calendar_id'] = (string) The ID of the calendar to modify
966 * $params['body'] = (array) A list of events (Required)
968 * @param array $params Associative array of parameters
972 public function postCalendarEvents(array $params = [])
974 $calendar_id = $this->extractArgument($params, 'calendar_id');
975 $body = $this->extractArgument($params, 'body');
979 $endpoint->setParams($params);
988 * $params['job_id'] = (string) The name of the job receiving the data
989 * $params['reset_start'] = (string) Optional parameter to specify the start of the bucket resetting range
990 * $params['reset_end'] = (string) Optional parameter to specify the end of the bucket resetting range
991 * $params['body'] = (array) The data to process (Required)
993 * @param array $params Associative array of parameters
997 public function postData(array $params = [])
999 $job_id = $this->extractArgument($params, 'job_id');
1000 $body = $this->extractArgument($params, 'body');
1004 $endpoint->setParams($params);
1013 * $params['id'] = (string) The ID of the data frame analytics to preview
1014 * $params['body'] = (array) The data frame analytics config to preview
1016 * @param array $params Associative array of parameters
1020 public function previewDataFrameAnalytics(array $params = [])
1022 $id = $this->extractArgument($params, 'id');
1023 $body = $this->extractArgument($params, 'body');
1027 $endpoint->setParams($params);
1036 * $params['datafeed_id'] = (string) The ID of the datafeed to preview
1037 * $params['body'] = (array) The datafeed config and job config with which to execute the preview
1039 * @param array $params Associative array of parameters
1043 public function previewDatafeed(array $params = [])
1045 $datafeed_id = $this->extractArgument($params, 'datafeed_id');
1046 $body = $this->extractArgument($params, 'body');
1050 $endpoint->setParams($params);
1059 * $params['calendar_id'] = (string) The ID of the calendar to create
1060 * $params['body'] = (array) The calendar details
1062 * @param array $params Associative array of parameters
1066 public function putCalendar(array $params = [])
1068 $calendar_id = $this->extractArgument($params, 'calendar_id');
1069 $body = $this->extractArgument($params, 'body');
1073 $endpoint->setParams($params);
1082 * $params['calendar_id'] = (string) The ID of the calendar to modify
1083 * $params['job_id'] = (string) The ID of the job to add to the calendar
1085 * @param array $params Associative array of parameters
1089 public function putCalendarJob(array $params = [])
1091 $calendar_id = $this->extractArgument($params, 'calendar_id');
1092 $job_id = $this->extractArgument($params, 'job_id');
1096 $endpoint->setParams($params);
1105 * $params['id'] = (string) The ID of the data frame analytics to create
1106 * $params['body'] = (array) The data frame analytics configuration (Required)
1108 * @param array $params Associative array of parameters
1112 public function putDataFrameAnalytics(array $params = [])
1114 $id = $this->extractArgument($params, 'id');
1115 $body = $this->extractArgument($params, 'body');
1119 $endpoint->setParams($params);
1128 * $params['datafeed_id'] = (string) The ID of the datafeed to create
1129 * $params['ignore_unavailable'] = (boolean) Ignore unavailable indexes (default: false)
1130 * $params['allow_no_indices'] = (boolean) Ignore if the source indices expressions resolves to no concrete indices (default: true)
1131 * $params['ignore_throttled'] = (boolean) Ignore indices that are marked as throttled (default: true)
1132 * $params['expand_wildcards'] = (enum) Whether source index expressions should get expanded to open or closed indices (default: open) (Options = open,closed,hidden,none,all)
1133 * $params['body'] = (array) The datafeed config (Required)
1135 * @param array $params Associative array of parameters
1139 public function putDatafeed(array $params = [])
1141 $datafeed_id = $this->extractArgument($params, 'datafeed_id');
1142 $body = $this->extractArgument($params, 'body');
1146 $endpoint->setParams($params);
1155 * $params['filter_id'] = (string) The ID of the filter to create
1156 * $params['body'] = (array) The filter details (Required)
1158 * @param array $params Associative array of parameters
1162 public function putFilter(array $params = [])
1164 $filter_id = $this->extractArgument($params, 'filter_id');
1165 $body = $this->extractArgument($params, 'body');
1169 $endpoint->setParams($params);
1178 * $params['job_id'] = (string) The ID of the job to create
1179 * $params['ignore_unavailable'] = (boolean) Ignore unavailable indexes (default: false). Only set if datafeed_config is provided.
1180 * $params['allow_no_indices'] = (boolean) Ignore if the source indices expressions resolves to no concrete indices (default: true). Only set if datafeed_config is provided.
1181 * $params['ignore_throttled'] = (boolean) Ignore indices that are marked as throttled (default: true). Only set if datafeed_config is provided.
1182 * $params['expand_wildcards'] = (enum) Whether source index expressions should get expanded to open or closed indices (default: open). Only set if datafeed_config is provided. (Options = open,closed,hidden,none,all)
1183 * $params['body'] = (array) The job (Required)
1185 * @param array $params Associative array of parameters
1189 public function putJob(array $params = [])
1191 $job_id = $this->extractArgument($params, 'job_id');
1192 $body = $this->extractArgument($params, 'body');
1196 $endpoint->setParams($params);
1205 * $params['model_id'] = (string) The ID of the trained models to store
1206 * $params['defer_definition_decompression'] = (boolean) If set to `true` and a `compressed_definition` is provided, the request defers definition decompression and skips relevant validations. (Default = false)
1207 * $params['body'] = (array) The trained model configuration (Required)
1209 * @param array $params Associative array of parameters
1213 public function putTrainedModel(array $params = [])
1215 $model_id = $this->extractArgument($params, 'model_id');
1216 $body = $this->extractArgument($params, 'body');
1220 $endpoint->setParams($params);
1229 * $params['model_alias'] = (string) The trained model alias to update
1230 * $params['model_id'] = (string) The trained model where the model alias should be assigned
1231 * $params['reassign'] = (boolean) If the model_alias already exists and points to a separate model_id, this parameter must be true. Defaults to false.
1233 * @param array $params Associative array of parameters
1237 public function putTrainedModelAlias(array $params = [])
1239 $model_alias = $this->extractArgument($params, 'model_alias');
1240 $model_id = $this->extractArgument($params, 'model_id');
1244 $endpoint->setParams($params);
1253 * $params['job_id'] = (string) The ID of the job to reset
1254 * $params['wait_for_completion'] = (boolean) Should this request wait until the operation has completed before returning (Default = true)
1256 * @param array $params Associative array of parameters
1260 public function resetJob(array $params = [])
1262 $job_id = $this->extractArgument($params, 'job_id');
1266 $endpoint->setParams($params);
1274 * $params['job_id'] = (string) The ID of the job to fetch
1275 * $params['snapshot_id'] = (string) The ID of the snapshot to revert to
1276 * $params['delete_intervening_results'] = (boolean) Should we reset the results back to the time of the snapshot?
1277 * $params['body'] = (array) Reversion options
1279 * @param array $params Associative array of parameters
1283 public function revertModelSnapshot(array $params = [])
1285 $job_id = $this->extractArgument($params, 'job_id');
1286 $snapshot_id = $this->extractArgument($params, 'snapshot_id');
1287 $body = $this->extractArgument($params, 'body');
1291 $endpoint->setParams($params);
1301 * $params['enabled'] = (boolean) Whether to enable upgrade_mode ML setting or not. Defaults to false.
1302 * $params['timeout'] = (time) Controls the time to wait before action times out. Defaults to 30 seconds
1304 * @param array $params Associative array of parameters
1308 public function setUpgradeMode(array $params = [])
1313 $endpoint->setParams($params);
1320 * $params['id'] = (string) The ID of the data frame analytics to start
1321 * $params['timeout'] = (time) Controls the time to wait until the task has started. Defaults to 20 seconds
1322 * $params['body'] = (array) The start data frame analytics parameters
1324 * @param array $params Associative array of parameters
1328 public function startDataFrameAnalytics(array $params = [])
1330 $id = $this->extractArgument($params, 'id');
1331 $body = $this->extractArgument($params, 'body');
1335 $endpoint->setParams($params);
1344 * $params['datafeed_id'] = (string) The ID of the datafeed to start
1345 * $params['start'] = (string) The start time from where the datafeed should begin
1346 * $params['end'] = (string) The end time when the datafeed should stop. When not set, the datafeed continues in real time
1347 * $params['timeout'] = (time) Controls the time to wait until a datafeed has started. Default to 20 seconds
1348 * $params['body'] = (array) The start datafeed parameters
1350 * @param array $params Associative array of parameters
1354 public function startDatafeed(array $params = [])
1356 $datafeed_id = $this->extractArgument($params, 'datafeed_id');
1357 $body = $this->extractArgument($params, 'body');
1361 $endpoint->setParams($params);
1370 * $params['id'] = (string) The ID of the data frame analytics to stop
1371 * $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)
1372 * $params['force'] = (boolean) True if the data frame analytics should be forcefully stopped
1373 * $params['timeout'] = (time) Controls the time to wait until the task has stopped. Defaults to 20 seconds
1374 * $params['body'] = (array) The stop data frame analytics parameters
1376 * @param array $params Associative array of parameters
1380 public function stopDataFrameAnalytics(array $params = [])
1382 $id = $this->extractArgument($params, 'id');
1383 $body = $this->extractArgument($params, 'body');
1387 $endpoint->setParams($params);
1396 * $params['datafeed_id'] = (string) The ID of the datafeed to stop
1397 * $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)
1398 * $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)
1399 * $params['force'] = (boolean) True if the datafeed should be forcefully stopped.
1400 * $params['timeout'] = (time) Controls the time to wait until a datafeed has stopped. Default to 20 seconds
1401 * $params['body'] = (array) The URL params optionally sent in the body
1403 * @param array $params Associative array of parameters
1407 public function stopDatafeed(array $params = [])
1409 $datafeed_id = $this->extractArgument($params, 'datafeed_id');
1410 $body = $this->extractArgument($params, 'body');
1414 $endpoint->setParams($params);
1423 * $params['id'] = (string) The ID of the data frame analytics to update
1424 * $params['body'] = (array) The data frame analytics settings to update (Required)
1426 * @param array $params Associative array of parameters
1430 public function updateDataFrameAnalytics(array $params = [])
1432 $id = $this->extractArgument($params, 'id');
1433 $body = $this->extractArgument($params, 'body');
1437 $endpoint->setParams($params);
1446 * $params['datafeed_id'] = (string) The ID of the datafeed to update
1447 * $params['ignore_unavailable'] = (boolean) Ignore unavailable indexes (default: false)
1448 * $params['allow_no_indices'] = (boolean) Ignore if the source indices expressions resolves to no concrete indices (default: true)
1449 * $params['ignore_throttled'] = (boolean) Ignore indices that are marked as throttled (default: true)
1450 * $params['expand_wildcards'] = (enum) Whether source index expressions should get expanded to open or closed indices (default: open) (Options = open,closed,hidden,none,all)
1451 * $params['body'] = (array) The datafeed update settings (Required)
1453 * @param array $params Associative array of parameters
1457 public function updateDatafeed(array $params = [])
1459 $datafeed_id = $this->extractArgument($params, 'datafeed_id');
1460 $body = $this->extractArgument($params, 'body');
1464 $endpoint->setParams($params);
1473 * $params['filter_id'] = (string) The ID of the filter to update
1474 * $params['body'] = (array) The filter update (Required)
1476 * @param array $params Associative array of parameters
1480 public function updateFilter(array $params = [])
1482 $filter_id = $this->extractArgument($params, 'filter_id');
1483 $body = $this->extractArgument($params, 'body');
1487 $endpoint->setParams($params);
1496 * $params['job_id'] = (string) The ID of the job to create
1497 * $params['body'] = (array) The job update settings (Required)
1499 * @param array $params Associative array of parameters
1503 public function updateJob(array $params = [])
1505 $job_id = $this->extractArgument($params, 'job_id');
1506 $body = $this->extractArgument($params, 'body');
1510 $endpoint->setParams($params);
1519 * $params['job_id'] = (string) The ID of the job to fetch
1520 * $params['snapshot_id'] = (string) The ID of the snapshot to update
1521 * $params['body'] = (array) The model snapshot properties to update (Required)
1523 * @param array $params Associative array of parameters
1527 public function updateModelSnapshot(array $params = [])
1529 $job_id = $this->extractArgument($params, 'job_id');
1530 $snapshot_id = $this->extractArgument($params, 'snapshot_id');
1531 $body = $this->extractArgument($params, 'body');
1535 $endpoint->setParams($params);
1545 * $params['job_id'] = (string) The ID of the job
1546 * $params['snapshot_id'] = (string) The ID of the snapshot
1547 * $params['timeout'] = (time) How long should the API wait for the job to be opened and the old snapshot to be loaded.
1548 * $params['wait_for_completion'] = (boolean) Should the request wait until the task is complete before responding to the caller. Default is false.
1550 * @param array $params Associative array of parameters
1554 public function upgradeJobSnapshot(array $params = [])
1556 $job_id = $this->extractArgument($params, 'job_id');
1557 $snapshot_id = $this->extractArgument($params, 'snapshot_id');
1561 $endpoint->setParams($params);
1570 * $params['body'] = (array) The job config (Required)
1572 * @param array $params Associative array of parameters
1576 public function validate(array $params = [])
1578 $body = $this->extractArgument($params, 'body');
1582 $endpoint->setParams($params);
1590 * $params['body'] = (array) The detector (Required)
1592 * @param array $params Associative array of parameters
1596 public function validateDetector(array $params = [])
1598 $body = $this->extractArgument($params, 'body');
1602 $endpoint->setParams($params);