public static final class ThresholdRule.Builder extends GeneratedMessageV3.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.v1.ThresholdRule
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ThresholdRule.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public ThresholdRule build()
buildPartial()
public ThresholdRule buildPartial()
clear()
public ThresholdRule.Builder clear()
Overrides
clearField(Descriptors.FieldDescriptor field)
public ThresholdRule.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public ThresholdRule.Builder clearOneof(Descriptors.OneofDescriptor oneof)
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.v1.ThresholdRule.Basis spend_basis = 2 [(.google.api.field_behavior) = OPTIONAL];
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];
clone()
public ThresholdRule.Builder clone()
Overrides
getDefaultInstanceForType()
public ThresholdRule getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
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];
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.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(ThresholdRule other)
public ThresholdRule.Builder mergeFrom(ThresholdRule other)
public ThresholdRule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public ThresholdRule.Builder mergeFrom(Message other)
| Parameter |
|---|
| Name | Description |
other | Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ThresholdRule.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public ThresholdRule.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ThresholdRule.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
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.v1.ThresholdRule.Basis spend_basis = 2 [(.google.api.field_behavior) = OPTIONAL];
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.v1.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.
|
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.
|
setUnknownFields(UnknownFieldSet unknownFields)
public final ThresholdRule.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
