DataTypeInformation
DataTypeInformation
Information describing a single data type from the perspective of a data consumer, including the schema associated with the type, the number of producers for that type, and whether the type is enabled or disabled.
JSON Example
{
"no_of_producers": 1,
"type_status": "ENABLED",
"job_data_schema": {
"required": [
"start",
"end",
"technology"
],
"type": "object",
"description": "The filtering parameters that shape a pmhistory query. `start`,\n`end`, `technology` and `counter_names` are required. If one or\nmore `cell_ids` or `vector_indexes` are provided, the results\nare filtered by those ids and indexes. If a chosen counter\nis a vector and no `vector_indexes` value is provided, then the\ncaller is responsible for processing the vectors appropriately.\nIf any `vector_indexes` are present then `counter_names` must\nhave only one item. **Note**: This format is expected to change\nas R1 standards mature.\n",
"properties": {
"start": {
"type": "integer",
"description": "Milliseconds since the UNIX epoch defining the start of the time range to query.\n",
"examples": [
1632781620000
]
},
"end": {
"type": "integer",
"description": "Milliseconds since the UNIX epoch defining the end of the time range to query.\n",
"examples": [
1632929865000
]
},
"technology": {
"type": "string",
"description": "The wireless networking technology, `nr` or `lte`, of the counters being retrieved.\n",
"enum": [
"nr",
"lte"
]
},
"cell_ids": {
"type": "array",
"description": "A list of Cell Global Identifiers. The results are filtered\nto include only data for the listed cells. If this\nfield is not present, then the results contain counter\ndata for all cells for all provided counter names.\n",
"items": {
"type": "string",
"description": "One cell global identifier as a string."
},
"examples": [
[
"14342903"
]
],
"minItems": 1
},
"counter_names": {
"type": "array",
"description": "One or more counter names on which to filter the results.\n",
"items": {
"type": "string",
"description": "One counter name."
},
"minItems": 1,
"examples": [
[
"PMUECTXTSETUPATT"
]
]
},
"vector_indexes": {
"type": "array",
"description": "One or more vector indexes on which to filter the results. If this is set then `counter_names` must have a length of 1 and it is that counter's vectors that will be filtered.\n",
"items": {
"type": "integer",
"description": "One vector index.",
"minimum": 0,
"maximum": 255,
"examples": [
5
]
},
"examples": [
[
5
]
],
"minItems": 1
},
"type_information": {
"type": "object",
"description": "Additional information about the type"
}
}
}
}integer
no_of_producers
Required
The number of registered producers for this type.
string
type_status
Required
Allowed values:
- ENABLED: one or more producers for the data type are operational.
- DISABLED: no producers for the datatype are operational.
Possible values are : ENABLED, DISABLED,
object
job_data_schema
Required
JSON schema for the job data