docs: Add documentation for enums (#119)

* 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>

Author: gcf-owl-bot[bot]

google/cloud/dataplex_v1/services/content_service/client.py

@@ -1416,7 +1416,7 @@ def sample_list_content():
  # Done; return the response.
  return response
 
- def __enter__(self):
+ def __enter__(self) -> "ContentServiceClient":
  return self
 
  def __exit__(self, type, value, traceback):

google/cloud/dataplex_v1/services/data_scan_service/client.py

@@ -1480,7 +1480,7 @@ def sample_list_data_scan_jobs():
  # Done; return the response.
  return response
 
- def __enter__(self):
+ def __enter__(self) -> "DataScanServiceClient":
  return self
 
  def __exit__(self, type, value, traceback):

google/cloud/dataplex_v1/services/dataplex_service/client.py

@@ -4494,7 +4494,7 @@ def sample_list_sessions():
  # Done; return the response.
  return response
 
- def __enter__(self):
+ def __enter__(self) -> "DataplexServiceClient":
  return self
 
  def __exit__(self, type, value, traceback):

google/cloud/dataplex_v1/services/metadata_service/client.py

@@ -1450,7 +1450,7 @@ def sample_list_partitions():
  # Done; return the response.
  return response
 
- def __enter__(self):
+ def __enter__(self) -> "MetadataServiceClient":
  return self
 
  def __exit__(self, type, value, traceback):

google/cloud/dataplex_v1/types/analyze.py

@@ -356,7 +356,14 @@ class SqlScript(proto.Message):
  """
 
  class QueryEngine(proto.Enum):
- r"""Query Engine Type of the SQL Script."""
+ r"""Query Engine Type of the SQL Script.
+
+ Values:
+ QUERY_ENGINE_UNSPECIFIED (0):
+ Value was unspecified.
+ SPARK (2):
+ Spark SQL Query.
+ """
  QUERY_ENGINE_UNSPECIFIED = 0
  SPARK = 2
 
@@ -375,7 +382,14 @@ class Notebook(proto.Message):
  """
 
  class KernelType(proto.Enum):
- r"""Kernel Type of the Jupyter notebook."""
+ r"""Kernel Type of the Jupyter notebook.
+
+ Values:
+ KERNEL_TYPE_UNSPECIFIED (0):
+ Kernel Type unspecified.
+ PYTHON3 (1):
+ Python 3 Kernel.
+ """
  KERNEL_TYPE_UNSPECIFIED = 0
  PYTHON3 = 1
 

google/cloud/dataplex_v1/types/content.py

@@ -197,6 +197,15 @@ class GetContentRequest(proto.Message):
  class ContentView(proto.Enum):
  r"""Specifies whether the request should return the full or the
  partial representation.
+
+ Values:
+ CONTENT_VIEW_UNSPECIFIED (0):
+ Content view not specified. Defaults to
+ BASIC. The API will default to the BASIC view.
+ BASIC (1):
+ Will not return the ``data_text`` field.
+ FULL (2):
+ Returns the complete proto.
  """
  CONTENT_VIEW_UNSPECIFIED = 0
  BASIC = 1

google/cloud/dataplex_v1/types/data_quality.py

@@ -340,7 +340,18 @@ class StatisticRangeExpectation(proto.Message):
  """
 
  class ColumnStatistic(proto.Enum):
- r""""""
+ r"""
+
+ Values:
+ STATISTIC_UNDEFINED (0):
+ Unspecified statistic type
+ MEAN (1):
+ Evaluate the column mean
+ MIN (2):
+ Evaluate the column min
+ MAX (3):
+ Evaluate the column max
+ """
  STATISTIC_UNDEFINED = 0
  MEAN = 1
  MIN = 2

google/cloud/dataplex_v1/types/datascans.py

@@ -48,7 +48,16 @@
 
 
 class DataScanType(proto.Enum):
- r"""The type of DataScan."""
+ r"""The type of DataScan.
+
+ Values:
+ DATA_SCAN_TYPE_UNSPECIFIED (0):
+ The DataScan Type is unspecified.
+ DATA_QUALITY (1):
+ Data Quality Scan.
+ DATA_PROFILE (2):
+ Data Profile Scan.
+ """
  DATA_SCAN_TYPE_UNSPECIFIED = 0
  DATA_QUALITY = 1
  DATA_PROFILE = 2
@@ -145,7 +154,17 @@ class GetDataScanRequest(proto.Message):
  """
 
  class DataScanView(proto.Enum):
- r"""DataScan views for getting a partial dataScan."""
+ r"""DataScan views for getting a partial dataScan.
+
+ Values:
+ DATA_SCAN_VIEW_UNSPECIFIED (0):
+ The API will default to the ``BASIC`` view.
+ BASIC (1):
+ Basic view that does not include spec and
+ result.
+ FULL (10):
+ Include everything.
+ """
  DATA_SCAN_VIEW_UNSPECIFIED = 0
  BASIC = 1
  FULL = 10
@@ -292,7 +311,17 @@ class GetDataScanJobRequest(proto.Message):
  """
 
  class DataScanJobView(proto.Enum):
- r"""DataScanJob views for getting a partial dataScanJob."""
+ r"""DataScanJob views for getting a partial dataScanJob.
+
+ Values:
+ DATA_SCAN_JOB_VIEW_UNSPECIFIED (0):
+ The API will default to the ``BASIC`` view.
+ BASIC (1):
+ Basic view that does not include spec and
+ result.
+ FULL (10):
+ Include everything.
+ """
  DATA_SCAN_JOB_VIEW_UNSPECIFIED = 0
  BASIC = 1
  FULL = 10
@@ -642,7 +671,26 @@ class DataScanJob(proto.Message):
  """
 
  class State(proto.Enum):
- r"""Execution state for the DataScanJob."""
+ r"""Execution state for the DataScanJob.
+
+ Values:
+ STATE_UNSPECIFIED (0):
+ The DataScanJob state is unspecified.
+ RUNNING (1):
+ The DataScanJob is running.
+ CANCELING (2):
+ The DataScanJob is canceling.
+ CANCELLED (3):
+ The DataScanJob cancellation was successful.
+ SUCCEEDED (4):
+ The DataScanJob completed successfully.
+ FAILED (5):
+ The DataScanJob is no longer running due to
+ an error.
+ PENDING (7):
+ The DataScanJob has been created but not
+ started to run yet.
+ """
  STATE_UNSPECIFIED = 0
  RUNNING = 1
  CANCELING = 2