public static final class XyChart.DataSet extends GeneratedMessageV3 implements XyChart.DataSetOrBuilder
Groups a time series query definition with charting options.
Protobuf type google.monitoring.dashboard.v1.XyChart.DataSet
Static Fields
LEGEND_TEMPLATE_FIELD_NUMBER
public static final int LEGEND_TEMPLATE_FIELD_NUMBER
Field Value
MIN_ALIGNMENT_PERIOD_FIELD_NUMBER
public static final int MIN_ALIGNMENT_PERIOD_FIELD_NUMBER
Field Value
PLOT_TYPE_FIELD_NUMBER
public static final int PLOT_TYPE_FIELD_NUMBER
Field Value
TARGET_AXIS_FIELD_NUMBER
public static final int TARGET_AXIS_FIELD_NUMBER
Field Value
TIME_SERIES_QUERY_FIELD_NUMBER
public static final int TIME_SERIES_QUERY_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static XyChart.DataSet getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static XyChart.DataSet.Builder newBuilder()
Returns
newBuilder(XyChart.DataSet prototype)
public static XyChart.DataSet.Builder newBuilder(XyChart.DataSet prototype)
Parameter
Returns
public static XyChart.DataSet parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static XyChart.DataSet parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static XyChart.DataSet parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static XyChart.DataSet parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static XyChart.DataSet parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static XyChart.DataSet parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static XyChart.DataSet parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static XyChart.DataSet parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static XyChart.DataSet parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static XyChart.DataSet parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static XyChart.DataSet parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static XyChart.DataSet parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<XyChart.DataSet> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public XyChart.DataSet getDefaultInstanceForType()
Returns
getLegendTemplate()
public 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
Type | Description |
String | The legendTemplate.
|
getLegendTemplateBytes()
public 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
Type | Description |
ByteString | The bytes for legendTemplate.
|
getMinAlignmentPeriod()
public 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
Type | Description |
Duration | The minAlignmentPeriod.
|
getMinAlignmentPeriodOrBuilder()
public 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
getParserForType()
public Parser<XyChart.DataSet> getParserForType()
Returns
Overrides
getPlotType()
public XyChart.DataSet.PlotType getPlotType()
How this data should be plotted on the chart.
.google.monitoring.dashboard.v1.XyChart.DataSet.PlotType plot_type = 2;
Returns
getPlotTypeValue()
public int getPlotTypeValue()
How this data should be plotted on the chart.
.google.monitoring.dashboard.v1.XyChart.DataSet.PlotType plot_type = 2;
Returns
Type | Description |
int | The enum numeric value on the wire for plotType.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getTargetAxis()
public 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
getTargetAxisValue()
public 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
Type | Description |
int | The enum numeric value on the wire for targetAxis.
|
getTimeSeriesQuery()
public 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
getTimeSeriesQueryOrBuilder()
public 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
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hasMinAlignmentPeriod()
public 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
Type | Description |
boolean | Whether the minAlignmentPeriod field is set.
|
hasTimeSeriesQuery()
public 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
Type | Description |
boolean | Whether the timeSeriesQuery field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public XyChart.DataSet.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected XyChart.DataSet.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public XyChart.DataSet.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions