Class: Google::Apis::BillingbudgetsV1beta1::GoogleCloudBillingBudgetsV1beta1AllUpdatesRule

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudBillingBudgetsV1beta1AllUpdatesRule

Returns a new instance of GoogleCloudBillingBudgetsV1beta1AllUpdatesRule.



81
82
83
 
# File 'lib/google/apis/billingbudgets_v1beta1/classes.rb', line 81

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) 


36
37
38
 
# File 'lib/google/apis/billingbudgets_v1beta1/classes.rb', line 36

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) 


46
47
48
 
# File 'lib/google/apis/billingbudgets_v1beta1/classes.rb', line 46

def enable_project_level_recipients
  @enable_project_level_recipients
end

#monitoring_notification_channels ⇒ Array<String>

Optional. Targets to send notifications to when a threshold is exceeded. This is in addition to default recipients who have billing account IAM roles. The value is the full REST resource name of a monitoring notification channel with the form projects/project_id/notificationChannels/channel_id`. A maximum of 5 channels are allowed. See https://cloud.google.com/billing/docs/how-to/ budgets-notification-recipients for more details. Corresponds to the JSON propertymonitoringNotificationChannels`

Returns:

  • (Array<String>) 


57
58
59
 
# File 'lib/google/apis/billingbudgets_v1beta1/classes.rb', line 57

def monitoring_notification_channels
  @monitoring_notification_channels
end

#pubsub_topic ⇒ String

Optional. The name of the Pub/Sub topic where budget related messages will be published, in the form projects/project_id/topics/topic_id`. Updates are sent at regular intervals to the topic. The topic needs to be created before the budget is created; see https://cloud.google.com/billing/docs/how-to/ budgets-programmatic-notifications for more details. Caller is expected to havepubsub.topics.setIamPolicypermission on the topic when it's set for a budget, otherwise, the API call will fail with PERMISSION_DENIED. See https:// cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications# permissions_required_for_this_task for more details on Pub/Sub roles and permissions. Corresponds to the JSON propertypubsubTopic`

Returns:

  • (String) 


71
72
73
 
# File 'lib/google/apis/billingbudgets_v1beta1/classes.rb', line 71

def pubsub_topic
  @pubsub_topic
end

#schema_version ⇒ String

Optional. Required when AllUpdatesRule.pubsub_topic is set. The schema version of the notification sent to AllUpdatesRule.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) 


79
80
81
 
# File 'lib/google/apis/billingbudgets_v1beta1/classes.rb', line 79

def schema_version
  @schema_version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



86
87
88
89
90
91
92
 
# File 'lib/google/apis/billingbudgets_v1beta1/classes.rb', line 86

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