Class PickTimeSeriesFilter.Builder (2.39.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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > PickTimeSeriesFilter.Builder

Implements

PickTimeSeriesFilterOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public PickTimeSeriesFilter.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`PickTimeSeriesFilter.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public PickTimeSeriesFilter build()

Returns
Type	Description
`PickTimeSeriesFilter`

buildPartial()

public PickTimeSeriesFilter buildPartial()

Returns
Type	Description
`PickTimeSeriesFilter`

clear()

public PickTimeSeriesFilter.Builder clear()

Returns
Type	Description
`PickTimeSeriesFilter.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

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
Type	Description
`PickTimeSeriesFilter.Builder`	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public PickTimeSeriesFilter.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`PickTimeSeriesFilter.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearInterval()

public PickTimeSeriesFilter.Builder clearInterval()

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

.google.type.Interval interval = 4;

Returns
Type	Description
`PickTimeSeriesFilter.Builder`

clearNumTimeSeries()

public PickTimeSeriesFilter.Builder clearNumTimeSeries()

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

int32 num_time_series = 2;

Returns
Type	Description
`PickTimeSeriesFilter.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public PickTimeSeriesFilter.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`PickTimeSeriesFilter.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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
Type	Description
`PickTimeSeriesFilter.Builder`	This builder for chaining.

clone()

public PickTimeSeriesFilter.Builder clone()

Returns
Type	Description
`PickTimeSeriesFilter.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public PickTimeSeriesFilter getDefaultInstanceForType()

Returns
Type	Description
`PickTimeSeriesFilter`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

getIntervalBuilder()

public Interval.Builder getIntervalBuilder()

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

.google.type.Interval interval = 4;

Returns
Type	Description
`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
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.

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(PickTimeSeriesFilter other)

public PickTimeSeriesFilter.Builder mergeFrom(PickTimeSeriesFilter other)

Parameter
Name	Description
`other`	`PickTimeSeriesFilter`

Returns
Type	Description
`PickTimeSeriesFilter.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public PickTimeSeriesFilter.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`PickTimeSeriesFilter.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public PickTimeSeriesFilter.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`PickTimeSeriesFilter.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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
Name	Description
`value`	`com.google.type.Interval`

Returns
Type	Description
`PickTimeSeriesFilter.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final PickTimeSeriesFilter.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`PickTimeSeriesFilter.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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
Name	Description
`value`	`PickTimeSeriesFilter.Direction` The direction to set.

Returns
Type	Description
`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
Name	Description
`value`	`int` The enum numeric value on the wire for direction to set.

Returns
Type	Description
`PickTimeSeriesFilter.Builder`	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public PickTimeSeriesFilter.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`PickTimeSeriesFilter.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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
Name	Description
`value`	`com.google.type.Interval`

Returns
Type	Description
`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
Name	Description
`builderForValue`	`com.google.type.Interval.Builder`

Returns
Type	Description
`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
Name	Description
`value`	`int` The numTimeSeries to set.

Returns
Type	Description
`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
Name	Description
`value`	`PickTimeSeriesFilter.Method` The rankingMethod to set.

Returns
Type	Description
`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
Name	Description
`value`	`int` The enum numeric value on the wire for rankingMethod to set.

Returns
Type	Description
`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
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`PickTimeSeriesFilter.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final PickTimeSeriesFilter.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`PickTimeSeriesFilter.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)