docs: Add documentation for enums (#235)

gcf-owl-bot[bot] · web-flow · commit 4424b89c0af0 · 2023-01-23T10:17:30.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/workflows/executions_v1/services/executions/client.py b/google/cloud/workflows/executions_v1/services/executions/client.py
@@ -914,7 +914,7 @@ def sample_cancel_execution():
         # Done; return the response.
         return response
 
-    def __enter__(self):
+    def __enter__(self) -> "ExecutionsClient":
         return self
 
     def __exit__(self, type, value, traceback):
diff --git a/google/cloud/workflows/executions_v1/types/executions.py b/google/cloud/workflows/executions_v1/types/executions.py
@@ -33,7 +33,18 @@
 
 
 class ExecutionView(proto.Enum):
-    r"""Defines possible views for execution resource."""
+    r"""Defines possible views for execution resource.
+
+    Values:
+        EXECUTION_VIEW_UNSPECIFIED (0):
+            The default / unset value.
+        BASIC (1):
+            Includes only basic metadata about the execution. Following
+            fields are returned: name, start_time, end_time, state and
+            workflow_revision_id.
+        FULL (2):
+            Includes all data.
+    """
     EXECUTION_VIEW_UNSPECIFIED = 0
     BASIC = 1
     FULL = 2
@@ -83,6 +94,18 @@ class Execution(proto.Message):
     class State(proto.Enum):
         r"""Describes the current state of the execution. More states
         might be added in the future.
+
+        Values:
+            STATE_UNSPECIFIED (0):
+                Invalid state.
+            ACTIVE (1):
+                The execution is in progress.
+            SUCCEEDED (2):
+                The execution finished successfully.
+            FAILED (3):
+                The execution failed with an error.
+            CANCELLED (4):
+                The execution was stopped intentionally.
         """
         STATE_UNSPECIFIED = 0
         ACTIVE = 1
@@ -93,6 +116,16 @@ class State(proto.Enum):
     class CallLogLevel(proto.Enum):
         r"""Describes the level of platform logging to apply to calls and
         call responses during workflow executions.
+
+        Values:
+            CALL_LOG_LEVEL_UNSPECIFIED (0):
+                No call logging specified.
+            LOG_ALL_CALLS (1):
+                Log all call steps within workflows, all call
+                returns, and all exceptions raised.
+            LOG_ERRORS_ONLY (2):
+                Log only exceptions that are raised from call
+                steps within workflows.
         """
         CALL_LOG_LEVEL_UNSPECIFIED = 0
         LOG_ALL_CALLS = 1
diff --git a/google/cloud/workflows/executions_v1beta/services/executions/client.py b/google/cloud/workflows/executions_v1beta/services/executions/client.py
@@ -915,7 +915,7 @@ def sample_cancel_execution():
         # Done; return the response.
         return response
 
-    def __enter__(self):
+    def __enter__(self) -> "ExecutionsClient":
         return self
 
     def __exit__(self, type, value, traceback):
diff --git a/google/cloud/workflows/executions_v1beta/types/executions.py b/google/cloud/workflows/executions_v1beta/types/executions.py
@@ -33,7 +33,18 @@
 
 
 class ExecutionView(proto.Enum):
-    r"""Defines possible views for execution resource."""
+    r"""Defines possible views for execution resource.
+
+    Values:
+        EXECUTION_VIEW_UNSPECIFIED (0):
+            The default / unset value.
+        BASIC (1):
+            Includes only basic metadata about the execution. Following
+            fields are returned: name, start_time, end_time, state and
+            workflow_revision_id.
+        FULL (2):
+            Includes all data.
+    """
     EXECUTION_VIEW_UNSPECIFIED = 0
     BASIC = 1
     FULL = 2
@@ -75,6 +86,18 @@ class Execution(proto.Message):
     class State(proto.Enum):
         r"""Describes the current state of the execution. More states may
         be added in the future.
+
+        Values:
+            STATE_UNSPECIFIED (0):
+                Invalid state.
+            ACTIVE (1):
+                The execution is in progress.
+            SUCCEEDED (2):
+                The execution finished successfully.
+            FAILED (3):
+                The execution failed with an error.
+            CANCELLED (4):
+                The execution was stopped intentionally.
         """
         STATE_UNSPECIFIED = 0
         ACTIVE = 1
diff --git a/google/cloud/workflows_v1/services/workflows/client.py b/google/cloud/workflows_v1/services/workflows/client.py
@@ -1091,7 +1091,7 @@ def sample_update_workflow():
         # Done; return the response.
         return response
 
-    def __enter__(self):
+    def __enter__(self) -> "WorkflowsClient":
         return self
 
     def __exit__(self, type, value, traceback):
diff --git a/google/cloud/workflows_v1/types/workflows.py b/google/cloud/workflows_v1/types/workflows.py
@@ -106,6 +106,13 @@ class Workflow(proto.Message):
     class State(proto.Enum):
         r"""Describes the current state of workflow deployment. More
         states may be added in the future.
+
+        Values:
+            STATE_UNSPECIFIED (0):
+                Invalid state.
+            ACTIVE (1):
+                The workflow has been deployed successfully
+                and is serving.
         """
         STATE_UNSPECIFIED = 0
         ACTIVE = 1
diff --git a/google/cloud/workflows_v1beta/services/workflows/client.py b/google/cloud/workflows_v1beta/services/workflows/client.py
@@ -1091,7 +1091,7 @@ def sample_update_workflow():
         # Done; return the response.
         return response
 
-    def __enter__(self):
+    def __enter__(self) -> "WorkflowsClient":
         return self
 
     def __exit__(self, type, value, traceback):
diff --git a/google/cloud/workflows_v1beta/types/workflows.py b/google/cloud/workflows_v1beta/types/workflows.py
@@ -103,6 +103,13 @@ class Workflow(proto.Message):
     class State(proto.Enum):
         r"""Describes the current state of workflow deployment. More
         states may be added in the future.
+
+        Values:
+            STATE_UNSPECIFIED (0):
+                Invalid state.
+            ACTIVE (1):
+                The workflow has been deployed successfully
+                and is serving.
         """
         STATE_UNSPECIFIED = 0
         ACTIVE = 1
diff --git a/samples/generated_samples/snippet_metadata_google.cloud.workflows.v1.json b/samples/generated_samples/snippet_metadata_google.cloud.workflows.v1.json
@@ -8,7 +8,7 @@
     ],
     "language": "PYTHON",
     "name": "google-cloud-workflows",
-    "version": "1.9.0"
+    "version": "0.1.0"
   },
   "snippets": [
     {
diff --git a/samples/generated_samples/snippet_metadata_google.cloud.workflows.v1beta.json b/samples/generated_samples/snippet_metadata_google.cloud.workflows.v1beta.json
@@ -8,7 +8,7 @@
     ],
     "language": "PYTHON",
     "name": "google-cloud-workflows",
-    "version": "1.9.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-workflows",`
`11`		`- "version": "1.9.0"`
	`11`	`+ "version": "0.1.0"`
`12`	`12`	`},`
`13`	`13`	`"snippets": [`
`14`	`14`	`{`