Class NotificationsRule.Builder (2.6.0)

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllMonitoringNotificationChannels(Iterable<String> values)

public NotificationsRule.Builder addAllMonitoringNotificationChannels(Iterable<String> values)

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
NameDescription
valuesIterable<String>

The monitoringNotificationChannels to add.

Returns
TypeDescription
NotificationsRule.Builder

This builder for chaining.

addMonitoringNotificationChannels(String value)

public NotificationsRule.Builder addMonitoringNotificationChannels(String value)

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
NameDescription
valueString

The monitoringNotificationChannels to add.

Returns
TypeDescription
NotificationsRule.Builder

This builder for chaining.

addMonitoringNotificationChannelsBytes(ByteString value)

public NotificationsRule.Builder addMonitoringNotificationChannelsBytes(ByteString value)

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
NameDescription
valueByteString

The bytes of the monitoringNotificationChannels to add.

Returns
TypeDescription
NotificationsRule.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public NotificationsRule.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
NotificationsRule.Builder
Overrides

build()

public NotificationsRule build()
Returns
TypeDescription
NotificationsRule

buildPartial()

public NotificationsRule buildPartial()
Returns
TypeDescription
NotificationsRule

clear()

public NotificationsRule.Builder clear()
Returns
TypeDescription
NotificationsRule.Builder
Overrides

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
TypeDescription
NotificationsRule.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public NotificationsRule.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
NotificationsRule.Builder
Overrides

clearMonitoringNotificationChannels()

public NotificationsRule.Builder clearMonitoringNotificationChannels()

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
TypeDescription
NotificationsRule.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public NotificationsRule.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
NotificationsRule.Builder
Overrides

clearPubsubTopic()

public NotificationsRule.Builder clearPubsubTopic()

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
TypeDescription
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
TypeDescription
NotificationsRule.Builder

This builder for chaining.

clone()

public NotificationsRule.Builder clone()
Returns
TypeDescription
NotificationsRule.Builder
Overrides

getDefaultInstanceForType()

public NotificationsRule getDefaultInstanceForType()
Returns
TypeDescription
NotificationsRule

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
boolean

The disableDefaultIamRecipients.

getMonitoringNotificationChannels(int index)

public 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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The monitoringNotificationChannels at the given index.

getMonitoringNotificationChannelsBytes(int index)

public 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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the monitoringNotificationChannels at the given index.

getMonitoringNotificationChannelsCount()

public 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
TypeDescription
int

The count of monitoringNotificationChannels.

getMonitoringNotificationChannelsList()

public ProtocolStringList 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
TypeDescription
ProtocolStringList

A list containing the monitoringNotificationChannels.

getPubsubTopic()

public 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
TypeDescription
String

The pubsubTopic.

getPubsubTopicBytes()

public 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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for schemaVersion.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(NotificationsRule other)

public NotificationsRule.Builder mergeFrom(NotificationsRule other)
Parameter
NameDescription
otherNotificationsRule
Returns
TypeDescription
NotificationsRule.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public NotificationsRule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NotificationsRule.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public NotificationsRule.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
NotificationsRule.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final NotificationsRule.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
NotificationsRule.Builder
Overrides

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
NameDescription
valueboolean

The disableDefaultIamRecipients to set.

Returns
TypeDescription
NotificationsRule.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public NotificationsRule.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
NotificationsRule.Builder
Overrides

setMonitoringNotificationChannels(int index, String value)

public NotificationsRule.Builder setMonitoringNotificationChannels(int index, String value)

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
NameDescription
indexint

The index to set the value at.

valueString

The monitoringNotificationChannels to set.

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

Parameter
NameDescription
valueString

The pubsubTopic to set.

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

Parameter
NameDescription
valueByteString

The bytes for pubsubTopic to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
NotificationsRule.Builder
Overrides

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
NameDescription
valueString

The schemaVersion to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for schemaVersion to set.

Returns
TypeDescription
NotificationsRule.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final NotificationsRule.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
NotificationsRule.Builder
Overrides