Class ThresholdRule.Builder (2.40.0)

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ThresholdRule.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ThresholdRule.Builder
Overrides

build()

public ThresholdRule build()
Returns
TypeDescription
ThresholdRule

buildPartial()

public ThresholdRule buildPartial()
Returns
TypeDescription
ThresholdRule

clear()

public ThresholdRule.Builder clear()
Returns
TypeDescription
ThresholdRule.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ThresholdRule.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ThresholdRule.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ThresholdRule.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ThresholdRule.Builder

This builder for chaining.

clone()

public ThresholdRule.Builder clone()
Returns
TypeDescription
ThresholdRule.Builder
Overrides

getDefaultInstanceForType()

public ThresholdRule getDefaultInstanceForType()
Returns
TypeDescription
ThresholdRule

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
double

The thresholdPercent.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ThresholdRule other)

public ThresholdRule.Builder mergeFrom(ThresholdRule other)
Parameter
NameDescription
otherThresholdRule
Returns
TypeDescription
ThresholdRule.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ThresholdRule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ThresholdRule.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ThresholdRule.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ThresholdRule.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ThresholdRule.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ThresholdRule.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ThresholdRule.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ThresholdRule.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ThresholdRule.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
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
NameDescription
valueThresholdRule.Basis

The spendBasis to set.

Returns
TypeDescription
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
NameDescription
valueint

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

Returns
TypeDescription
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
NameDescription
valuedouble

The thresholdPercent to set.

Returns
TypeDescription
ThresholdRule.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ThresholdRule.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ThresholdRule.Builder
Overrides