Class NotificationsRule

  • All Implemented Interfaces:
    NotificationsRuleOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class NotificationsRule
    extends com.google.protobuf.GeneratedMessageV3
    implements NotificationsRuleOrBuilder
     NotificationsRule defines notifications that are sent based on budget spend
     and thresholds.
     
    Protobuf type google.cloud.billing.budgets.v1.NotificationsRule
    See Also:
    Serialized Form
    • Field Detail

      • PUBSUB_TOPIC_FIELD_NUMBER

        public static final int PUBSUB_TOPIC_FIELD_NUMBER
        See Also:
        Constant Field Values
      • SCHEMA_VERSION_FIELD_NUMBER

        public static final int SCHEMA_VERSION_FIELD_NUMBER
        See Also:
        Constant Field Values
      • MONITORING_NOTIFICATION_CHANNELS_FIELD_NUMBER

        public static final int MONITORING_NOTIFICATION_CHANNELS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • DISABLE_DEFAULT_IAM_RECIPIENTS_FIELD_NUMBER

        public static final int DISABLE_DEFAULT_IAM_RECIPIENTS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • ENABLE_PROJECT_LEVEL_RECIPIENTS_FIELD_NUMBER

        public static final int ENABLE_PROJECT_LEVEL_RECIPIENTS_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
      • getPubsubTopic

        public String getPubsubTopic()
         Optional. The name of the Pub/Sub topic where budget-related messages are
         published, in the form `projects/{project_id}/topics/{topic_id}`. Updates
         are sent to the topic at regular intervals; the timing of the updates is
         not dependent on the [threshold rules](#thresholdrule) you've set.
        
         Note that if you want your
         [Pub/Sub JSON
         object](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format)
         to contain data for `alertThresholdExceeded`, you need at least one
         [alert threshold rule](#thresholdrule). When you set threshold rules, you
         must also enable at least one of the email notification options, either
         using the default IAM recipients or Cloud Monitoring email notification
         channels.
        
         To use Pub/Sub topics with budgets, you must do the following:
        
         1. Create the Pub/Sub topic
         before connecting it to your budget. For guidance, see
         [Manage programmatic budget alert
         notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications).
        
         2. Grant the API caller the `pubsub.topics.setIamPolicy` permission on
         the Pub/Sub topic. If not set, the API call fails with PERMISSION_DENIED.
         For additional details on Pub/Sub roles and permissions, see
         [Permissions required for this
         task](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#permissions_required_for_this_task).
         
        string pubsub_topic = 1 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPubsubTopic in interface NotificationsRuleOrBuilder
        Returns:
        The pubsubTopic.
      • getPubsubTopicBytes

        public com.google.protobuf.ByteString getPubsubTopicBytes()
         Optional. The name of the Pub/Sub topic where budget-related messages are
         published, in the form `projects/{project_id}/topics/{topic_id}`. Updates
         are sent to the topic at regular intervals; the timing of the updates is
         not dependent on the [threshold rules](#thresholdrule) you've set.
        
         Note that if you want your
         [Pub/Sub JSON
         object](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format)
         to contain data for `alertThresholdExceeded`, you need at least one
         [alert threshold rule](#thresholdrule). When you set threshold rules, you
         must also enable at least one of the email notification options, either
         using the default IAM recipients or Cloud Monitoring email notification
         channels.
        
         To use Pub/Sub topics with budgets, you must do the following:
        
         1. Create the Pub/Sub topic
         before connecting it to your budget. For guidance, see
         [Manage programmatic budget alert
         notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications).
        
         2. Grant the API caller the `pubsub.topics.setIamPolicy` permission on
         the Pub/Sub topic. If not set, the API call fails with PERMISSION_DENIED.
         For additional details on Pub/Sub roles and permissions, see
         [Permissions required for this
         task](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#permissions_required_for_this_task).
         
        string pubsub_topic = 1 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPubsubTopicBytes in interface NotificationsRuleOrBuilder
        Returns:
        The bytes for pubsubTopic.
      • getSchemaVersion

        public String getSchemaVersion()
         Optional. Required when
         [NotificationsRule.pubsub_topic][google.cloud.billing.budgets.v1.NotificationsRule.pubsub_topic]
         is set. The schema version of the notification sent to
         [NotificationsRule.pubsub_topic][google.cloud.billing.budgets.v1.NotificationsRule.pubsub_topic].
         Only "1.0" is accepted. It represents the JSON schema as defined in
         https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format.
         
        string schema_version = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getSchemaVersion in interface NotificationsRuleOrBuilder
        Returns:
        The schemaVersion.
      • getSchemaVersionBytes

        public com.google.protobuf.ByteString getSchemaVersionBytes()
         Optional. Required when
         [NotificationsRule.pubsub_topic][google.cloud.billing.budgets.v1.NotificationsRule.pubsub_topic]
         is set. The schema version of the notification sent to
         [NotificationsRule.pubsub_topic][google.cloud.billing.budgets.v1.NotificationsRule.pubsub_topic].
         Only "1.0" is accepted. It represents the JSON schema as defined in
         https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format.
         
        string schema_version = 2 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getSchemaVersionBytes in interface NotificationsRuleOrBuilder
        Returns:
        The bytes for schemaVersion.
      • getMonitoringNotificationChannelsList

        public com.google.protobuf.ProtocolStringList getMonitoringNotificationChannelsList()
         Optional. Email targets to send notifications to when a threshold is
         exceeded. This is in addition to the `DefaultIamRecipients` who receive
         alert emails based on their billing account IAM role. The value is the full
         REST resource name of a Cloud Monitoring email notification channel with
         the form `projects/{project_id}/notificationChannels/{channel_id}`. A
         maximum of 5 email notifications are allowed.
        
         To customize budget alert email recipients with monitoring notification
         channels, you _must create the monitoring notification channels before
         you link them to a budget_. For guidance on setting up notification
         channels to use with budgets, see
         [Customize budget alert email
         recipients](https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients).
        
         For Cloud Billing budget alerts, you _must use email notification
         channels_. The other types of notification channels are _not_
         supported, such as Slack, SMS, or PagerDuty. If you want to
         [send budget notifications to
         Slack](https://cloud.google.com/billing/docs/how-to/notify#send_notifications_to_slack),
         use a pubsubTopic and configure
         [programmatic
         notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications).
         
        repeated string monitoring_notification_channels = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getMonitoringNotificationChannelsList in interface NotificationsRuleOrBuilder
        Returns:
        A list containing the monitoringNotificationChannels.
      • getMonitoringNotificationChannelsCount

        public int getMonitoringNotificationChannelsCount()
         Optional. Email targets to send notifications to when a threshold is
         exceeded. This is in addition to the `DefaultIamRecipients` who receive
         alert emails based on their billing account IAM role. The value is the full
         REST resource name of a Cloud Monitoring email notification channel with
         the form `projects/{project_id}/notificationChannels/{channel_id}`. A
         maximum of 5 email notifications are allowed.
        
         To customize budget alert email recipients with monitoring notification
         channels, you _must create the monitoring notification channels before
         you link them to a budget_. For guidance on setting up notification
         channels to use with budgets, see
         [Customize budget alert email
         recipients](https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients).
        
         For Cloud Billing budget alerts, you _must use email notification
         channels_. The other types of notification channels are _not_
         supported, such as Slack, SMS, or PagerDuty. If you want to
         [send budget notifications to
         Slack](https://cloud.google.com/billing/docs/how-to/notify#send_notifications_to_slack),
         use a pubsubTopic and configure
         [programmatic
         notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications).
         
        repeated string monitoring_notification_channels = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getMonitoringNotificationChannelsCount in interface NotificationsRuleOrBuilder
        Returns:
        The count of monitoringNotificationChannels.
      • getMonitoringNotificationChannels

        public String getMonitoringNotificationChannels​(int index)
         Optional. Email targets to send notifications to when a threshold is
         exceeded. This is in addition to the `DefaultIamRecipients` who receive
         alert emails based on their billing account IAM role. The value is the full
         REST resource name of a Cloud Monitoring email notification channel with
         the form `projects/{project_id}/notificationChannels/{channel_id}`. A
         maximum of 5 email notifications are allowed.
        
         To customize budget alert email recipients with monitoring notification
         channels, you _must create the monitoring notification channels before
         you link them to a budget_. For guidance on setting up notification
         channels to use with budgets, see
         [Customize budget alert email
         recipients](https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients).
        
         For Cloud Billing budget alerts, you _must use email notification
         channels_. The other types of notification channels are _not_
         supported, such as Slack, SMS, or PagerDuty. If you want to
         [send budget notifications to
         Slack](https://cloud.google.com/billing/docs/how-to/notify#send_notifications_to_slack),
         use a pubsubTopic and configure
         [programmatic
         notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications).
         
        repeated string monitoring_notification_channels = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getMonitoringNotificationChannels in interface NotificationsRuleOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The monitoringNotificationChannels at the given index.
      • getMonitoringNotificationChannelsBytes

        public com.google.protobuf.ByteString getMonitoringNotificationChannelsBytes​(int index)
         Optional. Email targets to send notifications to when a threshold is
         exceeded. This is in addition to the `DefaultIamRecipients` who receive
         alert emails based on their billing account IAM role. The value is the full
         REST resource name of a Cloud Monitoring email notification channel with
         the form `projects/{project_id}/notificationChannels/{channel_id}`. A
         maximum of 5 email notifications are allowed.
        
         To customize budget alert email recipients with monitoring notification
         channels, you _must create the monitoring notification channels before
         you link them to a budget_. For guidance on setting up notification
         channels to use with budgets, see
         [Customize budget alert email
         recipients](https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients).
        
         For Cloud Billing budget alerts, you _must use email notification
         channels_. The other types of notification channels are _not_
         supported, such as Slack, SMS, or PagerDuty. If you want to
         [send budget notifications to
         Slack](https://cloud.google.com/billing/docs/how-to/notify#send_notifications_to_slack),
         use a pubsubTopic and configure
         [programmatic
         notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications).
         
        repeated string monitoring_notification_channels = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getMonitoringNotificationChannelsBytes in interface NotificationsRuleOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the monitoringNotificationChannels at the given index.
      • getDisableDefaultIamRecipients

        public boolean getDisableDefaultIamRecipients()
         Optional. When set to true, disables default notifications sent when a
         threshold is exceeded. Default notifications are sent to those with Billing
         Account Administrator and Billing Account User IAM roles for the target
         account.
         
        bool disable_default_iam_recipients = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getDisableDefaultIamRecipients in interface NotificationsRuleOrBuilder
        Returns:
        The disableDefaultIamRecipients.
      • getEnableProjectLevelRecipients

        public boolean getEnableProjectLevelRecipients()
         Optional. When set to true, and when the budget has a single project
         configured, notifications will be sent to project level recipients of that
         project. This field will be ignored if the budget has multiple or no
         project configured.
        
         Currently, project level recipients are the users with `Owner` role on a
         cloud project.
         
        bool enable_project_level_recipients = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getEnableProjectLevelRecipients in interface NotificationsRuleOrBuilder
        Returns:
        The enableProjectLevelRecipients.
      • 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 NotificationsRule parseFrom​(ByteBuffer data)
                                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

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

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

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

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

        public com.google.protobuf.Parser<NotificationsRule> 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 NotificationsRule getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder