folders_import
Creates, updates, deletes, gets or lists a folders_import resource.
Overview
| Name | folders_import |
| Type | Resource |
| Id | sumologic.content.folders_import |
Fields
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
beginAsyncImport | exec | folderId, region, name, type | isAdminMode, overwrite | Schedule an asynchronous import of content inside an existing folder with the given identifier. Import requests can be used to create or update content within a folder. Content items need to have a unique name within their folder. If there is already a content item with the same name in the folder, you can set the overwrite parameter to true to overwrite existing content items. By default, the overwrite parameter is set to false, where the import will fail if a content item with the same name already exist. Keep in mind when importing large folders that there is a limit of 1000 content objects that can be imported at once. If you want to import more than 1000 content objects, then be sure to split the import into batches of 1000 objects or less. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
folderId | string | The identifier of the folder to import into. Identifiers from the Library in the Sumo user interface are provided in decimal format which is incompatible with this API. The identifier needs to be in hexadecimal format. |
region | string | SumoLogic region (enum: [us2, au, ca, de, eu, fed, in, jp], default: us2) |
isAdminMode | string | Set this to "true" if you want to perform the request as a Content Administrator. |
overwrite | boolean | Set this to "true" to overwrite a content item if the name already exists. |
Lifecycle Methods
- beginAsyncImport
Schedule an asynchronous import of content inside an existing folder with the given identifier. Import requests can be used to create or update content within a folder. Content items need to have a unique name within their folder. If there is already a content item with the same name in the folder, you can set the overwrite parameter to true to overwrite existing content items. By default, the overwrite parameter is set to false, where the import will fail if a content item with the same name already exist. Keep in mind when importing large folders that there is a limit of 1000 content objects that can be imported at once. If you want to import more than 1000 content objects, then be sure to split the import into batches of 1000 objects or less.
EXEC sumologic.content.folders_import.beginAsyncImport
@folderId='{{ folderId }}' --required,
@region='{{ region }}' --required,
@isAdminMode='{{ isAdminMode }}',
@overwrite={{ overwrite }}
@@json=
'{
"type": "{{ type }}",
"name": "{{ name }}"
}'
;