- 2.51.0 (latest)
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.6
- 2.4.0
- 2.3.0
- 2.2.6
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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > XyChart.DataSet.BuilderImplements
XyChart.DataSetOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public XyChart.DataSet.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
XyChart.DataSet.Builder |
build()
public XyChart.DataSet build()
Returns | |
---|---|
Type | Description |
XyChart.DataSet |
buildPartial()
public XyChart.DataSet buildPartial()
Returns | |
---|---|
Type | Description |
XyChart.DataSet |
clear()
public XyChart.DataSet.Builder clear()
Returns | |
---|---|
Type | Description |
XyChart.DataSet.Builder |
clearField(Descriptors.FieldDescriptor field)
public XyChart.DataSet.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field | FieldDescriptor |
Returns | |
---|---|
Type | Description |
XyChart.DataSet.Builder |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
XyChart.DataSet.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public XyChart.DataSet.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof | OneofDescriptor |
Returns | |
---|---|
Type | Description |
XyChart.DataSet.Builder |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
XyChart.DataSet.Builder |
clone()
public XyChart.DataSet.Builder clone()
Returns | |
---|---|
Type | Description |
XyChart.DataSet.Builder |
getDefaultInstanceForType()
public XyChart.DataSet getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
XyChart.DataSet |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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. |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
Type | Description |
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 | |
---|---|
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(XyChart.DataSet other)
public XyChart.DataSet.Builder mergeFrom(XyChart.DataSet other)
Parameter | |
---|---|
Name | Description |
other | XyChart.DataSet |
Returns | |
---|---|
Type | Description |
XyChart.DataSet.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public XyChart.DataSet.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
XyChart.DataSet.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public XyChart.DataSet.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other | Message |
Returns | |
---|---|
Type | Description |
XyChart.DataSet.Builder |
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 | |
---|---|
Name | Description |
value | Duration |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value | TimeSeriesQuery |
Returns | |
---|---|
Type | Description |
XyChart.DataSet.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final XyChart.DataSet.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
XyChart.DataSet.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public XyChart.DataSet.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
XyChart.DataSet.Builder |
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 | |
---|---|
Name | Description |
value | String The legendTemplate to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value | ByteString The bytes for legendTemplate to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value | Duration |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
builderForValue | Builder |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value | XyChart.DataSet.PlotType The plotType to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value | int The enum numeric value on the wire for plotType to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Returns | |
---|---|
Type | Description |
XyChart.DataSet.Builder |
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 | |
---|---|
Name | Description |
value | XyChart.DataSet.TargetAxis The targetAxis to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value | int The enum numeric value on the wire for targetAxis to set. |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
value | TimeSeriesQuery |
Returns | |
---|---|
Type | Description |
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 | |
---|---|
Name | Description |
builderForValue | TimeSeriesQuery.Builder |
Returns | |
---|---|
Type | Description |
XyChart.DataSet.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final XyChart.DataSet.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
XyChart.DataSet.Builder |