Class TimeSeriesQuery (2.57.0)

Version latest

• 2.57.0 (latest)
• 2.56.0
• 2.55.0
• 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 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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > TimeSeriesQuery

Implements

TimeSeriesQueryOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,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()

Returns
Type	Description
TimeSeriesQuery

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static TimeSeriesQuery.Builder newBuilder()

Returns
Type	Description
TimeSeriesQuery.Builder

newBuilder(TimeSeriesQuery prototype)

public static TimeSeriesQuery.Builder newBuilder(TimeSeriesQuery prototype)

Parameter
Name	Description
prototype	TimeSeriesQuery

Returns
Type	Description
TimeSeriesQuery.Builder

parseDelimitedFrom(InputStream input)

public static TimeSeriesQuery parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
TimeSeriesQuery

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TimeSeriesQuery parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TimeSeriesQuery

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static TimeSeriesQuery parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
TimeSeriesQuery

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TimeSeriesQuery parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TimeSeriesQuery

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TimeSeriesQuery parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
TimeSeriesQuery

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TimeSeriesQuery parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TimeSeriesQuery

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TimeSeriesQuery parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
TimeSeriesQuery

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TimeSeriesQuery parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TimeSeriesQuery

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static TimeSeriesQuery parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
TimeSeriesQuery

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TimeSeriesQuery parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TimeSeriesQuery

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static TimeSeriesQuery parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
TimeSeriesQuery

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TimeSeriesQuery parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
TimeSeriesQuery

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<TimeSeriesQuery> parser()

Returns
Type	Description
Parser<TimeSeriesQuery>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public TimeSeriesQuery getDefaultInstanceForType()

Returns
Type	Description
TimeSeriesQuery

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()

Returns
Type	Description
Parser<TimeSeriesQuery>

Overrides

GeneratedMessageV3.getParserForType()

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

GeneratedMessageV3.getSerializedSize()

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.

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.

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.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public TimeSeriesQuery.Builder newBuilderForType()

Returns
Type	Description
TimeSeriesQuery.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TimeSeriesQuery.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
TimeSeriesQuery.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public TimeSeriesQuery.Builder toBuilder()

Returns
Type	Description
TimeSeriesQuery.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException