docs: Add documentation for enums (#151)

gcf-owl-bot[bot] · web-flow · commit 287a2a568fd1 · 2023-01-23T10:11:27.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: https://github.com/googleapis/googleapis-gen/commit/0080f830dec37c3384157082bce279e37079ea58 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/google/cloud/shell_v1/services/cloud_shell_service/client.py b/google/cloud/shell_v1/services/cloud_shell_service/client.py
@@ -954,7 +954,7 @@ def sample_remove_public_key():
         # Done; return the response.
         return response
 
-    def __enter__(self):
+    def __enter__(self) -> "CloudShellServiceClient":
         return self
 
     def __exit__(self, type, value, traceback):
diff --git a/google/cloud/shell_v1/types/cloudshell.py b/google/cloud/shell_v1/types/cloudshell.py
@@ -94,7 +94,27 @@ class Environment(proto.Message):
     """
 
     class State(proto.Enum):
-        r"""Possible execution states for an environment."""
+        r"""Possible execution states for an environment.
+
+        Values:
+            STATE_UNSPECIFIED (0):
+                The environment's states is unknown.
+            SUSPENDED (1):
+                The environment is not running and can't be
+                connected to. Starting the environment will
+                transition it to the PENDING state.
+            PENDING (2):
+                The environment is being started but is not
+                yet ready to accept connections.
+            RUNNING (3):
+                The environment is running and ready to
+                accept connections. It will automatically
+                transition back to DISABLED after a period of
+                inactivity or if another environment is started.
+            DELETING (4):
+                The environment is being deleted and can't be
+                connected to.
+        """
         STATE_UNSPECIFIED = 0
         SUSPENDED = 1
         PENDING = 2
@@ -277,6 +297,33 @@ class State(proto.Enum):
         clients, but may be used to show a progress message to the user.
         An environment won't necessarily go through all of these states
         when starting. More states are likely to be added in the future.
+
+        Values:
+            STATE_UNSPECIFIED (0):
+                The environment's start state is unknown.
+            STARTING (1):
+                The environment is in the process of being
+                started, but no additional details are
+                available.
+            UNARCHIVING_DISK (2):
+                Startup is waiting for the user's disk to be
+                unarchived. This can happen when the user
+                returns to Cloud Shell after not having used it
+                for a while, and suggests that startup will take
+                longer than normal.
+            AWAITING_COMPUTE_RESOURCES (4):
+                Startup is waiting for compute resources to
+                be assigned to the environment. This should
+                normally happen very quickly, but an environment
+                might stay in this state for an extended period
+                of time if the system is experiencing heavy
+                load.
+            FINISHED (3):
+                Startup has completed. If the start operation
+                was successful, the user should be able to
+                establish an SSH connection to their
+                environment. Otherwise, the operation will
+                contain details of the failure.
         """
         STATE_UNSPECIFIED = 0
         STARTING = 1
@@ -406,7 +453,29 @@ class CloudShellErrorDetails(proto.Message):
     """
 
     class CloudShellErrorCode(proto.Enum):
-        r"""Set of possible errors returned from API calls."""
+        r"""Set of possible errors returned from API calls.
+
+        Values:
+            CLOUD_SHELL_ERROR_CODE_UNSPECIFIED (0):
+                An unknown error occurred.
+            IMAGE_UNAVAILABLE (1):
+                The image used by the Cloud Shell environment
+                either does not exist or the user does not have
+                access to it.
+            CLOUD_SHELL_DISABLED (2):
+                Cloud Shell has been disabled by an
+                administrator for the user making the request.
+            TOS_VIOLATION (4):
+                Cloud Shell has been permanently disabled due
+                to a Terms of Service violation by the user.
+            QUOTA_EXCEEDED (5):
+                The user has exhausted their weekly Cloud
+                Shell quota, and Cloud Shell will be disabled
+                until the quota resets.
+            ENVIRONMENT_UNAVAILABLE (6):
+                The Cloud Shell environment is unavailable
+                and cannot be connected to at the moment.
+        """
         CLOUD_SHELL_ERROR_CODE_UNSPECIFIED = 0
         IMAGE_UNAVAILABLE = 1
         CLOUD_SHELL_DISABLED = 2
diff --git a/samples/generated_samples/snippet_metadata_google.cloud.shell.v1.json b/samples/generated_samples/snippet_metadata_google.cloud.shell.v1.json
@@ -8,7 +8,7 @@
     ],
     "language": "PYTHON",
     "name": "google-cloud-shell",
-    "version": "1.6.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-shell",`
`11`		`- "version": "1.6.0"`
	`11`	`+ "version": "0.1.0"`
`12`	`12`	`},`
`13`	`13`	`"snippets": [`
`14`	`14`	`{`