Class PickTimeSeriesFilter (2.48.0)

public final class PickTimeSeriesFilter extends GeneratedMessageV3 implements PickTimeSeriesFilterOrBuilder

Describes a ranking-based time series filter. Each input time series is ranked with an aligner. The filter will allow up to num_time_series time series to pass through it, selecting them based on the relative ranking.

For example, if ranking_method is METHOD_MEAN,direction is BOTTOM, and num_time_series is 3, then the 3 times series with the lowest mean values will pass through the filter.

Protobuf type google.monitoring.dashboard.v1.PickTimeSeriesFilter

Static Fields

DIRECTION_FIELD_NUMBER

public static final int DIRECTION_FIELD_NUMBER
Field Value
Type Description
int

INTERVAL_FIELD_NUMBER

public static final int INTERVAL_FIELD_NUMBER
Field Value
Type Description
int

NUM_TIME_SERIES_FIELD_NUMBER

public static final int NUM_TIME_SERIES_FIELD_NUMBER
Field Value
Type Description
int

RANKING_METHOD_FIELD_NUMBER

public static final int RANKING_METHOD_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PickTimeSeriesFilter getDefaultInstance()
Returns
Type Description
PickTimeSeriesFilter

getDescriptor()

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

newBuilder()

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

newBuilder(PickTimeSeriesFilter prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public PickTimeSeriesFilter getDefaultInstanceForType()
Returns
Type Description
PickTimeSeriesFilter

getDirection()

public PickTimeSeriesFilter.Direction getDirection()

How to use the ranking to select time series that pass through the filter.

.google.monitoring.dashboard.v1.PickTimeSeriesFilter.Direction direction = 3;

Returns
Type Description
PickTimeSeriesFilter.Direction

The direction.

getDirectionValue()

public int getDirectionValue()

How to use the ranking to select time series that pass through the filter.

.google.monitoring.dashboard.v1.PickTimeSeriesFilter.Direction direction = 3;

Returns
Type Description
int

The enum numeric value on the wire for direction.

getInterval()

public Interval getInterval()

Select the top N streams/time series within this time interval

.google.type.Interval interval = 4;

Returns
Type Description
com.google.type.Interval

The interval.

getIntervalOrBuilder()

public IntervalOrBuilder getIntervalOrBuilder()

Select the top N streams/time series within this time interval

.google.type.Interval interval = 4;

Returns
Type Description
com.google.type.IntervalOrBuilder

getNumTimeSeries()

public int getNumTimeSeries()

How many time series to allow to pass through the filter.

int32 num_time_series = 2;

Returns
Type Description
int

The numTimeSeries.

getParserForType()

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

getRankingMethod()

public PickTimeSeriesFilter.Method getRankingMethod()

ranking_method is applied to each time series independently to produce the value which will be used to compare the time series to other time series.

.google.monitoring.dashboard.v1.PickTimeSeriesFilter.Method ranking_method = 1;

Returns
Type Description
PickTimeSeriesFilter.Method

The rankingMethod.

getRankingMethodValue()

public int getRankingMethodValue()

ranking_method is applied to each time series independently to produce the value which will be used to compare the time series to other time series.

.google.monitoring.dashboard.v1.PickTimeSeriesFilter.Method ranking_method = 1;

Returns
Type Description
int

The enum numeric value on the wire for rankingMethod.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasInterval()

public boolean hasInterval()

Select the top N streams/time series within this time interval

.google.type.Interval interval = 4;

Returns
Type Description
boolean

Whether the interval 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 PickTimeSeriesFilter.Builder newBuilderForType()
Returns
Type Description
PickTimeSeriesFilter.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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