Class TimeSeriesFilter (2.57.0) 

public final class TimeSeriesFilter extends GeneratedMessageV3 implements TimeSeriesFilterOrBuilder

A filter that defines a subset of time series data that is displayed in a widget. Time series data is fetched using the ListTimeSeries method.

Protobuf type google.monitoring.dashboard.v1.TimeSeriesFilter

Inheritance

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

Static Fields

AGGREGATION_FIELD_NUMBER

public static final int AGGREGATION_FIELD_NUMBER
Field Value
Type Description
int

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
Type Description
int

PICK_TIME_SERIES_FILTER_FIELD_NUMBER

public static final int PICK_TIME_SERIES_FILTER_FIELD_NUMBER
Field Value
Type Description
int

SECONDARY_AGGREGATION_FIELD_NUMBER

public static final int SECONDARY_AGGREGATION_FIELD_NUMBER
Field Value
Type Description
int

STATISTICAL_TIME_SERIES_FILTER_FIELD_NUMBER

public static final int STATISTICAL_TIME_SERIES_FILTER_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static TimeSeriesFilter getDefaultInstance()
Returns
Type Description
TimeSeriesFilter

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static TimeSeriesFilter.Builder newBuilder()
Returns
Type Description
TimeSeriesFilter.Builder

newBuilder(TimeSeriesFilter prototype)

public static TimeSeriesFilter.Builder newBuilder(TimeSeriesFilter prototype)
Parameter
Name Description
prototype TimeSeriesFilter
Returns
Type Description
TimeSeriesFilter.Builder

parseDelimitedFrom(InputStream input)

public static TimeSeriesFilter parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TimeSeriesFilter
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TimeSeriesFilter parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TimeSeriesFilter
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static TimeSeriesFilter parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
TimeSeriesFilter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TimeSeriesFilter parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TimeSeriesFilter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TimeSeriesFilter parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
TimeSeriesFilter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TimeSeriesFilter parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TimeSeriesFilter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TimeSeriesFilter parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
TimeSeriesFilter
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TimeSeriesFilter parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TimeSeriesFilter
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static TimeSeriesFilter parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TimeSeriesFilter
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TimeSeriesFilter parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TimeSeriesFilter
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static TimeSeriesFilter parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
TimeSeriesFilter
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TimeSeriesFilter parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TimeSeriesFilter
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<TimeSeriesFilter> parser()
Returns
Type Description
Parser<TimeSeriesFilter>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAggregation()

public Aggregation getAggregation()

By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data.

.google.monitoring.dashboard.v1.Aggregation aggregation = 2;

Returns
Type Description
Aggregation

The aggregation.

getAggregationOrBuilder()

public AggregationOrBuilder getAggregationOrBuilder()

By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data.

.google.monitoring.dashboard.v1.Aggregation aggregation = 2;

Returns
Type Description
AggregationOrBuilder

getDefaultInstanceForType()

public TimeSeriesFilter getDefaultInstanceForType()
Returns
Type Description
TimeSeriesFilter

getFilter()

public String getFilter()

Required. The monitoring filter that identifies the metric types, resources, and projects to query.

string filter = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The filter.

getFilterBytes()

public ByteString getFilterBytes()

Required. The monitoring filter that identifies the metric types, resources, and projects to query.

string filter = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for filter.

getOutputFilterCase()

public TimeSeriesFilter.OutputFilterCase getOutputFilterCase()
Returns
Type Description
TimeSeriesFilter.OutputFilterCase

getParserForType()

public Parser<TimeSeriesFilter> getParserForType()
Returns
Type Description
Parser<TimeSeriesFilter>
Overrides

getPickTimeSeriesFilter()

public PickTimeSeriesFilter getPickTimeSeriesFilter()

Ranking based time series filter.

.google.monitoring.dashboard.v1.PickTimeSeriesFilter pick_time_series_filter = 4;

Returns
Type Description
PickTimeSeriesFilter

The pickTimeSeriesFilter.

getPickTimeSeriesFilterOrBuilder()

public PickTimeSeriesFilterOrBuilder getPickTimeSeriesFilterOrBuilder()

Ranking based time series filter.

.google.monitoring.dashboard.v1.PickTimeSeriesFilter pick_time_series_filter = 4;

Returns
Type Description
PickTimeSeriesFilterOrBuilder

getSecondaryAggregation()

public Aggregation getSecondaryAggregation()

Apply a second aggregation after aggregation is applied.

.google.monitoring.dashboard.v1.Aggregation secondary_aggregation = 3;

Returns
Type Description
Aggregation

The secondaryAggregation.

getSecondaryAggregationOrBuilder()

public AggregationOrBuilder getSecondaryAggregationOrBuilder()

Apply a second aggregation after aggregation is applied.

.google.monitoring.dashboard.v1.Aggregation secondary_aggregation = 3;

Returns
Type Description
AggregationOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStatisticalTimeSeriesFilter() (deprecated)

public StatisticalTimeSeriesFilter getStatisticalTimeSeriesFilter()

Deprecated. google.monitoring.dashboard.v1.TimeSeriesFilter.statistical_time_series_filter is deprecated. See google/monitoring/dashboard/v1/metrics.proto;l=89

Statistics based time series filter. Note: This field is deprecated and completely ignored by the API.

.google.monitoring.dashboard.v1.StatisticalTimeSeriesFilter statistical_time_series_filter = 5 [deprecated = true];

Returns
Type Description
StatisticalTimeSeriesFilter

The statisticalTimeSeriesFilter.

getStatisticalTimeSeriesFilterOrBuilder() (deprecated)

public StatisticalTimeSeriesFilterOrBuilder getStatisticalTimeSeriesFilterOrBuilder()

Statistics based time series filter. Note: This field is deprecated and completely ignored by the API.

.google.monitoring.dashboard.v1.StatisticalTimeSeriesFilter statistical_time_series_filter = 5 [deprecated = true];

Returns
Type Description
StatisticalTimeSeriesFilterOrBuilder

hasAggregation()

public boolean hasAggregation()

By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data.

.google.monitoring.dashboard.v1.Aggregation aggregation = 2;

Returns
Type Description
boolean

Whether the aggregation field is set.

hasPickTimeSeriesFilter()

public boolean hasPickTimeSeriesFilter()

Ranking based time series filter.

.google.monitoring.dashboard.v1.PickTimeSeriesFilter pick_time_series_filter = 4;

Returns
Type Description
boolean

Whether the pickTimeSeriesFilter field is set.

hasSecondaryAggregation()

public boolean hasSecondaryAggregation()

Apply a second aggregation after aggregation is applied.

.google.monitoring.dashboard.v1.Aggregation secondary_aggregation = 3;

Returns
Type Description
boolean

Whether the secondaryAggregation field is set.

hasStatisticalTimeSeriesFilter() (deprecated)

public boolean hasStatisticalTimeSeriesFilter()

Deprecated. google.monitoring.dashboard.v1.TimeSeriesFilter.statistical_time_series_filter is deprecated. See google/monitoring/dashboard/v1/metrics.proto;l=89

Statistics based time series filter. Note: This field is deprecated and completely ignored by the API.

.google.monitoring.dashboard.v1.StatisticalTimeSeriesFilter statistical_time_series_filter = 5 [deprecated = true];

Returns
Type Description
boolean

Whether the statisticalTimeSeriesFilter field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public TimeSeriesFilter.Builder newBuilderForType()
Returns
Type Description
TimeSeriesFilter.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TimeSeriesFilter.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TimeSeriesFilter.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public TimeSeriesFilter.Builder toBuilder()
Returns
Type Description
TimeSeriesFilter.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException