Class NotificationsRule

public final class NotificationsRule extends GeneratedMessageV3 implements NotificationsRuleOrBuilder

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

Protobuf type google.cloud.billing.budgets.v1.NotificationsRule

Fields

DISABLE_DEFAULT_IAM_RECIPIENTS_FIELD_NUMBER

public static final int DISABLE_DEFAULT_IAM_RECIPIENTS_FIELD_NUMBER
Field Value
TypeDescription
int

MONITORING_NOTIFICATION_CHANNELS_FIELD_NUMBER

public static final int MONITORING_NOTIFICATION_CHANNELS_FIELD_NUMBER
Field Value
TypeDescription
int

PUBSUB_TOPIC_FIELD_NUMBER

public static final int PUBSUB_TOPIC_FIELD_NUMBER
Field Value
TypeDescription
int

SCHEMA_VERSION_FIELD_NUMBER

public static final int SCHEMA_VERSION_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstance()

public static NotificationsRule getDefaultInstance()
Returns
TypeDescription
NotificationsRule

getDefaultInstanceForType()

public NotificationsRule getDefaultInstanceForType()
Returns
TypeDescription
NotificationsRule

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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
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.

getParserForType()

public Parser<NotificationsRule> getParserForType()
Returns
TypeDescription
Parser<NotificationsRule>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilder()

public static NotificationsRule.Builder newBuilder()
Returns
TypeDescription
NotificationsRule.Builder

newBuilder(NotificationsRule prototype)

public static NotificationsRule.Builder newBuilder(NotificationsRule prototype)
Parameter
NameDescription
prototypeNotificationsRule
Returns
TypeDescription
NotificationsRule.Builder

newBuilderForType()

public NotificationsRule.Builder newBuilderForType()
Returns
TypeDescription
NotificationsRule.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected NotificationsRule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
NotificationsRule.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

parseDelimitedFrom(InputStream input)

public static NotificationsRule parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
NotificationsRule
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static NotificationsRule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NotificationsRule
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static NotificationsRule parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
NotificationsRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static NotificationsRule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NotificationsRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static NotificationsRule parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
NotificationsRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static NotificationsRule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NotificationsRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static NotificationsRule parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
NotificationsRule
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static NotificationsRule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NotificationsRule
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static NotificationsRule parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
NotificationsRule
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static NotificationsRule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NotificationsRule
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static NotificationsRule parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
NotificationsRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static NotificationsRule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
NotificationsRule
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<NotificationsRule> parser()
Returns
TypeDescription
Parser<NotificationsRule>

toBuilder()

public NotificationsRule.Builder toBuilder()
Returns
TypeDescription
NotificationsRule.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException