| layout | title |
|---|---|
default |
Metrics |
https://github.com/StreamlineData/catalog/blob/master/catalog-rest-service/src/main/resources/json/schema/entity/data/metrics.json
Entity that represents a Metrics
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | metrics.json |
object (Metrics entity)
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| id | string |
Required | cannot be null | Metrics entity |
| name | string |
Required | cannot be null | Metrics entity |
| fullyQualifiedName | string |
Optional | cannot be null | Metrics entity |
| description | string |
Optional | cannot be null | Metrics entity |
| href | string |
Optional | cannot be null | Metrics entity |
| owner | object |
Optional | cannot be null | Metrics entity |
| service | object |
Required | cannot be null | Metrics entity |
| usageSummary | object |
Optional | cannot be null | Metrics entity |
Unique id used to identify an entity
id
- is required
- Type:
string - cannot be null
- defined in: Metrics entity
string
UUID: the string must be a UUID, according to RFC 4122
Name that identifies the this metrics instance uniquely.
name
- is required
- Type:
string - cannot be null
- defined in: Metrics entity
string
maximum length: the maximum number of characters for this string is: 64
minimum length: the minimum number of characters for this string is: 1
Unique name that identifies a metric in the format 'ServiceName.MetricName'
fullyQualifiedName
- is optional
- Type:
string - cannot be null
- defined in: Metrics entity
string
maximum length: the maximum number of characters for this string is: 64
minimum length: the minimum number of characters for this string is: 1
Description of metrics instance. What is has and how to use it
description
- is optional
- Type:
string - cannot be null
- defined in: Metrics entity
string
Link to the resource corresponding to this entity
Link to the resource
href
- is optional
- Type:
string - cannot be null
- defined in: Metrics entity
string
URI: the string must be a URI, according to RFC 3986
Owner of this metrics
Entity reference that includes entity ID and entity type
owner
- is optional
- Type:
object(Details) - cannot be null
- defined in: Metrics entity
object (Details)
Link to service where this metrics is hosted in
Entity reference that includes entity ID and entity type
service
- is required
- Type:
object(Details) - cannot be null
- defined in: Metrics entity
object (Details)
Latest usage information for this database
Type used to return usage details
usageSummary
- is optional
- Type:
object(Details) - cannot be null
- defined in: Metrics entity
object (Details)