monitoring.v1beta1.monitoringDashboard
"MonitoringDashboard is the Schema for the monitoring API"
Index
fn new(name)
obj metadata
fn withAnnotations(annotations)
fn withAnnotationsMixin(annotations)
fn withClusterName(clusterName)
fn withCreationTimestamp(creationTimestamp)
fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)
fn withDeletionTimestamp(deletionTimestamp)
fn withFinalizers(finalizers)
fn withFinalizersMixin(finalizers)
fn withGenerateName(generateName)
fn withGeneration(generation)
fn withLabels(labels)
fn withLabelsMixin(labels)
fn withName(name)
fn withNamespace(namespace)
fn withOwnerReferences(ownerReferences)
fn withOwnerReferencesMixin(ownerReferences)
fn withResourceVersion(resourceVersion)
fn withSelfLink(selfLink)
fn withUid(uid)
obj spec
fn withDashboardFilters(dashboardFilters)
fn withDashboardFiltersMixin(dashboardFilters)
fn withDisplayName(displayName)
fn withResourceID(resourceID)
obj spec.columnLayout
fn withColumns(columns)
fn withColumnsMixin(columns)
obj spec.columnLayout.columns
fn withWeight(weight)
fn withWidgets(widgets)
fn withWidgetsMixin(widgets)
obj spec.columnLayout.columns.widgets
fn withBlank(blank)
fn withBlankMixin(blank)
fn withId(id)
fn withSingleViewGroup(singleViewGroup)
fn withSingleViewGroupMixin(singleViewGroup)
fn withTitle(title)
obj spec.columnLayout.columns.widgets.alertChart
obj spec.columnLayout.columns.widgets.collapsibleGroup
obj spec.columnLayout.columns.widgets.errorReportingPanel
obj spec.columnLayout.columns.widgets.incidentList
obj spec.columnLayout.columns.widgets.logsPanel
obj spec.columnLayout.columns.widgets.pieChart
fn withChartType(chartType)
fn withDataSets(dataSets)
fn withDataSetsMixin(dataSets)
fn withShowLabels(showLabels)
obj spec.columnLayout.columns.widgets.pieChart.dataSets
fn withMinAlignmentPeriod(minAlignmentPeriod)
fn withSliceNameTemplate(sliceNameTemplate)
obj spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery
fn withOutputFullDuration(outputFullDuration)
fn withPrometheusQuery(prometheusQuery)
fn withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)
fn withUnitOverride(unitOverride)
obj spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter
fn withFilter(filter)
obj spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation
obj spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter
obj spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation
obj spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio
obj spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator
obj spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator
obj spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter
obj spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation
obj spec.columnLayout.columns.widgets.scorecard
fn withBlankView(blankView)
fn withBlankViewMixin(blankView)
fn withThresholds(thresholds)
fn withThresholdsMixin(thresholds)
obj spec.columnLayout.columns.widgets.scorecard.gaugeView
obj spec.columnLayout.columns.widgets.scorecard.sparkChartView
obj spec.columnLayout.columns.widgets.scorecard.thresholds
obj spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery
fn withOutputFullDuration(outputFullDuration)
fn withPrometheusQuery(prometheusQuery)
fn withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)
fn withUnitOverride(unitOverride)
obj spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter
fn withFilter(filter)
obj spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation
obj spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter
obj spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation
obj spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio
obj spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator
obj spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator
obj spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter
obj spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation
obj spec.columnLayout.columns.widgets.sectionHeader
obj spec.columnLayout.columns.widgets.text
obj spec.columnLayout.columns.widgets.timeSeriesTable
fn withColumnSettings(columnSettings)
fn withColumnSettingsMixin(columnSettings)
fn withDataSets(dataSets)
fn withDataSetsMixin(dataSets)
fn withMetricVisualization(metricVisualization)
obj spec.columnLayout.columns.widgets.timeSeriesTable.columnSettings
obj spec.columnLayout.columns.widgets.timeSeriesTable.dataSets
fn withMinAlignmentPeriod(minAlignmentPeriod)
fn withTableTemplate(tableTemplate)
obj spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.tableDisplayOptions
obj spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery
fn withOutputFullDuration(outputFullDuration)
fn withPrometheusQuery(prometheusQuery)
fn withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)
fn withUnitOverride(unitOverride)
obj spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter
fn withFilter(filter)
obj spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation
obj spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter
obj spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation
obj spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio
obj spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator
obj spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator
obj spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter
obj spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation
obj spec.columnLayout.columns.widgets.xyChart
fn withDataSets(dataSets)
fn withDataSetsMixin(dataSets)
fn withThresholds(thresholds)
fn withThresholdsMixin(thresholds)
fn withTimeshiftDuration(timeshiftDuration)
obj spec.columnLayout.columns.widgets.xyChart.chartOptions
obj spec.columnLayout.columns.widgets.xyChart.dataSets
fn withLegendTemplate(legendTemplate)
fn withMinAlignmentPeriod(minAlignmentPeriod)
fn withPlotType(plotType)
fn withTargetAxis(targetAxis)
obj spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery
fn withOutputFullDuration(outputFullDuration)
fn withPrometheusQuery(prometheusQuery)
fn withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)
fn withUnitOverride(unitOverride)
obj spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter
fn withFilter(filter)
obj spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation
obj spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter
obj spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation
obj spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio
obj spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator
obj spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator
obj spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter
obj spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation
obj spec.columnLayout.columns.widgets.xyChart.thresholds
obj spec.columnLayout.columns.widgets.xyChart.xAxis
obj spec.columnLayout.columns.widgets.xyChart.y2Axis
obj spec.columnLayout.columns.widgets.xyChart.yAxis
obj spec.dashboardFilters
obj spec.gridLayout
fn withColumns(columns)
fn withWidgets(widgets)
fn withWidgetsMixin(widgets)
obj spec.gridLayout.widgets
fn withBlank(blank)
fn withBlankMixin(blank)
fn withId(id)
fn withSingleViewGroup(singleViewGroup)
fn withSingleViewGroupMixin(singleViewGroup)
fn withTitle(title)
obj spec.gridLayout.widgets.alertChart
obj spec.gridLayout.widgets.collapsibleGroup
obj spec.gridLayout.widgets.errorReportingPanel
obj spec.gridLayout.widgets.incidentList
obj spec.gridLayout.widgets.logsPanel
obj spec.gridLayout.widgets.pieChart
fn withChartType(chartType)
fn withDataSets(dataSets)
fn withDataSetsMixin(dataSets)
fn withShowLabels(showLabels)
obj spec.gridLayout.widgets.pieChart.dataSets
fn withMinAlignmentPeriod(minAlignmentPeriod)
fn withSliceNameTemplate(sliceNameTemplate)
obj spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery
fn withOutputFullDuration(outputFullDuration)
fn withPrometheusQuery(prometheusQuery)
fn withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)
fn withUnitOverride(unitOverride)
obj spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter
fn withFilter(filter)
obj spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation
obj spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter
obj spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation
obj spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio
obj spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator
obj spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator
obj spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter
obj spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation
obj spec.gridLayout.widgets.scorecard
fn withBlankView(blankView)
fn withBlankViewMixin(blankView)
fn withThresholds(thresholds)
fn withThresholdsMixin(thresholds)
obj spec.gridLayout.widgets.scorecard.gaugeView
obj spec.gridLayout.widgets.scorecard.sparkChartView
obj spec.gridLayout.widgets.scorecard.thresholds
obj spec.gridLayout.widgets.scorecard.timeSeriesQuery
fn withOutputFullDuration(outputFullDuration)
fn withPrometheusQuery(prometheusQuery)
fn withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)
fn withUnitOverride(unitOverride)
obj spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilter
obj spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio
obj spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator
obj spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator
obj spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter
obj spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation
obj spec.gridLayout.widgets.sectionHeader
obj spec.gridLayout.widgets.text
obj spec.gridLayout.widgets.timeSeriesTable
fn withColumnSettings(columnSettings)
fn withColumnSettingsMixin(columnSettings)
fn withDataSets(dataSets)
fn withDataSetsMixin(dataSets)
fn withMetricVisualization(metricVisualization)
obj spec.gridLayout.widgets.timeSeriesTable.columnSettings
obj spec.gridLayout.widgets.timeSeriesTable.dataSets
fn withMinAlignmentPeriod(minAlignmentPeriod)
fn withTableTemplate(tableTemplate)
obj spec.gridLayout.widgets.timeSeriesTable.dataSets.tableDisplayOptions
obj spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery
fn withOutputFullDuration(outputFullDuration)
fn withPrometheusQuery(prometheusQuery)
fn withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)
fn withUnitOverride(unitOverride)
obj spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter
fn withFilter(filter)
obj spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation
obj spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter
obj spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation
obj spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio
obj spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator
obj spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator
obj spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter
obj spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation
obj spec.gridLayout.widgets.xyChart
fn withDataSets(dataSets)
fn withDataSetsMixin(dataSets)
fn withThresholds(thresholds)
fn withThresholdsMixin(thresholds)
fn withTimeshiftDuration(timeshiftDuration)
obj spec.gridLayout.widgets.xyChart.chartOptions
obj spec.gridLayout.widgets.xyChart.dataSets
fn withLegendTemplate(legendTemplate)
fn withMinAlignmentPeriod(minAlignmentPeriod)
fn withPlotType(plotType)
fn withTargetAxis(targetAxis)
obj spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery
fn withOutputFullDuration(outputFullDuration)
fn withPrometheusQuery(prometheusQuery)
fn withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)
fn withUnitOverride(unitOverride)
obj spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter
fn withFilter(filter)
obj spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation
obj spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter
obj spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation
obj spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio
obj spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator
obj spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator
obj spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter
obj spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation
obj spec.gridLayout.widgets.xyChart.thresholds
obj spec.gridLayout.widgets.xyChart.xAxis
obj spec.gridLayout.widgets.xyChart.y2Axis
obj spec.gridLayout.widgets.xyChart.yAxis
obj spec.mosaicLayout
fn withColumns(columns)
fn withTiles(tiles)
fn withTilesMixin(tiles)
obj spec.mosaicLayout.tiles
fn withHeight(height)
fn withWidth(width)
fn withXPos(xPos)
fn withYPos(yPos)
obj spec.mosaicLayout.tiles.widget
fn withBlank(blank)
fn withBlankMixin(blank)
fn withId(id)
fn withSingleViewGroup(singleViewGroup)
fn withSingleViewGroupMixin(singleViewGroup)
fn withTitle(title)
obj spec.mosaicLayout.tiles.widget.alertChart
obj spec.mosaicLayout.tiles.widget.collapsibleGroup
obj spec.mosaicLayout.tiles.widget.errorReportingPanel
obj spec.mosaicLayout.tiles.widget.incidentList
obj spec.mosaicLayout.tiles.widget.logsPanel
obj spec.mosaicLayout.tiles.widget.pieChart
fn withChartType(chartType)
fn withDataSets(dataSets)
fn withDataSetsMixin(dataSets)
fn withShowLabels(showLabels)
obj spec.mosaicLayout.tiles.widget.pieChart.dataSets
fn withMinAlignmentPeriod(minAlignmentPeriod)
fn withSliceNameTemplate(sliceNameTemplate)
obj spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery
fn withOutputFullDuration(outputFullDuration)
fn withPrometheusQuery(prometheusQuery)
fn withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)
fn withUnitOverride(unitOverride)
obj spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter
fn withFilter(filter)
obj spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation
obj spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter
obj spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation
obj spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio
obj spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator
obj spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator
obj spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter
obj spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation
obj spec.mosaicLayout.tiles.widget.scorecard
fn withBlankView(blankView)
fn withBlankViewMixin(blankView)
fn withThresholds(thresholds)
fn withThresholdsMixin(thresholds)
obj spec.mosaicLayout.tiles.widget.scorecard.gaugeView
obj spec.mosaicLayout.tiles.widget.scorecard.sparkChartView
obj spec.mosaicLayout.tiles.widget.scorecard.thresholds
obj spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery
fn withOutputFullDuration(outputFullDuration)
fn withPrometheusQuery(prometheusQuery)
fn withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)
fn withUnitOverride(unitOverride)
obj spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter
fn withFilter(filter)
obj spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation
obj spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter
obj spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation
obj spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio
obj spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator
obj spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator
obj spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter
obj spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation
obj spec.mosaicLayout.tiles.widget.sectionHeader
obj spec.mosaicLayout.tiles.widget.text
obj spec.mosaicLayout.tiles.widget.timeSeriesTable
fn withColumnSettings(columnSettings)
fn withColumnSettingsMixin(columnSettings)
fn withDataSets(dataSets)
fn withDataSetsMixin(dataSets)
fn withMetricVisualization(metricVisualization)
obj spec.mosaicLayout.tiles.widget.timeSeriesTable.columnSettings
obj spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets
fn withMinAlignmentPeriod(minAlignmentPeriod)
fn withTableTemplate(tableTemplate)
obj spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.tableDisplayOptions
obj spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery
fn withOutputFullDuration(outputFullDuration)
fn withPrometheusQuery(prometheusQuery)
fn withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)
fn withUnitOverride(unitOverride)
obj spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter
fn withFilter(filter)
obj spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation
obj spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter
obj spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation
obj spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio
obj spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator
obj spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator
obj spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter
obj spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation
obj spec.mosaicLayout.tiles.widget.xyChart
fn withDataSets(dataSets)
fn withDataSetsMixin(dataSets)
fn withThresholds(thresholds)
fn withThresholdsMixin(thresholds)
fn withTimeshiftDuration(timeshiftDuration)
obj spec.mosaicLayout.tiles.widget.xyChart.chartOptions
obj spec.mosaicLayout.tiles.widget.xyChart.dataSets
fn withLegendTemplate(legendTemplate)
fn withMinAlignmentPeriod(minAlignmentPeriod)
fn withPlotType(plotType)
fn withTargetAxis(targetAxis)
obj spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery
fn withOutputFullDuration(outputFullDuration)
fn withPrometheusQuery(prometheusQuery)
fn withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)
fn withUnitOverride(unitOverride)
obj spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter
fn withFilter(filter)
obj spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation
obj spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter
obj spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation
obj spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio
obj spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator
obj spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator
obj spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter
obj spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation
obj spec.mosaicLayout.tiles.widget.xyChart.thresholds
obj spec.mosaicLayout.tiles.widget.xyChart.xAxis
obj spec.mosaicLayout.tiles.widget.xyChart.y2Axis
obj spec.mosaicLayout.tiles.widget.xyChart.yAxis
obj spec.projectRef
obj spec.rowLayout
fn withRows(rows)
fn withRowsMixin(rows)
obj spec.rowLayout.rows
fn withWeight(weight)
fn withWidgets(widgets)
fn withWidgetsMixin(widgets)
obj spec.rowLayout.rows.widgets
fn withBlank(blank)
fn withBlankMixin(blank)
fn withId(id)
fn withSingleViewGroup(singleViewGroup)
fn withSingleViewGroupMixin(singleViewGroup)
fn withTitle(title)
obj spec.rowLayout.rows.widgets.alertChart
obj spec.rowLayout.rows.widgets.collapsibleGroup
obj spec.rowLayout.rows.widgets.errorReportingPanel
obj spec.rowLayout.rows.widgets.incidentList
obj spec.rowLayout.rows.widgets.logsPanel
obj spec.rowLayout.rows.widgets.pieChart
fn withChartType(chartType)
fn withDataSets(dataSets)
fn withDataSetsMixin(dataSets)
fn withShowLabels(showLabels)
obj spec.rowLayout.rows.widgets.pieChart.dataSets
fn withMinAlignmentPeriod(minAlignmentPeriod)
fn withSliceNameTemplate(sliceNameTemplate)
obj spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery
fn withOutputFullDuration(outputFullDuration)
fn withPrometheusQuery(prometheusQuery)
fn withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)
fn withUnitOverride(unitOverride)
obj spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter
fn withFilter(filter)
obj spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation
obj spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter
obj spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation
obj spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio
obj spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator
obj spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator
obj spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter
obj spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation
obj spec.rowLayout.rows.widgets.scorecard
fn withBlankView(blankView)
fn withBlankViewMixin(blankView)
fn withThresholds(thresholds)
fn withThresholdsMixin(thresholds)
obj spec.rowLayout.rows.widgets.scorecard.gaugeView
obj spec.rowLayout.rows.widgets.scorecard.sparkChartView
obj spec.rowLayout.rows.widgets.scorecard.thresholds
obj spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery
fn withOutputFullDuration(outputFullDuration)
fn withPrometheusQuery(prometheusQuery)
fn withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)
fn withUnitOverride(unitOverride)
obj spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter
fn withFilter(filter)
obj spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation
obj spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter
obj spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation
obj spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio
obj spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator
obj spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator
obj spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter
obj spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation
obj spec.rowLayout.rows.widgets.sectionHeader
obj spec.rowLayout.rows.widgets.text
obj spec.rowLayout.rows.widgets.timeSeriesTable
fn withColumnSettings(columnSettings)
fn withColumnSettingsMixin(columnSettings)
fn withDataSets(dataSets)
fn withDataSetsMixin(dataSets)
fn withMetricVisualization(metricVisualization)
obj spec.rowLayout.rows.widgets.timeSeriesTable.columnSettings
obj spec.rowLayout.rows.widgets.timeSeriesTable.dataSets
fn withMinAlignmentPeriod(minAlignmentPeriod)
fn withTableTemplate(tableTemplate)
obj spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.tableDisplayOptions
obj spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery
fn withOutputFullDuration(outputFullDuration)
fn withPrometheusQuery(prometheusQuery)
fn withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)
fn withUnitOverride(unitOverride)
obj spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter
fn withFilter(filter)
obj spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation
obj spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter
obj spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation
obj spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio
obj spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator
obj spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator
obj spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter
obj spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation
obj spec.rowLayout.rows.widgets.xyChart
fn withDataSets(dataSets)
fn withDataSetsMixin(dataSets)
fn withThresholds(thresholds)
fn withThresholdsMixin(thresholds)
fn withTimeshiftDuration(timeshiftDuration)
obj spec.rowLayout.rows.widgets.xyChart.chartOptions
obj spec.rowLayout.rows.widgets.xyChart.dataSets
fn withLegendTemplate(legendTemplate)
fn withMinAlignmentPeriod(minAlignmentPeriod)
fn withPlotType(plotType)
fn withTargetAxis(targetAxis)
obj spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery
fn withOutputFullDuration(outputFullDuration)
fn withPrometheusQuery(prometheusQuery)
fn withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)
fn withUnitOverride(unitOverride)
obj spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter
fn withFilter(filter)
obj spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation
obj spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter
obj spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation
obj spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio
obj spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator
obj spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator
obj spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter
obj spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation
obj spec.rowLayout.rows.widgets.xyChart.thresholds
obj spec.rowLayout.rows.widgets.xyChart.xAxis
obj spec.rowLayout.rows.widgets.xyChart.y2Axis
obj spec.rowLayout.rows.widgets.xyChart.yAxis
Fields
fn new
new(name)
new returns an instance of MonitoringDashboard
obj metadata
"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."
fn metadata.withAnnotations
withAnnotations(annotations)
"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"
fn metadata.withAnnotationsMixin
withAnnotationsMixin(annotations)
"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"
Note: This function appends passed data to existing values
fn metadata.withClusterName
withClusterName(clusterName)
"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."
fn metadata.withCreationTimestamp
withCreationTimestamp(creationTimestamp)
"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."
fn metadata.withDeletionGracePeriodSeconds
withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)
"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."
fn metadata.withDeletionTimestamp
withDeletionTimestamp(deletionTimestamp)
"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."
fn metadata.withFinalizers
withFinalizers(finalizers)
"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."
fn metadata.withFinalizersMixin
withFinalizersMixin(finalizers)
"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."
Note: This function appends passed data to existing values
fn metadata.withGenerateName
withGenerateName(generateName)
"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"
fn metadata.withGeneration
withGeneration(generation)
"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."
fn metadata.withLabels
withLabels(labels)
"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"
fn metadata.withLabelsMixin
withLabelsMixin(labels)
"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"
Note: This function appends passed data to existing values
fn metadata.withName
withName(name)
"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"
fn metadata.withNamespace
withNamespace(namespace)
"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"
fn metadata.withOwnerReferences
withOwnerReferences(ownerReferences)
"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."
fn metadata.withOwnerReferencesMixin
withOwnerReferencesMixin(ownerReferences)
"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."
Note: This function appends passed data to existing values
fn metadata.withResourceVersion
withResourceVersion(resourceVersion)
"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"
fn metadata.withSelfLink
withSelfLink(selfLink)
"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."
fn metadata.withUid
withUid(uid)
"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"
obj spec
fn spec.withDashboardFilters
withDashboardFilters(dashboardFilters)
"Filters to reduce the amount of data charted based on the filter criteria."
fn spec.withDashboardFiltersMixin
withDashboardFiltersMixin(dashboardFilters)
"Filters to reduce the amount of data charted based on the filter criteria."
Note: This function appends passed data to existing values
fn spec.withDisplayName
withDisplayName(displayName)
"Required. The mutable, human-readable name."
fn spec.withResourceID
withResourceID(resourceID)
"Immutable. Optional. The name of the resource. Used for creation and acquisition."
obj spec.columnLayout
"The content is divided into equally spaced columns and the widgets are arranged vertically."
fn spec.columnLayout.withColumns
withColumns(columns)
"The columns of content to display."
fn spec.columnLayout.withColumnsMixin
withColumnsMixin(columns)
"The columns of content to display."
Note: This function appends passed data to existing values
obj spec.columnLayout.columns
"The columns of content to display."
fn spec.columnLayout.columns.withWeight
withWeight(weight)
"The relative weight of this column. The column weight is used to adjust the width of columns on the screen (relative to peers)."
fn spec.columnLayout.columns.withWidgets
withWidgets(widgets)
"The display widgets arranged vertically in this column."
fn spec.columnLayout.columns.withWidgetsMixin
withWidgetsMixin(widgets)
"The display widgets arranged vertically in this column."
Note: This function appends passed data to existing values
obj spec.columnLayout.columns.widgets
"The display widgets arranged vertically in this column."
fn spec.columnLayout.columns.widgets.withBlank
withBlank(blank)
"A blank space."
fn spec.columnLayout.columns.widgets.withBlankMixin
withBlankMixin(blank)
"A blank space."
Note: This function appends passed data to existing values
fn spec.columnLayout.columns.widgets.withId
withId(id)
"Optional. The widget id. Ids may be made up of alphanumerics, dashes and underscores. Widget ids are optional."
fn spec.columnLayout.columns.widgets.withSingleViewGroup
withSingleViewGroup(singleViewGroup)
"A widget that groups the other widgets by using a dropdown menu."
fn spec.columnLayout.columns.widgets.withSingleViewGroupMixin
withSingleViewGroupMixin(singleViewGroup)
"A widget that groups the other widgets by using a dropdown menu."
Note: This function appends passed data to existing values
fn spec.columnLayout.columns.widgets.withTitle
withTitle(title)
"Optional. The title of the widget."
obj spec.columnLayout.columns.widgets.alertChart
"A chart of alert policy data."
obj spec.columnLayout.columns.widgets.alertChart.alertPolicyRef
"Required. A reference to the MonitoringAlertPolicy."
fn spec.columnLayout.columns.widgets.alertChart.alertPolicyRef.withExternal
withExternal(external)
"The MonitoringAlertPolicy link in the form \"projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]\", when not managed by Config Connector."
fn spec.columnLayout.columns.widgets.alertChart.alertPolicyRef.withName
withName(name)
"The name
field of a MonitoringAlertPolicy
resource."
fn spec.columnLayout.columns.widgets.alertChart.alertPolicyRef.withNamespace
withNamespace(namespace)
"The namespace
field of a MonitoringAlertPolicy
resource."
obj spec.columnLayout.columns.widgets.collapsibleGroup
"A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets."
fn spec.columnLayout.columns.widgets.collapsibleGroup.withCollapsed
withCollapsed(collapsed)
"The collapsed state of the widget on first page load."
obj spec.columnLayout.columns.widgets.errorReportingPanel
"A widget that displays a list of error groups."
fn spec.columnLayout.columns.widgets.errorReportingPanel.withProjectRefs
withProjectRefs(projectRefs)
"The projects from which to gather errors."
fn spec.columnLayout.columns.widgets.errorReportingPanel.withProjectRefsMixin
withProjectRefsMixin(projectRefs)
"The projects from which to gather errors."
Note: This function appends passed data to existing values
fn spec.columnLayout.columns.widgets.errorReportingPanel.withServices
withServices(services)
"An identifier of the service, such as the name of the executable, job, or Google App Engine service name. This field is expected to have a low number of values that are relatively stable over time, as opposed to version
, which can be changed whenever new code is deployed."
fn spec.columnLayout.columns.widgets.errorReportingPanel.withServicesMixin
withServicesMixin(services)
"An identifier of the service, such as the name of the executable, job, or Google App Engine service name. This field is expected to have a low number of values that are relatively stable over time, as opposed to version
, which can be changed whenever new code is deployed."
Note: This function appends passed data to existing values
fn spec.columnLayout.columns.widgets.errorReportingPanel.withVersions
withVersions(versions)
"Represents the source code version that the developer provided, which could represent a version label or a Git SHA-1 hash, for example. For App Engine standard environment, the version is set to the version of the app."
fn spec.columnLayout.columns.widgets.errorReportingPanel.withVersionsMixin
withVersionsMixin(versions)
"Represents the source code version that the developer provided, which could represent a version label or a Git SHA-1 hash, for example. For App Engine standard environment, the version is set to the version of the app."
Note: This function appends passed data to existing values
obj spec.columnLayout.columns.widgets.errorReportingPanel.projectRefs
"The projects from which to gather errors."
fn spec.columnLayout.columns.widgets.errorReportingPanel.projectRefs.withExternal
withExternal(external)
"The projectID
field of a project, when not managed by Config Connector."
fn spec.columnLayout.columns.widgets.errorReportingPanel.projectRefs.withKind
withKind(kind)
"The kind of the Project resource; optional but must be Project
if provided."
fn spec.columnLayout.columns.widgets.errorReportingPanel.projectRefs.withName
withName(name)
"The name
field of a Project
resource."
fn spec.columnLayout.columns.widgets.errorReportingPanel.projectRefs.withNamespace
withNamespace(namespace)
"The namespace
field of a Project
resource."
obj spec.columnLayout.columns.widgets.incidentList
"A widget that shows list of incidents."
fn spec.columnLayout.columns.widgets.incidentList.withMonitoredResources
withMonitoredResources(monitoredResources)
"Optional. The monitored resource for which incidents are listed."
fn spec.columnLayout.columns.widgets.incidentList.withMonitoredResourcesMixin
withMonitoredResourcesMixin(monitoredResources)
"Optional. The monitored resource for which incidents are listed."
Note: This function appends passed data to existing values
fn spec.columnLayout.columns.widgets.incidentList.withPolicyRefs
withPolicyRefs(policyRefs)
"Optional. A list of alert policies to filter the incident list by."
fn spec.columnLayout.columns.widgets.incidentList.withPolicyRefsMixin
withPolicyRefsMixin(policyRefs)
"Optional. A list of alert policies to filter the incident list by."
Note: This function appends passed data to existing values
obj spec.columnLayout.columns.widgets.incidentList.monitoredResources
"Optional. The monitored resource for which incidents are listed."
fn spec.columnLayout.columns.widgets.incidentList.monitoredResources.withLabels
withLabels(labels)
"Required. Values for all of the labels listed in the associated monitored resource descriptor."
fn spec.columnLayout.columns.widgets.incidentList.monitoredResources.withLabelsMixin
withLabelsMixin(labels)
"Required. Values for all of the labels listed in the associated monitored resource descriptor."
Note: This function appends passed data to existing values
fn spec.columnLayout.columns.widgets.incidentList.monitoredResources.withType
withType(type)
"Required. The monitored resource type. This field must match the type
field of a [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor] object."
obj spec.columnLayout.columns.widgets.incidentList.policyRefs
"Optional. A list of alert policies to filter the incident list by."
fn spec.columnLayout.columns.widgets.incidentList.policyRefs.withExternal
withExternal(external)
"The MonitoringAlertPolicy link in the form \"projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]\", when not managed by Config Connector."
fn spec.columnLayout.columns.widgets.incidentList.policyRefs.withName
withName(name)
"The name
field of a MonitoringAlertPolicy
resource."
fn spec.columnLayout.columns.widgets.incidentList.policyRefs.withNamespace
withNamespace(namespace)
"The namespace
field of a MonitoringAlertPolicy
resource."
obj spec.columnLayout.columns.widgets.logsPanel
"A widget that shows a stream of logs."
fn spec.columnLayout.columns.widgets.logsPanel.withFilter
withFilter(filter)
"A filter that chooses which log entries to return. See Advanced Logs Queries."
fn spec.columnLayout.columns.widgets.logsPanel.withResourceNames
withResourceNames(resourceNames)
"The names of logging resources to collect logs for."
fn spec.columnLayout.columns.widgets.logsPanel.withResourceNamesMixin
withResourceNamesMixin(resourceNames)
"The names of logging resources to collect logs for."
Note: This function appends passed data to existing values
obj spec.columnLayout.columns.widgets.logsPanel.resourceNames
"The names of logging resources to collect logs for."
fn spec.columnLayout.columns.widgets.logsPanel.resourceNames.withExternal
withExternal(external)
"The external name of the referenced resource"
fn spec.columnLayout.columns.widgets.logsPanel.resourceNames.withKind
withKind(kind)
"Kind of the referent."
fn spec.columnLayout.columns.widgets.logsPanel.resourceNames.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.columnLayout.columns.widgets.logsPanel.resourceNames.withNamespace
withNamespace(namespace)
"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"
obj spec.columnLayout.columns.widgets.pieChart
"A widget that displays timeseries data as a pie chart."
fn spec.columnLayout.columns.widgets.pieChart.withChartType
withChartType(chartType)
"Required. Indicates the visualization type for the PieChart."
fn spec.columnLayout.columns.widgets.pieChart.withDataSets
withDataSets(dataSets)
"Required. The queries for the chart's data."
fn spec.columnLayout.columns.widgets.pieChart.withDataSetsMixin
withDataSetsMixin(dataSets)
"Required. The queries for the chart's data."
Note: This function appends passed data to existing values
fn spec.columnLayout.columns.widgets.pieChart.withShowLabels
withShowLabels(showLabels)
"Optional. Indicates whether or not the pie chart should show slices' labels"
obj spec.columnLayout.columns.widgets.pieChart.dataSets
"Required. The queries for the chart's data."
fn spec.columnLayout.columns.widgets.pieChart.dataSets.withMinAlignmentPeriod
withMinAlignmentPeriod(minAlignmentPeriod)
"Optional. The lower bound on data point frequency for this data set."
fn spec.columnLayout.columns.widgets.pieChart.dataSets.withSliceNameTemplate
withSliceNameTemplate(sliceNameTemplate)
"Optional. A template for the name of the slice."
obj spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery
"Required. The query for the PieChart. See, google.monitoring.dashboard.v1.TimeSeriesQuery
."
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.withOutputFullDuration
withOutputFullDuration(outputFullDuration)
"Optional. If set, Cloud Monitoring will treat the full query duration as the alignment period so that there will be only 1 output value."
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.withPrometheusQuery
withPrometheusQuery(prometheusQuery)
"A query used to fetch time series with PromQL."
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.withTimeSeriesQueryLanguage
withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)
"A query used to fetch time series with MQL."
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.withUnitOverride
withUnitOverride(unitOverride)
"The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit
field in MetricDescriptor
."
obj spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter
"Filter parameters to fetch time series."
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.withFilter
withFilter(filter)
"Required. The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation
"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter
"Ranking based time series filter."
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withDirection
withDirection(direction)
"How to use the ranking to select time series that pass through the filter."
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withNumTimeSeries
withNumTimeSeries(numTimeSeries)
"How many time series to allow to pass through the filter."
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withRankingMethod
withRankingMethod(rankingMethod)
"ranking_method
is applied to each time series independently to produce the value which will be used to compare the time series to other time series."
obj spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation
"Apply a second aggregation after aggregation
is applied."
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio
"Parameters to fetch a ratio between two time series filters."
obj spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator
"The denominator of the ratio."
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.withFilter
withFilter(filter)
"The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation
"By default, the raw time series data is returned."
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator
"The numerator of the ratio."
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.withFilter
withFilter(filter)
"The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation
"By default, the raw time series data is returned."
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter
"Ranking based time series filter."
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withDirection
withDirection(direction)
"How to use the ranking to select time series that pass through the filter."
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withNumTimeSeries
withNumTimeSeries(numTimeSeries)
"How many time series to allow to pass through the filter."
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withRankingMethod
withRankingMethod(rankingMethod)
"ranking_method
is applied to each time series independently to produce the value which will be used to compare the time series to other time series."
obj spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation
"Apply a second aggregation after the ratio is computed."
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.columnLayout.columns.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.columnLayout.columns.widgets.scorecard
"A scorecard summarizing time series data."
fn spec.columnLayout.columns.widgets.scorecard.withBlankView
withBlankView(blankView)
"Will cause the Scorecard
to show only the value, with no indicator to its value relative to its thresholds."
fn spec.columnLayout.columns.widgets.scorecard.withBlankViewMixin
withBlankViewMixin(blankView)
"Will cause the Scorecard
to show only the value, with no indicator to its value relative to its thresholds."
Note: This function appends passed data to existing values
fn spec.columnLayout.columns.widgets.scorecard.withThresholds
withThresholds(thresholds)
"The thresholds used to determine the state of the scorecard given the time series' current value."
fn spec.columnLayout.columns.widgets.scorecard.withThresholdsMixin
withThresholdsMixin(thresholds)
"The thresholds used to determine the state of the scorecard given the time series' current value."
Note: This function appends passed data to existing values
obj spec.columnLayout.columns.widgets.scorecard.gaugeView
"Will cause the scorecard to show a gauge chart."
fn spec.columnLayout.columns.widgets.scorecard.gaugeView.withLowerBound
withLowerBound(lowerBound)
"The lower bound for this gauge chart. The value of the chart should always be greater than or equal to this."
fn spec.columnLayout.columns.widgets.scorecard.gaugeView.withUpperBound
withUpperBound(upperBound)
"The upper bound for this gauge chart. The value of the chart should always be less than or equal to this."
obj spec.columnLayout.columns.widgets.scorecard.sparkChartView
"Will cause the scorecard to show a spark chart."
fn spec.columnLayout.columns.widgets.scorecard.sparkChartView.withMinAlignmentPeriod
withMinAlignmentPeriod(minAlignmentPeriod)
"The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query."
fn spec.columnLayout.columns.widgets.scorecard.sparkChartView.withSparkChartType
withSparkChartType(sparkChartType)
"Required. The type of sparkchart to show in this chartView."
obj spec.columnLayout.columns.widgets.scorecard.thresholds
"The thresholds used to determine the state of the scorecard given the time series' current value."
fn spec.columnLayout.columns.widgets.scorecard.thresholds.withColor
withColor(color)
"The state color for this threshold. Color is not allowed in a XyChart."
fn spec.columnLayout.columns.widgets.scorecard.thresholds.withDirection
withDirection(direction)
"The direction for the current threshold. Direction is not allowed in a XyChart."
fn spec.columnLayout.columns.widgets.scorecard.thresholds.withLabel
withLabel(label)
"A label for the threshold."
fn spec.columnLayout.columns.widgets.scorecard.thresholds.withTargetAxis
withTargetAxis(targetAxis)
"The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard."
fn spec.columnLayout.columns.widgets.scorecard.thresholds.withValue
withValue(value)
"The value of the threshold. The value should be defined in the native scale of the metric."
obj spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery
"Required. Fields for querying time series data from the Stackdriver metrics API."
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.withOutputFullDuration
withOutputFullDuration(outputFullDuration)
"Optional. If set, Cloud Monitoring will treat the full query duration as the alignment period so that there will be only 1 output value."
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.withPrometheusQuery
withPrometheusQuery(prometheusQuery)
"A query used to fetch time series with PromQL."
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.withTimeSeriesQueryLanguage
withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)
"A query used to fetch time series with MQL."
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.withUnitOverride
withUnitOverride(unitOverride)
"The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit
field in MetricDescriptor
."
obj spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter
"Filter parameters to fetch time series."
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.withFilter
withFilter(filter)
"Required. The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation
"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter
"Ranking based time series filter."
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withDirection
withDirection(direction)
"How to use the ranking to select time series that pass through the filter."
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withNumTimeSeries
withNumTimeSeries(numTimeSeries)
"How many time series to allow to pass through the filter."
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withRankingMethod
withRankingMethod(rankingMethod)
"ranking_method
is applied to each time series independently to produce the value which will be used to compare the time series to other time series."
obj spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation
"Apply a second aggregation after aggregation
is applied."
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio
"Parameters to fetch a ratio between two time series filters."
obj spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator
"The denominator of the ratio."
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.withFilter
withFilter(filter)
"The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation
"By default, the raw time series data is returned."
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator
"The numerator of the ratio."
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.withFilter
withFilter(filter)
"The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation
"By default, the raw time series data is returned."
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter
"Ranking based time series filter."
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withDirection
withDirection(direction)
"How to use the ranking to select time series that pass through the filter."
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withNumTimeSeries
withNumTimeSeries(numTimeSeries)
"How many time series to allow to pass through the filter."
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withRankingMethod
withRankingMethod(rankingMethod)
"ranking_method
is applied to each time series independently to produce the value which will be used to compare the time series to other time series."
obj spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation
"Apply a second aggregation after the ratio is computed."
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.columnLayout.columns.widgets.sectionHeader
"A widget that defines a section header for easier navigation of the dashboard."
fn spec.columnLayout.columns.widgets.sectionHeader.withDividerBelow
withDividerBelow(dividerBelow)
"Whether to insert a divider below the section in the table of contents"
fn spec.columnLayout.columns.widgets.sectionHeader.withSubtitle
withSubtitle(subtitle)
"The subtitle of the section"
obj spec.columnLayout.columns.widgets.text
"A raw string or markdown displaying textual content."
fn spec.columnLayout.columns.widgets.text.withContent
withContent(content)
"The text content to be displayed."
fn spec.columnLayout.columns.widgets.text.withFormat
withFormat(format)
"How the text content is formatted."
obj spec.columnLayout.columns.widgets.text.style
"How the text is styled"
fn spec.columnLayout.columns.widgets.text.style.withBackgroundColor
withBackgroundColor(backgroundColor)
"The background color as a hex string. \"#RRGGBB\" or \"#RGB\
fn spec.columnLayout.columns.widgets.text.style.withFontSize
withFontSize(fontSize)
"Font sizes for both the title and content. The title will still be larger relative to the content."
fn spec.columnLayout.columns.widgets.text.style.withHorizontalAlignment
withHorizontalAlignment(horizontalAlignment)
"The horizontal alignment of both the title and content"
fn spec.columnLayout.columns.widgets.text.style.withPadding
withPadding(padding)
"The amount of padding around the widget"
fn spec.columnLayout.columns.widgets.text.style.withPointerLocation
withPointerLocation(pointerLocation)
"The pointer location for this widget (also sometimes called a \"tail\")"
fn spec.columnLayout.columns.widgets.text.style.withTextColor
withTextColor(textColor)
"The text color as a hex string. \"#RRGGBB\" or \"#RGB\
fn spec.columnLayout.columns.widgets.text.style.withVerticalAlignment
withVerticalAlignment(verticalAlignment)
"The vertical alignment of both the title and content"
obj spec.columnLayout.columns.widgets.timeSeriesTable
"A widget that displays time series data in a tabular format."
fn spec.columnLayout.columns.widgets.timeSeriesTable.withColumnSettings
withColumnSettings(columnSettings)
"Optional. The list of the persistent column settings for the table."
fn spec.columnLayout.columns.widgets.timeSeriesTable.withColumnSettingsMixin
withColumnSettingsMixin(columnSettings)
"Optional. The list of the persistent column settings for the table."
Note: This function appends passed data to existing values
fn spec.columnLayout.columns.widgets.timeSeriesTable.withDataSets
withDataSets(dataSets)
"Required. The data displayed in this table."
fn spec.columnLayout.columns.widgets.timeSeriesTable.withDataSetsMixin
withDataSetsMixin(dataSets)
"Required. The data displayed in this table."
Note: This function appends passed data to existing values
fn spec.columnLayout.columns.widgets.timeSeriesTable.withMetricVisualization
withMetricVisualization(metricVisualization)
"Optional. Store rendering strategy"
obj spec.columnLayout.columns.widgets.timeSeriesTable.columnSettings
"Optional. The list of the persistent column settings for the table."
fn spec.columnLayout.columns.widgets.timeSeriesTable.columnSettings.withColumn
withColumn(column)
"Required. The id of the column."
fn spec.columnLayout.columns.widgets.timeSeriesTable.columnSettings.withVisible
withVisible(visible)
"Required. Whether the column should be visible on page load."
obj spec.columnLayout.columns.widgets.timeSeriesTable.dataSets
"Required. The data displayed in this table."
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.withMinAlignmentPeriod
withMinAlignmentPeriod(minAlignmentPeriod)
"Optional. The lower bound on data point frequency for this data set."
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.withTableTemplate
withTableTemplate(tableTemplate)
"Optional. A template string for naming TimeSeries
in the resulting data set."
obj spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.tableDisplayOptions
"Optional. Table display options for configuring how the table is rendered."
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.tableDisplayOptions.withShownColumns
withShownColumns(shownColumns)
"Optional. This field is unused and has been replaced by TimeSeriesTable.column_settings"
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.tableDisplayOptions.withShownColumnsMixin
withShownColumnsMixin(shownColumns)
"Optional. This field is unused and has been replaced by TimeSeriesTable.column_settings"
Note: This function appends passed data to existing values
obj spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery
"Required. Fields for querying time series data from the Stackdriver metrics API."
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.withOutputFullDuration
withOutputFullDuration(outputFullDuration)
"Optional. If set, Cloud Monitoring will treat the full query duration as the alignment period so that there will be only 1 output value."
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.withPrometheusQuery
withPrometheusQuery(prometheusQuery)
"A query used to fetch time series with PromQL."
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.withTimeSeriesQueryLanguage
withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)
"A query used to fetch time series with MQL."
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.withUnitOverride
withUnitOverride(unitOverride)
"The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit
field in MetricDescriptor
."
obj spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter
"Filter parameters to fetch time series."
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.withFilter
withFilter(filter)
"Required. The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation
"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter
"Ranking based time series filter."
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withDirection
withDirection(direction)
"How to use the ranking to select time series that pass through the filter."
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withNumTimeSeries
withNumTimeSeries(numTimeSeries)
"How many time series to allow to pass through the filter."
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withRankingMethod
withRankingMethod(rankingMethod)
"ranking_method
is applied to each time series independently to produce the value which will be used to compare the time series to other time series."
obj spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation
"Apply a second aggregation after aggregation
is applied."
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio
"Parameters to fetch a ratio between two time series filters."
obj spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator
"The denominator of the ratio."
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.withFilter
withFilter(filter)
"The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation
"By default, the raw time series data is returned."
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator
"The numerator of the ratio."
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.withFilter
withFilter(filter)
"The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation
"By default, the raw time series data is returned."
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter
"Ranking based time series filter."
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withDirection
withDirection(direction)
"How to use the ranking to select time series that pass through the filter."
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withNumTimeSeries
withNumTimeSeries(numTimeSeries)
"How many time series to allow to pass through the filter."
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withRankingMethod
withRankingMethod(rankingMethod)
"ranking_method
is applied to each time series independently to produce the value which will be used to compare the time series to other time series."
obj spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation
"Apply a second aggregation after the ratio is computed."
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.columnLayout.columns.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.columnLayout.columns.widgets.xyChart
"A chart of time series data."
fn spec.columnLayout.columns.widgets.xyChart.withDataSets
withDataSets(dataSets)
"Required. The data displayed in this chart."
fn spec.columnLayout.columns.widgets.xyChart.withDataSetsMixin
withDataSetsMixin(dataSets)
"Required. The data displayed in this chart."
Note: This function appends passed data to existing values
fn spec.columnLayout.columns.widgets.xyChart.withThresholds
withThresholds(thresholds)
"Threshold lines drawn horizontally across the chart."
fn spec.columnLayout.columns.widgets.xyChart.withThresholdsMixin
withThresholdsMixin(thresholds)
"Threshold lines drawn horizontally across the chart."
Note: This function appends passed data to existing values
fn spec.columnLayout.columns.widgets.xyChart.withTimeshiftDuration
withTimeshiftDuration(timeshiftDuration)
"The duration used to display a comparison chart."
obj spec.columnLayout.columns.widgets.xyChart.chartOptions
"Display options for the chart."
fn spec.columnLayout.columns.widgets.xyChart.chartOptions.withMode
withMode(mode)
"The chart mode."
obj spec.columnLayout.columns.widgets.xyChart.dataSets
"Required. The data displayed in this chart."
fn spec.columnLayout.columns.widgets.xyChart.dataSets.withLegendTemplate
withLegendTemplate(legendTemplate)
"A template string for naming TimeSeries
in the resulting data set."
fn spec.columnLayout.columns.widgets.xyChart.dataSets.withMinAlignmentPeriod
withMinAlignmentPeriod(minAlignmentPeriod)
"Optional. The lower bound on data point frequency for this data set."
fn spec.columnLayout.columns.widgets.xyChart.dataSets.withPlotType
withPlotType(plotType)
"How this data should be plotted on the chart."
fn spec.columnLayout.columns.widgets.xyChart.dataSets.withTargetAxis
withTargetAxis(targetAxis)
"Optional. The target axis to use for plotting the metric."
obj spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery
"Fields for querying time series data from the Stackdriver metrics API."
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.withOutputFullDuration
withOutputFullDuration(outputFullDuration)
"Optional. If set, Cloud Monitoring will treat the full query duration as the alignment period so that there will be only 1 output value."
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.withPrometheusQuery
withPrometheusQuery(prometheusQuery)
"A query used to fetch time series with PromQL."
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.withTimeSeriesQueryLanguage
withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)
"A query used to fetch time series with MQL."
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.withUnitOverride
withUnitOverride(unitOverride)
"The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit
field in MetricDescriptor
."
obj spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter
"Filter parameters to fetch time series."
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.withFilter
withFilter(filter)
"Required. The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation
"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter
"Ranking based time series filter."
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withDirection
withDirection(direction)
"How to use the ranking to select time series that pass through the filter."
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withNumTimeSeries
withNumTimeSeries(numTimeSeries)
"How many time series to allow to pass through the filter."
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withRankingMethod
withRankingMethod(rankingMethod)
"ranking_method
is applied to each time series independently to produce the value which will be used to compare the time series to other time series."
obj spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation
"Apply a second aggregation after aggregation
is applied."
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio
"Parameters to fetch a ratio between two time series filters."
obj spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator
"The denominator of the ratio."
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.withFilter
withFilter(filter)
"The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation
"By default, the raw time series data is returned."
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator
"The numerator of the ratio."
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.withFilter
withFilter(filter)
"The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation
"By default, the raw time series data is returned."
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter
"Ranking based time series filter."
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withDirection
withDirection(direction)
"How to use the ranking to select time series that pass through the filter."
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withNumTimeSeries
withNumTimeSeries(numTimeSeries)
"How many time series to allow to pass through the filter."
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withRankingMethod
withRankingMethod(rankingMethod)
"ranking_method
is applied to each time series independently to produce the value which will be used to compare the time series to other time series."
obj spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation
"Apply a second aggregation after the ratio is computed."
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.columnLayout.columns.widgets.xyChart.thresholds
"Threshold lines drawn horizontally across the chart."
fn spec.columnLayout.columns.widgets.xyChart.thresholds.withColor
withColor(color)
"The state color for this threshold. Color is not allowed in a XyChart."
fn spec.columnLayout.columns.widgets.xyChart.thresholds.withDirection
withDirection(direction)
"The direction for the current threshold. Direction is not allowed in a XyChart."
fn spec.columnLayout.columns.widgets.xyChart.thresholds.withLabel
withLabel(label)
"A label for the threshold."
fn spec.columnLayout.columns.widgets.xyChart.thresholds.withTargetAxis
withTargetAxis(targetAxis)
"The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard."
fn spec.columnLayout.columns.widgets.xyChart.thresholds.withValue
withValue(value)
"The value of the threshold. The value should be defined in the native scale of the metric."
obj spec.columnLayout.columns.widgets.xyChart.xAxis
"The properties applied to the x-axis."
fn spec.columnLayout.columns.widgets.xyChart.xAxis.withLabel
withLabel(label)
"The label of the axis."
fn spec.columnLayout.columns.widgets.xyChart.xAxis.withScale
withScale(scale)
"The axis scale. By default, a linear scale is used."
obj spec.columnLayout.columns.widgets.xyChart.y2Axis
"The properties applied to the y2-axis."
fn spec.columnLayout.columns.widgets.xyChart.y2Axis.withLabel
withLabel(label)
"The label of the axis."
fn spec.columnLayout.columns.widgets.xyChart.y2Axis.withScale
withScale(scale)
"The axis scale. By default, a linear scale is used."
obj spec.columnLayout.columns.widgets.xyChart.yAxis
"The properties applied to the y-axis."
fn spec.columnLayout.columns.widgets.xyChart.yAxis.withLabel
withLabel(label)
"The label of the axis."
fn spec.columnLayout.columns.widgets.xyChart.yAxis.withScale
withScale(scale)
"The axis scale. By default, a linear scale is used."
obj spec.dashboardFilters
"Filters to reduce the amount of data charted based on the filter criteria."
fn spec.dashboardFilters.withFilterType
withFilterType(filterType)
"The specified filter type"
fn spec.dashboardFilters.withLabelKey
withLabelKey(labelKey)
"Required. The key for the label"
fn spec.dashboardFilters.withStringValue
withStringValue(stringValue)
"A variable-length string value."
fn spec.dashboardFilters.withTemplateVariable
withTemplateVariable(templateVariable)
"The placeholder text that can be referenced in a filter string or MQL query. If omitted, the dashboard filter will be applied to all relevant widgets in the dashboard."
obj spec.gridLayout
"Content is arranged with a basic layout that re-flows a simple list of informational elements like widgets or tiles."
fn spec.gridLayout.withColumns
withColumns(columns)
"The number of columns into which the view's width is divided. If omitted or set to zero, a system default will be used while rendering."
fn spec.gridLayout.withWidgets
withWidgets(widgets)
"The informational elements that are arranged into the columns row-first."
fn spec.gridLayout.withWidgetsMixin
withWidgetsMixin(widgets)
"The informational elements that are arranged into the columns row-first."
Note: This function appends passed data to existing values
obj spec.gridLayout.widgets
"The informational elements that are arranged into the columns row-first."
fn spec.gridLayout.widgets.withBlank
withBlank(blank)
"A blank space."
fn spec.gridLayout.widgets.withBlankMixin
withBlankMixin(blank)
"A blank space."
Note: This function appends passed data to existing values
fn spec.gridLayout.widgets.withId
withId(id)
"Optional. The widget id. Ids may be made up of alphanumerics, dashes and underscores. Widget ids are optional."
fn spec.gridLayout.widgets.withSingleViewGroup
withSingleViewGroup(singleViewGroup)
"A widget that groups the other widgets by using a dropdown menu."
fn spec.gridLayout.widgets.withSingleViewGroupMixin
withSingleViewGroupMixin(singleViewGroup)
"A widget that groups the other widgets by using a dropdown menu."
Note: This function appends passed data to existing values
fn spec.gridLayout.widgets.withTitle
withTitle(title)
"Optional. The title of the widget."
obj spec.gridLayout.widgets.alertChart
"A chart of alert policy data."
obj spec.gridLayout.widgets.alertChart.alertPolicyRef
"Required. A reference to the MonitoringAlertPolicy."
fn spec.gridLayout.widgets.alertChart.alertPolicyRef.withExternal
withExternal(external)
"The MonitoringAlertPolicy link in the form \"projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]\", when not managed by Config Connector."
fn spec.gridLayout.widgets.alertChart.alertPolicyRef.withName
withName(name)
"The name
field of a MonitoringAlertPolicy
resource."
fn spec.gridLayout.widgets.alertChart.alertPolicyRef.withNamespace
withNamespace(namespace)
"The namespace
field of a MonitoringAlertPolicy
resource."
obj spec.gridLayout.widgets.collapsibleGroup
"A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets."
fn spec.gridLayout.widgets.collapsibleGroup.withCollapsed
withCollapsed(collapsed)
"The collapsed state of the widget on first page load."
obj spec.gridLayout.widgets.errorReportingPanel
"A widget that displays a list of error groups."
fn spec.gridLayout.widgets.errorReportingPanel.withProjectRefs
withProjectRefs(projectRefs)
"The projects from which to gather errors."
fn spec.gridLayout.widgets.errorReportingPanel.withProjectRefsMixin
withProjectRefsMixin(projectRefs)
"The projects from which to gather errors."
Note: This function appends passed data to existing values
fn spec.gridLayout.widgets.errorReportingPanel.withServices
withServices(services)
"An identifier of the service, such as the name of the executable, job, or Google App Engine service name. This field is expected to have a low number of values that are relatively stable over time, as opposed to version
, which can be changed whenever new code is deployed."
fn spec.gridLayout.widgets.errorReportingPanel.withServicesMixin
withServicesMixin(services)
"An identifier of the service, such as the name of the executable, job, or Google App Engine service name. This field is expected to have a low number of values that are relatively stable over time, as opposed to version
, which can be changed whenever new code is deployed."
Note: This function appends passed data to existing values
fn spec.gridLayout.widgets.errorReportingPanel.withVersions
withVersions(versions)
"Represents the source code version that the developer provided, which could represent a version label or a Git SHA-1 hash, for example. For App Engine standard environment, the version is set to the version of the app."
fn spec.gridLayout.widgets.errorReportingPanel.withVersionsMixin
withVersionsMixin(versions)
"Represents the source code version that the developer provided, which could represent a version label or a Git SHA-1 hash, for example. For App Engine standard environment, the version is set to the version of the app."
Note: This function appends passed data to existing values
obj spec.gridLayout.widgets.errorReportingPanel.projectRefs
"The projects from which to gather errors."
fn spec.gridLayout.widgets.errorReportingPanel.projectRefs.withExternal
withExternal(external)
"The projectID
field of a project, when not managed by Config Connector."
fn spec.gridLayout.widgets.errorReportingPanel.projectRefs.withKind
withKind(kind)
"The kind of the Project resource; optional but must be Project
if provided."
fn spec.gridLayout.widgets.errorReportingPanel.projectRefs.withName
withName(name)
"The name
field of a Project
resource."
fn spec.gridLayout.widgets.errorReportingPanel.projectRefs.withNamespace
withNamespace(namespace)
"The namespace
field of a Project
resource."
obj spec.gridLayout.widgets.incidentList
"A widget that shows list of incidents."
fn spec.gridLayout.widgets.incidentList.withMonitoredResources
withMonitoredResources(monitoredResources)
"Optional. The monitored resource for which incidents are listed."
fn spec.gridLayout.widgets.incidentList.withMonitoredResourcesMixin
withMonitoredResourcesMixin(monitoredResources)
"Optional. The monitored resource for which incidents are listed."
Note: This function appends passed data to existing values
fn spec.gridLayout.widgets.incidentList.withPolicyRefs
withPolicyRefs(policyRefs)
"Optional. A list of alert policies to filter the incident list by."
fn spec.gridLayout.widgets.incidentList.withPolicyRefsMixin
withPolicyRefsMixin(policyRefs)
"Optional. A list of alert policies to filter the incident list by."
Note: This function appends passed data to existing values
obj spec.gridLayout.widgets.incidentList.monitoredResources
"Optional. The monitored resource for which incidents are listed."
fn spec.gridLayout.widgets.incidentList.monitoredResources.withLabels
withLabels(labels)
"Required. Values for all of the labels listed in the associated monitored resource descriptor."
fn spec.gridLayout.widgets.incidentList.monitoredResources.withLabelsMixin
withLabelsMixin(labels)
"Required. Values for all of the labels listed in the associated monitored resource descriptor."
Note: This function appends passed data to existing values
fn spec.gridLayout.widgets.incidentList.monitoredResources.withType
withType(type)
"Required. The monitored resource type. This field must match the type
field of a [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor] object."
obj spec.gridLayout.widgets.incidentList.policyRefs
"Optional. A list of alert policies to filter the incident list by."
fn spec.gridLayout.widgets.incidentList.policyRefs.withExternal
withExternal(external)
"The MonitoringAlertPolicy link in the form \"projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]\", when not managed by Config Connector."
fn spec.gridLayout.widgets.incidentList.policyRefs.withName
withName(name)
"The name
field of a MonitoringAlertPolicy
resource."
fn spec.gridLayout.widgets.incidentList.policyRefs.withNamespace
withNamespace(namespace)
"The namespace
field of a MonitoringAlertPolicy
resource."
obj spec.gridLayout.widgets.logsPanel
"A widget that shows a stream of logs."
fn spec.gridLayout.widgets.logsPanel.withFilter
withFilter(filter)
"A filter that chooses which log entries to return. See Advanced Logs Queries."
fn spec.gridLayout.widgets.logsPanel.withResourceNames
withResourceNames(resourceNames)
"The names of logging resources to collect logs for."
fn spec.gridLayout.widgets.logsPanel.withResourceNamesMixin
withResourceNamesMixin(resourceNames)
"The names of logging resources to collect logs for."
Note: This function appends passed data to existing values
obj spec.gridLayout.widgets.logsPanel.resourceNames
"The names of logging resources to collect logs for."
fn spec.gridLayout.widgets.logsPanel.resourceNames.withExternal
withExternal(external)
"The external name of the referenced resource"
fn spec.gridLayout.widgets.logsPanel.resourceNames.withKind
withKind(kind)
"Kind of the referent."
fn spec.gridLayout.widgets.logsPanel.resourceNames.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.gridLayout.widgets.logsPanel.resourceNames.withNamespace
withNamespace(namespace)
"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"
obj spec.gridLayout.widgets.pieChart
"A widget that displays timeseries data as a pie chart."
fn spec.gridLayout.widgets.pieChart.withChartType
withChartType(chartType)
"Required. Indicates the visualization type for the PieChart."
fn spec.gridLayout.widgets.pieChart.withDataSets
withDataSets(dataSets)
"Required. The queries for the chart's data."
fn spec.gridLayout.widgets.pieChart.withDataSetsMixin
withDataSetsMixin(dataSets)
"Required. The queries for the chart's data."
Note: This function appends passed data to existing values
fn spec.gridLayout.widgets.pieChart.withShowLabels
withShowLabels(showLabels)
"Optional. Indicates whether or not the pie chart should show slices' labels"
obj spec.gridLayout.widgets.pieChart.dataSets
"Required. The queries for the chart's data."
fn spec.gridLayout.widgets.pieChart.dataSets.withMinAlignmentPeriod
withMinAlignmentPeriod(minAlignmentPeriod)
"Optional. The lower bound on data point frequency for this data set."
fn spec.gridLayout.widgets.pieChart.dataSets.withSliceNameTemplate
withSliceNameTemplate(sliceNameTemplate)
"Optional. A template for the name of the slice."
obj spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery
"Required. The query for the PieChart. See, google.monitoring.dashboard.v1.TimeSeriesQuery
."
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.withOutputFullDuration
withOutputFullDuration(outputFullDuration)
"Optional. If set, Cloud Monitoring will treat the full query duration as the alignment period so that there will be only 1 output value."
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.withPrometheusQuery
withPrometheusQuery(prometheusQuery)
"A query used to fetch time series with PromQL."
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.withTimeSeriesQueryLanguage
withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)
"A query used to fetch time series with MQL."
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.withUnitOverride
withUnitOverride(unitOverride)
"The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit
field in MetricDescriptor
."
obj spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter
"Filter parameters to fetch time series."
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.withFilter
withFilter(filter)
"Required. The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation
"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter
"Ranking based time series filter."
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withDirection
withDirection(direction)
"How to use the ranking to select time series that pass through the filter."
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withNumTimeSeries
withNumTimeSeries(numTimeSeries)
"How many time series to allow to pass through the filter."
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withRankingMethod
withRankingMethod(rankingMethod)
"ranking_method
is applied to each time series independently to produce the value which will be used to compare the time series to other time series."
obj spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation
"Apply a second aggregation after aggregation
is applied."
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio
"Parameters to fetch a ratio between two time series filters."
obj spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator
"The denominator of the ratio."
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.withFilter
withFilter(filter)
"The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation
"By default, the raw time series data is returned."
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator
"The numerator of the ratio."
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.withFilter
withFilter(filter)
"The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation
"By default, the raw time series data is returned."
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter
"Ranking based time series filter."
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withDirection
withDirection(direction)
"How to use the ranking to select time series that pass through the filter."
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withNumTimeSeries
withNumTimeSeries(numTimeSeries)
"How many time series to allow to pass through the filter."
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withRankingMethod
withRankingMethod(rankingMethod)
"ranking_method
is applied to each time series independently to produce the value which will be used to compare the time series to other time series."
obj spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation
"Apply a second aggregation after the ratio is computed."
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.gridLayout.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.gridLayout.widgets.scorecard
"A scorecard summarizing time series data."
fn spec.gridLayout.widgets.scorecard.withBlankView
withBlankView(blankView)
"Will cause the Scorecard
to show only the value, with no indicator to its value relative to its thresholds."
fn spec.gridLayout.widgets.scorecard.withBlankViewMixin
withBlankViewMixin(blankView)
"Will cause the Scorecard
to show only the value, with no indicator to its value relative to its thresholds."
Note: This function appends passed data to existing values
fn spec.gridLayout.widgets.scorecard.withThresholds
withThresholds(thresholds)
"The thresholds used to determine the state of the scorecard given the time series' current value."
fn spec.gridLayout.widgets.scorecard.withThresholdsMixin
withThresholdsMixin(thresholds)
"The thresholds used to determine the state of the scorecard given the time series' current value."
Note: This function appends passed data to existing values
obj spec.gridLayout.widgets.scorecard.gaugeView
"Will cause the scorecard to show a gauge chart."
fn spec.gridLayout.widgets.scorecard.gaugeView.withLowerBound
withLowerBound(lowerBound)
"The lower bound for this gauge chart. The value of the chart should always be greater than or equal to this."
fn spec.gridLayout.widgets.scorecard.gaugeView.withUpperBound
withUpperBound(upperBound)
"The upper bound for this gauge chart. The value of the chart should always be less than or equal to this."
obj spec.gridLayout.widgets.scorecard.sparkChartView
"Will cause the scorecard to show a spark chart."
fn spec.gridLayout.widgets.scorecard.sparkChartView.withMinAlignmentPeriod
withMinAlignmentPeriod(minAlignmentPeriod)
"The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query."
fn spec.gridLayout.widgets.scorecard.sparkChartView.withSparkChartType
withSparkChartType(sparkChartType)
"Required. The type of sparkchart to show in this chartView."
obj spec.gridLayout.widgets.scorecard.thresholds
"The thresholds used to determine the state of the scorecard given the time series' current value."
fn spec.gridLayout.widgets.scorecard.thresholds.withColor
withColor(color)
"The state color for this threshold. Color is not allowed in a XyChart."
fn spec.gridLayout.widgets.scorecard.thresholds.withDirection
withDirection(direction)
"The direction for the current threshold. Direction is not allowed in a XyChart."
fn spec.gridLayout.widgets.scorecard.thresholds.withLabel
withLabel(label)
"A label for the threshold."
fn spec.gridLayout.widgets.scorecard.thresholds.withTargetAxis
withTargetAxis(targetAxis)
"The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard."
fn spec.gridLayout.widgets.scorecard.thresholds.withValue
withValue(value)
"The value of the threshold. The value should be defined in the native scale of the metric."
obj spec.gridLayout.widgets.scorecard.timeSeriesQuery
"Required. Fields for querying time series data from the Stackdriver metrics API."
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.withOutputFullDuration
withOutputFullDuration(outputFullDuration)
"Optional. If set, Cloud Monitoring will treat the full query duration as the alignment period so that there will be only 1 output value."
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.withPrometheusQuery
withPrometheusQuery(prometheusQuery)
"A query used to fetch time series with PromQL."
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.withTimeSeriesQueryLanguage
withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)
"A query used to fetch time series with MQL."
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.withUnitOverride
withUnitOverride(unitOverride)
"The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit
field in MetricDescriptor
."
obj spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilter
"Filter parameters to fetch time series."
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.withFilter
withFilter(filter)
"Required. The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation
"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter
"Ranking based time series filter."
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withDirection
withDirection(direction)
"How to use the ranking to select time series that pass through the filter."
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withNumTimeSeries
withNumTimeSeries(numTimeSeries)
"How many time series to allow to pass through the filter."
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withRankingMethod
withRankingMethod(rankingMethod)
"ranking_method
is applied to each time series independently to produce the value which will be used to compare the time series to other time series."
obj spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation
"Apply a second aggregation after aggregation
is applied."
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio
"Parameters to fetch a ratio between two time series filters."
obj spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator
"The denominator of the ratio."
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.withFilter
withFilter(filter)
"The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation
"By default, the raw time series data is returned."
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator
"The numerator of the ratio."
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.withFilter
withFilter(filter)
"The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation
"By default, the raw time series data is returned."
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter
"Ranking based time series filter."
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withDirection
withDirection(direction)
"How to use the ranking to select time series that pass through the filter."
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withNumTimeSeries
withNumTimeSeries(numTimeSeries)
"How many time series to allow to pass through the filter."
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withRankingMethod
withRankingMethod(rankingMethod)
"ranking_method
is applied to each time series independently to produce the value which will be used to compare the time series to other time series."
obj spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation
"Apply a second aggregation after the ratio is computed."
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.gridLayout.widgets.sectionHeader
"A widget that defines a section header for easier navigation of the dashboard."
fn spec.gridLayout.widgets.sectionHeader.withDividerBelow
withDividerBelow(dividerBelow)
"Whether to insert a divider below the section in the table of contents"
fn spec.gridLayout.widgets.sectionHeader.withSubtitle
withSubtitle(subtitle)
"The subtitle of the section"
obj spec.gridLayout.widgets.text
"A raw string or markdown displaying textual content."
fn spec.gridLayout.widgets.text.withContent
withContent(content)
"The text content to be displayed."
fn spec.gridLayout.widgets.text.withFormat
withFormat(format)
"How the text content is formatted."
obj spec.gridLayout.widgets.text.style
"How the text is styled"
fn spec.gridLayout.widgets.text.style.withBackgroundColor
withBackgroundColor(backgroundColor)
"The background color as a hex string. \"#RRGGBB\" or \"#RGB\
fn spec.gridLayout.widgets.text.style.withFontSize
withFontSize(fontSize)
"Font sizes for both the title and content. The title will still be larger relative to the content."
fn spec.gridLayout.widgets.text.style.withHorizontalAlignment
withHorizontalAlignment(horizontalAlignment)
"The horizontal alignment of both the title and content"
fn spec.gridLayout.widgets.text.style.withPadding
withPadding(padding)
"The amount of padding around the widget"
fn spec.gridLayout.widgets.text.style.withPointerLocation
withPointerLocation(pointerLocation)
"The pointer location for this widget (also sometimes called a \"tail\")"
fn spec.gridLayout.widgets.text.style.withTextColor
withTextColor(textColor)
"The text color as a hex string. \"#RRGGBB\" or \"#RGB\
fn spec.gridLayout.widgets.text.style.withVerticalAlignment
withVerticalAlignment(verticalAlignment)
"The vertical alignment of both the title and content"
obj spec.gridLayout.widgets.timeSeriesTable
"A widget that displays time series data in a tabular format."
fn spec.gridLayout.widgets.timeSeriesTable.withColumnSettings
withColumnSettings(columnSettings)
"Optional. The list of the persistent column settings for the table."
fn spec.gridLayout.widgets.timeSeriesTable.withColumnSettingsMixin
withColumnSettingsMixin(columnSettings)
"Optional. The list of the persistent column settings for the table."
Note: This function appends passed data to existing values
fn spec.gridLayout.widgets.timeSeriesTable.withDataSets
withDataSets(dataSets)
"Required. The data displayed in this table."
fn spec.gridLayout.widgets.timeSeriesTable.withDataSetsMixin
withDataSetsMixin(dataSets)
"Required. The data displayed in this table."
Note: This function appends passed data to existing values
fn spec.gridLayout.widgets.timeSeriesTable.withMetricVisualization
withMetricVisualization(metricVisualization)
"Optional. Store rendering strategy"
obj spec.gridLayout.widgets.timeSeriesTable.columnSettings
"Optional. The list of the persistent column settings for the table."
fn spec.gridLayout.widgets.timeSeriesTable.columnSettings.withColumn
withColumn(column)
"Required. The id of the column."
fn spec.gridLayout.widgets.timeSeriesTable.columnSettings.withVisible
withVisible(visible)
"Required. Whether the column should be visible on page load."
obj spec.gridLayout.widgets.timeSeriesTable.dataSets
"Required. The data displayed in this table."
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.withMinAlignmentPeriod
withMinAlignmentPeriod(minAlignmentPeriod)
"Optional. The lower bound on data point frequency for this data set."
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.withTableTemplate
withTableTemplate(tableTemplate)
"Optional. A template string for naming TimeSeries
in the resulting data set."
obj spec.gridLayout.widgets.timeSeriesTable.dataSets.tableDisplayOptions
"Optional. Table display options for configuring how the table is rendered."
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.tableDisplayOptions.withShownColumns
withShownColumns(shownColumns)
"Optional. This field is unused and has been replaced by TimeSeriesTable.column_settings"
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.tableDisplayOptions.withShownColumnsMixin
withShownColumnsMixin(shownColumns)
"Optional. This field is unused and has been replaced by TimeSeriesTable.column_settings"
Note: This function appends passed data to existing values
obj spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery
"Required. Fields for querying time series data from the Stackdriver metrics API."
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.withOutputFullDuration
withOutputFullDuration(outputFullDuration)
"Optional. If set, Cloud Monitoring will treat the full query duration as the alignment period so that there will be only 1 output value."
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.withPrometheusQuery
withPrometheusQuery(prometheusQuery)
"A query used to fetch time series with PromQL."
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.withTimeSeriesQueryLanguage
withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)
"A query used to fetch time series with MQL."
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.withUnitOverride
withUnitOverride(unitOverride)
"The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit
field in MetricDescriptor
."
obj spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter
"Filter parameters to fetch time series."
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.withFilter
withFilter(filter)
"Required. The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation
"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter
"Ranking based time series filter."
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withDirection
withDirection(direction)
"How to use the ranking to select time series that pass through the filter."
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withNumTimeSeries
withNumTimeSeries(numTimeSeries)
"How many time series to allow to pass through the filter."
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withRankingMethod
withRankingMethod(rankingMethod)
"ranking_method
is applied to each time series independently to produce the value which will be used to compare the time series to other time series."
obj spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation
"Apply a second aggregation after aggregation
is applied."
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio
"Parameters to fetch a ratio between two time series filters."
obj spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator
"The denominator of the ratio."
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.withFilter
withFilter(filter)
"The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation
"By default, the raw time series data is returned."
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator
"The numerator of the ratio."
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.withFilter
withFilter(filter)
"The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation
"By default, the raw time series data is returned."
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter
"Ranking based time series filter."
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withDirection
withDirection(direction)
"How to use the ranking to select time series that pass through the filter."
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withNumTimeSeries
withNumTimeSeries(numTimeSeries)
"How many time series to allow to pass through the filter."
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withRankingMethod
withRankingMethod(rankingMethod)
"ranking_method
is applied to each time series independently to produce the value which will be used to compare the time series to other time series."
obj spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation
"Apply a second aggregation after the ratio is computed."
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.gridLayout.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.gridLayout.widgets.xyChart
"A chart of time series data."
fn spec.gridLayout.widgets.xyChart.withDataSets
withDataSets(dataSets)
"Required. The data displayed in this chart."
fn spec.gridLayout.widgets.xyChart.withDataSetsMixin
withDataSetsMixin(dataSets)
"Required. The data displayed in this chart."
Note: This function appends passed data to existing values
fn spec.gridLayout.widgets.xyChart.withThresholds
withThresholds(thresholds)
"Threshold lines drawn horizontally across the chart."
fn spec.gridLayout.widgets.xyChart.withThresholdsMixin
withThresholdsMixin(thresholds)
"Threshold lines drawn horizontally across the chart."
Note: This function appends passed data to existing values
fn spec.gridLayout.widgets.xyChart.withTimeshiftDuration
withTimeshiftDuration(timeshiftDuration)
"The duration used to display a comparison chart."
obj spec.gridLayout.widgets.xyChart.chartOptions
"Display options for the chart."
fn spec.gridLayout.widgets.xyChart.chartOptions.withMode
withMode(mode)
"The chart mode."
obj spec.gridLayout.widgets.xyChart.dataSets
"Required. The data displayed in this chart."
fn spec.gridLayout.widgets.xyChart.dataSets.withLegendTemplate
withLegendTemplate(legendTemplate)
"A template string for naming TimeSeries
in the resulting data set."
fn spec.gridLayout.widgets.xyChart.dataSets.withMinAlignmentPeriod
withMinAlignmentPeriod(minAlignmentPeriod)
"Optional. The lower bound on data point frequency for this data set."
fn spec.gridLayout.widgets.xyChart.dataSets.withPlotType
withPlotType(plotType)
"How this data should be plotted on the chart."
fn spec.gridLayout.widgets.xyChart.dataSets.withTargetAxis
withTargetAxis(targetAxis)
"Optional. The target axis to use for plotting the metric."
obj spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery
"Fields for querying time series data from the Stackdriver metrics API."
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.withOutputFullDuration
withOutputFullDuration(outputFullDuration)
"Optional. If set, Cloud Monitoring will treat the full query duration as the alignment period so that there will be only 1 output value."
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.withPrometheusQuery
withPrometheusQuery(prometheusQuery)
"A query used to fetch time series with PromQL."
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.withTimeSeriesQueryLanguage
withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)
"A query used to fetch time series with MQL."
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.withUnitOverride
withUnitOverride(unitOverride)
"The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit
field in MetricDescriptor
."
obj spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter
"Filter parameters to fetch time series."
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.withFilter
withFilter(filter)
"Required. The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation
"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter
"Ranking based time series filter."
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withDirection
withDirection(direction)
"How to use the ranking to select time series that pass through the filter."
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withNumTimeSeries
withNumTimeSeries(numTimeSeries)
"How many time series to allow to pass through the filter."
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withRankingMethod
withRankingMethod(rankingMethod)
"ranking_method
is applied to each time series independently to produce the value which will be used to compare the time series to other time series."
obj spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation
"Apply a second aggregation after aggregation
is applied."
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio
"Parameters to fetch a ratio between two time series filters."
obj spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator
"The denominator of the ratio."
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.withFilter
withFilter(filter)
"The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation
"By default, the raw time series data is returned."
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator
"The numerator of the ratio."
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.withFilter
withFilter(filter)
"The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation
"By default, the raw time series data is returned."
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter
"Ranking based time series filter."
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withDirection
withDirection(direction)
"How to use the ranking to select time series that pass through the filter."
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withNumTimeSeries
withNumTimeSeries(numTimeSeries)
"How many time series to allow to pass through the filter."
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withRankingMethod
withRankingMethod(rankingMethod)
"ranking_method
is applied to each time series independently to produce the value which will be used to compare the time series to other time series."
obj spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation
"Apply a second aggregation after the ratio is computed."
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.gridLayout.widgets.xyChart.thresholds
"Threshold lines drawn horizontally across the chart."
fn spec.gridLayout.widgets.xyChart.thresholds.withColor
withColor(color)
"The state color for this threshold. Color is not allowed in a XyChart."
fn spec.gridLayout.widgets.xyChart.thresholds.withDirection
withDirection(direction)
"The direction for the current threshold. Direction is not allowed in a XyChart."
fn spec.gridLayout.widgets.xyChart.thresholds.withLabel
withLabel(label)
"A label for the threshold."
fn spec.gridLayout.widgets.xyChart.thresholds.withTargetAxis
withTargetAxis(targetAxis)
"The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard."
fn spec.gridLayout.widgets.xyChart.thresholds.withValue
withValue(value)
"The value of the threshold. The value should be defined in the native scale of the metric."
obj spec.gridLayout.widgets.xyChart.xAxis
"The properties applied to the x-axis."
fn spec.gridLayout.widgets.xyChart.xAxis.withLabel
withLabel(label)
"The label of the axis."
fn spec.gridLayout.widgets.xyChart.xAxis.withScale
withScale(scale)
"The axis scale. By default, a linear scale is used."
obj spec.gridLayout.widgets.xyChart.y2Axis
"The properties applied to the y2-axis."
fn spec.gridLayout.widgets.xyChart.y2Axis.withLabel
withLabel(label)
"The label of the axis."
fn spec.gridLayout.widgets.xyChart.y2Axis.withScale
withScale(scale)
"The axis scale. By default, a linear scale is used."
obj spec.gridLayout.widgets.xyChart.yAxis
"The properties applied to the y-axis."
fn spec.gridLayout.widgets.xyChart.yAxis.withLabel
withLabel(label)
"The label of the axis."
fn spec.gridLayout.widgets.xyChart.yAxis.withScale
withScale(scale)
"The axis scale. By default, a linear scale is used."
obj spec.mosaicLayout
"The content is arranged as a grid of tiles, with each content widget occupying one or more grid blocks."
fn spec.mosaicLayout.withColumns
withColumns(columns)
"The number of columns in the mosaic grid. The number of columns must be between 1 and 12, inclusive."
fn spec.mosaicLayout.withTiles
withTiles(tiles)
"The tiles to display."
fn spec.mosaicLayout.withTilesMixin
withTilesMixin(tiles)
"The tiles to display."
Note: This function appends passed data to existing values
obj spec.mosaicLayout.tiles
"The tiles to display."
fn spec.mosaicLayout.tiles.withHeight
withHeight(height)
"The height of the tile, measured in grid blocks. Tiles must have a minimum height of 1."
fn spec.mosaicLayout.tiles.withWidth
withWidth(width)
"The width of the tile, measured in grid blocks. Tiles must have a minimum width of 1."
fn spec.mosaicLayout.tiles.withXPos
withXPos(xPos)
"The zero-indexed position of the tile in grid blocks relative to the left edge of the grid. Tiles must be contained within the specified number of columns. x_pos
cannot be negative."
fn spec.mosaicLayout.tiles.withYPos
withYPos(yPos)
"The zero-indexed position of the tile in grid blocks relative to the top edge of the grid. y_pos
cannot be negative."
obj spec.mosaicLayout.tiles.widget
"The informational widget contained in the tile. For example an XyChart
."
fn spec.mosaicLayout.tiles.widget.withBlank
withBlank(blank)
"A blank space."
fn spec.mosaicLayout.tiles.widget.withBlankMixin
withBlankMixin(blank)
"A blank space."
Note: This function appends passed data to existing values
fn spec.mosaicLayout.tiles.widget.withId
withId(id)
"Optional. The widget id. Ids may be made up of alphanumerics, dashes and underscores. Widget ids are optional."
fn spec.mosaicLayout.tiles.widget.withSingleViewGroup
withSingleViewGroup(singleViewGroup)
"A widget that groups the other widgets by using a dropdown menu."
fn spec.mosaicLayout.tiles.widget.withSingleViewGroupMixin
withSingleViewGroupMixin(singleViewGroup)
"A widget that groups the other widgets by using a dropdown menu."
Note: This function appends passed data to existing values
fn spec.mosaicLayout.tiles.widget.withTitle
withTitle(title)
"Optional. The title of the widget."
obj spec.mosaicLayout.tiles.widget.alertChart
"A chart of alert policy data."
obj spec.mosaicLayout.tiles.widget.alertChart.alertPolicyRef
"Required. A reference to the MonitoringAlertPolicy."
fn spec.mosaicLayout.tiles.widget.alertChart.alertPolicyRef.withExternal
withExternal(external)
"The MonitoringAlertPolicy link in the form \"projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]\", when not managed by Config Connector."
fn spec.mosaicLayout.tiles.widget.alertChart.alertPolicyRef.withName
withName(name)
"The name
field of a MonitoringAlertPolicy
resource."
fn spec.mosaicLayout.tiles.widget.alertChart.alertPolicyRef.withNamespace
withNamespace(namespace)
"The namespace
field of a MonitoringAlertPolicy
resource."
obj spec.mosaicLayout.tiles.widget.collapsibleGroup
"A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets."
fn spec.mosaicLayout.tiles.widget.collapsibleGroup.withCollapsed
withCollapsed(collapsed)
"The collapsed state of the widget on first page load."
obj spec.mosaicLayout.tiles.widget.errorReportingPanel
"A widget that displays a list of error groups."
fn spec.mosaicLayout.tiles.widget.errorReportingPanel.withProjectRefs
withProjectRefs(projectRefs)
"The projects from which to gather errors."
fn spec.mosaicLayout.tiles.widget.errorReportingPanel.withProjectRefsMixin
withProjectRefsMixin(projectRefs)
"The projects from which to gather errors."
Note: This function appends passed data to existing values
fn spec.mosaicLayout.tiles.widget.errorReportingPanel.withServices
withServices(services)
"An identifier of the service, such as the name of the executable, job, or Google App Engine service name. This field is expected to have a low number of values that are relatively stable over time, as opposed to version
, which can be changed whenever new code is deployed."
fn spec.mosaicLayout.tiles.widget.errorReportingPanel.withServicesMixin
withServicesMixin(services)
"An identifier of the service, such as the name of the executable, job, or Google App Engine service name. This field is expected to have a low number of values that are relatively stable over time, as opposed to version
, which can be changed whenever new code is deployed."
Note: This function appends passed data to existing values
fn spec.mosaicLayout.tiles.widget.errorReportingPanel.withVersions
withVersions(versions)
"Represents the source code version that the developer provided, which could represent a version label or a Git SHA-1 hash, for example. For App Engine standard environment, the version is set to the version of the app."
fn spec.mosaicLayout.tiles.widget.errorReportingPanel.withVersionsMixin
withVersionsMixin(versions)
"Represents the source code version that the developer provided, which could represent a version label or a Git SHA-1 hash, for example. For App Engine standard environment, the version is set to the version of the app."
Note: This function appends passed data to existing values
obj spec.mosaicLayout.tiles.widget.errorReportingPanel.projectRefs
"The projects from which to gather errors."
fn spec.mosaicLayout.tiles.widget.errorReportingPanel.projectRefs.withExternal
withExternal(external)
"The projectID
field of a project, when not managed by Config Connector."
fn spec.mosaicLayout.tiles.widget.errorReportingPanel.projectRefs.withKind
withKind(kind)
"The kind of the Project resource; optional but must be Project
if provided."
fn spec.mosaicLayout.tiles.widget.errorReportingPanel.projectRefs.withName
withName(name)
"The name
field of a Project
resource."
fn spec.mosaicLayout.tiles.widget.errorReportingPanel.projectRefs.withNamespace
withNamespace(namespace)
"The namespace
field of a Project
resource."
obj spec.mosaicLayout.tiles.widget.incidentList
"A widget that shows list of incidents."
fn spec.mosaicLayout.tiles.widget.incidentList.withMonitoredResources
withMonitoredResources(monitoredResources)
"Optional. The monitored resource for which incidents are listed."
fn spec.mosaicLayout.tiles.widget.incidentList.withMonitoredResourcesMixin
withMonitoredResourcesMixin(monitoredResources)
"Optional. The monitored resource for which incidents are listed."
Note: This function appends passed data to existing values
fn spec.mosaicLayout.tiles.widget.incidentList.withPolicyRefs
withPolicyRefs(policyRefs)
"Optional. A list of alert policies to filter the incident list by."
fn spec.mosaicLayout.tiles.widget.incidentList.withPolicyRefsMixin
withPolicyRefsMixin(policyRefs)
"Optional. A list of alert policies to filter the incident list by."
Note: This function appends passed data to existing values
obj spec.mosaicLayout.tiles.widget.incidentList.monitoredResources
"Optional. The monitored resource for which incidents are listed."
fn spec.mosaicLayout.tiles.widget.incidentList.monitoredResources.withLabels
withLabels(labels)
"Required. Values for all of the labels listed in the associated monitored resource descriptor."
fn spec.mosaicLayout.tiles.widget.incidentList.monitoredResources.withLabelsMixin
withLabelsMixin(labels)
"Required. Values for all of the labels listed in the associated monitored resource descriptor."
Note: This function appends passed data to existing values
fn spec.mosaicLayout.tiles.widget.incidentList.monitoredResources.withType
withType(type)
"Required. The monitored resource type. This field must match the type
field of a [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor] object."
obj spec.mosaicLayout.tiles.widget.incidentList.policyRefs
"Optional. A list of alert policies to filter the incident list by."
fn spec.mosaicLayout.tiles.widget.incidentList.policyRefs.withExternal
withExternal(external)
"The MonitoringAlertPolicy link in the form \"projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]\", when not managed by Config Connector."
fn spec.mosaicLayout.tiles.widget.incidentList.policyRefs.withName
withName(name)
"The name
field of a MonitoringAlertPolicy
resource."
fn spec.mosaicLayout.tiles.widget.incidentList.policyRefs.withNamespace
withNamespace(namespace)
"The namespace
field of a MonitoringAlertPolicy
resource."
obj spec.mosaicLayout.tiles.widget.logsPanel
"A widget that shows a stream of logs."
fn spec.mosaicLayout.tiles.widget.logsPanel.withFilter
withFilter(filter)
"A filter that chooses which log entries to return. See Advanced Logs Queries."
fn spec.mosaicLayout.tiles.widget.logsPanel.withResourceNames
withResourceNames(resourceNames)
"The names of logging resources to collect logs for."
fn spec.mosaicLayout.tiles.widget.logsPanel.withResourceNamesMixin
withResourceNamesMixin(resourceNames)
"The names of logging resources to collect logs for."
Note: This function appends passed data to existing values
obj spec.mosaicLayout.tiles.widget.logsPanel.resourceNames
"The names of logging resources to collect logs for."
fn spec.mosaicLayout.tiles.widget.logsPanel.resourceNames.withExternal
withExternal(external)
"The external name of the referenced resource"
fn spec.mosaicLayout.tiles.widget.logsPanel.resourceNames.withKind
withKind(kind)
"Kind of the referent."
fn spec.mosaicLayout.tiles.widget.logsPanel.resourceNames.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.mosaicLayout.tiles.widget.logsPanel.resourceNames.withNamespace
withNamespace(namespace)
"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"
obj spec.mosaicLayout.tiles.widget.pieChart
"A widget that displays timeseries data as a pie chart."
fn spec.mosaicLayout.tiles.widget.pieChart.withChartType
withChartType(chartType)
"Required. Indicates the visualization type for the PieChart."
fn spec.mosaicLayout.tiles.widget.pieChart.withDataSets
withDataSets(dataSets)
"Required. The queries for the chart's data."
fn spec.mosaicLayout.tiles.widget.pieChart.withDataSetsMixin
withDataSetsMixin(dataSets)
"Required. The queries for the chart's data."
Note: This function appends passed data to existing values
fn spec.mosaicLayout.tiles.widget.pieChart.withShowLabels
withShowLabels(showLabels)
"Optional. Indicates whether or not the pie chart should show slices' labels"
obj spec.mosaicLayout.tiles.widget.pieChart.dataSets
"Required. The queries for the chart's data."
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.withMinAlignmentPeriod
withMinAlignmentPeriod(minAlignmentPeriod)
"Optional. The lower bound on data point frequency for this data set."
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.withSliceNameTemplate
withSliceNameTemplate(sliceNameTemplate)
"Optional. A template for the name of the slice."
obj spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery
"Required. The query for the PieChart. See, google.monitoring.dashboard.v1.TimeSeriesQuery
."
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.withOutputFullDuration
withOutputFullDuration(outputFullDuration)
"Optional. If set, Cloud Monitoring will treat the full query duration as the alignment period so that there will be only 1 output value."
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.withPrometheusQuery
withPrometheusQuery(prometheusQuery)
"A query used to fetch time series with PromQL."
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.withTimeSeriesQueryLanguage
withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)
"A query used to fetch time series with MQL."
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.withUnitOverride
withUnitOverride(unitOverride)
"The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit
field in MetricDescriptor
."
obj spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter
"Filter parameters to fetch time series."
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.withFilter
withFilter(filter)
"Required. The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation
"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter
"Ranking based time series filter."
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withDirection
withDirection(direction)
"How to use the ranking to select time series that pass through the filter."
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withNumTimeSeries
withNumTimeSeries(numTimeSeries)
"How many time series to allow to pass through the filter."
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withRankingMethod
withRankingMethod(rankingMethod)
"ranking_method
is applied to each time series independently to produce the value which will be used to compare the time series to other time series."
obj spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation
"Apply a second aggregation after aggregation
is applied."
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio
"Parameters to fetch a ratio between two time series filters."
obj spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator
"The denominator of the ratio."
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.withFilter
withFilter(filter)
"The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation
"By default, the raw time series data is returned."
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator
"The numerator of the ratio."
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.withFilter
withFilter(filter)
"The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation
"By default, the raw time series data is returned."
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter
"Ranking based time series filter."
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withDirection
withDirection(direction)
"How to use the ranking to select time series that pass through the filter."
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withNumTimeSeries
withNumTimeSeries(numTimeSeries)
"How many time series to allow to pass through the filter."
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withRankingMethod
withRankingMethod(rankingMethod)
"ranking_method
is applied to each time series independently to produce the value which will be used to compare the time series to other time series."
obj spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation
"Apply a second aggregation after the ratio is computed."
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.mosaicLayout.tiles.widget.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.mosaicLayout.tiles.widget.scorecard
"A scorecard summarizing time series data."
fn spec.mosaicLayout.tiles.widget.scorecard.withBlankView
withBlankView(blankView)
"Will cause the Scorecard
to show only the value, with no indicator to its value relative to its thresholds."
fn spec.mosaicLayout.tiles.widget.scorecard.withBlankViewMixin
withBlankViewMixin(blankView)
"Will cause the Scorecard
to show only the value, with no indicator to its value relative to its thresholds."
Note: This function appends passed data to existing values
fn spec.mosaicLayout.tiles.widget.scorecard.withThresholds
withThresholds(thresholds)
"The thresholds used to determine the state of the scorecard given the time series' current value."
fn spec.mosaicLayout.tiles.widget.scorecard.withThresholdsMixin
withThresholdsMixin(thresholds)
"The thresholds used to determine the state of the scorecard given the time series' current value."
Note: This function appends passed data to existing values
obj spec.mosaicLayout.tiles.widget.scorecard.gaugeView
"Will cause the scorecard to show a gauge chart."
fn spec.mosaicLayout.tiles.widget.scorecard.gaugeView.withLowerBound
withLowerBound(lowerBound)
"The lower bound for this gauge chart. The value of the chart should always be greater than or equal to this."
fn spec.mosaicLayout.tiles.widget.scorecard.gaugeView.withUpperBound
withUpperBound(upperBound)
"The upper bound for this gauge chart. The value of the chart should always be less than or equal to this."
obj spec.mosaicLayout.tiles.widget.scorecard.sparkChartView
"Will cause the scorecard to show a spark chart."
fn spec.mosaicLayout.tiles.widget.scorecard.sparkChartView.withMinAlignmentPeriod
withMinAlignmentPeriod(minAlignmentPeriod)
"The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query."
fn spec.mosaicLayout.tiles.widget.scorecard.sparkChartView.withSparkChartType
withSparkChartType(sparkChartType)
"Required. The type of sparkchart to show in this chartView."
obj spec.mosaicLayout.tiles.widget.scorecard.thresholds
"The thresholds used to determine the state of the scorecard given the time series' current value."
fn spec.mosaicLayout.tiles.widget.scorecard.thresholds.withColor
withColor(color)
"The state color for this threshold. Color is not allowed in a XyChart."
fn spec.mosaicLayout.tiles.widget.scorecard.thresholds.withDirection
withDirection(direction)
"The direction for the current threshold. Direction is not allowed in a XyChart."
fn spec.mosaicLayout.tiles.widget.scorecard.thresholds.withLabel
withLabel(label)
"A label for the threshold."
fn spec.mosaicLayout.tiles.widget.scorecard.thresholds.withTargetAxis
withTargetAxis(targetAxis)
"The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard."
fn spec.mosaicLayout.tiles.widget.scorecard.thresholds.withValue
withValue(value)
"The value of the threshold. The value should be defined in the native scale of the metric."
obj spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery
"Required. Fields for querying time series data from the Stackdriver metrics API."
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.withOutputFullDuration
withOutputFullDuration(outputFullDuration)
"Optional. If set, Cloud Monitoring will treat the full query duration as the alignment period so that there will be only 1 output value."
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.withPrometheusQuery
withPrometheusQuery(prometheusQuery)
"A query used to fetch time series with PromQL."
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.withTimeSeriesQueryLanguage
withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)
"A query used to fetch time series with MQL."
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.withUnitOverride
withUnitOverride(unitOverride)
"The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit
field in MetricDescriptor
."
obj spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter
"Filter parameters to fetch time series."
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter.withFilter
withFilter(filter)
"Required. The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation
"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter
"Ranking based time series filter."
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withDirection
withDirection(direction)
"How to use the ranking to select time series that pass through the filter."
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withNumTimeSeries
withNumTimeSeries(numTimeSeries)
"How many time series to allow to pass through the filter."
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withRankingMethod
withRankingMethod(rankingMethod)
"ranking_method
is applied to each time series independently to produce the value which will be used to compare the time series to other time series."
obj spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation
"Apply a second aggregation after aggregation
is applied."
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio
"Parameters to fetch a ratio between two time series filters."
obj spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator
"The denominator of the ratio."
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.withFilter
withFilter(filter)
"The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation
"By default, the raw time series data is returned."
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator
"The numerator of the ratio."
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.withFilter
withFilter(filter)
"The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation
"By default, the raw time series data is returned."
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter
"Ranking based time series filter."
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withDirection
withDirection(direction)
"How to use the ranking to select time series that pass through the filter."
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withNumTimeSeries
withNumTimeSeries(numTimeSeries)
"How many time series to allow to pass through the filter."
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withRankingMethod
withRankingMethod(rankingMethod)
"ranking_method
is applied to each time series independently to produce the value which will be used to compare the time series to other time series."
obj spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation
"Apply a second aggregation after the ratio is computed."
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.mosaicLayout.tiles.widget.sectionHeader
"A widget that defines a section header for easier navigation of the dashboard."
fn spec.mosaicLayout.tiles.widget.sectionHeader.withDividerBelow
withDividerBelow(dividerBelow)
"Whether to insert a divider below the section in the table of contents"
fn spec.mosaicLayout.tiles.widget.sectionHeader.withSubtitle
withSubtitle(subtitle)
"The subtitle of the section"
obj spec.mosaicLayout.tiles.widget.text
"A raw string or markdown displaying textual content."
fn spec.mosaicLayout.tiles.widget.text.withContent
withContent(content)
"The text content to be displayed."
fn spec.mosaicLayout.tiles.widget.text.withFormat
withFormat(format)
"How the text content is formatted."
obj spec.mosaicLayout.tiles.widget.text.style
"How the text is styled"
fn spec.mosaicLayout.tiles.widget.text.style.withBackgroundColor
withBackgroundColor(backgroundColor)
"The background color as a hex string. \"#RRGGBB\" or \"#RGB\
fn spec.mosaicLayout.tiles.widget.text.style.withFontSize
withFontSize(fontSize)
"Font sizes for both the title and content. The title will still be larger relative to the content."
fn spec.mosaicLayout.tiles.widget.text.style.withHorizontalAlignment
withHorizontalAlignment(horizontalAlignment)
"The horizontal alignment of both the title and content"
fn spec.mosaicLayout.tiles.widget.text.style.withPadding
withPadding(padding)
"The amount of padding around the widget"
fn spec.mosaicLayout.tiles.widget.text.style.withPointerLocation
withPointerLocation(pointerLocation)
"The pointer location for this widget (also sometimes called a \"tail\")"
fn spec.mosaicLayout.tiles.widget.text.style.withTextColor
withTextColor(textColor)
"The text color as a hex string. \"#RRGGBB\" or \"#RGB\
fn spec.mosaicLayout.tiles.widget.text.style.withVerticalAlignment
withVerticalAlignment(verticalAlignment)
"The vertical alignment of both the title and content"
obj spec.mosaicLayout.tiles.widget.timeSeriesTable
"A widget that displays time series data in a tabular format."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.withColumnSettings
withColumnSettings(columnSettings)
"Optional. The list of the persistent column settings for the table."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.withColumnSettingsMixin
withColumnSettingsMixin(columnSettings)
"Optional. The list of the persistent column settings for the table."
Note: This function appends passed data to existing values
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.withDataSets
withDataSets(dataSets)
"Required. The data displayed in this table."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.withDataSetsMixin
withDataSetsMixin(dataSets)
"Required. The data displayed in this table."
Note: This function appends passed data to existing values
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.withMetricVisualization
withMetricVisualization(metricVisualization)
"Optional. Store rendering strategy"
obj spec.mosaicLayout.tiles.widget.timeSeriesTable.columnSettings
"Optional. The list of the persistent column settings for the table."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.columnSettings.withColumn
withColumn(column)
"Required. The id of the column."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.columnSettings.withVisible
withVisible(visible)
"Required. Whether the column should be visible on page load."
obj spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets
"Required. The data displayed in this table."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.withMinAlignmentPeriod
withMinAlignmentPeriod(minAlignmentPeriod)
"Optional. The lower bound on data point frequency for this data set."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.withTableTemplate
withTableTemplate(tableTemplate)
"Optional. A template string for naming TimeSeries
in the resulting data set."
obj spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.tableDisplayOptions
"Optional. Table display options for configuring how the table is rendered."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.tableDisplayOptions.withShownColumns
withShownColumns(shownColumns)
"Optional. This field is unused and has been replaced by TimeSeriesTable.column_settings"
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.tableDisplayOptions.withShownColumnsMixin
withShownColumnsMixin(shownColumns)
"Optional. This field is unused and has been replaced by TimeSeriesTable.column_settings"
Note: This function appends passed data to existing values
obj spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery
"Required. Fields for querying time series data from the Stackdriver metrics API."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.withOutputFullDuration
withOutputFullDuration(outputFullDuration)
"Optional. If set, Cloud Monitoring will treat the full query duration as the alignment period so that there will be only 1 output value."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.withPrometheusQuery
withPrometheusQuery(prometheusQuery)
"A query used to fetch time series with PromQL."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.withTimeSeriesQueryLanguage
withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)
"A query used to fetch time series with MQL."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.withUnitOverride
withUnitOverride(unitOverride)
"The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit
field in MetricDescriptor
."
obj spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter
"Filter parameters to fetch time series."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.withFilter
withFilter(filter)
"Required. The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation
"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter
"Ranking based time series filter."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withDirection
withDirection(direction)
"How to use the ranking to select time series that pass through the filter."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withNumTimeSeries
withNumTimeSeries(numTimeSeries)
"How many time series to allow to pass through the filter."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withRankingMethod
withRankingMethod(rankingMethod)
"ranking_method
is applied to each time series independently to produce the value which will be used to compare the time series to other time series."
obj spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation
"Apply a second aggregation after aggregation
is applied."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio
"Parameters to fetch a ratio between two time series filters."
obj spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator
"The denominator of the ratio."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.withFilter
withFilter(filter)
"The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation
"By default, the raw time series data is returned."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator
"The numerator of the ratio."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.withFilter
withFilter(filter)
"The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation
"By default, the raw time series data is returned."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter
"Ranking based time series filter."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withDirection
withDirection(direction)
"How to use the ranking to select time series that pass through the filter."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withNumTimeSeries
withNumTimeSeries(numTimeSeries)
"How many time series to allow to pass through the filter."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withRankingMethod
withRankingMethod(rankingMethod)
"ranking_method
is applied to each time series independently to produce the value which will be used to compare the time series to other time series."
obj spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation
"Apply a second aggregation after the ratio is computed."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.mosaicLayout.tiles.widget.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.mosaicLayout.tiles.widget.xyChart
"A chart of time series data."
fn spec.mosaicLayout.tiles.widget.xyChart.withDataSets
withDataSets(dataSets)
"Required. The data displayed in this chart."
fn spec.mosaicLayout.tiles.widget.xyChart.withDataSetsMixin
withDataSetsMixin(dataSets)
"Required. The data displayed in this chart."
Note: This function appends passed data to existing values
fn spec.mosaicLayout.tiles.widget.xyChart.withThresholds
withThresholds(thresholds)
"Threshold lines drawn horizontally across the chart."
fn spec.mosaicLayout.tiles.widget.xyChart.withThresholdsMixin
withThresholdsMixin(thresholds)
"Threshold lines drawn horizontally across the chart."
Note: This function appends passed data to existing values
fn spec.mosaicLayout.tiles.widget.xyChart.withTimeshiftDuration
withTimeshiftDuration(timeshiftDuration)
"The duration used to display a comparison chart."
obj spec.mosaicLayout.tiles.widget.xyChart.chartOptions
"Display options for the chart."
fn spec.mosaicLayout.tiles.widget.xyChart.chartOptions.withMode
withMode(mode)
"The chart mode."
obj spec.mosaicLayout.tiles.widget.xyChart.dataSets
"Required. The data displayed in this chart."
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.withLegendTemplate
withLegendTemplate(legendTemplate)
"A template string for naming TimeSeries
in the resulting data set."
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.withMinAlignmentPeriod
withMinAlignmentPeriod(minAlignmentPeriod)
"Optional. The lower bound on data point frequency for this data set."
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.withPlotType
withPlotType(plotType)
"How this data should be plotted on the chart."
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.withTargetAxis
withTargetAxis(targetAxis)
"Optional. The target axis to use for plotting the metric."
obj spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery
"Fields for querying time series data from the Stackdriver metrics API."
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.withOutputFullDuration
withOutputFullDuration(outputFullDuration)
"Optional. If set, Cloud Monitoring will treat the full query duration as the alignment period so that there will be only 1 output value."
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.withPrometheusQuery
withPrometheusQuery(prometheusQuery)
"A query used to fetch time series with PromQL."
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.withTimeSeriesQueryLanguage
withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)
"A query used to fetch time series with MQL."
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.withUnitOverride
withUnitOverride(unitOverride)
"The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit
field in MetricDescriptor
."
obj spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter
"Filter parameters to fetch time series."
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.withFilter
withFilter(filter)
"Required. The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation
"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter
"Ranking based time series filter."
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withDirection
withDirection(direction)
"How to use the ranking to select time series that pass through the filter."
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withNumTimeSeries
withNumTimeSeries(numTimeSeries)
"How many time series to allow to pass through the filter."
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withRankingMethod
withRankingMethod(rankingMethod)
"ranking_method
is applied to each time series independently to produce the value which will be used to compare the time series to other time series."
obj spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation
"Apply a second aggregation after aggregation
is applied."
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio
"Parameters to fetch a ratio between two time series filters."
obj spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator
"The denominator of the ratio."
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.withFilter
withFilter(filter)
"The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation
"By default, the raw time series data is returned."
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator
"The numerator of the ratio."
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.withFilter
withFilter(filter)
"The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation
"By default, the raw time series data is returned."
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter
"Ranking based time series filter."
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withDirection
withDirection(direction)
"How to use the ranking to select time series that pass through the filter."
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withNumTimeSeries
withNumTimeSeries(numTimeSeries)
"How many time series to allow to pass through the filter."
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withRankingMethod
withRankingMethod(rankingMethod)
"ranking_method
is applied to each time series independently to produce the value which will be used to compare the time series to other time series."
obj spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation
"Apply a second aggregation after the ratio is computed."
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.mosaicLayout.tiles.widget.xyChart.thresholds
"Threshold lines drawn horizontally across the chart."
fn spec.mosaicLayout.tiles.widget.xyChart.thresholds.withColor
withColor(color)
"The state color for this threshold. Color is not allowed in a XyChart."
fn spec.mosaicLayout.tiles.widget.xyChart.thresholds.withDirection
withDirection(direction)
"The direction for the current threshold. Direction is not allowed in a XyChart."
fn spec.mosaicLayout.tiles.widget.xyChart.thresholds.withLabel
withLabel(label)
"A label for the threshold."
fn spec.mosaicLayout.tiles.widget.xyChart.thresholds.withTargetAxis
withTargetAxis(targetAxis)
"The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard."
fn spec.mosaicLayout.tiles.widget.xyChart.thresholds.withValue
withValue(value)
"The value of the threshold. The value should be defined in the native scale of the metric."
obj spec.mosaicLayout.tiles.widget.xyChart.xAxis
"The properties applied to the x-axis."
fn spec.mosaicLayout.tiles.widget.xyChart.xAxis.withLabel
withLabel(label)
"The label of the axis."
fn spec.mosaicLayout.tiles.widget.xyChart.xAxis.withScale
withScale(scale)
"The axis scale. By default, a linear scale is used."
obj spec.mosaicLayout.tiles.widget.xyChart.y2Axis
"The properties applied to the y2-axis."
fn spec.mosaicLayout.tiles.widget.xyChart.y2Axis.withLabel
withLabel(label)
"The label of the axis."
fn spec.mosaicLayout.tiles.widget.xyChart.y2Axis.withScale
withScale(scale)
"The axis scale. By default, a linear scale is used."
obj spec.mosaicLayout.tiles.widget.xyChart.yAxis
"The properties applied to the y-axis."
fn spec.mosaicLayout.tiles.widget.xyChart.yAxis.withLabel
withLabel(label)
"The label of the axis."
fn spec.mosaicLayout.tiles.widget.xyChart.yAxis.withScale
withScale(scale)
"The axis scale. By default, a linear scale is used."
obj spec.projectRef
"Immutable. The Project that this resource belongs to."
fn spec.projectRef.withExternal
withExternal(external)
"The projectID
field of a project, when not managed by Config Connector."
fn spec.projectRef.withKind
withKind(kind)
"The kind of the Project resource; optional but must be Project
if provided."
fn spec.projectRef.withName
withName(name)
"The name
field of a Project
resource."
fn spec.projectRef.withNamespace
withNamespace(namespace)
"The namespace
field of a Project
resource."
obj spec.rowLayout
"The content is divided into equally spaced rows and the widgets are arranged horizontally."
fn spec.rowLayout.withRows
withRows(rows)
"The rows of content to display."
fn spec.rowLayout.withRowsMixin
withRowsMixin(rows)
"The rows of content to display."
Note: This function appends passed data to existing values
obj spec.rowLayout.rows
"The rows of content to display."
fn spec.rowLayout.rows.withWeight
withWeight(weight)
"The relative weight of this row. The row weight is used to adjust the height of rows on the screen (relative to peers)."
fn spec.rowLayout.rows.withWidgets
withWidgets(widgets)
"The display widgets arranged horizontally in this row."
fn spec.rowLayout.rows.withWidgetsMixin
withWidgetsMixin(widgets)
"The display widgets arranged horizontally in this row."
Note: This function appends passed data to existing values
obj spec.rowLayout.rows.widgets
"The display widgets arranged horizontally in this row."
fn spec.rowLayout.rows.widgets.withBlank
withBlank(blank)
"A blank space."
fn spec.rowLayout.rows.widgets.withBlankMixin
withBlankMixin(blank)
"A blank space."
Note: This function appends passed data to existing values
fn spec.rowLayout.rows.widgets.withId
withId(id)
"Optional. The widget id. Ids may be made up of alphanumerics, dashes and underscores. Widget ids are optional."
fn spec.rowLayout.rows.widgets.withSingleViewGroup
withSingleViewGroup(singleViewGroup)
"A widget that groups the other widgets by using a dropdown menu."
fn spec.rowLayout.rows.widgets.withSingleViewGroupMixin
withSingleViewGroupMixin(singleViewGroup)
"A widget that groups the other widgets by using a dropdown menu."
Note: This function appends passed data to existing values
fn spec.rowLayout.rows.widgets.withTitle
withTitle(title)
"Optional. The title of the widget."
obj spec.rowLayout.rows.widgets.alertChart
"A chart of alert policy data."
obj spec.rowLayout.rows.widgets.alertChart.alertPolicyRef
"Required. A reference to the MonitoringAlertPolicy."
fn spec.rowLayout.rows.widgets.alertChart.alertPolicyRef.withExternal
withExternal(external)
"The MonitoringAlertPolicy link in the form \"projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]\", when not managed by Config Connector."
fn spec.rowLayout.rows.widgets.alertChart.alertPolicyRef.withName
withName(name)
"The name
field of a MonitoringAlertPolicy
resource."
fn spec.rowLayout.rows.widgets.alertChart.alertPolicyRef.withNamespace
withNamespace(namespace)
"The namespace
field of a MonitoringAlertPolicy
resource."
obj spec.rowLayout.rows.widgets.collapsibleGroup
"A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets."
fn spec.rowLayout.rows.widgets.collapsibleGroup.withCollapsed
withCollapsed(collapsed)
"The collapsed state of the widget on first page load."
obj spec.rowLayout.rows.widgets.errorReportingPanel
"A widget that displays a list of error groups."
fn spec.rowLayout.rows.widgets.errorReportingPanel.withProjectRefs
withProjectRefs(projectRefs)
"The projects from which to gather errors."
fn spec.rowLayout.rows.widgets.errorReportingPanel.withProjectRefsMixin
withProjectRefsMixin(projectRefs)
"The projects from which to gather errors."
Note: This function appends passed data to existing values
fn spec.rowLayout.rows.widgets.errorReportingPanel.withServices
withServices(services)
"An identifier of the service, such as the name of the executable, job, or Google App Engine service name. This field is expected to have a low number of values that are relatively stable over time, as opposed to version
, which can be changed whenever new code is deployed."
fn spec.rowLayout.rows.widgets.errorReportingPanel.withServicesMixin
withServicesMixin(services)
"An identifier of the service, such as the name of the executable, job, or Google App Engine service name. This field is expected to have a low number of values that are relatively stable over time, as opposed to version
, which can be changed whenever new code is deployed."
Note: This function appends passed data to existing values
fn spec.rowLayout.rows.widgets.errorReportingPanel.withVersions
withVersions(versions)
"Represents the source code version that the developer provided, which could represent a version label or a Git SHA-1 hash, for example. For App Engine standard environment, the version is set to the version of the app."
fn spec.rowLayout.rows.widgets.errorReportingPanel.withVersionsMixin
withVersionsMixin(versions)
"Represents the source code version that the developer provided, which could represent a version label or a Git SHA-1 hash, for example. For App Engine standard environment, the version is set to the version of the app."
Note: This function appends passed data to existing values
obj spec.rowLayout.rows.widgets.errorReportingPanel.projectRefs
"The projects from which to gather errors."
fn spec.rowLayout.rows.widgets.errorReportingPanel.projectRefs.withExternal
withExternal(external)
"The projectID
field of a project, when not managed by Config Connector."
fn spec.rowLayout.rows.widgets.errorReportingPanel.projectRefs.withKind
withKind(kind)
"The kind of the Project resource; optional but must be Project
if provided."
fn spec.rowLayout.rows.widgets.errorReportingPanel.projectRefs.withName
withName(name)
"The name
field of a Project
resource."
fn spec.rowLayout.rows.widgets.errorReportingPanel.projectRefs.withNamespace
withNamespace(namespace)
"The namespace
field of a Project
resource."
obj spec.rowLayout.rows.widgets.incidentList
"A widget that shows list of incidents."
fn spec.rowLayout.rows.widgets.incidentList.withMonitoredResources
withMonitoredResources(monitoredResources)
"Optional. The monitored resource for which incidents are listed."
fn spec.rowLayout.rows.widgets.incidentList.withMonitoredResourcesMixin
withMonitoredResourcesMixin(monitoredResources)
"Optional. The monitored resource for which incidents are listed."
Note: This function appends passed data to existing values
fn spec.rowLayout.rows.widgets.incidentList.withPolicyRefs
withPolicyRefs(policyRefs)
"Optional. A list of alert policies to filter the incident list by."
fn spec.rowLayout.rows.widgets.incidentList.withPolicyRefsMixin
withPolicyRefsMixin(policyRefs)
"Optional. A list of alert policies to filter the incident list by."
Note: This function appends passed data to existing values
obj spec.rowLayout.rows.widgets.incidentList.monitoredResources
"Optional. The monitored resource for which incidents are listed."
fn spec.rowLayout.rows.widgets.incidentList.monitoredResources.withLabels
withLabels(labels)
"Required. Values for all of the labels listed in the associated monitored resource descriptor."
fn spec.rowLayout.rows.widgets.incidentList.monitoredResources.withLabelsMixin
withLabelsMixin(labels)
"Required. Values for all of the labels listed in the associated monitored resource descriptor."
Note: This function appends passed data to existing values
fn spec.rowLayout.rows.widgets.incidentList.monitoredResources.withType
withType(type)
"Required. The monitored resource type. This field must match the type
field of a [MonitoredResourceDescriptor][google.api.MonitoredResourceDescriptor] object."
obj spec.rowLayout.rows.widgets.incidentList.policyRefs
"Optional. A list of alert policies to filter the incident list by."
fn spec.rowLayout.rows.widgets.incidentList.policyRefs.withExternal
withExternal(external)
"The MonitoringAlertPolicy link in the form \"projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]\", when not managed by Config Connector."
fn spec.rowLayout.rows.widgets.incidentList.policyRefs.withName
withName(name)
"The name
field of a MonitoringAlertPolicy
resource."
fn spec.rowLayout.rows.widgets.incidentList.policyRefs.withNamespace
withNamespace(namespace)
"The namespace
field of a MonitoringAlertPolicy
resource."
obj spec.rowLayout.rows.widgets.logsPanel
"A widget that shows a stream of logs."
fn spec.rowLayout.rows.widgets.logsPanel.withFilter
withFilter(filter)
"A filter that chooses which log entries to return. See Advanced Logs Queries."
fn spec.rowLayout.rows.widgets.logsPanel.withResourceNames
withResourceNames(resourceNames)
"The names of logging resources to collect logs for."
fn spec.rowLayout.rows.widgets.logsPanel.withResourceNamesMixin
withResourceNamesMixin(resourceNames)
"The names of logging resources to collect logs for."
Note: This function appends passed data to existing values
obj spec.rowLayout.rows.widgets.logsPanel.resourceNames
"The names of logging resources to collect logs for."
fn spec.rowLayout.rows.widgets.logsPanel.resourceNames.withExternal
withExternal(external)
"The external name of the referenced resource"
fn spec.rowLayout.rows.widgets.logsPanel.resourceNames.withKind
withKind(kind)
"Kind of the referent."
fn spec.rowLayout.rows.widgets.logsPanel.resourceNames.withName
withName(name)
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"
fn spec.rowLayout.rows.widgets.logsPanel.resourceNames.withNamespace
withNamespace(namespace)
"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"
obj spec.rowLayout.rows.widgets.pieChart
"A widget that displays timeseries data as a pie chart."
fn spec.rowLayout.rows.widgets.pieChart.withChartType
withChartType(chartType)
"Required. Indicates the visualization type for the PieChart."
fn spec.rowLayout.rows.widgets.pieChart.withDataSets
withDataSets(dataSets)
"Required. The queries for the chart's data."
fn spec.rowLayout.rows.widgets.pieChart.withDataSetsMixin
withDataSetsMixin(dataSets)
"Required. The queries for the chart's data."
Note: This function appends passed data to existing values
fn spec.rowLayout.rows.widgets.pieChart.withShowLabels
withShowLabels(showLabels)
"Optional. Indicates whether or not the pie chart should show slices' labels"
obj spec.rowLayout.rows.widgets.pieChart.dataSets
"Required. The queries for the chart's data."
fn spec.rowLayout.rows.widgets.pieChart.dataSets.withMinAlignmentPeriod
withMinAlignmentPeriod(minAlignmentPeriod)
"Optional. The lower bound on data point frequency for this data set."
fn spec.rowLayout.rows.widgets.pieChart.dataSets.withSliceNameTemplate
withSliceNameTemplate(sliceNameTemplate)
"Optional. A template for the name of the slice."
obj spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery
"Required. The query for the PieChart. See, google.monitoring.dashboard.v1.TimeSeriesQuery
."
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.withOutputFullDuration
withOutputFullDuration(outputFullDuration)
"Optional. If set, Cloud Monitoring will treat the full query duration as the alignment period so that there will be only 1 output value."
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.withPrometheusQuery
withPrometheusQuery(prometheusQuery)
"A query used to fetch time series with PromQL."
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.withTimeSeriesQueryLanguage
withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)
"A query used to fetch time series with MQL."
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.withUnitOverride
withUnitOverride(unitOverride)
"The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit
field in MetricDescriptor
."
obj spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter
"Filter parameters to fetch time series."
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.withFilter
withFilter(filter)
"Required. The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation
"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter
"Ranking based time series filter."
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withDirection
withDirection(direction)
"How to use the ranking to select time series that pass through the filter."
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withNumTimeSeries
withNumTimeSeries(numTimeSeries)
"How many time series to allow to pass through the filter."
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withRankingMethod
withRankingMethod(rankingMethod)
"ranking_method
is applied to each time series independently to produce the value which will be used to compare the time series to other time series."
obj spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation
"Apply a second aggregation after aggregation
is applied."
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio
"Parameters to fetch a ratio between two time series filters."
obj spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator
"The denominator of the ratio."
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.withFilter
withFilter(filter)
"The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation
"By default, the raw time series data is returned."
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator
"The numerator of the ratio."
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.withFilter
withFilter(filter)
"The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation
"By default, the raw time series data is returned."
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter
"Ranking based time series filter."
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withDirection
withDirection(direction)
"How to use the ranking to select time series that pass through the filter."
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withNumTimeSeries
withNumTimeSeries(numTimeSeries)
"How many time series to allow to pass through the filter."
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withRankingMethod
withRankingMethod(rankingMethod)
"ranking_method
is applied to each time series independently to produce the value which will be used to compare the time series to other time series."
obj spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation
"Apply a second aggregation after the ratio is computed."
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.rowLayout.rows.widgets.pieChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.rowLayout.rows.widgets.scorecard
"A scorecard summarizing time series data."
fn spec.rowLayout.rows.widgets.scorecard.withBlankView
withBlankView(blankView)
"Will cause the Scorecard
to show only the value, with no indicator to its value relative to its thresholds."
fn spec.rowLayout.rows.widgets.scorecard.withBlankViewMixin
withBlankViewMixin(blankView)
"Will cause the Scorecard
to show only the value, with no indicator to its value relative to its thresholds."
Note: This function appends passed data to existing values
fn spec.rowLayout.rows.widgets.scorecard.withThresholds
withThresholds(thresholds)
"The thresholds used to determine the state of the scorecard given the time series' current value."
fn spec.rowLayout.rows.widgets.scorecard.withThresholdsMixin
withThresholdsMixin(thresholds)
"The thresholds used to determine the state of the scorecard given the time series' current value."
Note: This function appends passed data to existing values
obj spec.rowLayout.rows.widgets.scorecard.gaugeView
"Will cause the scorecard to show a gauge chart."
fn spec.rowLayout.rows.widgets.scorecard.gaugeView.withLowerBound
withLowerBound(lowerBound)
"The lower bound for this gauge chart. The value of the chart should always be greater than or equal to this."
fn spec.rowLayout.rows.widgets.scorecard.gaugeView.withUpperBound
withUpperBound(upperBound)
"The upper bound for this gauge chart. The value of the chart should always be less than or equal to this."
obj spec.rowLayout.rows.widgets.scorecard.sparkChartView
"Will cause the scorecard to show a spark chart."
fn spec.rowLayout.rows.widgets.scorecard.sparkChartView.withMinAlignmentPeriod
withMinAlignmentPeriod(minAlignmentPeriod)
"The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query."
fn spec.rowLayout.rows.widgets.scorecard.sparkChartView.withSparkChartType
withSparkChartType(sparkChartType)
"Required. The type of sparkchart to show in this chartView."
obj spec.rowLayout.rows.widgets.scorecard.thresholds
"The thresholds used to determine the state of the scorecard given the time series' current value."
fn spec.rowLayout.rows.widgets.scorecard.thresholds.withColor
withColor(color)
"The state color for this threshold. Color is not allowed in a XyChart."
fn spec.rowLayout.rows.widgets.scorecard.thresholds.withDirection
withDirection(direction)
"The direction for the current threshold. Direction is not allowed in a XyChart."
fn spec.rowLayout.rows.widgets.scorecard.thresholds.withLabel
withLabel(label)
"A label for the threshold."
fn spec.rowLayout.rows.widgets.scorecard.thresholds.withTargetAxis
withTargetAxis(targetAxis)
"The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard."
fn spec.rowLayout.rows.widgets.scorecard.thresholds.withValue
withValue(value)
"The value of the threshold. The value should be defined in the native scale of the metric."
obj spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery
"Required. Fields for querying time series data from the Stackdriver metrics API."
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.withOutputFullDuration
withOutputFullDuration(outputFullDuration)
"Optional. If set, Cloud Monitoring will treat the full query duration as the alignment period so that there will be only 1 output value."
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.withPrometheusQuery
withPrometheusQuery(prometheusQuery)
"A query used to fetch time series with PromQL."
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.withTimeSeriesQueryLanguage
withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)
"A query used to fetch time series with MQL."
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.withUnitOverride
withUnitOverride(unitOverride)
"The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit
field in MetricDescriptor
."
obj spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter
"Filter parameters to fetch time series."
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.withFilter
withFilter(filter)
"Required. The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation
"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter
"Ranking based time series filter."
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withDirection
withDirection(direction)
"How to use the ranking to select time series that pass through the filter."
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withNumTimeSeries
withNumTimeSeries(numTimeSeries)
"How many time series to allow to pass through the filter."
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withRankingMethod
withRankingMethod(rankingMethod)
"ranking_method
is applied to each time series independently to produce the value which will be used to compare the time series to other time series."
obj spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation
"Apply a second aggregation after aggregation
is applied."
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio
"Parameters to fetch a ratio between two time series filters."
obj spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator
"The denominator of the ratio."
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.withFilter
withFilter(filter)
"The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation
"By default, the raw time series data is returned."
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator
"The numerator of the ratio."
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.withFilter
withFilter(filter)
"The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation
"By default, the raw time series data is returned."
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter
"Ranking based time series filter."
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withDirection
withDirection(direction)
"How to use the ranking to select time series that pass through the filter."
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withNumTimeSeries
withNumTimeSeries(numTimeSeries)
"How many time series to allow to pass through the filter."
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withRankingMethod
withRankingMethod(rankingMethod)
"ranking_method
is applied to each time series independently to produce the value which will be used to compare the time series to other time series."
obj spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation
"Apply a second aggregation after the ratio is computed."
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.rowLayout.rows.widgets.sectionHeader
"A widget that defines a section header for easier navigation of the dashboard."
fn spec.rowLayout.rows.widgets.sectionHeader.withDividerBelow
withDividerBelow(dividerBelow)
"Whether to insert a divider below the section in the table of contents"
fn spec.rowLayout.rows.widgets.sectionHeader.withSubtitle
withSubtitle(subtitle)
"The subtitle of the section"
obj spec.rowLayout.rows.widgets.text
"A raw string or markdown displaying textual content."
fn spec.rowLayout.rows.widgets.text.withContent
withContent(content)
"The text content to be displayed."
fn spec.rowLayout.rows.widgets.text.withFormat
withFormat(format)
"How the text content is formatted."
obj spec.rowLayout.rows.widgets.text.style
"How the text is styled"
fn spec.rowLayout.rows.widgets.text.style.withBackgroundColor
withBackgroundColor(backgroundColor)
"The background color as a hex string. \"#RRGGBB\" or \"#RGB\
fn spec.rowLayout.rows.widgets.text.style.withFontSize
withFontSize(fontSize)
"Font sizes for both the title and content. The title will still be larger relative to the content."
fn spec.rowLayout.rows.widgets.text.style.withHorizontalAlignment
withHorizontalAlignment(horizontalAlignment)
"The horizontal alignment of both the title and content"
fn spec.rowLayout.rows.widgets.text.style.withPadding
withPadding(padding)
"The amount of padding around the widget"
fn spec.rowLayout.rows.widgets.text.style.withPointerLocation
withPointerLocation(pointerLocation)
"The pointer location for this widget (also sometimes called a \"tail\")"
fn spec.rowLayout.rows.widgets.text.style.withTextColor
withTextColor(textColor)
"The text color as a hex string. \"#RRGGBB\" or \"#RGB\
fn spec.rowLayout.rows.widgets.text.style.withVerticalAlignment
withVerticalAlignment(verticalAlignment)
"The vertical alignment of both the title and content"
obj spec.rowLayout.rows.widgets.timeSeriesTable
"A widget that displays time series data in a tabular format."
fn spec.rowLayout.rows.widgets.timeSeriesTable.withColumnSettings
withColumnSettings(columnSettings)
"Optional. The list of the persistent column settings for the table."
fn spec.rowLayout.rows.widgets.timeSeriesTable.withColumnSettingsMixin
withColumnSettingsMixin(columnSettings)
"Optional. The list of the persistent column settings for the table."
Note: This function appends passed data to existing values
fn spec.rowLayout.rows.widgets.timeSeriesTable.withDataSets
withDataSets(dataSets)
"Required. The data displayed in this table."
fn spec.rowLayout.rows.widgets.timeSeriesTable.withDataSetsMixin
withDataSetsMixin(dataSets)
"Required. The data displayed in this table."
Note: This function appends passed data to existing values
fn spec.rowLayout.rows.widgets.timeSeriesTable.withMetricVisualization
withMetricVisualization(metricVisualization)
"Optional. Store rendering strategy"
obj spec.rowLayout.rows.widgets.timeSeriesTable.columnSettings
"Optional. The list of the persistent column settings for the table."
fn spec.rowLayout.rows.widgets.timeSeriesTable.columnSettings.withColumn
withColumn(column)
"Required. The id of the column."
fn spec.rowLayout.rows.widgets.timeSeriesTable.columnSettings.withVisible
withVisible(visible)
"Required. Whether the column should be visible on page load."
obj spec.rowLayout.rows.widgets.timeSeriesTable.dataSets
"Required. The data displayed in this table."
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.withMinAlignmentPeriod
withMinAlignmentPeriod(minAlignmentPeriod)
"Optional. The lower bound on data point frequency for this data set."
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.withTableTemplate
withTableTemplate(tableTemplate)
"Optional. A template string for naming TimeSeries
in the resulting data set."
obj spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.tableDisplayOptions
"Optional. Table display options for configuring how the table is rendered."
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.tableDisplayOptions.withShownColumns
withShownColumns(shownColumns)
"Optional. This field is unused and has been replaced by TimeSeriesTable.column_settings"
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.tableDisplayOptions.withShownColumnsMixin
withShownColumnsMixin(shownColumns)
"Optional. This field is unused and has been replaced by TimeSeriesTable.column_settings"
Note: This function appends passed data to existing values
obj spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery
"Required. Fields for querying time series data from the Stackdriver metrics API."
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.withOutputFullDuration
withOutputFullDuration(outputFullDuration)
"Optional. If set, Cloud Monitoring will treat the full query duration as the alignment period so that there will be only 1 output value."
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.withPrometheusQuery
withPrometheusQuery(prometheusQuery)
"A query used to fetch time series with PromQL."
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.withTimeSeriesQueryLanguage
withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)
"A query used to fetch time series with MQL."
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.withUnitOverride
withUnitOverride(unitOverride)
"The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit
field in MetricDescriptor
."
obj spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter
"Filter parameters to fetch time series."
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.withFilter
withFilter(filter)
"Required. The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation
"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter
"Ranking based time series filter."
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withDirection
withDirection(direction)
"How to use the ranking to select time series that pass through the filter."
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withNumTimeSeries
withNumTimeSeries(numTimeSeries)
"How many time series to allow to pass through the filter."
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withRankingMethod
withRankingMethod(rankingMethod)
"ranking_method
is applied to each time series independently to produce the value which will be used to compare the time series to other time series."
obj spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation
"Apply a second aggregation after aggregation
is applied."
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio
"Parameters to fetch a ratio between two time series filters."
obj spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator
"The denominator of the ratio."
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.withFilter
withFilter(filter)
"The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation
"By default, the raw time series data is returned."
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator
"The numerator of the ratio."
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.withFilter
withFilter(filter)
"The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation
"By default, the raw time series data is returned."
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter
"Ranking based time series filter."
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withDirection
withDirection(direction)
"How to use the ranking to select time series that pass through the filter."
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withNumTimeSeries
withNumTimeSeries(numTimeSeries)
"How many time series to allow to pass through the filter."
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withRankingMethod
withRankingMethod(rankingMethod)
"ranking_method
is applied to each time series independently to produce the value which will be used to compare the time series to other time series."
obj spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation
"Apply a second aggregation after the ratio is computed."
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.rowLayout.rows.widgets.timeSeriesTable.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.rowLayout.rows.widgets.xyChart
"A chart of time series data."
fn spec.rowLayout.rows.widgets.xyChart.withDataSets
withDataSets(dataSets)
"Required. The data displayed in this chart."
fn spec.rowLayout.rows.widgets.xyChart.withDataSetsMixin
withDataSetsMixin(dataSets)
"Required. The data displayed in this chart."
Note: This function appends passed data to existing values
fn spec.rowLayout.rows.widgets.xyChart.withThresholds
withThresholds(thresholds)
"Threshold lines drawn horizontally across the chart."
fn spec.rowLayout.rows.widgets.xyChart.withThresholdsMixin
withThresholdsMixin(thresholds)
"Threshold lines drawn horizontally across the chart."
Note: This function appends passed data to existing values
fn spec.rowLayout.rows.widgets.xyChart.withTimeshiftDuration
withTimeshiftDuration(timeshiftDuration)
"The duration used to display a comparison chart."
obj spec.rowLayout.rows.widgets.xyChart.chartOptions
"Display options for the chart."
fn spec.rowLayout.rows.widgets.xyChart.chartOptions.withMode
withMode(mode)
"The chart mode."
obj spec.rowLayout.rows.widgets.xyChart.dataSets
"Required. The data displayed in this chart."
fn spec.rowLayout.rows.widgets.xyChart.dataSets.withLegendTemplate
withLegendTemplate(legendTemplate)
"A template string for naming TimeSeries
in the resulting data set."
fn spec.rowLayout.rows.widgets.xyChart.dataSets.withMinAlignmentPeriod
withMinAlignmentPeriod(minAlignmentPeriod)
"Optional. The lower bound on data point frequency for this data set."
fn spec.rowLayout.rows.widgets.xyChart.dataSets.withPlotType
withPlotType(plotType)
"How this data should be plotted on the chart."
fn spec.rowLayout.rows.widgets.xyChart.dataSets.withTargetAxis
withTargetAxis(targetAxis)
"Optional. The target axis to use for plotting the metric."
obj spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery
"Fields for querying time series data from the Stackdriver metrics API."
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.withOutputFullDuration
withOutputFullDuration(outputFullDuration)
"Optional. If set, Cloud Monitoring will treat the full query duration as the alignment period so that there will be only 1 output value."
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.withPrometheusQuery
withPrometheusQuery(prometheusQuery)
"A query used to fetch time series with PromQL."
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.withTimeSeriesQueryLanguage
withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)
"A query used to fetch time series with MQL."
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.withUnitOverride
withUnitOverride(unitOverride)
"The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit
field in MetricDescriptor
."
obj spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter
"Filter parameters to fetch time series."
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.withFilter
withFilter(filter)
"Required. The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation
"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter
"Ranking based time series filter."
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withDirection
withDirection(direction)
"How to use the ranking to select time series that pass through the filter."
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withNumTimeSeries
withNumTimeSeries(numTimeSeries)
"How many time series to allow to pass through the filter."
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withRankingMethod
withRankingMethod(rankingMethod)
"ranking_method
is applied to each time series independently to produce the value which will be used to compare the time series to other time series."
obj spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation
"Apply a second aggregation after aggregation
is applied."
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio
"Parameters to fetch a ratio between two time series filters."
obj spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator
"The denominator of the ratio."
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.withFilter
withFilter(filter)
"The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation
"By default, the raw time series data is returned."
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator
"The numerator of the ratio."
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.withFilter
withFilter(filter)
"The monitoring filter that identifies the metric types, resources, and projects to query."
obj spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation
"By default, the raw time series data is returned."
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter
"Ranking based time series filter."
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withDirection
withDirection(direction)
"How to use the ranking to select time series that pass through the filter."
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withNumTimeSeries
withNumTimeSeries(numTimeSeries)
"How many time series to allow to pass through the filter."
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withRankingMethod
withRankingMethod(rankingMethod)
"ranking_method
is applied to each time series independently to produce the value which will be used to compare the time series to other time series."
obj spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation
"Apply a second aggregation after the ratio is computed."
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withAlignmentPeriod
withAlignmentPeriod(alignmentPeriod)
"The alignment_period
specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data."
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withCrossSeriesReducer
withCrossSeriesReducer(crossSeriesReducer)
"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series."
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFields
withGroupByFields(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFieldsMixin
withGroupByFieldsMixin(groupByFields)
"The set of fields to preserve when cross_series_reducer
is specified."
Note: This function appends passed data to existing values
fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withPerSeriesAligner
withPerSeriesAligner(perSeriesAligner)
"An Aligner
describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE
, all alignments cause all the data points in an alignment_period
to be mathematically grouped together, resulting in a single data point for each alignment_period
with end timestamp at the end of the period."
obj spec.rowLayout.rows.widgets.xyChart.thresholds
"Threshold lines drawn horizontally across the chart."
fn spec.rowLayout.rows.widgets.xyChart.thresholds.withColor
withColor(color)
"The state color for this threshold. Color is not allowed in a XyChart."
fn spec.rowLayout.rows.widgets.xyChart.thresholds.withDirection
withDirection(direction)
"The direction for the current threshold. Direction is not allowed in a XyChart."
fn spec.rowLayout.rows.widgets.xyChart.thresholds.withLabel
withLabel(label)
"A label for the threshold."
fn spec.rowLayout.rows.widgets.xyChart.thresholds.withTargetAxis
withTargetAxis(targetAxis)
"The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard."
fn spec.rowLayout.rows.widgets.xyChart.thresholds.withValue
withValue(value)
"The value of the threshold. The value should be defined in the native scale of the metric."
obj spec.rowLayout.rows.widgets.xyChart.xAxis
"The properties applied to the x-axis."
fn spec.rowLayout.rows.widgets.xyChart.xAxis.withLabel
withLabel(label)
"The label of the axis."
fn spec.rowLayout.rows.widgets.xyChart.xAxis.withScale
withScale(scale)
"The axis scale. By default, a linear scale is used."
obj spec.rowLayout.rows.widgets.xyChart.y2Axis
"The properties applied to the y2-axis."
fn spec.rowLayout.rows.widgets.xyChart.y2Axis.withLabel
withLabel(label)
"The label of the axis."
fn spec.rowLayout.rows.widgets.xyChart.y2Axis.withScale
withScale(scale)
"The axis scale. By default, a linear scale is used."
obj spec.rowLayout.rows.widgets.xyChart.yAxis
"The properties applied to the y-axis."
fn spec.rowLayout.rows.widgets.xyChart.yAxis.withLabel
withLabel(label)
"The label of the axis."
fn spec.rowLayout.rows.widgets.xyChart.yAxis.withScale
withScale(scale)
"The axis scale. By default, a linear scale is used."