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

Interface NotificationsRuleOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    NotificationsRule, NotificationsRule.Builder
    public interface NotificationsRuleOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getPubsubTopic

        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];
        Returns:
        The pubsubTopic.

      • getPubsubTopicBytes

        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];
        Returns:
        The bytes for pubsubTopic.

      • getSchemaVersion

        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];
        Returns:
        The schemaVersion.

      • getSchemaVersionBytes

        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];
        Returns:
        The bytes for schemaVersion.

      • getMonitoringNotificationChannelsList

        List<String> 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];
        Returns:
        A list containing the monitoringNotificationChannels.

      • getMonitoringNotificationChannelsCount

        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];
        Returns:
        The count of monitoringNotificationChannels.

      • getMonitoringNotificationChannels

        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];
        Parameters:
        index - The index of the element to return.
        Returns:
        The monitoringNotificationChannels at the given index.

      • getMonitoringNotificationChannelsBytes

        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];
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the monitoringNotificationChannels at the given index.

      • getDisableDefaultIamRecipients

        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];
        Returns:
        The disableDefaultIamRecipients.

      • getEnableProjectLevelRecipients

        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];
        Returns:
        The enableProjectLevelRecipients.