Task subtypes
The “task” job type has the following subtypes:- Log Cleanup
Log cleanup jobs are run against your system logs collection to delete log messages that were created prior to the number of days specified in theDelete logs older than "n" daysfield.
Parameters
- ID. The unique ID for this job in the API. This is the
idfield in the configuration file. Required field. - Logs Collection. The collection that contains the documents that are deleted when the job is run. The allowed value is system_logs. This is the
collectionfield in the configuration file. Required field. - Delete logs older than “n” days. The number of days to retain system log messages. When this job is run, it deletes all system log messages older than the number of days entered in this field. This is the
daysfield in the configuration file. Optional field. - Query to match docs to delete. The query syntax to identify the documents to be deleted. The default value of
-logger_class_s:"com.lucidworks.cloud.gateway.audit"excludes audit log entries to preserve audit information such as login and logout events. This is thequeryfield in the configuration file. Optional field. - REST Call
A versatile job type that runs an arbitrary REST/HTTP/Solr command.
- any HTTP or HTTPS request:
<http-protocol>://<path>; requires JWT header. - a Solr request:
solr://COLLECTION_NAME/…; authentication is handled. - a Fusion service request:
extservice://SERVICE_NAME/<path>; authentication is handled.
- ID. The user-defined name for this job. This is the
idfield in the configuration file. Required field. - Endpoint URI. The name or location of the data this job searches. This is the
urifield in the configuration file. Required field. - Call method. The operation submitted in the request. Values are GET, POST, PUT, or DELETE. This is the
methodfield in the configuration file. Required field. - Query parameters. This section lets you enter
property name:property valueoptions submitted in the query. This is thequeryParamsfield in the configuration file. Optional field. - Request protocol headers. This section lets you enter
property name:property valueprotocol headers submitted in the query. This is theheadersfield in the configuration file. Optional field. - Request entity. The request string to submit for the query. This is the
entityfield in the configuration file. Optional field.