@nevermined-io/sdk - v3.0.44 / NvmAppMetadata
• new NvmAppMetadata(): NvmAppMetadata
▸ getCreditsSubscriptionMetadataTemplate(name, author, customData?): MetaData
It returns a metadata template for a credits limitted subscription
| Name | Type | Description |
|---|---|---|
name |
string |
the name of the subscription |
author |
string |
the author of the subscrpiton |
customData |
Object |
any key-value pair to be included in the metadata |
Metadata
▸ getFileMetadataTemplate(name, author, customData?): MetaData
It gets a metadata template for a file type of asset (datasets, moldels, algorithms, etc.)
| Name | Type | Description |
|---|---|---|
name |
string |
the name of the asset |
author |
string |
the autor of the asset |
customData |
Object |
key-value pairs to be included in the metadata |
Metadata
▸ getServiceMetadataTemplate(name, author, endpoints, openEndpoints, openApiEndpoint, serviceType?, authType, authToken?, authUser?, authPassword?, isPriceDynamic?, isNeverminedHosted?, queryProtocol?, serviceHost?, customData?, nonce?): MetaData
It returns a metadata template for Web Service
| Name | Type | Default value | Description |
|---|---|---|---|
name |
string |
undefined |
the name of the subscription |
author |
string |
undefined |
the author of the subscrpiton |
endpoints |
{ [verb: string]: string; }[] |
undefined |
the list of endpoints |
openEndpoints |
string[] |
undefined |
the list of open endpoints (not protected) |
openApiEndpoint |
undefined | string |
undefined |
the openApi endpoint endpoint if any |
serviceType |
string |
'RESTful' |
the type of the service |
authType |
"none" | "basic" | "bearer" | "oauth" |
undefined |
the type of authentication required by the service |
authToken? |
string |
undefined |
the token to be used for authentication (if authType is oauth or bearer) |
authUser? |
string |
undefined |
the username to be used for authentication (if authType is basic) |
authPassword? |
string |
undefined |
the password to be used for authentication (if authType is basic) |
isPriceDynamic |
boolean |
false |
if the price is dynamic |
isNeverminedHosted |
boolean |
false |
- |
queryProtocol |
undefined | string |
undefined |
- |
serviceHost |
undefined | string |
undefined |
- |
customData |
Object |
{} |
any key-value pair to be included in the metadata |
nonce |
string | number |
undefined |
the nonce to be included in the metadata |
Metadata
▸ getSubscriptionMetadataTemplate(name, author, customData?): MetaData
It returns a metadata template for subscription
| Name | Type | Description |
|---|---|---|
name |
string |
the name of the subscription |
author |
string |
the author of the subscrpiton |
customData |
Object |
any key-value pair to be included in the metadata |
Metadata
▸ getTimeSubscriptionMetadataTemplate(name, author, timeMeasure, customData?): MetaData
It returns a metadata template for a subscription with time limit
| Name | Type | Description |
|---|---|---|
name |
string |
the name of the subscription |
author |
string |
the author of the subscrpiton |
timeMeasure |
string |
the string defining the time measure |
customData |
Object |
any key-value pair to be included in the metadata |
Metadata
▸ validateSubscription(metadata, subscriptionType): MetadataValidationResults
| Name | Type |
|---|---|
metadata |
MetaData |
subscriptionType |
SubscriptionType |