Interface XyChart.DataSetOrBuilder (2.30.0)

public static interface XyChart.DataSetOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getLegendTemplate()

public abstract String getLegendTemplate()

A template string for naming TimeSeries in the resulting data set. This should be a string with interpolations of the form ${label_name}, which will resolve to the label's value.

string legend_template = 3;

Returns
TypeDescription
String

The legendTemplate.

getLegendTemplateBytes()

public abstract ByteString getLegendTemplateBytes()

A template string for naming TimeSeries in the resulting data set. This should be a string with interpolations of the form ${label_name}, which will resolve to the label's value.

string legend_template = 3;

Returns
TypeDescription
ByteString

The bytes for legendTemplate.

getMinAlignmentPeriod()

public abstract Duration getMinAlignmentPeriod()

Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.

.google.protobuf.Duration min_alignment_period = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
Duration

The minAlignmentPeriod.

getMinAlignmentPeriodOrBuilder()

public abstract DurationOrBuilder getMinAlignmentPeriodOrBuilder()

Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.

.google.protobuf.Duration min_alignment_period = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
DurationOrBuilder

getPlotType()

public abstract XyChart.DataSet.PlotType getPlotType()

How this data should be plotted on the chart.

.google.monitoring.dashboard.v1.XyChart.DataSet.PlotType plot_type = 2;

Returns
TypeDescription
XyChart.DataSet.PlotType

The plotType.

getPlotTypeValue()

public abstract int getPlotTypeValue()

How this data should be plotted on the chart.

.google.monitoring.dashboard.v1.XyChart.DataSet.PlotType plot_type = 2;

Returns
TypeDescription
int

The enum numeric value on the wire for plotType.

getTargetAxis()

public abstract XyChart.DataSet.TargetAxis getTargetAxis()

Optional. The target axis to use for plotting the metric.

.google.monitoring.dashboard.v1.XyChart.DataSet.TargetAxis target_axis = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
XyChart.DataSet.TargetAxis

The targetAxis.

getTargetAxisValue()

public abstract int getTargetAxisValue()

Optional. The target axis to use for plotting the metric.

.google.monitoring.dashboard.v1.XyChart.DataSet.TargetAxis target_axis = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

The enum numeric value on the wire for targetAxis.

getTimeSeriesQuery()

public abstract TimeSeriesQuery getTimeSeriesQuery()

Required. Fields for querying time series data from the Stackdriver metrics API.

.google.monitoring.dashboard.v1.TimeSeriesQuery time_series_query = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
TimeSeriesQuery

The timeSeriesQuery.

getTimeSeriesQueryOrBuilder()

public abstract TimeSeriesQueryOrBuilder getTimeSeriesQueryOrBuilder()

Required. Fields for querying time series data from the Stackdriver metrics API.

.google.monitoring.dashboard.v1.TimeSeriesQuery time_series_query = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
TimeSeriesQueryOrBuilder

hasMinAlignmentPeriod()

public abstract boolean hasMinAlignmentPeriod()

Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.

.google.protobuf.Duration min_alignment_period = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

Whether the minAlignmentPeriod field is set.

hasTimeSeriesQuery()

public abstract boolean hasTimeSeriesQuery()

Required. Fields for querying time series data from the Stackdriver metrics API.

.google.monitoring.dashboard.v1.TimeSeriesQuery time_series_query = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the timeSeriesQuery field is set.