Class Threshold (2.38.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
TypeDescription
int

DIRECTION_FIELD_NUMBER

public static final int DIRECTION_FIELD_NUMBER
Field Value
TypeDescription
int

LABEL_FIELD_NUMBER

public static final int LABEL_FIELD_NUMBER
Field Value
TypeDescription
int

TARGET_AXIS_FIELD_NUMBER

public static final int TARGET_AXIS_FIELD_NUMBER
Field Value
TypeDescription
int

VALUE_FIELD_NUMBER

public static final int VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Threshold getDefaultInstance()
Returns
TypeDescription
Threshold

getDescriptor()

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

newBuilder()

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

newBuilder(Threshold prototype)

public static Threshold.Builder newBuilder(Threshold prototype)
Parameter
NameDescription
prototypeThreshold
Returns
TypeDescription
Threshold.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
int

The enum numeric value on the wire for color.

getDefaultInstanceForType()

public Threshold getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
int

The enum numeric value on the wire for direction.

getLabel()

public String getLabel()

A label for the threshold.

string label = 1;

Returns
TypeDescription
String

The label.

getLabelBytes()

public ByteString getLabelBytes()

A label for the threshold.

string label = 1;

Returns
TypeDescription
ByteString

The bytes for label.

getParserForType()

public Parser<Threshold> getParserForType()
Returns
TypeDescription
Parser<Threshold>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
double

The value.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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