Class: Google::Apis::BillingbudgetsV1::GoogleCloudBillingBudgetsV1NotificationsRule

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/billingbudgets_v1/classes.rb,
lib/google/apis/billingbudgets_v1/representations.rb,
lib/google/apis/billingbudgets_v1/representations.rb

Overview

NotificationsRule defines notifications that are sent based on budget spend and thresholds.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudBillingBudgetsV1NotificationsRule

Returns a new instance of GoogleCloudBillingBudgetsV1NotificationsRule.



378
379
380
 
# File 'lib/google/apis/billingbudgets_v1/classes.rb', line 378

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#disable_default_iam_recipients ⇒ Boolean Also known as: disable_default_iam_recipients?

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. Corresponds to the JSON property disableDefaultIamRecipients

Returns:

  • (Boolean) 


313
314
315
 
# File 'lib/google/apis/billingbudgets_v1/classes.rb', line 313

def disable_default_iam_recipients
  @disable_default_iam_recipients
end

#enable_project_level_recipients ⇒ Boolean Also known as: enable_project_level_recipients?

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. Corresponds to the JSON property enableProjectLevelRecipients

Returns:

  • (Boolean) 


323
324
325
 
# File 'lib/google/apis/billingbudgets_v1/classes.rb', line 323

def enable_project_level_recipients
  @enable_project_level_recipients
end

#monitoring_notification_channels ⇒ Array<String>

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). Corresponds to the JSON propertymonitoringNotificationChannels`

Returns:

  • (Array<String>) 


345
346
347
 
# File 'lib/google/apis/billingbudgets_v1/classes.rb', line 345

def monitoring_notification_channels
  @monitoring_notification_channels
end

#pubsub_topic ⇒ String

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 thepubsub.topics. setIamPolicypermission 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). Corresponds to the JSON propertypubsubTopic`

Returns:

  • (String) 


368
369
370
 
# File 'lib/google/apis/billingbudgets_v1/classes.rb', line 368

def pubsub_topic
  @pubsub_topic
end

#schema_version ⇒ String

Optional. Required when NotificationsRule.pubsub_topic is set. The schema version of the notification sent to 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. Corresponds to the JSON property schemaVersion

Returns:

  • (String) 


376
377
378
 
# File 'lib/google/apis/billingbudgets_v1/classes.rb', line 376

def schema_version
  @schema_version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



383
384
385
386
387
388
389
 
# File 'lib/google/apis/billingbudgets_v1/classes.rb', line 383

def update!(**args)
  @disable_default_iam_recipients = args[:disable_default_iam_recipients] if args.key?(:disable_default_iam_recipients)
  @enable_project_level_recipients = args[:enable_project_level_recipients] if args.key?(:enable_project_level_recipients)
  @monitoring_notification_channels = args[:monitoring_notification_channels] if args.key?(:monitoring_notification_channels)
  @pubsub_topic = args[:pubsub_topic] if args.key?(:pubsub_topic)
  @schema_version = args[:schema_version] if args.key?(:schema_version)
end