Skip to content
This repository was archived by the owner on Sep 21, 2023. It is now read-only.

docs: Add documentation for enums #271

Merged
merged 2 commits into from
Jan 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -1325,7 +1325,7 @@ def sample_delete_job_template():
metadata=metadata,
)

def __enter__(self):
def __enter__(self) -> "TranscoderServiceClient":
return self

def __exit__(self, type, value, traceback):
Expand Down
41 changes: 38 additions & 3 deletions google/cloud/video/transcoder_v1/types/resources.py
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,22 @@ class Job(proto.Message):
"""

class ProcessingState(proto.Enum):
r"""The current state of the job."""
r"""The current state of the job.

Values:
PROCESSING_STATE_UNSPECIFIED (0):
The processing state is not specified.
PENDING (1):
The job is enqueued and will be picked up for
processing soon.
RUNNING (2):
The job is being processed.
SUCCEEDED (3):
The job has been completed successfully.
FAILED (4):
The job has failed. For additional information, see
``failure_reason`` and ``failure_details``
"""
PROCESSING_STATE_UNSPECIFIED = 0
PENDING = 1
RUNNING = 2
Expand Down Expand Up @@ -536,7 +551,18 @@ class Manifest(proto.Message):
"""

class ManifestType(proto.Enum):
r"""The manifest type can be either ``HLS`` or ``DASH``."""
r"""The manifest type can be either ``HLS`` or ``DASH``.

Values:
MANIFEST_TYPE_UNSPECIFIED (0):
The manifest type is not specified.
HLS (1):
Create ``HLS`` manifest. The corresponding file extension is
``.m3u8``.
DASH (2):
Create ``DASH`` manifest. The corresponding file extension
is ``.mpd``.
"""
MANIFEST_TYPE_UNSPECIFIED = 0
HLS = 1
DASH = 2
Expand Down Expand Up @@ -723,7 +749,16 @@ class Overlay(proto.Message):
"""

class FadeType(proto.Enum):
r"""Fade type for the overlay: ``FADE_IN`` or ``FADE_OUT``."""
r"""Fade type for the overlay: ``FADE_IN`` or ``FADE_OUT``.

Values:
FADE_TYPE_UNSPECIFIED (0):
The fade type is not specified.
FADE_IN (1):
Fade the overlay object into view.
FADE_OUT (2):
Fade the overlay object out of view.
"""
FADE_TYPE_UNSPECIFIED = 0
FADE_IN = 1
FADE_OUT = 2
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
],
"language": "PYTHON",
"name": "google-cloud-video-transcoder",
"version": "1.6.0"
"version": "0.1.0"
},
"snippets": [
{
Expand Down