docs: Add documentation for enums (#252)

gcf-owl-bot[bot] · web-flow · commit 44941e141e7b · 2023-01-20T14:29:33.000-05:00
* docs: Add documentation for enums fix: Add context manager return types chore: Update gapic-generator-python to v1.8.1 PiperOrigin-RevId: 503210727 Source-Link: googleapis/googleapis@a391fd1 Source-Link: googleapis/googleapis-gen@0080f83 Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMDA4MGY4MzBkZWMzN2MzMzg0MTU3MDgyYmNlMjc5ZTM3MDc5ZWE1OCJ9 * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
diff --git a/packages/google-cloud-resource-manager/google/cloud/resourcemanager_v3/services/folders/client.py b/packages/google-cloud-resource-manager/google/cloud/resourcemanager_v3/services/folders/client.py
@@ -1962,7 +1962,7 @@ def sample_test_iam_permissions():
         # Done; return the response.
         return response
 
-    def __enter__(self):
+    def __enter__(self) -> "FoldersClient":
         return self
 
     def __exit__(self, type, value, traceback):
diff --git a/packages/google-cloud-resource-manager/google/cloud/resourcemanager_v3/services/organizations/client.py b/packages/google-cloud-resource-manager/google/cloud/resourcemanager_v3/services/organizations/client.py
@@ -1138,7 +1138,7 @@ def sample_test_iam_permissions():
         # Done; return the response.
         return response
 
-    def __enter__(self):
+    def __enter__(self) -> "OrganizationsClient":
         return self
 
     def __exit__(self, type, value, traceback):
diff --git a/packages/google-cloud-resource-manager/google/cloud/resourcemanager_v3/services/projects/client.py b/packages/google-cloud-resource-manager/google/cloud/resourcemanager_v3/services/projects/client.py
@@ -2018,7 +2018,7 @@ def sample_test_iam_permissions():
         # Done; return the response.
         return response
 
-    def __enter__(self):
+    def __enter__(self) -> "ProjectsClient":
         return self
 
     def __exit__(self, type, value, traceback):
diff --git a/packages/google-cloud-resource-manager/google/cloud/resourcemanager_v3/services/tag_bindings/client.py b/packages/google-cloud-resource-manager/google/cloud/resourcemanager_v3/services/tag_bindings/client.py
@@ -792,7 +792,7 @@ def sample_delete_tag_binding():
         # Done; return the response.
         return response
 
-    def __enter__(self):
+    def __enter__(self) -> "TagBindingsClient":
         return self
 
     def __exit__(self, type, value, traceback):
diff --git a/packages/google-cloud-resource-manager/google/cloud/resourcemanager_v3/services/tag_keys/client.py b/packages/google-cloud-resource-manager/google/cloud/resourcemanager_v3/services/tag_keys/client.py
@@ -1482,7 +1482,7 @@ def sample_test_iam_permissions():
         # Done; return the response.
         return response
 
-    def __enter__(self):
+    def __enter__(self) -> "TagKeysClient":
         return self
 
     def __exit__(self, type, value, traceback):
diff --git a/packages/google-cloud-resource-manager/google/cloud/resourcemanager_v3/services/tag_values/client.py b/packages/google-cloud-resource-manager/google/cloud/resourcemanager_v3/services/tag_values/client.py
@@ -1480,7 +1480,7 @@ def sample_test_iam_permissions():
         # Done; return the response.
         return response
 
-    def __enter__(self):
+    def __enter__(self) -> "TagValuesClient":
         return self
 
     def __exit__(self, type, value, traceback):
diff --git a/packages/google-cloud-resource-manager/google/cloud/resourcemanager_v3/types/folders.py b/packages/google-cloud-resource-manager/google/cloud/resourcemanager_v3/types/folders.py
@@ -87,7 +87,17 @@ class Folder(proto.Message):
     """
 
     class State(proto.Enum):
-        r"""Folder lifecycle states."""
+        r"""Folder lifecycle states.
+
+        Values:
+            STATE_UNSPECIFIED (0):
+                Unspecified state.
+            ACTIVE (1):
+                The normal and active state.
+            DELETE_REQUESTED (2):
+                The folder has been marked for deletion by
+                the user.
+        """
         STATE_UNSPECIFIED = 0
         ACTIVE = 1
         DELETE_REQUESTED = 2
diff --git a/packages/google-cloud-resource-manager/google/cloud/resourcemanager_v3/types/organizations.py b/packages/google-cloud-resource-manager/google/cloud/resourcemanager_v3/types/organizations.py
@@ -78,7 +78,18 @@ class Organization(proto.Message):
     """
 
     class State(proto.Enum):
-        r"""Organization lifecycle states."""
+        r"""Organization lifecycle states.
+
+        Values:
+            STATE_UNSPECIFIED (0):
+                Unspecified state.  This is only useful for
+                distinguishing unset values.
+            ACTIVE (1):
+                The normal and active state.
+            DELETE_REQUESTED (2):
+                The organization has been marked for deletion
+                by the user.
+        """
         STATE_UNSPECIFIED = 0
         ACTIVE = 1
         DELETE_REQUESTED = 2
diff --git a/packages/google-cloud-resource-manager/google/cloud/resourcemanager_v3/types/projects.py b/packages/google-cloud-resource-manager/google/cloud/resourcemanager_v3/types/projects.py
@@ -109,7 +109,22 @@ class Project(proto.Message):
     """
 
     class State(proto.Enum):
-        r"""Project lifecycle states."""
+        r"""Project lifecycle states.
+
+        Values:
+            STATE_UNSPECIFIED (0):
+                Unspecified state.  This is only used/useful
+                for distinguishing unset values.
+            ACTIVE (1):
+                The normal and active state.
+            DELETE_REQUESTED (2):
+                The project has been marked for deletion by the user (by
+                invoking
+                [DeleteProject][google.cloud.resourcemanager.v3.Projects.DeleteProject])
+                or by the system (Google Cloud Platform). This can generally
+                be reversed by invoking [UndeleteProject]
+                [google.cloud.resourcemanager.v3.Projects.UndeleteProject].
+        """
         STATE_UNSPECIFIED = 0
         ACTIVE = 1
         DELETE_REQUESTED = 2
diff --git a/packages/google-cloud-resource-manager/samples/generated_samples/snippet_metadata_google.cloud.resourcemanager.v3.json b/packages/google-cloud-resource-manager/samples/generated_samples/snippet_metadata_google.cloud.resourcemanager.v3.json
@@ -8,7 +8,7 @@
     ],
     "language": "PYTHON",
     "name": "google-cloud-resource-manager",
-    "version": "1.8.0"
+    "version": "0.1.0"
   },
   "snippets": [
     {

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`],`
`9`	`9`	`"language": "PYTHON",`
`10`	`10`	`"name": "google-cloud-resource-manager",`
`11`		`- "version": "1.8.0"`
	`11`	`+ "version": "0.1.0"`
`12`	`12`	`},`
`13`	`13`	`"snippets": [`
`14`	`14`	`{`