Class ThresholdRule (2.45.0) 

public final class ThresholdRule extends GeneratedMessageV3 implements ThresholdRuleOrBuilder

ThresholdRule contains the definition of a threshold. Threshold rules define the triggering events used to generate a budget notification email. When a threshold is crossed (spend exceeds the specified percentages of the budget), budget alert emails are sent to the email recipients you specify in the NotificationsRule.

Threshold rules also affect the fields included in the JSON data object sent to a Pub/Sub topic.

Threshold rules are required if using email notifications.

Threshold rules are optional if only setting a pubsubTopic NotificationsRule, unless you want your JSON data object to include data about the thresholds you set.

For more information, see set budget threshold rules and actions.

Protobuf type google.cloud.billing.budgets.v1.ThresholdRule

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ThresholdRule

Static Fields

SPEND_BASIS_FIELD_NUMBER

public static final int SPEND_BASIS_FIELD_NUMBER
Field Value
Type Description
int

THRESHOLD_PERCENT_FIELD_NUMBER

public static final int THRESHOLD_PERCENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ThresholdRule getDefaultInstance()
Returns
Type Description
ThresholdRule

getDescriptor()

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

newBuilder()

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

newBuilder(ThresholdRule prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ThresholdRule getDefaultInstanceForType()
Returns
Type Description
ThresholdRule

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSpendBasis()

public ThresholdRule.Basis getSpendBasis()

Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set.

.google.cloud.billing.budgets.v1.ThresholdRule.Basis spend_basis = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ThresholdRule.Basis

The spendBasis.

getSpendBasisValue()

public int getSpendBasisValue()

Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set.

.google.cloud.billing.budgets.v1.ThresholdRule.Basis spend_basis = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for spendBasis.

getThresholdPercent()

public double getThresholdPercent()

Required. Send an alert when this threshold is exceeded. This is a 1.0-based percentage, so 0.5 = 50%. Validation: non-negative number.

double threshold_percent = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
double

The thresholdPercent.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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