yandexcloud 0.351.0__py3-none-any.whl → 0.352.0__py3-none-any.whl

yandex/cloud/video/v1/stream_line_service_pb2_grpc.pyi

@@ -20,134 +20,179 @@ class _ServicerContext(grpc.ServicerContext, grpc.aio.ServicerContext):  # type:
     ...
 
 class StreamLineServiceStub:
-    """Stream line management service."""
+    """Stream line management service.
+    Provides methods for creating, retrieving, updating, and deleting stream lines,
+    which define the technical configuration for receiving and processing video signals.
+    """
 
     def __init__(self, channel: typing.Union[grpc.Channel, grpc.aio.Channel]) -> None: ...
     Get: grpc.UnaryUnaryMultiCallable[
         yandex.cloud.video.v1.stream_line_service_pb2.GetStreamLineRequest,
         yandex.cloud.video.v1.stream_line_pb2.StreamLine,
     ]
-    """Get the specific stream line."""
+    """Retrieves detailed information about a specific stream line by its ID.
+    Returns all stream line metadata, configuration, and related information.
+    """
 
     List: grpc.UnaryUnaryMultiCallable[
         yandex.cloud.video.v1.stream_line_service_pb2.ListStreamLinesRequest,
         yandex.cloud.video.v1.stream_line_service_pb2.ListStreamLinesResponse,
     ]
-    """List lines for channel."""
+    """Lists all stream lines in a specific channel with pagination support.
+    Results can be filtered and sorted using the provided parameters.
+    """
 
     BatchGet: grpc.UnaryUnaryMultiCallable[
         yandex.cloud.video.v1.stream_line_service_pb2.BatchGetStreamLinesRequest,
         yandex.cloud.video.v1.stream_line_service_pb2.BatchGetStreamLinesResponse,
     ]
-    """Batch get lines for channel."""
+    """Retrieves multiple stream lines by their IDs in a specific channel in a single request.
+    This is more efficient than making multiple Get requests when retrieving several stream lines.
+    """
 
     Create: grpc.UnaryUnaryMultiCallable[
         yandex.cloud.video.v1.stream_line_service_pb2.CreateStreamLineRequest,
         yandex.cloud.operation.operation_pb2.Operation,
     ]
-    """Create stream line."""
+    """Creates a new stream line in the specified channel with the provided configuration.
+    Stream lines define the technical settings for receiving and processing video signals.
+    """
 
     Update: grpc.UnaryUnaryMultiCallable[
         yandex.cloud.video.v1.stream_line_service_pb2.UpdateStreamLineRequest,
         yandex.cloud.operation.operation_pb2.Operation,
     ]
-    """Update stream line."""
+    """Updates an existing stream line's metadata and configuration.
+    Only fields specified in the field_mask will be updated.
+    """
 
     Delete: grpc.UnaryUnaryMultiCallable[
         yandex.cloud.video.v1.stream_line_service_pb2.DeleteStreamLineRequest,
         yandex.cloud.operation.operation_pb2.Operation,
     ]
-    """Delete stream line."""
+    """Deletes a specific stream line by its ID."""
 
     BatchDelete: grpc.UnaryUnaryMultiCallable[
         yandex.cloud.video.v1.stream_line_service_pb2.BatchDeleteStreamLinesRequest,
         yandex.cloud.operation.operation_pb2.Operation,
     ]
-    """Batch delete stream lines."""
+    """Deletes multiple stream lines in a specific channel in a single request.
+    This is more efficient than making multiple Delete requests when removing several stream lines.
+    """
 
     PerformAction: grpc.UnaryUnaryMultiCallable[
         yandex.cloud.video.v1.stream_line_service_pb2.PerformLineActionRequest,
         yandex.cloud.operation.operation_pb2.Operation,
     ]
-    """Perform an action on the line."""
+    """Performs a specific action on a stream line, such as activation or deactivation.
+    Actions change the stream line's state without modifying its configuration.
+    """
 
     GetStreamKey: grpc.UnaryUnaryMultiCallable[
         yandex.cloud.video.v1.stream_line_service_pb2.GetStreamKeyRequest,
         yandex.cloud.video.v1.stream_line_pb2.PushStreamKey,
     ]
-    """Get unique stream key."""
+    """Retrieves the unique stream key for a push-type stream line.
+    This key is used to authenticate when pushing video streams to the platform.
+    """
 
     UpdateStreamKey: grpc.UnaryUnaryMultiCallable[
         yandex.cloud.video.v1.stream_line_service_pb2.UpdateStreamKeyRequest,
         yandex.cloud.operation.operation_pb2.Operation,
     ]
-    """Update stream key."""
+    """Regenerates and updates the stream key for a push-type stream line.
+    This is useful for security purposes when the existing key may be compromised.
+    """
 
 class StreamLineServiceAsyncStub:
-    """Stream line management service."""
+    """Stream line management service.
+    Provides methods for creating, retrieving, updating, and deleting stream lines,
+    which define the technical configuration for receiving and processing video signals.
+    """
 
     Get: grpc.aio.UnaryUnaryMultiCallable[
         yandex.cloud.video.v1.stream_line_service_pb2.GetStreamLineRequest,
         yandex.cloud.video.v1.stream_line_pb2.StreamLine,
     ]
-    """Get the specific stream line."""
+    """Retrieves detailed information about a specific stream line by its ID.
+    Returns all stream line metadata, configuration, and related information.
+    """
 
     List: grpc.aio.UnaryUnaryMultiCallable[
         yandex.cloud.video.v1.stream_line_service_pb2.ListStreamLinesRequest,
         yandex.cloud.video.v1.stream_line_service_pb2.ListStreamLinesResponse,
     ]
-    """List lines for channel."""
+    """Lists all stream lines in a specific channel with pagination support.
+    Results can be filtered and sorted using the provided parameters.
+    """
 
     BatchGet: grpc.aio.UnaryUnaryMultiCallable[
         yandex.cloud.video.v1.stream_line_service_pb2.BatchGetStreamLinesRequest,
         yandex.cloud.video.v1.stream_line_service_pb2.BatchGetStreamLinesResponse,
     ]
-    """Batch get lines for channel."""
+    """Retrieves multiple stream lines by their IDs in a specific channel in a single request.
+    This is more efficient than making multiple Get requests when retrieving several stream lines.
+    """
 
     Create: grpc.aio.UnaryUnaryMultiCallable[
         yandex.cloud.video.v1.stream_line_service_pb2.CreateStreamLineRequest,
         yandex.cloud.operation.operation_pb2.Operation,
     ]
-    """Create stream line."""
+    """Creates a new stream line in the specified channel with the provided configuration.
+    Stream lines define the technical settings for receiving and processing video signals.
+    """
 
     Update: grpc.aio.UnaryUnaryMultiCallable[
         yandex.cloud.video.v1.stream_line_service_pb2.UpdateStreamLineRequest,
         yandex.cloud.operation.operation_pb2.Operation,
     ]
-    """Update stream line."""
+    """Updates an existing stream line's metadata and configuration.
+    Only fields specified in the field_mask will be updated.
+    """
 
     Delete: grpc.aio.UnaryUnaryMultiCallable[
         yandex.cloud.video.v1.stream_line_service_pb2.DeleteStreamLineRequest,
         yandex.cloud.operation.operation_pb2.Operation,
     ]
-    """Delete stream line."""
+    """Deletes a specific stream line by its ID."""
 
     BatchDelete: grpc.aio.UnaryUnaryMultiCallable[
         yandex.cloud.video.v1.stream_line_service_pb2.BatchDeleteStreamLinesRequest,
         yandex.cloud.operation.operation_pb2.Operation,
     ]
-    """Batch delete stream lines."""
+    """Deletes multiple stream lines in a specific channel in a single request.
+    This is more efficient than making multiple Delete requests when removing several stream lines.
+    """
 
     PerformAction: grpc.aio.UnaryUnaryMultiCallable[
         yandex.cloud.video.v1.stream_line_service_pb2.PerformLineActionRequest,
         yandex.cloud.operation.operation_pb2.Operation,
     ]
-    """Perform an action on the line."""
+    """Performs a specific action on a stream line, such as activation or deactivation.
+    Actions change the stream line's state without modifying its configuration.
+    """
 
     GetStreamKey: grpc.aio.UnaryUnaryMultiCallable[
         yandex.cloud.video.v1.stream_line_service_pb2.GetStreamKeyRequest,
         yandex.cloud.video.v1.stream_line_pb2.PushStreamKey,
     ]
-    """Get unique stream key."""
+    """Retrieves the unique stream key for a push-type stream line.
+    This key is used to authenticate when pushing video streams to the platform.
+    """
 
     UpdateStreamKey: grpc.aio.UnaryUnaryMultiCallable[
         yandex.cloud.video.v1.stream_line_service_pb2.UpdateStreamKeyRequest,
         yandex.cloud.operation.operation_pb2.Operation,
     ]
-    """Update stream key."""
+    """Regenerates and updates the stream key for a push-type stream line.
+    This is useful for security purposes when the existing key may be compromised.
+    """
 
 class StreamLineServiceServicer(metaclass=abc.ABCMeta):
-    """Stream line management service."""
+    """Stream line management service.
+    Provides methods for creating, retrieving, updating, and deleting stream lines,
+    which define the technical configuration for receiving and processing video signals.
+    """
 
     @abc.abstractmethod
     def Get(
@@ -155,7 +200,9 @@ class StreamLineServiceServicer(metaclass=abc.ABCMeta):
         request: yandex.cloud.video.v1.stream_line_service_pb2.GetStreamLineRequest,
         context: _ServicerContext,
     ) -> typing.Union[yandex.cloud.video.v1.stream_line_pb2.StreamLine, collections.abc.Awaitable[yandex.cloud.video.v1.stream_line_pb2.StreamLine]]:
-        """Get the specific stream line."""
+        """Retrieves detailed information about a specific stream line by its ID.
+        Returns all stream line metadata, configuration, and related information.
+        """
 
     @abc.abstractmethod
     def List(
@@ -163,7 +210,9 @@ class StreamLineServiceServicer(metaclass=abc.ABCMeta):
         request: yandex.cloud.video.v1.stream_line_service_pb2.ListStreamLinesRequest,
         context: _ServicerContext,
     ) -> typing.Union[yandex.cloud.video.v1.stream_line_service_pb2.ListStreamLinesResponse, collections.abc.Awaitable[yandex.cloud.video.v1.stream_line_service_pb2.ListStreamLinesResponse]]:
-        """List lines for channel."""
+        """Lists all stream lines in a specific channel with pagination support.
+        Results can be filtered and sorted using the provided parameters.
+        """
 
     @abc.abstractmethod
     def BatchGet(
@@ -171,7 +220,9 @@ class StreamLineServiceServicer(metaclass=abc.ABCMeta):
         request: yandex.cloud.video.v1.stream_line_service_pb2.BatchGetStreamLinesRequest,
         context: _ServicerContext,
     ) -> typing.Union[yandex.cloud.video.v1.stream_line_service_pb2.BatchGetStreamLinesResponse, collections.abc.Awaitable[yandex.cloud.video.v1.stream_line_service_pb2.BatchGetStreamLinesResponse]]:
-        """Batch get lines for channel."""
+        """Retrieves multiple stream lines by their IDs in a specific channel in a single request.
+        This is more efficient than making multiple Get requests when retrieving several stream lines.
+        """
 
     @abc.abstractmethod
     def Create(
@@ -179,7 +230,9 @@ class StreamLineServiceServicer(metaclass=abc.ABCMeta):
         request: yandex.cloud.video.v1.stream_line_service_pb2.CreateStreamLineRequest,
         context: _ServicerContext,
     ) -> typing.Union[yandex.cloud.operation.operation_pb2.Operation, collections.abc.Awaitable[yandex.cloud.operation.operation_pb2.Operation]]:
-        """Create stream line."""
+        """Creates a new stream line in the specified channel with the provided configuration.
+        Stream lines define the technical settings for receiving and processing video signals.
+        """
 
     @abc.abstractmethod
     def Update(
@@ -187,7 +240,9 @@ class StreamLineServiceServicer(metaclass=abc.ABCMeta):
         request: yandex.cloud.video.v1.stream_line_service_pb2.UpdateStreamLineRequest,
         context: _ServicerContext,
     ) -> typing.Union[yandex.cloud.operation.operation_pb2.Operation, collections.abc.Awaitable[yandex.cloud.operation.operation_pb2.Operation]]:
-        """Update stream line."""
+        """Updates an existing stream line's metadata and configuration.
+        Only fields specified in the field_mask will be updated.
+        """
 
     @abc.abstractmethod
     def Delete(
@@ -195,7 +250,7 @@ class StreamLineServiceServicer(metaclass=abc.ABCMeta):
         request: yandex.cloud.video.v1.stream_line_service_pb2.DeleteStreamLineRequest,
         context: _ServicerContext,
     ) -> typing.Union[yandex.cloud.operation.operation_pb2.Operation, collections.abc.Awaitable[yandex.cloud.operation.operation_pb2.Operation]]:
-        """Delete stream line."""
+        """Deletes a specific stream line by its ID."""
 
     @abc.abstractmethod
     def BatchDelete(
@@ -203,7 +258,9 @@ class StreamLineServiceServicer(metaclass=abc.ABCMeta):
         request: yandex.cloud.video.v1.stream_line_service_pb2.BatchDeleteStreamLinesRequest,
         context: _ServicerContext,
     ) -> typing.Union[yandex.cloud.operation.operation_pb2.Operation, collections.abc.Awaitable[yandex.cloud.operation.operation_pb2.Operation]]:
-        """Batch delete stream lines."""
+        """Deletes multiple stream lines in a specific channel in a single request.
+        This is more efficient than making multiple Delete requests when removing several stream lines.
+        """
 
     @abc.abstractmethod
     def PerformAction(
@@ -211,7 +268,9 @@ class StreamLineServiceServicer(metaclass=abc.ABCMeta):
         request: yandex.cloud.video.v1.stream_line_service_pb2.PerformLineActionRequest,
         context: _ServicerContext,
     ) -> typing.Union[yandex.cloud.operation.operation_pb2.Operation, collections.abc.Awaitable[yandex.cloud.operation.operation_pb2.Operation]]:
-        """Perform an action on the line."""
+        """Performs a specific action on a stream line, such as activation or deactivation.
+        Actions change the stream line's state without modifying its configuration.
+        """
 
     @abc.abstractmethod
     def GetStreamKey(
@@ -219,7 +278,9 @@ class StreamLineServiceServicer(metaclass=abc.ABCMeta):
         request: yandex.cloud.video.v1.stream_line_service_pb2.GetStreamKeyRequest,
         context: _ServicerContext,
     ) -> typing.Union[yandex.cloud.video.v1.stream_line_pb2.PushStreamKey, collections.abc.Awaitable[yandex.cloud.video.v1.stream_line_pb2.PushStreamKey]]:
-        """Get unique stream key."""
+        """Retrieves the unique stream key for a push-type stream line.
+        This key is used to authenticate when pushing video streams to the platform.
+        """
 
     @abc.abstractmethod
     def UpdateStreamKey(
@@ -227,6 +288,8 @@ class StreamLineServiceServicer(metaclass=abc.ABCMeta):
         request: yandex.cloud.video.v1.stream_line_service_pb2.UpdateStreamKeyRequest,
         context: _ServicerContext,
     ) -> typing.Union[yandex.cloud.operation.operation_pb2.Operation, collections.abc.Awaitable[yandex.cloud.operation.operation_pb2.Operation]]:
-        """Update stream key."""
+        """Regenerates and updates the stream key for a push-type stream line.
+        This is useful for security purposes when the existing key may be compromised.
+        """
 
 def add_StreamLineServiceServicer_to_server(servicer: StreamLineServiceServicer, server: typing.Union[grpc.Server, grpc.aio.Server]) -> None: ...

yandex/cloud/video/v1/stream_pb2.pyi

@@ -23,6 +23,10 @@ DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
 
 @typing.final
 class Stream(google.protobuf.message.Message):
+    """Entity representing a live video stream.
+    A stream is a real-time video broadcast linked to a specific stream line.
+    """
+
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
 
     class _StreamStatus:
@@ -32,33 +36,33 @@ class Stream(google.protobuf.message.Message):
     class _StreamStatusEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[Stream._StreamStatus.ValueType], builtins.type):
         DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
         STREAM_STATUS_UNSPECIFIED: Stream._StreamStatus.ValueType  # 0
-        """Stream status unspecified."""
+        """The stream status is not specified."""
         OFFLINE: Stream._StreamStatus.ValueType  # 1
-        """Stream offline."""
+        """The stream is offline and not broadcasting."""
         PREPARING: Stream._StreamStatus.ValueType  # 2
-        """Preparing the infrastructure for receiving video signal."""
+        """The system is preparing the infrastructure for receiving the video signal."""
         READY: Stream._StreamStatus.ValueType  # 3
-        """Everything is ready to launch stream."""
+        """The infrastructure is ready to launch the stream."""
         ONAIR: Stream._StreamStatus.ValueType  # 4
-        """Stream onair."""
+        """The stream is currently broadcasting live."""
         FINISHED: Stream._StreamStatus.ValueType  # 5
-        """Stream finished."""
+        """The stream has completed and is no longer broadcasting."""
 
     class StreamStatus(_StreamStatus, metaclass=_StreamStatusEnumTypeWrapper):
-        """Stream status."""
+        """Current status of the stream."""
 
     STREAM_STATUS_UNSPECIFIED: Stream.StreamStatus.ValueType  # 0
-    """Stream status unspecified."""
+    """The stream status is not specified."""
     OFFLINE: Stream.StreamStatus.ValueType  # 1
-    """Stream offline."""
+    """The stream is offline and not broadcasting."""
     PREPARING: Stream.StreamStatus.ValueType  # 2
-    """Preparing the infrastructure for receiving video signal."""
+    """The system is preparing the infrastructure for receiving the video signal."""
     READY: Stream.StreamStatus.ValueType  # 3
-    """Everything is ready to launch stream."""
+    """The infrastructure is ready to launch the stream."""
     ONAIR: Stream.StreamStatus.ValueType  # 4
-    """Stream onair."""
+    """The stream is currently broadcasting live."""
     FINISHED: Stream.StreamStatus.ValueType  # 5
-    """Stream finished."""
+    """The stream has completed and is no longer broadcasting."""
 
     @typing.final
     class LabelsEntry(google.protobuf.message.Message):
@@ -93,56 +97,60 @@ class Stream(google.protobuf.message.Message):
     UPDATED_AT_FIELD_NUMBER: builtins.int
     LABELS_FIELD_NUMBER: builtins.int
     id: builtins.str
-    """ID of the stream."""
+    """Unique identifier of the stream."""
     channel_id: builtins.str
-    """ID of the channel where the stream was created."""
+    """Identifier of the channel where the stream is created and managed."""
     line_id: builtins.str
-    """ID of the line to which stream is linked."""
+    """Identifier of the stream line to which this stream is linked."""
     title: builtins.str
-    """Stream title."""
+    """Title of the stream displayed in interfaces and players."""
     description: builtins.str
-    """Stream description."""
+    """Detailed description of the stream content and context."""
     thumbnail_id: builtins.str
-    """ID of the thumbnail."""
+    """Identifier of the thumbnail image used to represent the stream visually."""
     status: global___Stream.StreamStatus.ValueType
-    """Stream status."""
+    """Current status of the stream."""
     @property
     def start_time(self) -> google.protobuf.timestamp_pb2.Timestamp:
-        """Stream start time."""
+        """Timestamp when the stream was initiated."""
 
     @property
     def publish_time(self) -> google.protobuf.timestamp_pb2.Timestamp:
-        """Stream publish time. Time when stream switched to ONAIR status."""
+        """Timestamp when the stream was published (switched to ONAIR status)."""
 
     @property
     def finish_time(self) -> google.protobuf.timestamp_pb2.Timestamp:
-        """Stream finish time."""
+        """Timestamp when the stream was completed."""
 
     @property
     def auto_publish(self) -> google.protobuf.wrappers_pb2.BoolValue:
-        """Automatically publish stream when ready.
-        Switches status from READY to ONAIR.
+        """Controls automatic publishing of the stream when it's ready.
+        When set to true, automatically switches status from READY to ONAIR.
         """
 
     @property
     def on_demand(self) -> global___OnDemand:
-        """On-demand stream. Starts immediately when a signal appears."""
+        """On-demand stream starts immediately when a video signal appears."""
 
     @property
     def schedule(self) -> global___Schedule:
-        """Schedule stream. Starts or finished at the specified time."""
+        """Scheduled stream starts and finishes at specified time."""
 
     @property
     def created_at(self) -> google.protobuf.timestamp_pb2.Timestamp:
-        """Time when stream was created."""
+        """Timestamp when the stream was initially created in the system."""
 
     @property
     def updated_at(self) -> google.protobuf.timestamp_pb2.Timestamp:
-        """Time of last stream update."""
+        """Timestamp of the last modification to the stream or its metadata."""
 
     @property
     def labels(self) -> google.protobuf.internal.containers.ScalarMap[builtins.str, builtins.str]:
-        """Custom labels as `` key:value `` pairs. Maximum 64 per resource."""
+        """Custom user-defined labels as `key:value` pairs.
+        Maximum 64 labels per stream.
+        Used for organization, filtering, and metadata purposes.
+        Labels can be used for organization, filtering, and metadata purposes.
+        """
 
     def __init__(
         self,
@@ -172,8 +180,9 @@ global___Stream = Stream
 
 @typing.final
 class OnDemand(google.protobuf.message.Message):
-    """On-demand stream type.
-    This type of streams should be started and finished explicitly.
+    """Represents an on-demand stream type.
+    This type of stream must be started and finished explicitly by the user.
+    It begins broadcasting immediately when a video signal is detected.
     """
 
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
@@ -186,8 +195,8 @@ global___OnDemand = OnDemand
 
 @typing.final
 class Schedule(google.protobuf.message.Message):
-    """Schedule stream type.
-    This type of streams start and finish automatically at the specified time.
+    """Represents a scheduled stream type.
+    This type of stream starts and finishes automatically at specified time.
     """
 
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
@@ -195,9 +204,13 @@ class Schedule(google.protobuf.message.Message):
     START_TIME_FIELD_NUMBER: builtins.int
     FINISH_TIME_FIELD_NUMBER: builtins.int
     @property
-    def start_time(self) -> google.protobuf.timestamp_pb2.Timestamp: ...
+    def start_time(self) -> google.protobuf.timestamp_pb2.Timestamp:
+        """Scheduled time when the stream should automatically start."""
+
     @property
-    def finish_time(self) -> google.protobuf.timestamp_pb2.Timestamp: ...
+    def finish_time(self) -> google.protobuf.timestamp_pb2.Timestamp:
+        """Scheduled time when the stream should automatically finish."""
+
     def __init__(
         self,
         *,