docs: Add documentation for enums (#161)

gcf-owl-bot[bot] · web-flow · commit 970281ecea66 · 2023-01-20T11:24:02.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/bigquery_migration_v2/services/migration_service/client.py b/google/cloud/bigquery_migration_v2/services/migration_service/client.py
@@ -1231,7 +1231,7 @@ def sample_list_migration_subtasks():
         # Done; return the response.
         return response
 
-    def __enter__(self):
+    def __enter__(self) -> "MigrationServiceClient":
         return self
 
     def __exit__(self, type, value, traceback):
diff --git a/google/cloud/bigquery_migration_v2/types/migration_entities.py b/google/cloud/bigquery_migration_v2/types/migration_entities.py
@@ -63,7 +63,27 @@ class MigrationWorkflow(proto.Message):
     """
 
     class State(proto.Enum):
-        r"""Possible migration workflow states."""
+        r"""Possible migration workflow states.
+
+        Values:
+            STATE_UNSPECIFIED (0):
+                Workflow state is unspecified.
+            DRAFT (1):
+                Workflow is in draft status, i.e. tasks are
+                not yet eligible for execution.
+            RUNNING (2):
+                Workflow is running (i.e. tasks are eligible
+                for execution).
+            PAUSED (3):
+                Workflow is paused. Tasks currently in
+                progress may continue, but no further tasks will
+                be scheduled.
+            COMPLETED (4):
+                Workflow is complete. There should not be any
+                task in a non-terminal state, but if they are
+                (e.g. forced termination), they will not be
+                scheduled.
+        """
         STATE_UNSPECIFIED = 0
         DRAFT = 1
         RUNNING = 2
@@ -138,7 +158,26 @@ class MigrationTask(proto.Message):
     """
 
     class State(proto.Enum):
-        r"""Possible states of a migration task."""
+        r"""Possible states of a migration task.
+
+        Values:
+            STATE_UNSPECIFIED (0):
+                The state is unspecified.
+            PENDING (1):
+                The task is waiting for orchestration.
+            ORCHESTRATING (2):
+                The task is assigned to an orchestrator.
+            RUNNING (3):
+                The task is running, i.e. its subtasks are
+                ready for execution.
+            PAUSED (4):
+                Tha task is paused. Assigned subtasks can
+                continue, but no new subtasks will be scheduled.
+            SUCCEEDED (5):
+                The task finished successfully.
+            FAILED (6):
+                The task finished unsuccessfully.
+        """
         STATE_UNSPECIFIED = 0
         PENDING = 1
         ORCHESTRATING = 2
@@ -234,7 +273,27 @@ class MigrationSubtask(proto.Message):
     """
 
     class State(proto.Enum):
-        r"""Possible states of a migration subtask."""
+        r"""Possible states of a migration subtask.
+
+        Values:
+            STATE_UNSPECIFIED (0):
+                The state is unspecified.
+            ACTIVE (1):
+                The subtask is ready, i.e. it is ready for
+                execution.
+            RUNNING (2):
+                The subtask is running, i.e. it is assigned
+                to a worker for execution.
+            SUCCEEDED (3):
+                The subtask finished successfully.
+            FAILED (4):
+                The subtask finished unsuccessfully.
+            PAUSED (5):
+                The subtask is paused, i.e., it will not be
+                scheduled. If it was already assigned,it might
+                still finish but no new lease renewals will be
+                granted.
+        """
         STATE_UNSPECIFIED = 0
         ACTIVE = 1
         RUNNING = 2
diff --git a/google/cloud/bigquery_migration_v2/types/translation_config.py b/google/cloud/bigquery_migration_v2/types/translation_config.py
@@ -288,7 +288,16 @@ class TeradataDialect(proto.Message):
     """
 
     class Mode(proto.Enum):
-        r"""The sub-dialect options for Teradata."""
+        r"""The sub-dialect options for Teradata.
+
+        Values:
+            MODE_UNSPECIFIED (0):
+                Unspecified mode.
+            SQL (1):
+                Teradata SQL mode.
+            BTEQ (2):
+                BTEQ mode (which includes SQL).
+        """
         MODE_UNSPECIFIED = 0
         SQL = 1
         BTEQ = 2
@@ -404,7 +413,27 @@ class NameMappingKey(proto.Message):
     """
 
     class Type(proto.Enum):
-        r"""The type of the object that is being mapped."""
+        r"""The type of the object that is being mapped.
+
+        Values:
+            TYPE_UNSPECIFIED (0):
+                Unspecified name mapping type.
+            DATABASE (1):
+                The object being mapped is a database.
+            SCHEMA (2):
+                The object being mapped is a schema.
+            RELATION (3):
+                The object being mapped is a relation.
+            ATTRIBUTE (4):
+                The object being mapped is an attribute.
+            RELATION_ALIAS (5):
+                The object being mapped is a relation alias.
+            ATTRIBUTE_ALIAS (6):
+                The object being mapped is a an attribute
+                alias.
+            FUNCTION (7):
+                The object being mapped is a function.
+        """
         TYPE_UNSPECIFIED = 0
         DATABASE = 1
         SCHEMA = 2
diff --git a/google/cloud/bigquery_migration_v2alpha/services/migration_service/client.py b/google/cloud/bigquery_migration_v2alpha/services/migration_service/client.py
@@ -1231,7 +1231,7 @@ def sample_list_migration_subtasks():
         # Done; return the response.
         return response
 
-    def __enter__(self):
+    def __enter__(self) -> "MigrationServiceClient":
         return self
 
     def __exit__(self, type, value, traceback):
diff --git a/google/cloud/bigquery_migration_v2alpha/types/migration_entities.py b/google/cloud/bigquery_migration_v2alpha/types/migration_entities.py
@@ -66,7 +66,27 @@ class MigrationWorkflow(proto.Message):
     """
 
     class State(proto.Enum):
-        r"""Possible migration workflow states."""
+        r"""Possible migration workflow states.
+
+        Values:
+            STATE_UNSPECIFIED (0):
+                Workflow state is unspecified.
+            DRAFT (1):
+                Workflow is in draft status, i.e. tasks are
+                not yet eligible for execution.
+            RUNNING (2):
+                Workflow is running (i.e. tasks are eligible
+                for execution).
+            PAUSED (3):
+                Workflow is paused. Tasks currently in
+                progress may continue, but no further tasks will
+                be scheduled.
+            COMPLETED (4):
+                Workflow is complete. There should not be any
+                task in a non-terminal state, but if they are
+                (e.g. forced termination), they will not be
+                scheduled.
+        """
         STATE_UNSPECIFIED = 0
         DRAFT = 1
         RUNNING = 2
@@ -151,7 +171,26 @@ class MigrationTask(proto.Message):
     """
 
     class State(proto.Enum):
-        r"""Possible states of a migration task."""
+        r"""Possible states of a migration task.
+
+        Values:
+            STATE_UNSPECIFIED (0):
+                The state is unspecified.
+            PENDING (1):
+                The task is waiting for orchestration.
+            ORCHESTRATING (2):
+                The task is assigned to an orchestrator.
+            RUNNING (3):
+                The task is running, i.e. its subtasks are
+                ready for execution.
+            PAUSED (4):
+                Tha task is paused. Assigned subtasks can
+                continue, but no new subtasks will be scheduled.
+            SUCCEEDED (5):
+                The task finished successfully.
+            FAILED (6):
+                The task finished unsuccessfully.
+        """
         STATE_UNSPECIFIED = 0
         PENDING = 1
         ORCHESTRATING = 2
@@ -261,7 +300,27 @@ class MigrationSubtask(proto.Message):
     """
 
     class State(proto.Enum):
-        r"""Possible states of a migration subtask."""
+        r"""Possible states of a migration subtask.
+
+        Values:
+            STATE_UNSPECIFIED (0):
+                The state is unspecified.
+            ACTIVE (1):
+                The subtask is ready, i.e. it is ready for
+                execution.
+            RUNNING (2):
+                The subtask is running, i.e. it is assigned
+                to a worker for execution.
+            SUCCEEDED (3):
+                The subtask finished successfully.
+            FAILED (4):
+                The subtask finished unsuccessfully.
+            PAUSED (5):
+                The subtask is paused, i.e., it will not be
+                scheduled. If it was already assigned,it might
+                still finish but no new lease renewals will be
+                granted.
+        """
         STATE_UNSPECIFIED = 0
         ACTIVE = 1
         RUNNING = 2
diff --git a/google/cloud/bigquery_migration_v2alpha/types/translation_task.py b/google/cloud/bigquery_migration_v2alpha/types/translation_task.py
@@ -116,7 +116,24 @@ class TranslationTaskDetails(proto.Message):
     """
 
     class FileEncoding(proto.Enum):
-        r"""The file encoding types."""
+        r"""The file encoding types.
+
+        Values:
+            FILE_ENCODING_UNSPECIFIED (0):
+                File encoding setting is not specified.
+            UTF_8 (1):
+                File encoding is UTF_8.
+            ISO_8859_1 (2):
+                File encoding is ISO_8859_1.
+            US_ASCII (3):
+                File encoding is US_ASCII.
+            UTF_16 (4):
+                File encoding is UTF_16.
+            UTF_16LE (5):
+                File encoding is UTF_16LE.
+            UTF_16BE (6):
+                File encoding is UTF_16BE.
+        """
         FILE_ENCODING_UNSPECIFIED = 0
         UTF_8 = 1
         ISO_8859_1 = 2
@@ -126,7 +143,26 @@ class FileEncoding(proto.Enum):
         UTF_16BE = 6
 
     class TokenType(proto.Enum):
-        r"""The special token data type."""
+        r"""The special token data type.
+
+        Values:
+            TOKEN_TYPE_UNSPECIFIED (0):
+                Token type is not specified.
+            STRING (1):
+                Token type as string.
+            INT64 (2):
+                Token type as integer.
+            NUMERIC (3):
+                Token type as numeric.
+            BOOL (4):
+                Token type as boolean.
+            FLOAT64 (5):
+                Token type as float.
+            DATE (6):
+                Token type as date.
+            TIMESTAMP (7):
+                Token type as timestamp.
+        """
         TOKEN_TYPE_UNSPECIFIED = 0
         STRING = 1
         INT64 = 2
@@ -220,14 +256,35 @@ class IdentifierSettings(proto.Message):
     """
 
     class IdentifierCase(proto.Enum):
-        r"""The identifier case type."""
+        r"""The identifier case type.
+
+        Values:
+            IDENTIFIER_CASE_UNSPECIFIED (0):
+                The identifier case is not specified.
+            ORIGINAL (1):
+                Identifiers' cases will be kept as the
+                original cases.
+            UPPER (2):
+                Identifiers will be in upper cases.
+            LOWER (3):
+                Identifiers will be in lower cases.
+        """
         IDENTIFIER_CASE_UNSPECIFIED = 0
         ORIGINAL = 1
         UPPER = 2
         LOWER = 3
 
     class IdentifierRewriteMode(proto.Enum):
-        r"""The SQL identifier rewrite mode."""
+        r"""The SQL identifier rewrite mode.
+
+        Values:
+            IDENTIFIER_REWRITE_MODE_UNSPECIFIED (0):
+                SQL Identifier rewrite mode is unspecified.
+            NONE (1):
+                SQL identifiers won't be rewrite.
+            REWRITE_ALL (2):
+                All SQL identifiers will be rewrite.
+        """
         IDENTIFIER_REWRITE_MODE_UNSPECIFIED = 0
         NONE = 1
         REWRITE_ALL = 2
diff --git a/samples/generated_samples/snippet_metadata_google.cloud.bigquery.migration.v2.json b/samples/generated_samples/snippet_metadata_google.cloud.bigquery.migration.v2.json
@@ -8,7 +8,7 @@
     ],
     "language": "PYTHON",
     "name": "google-cloud-bigquery-migration",
-    "version": "0.9.0"
+    "version": "0.1.0"
   },
   "snippets": [
     {
diff --git a/samples/generated_samples/snippet_metadata_google.cloud.bigquery.migration.v2alpha.json b/samples/generated_samples/snippet_metadata_google.cloud.bigquery.migration.v2alpha.json
@@ -8,7 +8,7 @@
     ],
     "language": "PYTHON",
     "name": "google-cloud-bigquery-migration",
-    "version": "0.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-bigquery-migration",`
`11`		`- "version": "0.9.0"`
	`11`	`+ "version": "0.1.0"`
`12`	`12`	`},`
`13`	`13`	`"snippets": [`
`14`	`14`	`{`