com.google.cloud.billing.budgets.v1beta1

Interface AllUpdatesRuleOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

AllUpdatesRule, AllUpdatesRule.Builder

public interface AllUpdatesRuleOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	getDisableDefaultIamRecipients() Optional.
boolean	getEnableProjectLevelRecipients() Optional.
String	getMonitoringNotificationChannels(int index) Optional.
com.google.protobuf.ByteString	getMonitoringNotificationChannelsBytes(int index) Optional.
int	getMonitoringNotificationChannelsCount() Optional.
List<String>	getMonitoringNotificationChannelsList() Optional.
String	getPubsubTopic() Optional.
com.google.protobuf.ByteString	getPubsubTopicBytes() Optional.
String	getSchemaVersion() Optional.
com.google.protobuf.ByteString	getSchemaVersionBytes() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getPubsubTopic

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:

The pubsubTopic.

getPubsubTopicBytes

com.google.protobuf.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-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:

The bytes for pubsubTopic.

getSchemaVersion

String getSchemaVersion()

 Optional. Required when
 [AllUpdatesRule.pubsub_topic][google.cloud.billing.budgets.v1beta1.AllUpdatesRule.pubsub_topic]
 is set. The schema version of the notification sent to
 [AllUpdatesRule.pubsub_topic][google.cloud.billing.budgets.v1beta1.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:

The schemaVersion.

getSchemaVersionBytes

com.google.protobuf.ByteString getSchemaVersionBytes()

 Optional. Required when
 [AllUpdatesRule.pubsub_topic][google.cloud.billing.budgets.v1beta1.AllUpdatesRule.pubsub_topic]
 is set. The schema version of the notification sent to
 [AllUpdatesRule.pubsub_topic][google.cloud.billing.budgets.v1beta1.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:

The bytes for schemaVersion.

getMonitoringNotificationChannelsList

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:

A list containing the monitoringNotificationChannels.

getMonitoringNotificationChannelsCount

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:

The count of monitoringNotificationChannels.

getMonitoringNotificationChannels

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];

Parameters:

index - The index of the element to return.

Returns:

The monitoringNotificationChannels at the given index.

getMonitoringNotificationChannelsBytes

com.google.protobuf.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];

Parameters:

index - The index of the value to return.

Returns:

The bytes of the monitoringNotificationChannels at the given index.

getDisableDefaultIamRecipients

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:

The disableDefaultIamRecipients.

getEnableProjectLevelRecipients

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:

The enableProjectLevelRecipients.