- 2.53.0 (latest)
- 2.52.0
- 2.51.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.6
- 2.2.0
- 2.1.7
public interface NotificationsRuleOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getDisableDefaultIamRecipients()
public abstract 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 | |
---|---|
Type | Description |
boolean | The disableDefaultIamRecipients. |
getMonitoringNotificationChannels(int index)
public abstract String getMonitoringNotificationChannels(int index)
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.
repeated string monitoring_notification_channels = 3 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index | int The index of the element to return. |
Returns | |
---|---|
Type | Description |
String | The monitoringNotificationChannels at the given index. |
getMonitoringNotificationChannelsBytes(int index)
public abstract ByteString getMonitoringNotificationChannelsBytes(int index)
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.
repeated string monitoring_notification_channels = 3 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
index | int The index of the value to return. |
Returns | |
---|---|
Type | Description |
ByteString | The bytes of the monitoringNotificationChannels at the given index. |
getMonitoringNotificationChannelsCount()
public abstract int getMonitoringNotificationChannelsCount()
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.
repeated string monitoring_notification_channels = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int | The count of monitoringNotificationChannels. |
getMonitoringNotificationChannelsList()
public abstract List<String> getMonitoringNotificationChannelsList()
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.
repeated string monitoring_notification_channels = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
List<String> | A list containing the monitoringNotificationChannels. |
getPubsubTopic()
public abstract String 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#manage-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
for more details on Pub/Sub roles and permissions.
string pubsub_topic = 1 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String | The pubsubTopic. |
getPubsubTopicBytes()
public abstract ByteString getPubsubTopicBytes()
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#manage-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
for more details on Pub/Sub roles and permissions.
string pubsub_topic = 1 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for pubsubTopic. |
getSchemaVersion()
public abstract String getSchemaVersion()
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.
string schema_version = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String | The schemaVersion. |
getSchemaVersionBytes()
public abstract ByteString getSchemaVersionBytes()
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.
string schema_version = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for schemaVersion. |