[{"label":"Latest (v1)","version":"latest"}]
vmware-aria-operations-for-logs

QueryDefinitionState

Query definition state associated with this widget


Properties

aggregationFunctions Optional

List of aggregation functions associated with the query


boolean
annotation Optional

constraints Optional

Constraints for the query associated with this dataset


string
contentPackId Optional

ID of the content pack that provided this query definition


string
description Optional

Detailed description of the query


string
documentAuthPrincipalLink Optional

System internal field


documentDescription Optional

System internal field


integer as int64
documentEpoch Optional

System internal field


integer as int64
documentExpirationTimeMicros Optional

System internal field


string
documentKind Optional

System internal field


string
documentOwner Optional

System internal field


string
documentSelfLink Optional

string
documentSourceLink Optional

System internal field


string
documentTransactionId Optional

System internal field


string
documentUpdateAction Optional

System internal field


integer as int64
documentUpdateTimeMicros Optional

System internal field


integer as int64
documentVersion Optional

System internal field


array of GroupByTerm
groupByTerms Optional

List of ‘group by’ terms associated with the query


boolean
isAnnotation Optional

Indicates whether the query should be used to annotate log messages


boolean
isSearchable Optional

Indicates whether the query should be displayed in search results


string
name Optional

Short name to describe the query


array of RelationFunction
relationFunctions Optional

List of relation functions associated with the query


boolean
searchable Optional

string
source Optional

Source of the query document creation

Possible values are: USER_DEFINED


string
sourceName Optional

Name of the content pack that provided this query definition


array of string
tenantLinks Optional

Set of tenant links associated with the query. This is an internal field


string
url Optional

A URL that links to additional information and other recommended approaches for fixing the issue)


widget Optional

Widget configuration that is used to capture the configuration of the chart

JSON Example

{
	"aggregationFunctions": [
		{
			"fieldName": "string",
			"functionName": "COUNT"
		}
	],
	"annotation": false,
	"constraints": {
		"constraints": "QueryConstraint Object",
		"fieldName": "string",
		"operator": "AND",
		"tags": [
			"string"
		],
		"value": "string"
	},
	"contentPackId": "string",
	"description": "string",
	"documentAuthPrincipalLink": "string",
	"documentDescription": {
		"description": "string",
		"documentIndexingOptions": [
			"INDEX_METADATA"
		],
		"name": "string",
		"propertyDescriptions": {
			"key": {
				"elementDescription": "PropertyDescription Object",
				"enumValues": [
					"string"
				],
				"exampleValue": {},
				"indexingOptions": [
					"EXPAND"
				],
				"kind": "string",
				"propertyDocumentation": "string",
				"typeName": "LONG",
				"usageOptions": [
					"SINGLE_ASSIGNMENT"
				]
			}
		},
		"serializedStateSizeLimit": 0,
		"serviceCapabilities": [
			"INSTRUMENTATION"
		],
		"serviceRequestRoutes": {
			"key": {
				"action": "GET",
				"description": "string",
				"handler": {},
				"matcher": {},
				"parameters": [
					{
						"description": "string",
						"name": "string",
						"paramDef": "QUERY",
						"required": false,
						"type": "string",
						"value": "string"
					}
				],
				"path": "string",
				"supportLevel": "NOT_SUPPORTED"
			}
		},
		"userInterfaceResourcePath": "string",
		"versionRetentionFloor": 0,
		"versionRetentionLimit": 0
	},
	"documentEpoch": 0,
	"documentExpirationTimeMicros": 0,
	"documentKind": "string",
	"documentOwner": "string",
	"documentSelfLink": "string",
	"documentSourceLink": "string",
	"documentTransactionId": "string",
	"documentUpdateAction": "string",
	"documentUpdateTimeMicros": 0,
	"documentVersion": 0,
	"groupByTerms": [
		{
			"fieldName": "string",
			"groupByType": "EACH_VALUE"
		}
	],
	"isAnnotation": false,
	"isSearchable": false,
	"name": "string",
	"relationFunctions": [
		{
			"relationName": "string",
			"relationType": "LOGS",
			"shardInfo": {
				"key": "string"
			}
		}
	],
	"searchable": false,
	"source": "USER_DEFINED",
	"sourceName": "string",
	"tenantLinks": [
		"string"
	],
	"url": "string",
	"widget": {
		"analysisFunctions": [
			{
				"name": "INFLECTION",
				"parameters": {
					"key": "string"
				}
			}
		],
		"visualization": {
			"options": {
				"key": "string"
			},
			"type": "AREA"
		},
		"widgetType": "CHART"
	}
}
[{"label":"Latest (v1)","version":"latest"}]
vmware-aria-operations-for-logs
Property Of

DashboardWidget

Feedback

Was this page helpful?