Class PickTimeSeriesFilter.Builder (2.38.0)

public static final class PickTimeSeriesFilter.Builder extends GeneratedMessageV3.Builder<PickTimeSeriesFilter.Builder> 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 Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PickTimeSeriesFilter.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PickTimeSeriesFilter.Builder
Overrides

build()

public PickTimeSeriesFilter build()
Returns
TypeDescription
PickTimeSeriesFilter

buildPartial()

public PickTimeSeriesFilter buildPartial()
Returns
TypeDescription
PickTimeSeriesFilter

clear()

public PickTimeSeriesFilter.Builder clear()
Returns
TypeDescription
PickTimeSeriesFilter.Builder
Overrides

clearDirection()

public PickTimeSeriesFilter.Builder clearDirection()

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

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

Returns
TypeDescription
PickTimeSeriesFilter.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public PickTimeSeriesFilter.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
PickTimeSeriesFilter.Builder
Overrides

clearInterval()

public PickTimeSeriesFilter.Builder clearInterval()

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

.google.type.Interval interval = 4;

Returns
TypeDescription
PickTimeSeriesFilter.Builder

clearNumTimeSeries()

public PickTimeSeriesFilter.Builder clearNumTimeSeries()

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

int32 num_time_series = 2;

Returns
TypeDescription
PickTimeSeriesFilter.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public PickTimeSeriesFilter.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
PickTimeSeriesFilter.Builder
Overrides

clearRankingMethod()

public PickTimeSeriesFilter.Builder clearRankingMethod()

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
TypeDescription
PickTimeSeriesFilter.Builder

This builder for chaining.

clone()

public PickTimeSeriesFilter.Builder clone()
Returns
TypeDescription
PickTimeSeriesFilter.Builder
Overrides

getDefaultInstanceForType()

public PickTimeSeriesFilter getDefaultInstanceForType()
Returns
TypeDescription
PickTimeSeriesFilter

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
com.google.type.Interval

The interval.

getIntervalBuilder()

public Interval.Builder getIntervalBuilder()

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

.google.type.Interval interval = 4;

Returns
TypeDescription
com.google.type.Interval.Builder

getIntervalOrBuilder()

public IntervalOrBuilder getIntervalOrBuilder()

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

.google.type.Interval interval = 4;

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

The numTimeSeries.

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

The enum numeric value on the wire for rankingMethod.

hasInterval()

public boolean hasInterval()

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

.google.type.Interval interval = 4;

Returns
TypeDescription
boolean

Whether the interval field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(PickTimeSeriesFilter other)

public PickTimeSeriesFilter.Builder mergeFrom(PickTimeSeriesFilter other)
Parameter
NameDescription
otherPickTimeSeriesFilter
Returns
TypeDescription
PickTimeSeriesFilter.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PickTimeSeriesFilter.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PickTimeSeriesFilter.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public PickTimeSeriesFilter.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
PickTimeSeriesFilter.Builder
Overrides

mergeInterval(Interval value)

public PickTimeSeriesFilter.Builder mergeInterval(Interval value)

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

.google.type.Interval interval = 4;

Parameter
NameDescription
valuecom.google.type.Interval
Returns
TypeDescription
PickTimeSeriesFilter.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PickTimeSeriesFilter.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PickTimeSeriesFilter.Builder
Overrides

setDirection(PickTimeSeriesFilter.Direction value)

public PickTimeSeriesFilter.Builder setDirection(PickTimeSeriesFilter.Direction value)

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

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

Parameter
NameDescription
valuePickTimeSeriesFilter.Direction

The direction to set.

Returns
TypeDescription
PickTimeSeriesFilter.Builder

This builder for chaining.

setDirectionValue(int value)

public PickTimeSeriesFilter.Builder setDirectionValue(int value)

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

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

Parameter
NameDescription
valueint

The enum numeric value on the wire for direction to set.

Returns
TypeDescription
PickTimeSeriesFilter.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public PickTimeSeriesFilter.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
PickTimeSeriesFilter.Builder
Overrides

setInterval(Interval value)

public PickTimeSeriesFilter.Builder setInterval(Interval value)

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

.google.type.Interval interval = 4;

Parameter
NameDescription
valuecom.google.type.Interval
Returns
TypeDescription
PickTimeSeriesFilter.Builder

setInterval(Interval.Builder builderForValue)

public PickTimeSeriesFilter.Builder setInterval(Interval.Builder builderForValue)

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

.google.type.Interval interval = 4;

Parameter
NameDescription
builderForValuecom.google.type.Interval.Builder
Returns
TypeDescription
PickTimeSeriesFilter.Builder

setNumTimeSeries(int value)

public PickTimeSeriesFilter.Builder setNumTimeSeries(int value)

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

int32 num_time_series = 2;

Parameter
NameDescription
valueint

The numTimeSeries to set.

Returns
TypeDescription
PickTimeSeriesFilter.Builder

This builder for chaining.

setRankingMethod(PickTimeSeriesFilter.Method value)

public PickTimeSeriesFilter.Builder setRankingMethod(PickTimeSeriesFilter.Method value)

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;

Parameter
NameDescription
valuePickTimeSeriesFilter.Method

The rankingMethod to set.

Returns
TypeDescription
PickTimeSeriesFilter.Builder

This builder for chaining.

setRankingMethodValue(int value)

public PickTimeSeriesFilter.Builder setRankingMethodValue(int value)

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;

Parameter
NameDescription
valueint

The enum numeric value on the wire for rankingMethod to set.

Returns
TypeDescription
PickTimeSeriesFilter.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public PickTimeSeriesFilter.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
PickTimeSeriesFilter.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final PickTimeSeriesFilter.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
PickTimeSeriesFilter.Builder
Overrides