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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ThresholdRule.Builder newBuilder()
newBuilder(ThresholdRule prototype)
public static ThresholdRule.Builder newBuilder(ThresholdRule prototype)
public static ThresholdRule parseDelimitedFrom(InputStream input)
public static ThresholdRule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ThresholdRule parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ThresholdRule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ThresholdRule parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ThresholdRule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ThresholdRule parseFrom(CodedInputStream input)
public static ThresholdRule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ThresholdRule parseFrom(InputStream input)
public static ThresholdRule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ThresholdRule parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ThresholdRule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ThresholdRule> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public ThresholdRule getDefaultInstanceForType()
getParserForType()
public Parser<ThresholdRule> getParserForType()
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];
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()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ThresholdRule.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ThresholdRule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public ThresholdRule.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
