GSCoverageStoreManager: Geoserver REST API CoverageStore Manager
In geosapi: GeoServer REST API R Interface
GSCoverageStoreManager R Documentation
Geoserver REST API CoverageStore Manager
Description
Geoserver REST API CoverageStore Manager
Geoserver REST API CoverageStore Manager
Format
R6Class object.
Value
Object of R6Class with methods for managing GeoServer
CoverageStores (i.e. stores of coverage data)
Super class
geosapi::GSManager -> GSCoverageStoreManager
Methods
Public methods
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Inherited methods
geosapi::GSManager$ERROR()geosapi::GSManager$INFO()geosapi::GSManager$WARN()geosapi::GSManager$connect()geosapi::GSManager$getClassName()geosapi::GSManager$getCoverageStoreManager()geosapi::GSManager$getDataStoreManager()geosapi::GSManager$getNamespaceManager()geosapi::GSManager$getServiceManager()geosapi::GSManager$getStyleManager()geosapi::GSManager$getSystemStatus()geosapi::GSManager$getUrl()geosapi::GSManager$getWorkspaceManager()geosapi::GSManager$initialize()geosapi::GSManager$logger()geosapi::GSManager$monitor()geosapi::GSManager$reload()
Method getCoverageStores()
Get the list of available coverage stores. Returns an object of class list
giving items of class GSAbstractCoverageStore
Usage
GSCoverageStoreManager$getCoverageStores(ws)
Arguments
wsworkspace name
Returns
the list of coverage stores
Method getCoverageStoreNames()
Get the list of available coverage store names. Returns an vector of class character
Usage
GSCoverageStoreManager$getCoverageStoreNames(ws)
Arguments
wsworkspace name
Returns
the list of coverage store names, as character
Method getCoverageStore()
Get an object of class GSAbstractDataStore given a workspace and coverage store names.
Usage
GSCoverageStoreManager$getCoverageStore(ws, cs)
Arguments
wsworkspace name
cscoverage store name
Returns
the coverage store
Method createCoverageStore()
Creates a new coverage store given a workspace, coverage store name. Abstract method used in below format-specific
methods to create coverage stores.
Usage
GSCoverageStoreManager$createCoverageStore(ws, coverageStore)
Arguments
wsworkspace name
coverageStorecoverage store object
Returns
TRUE if created, FALSE otherwise
Method updateCoverageStore()
Updates a coverage store given a workspace, coverage store name. Abstract method used in below format-specific
methods to create coverage stores.
Usage
GSCoverageStoreManager$updateCoverageStore(ws, coverageStore)
Arguments
wsworkspace name
coverageStorecoverage store object
Returns
TRUE if updated, FALSE otherwise
Method deleteCoverageStore()
Deletes a coverage store given a workspace and an object of class GSAbstractCoverageStore.
By defaut, the option recurse is set to FALSE, ie datastore layers are not removed.
To remove all coverage store layers, set this option to TRUE. The purge parameter is used
to customize the delete of files on disk (in case the underlying reader implements a delete method).
It can take one of the three values: none, metadata, all. For more details see https://docs.geoserver.org/stable/en/user/rest/api/coveragestores.html#purge
Usage
GSCoverageStoreManager$deleteCoverageStore(
ws,
cs,
recurse = FALSE,
purge = NULL
)
Arguments
wsworkspace name
cscoverage store name
recurserecurse
purgepurge
Returns
TRUE if deleted, FALSE otherwise
Method getCoverages()
Get the list of available coverages for given workspace and coverage store.
Returns an object of class list giving items of class GSCoverage
Usage
GSCoverageStoreManager$getCoverages(ws, cs)
Arguments
wsworkspace name
cscoverage store name
Returns
the list of GSCoverage
Method getCoverageNames()
Get the list of available coverage names for given workspace and coverage store.
Returns an object of class list giving items of class GSCoverage
Usage
GSCoverageStoreManager$getCoverageNames(ws, cs)
Arguments
wsworkspace name
cscoverage store name
Returns
the list of coverage names
Method getCoverage()
Get coverage
Usage
GSCoverageStoreManager$getCoverage(ws, cs, cv)
Arguments
wsworkspace name
cscoverage store name
cvcoverage name
Method createCoverage()
Creates a new coverage given a workspace, coverage store names and an object of class GSCoverage
Usage
GSCoverageStoreManager$createCoverage(ws, cs, coverage)
Arguments
wsworkspace name
cscoverage store name
coverageobject of class GSCoverage
Returns
TRUE if created, FALSE otherwise
Method updateCoverage()
Updates a coverage given a workspace, coverage store names and an object of class GSCoverage
Usage
GSCoverageStoreManager$updateCoverage(ws, cs, coverage)
Arguments
wsworkspace name
cscoverage store name
coverageobject of class GSCoverage
Returns
TRUE if updated, FALSE otherwise
Method deleteCoverage()
Deletes a coverage given a workspace, coverage store names, and an object of
class GSCoverage. By defaut, the option recurse is
set to FALSE, ie coverage layers are not removed.
Usage
GSCoverageStoreManager$deleteCoverage(ws, cs, cv, recurse = FALSE)
Arguments
wsworkspace name
cscoverage store name
cvcoverage name
recurserecurse
Method uploadCoverage()
Abstract method to upload a coverage file targeting a workspace (ws) and datastore (cs). The extension
corresponds to the format/type of coverage to be uploaded (among values 'geotiff', 'worldimage', 'arcgrid', or 'imagemosaic').
The endpoint takes a value among "file" (default), "url" or "external". The filename is the name
of the coverage file to upload and set for the newly created datastore. The configure parameter can take a value among values
"none" (indicates to configure only the datastore but no layer configuration) or "first" (configure
both datastore and layer). The update defines the strategy for the upload: "append" (default value) for
the first upload, "overwrite" in case the file should be overwriten.
Usage
GSCoverageStoreManager$uploadCoverage(
ws,
cs,
endpoint = "file",
extension,
filename,
configure = "first",
update = "append",
contentType
)
Arguments
wsworkspace name
cscoverage store name
endpointendpoint. Default is "file"
extensionextension
filenamefilename
configureconfigure. Default is "first"
updateupdate. Default is "append"
contentTypecontent type
Returns
TRUE if uploaded, FALSE otherwise
Method uploadGeoTIFF()
Uploads a GeoTIFF file targeting a workspace (ws) and datastore (cs). The endpoint takes a value among
"file" (default), "url" or "external". The filename is the name of the GeoTIFF file to
upload and set for the newly created datastore. The configure parameter can take a value among values
"none" (indicates to configure only the datastore but no layer configuration) or "first" (configure
both datastore and layer). The update defines the strategy for the upload: "append" (default value) for
the first upload, "overwrite" in case the file should be overwriten.
Usage
GSCoverageStoreManager$uploadGeoTIFF(
ws,
cs,
endpoint = "file",
filename,
configure = "first",
update = "append"
)
Arguments
wsworkspace name
cscoverage store name
endpointendpoint. Default is "file"
filenamefilename
configureconfigure. Default is "first"
updateupdate. Default is "append"
Returns
TRUE if uploaded, FALSE otherwise
Method uploadWorldImage()
Uploads a WorldImage file targeting a workspace (ws) and datastore (cs). The endpoint takes a value among
"file" (default), "url" or "external". The filename is the name of the zipped file to
upload and set for the newly created datastore. It is assumed the zip archive contains the .prj file to set the SRS.
The configure parameter can take a value among values "none" (indicates to configure only the datastore
but no layer configuration) or "first" (configure both datastore and layer). The update defines the strategy
for the upload: "append" (default value) for the first upload, "overwrite" in case the file should be overwriten.
Usage
GSCoverageStoreManager$uploadWorldImage(
ws,
cs,
endpoint = "file",
filename,
configure = "first",
update = "append"
)
Arguments
wsworkspace name
cscoverage store name
endpointendpoint. Default is "file"
filenamefilename
configureconfigure. Default is "first"
updateupdate. Default is "append"
Returns
TRUE if uploaded, FALSE otherwise
Method uploadArcGrid()
Uploads an ArcGrid file targeting a workspace (ws) and datastore (cs). The endpoint takes a value among
"file" (default), "url" or "external". The filename is the name of the ArcGrid file to
upload and set for the newly created datastore. The configure parameter can take a value among values
"none" (indicates to configure only the datastore but no layer configuration) or "first" (configure
both datastore and layer). The update defines the strategy for the upload: "append" (default value) for
the first upload, "overwrite" in case the file should be overwriten.
Usage
GSCoverageStoreManager$uploadArcGrid(
ws,
cs,
endpoint = "file",
filename,
configure = "first",
update = "append"
)
Arguments
wsworkspace name
cscoverage store name
endpointendpoint. Default is "file"
filenamefilename
configureconfigure. Default is "first"
updateupdate. Default is "append"
Returns
TRUE if uploaded, FALSE otherwise
Method uploadImageMosaic()
Uploads an ImageMosaic file targeting a workspace (ws) and datastore (cs). The endpoint takes a value among
"file" (default), "url" or "external". The filename is the name of the ImageMosaic file to
upload and set for the newly created datastore. The configure parameter can take a value among values
"none" (indicates to configure only the datastore but no layer configuration) or "first" (configure
both datastore and layer). The update defines the strategy for the upload: "append" (default value) for
the first upload, "overwrite" in case the file should be overwriten.
Usage
GSCoverageStoreManager$uploadImageMosaic(
ws,
cs,
endpoint = "file",
filename,
configure = "first",
update = "append"
)
Arguments
wsworkspace name
cscoverage store name
endpointendpoint. Default is "file"
filenamefilename
configureconfigure. Default is "first"
updateupdate. Default is "append"
Returns
TRUE if uploaded, FALSE otherwise
Method clone()
The objects of this class are cloneable with this method.
Usage
GSCoverageStoreManager$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
Author(s)
Emmanuel Blondel <emmanuel.blondel1@gmail.com>
Examples
## Not run:
GSCoverageStoreManager$new("http://localhost:8080/geoserver", "admin", "geoserver")
## End(Not run)
geosapi documentation built on May 29, 2024, 12:29 p.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| GSCoverageStoreManager | R Documentation |
Geoserver REST API CoverageStore Manager
Description
Geoserver REST API CoverageStore Manager
Geoserver REST API CoverageStore Manager
Format
R6Class object.
Value
Object of R6Class with methods for managing GeoServer
CoverageStores (i.e. stores of coverage data)
Super class
geosapi::GSManager -> GSCoverageStoreManager
Methods
Public methods
Inherited methods
geosapi::GSManager$ERROR()geosapi::GSManager$INFO()geosapi::GSManager$WARN()geosapi::GSManager$connect()geosapi::GSManager$getClassName()geosapi::GSManager$getCoverageStoreManager()geosapi::GSManager$getDataStoreManager()geosapi::GSManager$getNamespaceManager()geosapi::GSManager$getServiceManager()geosapi::GSManager$getStyleManager()geosapi::GSManager$getSystemStatus()geosapi::GSManager$getUrl()geosapi::GSManager$getWorkspaceManager()geosapi::GSManager$initialize()geosapi::GSManager$logger()geosapi::GSManager$monitor()geosapi::GSManager$reload()
Method getCoverageStores()
Get the list of available coverage stores. Returns an object of class list
giving items of class GSAbstractCoverageStore
Usage
GSCoverageStoreManager$getCoverageStores(ws)
Arguments
wsworkspace name
Returns
the list of coverage stores
Method getCoverageStoreNames()
Get the list of available coverage store names. Returns an vector of class character
Usage
GSCoverageStoreManager$getCoverageStoreNames(ws)
Arguments
wsworkspace name
Returns
the list of coverage store names, as character
Method getCoverageStore()
Get an object of class GSAbstractDataStore given a workspace and coverage store names.
Usage
GSCoverageStoreManager$getCoverageStore(ws, cs)
Arguments
wsworkspace name
cscoverage store name
Returns
the coverage store
Method createCoverageStore()
Creates a new coverage store given a workspace, coverage store name. Abstract method used in below format-specific methods to create coverage stores.
Usage
GSCoverageStoreManager$createCoverageStore(ws, coverageStore)
Arguments
wsworkspace name
coverageStorecoverage store object
Returns
TRUE if created, FALSE otherwise
Method updateCoverageStore()
Updates a coverage store given a workspace, coverage store name. Abstract method used in below format-specific methods to create coverage stores.
Usage
GSCoverageStoreManager$updateCoverageStore(ws, coverageStore)
Arguments
wsworkspace name
coverageStorecoverage store object
Returns
TRUE if updated, FALSE otherwise
Method deleteCoverageStore()
Deletes a coverage store given a workspace and an object of class GSAbstractCoverageStore.
By defaut, the option recurse is set to FALSE, ie datastore layers are not removed.
To remove all coverage store layers, set this option to TRUE. The purge parameter is used
to customize the delete of files on disk (in case the underlying reader implements a delete method).
It can take one of the three values: none, metadata, all. For more details see https://docs.geoserver.org/stable/en/user/rest/api/coveragestores.html#purge
Usage
GSCoverageStoreManager$deleteCoverageStore( ws, cs, recurse = FALSE, purge = NULL )
Arguments
wsworkspace name
cscoverage store name
recurserecurse
purgepurge
Returns
TRUE if deleted, FALSE otherwise
Method getCoverages()
Get the list of available coverages for given workspace and coverage store.
Returns an object of class list giving items of class GSCoverage
Usage
GSCoverageStoreManager$getCoverages(ws, cs)
Arguments
wsworkspace name
cscoverage store name
Returns
the list of GSCoverage
Method getCoverageNames()
Get the list of available coverage names for given workspace and coverage store.
Returns an object of class list giving items of class GSCoverage
Usage
GSCoverageStoreManager$getCoverageNames(ws, cs)
Arguments
wsworkspace name
cscoverage store name
Returns
the list of coverage names
Method getCoverage()
Get coverage
Usage
GSCoverageStoreManager$getCoverage(ws, cs, cv)
Arguments
wsworkspace name
cscoverage store name
cvcoverage name
Method createCoverage()
Creates a new coverage given a workspace, coverage store names and an object of class GSCoverage
Usage
GSCoverageStoreManager$createCoverage(ws, cs, coverage)
Arguments
wsworkspace name
cscoverage store name
coverageobject of class GSCoverage
Returns
TRUE if created, FALSE otherwise
Method updateCoverage()
Updates a coverage given a workspace, coverage store names and an object of class GSCoverage
Usage
GSCoverageStoreManager$updateCoverage(ws, cs, coverage)
Arguments
wsworkspace name
cscoverage store name
coverageobject of class GSCoverage
Returns
TRUE if updated, FALSE otherwise
Method deleteCoverage()
Deletes a coverage given a workspace, coverage store names, and an object of
class GSCoverage. By defaut, the option recurse is
set to FALSE, ie coverage layers are not removed.
Usage
GSCoverageStoreManager$deleteCoverage(ws, cs, cv, recurse = FALSE)
Arguments
wsworkspace name
cscoverage store name
cvcoverage name
recurserecurse
Method uploadCoverage()
Abstract method to upload a coverage file targeting a workspace (ws) and datastore (cs). The extension
corresponds to the format/type of coverage to be uploaded (among values 'geotiff', 'worldimage', 'arcgrid', or 'imagemosaic').
The endpoint takes a value among "file" (default), "url" or "external". The filename is the name
of the coverage file to upload and set for the newly created datastore. The configure parameter can take a value among values
"none" (indicates to configure only the datastore but no layer configuration) or "first" (configure
both datastore and layer). The update defines the strategy for the upload: "append" (default value) for
the first upload, "overwrite" in case the file should be overwriten.
Usage
GSCoverageStoreManager$uploadCoverage( ws, cs, endpoint = "file", extension, filename, configure = "first", update = "append", contentType )
Arguments
wsworkspace name
cscoverage store name
endpointendpoint. Default is "file"
extensionextension
filenamefilename
configureconfigure. Default is "first"
updateupdate. Default is "append"
contentTypecontent type
Returns
TRUE if uploaded, FALSE otherwise
Method uploadGeoTIFF()
Uploads a GeoTIFF file targeting a workspace (ws) and datastore (cs). The endpoint takes a value among
"file" (default), "url" or "external". The filename is the name of the GeoTIFF file to
upload and set for the newly created datastore. The configure parameter can take a value among values
"none" (indicates to configure only the datastore but no layer configuration) or "first" (configure
both datastore and layer). The update defines the strategy for the upload: "append" (default value) for
the first upload, "overwrite" in case the file should be overwriten.
Usage
GSCoverageStoreManager$uploadGeoTIFF( ws, cs, endpoint = "file", filename, configure = "first", update = "append" )
Arguments
wsworkspace name
cscoverage store name
endpointendpoint. Default is "file"
filenamefilename
configureconfigure. Default is "first"
updateupdate. Default is "append"
Returns
TRUE if uploaded, FALSE otherwise
Method uploadWorldImage()
Uploads a WorldImage file targeting a workspace (ws) and datastore (cs). The endpoint takes a value among
"file" (default), "url" or "external". The filename is the name of the zipped file to
upload and set for the newly created datastore. It is assumed the zip archive contains the .prj file to set the SRS.
The configure parameter can take a value among values "none" (indicates to configure only the datastore
but no layer configuration) or "first" (configure both datastore and layer). The update defines the strategy
for the upload: "append" (default value) for the first upload, "overwrite" in case the file should be overwriten.
Usage
GSCoverageStoreManager$uploadWorldImage( ws, cs, endpoint = "file", filename, configure = "first", update = "append" )
Arguments
wsworkspace name
cscoverage store name
endpointendpoint. Default is "file"
filenamefilename
configureconfigure. Default is "first"
updateupdate. Default is "append"
Returns
TRUE if uploaded, FALSE otherwise
Method uploadArcGrid()
Uploads an ArcGrid file targeting a workspace (ws) and datastore (cs). The endpoint takes a value among
"file" (default), "url" or "external". The filename is the name of the ArcGrid file to
upload and set for the newly created datastore. The configure parameter can take a value among values
"none" (indicates to configure only the datastore but no layer configuration) or "first" (configure
both datastore and layer). The update defines the strategy for the upload: "append" (default value) for
the first upload, "overwrite" in case the file should be overwriten.
Usage
GSCoverageStoreManager$uploadArcGrid( ws, cs, endpoint = "file", filename, configure = "first", update = "append" )
Arguments
wsworkspace name
cscoverage store name
endpointendpoint. Default is "file"
filenamefilename
configureconfigure. Default is "first"
updateupdate. Default is "append"
Returns
TRUE if uploaded, FALSE otherwise
Method uploadImageMosaic()
Uploads an ImageMosaic file targeting a workspace (ws) and datastore (cs). The endpoint takes a value among
"file" (default), "url" or "external". The filename is the name of the ImageMosaic file to
upload and set for the newly created datastore. The configure parameter can take a value among values
"none" (indicates to configure only the datastore but no layer configuration) or "first" (configure
both datastore and layer). The update defines the strategy for the upload: "append" (default value) for
the first upload, "overwrite" in case the file should be overwriten.
Usage
GSCoverageStoreManager$uploadImageMosaic( ws, cs, endpoint = "file", filename, configure = "first", update = "append" )
Arguments
wsworkspace name
cscoverage store name
endpointendpoint. Default is "file"
filenamefilename
configureconfigure. Default is "first"
updateupdate. Default is "append"
Returns
TRUE if uploaded, FALSE otherwise
Method clone()
The objects of this class are cloneable with this method.
Usage
GSCoverageStoreManager$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
Author(s)
Emmanuel Blondel <emmanuel.blondel1@gmail.com>
Examples
## Not run:
GSCoverageStoreManager$new("http://localhost:8080/geoserver", "admin", "geoserver")
## End(Not run)
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.