Class TimeSeriesFilter (2.8.0)

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

Static Fields

AGGREGATION_FIELD_NUMBER

public static final int AGGREGATION_FIELD_NUMBER
Field Value
TypeDescription
int

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

PICK_TIME_SERIES_FILTER_FIELD_NUMBER

public static final int PICK_TIME_SERIES_FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

SECONDARY_AGGREGATION_FIELD_NUMBER

public static final int SECONDARY_AGGREGATION_FIELD_NUMBER
Field Value
TypeDescription
int

STATISTICAL_TIME_SERIES_FILTER_FIELD_NUMBER

public static final int STATISTICAL_TIME_SERIES_FILTER_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static TimeSeriesFilter getDefaultInstance()
Returns
TypeDescription
TimeSeriesFilter

getDescriptor()

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

newBuilder()

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

newBuilder(TimeSeriesFilter prototype)

public static TimeSeriesFilter.Builder newBuilder(TimeSeriesFilter prototype)
Parameter
NameDescription
prototypeTimeSeriesFilter
Returns
TypeDescription
TimeSeriesFilter.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
AggregationOrBuilder

getDefaultInstanceForType()

public TimeSeriesFilter getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for filter.

getOutputFilterCase()

public TimeSeriesFilter.OutputFilterCase getOutputFilterCase()
Returns
TypeDescription
TimeSeriesFilter.OutputFilterCase

getParserForType()

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

getPickTimeSeriesFilter()

public PickTimeSeriesFilter getPickTimeSeriesFilter()

Ranking based time series filter.

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

Returns
TypeDescription
PickTimeSeriesFilter

The pickTimeSeriesFilter.

getPickTimeSeriesFilterOrBuilder()

public PickTimeSeriesFilterOrBuilder getPickTimeSeriesFilterOrBuilder()

Ranking based time series filter.

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

Returns
TypeDescription
PickTimeSeriesFilterOrBuilder

getSecondaryAggregation()

public Aggregation getSecondaryAggregation()

Apply a second aggregation after aggregation is applied.

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

Returns
TypeDescription
Aggregation

The secondaryAggregation.

getSecondaryAggregationOrBuilder()

public AggregationOrBuilder getSecondaryAggregationOrBuilder()

Apply a second aggregation after aggregation is applied.

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

Returns
TypeDescription
AggregationOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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=79

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
TypeDescription
StatisticalTimeSeriesFilter

The statisticalTimeSeriesFilter.

getStatisticalTimeSeriesFilterOrBuilder()

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
TypeDescription
StatisticalTimeSeriesFilterOrBuilder

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
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=79

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

Whether the statisticalTimeSeriesFilter 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 TimeSeriesFilter.Builder newBuilderForType()
Returns
TypeDescription
TimeSeriesFilter.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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