Package com.google.cloud.billing.budgets.v1beta1

Class AllUpdatesRule

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.billing.budgets.v1beta1.AllUpdatesRule
All Implemented Interfaces:
AllUpdatesRuleOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class AllUpdatesRule extends com.google.protobuf.GeneratedMessage implements AllUpdatesRuleOrBuilder
 AllUpdatesRule defines notifications that are sent based on budget spend
 and thresholds.
Protobuf type google.cloud.billing.budgets.v1beta1.AllUpdatesRule
See Also:

  • Field Details

    • PUBSUB_TOPIC_FIELD_NUMBER

      public static final int PUBSUB_TOPIC_FIELD_NUMBER
      See Also:

    • SCHEMA_VERSION_FIELD_NUMBER

      public static final int SCHEMA_VERSION_FIELD_NUMBER
      See Also:

    • MONITORING_NOTIFICATION_CHANNELS_FIELD_NUMBER

      public static final int MONITORING_NOTIFICATION_CHANNELS_FIELD_NUMBER
      See Also:

    • DISABLE_DEFAULT_IAM_RECIPIENTS_FIELD_NUMBER

      public static final int DISABLE_DEFAULT_IAM_RECIPIENTS_FIELD_NUMBER
      See Also:

    • ENABLE_PROJECT_LEVEL_RECIPIENTS_FIELD_NUMBER

      public static final int ENABLE_PROJECT_LEVEL_RECIPIENTS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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];
      Specified by:
      getPubsubTopic in interface AllUpdatesRuleOrBuilder
      Returns:
      The pubsubTopic.

    • getPubsubTopicBytes

      public 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];
      Specified by:
      getPubsubTopicBytes in interface AllUpdatesRuleOrBuilder
      Returns:
      The bytes for pubsubTopic.

    • getSchemaVersion

      public 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];
      Specified by:
      getSchemaVersion in interface AllUpdatesRuleOrBuilder
      Returns:
      The schemaVersion.

    • getSchemaVersionBytes

      public 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];
      Specified by:
      getSchemaVersionBytes in interface AllUpdatesRuleOrBuilder
      Returns:
      The bytes for schemaVersion.

    • getMonitoringNotificationChannelsList

      public com.google.protobuf.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];
      Specified by:
      getMonitoringNotificationChannelsList in interface AllUpdatesRuleOrBuilder
      Returns:
      A list containing the monitoringNotificationChannels.

    • 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];
      Specified by:
      getMonitoringNotificationChannelsCount in interface AllUpdatesRuleOrBuilder
      Returns:
      The count of monitoringNotificationChannels.

    • getMonitoringNotificationChannels

      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];
      Specified by:
      getMonitoringNotificationChannels in interface AllUpdatesRuleOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The monitoringNotificationChannels at the given index.

    • getMonitoringNotificationChannelsBytes

      public 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];
      Specified by:
      getMonitoringNotificationChannelsBytes in interface AllUpdatesRuleOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the monitoringNotificationChannels at the given index.

    • 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];
      Specified by:
      getDisableDefaultIamRecipients in interface AllUpdatesRuleOrBuilder
      Returns:
      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];
      Specified by:
      getEnableProjectLevelRecipients in interface AllUpdatesRuleOrBuilder
      Returns:
      The enableProjectLevelRecipients.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static AllUpdatesRule parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AllUpdatesRule parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AllUpdatesRule parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AllUpdatesRule parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AllUpdatesRule parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AllUpdatesRule parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static AllUpdatesRule parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AllUpdatesRule parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static AllUpdatesRule parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static AllUpdatesRule parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AllUpdatesRule parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static AllUpdatesRule parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public AllUpdatesRule.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static AllUpdatesRule.Builder newBuilder()

    • newBuilder

      public static AllUpdatesRule.Builder newBuilder(AllUpdatesRule prototype)

    • toBuilder

      public AllUpdatesRule.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected AllUpdatesRule.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static AllUpdatesRule getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<AllUpdatesRule> parser()

    • getParserForType

      public com.google.protobuf.Parser<AllUpdatesRule> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public AllUpdatesRule getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder