- 2.51.0 (latest)
- 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 static final class NotificationsRule.Builder extends GeneratedMessageV3.Builder<NotificationsRule.Builder> implements NotificationsRuleOrBuilder
NotificationsRule defines notifications that are sent based on budget spend and thresholds.
Protobuf type google.cloud.billing.budgets.v1.NotificationsRule
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > NotificationsRule.BuilderImplements
NotificationsRuleOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addAllMonitoringNotificationChannels(Iterable<String> values)
public NotificationsRule.Builder addAllMonitoringNotificationChannels(Iterable<String> values)
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.
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, use a pubsubTopic and configure programmatic notifications.
repeated string monitoring_notification_channels = 3 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
values | Iterable<String> The monitoringNotificationChannels to add. |
Returns | |
---|---|
Type | Description |
NotificationsRule.Builder | This builder for chaining. |
addMonitoringNotificationChannels(String value)
public NotificationsRule.Builder addMonitoringNotificationChannels(String value)
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.
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, use a pubsubTopic and configure programmatic notifications.
repeated string monitoring_notification_channels = 3 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value | String The monitoringNotificationChannels to add. |
Returns | |
---|---|
Type | Description |
NotificationsRule.Builder | This builder for chaining. |
addMonitoringNotificationChannelsBytes(ByteString value)
public NotificationsRule.Builder addMonitoringNotificationChannelsBytes(ByteString value)
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.
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, use a pubsubTopic and configure programmatic notifications.
repeated string monitoring_notification_channels = 3 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes of the monitoringNotificationChannels to add. |
Returns | |
---|---|
Type | Description |
NotificationsRule.Builder | This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public NotificationsRule.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
NotificationsRule.Builder |
build()
public NotificationsRule build()
Returns | |
---|---|
Type | Description |
NotificationsRule |
buildPartial()
public NotificationsRule buildPartial()
Returns | |
---|---|
Type | Description |
NotificationsRule |
clear()
public NotificationsRule.Builder clear()
Returns | |
---|---|
Type | Description |
NotificationsRule.Builder |
clearDisableDefaultIamRecipients()
public NotificationsRule.Builder clearDisableDefaultIamRecipients()
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 |
NotificationsRule.Builder | This builder for chaining. |
clearEnableProjectLevelRecipients()
public NotificationsRule.Builder clearEnableProjectLevelRecipients()
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 | |
---|---|
Type | Description |
NotificationsRule.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public NotificationsRule.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field | FieldDescriptor |
Returns | |
---|---|
Type | Description |
NotificationsRule.Builder |
clearMonitoringNotificationChannels()
public NotificationsRule.Builder clearMonitoringNotificationChannels()
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.
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, use a pubsubTopic and configure programmatic notifications.
repeated string monitoring_notification_channels = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
NotificationsRule.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public NotificationsRule.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof | OneofDescriptor |
Returns | |
---|---|
Type | Description |
NotificationsRule.Builder |
clearPubsubTopic()
public NotificationsRule.Builder clearPubsubTopic()
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 you've set.
Note that if you want your
Pub/Sub JSON
object
to contain data for alertThresholdExceeded
, you need at least one
alert threshold rule. 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:
Create the Pub/Sub topic before connecting it to your budget. For guidance, see Manage programmatic budget alert notifications.
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.
string pubsub_topic = 1 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
NotificationsRule.Builder | This builder for chaining. |
clearSchemaVersion()
public NotificationsRule.Builder clearSchemaVersion()
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 |
NotificationsRule.Builder | This builder for chaining. |
clone()
public NotificationsRule.Builder clone()
Returns | |
---|---|
Type | Description |
NotificationsRule.Builder |
getDefaultInstanceForType()
public NotificationsRule getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
NotificationsRule |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getDisableDefaultIamRecipients()
public 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. |
getEnableProjectLevelRecipients()
public 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 | |
---|---|
Type | Description |
boolean | The enableProjectLevelRecipients. |
getMonitoringNotificationChannels(int index)
public 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.
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, use a pubsubTopic and configure programmatic notifications.
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 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.
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, use a pubsubTopic and configure programmatic notifications.
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 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.
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, use a pubsubTopic and configure programmatic notifications.
repeated string monitoring_notification_channels = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
int | The count of monitoringNotificationChannels. |
getMonitoringNotificationChannelsList()
public ProtocolStringList 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.
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, use a pubsubTopic and configure programmatic notifications.
repeated string monitoring_notification_channels = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ProtocolStringList | A list containing the monitoringNotificationChannels. |
getPubsubTopic()
public 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 you've set.
Note that if you want your
Pub/Sub JSON
object
to contain data for alertThresholdExceeded
, you need at least one
alert threshold rule. 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:
Create the Pub/Sub topic before connecting it to your budget. For guidance, see Manage programmatic budget alert notifications.
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.
string pubsub_topic = 1 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
String | The pubsubTopic. |
getPubsubTopicBytes()
public 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 you've set.
Note that if you want your
Pub/Sub JSON
object
to contain data for alertThresholdExceeded
, you need at least one
alert threshold rule. 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:
Create the Pub/Sub topic before connecting it to your budget. For guidance, see Manage programmatic budget alert notifications.
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.
string pubsub_topic = 1 [(.google.api.field_behavior) = OPTIONAL];
Returns | |
---|---|
Type | Description |
ByteString | The bytes for pubsubTopic. |
getSchemaVersion()
public 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(NotificationsRule other)
public NotificationsRule.Builder mergeFrom(NotificationsRule other)
Parameter | |
---|---|
Name | Description |
other | NotificationsRule |
Returns | |
---|---|
Type | Description |
NotificationsRule.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public NotificationsRule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
NotificationsRule.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public NotificationsRule.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other | Message |
Returns | |
---|---|
Type | Description |
NotificationsRule.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final NotificationsRule.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
NotificationsRule.Builder |
setDisableDefaultIamRecipients(boolean value)
public NotificationsRule.Builder setDisableDefaultIamRecipients(boolean value)
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];
Parameter | |
---|---|
Name | Description |
value | boolean The disableDefaultIamRecipients to set. |
Returns | |
---|---|
Type | Description |
NotificationsRule.Builder | This builder for chaining. |
setEnableProjectLevelRecipients(boolean value)
public NotificationsRule.Builder setEnableProjectLevelRecipients(boolean value)
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];
Parameter | |
---|---|
Name | Description |
value | boolean The enableProjectLevelRecipients to set. |
Returns | |
---|---|
Type | Description |
NotificationsRule.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public NotificationsRule.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
value | Object |
Returns | |
---|---|
Type | Description |
NotificationsRule.Builder |
setMonitoringNotificationChannels(int index, String value)
public NotificationsRule.Builder setMonitoringNotificationChannels(int index, String value)
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.
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, use a pubsubTopic and configure programmatic notifications.
repeated string monitoring_notification_channels = 3 [(.google.api.field_behavior) = OPTIONAL];
Parameters | |
---|---|
Name | Description |
index | int The index to set the value at. |
value | String The monitoringNotificationChannels to set. |
Returns | |
---|---|
Type | Description |
NotificationsRule.Builder | This builder for chaining. |
setPubsubTopic(String value)
public NotificationsRule.Builder setPubsubTopic(String value)
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 you've set.
Note that if you want your
Pub/Sub JSON
object
to contain data for alertThresholdExceeded
, you need at least one
alert threshold rule. 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:
Create the Pub/Sub topic before connecting it to your budget. For guidance, see Manage programmatic budget alert notifications.
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.
string pubsub_topic = 1 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value | String The pubsubTopic to set. |
Returns | |
---|---|
Type | Description |
NotificationsRule.Builder | This builder for chaining. |
setPubsubTopicBytes(ByteString value)
public NotificationsRule.Builder setPubsubTopicBytes(ByteString value)
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 you've set.
Note that if you want your
Pub/Sub JSON
object
to contain data for alertThresholdExceeded
, you need at least one
alert threshold rule. 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:
Create the Pub/Sub topic before connecting it to your budget. For guidance, see Manage programmatic budget alert notifications.
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.
string pubsub_topic = 1 [(.google.api.field_behavior) = OPTIONAL];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for pubsubTopic to set. |
Returns | |
---|---|
Type | Description |
NotificationsRule.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public NotificationsRule.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
Returns | |
---|---|
Type | Description |
NotificationsRule.Builder |
setSchemaVersion(String value)
public NotificationsRule.Builder setSchemaVersion(String value)
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];
Parameter | |
---|---|
Name | Description |
value | String The schemaVersion to set. |
Returns | |
---|---|
Type | Description |
NotificationsRule.Builder | This builder for chaining. |
setSchemaVersionBytes(ByteString value)
public NotificationsRule.Builder setSchemaVersionBytes(ByteString value)
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];
Parameter | |
---|---|
Name | Description |
value | ByteString The bytes for schemaVersion to set. |
Returns | |
---|---|
Type | Description |
NotificationsRule.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final NotificationsRule.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields | UnknownFieldSet |
Returns | |
---|---|
Type | Description |
NotificationsRule.Builder |