docs: Add documentation for enums (#398)

* 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>
googleapis · Jan 23, 2023 · 0815c39 · 0815c39
1 parent ff4cb70
commit 0815c39
Show file tree

Hide file tree

Showing 16 changed files with 277 additions and 27 deletions.
diff --git a/google/cloud/videointelligence_v1/services/video_intelligence_service/client.py b/google/cloud/videointelligence_v1/services/video_intelligence_service/client.py
@@ -557,7 +557,7 @@ def sample_annotate_video():
         # Done; return the response.
         return response
 
-    def __enter__(self):
+    def __enter__(self) -> "VideoIntelligenceServiceClient":
         return self
 
     def __exit__(self, type, value, traceback):

diff --git a/google/cloud/videointelligence_v1/types/video_intelligence.py b/google/cloud/videointelligence_v1/types/video_intelligence.py
@@ -74,7 +74,31 @@
 
 
 class Feature(proto.Enum):
-    r"""Video annotation feature."""
+    r"""Video annotation feature.
+
+    Values:
+        FEATURE_UNSPECIFIED (0):
+            Unspecified.
+        LABEL_DETECTION (1):
+            Label detection. Detect objects, such as dog
+            or flower.
+        SHOT_CHANGE_DETECTION (2):
+            Shot change detection.
+        EXPLICIT_CONTENT_DETECTION (3):
+            Explicit content detection.
+        FACE_DETECTION (4):
+            Human face detection.
+        SPEECH_TRANSCRIPTION (6):
+            Speech transcription.
+        TEXT_DETECTION (7):
+            OCR text detection and tracking.
+        OBJECT_TRACKING (9):
+            Object detection and tracking.
+        LOGO_RECOGNITION (12):
+            Logo detection, tracking, and recognition.
+        PERSON_DETECTION (14):
+            Person detection.
+    """
     FEATURE_UNSPECIFIED = 0
     LABEL_DETECTION = 1
     SHOT_CHANGE_DETECTION = 2
@@ -88,15 +112,42 @@ class Feature(proto.Enum):
 
 
 class LabelDetectionMode(proto.Enum):
-    r"""Label detection mode."""
+    r"""Label detection mode.
+
+    Values:
+        LABEL_DETECTION_MODE_UNSPECIFIED (0):
+            Unspecified.
+        SHOT_MODE (1):
+            Detect shot-level labels.
+        FRAME_MODE (2):
+            Detect frame-level labels.
+        SHOT_AND_FRAME_MODE (3):
+            Detect both shot-level and frame-level
+            labels.
+    """
     LABEL_DETECTION_MODE_UNSPECIFIED = 0
     SHOT_MODE = 1
     FRAME_MODE = 2
     SHOT_AND_FRAME_MODE = 3
 
 
 class Likelihood(proto.Enum):
-    r"""Bucketized representation of likelihood."""
+    r"""Bucketized representation of likelihood.
+
+    Values:
+        LIKELIHOOD_UNSPECIFIED (0):
+            Unspecified likelihood.
+        VERY_UNLIKELY (1):
+            Very unlikely.
+        UNLIKELY (2):
+            Unlikely.
+        POSSIBLE (3):
+            Possible.
+        LIKELY (4):
+            Likely.
+        VERY_LIKELY (5):
+            Very likely.
+    """
     LIKELIHOOD_UNSPECIFIED = 0
     VERY_UNLIKELY = 1
     UNLIKELY = 2

diff --git a/google/cloud/videointelligence_v1beta2/services/video_intelligence_service/client.py b/google/cloud/videointelligence_v1beta2/services/video_intelligence_service/client.py
@@ -557,7 +557,7 @@ def sample_annotate_video():
         # Done; return the response.
         return response
 
-    def __enter__(self):
+    def __enter__(self) -> "VideoIntelligenceServiceClient":
         return self
 
     def __exit__(self, type, value, traceback):

diff --git a/google/cloud/videointelligence_v1beta2/types/video_intelligence.py b/google/cloud/videointelligence_v1beta2/types/video_intelligence.py
@@ -52,7 +52,21 @@
 
 
 class Feature(proto.Enum):
-    r"""Video annotation feature."""
+    r"""Video annotation feature.
+
+    Values:
+        FEATURE_UNSPECIFIED (0):
+            Unspecified.
+        LABEL_DETECTION (1):
+            Label detection. Detect objects, such as dog
+            or flower.
+        SHOT_CHANGE_DETECTION (2):
+            Shot change detection.
+        EXPLICIT_CONTENT_DETECTION (3):
+            Explicit content detection.
+        FACE_DETECTION (4):
+            Human face detection and tracking.
+    """
     FEATURE_UNSPECIFIED = 0
     LABEL_DETECTION = 1
     SHOT_CHANGE_DETECTION = 2
@@ -61,15 +75,42 @@ class Feature(proto.Enum):
 
 
 class LabelDetectionMode(proto.Enum):
-    r"""Label detection mode."""
+    r"""Label detection mode.
+
+    Values:
+        LABEL_DETECTION_MODE_UNSPECIFIED (0):
+            Unspecified.
+        SHOT_MODE (1):
+            Detect shot-level labels.
+        FRAME_MODE (2):
+            Detect frame-level labels.
+        SHOT_AND_FRAME_MODE (3):
+            Detect both shot-level and frame-level
+            labels.
+    """
     LABEL_DETECTION_MODE_UNSPECIFIED = 0
     SHOT_MODE = 1
     FRAME_MODE = 2
     SHOT_AND_FRAME_MODE = 3
 
 
 class Likelihood(proto.Enum):
-    r"""Bucketized representation of likelihood."""
+    r"""Bucketized representation of likelihood.
+
+    Values:
+        LIKELIHOOD_UNSPECIFIED (0):
+            Unspecified likelihood.
+        VERY_UNLIKELY (1):
+            Very unlikely.
+        UNLIKELY (2):
+            Unlikely.
+        POSSIBLE (3):
+            Possible.
+        LIKELY (4):
+            Likely.
+        VERY_LIKELY (5):
+            Very likely.
+    """
     LIKELIHOOD_UNSPECIFIED = 0
     VERY_UNLIKELY = 1
     UNLIKELY = 2

diff --git a/google/cloud/videointelligence_v1p1beta1/services/video_intelligence_service/client.py b/google/cloud/videointelligence_v1p1beta1/services/video_intelligence_service/client.py
@@ -557,7 +557,7 @@ def sample_annotate_video():
         # Done; return the response.
         return response
 
-    def __enter__(self):
+    def __enter__(self) -> "VideoIntelligenceServiceClient":
         return self
 
     def __exit__(self, type, value, traceback):

diff --git a/google/cloud/videointelligence_v1p1beta1/types/video_intelligence.py b/google/cloud/videointelligence_v1p1beta1/types/video_intelligence.py
@@ -52,7 +52,21 @@
 
 
 class Feature(proto.Enum):
-    r"""Video annotation feature."""
+    r"""Video annotation feature.
+
+    Values:
+        FEATURE_UNSPECIFIED (0):
+            Unspecified.
+        LABEL_DETECTION (1):
+            Label detection. Detect objects, such as dog
+            or flower.
+        SHOT_CHANGE_DETECTION (2):
+            Shot change detection.
+        EXPLICIT_CONTENT_DETECTION (3):
+            Explicit content detection.
+        SPEECH_TRANSCRIPTION (6):
+            Speech transcription.
+    """
     FEATURE_UNSPECIFIED = 0
     LABEL_DETECTION = 1
     SHOT_CHANGE_DETECTION = 2
@@ -61,15 +75,42 @@ class Feature(proto.Enum):
 
 
 class LabelDetectionMode(proto.Enum):
-    r"""Label detection mode."""
+    r"""Label detection mode.
+
+    Values:
+        LABEL_DETECTION_MODE_UNSPECIFIED (0):
+            Unspecified.
+        SHOT_MODE (1):
+            Detect shot-level labels.
+        FRAME_MODE (2):
+            Detect frame-level labels.
+        SHOT_AND_FRAME_MODE (3):
+            Detect both shot-level and frame-level
+            labels.
+    """
     LABEL_DETECTION_MODE_UNSPECIFIED = 0
     SHOT_MODE = 1
     FRAME_MODE = 2
     SHOT_AND_FRAME_MODE = 3
 
 
 class Likelihood(proto.Enum):
-    r"""Bucketized representation of likelihood."""
+    r"""Bucketized representation of likelihood.
+
+    Values:
+        LIKELIHOOD_UNSPECIFIED (0):
+            Unspecified likelihood.
+        VERY_UNLIKELY (1):
+            Very unlikely.
+        UNLIKELY (2):
+            Unlikely.
+        POSSIBLE (3):
+            Possible.
+        LIKELY (4):
+            Likely.
+        VERY_LIKELY (5):
+            Very likely.
+    """
     LIKELIHOOD_UNSPECIFIED = 0
     VERY_UNLIKELY = 1
     UNLIKELY = 2

diff --git a/google/cloud/videointelligence_v1p2beta1/services/video_intelligence_service/client.py b/google/cloud/videointelligence_v1p2beta1/services/video_intelligence_service/client.py
@@ -557,7 +557,7 @@ def sample_annotate_video():
         # Done; return the response.
         return response
 
-    def __enter__(self):
+    def __enter__(self) -> "VideoIntelligenceServiceClient":
         return self
 
     def __exit__(self, type, value, traceback):

diff --git a/google/cloud/videointelligence_v1p2beta1/types/video_intelligence.py b/google/cloud/videointelligence_v1p2beta1/types/video_intelligence.py
@@ -56,7 +56,23 @@
 
 
 class Feature(proto.Enum):
-    r"""Video annotation feature."""
+    r"""Video annotation feature.
+
+    Values:
+        FEATURE_UNSPECIFIED (0):
+            Unspecified.
+        LABEL_DETECTION (1):
+            Label detection. Detect objects, such as dog
+            or flower.
+        SHOT_CHANGE_DETECTION (2):
+            Shot change detection.
+        EXPLICIT_CONTENT_DETECTION (3):
+            Explicit content detection.
+        TEXT_DETECTION (7):
+            OCR text detection and tracking.
+        OBJECT_TRACKING (9):
+            Object detection and tracking.
+    """
     FEATURE_UNSPECIFIED = 0
     LABEL_DETECTION = 1
     SHOT_CHANGE_DETECTION = 2
@@ -66,15 +82,42 @@ class Feature(proto.Enum):
 
 
 class LabelDetectionMode(proto.Enum):
-    r"""Label detection mode."""
+    r"""Label detection mode.
+
+    Values:
+        LABEL_DETECTION_MODE_UNSPECIFIED (0):
+            Unspecified.
+        SHOT_MODE (1):
+            Detect shot-level labels.
+        FRAME_MODE (2):
+            Detect frame-level labels.
+        SHOT_AND_FRAME_MODE (3):
+            Detect both shot-level and frame-level
+            labels.
+    """
     LABEL_DETECTION_MODE_UNSPECIFIED = 0
     SHOT_MODE = 1
     FRAME_MODE = 2
     SHOT_AND_FRAME_MODE = 3
 
 
 class Likelihood(proto.Enum):
-    r"""Bucketized representation of likelihood."""
+    r"""Bucketized representation of likelihood.
+
+    Values:
+        LIKELIHOOD_UNSPECIFIED (0):
+            Unspecified likelihood.
+        VERY_UNLIKELY (1):
+            Very unlikely.
+        UNLIKELY (2):
+            Unlikely.
+        POSSIBLE (3):
+            Possible.
+        LIKELY (4):
+            Likely.
+        VERY_LIKELY (5):
+            Very likely.
+    """
     LIKELIHOOD_UNSPECIFIED = 0
     VERY_UNLIKELY = 1
     UNLIKELY = 2

diff --git a/...cloud/videointelligence_v1p3beta1/services/streaming_video_intelligence_service/client.py b/...cloud/videointelligence_v1p3beta1/services/streaming_video_intelligence_service/client.py
@@ -522,7 +522,7 @@ def request_generator():
         # Done; return the response.
         return response
 
-    def __enter__(self):
+    def __enter__(self) -> "StreamingVideoIntelligenceServiceClient":
         return self
 
     def __exit__(self, type, value, traceback):

diff --git a/google/cloud/videointelligence_v1p3beta1/services/video_intelligence_service/client.py b/google/cloud/videointelligence_v1p3beta1/services/video_intelligence_service/client.py
@@ -557,7 +557,7 @@ def sample_annotate_video():
         # Done; return the response.
         return response
 
-    def __enter__(self):
+    def __enter__(self) -> "VideoIntelligenceServiceClient":
         return self
 
     def __exit__(self, type, value, traceback):