Class AllUpdatesRule (2.17.0) 

public final class AllUpdatesRule extends GeneratedMessageV3 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<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > AllUpdatesRule

Static Fields

DISABLE_DEFAULT_IAM_RECIPIENTS_FIELD_NUMBER

public static final int DISABLE_DEFAULT_IAM_RECIPIENTS_FIELD_NUMBER
Field Value
Type Description
int

MONITORING_NOTIFICATION_CHANNELS_FIELD_NUMBER

public static final int MONITORING_NOTIFICATION_CHANNELS_FIELD_NUMBER
Field Value
Type Description
int

PUBSUB_TOPIC_FIELD_NUMBER

public static final int PUBSUB_TOPIC_FIELD_NUMBER
Field Value
Type Description
int

SCHEMA_VERSION_FIELD_NUMBER

public static final int SCHEMA_VERSION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AllUpdatesRule getDefaultInstance()
Returns
Type Description
AllUpdatesRule

getDescriptor()

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

newBuilder()

public static AllUpdatesRule.Builder newBuilder()
Returns
Type Description
AllUpdatesRule.Builder

newBuilder(AllUpdatesRule prototype)

public static AllUpdatesRule.Builder newBuilder(AllUpdatesRule prototype)
Parameter
Name Description
prototype AllUpdatesRule
Returns
Type Description
AllUpdatesRule.Builder

parseDelimitedFrom(InputStream input)

public static AllUpdatesRule parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AllUpdatesRule
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AllUpdatesRule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AllUpdatesRule
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AllUpdatesRule parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AllUpdatesRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AllUpdatesRule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AllUpdatesRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AllUpdatesRule parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AllUpdatesRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AllUpdatesRule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AllUpdatesRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AllUpdatesRule parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AllUpdatesRule
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AllUpdatesRule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AllUpdatesRule
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AllUpdatesRule parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AllUpdatesRule
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AllUpdatesRule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AllUpdatesRule
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AllUpdatesRule parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AllUpdatesRule
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AllUpdatesRule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AllUpdatesRule
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AllUpdatesRule> parser()
Returns
Type Description
Parser<AllUpdatesRule>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public AllUpdatesRule getDefaultInstanceForType()
Returns
Type Description
AllUpdatesRule

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.

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.

getParserForType()

public Parser<AllUpdatesRule> getParserForType()
Returns
Type Description
Parser<AllUpdatesRule>
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-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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
Type Description
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AllUpdatesRule.Builder newBuilderForType()
Returns
Type Description
AllUpdatesRule.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AllUpdatesRule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AllUpdatesRule.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AllUpdatesRule.Builder toBuilder()
Returns
Type Description
AllUpdatesRule.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException