Reference documentation and code samples for the Google Cloud Billing Budgets V1beta1 Client class AllUpdatesRule.
AllUpdatesRule defines notifications that are sent based on budget spend and thresholds.
Generated from protobuf message google.cloud.billing.budgets.v1beta1.AllUpdatesRule
Namespace
Google \ Cloud \ Billing \ Budgets \ V1beta1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ 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 have pubsub.topics.setIamPolicy
permission 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.
↳ 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 .
↳ monitoring_notification_channels
array
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.
↳ disable_default_iam_recipients
bool
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.
↳ enable_project_level_recipients
bool
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.
getPubsubTopic
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 have pubsub.topics.setIamPolicy
permission 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.
string
setPubsubTopic
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 have pubsub.topics.setIamPolicy
permission 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.
var
string
$this
getSchemaVersion
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 .
string
setSchemaVersion
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 .
var
string
$this
getMonitoringNotificationChannels
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.
setMonitoringNotificationChannels
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.
var
string[]
$this
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
setDisableDefaultIamRecipients
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.
var
bool
$this
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
setEnableProjectLevelRecipients
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.
var
bool
$this
