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.v1beta1.ThresholdRule
Static Fields
SPEND_BASIS_FIELD_NUMBER
public static final int SPEND_BASIS_FIELD_NUMBER
Field Value
THRESHOLD_PERCENT_FIELD_NUMBER
public static final int THRESHOLD_PERCENT_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ThresholdRule getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static ThresholdRule.Builder newBuilder()
Returns
newBuilder(ThresholdRule prototype)
public static ThresholdRule.Builder newBuilder(ThresholdRule prototype)
Parameter
Returns
public static ThresholdRule parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ThresholdRule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ThresholdRule parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ThresholdRule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ThresholdRule parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ThresholdRule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ThresholdRule parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ThresholdRule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ThresholdRule parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ThresholdRule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ThresholdRule parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ThresholdRule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ThresholdRule> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public ThresholdRule getDefaultInstanceForType()
Returns
getParserForType()
public Parser<ThresholdRule> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
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];
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];
| 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];
| Type | Description |
| double | The thresholdPercent.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public ThresholdRule.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ThresholdRule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public ThresholdRule.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
