Class Threshold (2.56.0)

public final class Threshold extends GeneratedMessageV3 implements ThresholdOrBuilder

Defines a threshold for categorizing time series values.

Protobuf type google.monitoring.dashboard.v1.Threshold

Implements

ThresholdOrBuilder

Static Fields

COLOR_FIELD_NUMBER

public static final int COLOR_FIELD_NUMBER
Field Value
Type Description
int

DIRECTION_FIELD_NUMBER

public static final int DIRECTION_FIELD_NUMBER
Field Value
Type Description
int

LABEL_FIELD_NUMBER

public static final int LABEL_FIELD_NUMBER
Field Value
Type Description
int

TARGET_AXIS_FIELD_NUMBER

public static final int TARGET_AXIS_FIELD_NUMBER
Field Value
Type Description
int

VALUE_FIELD_NUMBER

public static final int VALUE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Threshold getDefaultInstance()
Returns
Type Description
Threshold

getDescriptor()

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

newBuilder()

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

newBuilder(Threshold prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getColor()

public Threshold.Color getColor()

The state color for this threshold. Color is not allowed in a XyChart.

.google.monitoring.dashboard.v1.Threshold.Color color = 3;

Returns
Type Description
Threshold.Color

The color.

getColorValue()

public int getColorValue()

The state color for this threshold. Color is not allowed in a XyChart.

.google.monitoring.dashboard.v1.Threshold.Color color = 3;

Returns
Type Description
int

The enum numeric value on the wire for color.

getDefaultInstanceForType()

public Threshold getDefaultInstanceForType()
Returns
Type Description
Threshold

getDirection()

public Threshold.Direction getDirection()

The direction for the current threshold. Direction is not allowed in a XyChart.

.google.monitoring.dashboard.v1.Threshold.Direction direction = 4;

Returns
Type Description
Threshold.Direction

The direction.

getDirectionValue()

public int getDirectionValue()

The direction for the current threshold. Direction is not allowed in a XyChart.

.google.monitoring.dashboard.v1.Threshold.Direction direction = 4;

Returns
Type Description
int

The enum numeric value on the wire for direction.

getLabel()

public String getLabel()

A label for the threshold.

string label = 1;

Returns
Type Description
String

The label.

getLabelBytes()

public ByteString getLabelBytes()

A label for the threshold.

string label = 1;

Returns
Type Description
ByteString

The bytes for label.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTargetAxis()

public Threshold.TargetAxis getTargetAxis()

The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard.

.google.monitoring.dashboard.v1.Threshold.TargetAxis target_axis = 5;

Returns
Type Description
Threshold.TargetAxis

The targetAxis.

getTargetAxisValue()

public int getTargetAxisValue()

The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard.

.google.monitoring.dashboard.v1.Threshold.TargetAxis target_axis = 5;

Returns
Type Description
int

The enum numeric value on the wire for targetAxis.

getValue()

public double getValue()

The value of the threshold. The value should be defined in the native scale of the metric.

double value = 2;

Returns
Type Description
double

The value.

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 Threshold.Builder newBuilderForType()
Returns
Type Description
Threshold.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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