docs: Add documentation for enums (#124)

* 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 * restore rest support Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com> Co-authored-by: Anthonios Partheniou <partheniou@google.com>

Author: gcf-owl-bot[bot]

google/cloud/video/stitcher_v1/services/video_stitcher_service/client.py

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

google/cloud/video/stitcher_v1/types/companions.py

@@ -45,6 +45,18 @@ class CompanionAds(proto.Message):
  class DisplayRequirement(proto.Enum):
  r"""Indicates how many of the companions should be displayed with
  the ad.
+
+ Values:
+ DISPLAY_REQUIREMENT_UNSPECIFIED (0):
+ Required companions are not specified. The
+ default is ALL.
+ ALL (1):
+ All companions are required to be displayed.
+ ANY (2):
+ At least one of companions needs to be
+ displayed.
+ NONE (3):
+ All companions are optional for display.
  """
  DISPLAY_REQUIREMENT_UNSPECIFIED = 0
  ALL = 1

google/cloud/video/stitcher_v1/types/events.py

@@ -42,7 +42,60 @@ class Event(proto.Message):
  """
 
  class EventType(proto.Enum):
- r"""Describes the event that occurred."""
+ r"""Describes the event that occurred.
+
+ Values:
+ EVENT_TYPE_UNSPECIFIED (0):
+ The event type is unspecified.
+ CREATIVE_VIEW (1):
+ First frame of creative ad viewed.
+ START (2):
+ Creative ad started.
+ BREAK_START (3):
+ Start of an ad break.
+ BREAK_END (4):
+ End of an ad break.
+ IMPRESSION (5):
+ Impression.
+ FIRST_QUARTILE (6):
+ First quartile progress.
+ MIDPOINT (7):
+ Midpoint progress.
+ THIRD_QUARTILE (8):
+ Third quartile progress.
+ COMPLETE (9):
+ Ad progress completed.
+ PROGRESS (10):
+ Specific progress event with an offset.
+ MUTE (11):
+ Player muted.
+ UNMUTE (12):
+ Player unmuted.
+ PAUSE (13):
+ Player paused.
+ CLICK (14):
+ Click event.
+ CLICK_THROUGH (15):
+ Click-through event.
+ REWIND (16):
+ Player rewinding.
+ RESUME (17):
+ Player resumed.
+ ERROR (18):
+ Error event.
+ EXPAND (21):
+ Ad expanded to a larger size.
+ COLLAPSE (22):
+ Ad collapsed to a smaller size.
+ CLOSE (24):
+ Non-linear ad closed.
+ CLOSE_LINEAR (25):
+ Linear ad closed.
+ SKIP (26):
+ Ad skipped.
+ ACCEPT_INVITATION (27):
+ Accept invitation event.
+ """
  EVENT_TYPE_UNSPECIFIED = 0
  CREATIVE_VIEW = 1
  START = 2

google/cloud/video/stitcher_v1/types/sessions.py

@@ -305,6 +305,16 @@ class StitchingPolicy(proto.Enum):
  r"""Defines the stitcher behavior in case an ad does not align exactly
  with the ad break boundaries. If not specified, the default is
  COMPLETE_AD.
+
+ Values:
+ STITCHING_POLICY_UNSPECIFIED (0):
+ Stitching policy is not specified.
+ COMPLETE_AD (1):
+ Finishes stitching the current ad before
+ returning to content.
+ CUT_CURRENT (3):
+ Cuts an ad short and returns to content in
+ the middle of the ad.
  """
  STITCHING_POLICY_UNSPECIFIED = 0
  COMPLETE_AD = 1
@@ -390,7 +400,16 @@ class ManifestOptions(proto.Message):
  """
 
  class OrderPolicy(proto.Enum):
- r"""Defines the ordering policy during manifest generation."""
+ r"""Defines the ordering policy during manifest generation.
+
+ Values:
+ ORDER_POLICY_UNSPECIFIED (0):
+ Ordering policy is not specified.
+ ASCENDING (1):
+ Order by ascending.
+ DESCENDING (2):
+ Order by descending.
+ """
  ORDER_POLICY_UNSPECIFIED = 0
  ASCENDING = 1
  DESCENDING = 2

samples/generated_samples/snippet_metadata_google.cloud.video.stitcher.v1.json

@@ -8,7 +8,7 @@
  ],
  "language": "PYTHON",
  "name": "google-cloud-video-stitcher",
- "version": "0.6.0"
+ "version": "0.1.0"
  },
  "snippets": [
  {