Man pages for onc.api
Oceans 2.0 API Client Library
| DataProductFile-class | DataProductFile class |
| dot-appendList | Helper that appends a list item to a list of lists |
| dot-countFilesInProduct | Given a runId, polls the "download" method to count the... |
| dot-discoveryRequest | Discovery Request encapsulates a request to a discovery... |
| dot-doRequest | Generic request wrapper for making simple web service... |
| dot-downloadDataProduct | Public wrapper that lets a user download data products... |
| dot-downloadProductFiles | Download all data product files for provided run id |
| dot-estimatePollPeriod | Sets a poll period adequate to the estimated processing time... |
| dot-filterByExtension | Filter file list results to only those where the filename... |
| dot-filters2url | Returns a string URL for a base url and a named list of... |
| dot-formatDuration | Returns a formatted time duration string representation of a... |
| dot-formatResult | Aggregates individual download results obtained in... |
| dot-formatSize | Returns a formatted file size string representation |
| dot-formatUtc | Format date as ISO8601 UTC |
| dot-getDataProducts | Request a list of data products that matches the filters... |
| dot-getDeployments | Request a list of deployments that matches the filters... |
| dot-getDeviceCategories | Request a list of device categories that matches the filters... |
| dot-getDevices | Request a list of devices that matches the filters provided |
| dot-getDirectAllPages | Generic method to download and concatenate all pages of data... |
| dot-getDirectByDevice | Obtains scalar data from a device, as described by the... |
| dot-getDirectByLocation | Obtains scalar data from a location, from the source... |
| dot-getDirectFiles | Downloads all archive files that match the filters Internally... |
| dot-getDirectRawByDevice | Obtains raw data from a device, as described by the filters |
| dot-getDirectRawByLocation | Obtains raw data from a location, from the source described... |
| dot-getDownloadUrl | Given a filename, returns an archivefile absolute download... |
| dot-getFile | Download the archive file with filename |
| dot-getList | A generic wrapper for getListByLocation() and... |
| dot-getListByDevice | Get a list of files available in Oceans 2.0 Archiving System... |
| dot-getListByLocation | Get a list of files for a given location code and device... |
| dot-getLocationHierarchy | Request a hierarchical tree list of locations that matches... |
| dot-getLocations | Request a list of locations that matches the filters provided |
| dot-getProperties | Request a list of properties that matches the filters... |
| dot-infoForProductFiles | Returns a list of information lists for each file available... |
| dot-lastItem | R helper: Returns the last element of a list |
| dot-log | Prints message to console only when showInfo is true |
| dot-orderDataProduct | Request, run and download a data product as described by the... |
| dot-prepareDirectory | Creates directory if it does not exist Supports directory... |
| dot-prettyPrint | Pretty prints a complex hierarchy of lists |
| dot-print | Helper for printing a JSON named list to the console Can... |
| dot-printErrorMessage | Print Error Response Message |
| dot-printProductOrderStats | Prints a formatted representation of the total time and size... |
| dot-printProductRequest | Prints the response after a data product request The request... |
| dot-requestDataProduct | Request a data product generation described by the filters |
| dot-respFailed | Response has failed |
| dot-runDataProduct | Run a data product generation request |
| dot-sanitizeBooleans | For all rows in data, enforce that fields expected to have... |
| dot-saveAsFile | Saves the file downloaded in the response object, in the... |
| dot-serviceUrl | Returns the absolute url for a given ONC API service |
| MultiPage-class | MultiPage |
| Onc-class | Onc Class |
