new module:ImageMosaicClient(url, auth)
Creates a GeoServer REST ImageMosaicClient instance.
Parameters:
| Name | Type | Description |
|---|---|---|
url |
String | The URL of the GeoServer REST API endpoint |
auth |
String | The Basic Authentication string |
- Source:
Methods
(async) addGranuleByServerFile(workspace, coverageStore, filePath)
Adds a granule (defined by a server file) to an image mosaic.
Parameters:
| Name | Type | Description |
|---|---|---|
workspace |
String | Workspace of image mosaic |
coverageStore |
String | CoverageStore of image mosaic |
filePath |
String | Server file path of new granule |
- Source:
Throws:
Error if request fails
(async) deleteSingleGranule(workspace, coverageStore, coverage, covFileLocation)
Deletes a single granule of an image mosaic.
Parameters:
| Name | Type | Description |
|---|---|---|
workspace |
String | Workspace of image mosaic |
coverageStore |
String | CoverageStore of image mosaic |
coverage |
String | Name of image mosaic |
covFileLocation |
String | Location of coverage file |
- Source:
Throws:
Error if request fails
(async) getGranules(workspace, coverageStore, coverage) → {Object}
Returns all granules of an image mosaic.
Parameters:
| Name | Type | Description |
|---|---|---|
workspace |
String | Workspace of image mosaic |
coverageStore |
String | CoverageStore of image mosaic |
coverage |
String | Name of image mosaic |
- Source:
Throws:
Error if request fails
Returns:
An object with the granules
- Type
- Object
(async) harvestGranules(workspace, coverageStore, filePath) → {Object}
Harvests all granules in the given folder for an image mosaic.
Parameters:
| Name | Type | Description |
|---|---|---|
workspace |
String | Workspace of image mosaic |
coverageStore |
String | CoverageStore of image mosaic |
filePath |
String | Server path of folder to harvest |
- Source:
Throws:
Error if request fails
Returns:
An object with the granules
- Type
- Object