Class AllUpdatesRule.Builder (2.54.0) 

public static final class AllUpdatesRule.Builder extends GeneratedMessageV3.Builder<AllUpdatesRule.Builder> implements AllUpdatesRuleOrBuilder

AllUpdatesRule defines notifications that are sent based on budget spend and thresholds.

Protobuf type google.cloud.billing.budgets.v1beta1.AllUpdatesRule

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > AllUpdatesRule.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllMonitoringNotificationChannels(Iterable<String> values)

public AllUpdatesRule.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
Name Description
values Iterable<String>

The monitoringNotificationChannels to add.
Returns
Type Description
AllUpdatesRule.Builder

This builder for chaining.

addMonitoringNotificationChannels(String value)

public AllUpdatesRule.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
Name Description
value String

The monitoringNotificationChannels to add.
Returns
Type Description
AllUpdatesRule.Builder

This builder for chaining.

addMonitoringNotificationChannelsBytes(ByteString value)

public AllUpdatesRule.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
Name Description
value ByteString

The bytes of the monitoringNotificationChannels to add.
Returns
Type Description
AllUpdatesRule.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AllUpdatesRule.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AllUpdatesRule.Builder
Overrides

build()

public AllUpdatesRule build()
Returns
Type Description
AllUpdatesRule

buildPartial()

public AllUpdatesRule buildPartial()
Returns
Type Description
AllUpdatesRule

clear()

public AllUpdatesRule.Builder clear()
Returns
Type Description
AllUpdatesRule.Builder
Overrides

clearDisableDefaultIamRecipients()

public AllUpdatesRule.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
AllUpdatesRule.Builder

This builder for chaining.

clearEnableProjectLevelRecipients()

public AllUpdatesRule.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
AllUpdatesRule.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public AllUpdatesRule.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
AllUpdatesRule.Builder
Overrides

clearMonitoringNotificationChannels()

public AllUpdatesRule.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
Type Description
AllUpdatesRule.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public AllUpdatesRule.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
AllUpdatesRule.Builder
Overrides

clearPubsubTopic()

public AllUpdatesRule.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-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
AllUpdatesRule.Builder

This builder for chaining.

clearSchemaVersion()

public AllUpdatesRule.Builder clearSchemaVersion()

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
AllUpdatesRule.Builder

This builder for chaining.

clone()

public AllUpdatesRule.Builder clone()
Returns
Type Description
AllUpdatesRule.Builder
Overrides

getDefaultInstanceForType()

public AllUpdatesRule getDefaultInstanceForType()
Returns
Type Description
AllUpdatesRule

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
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
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. 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 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 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 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
Type Description
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-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 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
Type Description
ByteString

The bytes for pubsubTopic.

getSchemaVersion()

public 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 ByteString getSchemaVersionBytes()

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
ByteString

The bytes for schemaVersion.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(AllUpdatesRule other)

public AllUpdatesRule.Builder mergeFrom(AllUpdatesRule other)
Parameter
Name Description
other AllUpdatesRule
Returns
Type Description
AllUpdatesRule.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AllUpdatesRule.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AllUpdatesRule.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public AllUpdatesRule.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
AllUpdatesRule.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AllUpdatesRule.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AllUpdatesRule.Builder
Overrides

setDisableDefaultIamRecipients(boolean value)

public AllUpdatesRule.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
AllUpdatesRule.Builder

This builder for chaining.

setEnableProjectLevelRecipients(boolean value)

public AllUpdatesRule.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
AllUpdatesRule.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public AllUpdatesRule.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
AllUpdatesRule.Builder
Overrides

setMonitoringNotificationChannels(int index, String value)

public AllUpdatesRule.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
Name Description
index int

The index to set the value at.
value String

The monitoringNotificationChannels to set.
Returns
Type Description
AllUpdatesRule.Builder

This builder for chaining.

setPubsubTopic(String value)

public AllUpdatesRule.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-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];

Parameter
Name Description
value String

The pubsubTopic to set.
Returns
Type Description
AllUpdatesRule.Builder

This builder for chaining.

setPubsubTopicBytes(ByteString value)

public AllUpdatesRule.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-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];

Parameter
Name Description
value ByteString

The bytes for pubsubTopic to set.
Returns
Type Description
AllUpdatesRule.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AllUpdatesRule.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
AllUpdatesRule.Builder
Overrides

setSchemaVersion(String value)

public AllUpdatesRule.Builder setSchemaVersion(String value)

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

Parameter
Name Description
value String

The schemaVersion to set.
Returns
Type Description
AllUpdatesRule.Builder

This builder for chaining.

setSchemaVersionBytes(ByteString value)

public AllUpdatesRule.Builder setSchemaVersionBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for schemaVersion to set.
Returns
Type Description
AllUpdatesRule.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final AllUpdatesRule.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
AllUpdatesRule.Builder
Overrides