dataquery

package
v0.0.0-testrgm6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 24, 2023 License: AGPL-3.0 Imports: 0 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CloudWatchAnnotationQuery 

type CloudWatchAnnotationQuery struct {
	// DataQuery These are the common properties available to all queries in all datasources.
	// Specific implementations will *extend* this interface, adding the required
	// properties for the given context.
	DataQuery
	MetricStat

	// The ID of the AWS account to query for the metric, specifying `all` will query all accounts that the monitoring account is permitted to query.
	AccountId *string `json:"accountId,omitempty"`

	// Use this parameter to filter the results of the operation to only those alarms
	// that use a certain alarm action. For example, you could specify the ARN of
	// an SNS topic to find all alarms that send notifications to that topic.
	// e.g. `arn:aws:sns:us-east-1:123456789012:my-app-` would match `arn:aws:sns:us-east-1:123456789012:my-app-action`
	// but not match `arn:aws:sns:us-east-1:123456789012:your-app-action`
	ActionPrefix *string `json:"actionPrefix,omitempty"`

	// An alarm name prefix. If you specify this parameter, you receive information
	// about all alarms that have names that start with this prefix.
	// e.g. `my-team-service-` would match `my-team-service-high-cpu` but not match `your-team-service-high-cpu`
	AlarmNamePrefix *string `json:"alarmNamePrefix,omitempty"`

	// For mixed data sources the selected datasource is on the query level.
	// For non mixed scenarios this is undefined.
	// TODO find a better way to do this ^ that's friendly to schema
	// TODO this shouldn't be unknown but DataSourceRef | null
	Datasource *any `json:"datasource,omitempty"`

	// A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics.
	Dimensions *Dimensions `json:"dimensions,omitempty"`

	// Hide true if query is disabled (ie should not be returned to the dashboard)
	// Note this does not always imply that the query should not be executed since
	// the results from a hidden query may be used as the input to other queries (SSE etc)
	Hide *bool `json:"hide,omitempty"`

	// Only show metrics that exactly match all defined dimension names.
	MatchExact *bool `json:"matchExact,omitempty"`

	// Name of the metric
	MetricName *string `json:"metricName,omitempty"`

	// A namespace is a container for CloudWatch metrics. Metrics in different namespaces are isolated from each other, so that metrics from different applications are not mistakenly aggregated into the same statistics. For example, Amazon EC2 uses the AWS/EC2 namespace.
	Namespace string `json:"namespace"`

	// The length of time associated with a specific Amazon CloudWatch statistic. Can be specified by a number of seconds, 'auto', or as a duration string e.g. '15m' being 15 minutes
	Period *string `json:"period,omitempty"`

	// Enable matching on the prefix of the action name or alarm name, specify the prefixes with actionPrefix and/or alarmNamePrefix
	PrefixMatching *bool               `json:"prefixMatching,omitempty"`
	QueryMode      CloudWatchQueryMode `json:"queryMode"`

	// Specify the query flavor
	// TODO make this required and give it a default
	QueryType *string `json:"queryType,omitempty"`

	// A unique identifier for the query within the list of targets.
	// In server side expressions, the refId is used as a variable name to identify results.
	// By default, the UI will assign A->Z; however setting meaningful names may be useful.
	RefId string `json:"refId"`

	// AWS region to query for the metric
	Region string `json:"region"`

	// Metric data aggregations over specified periods of time. For detailed definitions of the statistics supported by CloudWatch, see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.
	Statistic *string `json:"statistic,omitempty"`

	// @deprecated use statistic
	Statistics []string `json:"statistics,omitempty"`
}

CloudWatchAnnotationQuery defines model for CloudWatchAnnotationQuery.

type CloudWatchDataQuery 

type CloudWatchDataQuery = map[string]any

CloudWatchDataQuery defines model for CloudWatchDataQuery.

type CloudWatchLogsQuery 

type CloudWatchLogsQuery struct {
	// DataQuery These are the common properties available to all queries in all datasources.
	// Specific implementations will *extend* this interface, adding the required
	// properties for the given context.
	DataQuery

	// For mixed data sources the selected datasource is on the query level.
	// For non mixed scenarios this is undefined.
	// TODO find a better way to do this ^ that's friendly to schema
	// TODO this shouldn't be unknown but DataSourceRef | null
	Datasource *any `json:"datasource,omitempty"`

	// The CloudWatch Logs Insights query to execute
	Expression *string `json:"expression,omitempty"`

	// Hide true if query is disabled (ie should not be returned to the dashboard)
	// Note this does not always imply that the query should not be executed since
	// the results from a hidden query may be used as the input to other queries (SSE etc)
	Hide *bool  `json:"hide,omitempty"`
	Id   string `json:"id"`

	// @deprecated use logGroups
	LogGroupNames []string `json:"logGroupNames,omitempty"`

	// Log groups to query
	LogGroups []LogGroup          `json:"logGroups,omitempty"`
	QueryMode CloudWatchQueryMode `json:"queryMode"`

	// Specify the query flavor
	// TODO make this required and give it a default
	QueryType *string `json:"queryType,omitempty"`

	// A unique identifier for the query within the list of targets.
	// In server side expressions, the refId is used as a variable name to identify results.
	// By default, the UI will assign A->Z; however setting meaningful names may be useful.
	RefId string `json:"refId"`

	// AWS region to query for the logs
	Region string `json:"region"`

	// Fields to group the results by, this field is automatically populated whenever the query is updated
	StatsGroups []string `json:"statsGroups,omitempty"`
}

CloudWatchLogsQuery defines model for CloudWatchLogsQuery.

type CloudWatchMetricsQuery 

type CloudWatchMetricsQuery struct {
	// DataQuery These are the common properties available to all queries in all datasources.
	// Specific implementations will *extend* this interface, adding the required
	// properties for the given context.
	DataQuery
	MetricStat

	// The ID of the AWS account to query for the metric, specifying `all` will query all accounts that the monitoring account is permitted to query.
	AccountId *string `json:"accountId,omitempty"`

	// Deprecated: use label
	// @deprecated use label
	Alias *string `json:"alias,omitempty"`

	// For mixed data sources the selected datasource is on the query level.
	// For non mixed scenarios this is undefined.
	// TODO find a better way to do this ^ that's friendly to schema
	// TODO this shouldn't be unknown but DataSourceRef | null
	Datasource *any `json:"datasource,omitempty"`

	// A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics.
	Dimensions *Dimensions `json:"dimensions,omitempty"`

	// Math expression query
	Expression *string `json:"expression,omitempty"`

	// Hide true if query is disabled (ie should not be returned to the dashboard)
	// Note this does not always imply that the query should not be executed since
	// the results from a hidden query may be used as the input to other queries (SSE etc)
	Hide *bool `json:"hide,omitempty"`

	// ID can be used to reference other queries in math expressions. The ID can include numbers, letters, and underscore, and must start with a lowercase letter.
	Id string `json:"id"`

	// Change the time series legend names using dynamic labels. See https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/graph-dynamic-labels.html for more details.
	Label *string `json:"label,omitempty"`

	// Only show metrics that exactly match all defined dimension names.
	MatchExact       *bool             `json:"matchExact,omitempty"`
	MetricEditorMode *MetricEditorMode `json:"metricEditorMode,omitempty"`

	// Name of the metric
	MetricName      *string          `json:"metricName,omitempty"`
	MetricQueryType *MetricQueryType `json:"metricQueryType,omitempty"`

	// A namespace is a container for CloudWatch metrics. Metrics in different namespaces are isolated from each other, so that metrics from different applications are not mistakenly aggregated into the same statistics. For example, Amazon EC2 uses the AWS/EC2 namespace.
	Namespace string `json:"namespace"`

	// The length of time associated with a specific Amazon CloudWatch statistic. Can be specified by a number of seconds, 'auto', or as a duration string e.g. '15m' being 15 minutes
	Period    *string              `json:"period,omitempty"`
	QueryMode *CloudWatchQueryMode `json:"queryMode,omitempty"`

	// Specify the query flavor
	// TODO make this required and give it a default
	QueryType *string `json:"queryType,omitempty"`

	// A unique identifier for the query within the list of targets.
	// In server side expressions, the refId is used as a variable name to identify results.
	// By default, the UI will assign A->Z; however setting meaningful names may be useful.
	RefId string `json:"refId"`

	// AWS region to query for the metric
	Region string         `json:"region"`
	Sql    *SQLExpression `json:"sql,omitempty"`

	// When the metric query type is `metricQueryType` is set to `Query`, this field is used to specify the query string.
	SqlExpression *string `json:"sqlExpression,omitempty"`

	// Metric data aggregations over specified periods of time. For detailed definitions of the statistics supported by CloudWatch, see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.
	Statistic *string `json:"statistic,omitempty"`

	// @deprecated use statistic
	Statistics []string `json:"statistics,omitempty"`
}

CloudWatchMetricsQuery defines model for CloudWatchMetricsQuery.

type CloudWatchQueryMode 

type CloudWatchQueryMode string

CloudWatchQueryMode defines model for CloudWatchQueryMode. 

const (
	CloudWatchQueryModeAnnotations CloudWatchQueryMode = "Annotations"
	CloudWatchQueryModeLogs        CloudWatchQueryMode = "Logs"
	CloudWatchQueryModeMetrics     CloudWatchQueryMode = "Metrics"
)

Defines values for CloudWatchQueryMode.

type DataQuery 

type DataQuery struct {
	// For mixed data sources the selected datasource is on the query level.
	// For non mixed scenarios this is undefined.
	// TODO find a better way to do this ^ that's friendly to schema
	// TODO this shouldn't be unknown but DataSourceRef | null
	Datasource *any `json:"datasource,omitempty"`

	// Hide true if query is disabled (ie should not be returned to the dashboard)
	// Note this does not always imply that the query should not be executed since
	// the results from a hidden query may be used as the input to other queries (SSE etc)
	Hide *bool `json:"hide,omitempty"`

	// Specify the query flavor
	// TODO make this required and give it a default
	QueryType *string `json:"queryType,omitempty"`

	// A unique identifier for the query within the list of targets.
	// In server side expressions, the refId is used as a variable name to identify results.
	// By default, the UI will assign A->Z; however setting meaningful names may be useful.
	RefId string `json:"refId"`
}

These are the common properties available to all queries in all datasources. Specific implementations will *extend* this interface, adding the required properties for the given context.

type Dimensions 

type Dimensions map[string]any

A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics.

type LogGroup 

type LogGroup struct {
	// AccountId of the log group
	AccountId *string `json:"accountId,omitempty"`

	// Label of the log group
	AccountLabel *string `json:"accountLabel,omitempty"`

	// ARN of the log group
	Arn string `json:"arn"`

	// Name of the log group
	Name string `json:"name"`
}

LogGroup defines model for LogGroup.

type MetricEditorMode 

type MetricEditorMode int

MetricEditorMode defines model for MetricEditorMode. 

const (
	MetricEditorModeN0 MetricEditorMode = 0
	MetricEditorModeN1 MetricEditorMode = 1
)

Defines values for MetricEditorMode.

type MetricQueryType 

type MetricQueryType int

MetricQueryType defines model for MetricQueryType. 

const (
	MetricQueryTypeN0 MetricQueryType = 0
	MetricQueryTypeN1 MetricQueryType = 1
)

Defines values for MetricQueryType.

type MetricStat 

type MetricStat struct {
	// The ID of the AWS account to query for the metric, specifying `all` will query all accounts that the monitoring account is permitted to query.
	AccountId *string `json:"accountId,omitempty"`

	// A name/value pair that is part of the identity of a metric. For example, you can get statistics for a specific EC2 instance by specifying the InstanceId dimension when you search for metrics.
	Dimensions *Dimensions `json:"dimensions,omitempty"`

	// Only show metrics that exactly match all defined dimension names.
	MatchExact *bool `json:"matchExact,omitempty"`

	// Name of the metric
	MetricName *string `json:"metricName,omitempty"`

	// A namespace is a container for CloudWatch metrics. Metrics in different namespaces are isolated from each other, so that metrics from different applications are not mistakenly aggregated into the same statistics. For example, Amazon EC2 uses the AWS/EC2 namespace.
	Namespace string `json:"namespace"`

	// The length of time associated with a specific Amazon CloudWatch statistic. Can be specified by a number of seconds, 'auto', or as a duration string e.g. '15m' being 15 minutes
	Period *string `json:"period,omitempty"`

	// AWS region to query for the metric
	Region string `json:"region"`

	// Metric data aggregations over specified periods of time. For detailed definitions of the statistics supported by CloudWatch, see https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/Statistics-definitions.html.
	Statistic *string `json:"statistic,omitempty"`

	// @deprecated use statistic
	Statistics []string `json:"statistics,omitempty"`
}

MetricStat defines model for MetricStat.

type QueryEditorArrayExpression 

type QueryEditorArrayExpression struct {
	Expressions []any                          `json:"expressions"`
	Type        QueryEditorArrayExpressionType `json:"type"`
}

QueryEditorArrayExpression defines model for QueryEditorArrayExpression.

type QueryEditorArrayExpressionType 

type QueryEditorArrayExpressionType string

QueryEditorArrayExpressionType defines model for QueryEditorArrayExpression.Type. 

const (
	QueryEditorArrayExpressionTypeAnd QueryEditorArrayExpressionType = "and"
	QueryEditorArrayExpressionTypeOr  QueryEditorArrayExpressionType = "or"
)

Defines values for QueryEditorArrayExpressionType.

type QueryEditorExpressionType 

type QueryEditorExpressionType string

QueryEditorExpressionType defines model for QueryEditorExpressionType. 

const (
	QueryEditorExpressionTypeAnd               QueryEditorExpressionType = "and"
	QueryEditorExpressionTypeFunction          QueryEditorExpressionType = "function"
	QueryEditorExpressionTypeFunctionParameter QueryEditorExpressionType = "functionParameter"
	QueryEditorExpressionTypeGroupBy           QueryEditorExpressionType = "groupBy"
	QueryEditorExpressionTypeOperator          QueryEditorExpressionType = "operator"
	QueryEditorExpressionTypeOr                QueryEditorExpressionType = "or"
	QueryEditorExpressionTypeProperty          QueryEditorExpressionType = "property"
)

Defines values for QueryEditorExpressionType.

type QueryEditorFunctionExpression 

type QueryEditorFunctionExpression struct {
	Name       *string                                  `json:"name,omitempty"`
	Parameters []QueryEditorFunctionParameterExpression `json:"parameters,omitempty"`
	Type       QueryEditorFunctionExpressionType        `json:"type"`
}

QueryEditorFunctionExpression defines model for QueryEditorFunctionExpression.

type QueryEditorFunctionExpressionType 

type QueryEditorFunctionExpressionType string

QueryEditorFunctionExpressionType defines model for QueryEditorFunctionExpression.Type. 

const (
	QueryEditorFunctionExpressionTypeAnd               QueryEditorFunctionExpressionType = "and"
	QueryEditorFunctionExpressionTypeFunction          QueryEditorFunctionExpressionType = "function"
	QueryEditorFunctionExpressionTypeFunctionParameter QueryEditorFunctionExpressionType = "functionParameter"
	QueryEditorFunctionExpressionTypeGroupBy           QueryEditorFunctionExpressionType = "groupBy"
	QueryEditorFunctionExpressionTypeOperator          QueryEditorFunctionExpressionType = "operator"
	QueryEditorFunctionExpressionTypeOr                QueryEditorFunctionExpressionType = "or"
	QueryEditorFunctionExpressionTypeProperty          QueryEditorFunctionExpressionType = "property"
)

Defines values for QueryEditorFunctionExpressionType.

type QueryEditorFunctionParameterExpression 

type QueryEditorFunctionParameterExpression struct {
	Name *string                                    `json:"name,omitempty"`
	Type QueryEditorFunctionParameterExpressionType `json:"type"`
}

QueryEditorFunctionParameterExpression defines model for QueryEditorFunctionParameterExpression.

type QueryEditorFunctionParameterExpressionType 

type QueryEditorFunctionParameterExpressionType string

QueryEditorFunctionParameterExpressionType defines model for QueryEditorFunctionParameterExpression.Type. 

const (
	QueryEditorFunctionParameterExpressionTypeAnd               QueryEditorFunctionParameterExpressionType = "and"
	QueryEditorFunctionParameterExpressionTypeFunction          QueryEditorFunctionParameterExpressionType = "function"
	QueryEditorFunctionParameterExpressionTypeFunctionParameter QueryEditorFunctionParameterExpressionType = "functionParameter"
	QueryEditorFunctionParameterExpressionTypeGroupBy           QueryEditorFunctionParameterExpressionType = "groupBy"
	QueryEditorFunctionParameterExpressionTypeOperator          QueryEditorFunctionParameterExpressionType = "operator"
	QueryEditorFunctionParameterExpressionTypeOr                QueryEditorFunctionParameterExpressionType = "or"
	QueryEditorFunctionParameterExpressionTypeProperty          QueryEditorFunctionParameterExpressionType = "property"
)

Defines values for QueryEditorFunctionParameterExpressionType.

type QueryEditorGroupByExpression 

type QueryEditorGroupByExpression struct {
	Property QueryEditorProperty              `json:"property"`
	Type     QueryEditorGroupByExpressionType `json:"type"`
}

QueryEditorGroupByExpression defines model for QueryEditorGroupByExpression.

type QueryEditorGroupByExpressionType 

type QueryEditorGroupByExpressionType string

QueryEditorGroupByExpressionType defines model for QueryEditorGroupByExpression.Type. 

const (
	QueryEditorGroupByExpressionTypeAnd               QueryEditorGroupByExpressionType = "and"
	QueryEditorGroupByExpressionTypeFunction          QueryEditorGroupByExpressionType = "function"
	QueryEditorGroupByExpressionTypeFunctionParameter QueryEditorGroupByExpressionType = "functionParameter"
	QueryEditorGroupByExpressionTypeGroupBy           QueryEditorGroupByExpressionType = "groupBy"
	QueryEditorGroupByExpressionTypeOperator          QueryEditorGroupByExpressionType = "operator"
	QueryEditorGroupByExpressionTypeOr                QueryEditorGroupByExpressionType = "or"
	QueryEditorGroupByExpressionTypeProperty          QueryEditorGroupByExpressionType = "property"
)

Defines values for QueryEditorGroupByExpressionType.

type QueryEditorOperator 

type QueryEditorOperator struct {
	Name  *string `json:"name,omitempty"`
	Value *any    `json:"value,omitempty"`
}

TS type is QueryEditorOperator<T extends QueryEditorOperatorValueType>, extended in veneer

type QueryEditorOperatorExpression 

type QueryEditorOperatorExpression struct {
	// TS type is QueryEditorOperator<T extends QueryEditorOperatorValueType>, extended in veneer
	Operator QueryEditorOperator               `json:"operator"`
	Property QueryEditorProperty               `json:"property"`
	Type     QueryEditorOperatorExpressionType `json:"type"`
}

QueryEditorOperatorExpression defines model for QueryEditorOperatorExpression.

type QueryEditorOperatorExpressionType 

type QueryEditorOperatorExpressionType string

QueryEditorOperatorExpressionType defines model for QueryEditorOperatorExpression.Type. 

const (
	QueryEditorOperatorExpressionTypeAnd               QueryEditorOperatorExpressionType = "and"
	QueryEditorOperatorExpressionTypeFunction          QueryEditorOperatorExpressionType = "function"
	QueryEditorOperatorExpressionTypeFunctionParameter QueryEditorOperatorExpressionType = "functionParameter"
	QueryEditorOperatorExpressionTypeGroupBy           QueryEditorOperatorExpressionType = "groupBy"
	QueryEditorOperatorExpressionTypeOperator          QueryEditorOperatorExpressionType = "operator"
	QueryEditorOperatorExpressionTypeOr                QueryEditorOperatorExpressionType = "or"
	QueryEditorOperatorExpressionTypeProperty          QueryEditorOperatorExpressionType = "property"
)

Defines values for QueryEditorOperatorExpressionType.

type QueryEditorProperty 

type QueryEditorProperty struct {
	Name *string                 `json:"name,omitempty"`
	Type QueryEditorPropertyType `json:"type"`
}

QueryEditorProperty defines model for QueryEditorProperty.

type QueryEditorPropertyExpression 

type QueryEditorPropertyExpression struct {
	Property QueryEditorProperty               `json:"property"`
	Type     QueryEditorPropertyExpressionType `json:"type"`
}

QueryEditorPropertyExpression defines model for QueryEditorPropertyExpression.

type QueryEditorPropertyExpressionType 

type QueryEditorPropertyExpressionType string

QueryEditorPropertyExpressionType defines model for QueryEditorPropertyExpression.Type. 

const (
	QueryEditorPropertyExpressionTypeAnd               QueryEditorPropertyExpressionType = "and"
	QueryEditorPropertyExpressionTypeFunction          QueryEditorPropertyExpressionType = "function"
	QueryEditorPropertyExpressionTypeFunctionParameter QueryEditorPropertyExpressionType = "functionParameter"
	QueryEditorPropertyExpressionTypeGroupBy           QueryEditorPropertyExpressionType = "groupBy"
	QueryEditorPropertyExpressionTypeOperator          QueryEditorPropertyExpressionType = "operator"
	QueryEditorPropertyExpressionTypeOr                QueryEditorPropertyExpressionType = "or"
	QueryEditorPropertyExpressionTypeProperty          QueryEditorPropertyExpressionType = "property"
)

Defines values for QueryEditorPropertyExpressionType.

type QueryEditorPropertyType 

type QueryEditorPropertyType string

QueryEditorPropertyType defines model for QueryEditorPropertyType. 

const (
	QueryEditorPropertyTypeString QueryEditorPropertyType = "string"
)

Defines values for QueryEditorPropertyType.

type SQLExpression 

type SQLExpression struct {
	// FROM part of the SQL expression
	From    *any                        `json:"from,omitempty"`
	GroupBy *QueryEditorArrayExpression `json:"groupBy,omitempty"`

	// LIMIT part of the SQL expression
	Limit   *int64                         `json:"limit,omitempty"`
	OrderBy *QueryEditorFunctionExpression `json:"orderBy,omitempty"`

	// The sort order of the SQL expression, `ASC` or `DESC`
	OrderByDirection *string                        `json:"orderByDirection,omitempty"`
	Select           *QueryEditorFunctionExpression `json:"select,omitempty"`
	Where            *QueryEditorArrayExpression    `json:"where,omitempty"`
}

SQLExpression defines model for SQLExpression.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.