Class PickTimeSeriesFilter (2.17.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
TypeDescription
int

NUM_TIME_SERIES_FIELD_NUMBER

public static final int NUM_TIME_SERIES_FIELD_NUMBER
Field Value
TypeDescription
int

RANKING_METHOD_FIELD_NUMBER

public static final int RANKING_METHOD_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static PickTimeSeriesFilter getDefaultInstance()
Returns
TypeDescription
PickTimeSeriesFilter

getDescriptor()

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

newBuilder()

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

newBuilder(PickTimeSeriesFilter prototype)

public static PickTimeSeriesFilter.Builder newBuilder(PickTimeSeriesFilter prototype)
Parameter
NameDescription
prototypePickTimeSeriesFilter
Returns
TypeDescription
PickTimeSeriesFilter.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public PickTimeSeriesFilter getDefaultInstanceForType()
Returns
TypeDescription
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
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.

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.

getParserForType()

public Parser<PickTimeSeriesFilter> getParserForType()
Returns
TypeDescription
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
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.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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 PickTimeSeriesFilter.Builder newBuilderForType()
Returns
TypeDescription
PickTimeSeriesFilter.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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