Package com.google.cloud.billing.budgets.v1

Class ThresholdRule

  • All Implemented Interfaces:
    ThresholdRuleOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ThresholdRule
extends com.google.protobuf.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](#notificationsrule).

 Threshold rules also affect the fields included in the
 [JSON data
 object](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format)
 sent to a Pub/Sub topic.

 Threshold rules are _required_ if using email notifications.

 Threshold rules are _optional_ if only setting a
 [`pubsubTopic` NotificationsRule](#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](https://cloud.google.com/billing/docs/how-to/budgets#budget-actions).
    Protobuf type google.cloud.billing.budgets.v1.ThresholdRule
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ThresholdRule.Basis
      The type of basis used to determine if spend has passed the threshold.
      static class  ThresholdRule.Builder
      ThresholdRule contains the definition of a threshold.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int SPEND_BASIS_FIELD_NUMBER  
      static int THRESHOLD_PERCENT_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Field Detail

      • THRESHOLD_PERCENT_FIELD_NUMBER

        public static final int THRESHOLD_PERCENT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SPEND_BASIS_FIELD_NUMBER

        public static final int SPEND_BASIS_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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];
        Specified by:
        getThresholdPercent in interface ThresholdRuleOrBuilder
        Returns:
        The thresholdPercent.

      • 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];
        Specified by:
        getSpendBasisValue in interface ThresholdRuleOrBuilder
        Returns:
        The enum numeric value on the wire for spendBasis.

      • 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];
        Specified by:
        getSpendBasis in interface ThresholdRuleOrBuilder
        Returns:
        The spendBasis.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static ThresholdRule parseFrom​(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ThresholdRule parseFrom​(ByteBuffer data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ThresholdRule parseFrom​(com.google.protobuf.ByteString data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ThresholdRule parseFrom​(com.google.protobuf.ByteString data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ThresholdRule parseFrom​(byte[] data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ThresholdRule parseFrom​(byte[] data,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ThresholdRule parseFrom​(com.google.protobuf.CodedInputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException
        Throws:
        IOException

      • newBuilderForType

        public ThresholdRule.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public ThresholdRule.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected ThresholdRule.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static ThresholdRule getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<ThresholdRule> parser()

      • getParserForType

        public com.google.protobuf.Parser<ThresholdRule> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public ThresholdRule getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder