public final class TimeSeriesQuery extends GeneratedMessageV3 implements TimeSeriesQueryOrBuilder
TimeSeriesQuery collects the set of supported methods for querying time
series data from the Stackdriver metrics API.
Protobuf type google.monitoring.dashboard.v1.TimeSeriesQuery
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
OUTPUT_FULL_DURATION_FIELD_NUMBER
public static final int OUTPUT_FULL_DURATION_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
PROMETHEUS_QUERY_FIELD_NUMBER
public static final int PROMETHEUS_QUERY_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
TIME_SERIES_FILTER_FIELD_NUMBER
public static final int TIME_SERIES_FILTER_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
TIME_SERIES_FILTER_RATIO_FIELD_NUMBER
public static final int TIME_SERIES_FILTER_RATIO_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
TIME_SERIES_QUERY_LANGUAGE_FIELD_NUMBER
public static final int TIME_SERIES_QUERY_LANGUAGE_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
UNIT_OVERRIDE_FIELD_NUMBER
public static final int UNIT_OVERRIDE_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static TimeSeriesQuery getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static TimeSeriesQuery.Builder newBuilder()
newBuilder(TimeSeriesQuery prototype)
public static TimeSeriesQuery.Builder newBuilder(TimeSeriesQuery prototype)
public static TimeSeriesQuery parseDelimitedFrom(InputStream input)
public static TimeSeriesQuery parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static TimeSeriesQuery parseFrom(byte[] data)
Parameter |
Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static TimeSeriesQuery parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static TimeSeriesQuery parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TimeSeriesQuery parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static TimeSeriesQuery parseFrom(CodedInputStream input)
public static TimeSeriesQuery parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static TimeSeriesQuery parseFrom(InputStream input)
public static TimeSeriesQuery parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static TimeSeriesQuery parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static TimeSeriesQuery parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<TimeSeriesQuery> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter |
Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public TimeSeriesQuery getDefaultInstanceForType()
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.
|
getParserForType()
public Parser<TimeSeriesQuery> getParserForType()
Overrides
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.
|
getSerializedSize()
public int getSerializedSize()
Returns |
Type |
Description |
int |
|
Overrides
getSourceCase()
public TimeSeriesQuery.SourceCase getSourceCase()
getTimeSeriesFilter()
public TimeSeriesFilter getTimeSeriesFilter()
Filter parameters to fetch time series.
.google.monitoring.dashboard.v1.TimeSeriesFilter time_series_filter = 1;
getTimeSeriesFilterOrBuilder()
public TimeSeriesFilterOrBuilder getTimeSeriesFilterOrBuilder()
Filter parameters to fetch time series.
.google.monitoring.dashboard.v1.TimeSeriesFilter time_series_filter = 1;
getTimeSeriesFilterRatio()
public TimeSeriesFilterRatio getTimeSeriesFilterRatio()
Parameters to fetch a ratio between two time series filters.
.google.monitoring.dashboard.v1.TimeSeriesFilterRatio time_series_filter_ratio = 2;
getTimeSeriesFilterRatioOrBuilder()
public TimeSeriesFilterRatioOrBuilder getTimeSeriesFilterRatioOrBuilder()
Parameters to fetch a ratio between two time series filters.
.google.monitoring.dashboard.v1.TimeSeriesFilterRatio time_series_filter_ratio = 2;
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.
|
hashCode()
Returns |
Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public TimeSeriesQuery.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected TimeSeriesQuery.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Returns |
Type |
Description |
Object |
|
Overrides
toBuilder()
public TimeSeriesQuery.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides