Skip to content

CloudMonitoringQuery🔗

Definition🔗

type CloudMonitoringQuery struct {
    // 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"`
    // 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"`
    // Aliases can be set to modify the legend labels. e.g. {{metric.label.xxx}}. See docs for more detail.
    AliasBy *string `json:"aliasBy,omitempty"`
    // GCM query type.
    // queryType: #QueryType
    // Time Series List sub-query properties.
    TimeSeriesList *googlecloudmonitoring.TimeSeriesList `json:"timeSeriesList,omitempty"`
    // Time Series sub-query properties.
    TimeSeriesQuery *googlecloudmonitoring.TimeSeriesQuery `json:"timeSeriesQuery,omitempty"`
    // SLO sub-query properties.
    SloQuery *googlecloudmonitoring.SLOQuery `json:"sloQuery,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 *dashboard.DataSourceRef `json:"datasource,omitempty"`
    // Time interval in milliseconds.
    IntervalMs *float64 `json:"intervalMs,omitempty"`
}

Methods🔗

UnmarshalJSONStrict🔗

UnmarshalJSONStrict implements a custom JSON unmarshalling logic to decode CloudMonitoringQuery from JSON.

Note: the unmarshalling done by this function is strict. It will fail over required fields being absent from the input, fields having an incorrect type, unexpected fields being present, …

func (cloudMonitoringQuery *CloudMonitoringQuery) UnmarshalJSONStrict(raw []byte) error

Equals🔗

Equals tests the equality of two CloudMonitoringQuery objects.

func (cloudMonitoringQuery *CloudMonitoringQuery) Equals(other CloudMonitoringQuery) bool

Validate🔗

Validate checks all the validation constraints that may be defined on CloudMonitoringQuery fields for violations and returns them.

func (cloudMonitoringQuery *CloudMonitoringQuery) Validate() error

See also🔗

CloudMonitoringQueryBuilder