- 2.55.0 (latest)
- 2.54.0
- 2.53.0
- 2.51.0
- 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 TimeSeriesQuery.Builder extends GeneratedMessageV3.Builder<TimeSeriesQuery.Builder> implements TimeSeriesQueryOrBuilderTimeSeriesQuery collects the set of supported methods for querying time series data from the Stackdriver metrics API.
Protobuf type google.monitoring.dashboard.v1.TimeSeriesQuery
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > TimeSeriesQuery.BuilderImplements
TimeSeriesQueryOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public TimeSeriesQuery.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
TimeSeriesQuery.Builder |
|
build()
public TimeSeriesQuery build()| Returns | |
|---|---|
| Type | Description |
TimeSeriesQuery |
|
buildPartial()
public TimeSeriesQuery buildPartial()| Returns | |
|---|---|
| Type | Description |
TimeSeriesQuery |
|
clear()
public TimeSeriesQuery.Builder clear()| Returns | |
|---|---|
| Type | Description |
TimeSeriesQuery.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public TimeSeriesQuery.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
TimeSeriesQuery.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public TimeSeriesQuery.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
TimeSeriesQuery.Builder |
|
clearOutputFullDuration()
public TimeSeriesQuery.Builder clearOutputFullDuration()Optional. If set, Cloud Monitoring will treat the full query duration as the alignment period so that there will be only 1 output value.
*Note: This could override the configured alignment period except for the cases where a series of data points are expected, like
- XyChart
- Scorecard's spark chart
bool output_full_duration = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
TimeSeriesQuery.Builder |
This builder for chaining. |
clearPrometheusQuery()
public TimeSeriesQuery.Builder clearPrometheusQuery()A query used to fetch time series with PromQL.
string prometheus_query = 6;
| Returns | |
|---|---|
| Type | Description |
TimeSeriesQuery.Builder |
This builder for chaining. |
clearSource()
public TimeSeriesQuery.Builder clearSource()| Returns | |
|---|---|
| Type | Description |
TimeSeriesQuery.Builder |
|
clearTimeSeriesFilter()
public TimeSeriesQuery.Builder clearTimeSeriesFilter()Filter parameters to fetch time series.
.google.monitoring.dashboard.v1.TimeSeriesFilter time_series_filter = 1;
| Returns | |
|---|---|
| Type | Description |
TimeSeriesQuery.Builder |
|
clearTimeSeriesFilterRatio()
public TimeSeriesQuery.Builder clearTimeSeriesFilterRatio()Parameters to fetch a ratio between two time series filters.
.google.monitoring.dashboard.v1.TimeSeriesFilterRatio time_series_filter_ratio = 2;
| Returns | |
|---|---|
| Type | Description |
TimeSeriesQuery.Builder |
|
clearTimeSeriesQueryLanguage()
public TimeSeriesQuery.Builder clearTimeSeriesQueryLanguage()A query used to fetch time series with MQL.
string time_series_query_language = 3;
| Returns | |
|---|---|
| Type | Description |
TimeSeriesQuery.Builder |
This builder for chaining. |
clearUnitOverride()
public TimeSeriesQuery.Builder clearUnitOverride() The unit of data contained in fetched time series. If non-empty, this
unit will override any unit that accompanies fetched data. The format is
the same as the
unit
field in MetricDescriptor.
string unit_override = 5;
| Returns | |
|---|---|
| Type | Description |
TimeSeriesQuery.Builder |
This builder for chaining. |
clone()
public TimeSeriesQuery.Builder clone()| Returns | |
|---|---|
| Type | Description |
TimeSeriesQuery.Builder |
|
getDefaultInstanceForType()
public TimeSeriesQuery getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
TimeSeriesQuery |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getOutputFullDuration()
public boolean getOutputFullDuration()Optional. If set, Cloud Monitoring will treat the full query duration as the alignment period so that there will be only 1 output value.
*Note: This could override the configured alignment period except for the cases where a series of data points are expected, like
- XyChart
- Scorecard's spark chart
bool output_full_duration = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
The outputFullDuration. |
getPrometheusQuery()
public String getPrometheusQuery()A query used to fetch time series with PromQL.
string prometheus_query = 6;
| Returns | |
|---|---|
| Type | Description |
String |
The prometheusQuery. |
getPrometheusQueryBytes()
public ByteString getPrometheusQueryBytes()A query used to fetch time series with PromQL.
string prometheus_query = 6;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for prometheusQuery. |
getSourceCase()
public TimeSeriesQuery.SourceCase getSourceCase()| Returns | |
|---|---|
| Type | Description |
TimeSeriesQuery.SourceCase |
|
getTimeSeriesFilter()
public TimeSeriesFilter getTimeSeriesFilter()Filter parameters to fetch time series.
.google.monitoring.dashboard.v1.TimeSeriesFilter time_series_filter = 1;
| Returns | |
|---|---|
| Type | Description |
TimeSeriesFilter |
The timeSeriesFilter. |
getTimeSeriesFilterBuilder()
public TimeSeriesFilter.Builder getTimeSeriesFilterBuilder()Filter parameters to fetch time series.
.google.monitoring.dashboard.v1.TimeSeriesFilter time_series_filter = 1;
| Returns | |
|---|---|
| Type | Description |
TimeSeriesFilter.Builder |
|
getTimeSeriesFilterOrBuilder()
public TimeSeriesFilterOrBuilder getTimeSeriesFilterOrBuilder()Filter parameters to fetch time series.
.google.monitoring.dashboard.v1.TimeSeriesFilter time_series_filter = 1;
| Returns | |
|---|---|
| Type | Description |
TimeSeriesFilterOrBuilder |
|
getTimeSeriesFilterRatio()
public TimeSeriesFilterRatio getTimeSeriesFilterRatio()Parameters to fetch a ratio between two time series filters.
.google.monitoring.dashboard.v1.TimeSeriesFilterRatio time_series_filter_ratio = 2;
| Returns | |
|---|---|
| Type | Description |
TimeSeriesFilterRatio |
The timeSeriesFilterRatio. |
getTimeSeriesFilterRatioBuilder()
public TimeSeriesFilterRatio.Builder getTimeSeriesFilterRatioBuilder()Parameters to fetch a ratio between two time series filters.
.google.monitoring.dashboard.v1.TimeSeriesFilterRatio time_series_filter_ratio = 2;
| Returns | |
|---|---|
| Type | Description |
TimeSeriesFilterRatio.Builder |
|
getTimeSeriesFilterRatioOrBuilder()
public TimeSeriesFilterRatioOrBuilder getTimeSeriesFilterRatioOrBuilder()Parameters to fetch a ratio between two time series filters.
.google.monitoring.dashboard.v1.TimeSeriesFilterRatio time_series_filter_ratio = 2;
| Returns | |
|---|---|
| Type | Description |
TimeSeriesFilterRatioOrBuilder |
|
getTimeSeriesQueryLanguage()
public String getTimeSeriesQueryLanguage()A query used to fetch time series with MQL.
string time_series_query_language = 3;
| Returns | |
|---|---|
| Type | Description |
String |
The timeSeriesQueryLanguage. |
getTimeSeriesQueryLanguageBytes()
public ByteString getTimeSeriesQueryLanguageBytes()A query used to fetch time series with MQL.
string time_series_query_language = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for timeSeriesQueryLanguage. |
getUnitOverride()
public String getUnitOverride() The unit of data contained in fetched time series. If non-empty, this
unit will override any unit that accompanies fetched data. The format is
the same as the
unit
field in MetricDescriptor.
string unit_override = 5;
| Returns | |
|---|---|
| Type | Description |
String |
The unitOverride. |
getUnitOverrideBytes()
public ByteString getUnitOverrideBytes() The unit of data contained in fetched time series. If non-empty, this
unit will override any unit that accompanies fetched data. The format is
the same as the
unit
field in MetricDescriptor.
string unit_override = 5;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for unitOverride. |
hasPrometheusQuery()
public boolean hasPrometheusQuery()A query used to fetch time series with PromQL.
string prometheus_query = 6;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the prometheusQuery field is set. |
hasTimeSeriesFilter()
public boolean hasTimeSeriesFilter()Filter parameters to fetch time series.
.google.monitoring.dashboard.v1.TimeSeriesFilter time_series_filter = 1;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the timeSeriesFilter field is set. |
hasTimeSeriesFilterRatio()
public boolean hasTimeSeriesFilterRatio()Parameters to fetch a ratio between two time series filters.
.google.monitoring.dashboard.v1.TimeSeriesFilterRatio time_series_filter_ratio = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the timeSeriesFilterRatio field is set. |
hasTimeSeriesQueryLanguage()
public boolean hasTimeSeriesQueryLanguage()A query used to fetch time series with MQL.
string time_series_query_language = 3;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the timeSeriesQueryLanguage field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(TimeSeriesQuery other)
public TimeSeriesQuery.Builder mergeFrom(TimeSeriesQuery other)| Parameter | |
|---|---|
| Name | Description |
other |
TimeSeriesQuery |
| Returns | |
|---|---|
| Type | Description |
TimeSeriesQuery.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public TimeSeriesQuery.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
TimeSeriesQuery.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public TimeSeriesQuery.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
TimeSeriesQuery.Builder |
|
mergeTimeSeriesFilter(TimeSeriesFilter value)
public TimeSeriesQuery.Builder mergeTimeSeriesFilter(TimeSeriesFilter value)Filter parameters to fetch time series.
.google.monitoring.dashboard.v1.TimeSeriesFilter time_series_filter = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
TimeSeriesFilter |
| Returns | |
|---|---|
| Type | Description |
TimeSeriesQuery.Builder |
|
mergeTimeSeriesFilterRatio(TimeSeriesFilterRatio value)
public TimeSeriesQuery.Builder mergeTimeSeriesFilterRatio(TimeSeriesFilterRatio value)Parameters to fetch a ratio between two time series filters.
.google.monitoring.dashboard.v1.TimeSeriesFilterRatio time_series_filter_ratio = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
TimeSeriesFilterRatio |
| Returns | |
|---|---|
| Type | Description |
TimeSeriesQuery.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final TimeSeriesQuery.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
TimeSeriesQuery.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public TimeSeriesQuery.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
TimeSeriesQuery.Builder |
|
setOutputFullDuration(boolean value)
public TimeSeriesQuery.Builder setOutputFullDuration(boolean value)Optional. If set, Cloud Monitoring will treat the full query duration as the alignment period so that there will be only 1 output value.
*Note: This could override the configured alignment period except for the cases where a series of data points are expected, like
- XyChart
- Scorecard's spark chart
bool output_full_duration = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe outputFullDuration to set. |
| Returns | |
|---|---|
| Type | Description |
TimeSeriesQuery.Builder |
This builder for chaining. |
setPrometheusQuery(String value)
public TimeSeriesQuery.Builder setPrometheusQuery(String value)A query used to fetch time series with PromQL.
string prometheus_query = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe prometheusQuery to set. |
| Returns | |
|---|---|
| Type | Description |
TimeSeriesQuery.Builder |
This builder for chaining. |
setPrometheusQueryBytes(ByteString value)
public TimeSeriesQuery.Builder setPrometheusQueryBytes(ByteString value)A query used to fetch time series with PromQL.
string prometheus_query = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for prometheusQuery to set. |
| Returns | |
|---|---|
| Type | Description |
TimeSeriesQuery.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public TimeSeriesQuery.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
TimeSeriesQuery.Builder |
|
setTimeSeriesFilter(TimeSeriesFilter value)
public TimeSeriesQuery.Builder setTimeSeriesFilter(TimeSeriesFilter value)Filter parameters to fetch time series.
.google.monitoring.dashboard.v1.TimeSeriesFilter time_series_filter = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
TimeSeriesFilter |
| Returns | |
|---|---|
| Type | Description |
TimeSeriesQuery.Builder |
|
setTimeSeriesFilter(TimeSeriesFilter.Builder builderForValue)
public TimeSeriesQuery.Builder setTimeSeriesFilter(TimeSeriesFilter.Builder builderForValue)Filter parameters to fetch time series.
.google.monitoring.dashboard.v1.TimeSeriesFilter time_series_filter = 1;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
TimeSeriesFilter.Builder |
| Returns | |
|---|---|
| Type | Description |
TimeSeriesQuery.Builder |
|
setTimeSeriesFilterRatio(TimeSeriesFilterRatio value)
public TimeSeriesQuery.Builder setTimeSeriesFilterRatio(TimeSeriesFilterRatio value)Parameters to fetch a ratio between two time series filters.
.google.monitoring.dashboard.v1.TimeSeriesFilterRatio time_series_filter_ratio = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
TimeSeriesFilterRatio |
| Returns | |
|---|---|
| Type | Description |
TimeSeriesQuery.Builder |
|
setTimeSeriesFilterRatio(TimeSeriesFilterRatio.Builder builderForValue)
public TimeSeriesQuery.Builder setTimeSeriesFilterRatio(TimeSeriesFilterRatio.Builder builderForValue)Parameters to fetch a ratio between two time series filters.
.google.monitoring.dashboard.v1.TimeSeriesFilterRatio time_series_filter_ratio = 2;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
TimeSeriesFilterRatio.Builder |
| Returns | |
|---|---|
| Type | Description |
TimeSeriesQuery.Builder |
|
setTimeSeriesQueryLanguage(String value)
public TimeSeriesQuery.Builder setTimeSeriesQueryLanguage(String value)A query used to fetch time series with MQL.
string time_series_query_language = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe timeSeriesQueryLanguage to set. |
| Returns | |
|---|---|
| Type | Description |
TimeSeriesQuery.Builder |
This builder for chaining. |
setTimeSeriesQueryLanguageBytes(ByteString value)
public TimeSeriesQuery.Builder setTimeSeriesQueryLanguageBytes(ByteString value)A query used to fetch time series with MQL.
string time_series_query_language = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for timeSeriesQueryLanguage to set. |
| Returns | |
|---|---|
| Type | Description |
TimeSeriesQuery.Builder |
This builder for chaining. |
setUnitOverride(String value)
public TimeSeriesQuery.Builder setUnitOverride(String value) The unit of data contained in fetched time series. If non-empty, this
unit will override any unit that accompanies fetched data. The format is
the same as the
unit
field in MetricDescriptor.
string unit_override = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe unitOverride to set. |
| Returns | |
|---|---|
| Type | Description |
TimeSeriesQuery.Builder |
This builder for chaining. |
setUnitOverrideBytes(ByteString value)
public TimeSeriesQuery.Builder setUnitOverrideBytes(ByteString value) The unit of data contained in fetched time series. If non-empty, this
unit will override any unit that accompanies fetched data. The format is
the same as the
unit
field in MetricDescriptor.
string unit_override = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for unitOverride to set. |
| Returns | |
|---|---|
| Type | Description |
TimeSeriesQuery.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final TimeSeriesQuery.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
TimeSeriesQuery.Builder |
|