The JSON objects returned by calls to
org.lappsgrid.api.ProcessingService#getMetadata.
Typically Lapp services will either generate this metadata at compile time or at
runtime when the service is first launched. The metadata can then be cached
until getMetadata() is called.
| Modifiers | Name | Description |
|---|---|---|
static String |
DEFAULT_SCHEMA_URL |
| Type | Name and description |
|---|---|
String |
allowPermitted uses of this service. |
String |
descriptionA plain text description of the service or the URL to an online description. |
String |
licenseURL to the license for this service. |
String |
licenseDescA human readable description of the license terms. |
String |
nameA human readable name for the service. |
List |
parametersDescriptions of the parameters required by the service. |
IOSpecification |
producesOutput format specification. |
IOSpecification |
requiresThe input requirements of the service. |
String |
schemaThe JSON schema that describes the JSON format. |
String |
toolVersionThe version number of the tool being wrapped. |
String |
urlThe full URL used to invoke the service. |
String |
vendorName or URI of the organization providing the service. |
String |
versionThe service version number in [major]. |
| Constructor and description |
|---|
ServiceMetadata
() |
ServiceMetadata
(Object object) |
ServiceMetadata
(String json) |
ServiceMetadata
(Map map) |
Permitted uses of this service.
This field is actually a URI that describes the allowable usages, e.g. commerial, research, etc. If this field is omitted then it is assumed that the service can be used for any purpose.
A plain text description of the service or the URL to an online description.
URL to the license for this service.
A human readable description of the license terms. May also include markdown.
A human readable name for the service.
Descriptions of the parameters required by the service.
Output format specification. The output specification consists of:
The input requirements of the service. The input specification consists of:
The JSON schema that describes the JSON format.
The version number of the tool being wrapped. Not all LAPPS Grid tools wrap other software packages so this field is optional.
The full URL used to invoke the service. TODO Should this be deprecated since services do not know the URL they have been deployed to.
Name or URI of the organization providing the service.
The service version number in [major].[minor].[revision] format with an optional trailing qualifier. E.G. 1.1.0-SNAPSHOT
org.lappsgrid:metadata:1.4.0