feat: Supported project-level-budgets in Public Budget API V1 (#11597)

- [ ] Regenerate this pull request now.

Added `scope` for project scope filter in `ListBudgetsRequest`. When this field is set to a project's resource name, the budgets returned are tracking the costs for the given project.

feat: Added `enable_project_level_recipients` for project owner budget emails

Setting this field to true will enable email notification to project owners for project-level budgets.

PiperOrigin-RevId: 559152052

Source-Link: https://togithub.com/googleapis/googleapis/commit/113867b53b015c1f951e0e4e515756f221abc0a2

Source-Link: https://togithub.com/googleapis/googleapis-gen/commit/017d177f51469d150417b7b6a45d99d9963f7813
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWJpbGxpbmctYnVkZ2V0cy8uT3dsQm90LnlhbWwiLCJoIjoiMDE3ZDE3N2Y1MTQ2OWQxNTA0MTdiN2I2YTQ1ZDk5ZDk5NjNmNzgxMyJ9

BEGIN_NESTED_COMMIT
feat: Supported project-level-budgets in Public Budget API V1Beta
Added `scope` for project scope filter in `ListBudgetsRequest`. When this field is set to a project's resource name, the budgets returned are tracking the costs for the given project.

feat: Added `enable_project_level_recipients` for project owner budget emails

Setting this field to true will enable email notification to project owners for project-level budgets.

PiperOrigin-RevId: 559151636

Source-Link: https://togithub.com/googleapis/googleapis/commit/138b0f1265518d46c9f65403fe6ddd163f2757af

Source-Link: https://togithub.com/googleapis/googleapis-gen/commit/41c0ba899f76cbbfacddeccf7c769747acafe26d
Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWJpbGxpbmctYnVkZ2V0cy8uT3dsQm90LnlhbWwiLCJoIjoiNDFjMGJhODk5Zjc2Y2JiZmFjZGRlY2NmN2M3Njk3NDdhY2FmZTI2ZCJ9
END_NESTED_COMMIT

Author: gcf-owl-bot[bot]

packages/google-cloud-billing-budgets/.flake8

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright 2020 Google LLC
+# Copyright 2023 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

packages/google-cloud-billing-budgets/CONTRIBUTING.rst

@@ -236,7 +236,7 @@ We support:
 
 Supported versions can be found in our ``noxfile.py`` `config`_.
 
-.. _config: https://github.com/googleapis/google-cloud-python/blob/main/noxfile.py
+.. _config: https://github.com/googleapis/google-cloud-python/blob/main/packages/google-cloud-billing-budgets/noxfile.py
 
 
 **********

packages/google-cloud-billing-budgets/MANIFEST.in

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright 2020 Google LLC
+# Copyright 2023 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

packages/google-cloud-billing-budgets/README.rst

@@ -36,21 +36,24 @@ In order to use this library, you first need to go through the following steps:
 Installation
 ~~~~~~~~~~~~
 
-Install this library in a `virtualenv`_ using pip. `virtualenv`_ is a tool to
-create isolated Python environments. The basic problem it addresses is one of
-dependencies and versions, and indirectly permissions.
+Install this library in a virtual environment using `venv`_. `venv`_ is a tool that
+creates isolated Python environments. These isolated environments can have separate
+versions of Python packages, which allows you to isolate one project's dependencies
+from the dependencies of other projects.
 
-With `virtualenv`_, it's possible to install this library without needing system
+With `venv`_, it's possible to install this library without needing system
 install permissions, and without clashing with the installed system
 dependencies.
 
-.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/
+.. _`venv`: https://docs.python.org/3/library/venv.html
 
 
 Code samples and snippets
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Code samples and snippets live in the `samples/` folder.
+Code samples and snippets live in the `samples/`_ folder.
+
+.. _samples/: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-billing-budgets/samples
 
 
 Supported Python Versions
@@ -77,21 +80,19 @@ Mac/Linux
 
 .. code-block:: console
 
-    pip install virtualenv
-    virtualenv <your-env>
+    python3 -m venv <your-env>
     source <your-env>/bin/activate
-    <your-env>/bin/pip install google-cloud-billing-budgets
+    pip install google-cloud-billing-budgets
 
 
 Windows
 ^^^^^^^
 
 .. code-block:: console
 
-    pip install virtualenv
-    virtualenv <your-env>
-    <your-env>\Scripts\activate
-    <your-env>\Scripts\pip.exe install google-cloud-billing-budgets
+    py -m venv <your-env>
+    .\<your-env>\Scripts\activate
+    pip install google-cloud-billing-budgets
 
 Next Steps
 ~~~~~~~~~~

packages/google-cloud-billing-budgets/docs/conf.py

@@ -1,5 +1,5 @@
 # -*- coding: utf-8 -*-
-# Copyright 2021 Google LLC
+# Copyright 2023 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

packages/google-cloud-billing-budgets/google/cloud/billing/budgets_v1/types/budget_model.py

@@ -335,6 +335,14 @@ class NotificationsRule(proto.Message):
             Default notifications are sent to those with
             Billing Account Administrator and Billing
             Account User IAM roles for the target account.
+        enable_project_level_recipients (bool):
+            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.
     """
 
     pubsub_topic: str = proto.Field(
@@ -353,6 +361,10 @@ class NotificationsRule(proto.Message):
         proto.BOOL,
         number=4,
     )
+    enable_project_level_recipients: bool = proto.Field(
+        proto.BOOL,
+        number=5,
+    )
 
 
 class Filter(proto.Message):
@@ -378,9 +390,11 @@ class Filter(proto.Message):
             ``folders/{folderId}`` or
             ``organizations/{organizationId}``, specifying that usage
             from only this set of folders and organizations should be
-            included in the budget. If omitted, the report includes all
-            usage for all organizations, regardless of which
-            organization the usage occurred on.
+            included in the budget. If omitted, the budget includes all
+            usage that the billing account pays for. If the folder or
+            organization contains projects that are paid for by a
+            different Cloud Billing account, the budget *doesn't* apply
+            to those projects.
         credit_types (MutableSequence[str]):
             Optional. If
             [Filter.credit_types_treatment][google.cloud.billing.budgets.v1.Filter.credit_types_treatment]

packages/google-cloud-billing-budgets/google/cloud/billing/budgets_v1/types/budget_service.py

@@ -110,6 +110,18 @@ class ListBudgetsRequest(proto.Message):
             Required. Name of billing account to list budgets under.
             Values are of the form
             ``billingAccounts/{billingAccountId}``.
+        scope (str):
+            Optional. Set the scope of the budgets to be
+            returned, in the format of the resource name.
+            The scope of a budget is the cost that it
+            tracks, such as costs for a single project, or
+            the costs for all projects in a folder. Only
+            project scope (in the format of
+            "projects/project-id" or "projects/123") is
+            supported in this field. When this field is set
+            to a project's resource name, the budgets
+            returned are tracking the costs for that
+            project.
         page_size (int):
             Optional. The maximum number of budgets to
             return per page. The default and maximum value
@@ -125,6 +137,10 @@ class ListBudgetsRequest(proto.Message):
         proto.STRING,
         number=1,
     )
+    scope: str = proto.Field(
+        proto.STRING,
+        number=4,
+    )
     page_size: int = proto.Field(
         proto.INT32,
         number=2,

packages/google-cloud-billing-budgets/google/cloud/billing/budgets_v1beta1/types/budget_model.py

@@ -305,6 +305,14 @@ class AllUpdatesRule(proto.Message):
             Default notifications are sent to those with
             Billing Account Administrator and Billing
             Account User IAM roles for the target account.
+        enable_project_level_recipients (bool):
+            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.
     """
 
     pubsub_topic: str = proto.Field(
@@ -323,6 +331,10 @@ class AllUpdatesRule(proto.Message):
         proto.BOOL,
         number=4,
     )
+    enable_project_level_recipients: bool = proto.Field(
+        proto.BOOL,
+        number=5,
+    )
 
 
 class Filter(proto.Message):
@@ -348,9 +360,11 @@ class Filter(proto.Message):
             ``folders/{folderId}`` or
             ``organizations/{organizationId}``, specifying that usage
             from only this set of folders and organizations should be
-            included in the budget. If omitted, the report includes all
-            usage for all organizations, regardless of which
-            organization the usage occurred on.
+            included in the budget. If omitted, the budget includes all
+            usage that the billing account pays for. If the folder or
+            organization contains projects that are paid for by a
+            different Cloud Billing account, the budget *doesn't* apply
+            to those projects.
         credit_types (MutableSequence[str]):
             Optional. If
             [Filter.credit_types_treatment][google.cloud.billing.budgets.v1beta1.Filter.credit_types_treatment]

packages/google-cloud-billing-budgets/google/cloud/billing/budgets_v1beta1/types/budget_service.py

@@ -110,6 +110,18 @@ class ListBudgetsRequest(proto.Message):
             Required. Name of billing account to list budgets under.
             Values are of the form
             ``billingAccounts/{billingAccountId}``.
+        scope (str):
+            Optional. Set the scope of the budgets to be
+            returned, in the format of the resource name.
+            The scope of a budget is the cost that it
+            tracks, such as costs for a single project, or
+            the costs for all projects in a folder. Only
+            project scope (in the format of
+            "projects/project-id" or "projects/123") is
+            supported in this field. When this field is set
+            to a project's resource name, the budgets
+            returned are tracking the costs for that
+            project.
         page_size (int):
             Optional. The maximum number of budgets to
             return per page. The default and maximum value
@@ -125,6 +137,10 @@ class ListBudgetsRequest(proto.Message):
         proto.STRING,
         number=1,
     )
+    scope: str = proto.Field(
+        proto.STRING,
+        number=4,
+    )
     page_size: int = proto.Field(
         proto.INT32,
         number=2,

packages/google-cloud-billing-budgets/noxfile.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# Copyright 2018 Google LLC
+# Copyright 2023 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.