Class XyChart.DataSet.Builder (2.22.0)

public static final class XyChart.DataSet.Builder extends GeneratedMessageV3.Builder<XyChart.DataSet.Builder> implements XyChart.DataSetOrBuilder

Groups a time series query definition with charting options.

Protobuf type google.monitoring.dashboard.v1.XyChart.DataSet

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public XyChart.DataSet.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
XyChart.DataSet.Builder
Overrides

build()

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

buildPartial()

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

clear()

public XyChart.DataSet.Builder clear()
Returns
TypeDescription
XyChart.DataSet.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public XyChart.DataSet.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
XyChart.DataSet.Builder
Overrides

clearLegendTemplate()

public XyChart.DataSet.Builder clearLegendTemplate()

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
XyChart.DataSet.Builder

This builder for chaining.

clearMinAlignmentPeriod()

public XyChart.DataSet.Builder clearMinAlignmentPeriod()

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
XyChart.DataSet.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public XyChart.DataSet.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
XyChart.DataSet.Builder
Overrides

clearPlotType()

public XyChart.DataSet.Builder clearPlotType()

How this data should be plotted on the chart.

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

Returns
TypeDescription
XyChart.DataSet.Builder

This builder for chaining.

clearTargetAxis()

public XyChart.DataSet.Builder clearTargetAxis()

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

This builder for chaining.

clearTimeSeriesQuery()

public XyChart.DataSet.Builder clearTimeSeriesQuery()

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
XyChart.DataSet.Builder

clone()

public XyChart.DataSet.Builder clone()
Returns
TypeDescription
XyChart.DataSet.Builder
Overrides

getDefaultInstanceForType()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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.

getMinAlignmentPeriodBuilder()

public Duration.Builder getMinAlignmentPeriodBuilder()

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
Builder

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

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.

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.

getTimeSeriesQueryBuilder()

public TimeSeriesQuery.Builder getTimeSeriesQueryBuilder()

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

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(XyChart.DataSet other)

public XyChart.DataSet.Builder mergeFrom(XyChart.DataSet other)
Parameter
NameDescription
otherXyChart.DataSet
Returns
TypeDescription
XyChart.DataSet.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public XyChart.DataSet.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
XyChart.DataSet.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public XyChart.DataSet.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
XyChart.DataSet.Builder
Overrides

mergeMinAlignmentPeriod(Duration value)

public XyChart.DataSet.Builder mergeMinAlignmentPeriod(Duration value)

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];

Parameter
NameDescription
valueDuration
Returns
TypeDescription
XyChart.DataSet.Builder

mergeTimeSeriesQuery(TimeSeriesQuery value)

public XyChart.DataSet.Builder mergeTimeSeriesQuery(TimeSeriesQuery value)

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];

Parameter
NameDescription
valueTimeSeriesQuery
Returns
TypeDescription
XyChart.DataSet.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final XyChart.DataSet.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
XyChart.DataSet.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public XyChart.DataSet.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
XyChart.DataSet.Builder
Overrides

setLegendTemplate(String value)

public XyChart.DataSet.Builder setLegendTemplate(String value)

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;

Parameter
NameDescription
valueString

The legendTemplate to set.

Returns
TypeDescription
XyChart.DataSet.Builder

This builder for chaining.

setLegendTemplateBytes(ByteString value)

public XyChart.DataSet.Builder setLegendTemplateBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for legendTemplate to set.

Returns
TypeDescription
XyChart.DataSet.Builder

This builder for chaining.

setMinAlignmentPeriod(Duration value)

public XyChart.DataSet.Builder setMinAlignmentPeriod(Duration value)

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];

Parameter
NameDescription
valueDuration
Returns
TypeDescription
XyChart.DataSet.Builder

setMinAlignmentPeriod(Duration.Builder builderForValue)

public XyChart.DataSet.Builder setMinAlignmentPeriod(Duration.Builder builderForValue)

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];

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
XyChart.DataSet.Builder

setPlotType(XyChart.DataSet.PlotType value)

public XyChart.DataSet.Builder setPlotType(XyChart.DataSet.PlotType value)

How this data should be plotted on the chart.

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

Parameter
NameDescription
valueXyChart.DataSet.PlotType

The plotType to set.

Returns
TypeDescription
XyChart.DataSet.Builder

This builder for chaining.

setPlotTypeValue(int value)

public XyChart.DataSet.Builder setPlotTypeValue(int value)

How this data should be plotted on the chart.

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

Parameter
NameDescription
valueint

The enum numeric value on the wire for plotType to set.

Returns
TypeDescription
XyChart.DataSet.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public XyChart.DataSet.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
XyChart.DataSet.Builder
Overrides

setTargetAxis(XyChart.DataSet.TargetAxis value)

public XyChart.DataSet.Builder setTargetAxis(XyChart.DataSet.TargetAxis value)

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];

Parameter
NameDescription
valueXyChart.DataSet.TargetAxis

The targetAxis to set.

Returns
TypeDescription
XyChart.DataSet.Builder

This builder for chaining.

setTargetAxisValue(int value)

public XyChart.DataSet.Builder setTargetAxisValue(int value)

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];

Parameter
NameDescription
valueint

The enum numeric value on the wire for targetAxis to set.

Returns
TypeDescription
XyChart.DataSet.Builder

This builder for chaining.

setTimeSeriesQuery(TimeSeriesQuery value)

public XyChart.DataSet.Builder setTimeSeriesQuery(TimeSeriesQuery value)

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];

Parameter
NameDescription
valueTimeSeriesQuery
Returns
TypeDescription
XyChart.DataSet.Builder

setTimeSeriesQuery(TimeSeriesQuery.Builder builderForValue)

public XyChart.DataSet.Builder setTimeSeriesQuery(TimeSeriesQuery.Builder builderForValue)

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];

Parameter
NameDescription
builderForValueTimeSeriesQuery.Builder
Returns
TypeDescription
XyChart.DataSet.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final XyChart.DataSet.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
XyChart.DataSet.Builder
Overrides