Class XyChart.DataSet (2.32.0)

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
TypeDescription
int

MIN_ALIGNMENT_PERIOD_FIELD_NUMBER

public static final int MIN_ALIGNMENT_PERIOD_FIELD_NUMBER
Field Value
TypeDescription
int

PLOT_TYPE_FIELD_NUMBER

public static final int PLOT_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

TARGET_AXIS_FIELD_NUMBER

public static final int TARGET_AXIS_FIELD_NUMBER
Field Value
TypeDescription
int

TIME_SERIES_QUERY_FIELD_NUMBER

public static final int TIME_SERIES_QUERY_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static XyChart.DataSet getDefaultInstance()
Returns
TypeDescription
XyChart.DataSet

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static XyChart.DataSet.Builder newBuilder()
Returns
TypeDescription
XyChart.DataSet.Builder

newBuilder(XyChart.DataSet prototype)

public static XyChart.DataSet.Builder newBuilder(XyChart.DataSet prototype)
Parameter
NameDescription
prototypeXyChart.DataSet
Returns
TypeDescription
XyChart.DataSet.Builder

parseDelimitedFrom(InputStream input)

public static XyChart.DataSet parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
XyChart.DataSet
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static XyChart.DataSet parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
XyChart.DataSet
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static XyChart.DataSet parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
XyChart.DataSet
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static XyChart.DataSet parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
XyChart.DataSet
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static XyChart.DataSet parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
XyChart.DataSet
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static XyChart.DataSet parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
XyChart.DataSet
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static XyChart.DataSet parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
XyChart.DataSet
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static XyChart.DataSet parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
XyChart.DataSet
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static XyChart.DataSet parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
XyChart.DataSet
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static XyChart.DataSet parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
XyChart.DataSet
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static XyChart.DataSet parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
XyChart.DataSet
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static XyChart.DataSet parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
XyChart.DataSet
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<XyChart.DataSet> parser()
Returns
TypeDescription
Parser<DataSet>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public XyChart.DataSet getDefaultInstanceForType()
Returns
TypeDescription
XyChart.DataSet

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
DurationOrBuilder

getParserForType()

public Parser<XyChart.DataSet> getParserForType()
Returns
TypeDescription
Parser<DataSet>
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
TypeDescription
XyChart.DataSet.PlotType

The plotType.

getPlotTypeValue()

public 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.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
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
TypeDescription
XyChart.DataSet.TargetAxis

The targetAxis.

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
TypeDescription
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
TypeDescription
TimeSeriesQuery

The timeSeriesQuery.

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
TypeDescription
TimeSeriesQueryOrBuilder

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
TypeDescription
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
TypeDescription
boolean

Whether the timeSeriesQuery field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public XyChart.DataSet.Builder newBuilderForType()
Returns
TypeDescription
XyChart.DataSet.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected XyChart.DataSet.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
XyChart.DataSet.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public XyChart.DataSet.Builder toBuilder()
Returns
TypeDescription
XyChart.DataSet.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException