Interface AllUpdatesRuleOrBuilder (2.33.0)

public interface AllUpdatesRuleOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

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.

getEnableProjectLevelRecipients()

public abstract 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 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)

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()

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()

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-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 pubsub_topic = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The pubsubTopic.

getPubsubTopicBytes()

public abstract ByteString getPubsubTopicBytes()

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 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 schema_version = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The schemaVersion.

getSchemaVersionBytes()

public abstract ByteString getSchemaVersionBytes()

string schema_version = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for schemaVersion.