Skip to content

Commit 3bfdfc0

Browse files
docs: Add documentation for enums (#137)
* 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: googleapis/googleapis-gen@0080f83 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>
1 parent 5730938 commit 3bfdfc0

File tree

4 files changed

+106
-7
lines changed

4 files changed

+106
-7
lines changed

packages/google-cloud-video-live-stream/google/cloud/video/live_stream_v1/services/livestream_service/client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2437,7 +2437,7 @@ def sample_delete_event():
24372437
metadata=metadata,
24382438
)
24392439

2440-
def __enter__(self):
2440+
def __enter__(self) -> "LivestreamServiceClient":
24412441
return self
24422442

24432443
def __exit__(self, type, value, traceback):

packages/google-cloud-video-live-stream/google/cloud/video/live_stream_v1/types/outputs.py

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,18 @@ class Manifest(proto.Message):
172172
"""
173173

174174
class ManifestType(proto.Enum):
175-
r"""The manifest type can be either ``HLS`` or ``DASH``."""
175+
r"""The manifest type can be either ``HLS`` or ``DASH``.
176+
177+
Values:
178+
MANIFEST_TYPE_UNSPECIFIED (0):
179+
The manifest type is not specified.
180+
HLS (1):
181+
Create an ``HLS`` manifest. The corresponding file extension
182+
is ``.m3u8``.
183+
DASH (2):
184+
Create a ``DASH`` manifest. The corresponding file extension
185+
is ``.mpd``.
186+
"""
176187
MANIFEST_TYPE_UNSPECIFIED = 0
177188
HLS = 1
178189
DASH = 2

packages/google-cloud-video-live-stream/google/cloud/video/live_stream_v1/types/resources.py

Lines changed: 92 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,13 +80,36 @@ class Input(proto.Message):
8080
"""
8181

8282
class Type(proto.Enum):
83-
r"""The type of the input."""
83+
r"""The type of the input.
84+
85+
Values:
86+
TYPE_UNSPECIFIED (0):
87+
Input type is not specified.
88+
RTMP_PUSH (1):
89+
Input will take an rtmp input stream.
90+
SRT_PUSH (2):
91+
Input will take an srt (Secure Reliable
92+
Transport) input stream.
93+
"""
8494
TYPE_UNSPECIFIED = 0
8595
RTMP_PUSH = 1
8696
SRT_PUSH = 2
8797

8898
class Tier(proto.Enum):
89-
r"""Tier of the input specification."""
99+
r"""Tier of the input specification.
100+
101+
Values:
102+
TIER_UNSPECIFIED (0):
103+
Tier is not specified.
104+
SD (1):
105+
Resolution < 1280x720. Bitrate <= 6 Mbps. FPS
106+
<= 60.
107+
HD (2):
108+
Resolution <= 1920x1080. Bitrate <= 25 Mbps.
109+
FPS <= 60.
110+
UHD (3):
111+
Resolution <= 4096x2160. Not supported yet.
112+
"""
90113
TIER_UNSPECIFIED = 0
91114
SD = 1
92115
HD = 2
@@ -217,7 +240,35 @@ class Channel(proto.Message):
217240
"""
218241

219242
class StreamingState(proto.Enum):
220-
r"""State of streaming operation that the channel is running."""
243+
r"""State of streaming operation that the channel is running.
244+
245+
Values:
246+
STREAMING_STATE_UNSPECIFIED (0):
247+
Streaming state is not specified.
248+
STREAMING (1):
249+
Channel is getting the input stream,
250+
generating the live streams to the specified
251+
output location.
252+
AWAITING_INPUT (2):
253+
Channel is waiting for the input stream
254+
through the input.
255+
STREAMING_ERROR (4):
256+
Channel is running, but has trouble
257+
publishing the live streams onto the specified
258+
output location (for example, the specified
259+
Cloud Storage bucket is not writable).
260+
STREAMING_NO_INPUT (5):
261+
Channel is generating live streams with no
262+
input stream. Live streams are filled out with
263+
black screen, while input stream is missing. Not
264+
supported yet.
265+
STOPPED (6):
266+
Channel is stopped, finishing live streams.
267+
STARTING (7):
268+
Channel is starting.
269+
STOPPING (8):
270+
Channel is stopping.
271+
"""
221272
STREAMING_STATE_UNSPECIFIED = 0
222273
STREAMING = 1
223274
AWAITING_INPUT = 2
@@ -331,6 +382,25 @@ class LogSeverity(proto.Enum):
331382
< NOTICE < WARNING < ERROR < CRITICAL < ALERT < EMERGENCY. See
332383
`LogSeverity <https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#logseverity>`__
333384
for more information.
385+
386+
Values:
387+
LOG_SEVERITY_UNSPECIFIED (0):
388+
Log severity is not specified. This is the
389+
same as log severity is OFF.
390+
OFF (1):
391+
Log is turned off.
392+
DEBUG (100):
393+
Log with severity higher than or equal to
394+
DEBUG are logged.
395+
INFO (200):
396+
Logs with severity higher than or equal to
397+
INFO are logged.
398+
WARNING (400):
399+
Logs with severity higher than or equal to
400+
WARNING are logged.
401+
ERROR (500):
402+
Logs with severity higher than or equal to
403+
ERROR are logged.
334404
"""
335405
LOG_SEVERITY_UNSPECIFIED = 0
336406
OFF = 1
@@ -566,7 +636,25 @@ class Event(proto.Message):
566636
"""
567637

568638
class State(proto.Enum):
569-
r"""State of the event"""
639+
r"""State of the event
640+
641+
Values:
642+
STATE_UNSPECIFIED (0):
643+
Event state is not specified.
644+
SCHEDULED (1):
645+
Event is scheduled but not executed yet.
646+
RUNNING (2):
647+
Event is being executed.
648+
SUCCEEDED (3):
649+
Event has been successfully executed.
650+
FAILED (4):
651+
Event fails to be executed.
652+
PENDING (5):
653+
Event has been created but not scheduled yet.
654+
STOPPED (6):
655+
Event was stopped before running for its full
656+
duration.
657+
"""
570658
STATE_UNSPECIFIED = 0
571659
SCHEDULED = 1
572660
RUNNING = 2

packages/google-cloud-video-live-stream/samples/generated_samples/snippet_metadata_google.cloud.video.livestream.v1.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
],
99
"language": "PYTHON",
1010
"name": "google-cloud-video-live-stream",
11-
"version": "1.2.0"
11+
"version": "0.1.0"
1212
},
1313
"snippets": [
1414
{

0 commit comments

Comments
 (0)