Package-level declarations

Types

Link copied to clipboard
data class AggregationArgs(val alignmentPeriod: Output<String>? = null, val crossSeriesReducer: Output<AggregationCrossSeriesReducer>? = null, val groupByFields: Output<List<String>>? = null, val perSeriesAligner: Output<AggregationPerSeriesAligner>? = null) : ConvertibleToJava<AggregationArgs>

Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation).

Link copied to clipboard
Link copied to clipboard
data class AlertChartArgs(val name: Output<String>) : ConvertibleToJava<AlertChartArgs>

A chart that displays alert policy data.

Link copied to clipboard
Link copied to clipboard
data class AxisArgs(val label: Output<String>? = null, val scale: Output<AxisScale>? = null) : ConvertibleToJava<AxisArgs>

A chart axis.

Link copied to clipboard

Builder for AxisArgs.

Link copied to clipboard
data class ChartOptionsArgs(val mode: Output<ChartOptionsMode>? = null) : ConvertibleToJava<ChartOptionsArgs>

Options to control visual rendering of a chart.

Link copied to clipboard
Link copied to clipboard
data class CollapsibleGroupArgs(val collapsed: Output<Boolean>? = null) : ConvertibleToJava<CollapsibleGroupArgs>

A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets.

Link copied to clipboard
data class ColumnArgs(val weight: Output<String>? = null, val widgets: Output<List<WidgetArgs>>? = null) : ConvertibleToJava<ColumnArgs>

Defines the layout properties and content for a column.

Link copied to clipboard

Builder for ColumnArgs.

Link copied to clipboard
data class ColumnLayoutArgs(val columns: Output<List<ColumnArgs>>? = null) : ConvertibleToJava<ColumnLayoutArgs>

A simplified layout that divides the available space into vertical columns and arranges a set of widgets vertically in each column.

Link copied to clipboard
Link copied to clipboard
data class ColumnSettingsArgs(val column: Output<String>, val visible: Output<Boolean>) : ConvertibleToJava<ColumnSettingsArgs>

The persistent settings for a table's columns.

Link copied to clipboard
Link copied to clipboard
data class DashboardFilterArgs(val filterType: Output<DashboardFilterFilterType>? = null, val labelKey: Output<String>, val stringValue: Output<String>? = null, val templateVariable: Output<String>? = null) : ConvertibleToJava<DashboardFilterArgs>

A filter to reduce the amount of data charted in relevant widgets.

Link copied to clipboard
data class DataSetArgs(val legendTemplate: Output<String>? = null, val minAlignmentPeriod: Output<String>? = null, val plotType: Output<DataSetPlotType>? = null, val targetAxis: Output<DataSetTargetAxis>? = null, val timeSeriesQuery: Output<TimeSeriesQueryArgs>) : ConvertibleToJava<DataSetArgs>

Groups a time series query definition with charting options.

Link copied to clipboard
Link copied to clipboard
class EmptyArgs : ConvertibleToJava<EmptyArgs>

A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

Link copied to clipboard

Builder for EmptyArgs.

Link copied to clipboard
data class GaugeViewArgs(val lowerBound: Output<Double>? = null, val upperBound: Output<Double>? = null) : ConvertibleToJava<GaugeViewArgs>

A gauge chart shows where the current value sits within a pre-defined range. The upper and lower bounds should define the possible range of values for the scorecard's query (inclusive).

Link copied to clipboard
Link copied to clipboard
data class GetDashboardPlainArgs(val dashboardId: String, val project: String? = null) : ConvertibleToJava<GetDashboardPlainArgs>
Link copied to clipboard
data class GridLayoutArgs(val columns: Output<String>? = null, val widgets: Output<List<WidgetArgs>>? = null) : ConvertibleToJava<GridLayoutArgs>

A basic layout divides the available space into vertical columns of equal width and arranges a list of widgets using a row-first strategy.

Link copied to clipboard
Link copied to clipboard
data class IncidentListArgs(val monitoredResources: Output<List<MonitoredResourceArgs>>? = null, val policyNames: Output<List<String>>? = null) : ConvertibleToJava<IncidentListArgs>

A widget that displays a list of incidents

Link copied to clipboard
Link copied to clipboard
data class LogsPanelArgs(val filter: Output<String>? = null, val resourceNames: Output<List<String>>? = null) : ConvertibleToJava<LogsPanelArgs>

A widget that displays a stream of log.

Link copied to clipboard
Link copied to clipboard
data class MonitoredResourceArgs(val labels: Output<Map<String, String>>, val type: Output<String>) : ConvertibleToJava<MonitoredResourceArgs>

An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for "gce_instance" has labels "project_id", "instance_id" and "zone": { "type": "gce_instance", "labels": { "project_id": "my-project", "instance_id": "12345678901234", "zone": "us-central1-a" }}

Link copied to clipboard
data class MosaicLayoutArgs(val columns: Output<Int>? = null, val tiles: Output<List<TileArgs>>? = null) : ConvertibleToJava<MosaicLayoutArgs>

A mosaic layout divides the available space into a grid of blocks, and overlays the grid with tiles. Unlike GridLayout, tiles may span multiple grid blocks and can be placed at arbitrary locations in the grid.

Link copied to clipboard
Link copied to clipboard
data class PickTimeSeriesFilterArgs(val direction: Output<PickTimeSeriesFilterDirection>? = null, val numTimeSeries: Output<Int>? = null, val rankingMethod: Output<PickTimeSeriesFilterRankingMethod>? = null) : ConvertibleToJava<PickTimeSeriesFilterArgs>

Describes a ranking-based time series filter. Each input time series is ranked with an aligner. The filter will allow up to num_time_series time series to pass through it, selecting them based on the relative ranking.For example, if ranking_method is METHOD_MEAN,direction is BOTTOM, and num_time_series is 3, then the 3 times series with the lowest mean values will pass through the filter.

Link copied to clipboard
data class RatioPartArgs(val aggregation: Output<AggregationArgs>? = null, val filter: Output<String>) : ConvertibleToJava<RatioPartArgs>

Describes a query to build the numerator or denominator of a TimeSeriesFilterRatio.

Link copied to clipboard
Link copied to clipboard
data class RowArgs(val weight: Output<String>? = null, val widgets: Output<List<WidgetArgs>>? = null) : ConvertibleToJava<RowArgs>

Defines the layout properties and content for a row.

Link copied to clipboard

Builder for RowArgs.

Link copied to clipboard
data class RowLayoutArgs(val rows: Output<List<RowArgs>>? = null) : ConvertibleToJava<RowLayoutArgs>

A simplified layout that divides the available space into rows and arranges a set of widgets horizontally in each row.

Link copied to clipboard
Link copied to clipboard
data class ScorecardArgs(val gaugeView: Output<GaugeViewArgs>? = null, val sparkChartView: Output<SparkChartViewArgs>? = null, val thresholds: Output<List<ThresholdArgs>>? = null, val timeSeriesQuery: Output<TimeSeriesQueryArgs>) : ConvertibleToJava<ScorecardArgs>

A widget showing the latest value of a metric, and how this value relates to one or more thresholds.

Link copied to clipboard
Link copied to clipboard
data class SparkChartViewArgs(val minAlignmentPeriod: Output<String>? = null, val sparkChartType: Output<SparkChartViewSparkChartType>) : ConvertibleToJava<SparkChartViewArgs>

A sparkChart is a small chart suitable for inclusion in a table-cell or inline in text. This message contains the configuration for a sparkChart to show up on a Scorecard, showing recent trends of the scorecard's timeseries.

Link copied to clipboard
Link copied to clipboard
data class StatisticalTimeSeriesFilterArgs(val numTimeSeries: Output<Int>? = null, val rankingMethod: Output<StatisticalTimeSeriesFilterRankingMethod>? = null) : ConvertibleToJava<StatisticalTimeSeriesFilterArgs>

A filter that ranks streams based on their statistical relation to other streams in a request. Note: This field is deprecated and completely ignored by the API.

Link copied to clipboard
data class TableDataSetArgs(val minAlignmentPeriod: Output<String>? = null, val tableDisplayOptions: Output<TableDisplayOptionsArgs>? = null, val tableTemplate: Output<String>? = null, val timeSeriesQuery: Output<TimeSeriesQueryArgs>) : ConvertibleToJava<TableDataSetArgs>

Groups a time series query definition with table options.

Link copied to clipboard
Link copied to clipboard
data class TableDisplayOptionsArgs(val shownColumns: Output<List<String>>? = null) : ConvertibleToJava<TableDisplayOptionsArgs>

Table display options that can be reused.

Link copied to clipboard
data class TextArgs(val content: Output<String>? = null, val format: Output<TextFormat>? = null) : ConvertibleToJava<TextArgs>

A widget that displays textual content.

Link copied to clipboard

Builder for TextArgs.

Link copied to clipboard
data class ThresholdArgs(val color: Output<ThresholdColor>? = null, val direction: Output<ThresholdDirection>? = null, val label: Output<String>? = null, val targetAxis: Output<ThresholdTargetAxis>? = null, val value: Output<Double>? = null) : ConvertibleToJava<ThresholdArgs>

Defines a threshold for categorizing time series values.

Link copied to clipboard
Link copied to clipboard
data class TileArgs(val height: Output<Int>? = null, val widget: Output<WidgetArgs>? = null, val width: Output<Int>? = null, val xPos: Output<Int>? = null, val yPos: Output<Int>? = null) : ConvertibleToJava<TileArgs>

A single tile in the mosaic. The placement and size of the tile are configurable.

Link copied to clipboard

Builder for TileArgs.

Link copied to clipboard
data class TimeSeriesFilterArgs(val aggregation: Output<AggregationArgs>? = null, val filter: Output<String>, val pickTimeSeriesFilter: Output<PickTimeSeriesFilterArgs>? = null, val secondaryAggregation: Output<AggregationArgs>? = null, val statisticalTimeSeriesFilter: Output<StatisticalTimeSeriesFilterArgs>? = null) : ConvertibleToJava<TimeSeriesFilterArgs>

A filter that defines a subset of time series data that is displayed in a widget. Time series data is fetched using the ListTimeSeries (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list) method.

Link copied to clipboard
data class TimeSeriesFilterRatioArgs(val denominator: Output<RatioPartArgs>? = null, val numerator: Output<RatioPartArgs>? = null, val pickTimeSeriesFilter: Output<PickTimeSeriesFilterArgs>? = null, val secondaryAggregation: Output<AggregationArgs>? = null, val statisticalTimeSeriesFilter: Output<StatisticalTimeSeriesFilterArgs>? = null) : ConvertibleToJava<TimeSeriesFilterRatioArgs>

A pair of time series filters that define a ratio computation. The output time series is the pair-wise division of each aligned element from the numerator and denominator time series.

Link copied to clipboard
data class TimeSeriesQueryArgs(val prometheusQuery: Output<String>? = null, val timeSeriesFilter: Output<TimeSeriesFilterArgs>? = null, val timeSeriesFilterRatio: Output<TimeSeriesFilterRatioArgs>? = null, val timeSeriesQueryLanguage: Output<String>? = null, val unitOverride: Output<String>? = null) : ConvertibleToJava<TimeSeriesQueryArgs>

TimeSeriesQuery collects the set of supported methods for querying time series data from the Stackdriver metrics API.

Link copied to clipboard
data class TimeSeriesTableArgs(val columnSettings: Output<List<ColumnSettingsArgs>>? = null, val dataSets: Output<List<TableDataSetArgs>>, val metricVisualization: Output<TimeSeriesTableMetricVisualization>? = null) : ConvertibleToJava<TimeSeriesTableArgs>

A table that displays time series data.

Link copied to clipboard
data class WidgetArgs(val alertChart: Output<AlertChartArgs>? = null, val blank: Output<EmptyArgs>? = null, val collapsibleGroup: Output<CollapsibleGroupArgs>? = null, val incidentList: Output<IncidentListArgs>? = null, val logsPanel: Output<LogsPanelArgs>? = null, val scorecard: Output<ScorecardArgs>? = null, val text: Output<TextArgs>? = null, val timeSeriesTable: Output<TimeSeriesTableArgs>? = null, val title: Output<String>? = null, val xyChart: Output<XyChartArgs>? = null) : ConvertibleToJava<WidgetArgs>

Widget contains a single dashboard component and configuration of how to present the component in the dashboard.

Link copied to clipboard

Builder for WidgetArgs.

Link copied to clipboard
data class XyChartArgs(val chartOptions: Output<ChartOptionsArgs>? = null, val dataSets: Output<List<DataSetArgs>>, val thresholds: Output<List<ThresholdArgs>>? = null, val timeshiftDuration: Output<String>? = null, val xAxis: Output<AxisArgs>? = null, val y2Axis: Output<AxisArgs>? = null, val yAxis: Output<AxisArgs>? = null) : ConvertibleToJava<XyChartArgs>

A chart that displays data on a 2D (X and Y axes) plane.

Link copied to clipboard