Class ThresholdRule.Builder (2.83.0)

public static final class ThresholdRule.Builder extends GeneratedMessage.Builder<ThresholdRule.Builder> 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.v1beta1.ThresholdRule

Static Methods

getDescriptor()

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

Methods

build()

public ThresholdRule build()
Returns
Type Description
ThresholdRule

buildPartial()

public ThresholdRule buildPartial()
Returns
Type Description
ThresholdRule

clear()

public ThresholdRule.Builder clear()
Returns
Type Description
ThresholdRule.Builder
Overrides

clearSpendBasis()

public ThresholdRule.Builder clearSpendBasis()

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.v1beta1.ThresholdRule.Basis spend_basis = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ThresholdRule.Builder

This builder for chaining.

clearThresholdPercent()

public ThresholdRule.Builder clearThresholdPercent()

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
ThresholdRule.Builder

This builder for chaining.

getDefaultInstanceForType()

public ThresholdRule getDefaultInstanceForType()
Returns
Type Description
ThresholdRule

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
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.v1beta1.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.v1beta1.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.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ThresholdRule other)

public ThresholdRule.Builder mergeFrom(ThresholdRule other)
Parameter
Name Description
other ThresholdRule
Returns
Type Description
ThresholdRule.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ThresholdRule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ThresholdRule.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ThresholdRule.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ThresholdRule.Builder
Overrides

setSpendBasis(ThresholdRule.Basis value)

public ThresholdRule.Builder setSpendBasis(ThresholdRule.Basis value)

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.v1beta1.ThresholdRule.Basis spend_basis = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ThresholdRule.Basis

The spendBasis to set.

Returns
Type Description
ThresholdRule.Builder

This builder for chaining.

setSpendBasisValue(int value)

public ThresholdRule.Builder setSpendBasisValue(int value)

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.v1beta1.ThresholdRule.Basis spend_basis = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The enum numeric value on the wire for spendBasis to set.

Returns
Type Description
ThresholdRule.Builder

This builder for chaining.

setThresholdPercent(double value)

public ThresholdRule.Builder setThresholdPercent(double value)

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];

Parameter
Name Description
value double

The thresholdPercent to set.

Returns
Type Description
ThresholdRule.Builder

This builder for chaining.