Class TimeSeriesQuery (2.8.0)

Stay organized with collections Save and categorize content based on your preferences.
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

Static Fields

PROMETHEUS_QUERY_FIELD_NUMBER

public static final int PROMETHEUS_QUERY_FIELD_NUMBER
Field Value
TypeDescription
int

TIME_SERIES_FILTER_FIELD_NUMBER

public static final int TIME_SERIES_FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

TIME_SERIES_FILTER_RATIO_FIELD_NUMBER

public static final int TIME_SERIES_FILTER_RATIO_FIELD_NUMBER
Field Value
TypeDescription
int

TIME_SERIES_QUERY_LANGUAGE_FIELD_NUMBER

public static final int TIME_SERIES_QUERY_LANGUAGE_FIELD_NUMBER
Field Value
TypeDescription
int

UNIT_OVERRIDE_FIELD_NUMBER

public static final int UNIT_OVERRIDE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static TimeSeriesQuery getDefaultInstance()
Returns
TypeDescription
TimeSeriesQuery

getDescriptor()

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

newBuilder()

public static TimeSeriesQuery.Builder newBuilder()
Returns
TypeDescription
TimeSeriesQuery.Builder

newBuilder(TimeSeriesQuery prototype)

public static TimeSeriesQuery.Builder newBuilder(TimeSeriesQuery prototype)
Parameter
NameDescription
prototypeTimeSeriesQuery
Returns
TypeDescription
TimeSeriesQuery.Builder

parseDelimitedFrom(InputStream input)

public static TimeSeriesQuery parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TimeSeriesQuery
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TimeSeriesQuery parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TimeSeriesQuery
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static TimeSeriesQuery parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
TimeSeriesQuery
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TimeSeriesQuery parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TimeSeriesQuery
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TimeSeriesQuery parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
TimeSeriesQuery
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TimeSeriesQuery parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TimeSeriesQuery
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TimeSeriesQuery parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
TimeSeriesQuery
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TimeSeriesQuery parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TimeSeriesQuery
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static TimeSeriesQuery parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TimeSeriesQuery
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TimeSeriesQuery parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TimeSeriesQuery
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static TimeSeriesQuery parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
TimeSeriesQuery
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TimeSeriesQuery parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TimeSeriesQuery
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<TimeSeriesQuery> parser()
Returns
TypeDescription
Parser<TimeSeriesQuery>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public TimeSeriesQuery getDefaultInstanceForType()
Returns
TypeDescription
TimeSeriesQuery

getParserForType()

public Parser<TimeSeriesQuery> getParserForType()
Returns
TypeDescription
Parser<TimeSeriesQuery>
Overrides

getPrometheusQuery()

public String getPrometheusQuery()

A query used to fetch time series with PromQL.

string prometheus_query = 6;

Returns
TypeDescription
String

The prometheusQuery.

getPrometheusQueryBytes()

public ByteString getPrometheusQueryBytes()

A query used to fetch time series with PromQL.

string prometheus_query = 6;

Returns
TypeDescription
ByteString

The bytes for prometheusQuery.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSourceCase()

public TimeSeriesQuery.SourceCase getSourceCase()
Returns
TypeDescription
TimeSeriesQuery.SourceCase

getTimeSeriesFilter()

public TimeSeriesFilter getTimeSeriesFilter()

Filter parameters to fetch time series.

.google.monitoring.dashboard.v1.TimeSeriesFilter time_series_filter = 1;

Returns
TypeDescription
TimeSeriesFilter

The timeSeriesFilter.

getTimeSeriesFilterOrBuilder()

public TimeSeriesFilterOrBuilder getTimeSeriesFilterOrBuilder()

Filter parameters to fetch time series.

.google.monitoring.dashboard.v1.TimeSeriesFilter time_series_filter = 1;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
TimeSeriesFilterRatioOrBuilder

getTimeSeriesQueryLanguage()

public String getTimeSeriesQueryLanguage()

A query used to fetch time series with MQL.

string time_series_query_language = 3;

Returns
TypeDescription
String

The timeSeriesQueryLanguage.

getTimeSeriesQueryLanguageBytes()

public ByteString getTimeSeriesQueryLanguageBytes()

A query used to fetch time series with MQL.

string time_series_query_language = 3;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for unitOverride.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasPrometheusQuery()

public boolean hasPrometheusQuery()

A query used to fetch time series with PromQL.

string prometheus_query = 6;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the timeSeriesQueryLanguage field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public TimeSeriesQuery.Builder newBuilderForType()
Returns
TypeDescription
TimeSeriesQuery.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TimeSeriesQuery.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
TimeSeriesQuery.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public TimeSeriesQuery.Builder toBuilder()
Returns
TypeDescription
TimeSeriesQuery.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException