google-cloud-video-live_stream-v1 2.1.0 → 2.2.0

data/proto_docs/google/cloud/video/livestream/v1/resources.rb

@@ -672,7 +672,7 @@ module Google
           # @!attribute [rw] name
           #   @return [::String]
           #     The resource name of the clip, in the following format:
-          #     `projects/{project}/locations/{location}/channels/{c}/clips/{clipId}`.
+          #     `projects/{project}/locations/{location}/channels/{channelId}/clips/{clipId}`.
           #     `{clipId}` is a user-specified resource id that conforms to the following
           #     criteria:
           #
@@ -714,6 +714,10 @@ module Google
           #   @return [::Array<::Google::Cloud::Video::LiveStream::V1::Clip::ClipManifest>]
           #     Required. A list of clip manifests. Currently only one clip manifest is
           #     allowed.
+          # @!attribute [rw] output_type
+          #   @return [::Google::Cloud::Video::LiveStream::V1::Clip::OutputType]
+          #     Optional. OutputType of the clip. If not specified, the default value is
+          #     MANIFEST.
           class Clip
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -788,6 +792,153 @@ module Google
               # field.
               FAILED = 4
             end
+
+            # OutputType represents the output type of the clip.
+            module OutputType
+              # OutputType is not specified.
+              OUTPUT_TYPE_UNSPECIFIED = 0
+
+              # OutputType is a VOD manifest. This is the default value.
+              MANIFEST = 1
+
+              # OutputType is an MP4 file.
+              MP4 = 2
+            end
+          end
+
+          # TimeInterval represents a time interval.
+          # @!attribute [rw] start_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Optional. The start time of the interval.
+          # @!attribute [rw] end_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Optional. The end time of the interval.
+          class TimeInterval
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # DvrSession is a sub-resource under channel. Each DvrSession represents a DVR
+          # recording of the live stream for a specific time range.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Identifier. The resource name of the DVR session, in the following format:
+          #     `projects/{project}/locations/{location}/channels/{channelId}/dvrSessions/{dvrSessionId}`.
+          #     `{dvrSessionId}` is a user-specified resource id that conforms to the
+          #     following criteria:
+          #
+          #     1. 1 character minimum, 63 characters maximum
+          #     2. Only contains letters, digits, underscores, and hyphens
+          # @!attribute [r] create_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Output only. The creation time.
+          # @!attribute [r] update_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Output only. The update time.
+          # @!attribute [rw] labels
+          #   @return [::Google::Protobuf::Map{::String => ::String}]
+          #     Optional. User-defined key/value metadata.
+          # @!attribute [r] state
+          #   @return [::Google::Cloud::Video::LiveStream::V1::DvrSession::State]
+          #     Output only. The state of the clip.
+          # @!attribute [r] error
+          #   @return [::Google::Rpc::Status]
+          #     Output only. An error object that describes the reason for the failure.
+          #     This property only presents when `state` is `FAILED`.
+          # @!attribute [rw] dvr_manifests
+          #   @return [::Array<::Google::Cloud::Video::LiveStream::V1::DvrSession::DvrManifest>]
+          #     Required. A list of DVR manifests. Currently only one DVR manifest is
+          #     allowed.
+          # @!attribute [rw] dvr_windows
+          #   @return [::Array<::Google::Cloud::Video::LiveStream::V1::DvrSession::DvrWindow>]
+          #     Required. The specified ranges of segments to generate a DVR recording.
+          class DvrSession
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # DvrManifest identifies a source manifest and specifies a file name for the
+            # generated DVR manifest.
+            # @!attribute [rw] manifest_key
+            #   @return [::String]
+            #     Required. A unique key that identifies a manifest config in the parent
+            #     channel. This key is the same as `channel.manifests.key` for the selected
+            #     manifest.
+            # @!attribute [r] output_uri
+            #   @return [::String]
+            #     Output only. The output URI of the DVR manifest. The DVR output will be
+            #     placed in a directory named `dvr/dvrSessionId/` under the parent
+            #     channel's output uri. Format:
+            #     \\{channel.output.uri}/dvr/\\{dvrSessionId}/\\{channel.manifests.fileName}
+            #     Example: gs://my-bucket/outputs/dvr/my-dvr-session/main.m3u8
+            class DvrManifest
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # DvrWindow represents a DVR window.
+            # @!attribute [rw] time_interval
+            #   @return [::Google::Cloud::Video::LiveStream::V1::TimeInterval]
+            #     A time interval in the form of a tuple of Unix epoch time.
+            class DvrWindow
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # @!attribute [rw] key
+            #   @return [::String]
+            # @!attribute [rw] value
+            #   @return [::String]
+            class LabelsEntry
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+
+            # State of the DVR session.
+            module State
+              # State is not specified.
+              STATE_UNSPECIFIED = 0
+
+              # The operation is pending to be picked up by the server.
+              PENDING = 1
+
+              # The session is being updated.
+              UPDATING = 2
+
+              # The session is scheduled and waiting for the start time.
+              SCHEDULED = 3
+
+              # The session is currently in progress and the outputs are available in the
+              # specified Cloud Storage bucket. For additional information, see the
+              # `dvr_manifests.output_uri` field.
+              LIVE = 4
+
+              # Outputs are available in the specified Cloud Storage bucket. For
+              # additional information, see the `dvr_manifests.output_uri` field.
+              FINISHED = 5
+
+              # The operation has failed. For additional information, see the `error`
+              # field.
+              FAILED = 6
+
+              # The session is being deleted.
+              DELETING = 7
+
+              # The session is being post processed.
+              POST_PROCESSING = 8
+
+              # The session is in cooldown. The cooldown period lasts for 60 seconds.
+              # When the DVR session is updated by the user to have a new end time that
+              # is likely already in the past, the DVR manifest will end as soon as
+              # possible and the DVR session will move to this state. This is done to
+              # prevent the players to receive a manifest update that removes a segment
+              # that has already been played. After the cooldown period ends, a new
+              # manifest is generated that honors the new end time.
+              COOLDOWN = 9
+
+              # The session is being stopped. The session will move to STOPPING state, if
+              # the parent channel is updated.
+              STOPPING = 10
+            end
           end
 
           # An asset represents a video or an image.

data/proto_docs/google/cloud/video/livestream/v1/service.rb

@@ -458,6 +458,7 @@ module Google
           #     Field mask is used to specify the fields to be overwritten in the Input
           #     resource by the update. You can only update the following fields:
           #
+          #     * [`tier`](https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.inputs#Tier)
           #     * [`preprocessingConfig`](https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.inputs#PreprocessingConfig)
           #     * [`securityRules`](https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.inputs#SecurityRule)
           #
@@ -713,6 +714,146 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
+          # Request message for "LivestreamService.ListDvrSessions".
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. Parent value for ListDvrSessionsRequest
+          # @!attribute [rw] page_size
+          #   @return [::Integer]
+          #     Optional. Requested page size. Server may return fewer items than
+          #     requested. If unspecified, server will pick an appropriate default.
+          # @!attribute [rw] page_token
+          #   @return [::String]
+          #     Optional. A token identifying a page of results the server should return.
+          # @!attribute [rw] filter
+          #   @return [::String]
+          #     Optional. Filtering results
+          # @!attribute [rw] order_by
+          #   @return [::String]
+          #     Optional. Hint for how to order the results
+          class ListDvrSessionsRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Response message for "LivestreamService.ListDvrSessions".
+          # @!attribute [rw] dvr_sessions
+          #   @return [::Array<::Google::Cloud::Video::LiveStream::V1::DvrSession>]
+          #     The list of DVR sessions
+          # @!attribute [rw] next_page_token
+          #   @return [::String]
+          #     A token identifying a page of results the server should return.
+          # @!attribute [rw] unreachable
+          #   @return [::Array<::String>]
+          #     Locations that could not be reached.
+          class ListDvrSessionsResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for "LivestreamService.GetDvrSession".
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. Name of the resource, in the following form:
+          #     `projects/{project}/locations/{location}/channels/{channelId}/dvrSessions/{dvrSessionId}`.
+          class GetDvrSessionRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for "LivestreamService.CreateDvrSession".
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The parent resource name, in the following form:
+          #     `projects/{project}/locations/{location}/channels/{channelId}`.
+          # @!attribute [rw] dvr_session_id
+          #   @return [::String]
+          #     Required. Id of the requesting object in the following form:
+          #
+          #     1. 1 character minimum, 63 characters maximum
+          #     2. Only contains letters, digits, underscores, and hyphens
+          # @!attribute [rw] dvr_session
+          #   @return [::Google::Cloud::Video::LiveStream::V1::DvrSession]
+          #     Required. The resource being created
+          # @!attribute [rw] request_id
+          #   @return [::String]
+          #     Optional. An optional request ID to identify requests. Specify a unique
+          #     request ID so that if you must retry your request, the server will know to
+          #     ignore the request if it has already been completed. The server will
+          #     guarantee that for at least 60 minutes since the first request.
+          #
+          #     For example, consider a situation where you make an initial request and
+          #     the request times out. If you make the request again with the same request
+          #     ID, the server can check if original operation with the same request ID
+          #     was received, and if so, will ignore the second request. This prevents
+          #     clients from accidentally creating duplicate commitments.
+          #
+          #     The request ID must be a valid UUID with the exception that zero UUID is
+          #     not supported (00000000-0000-0000-0000-000000000000).
+          class CreateDvrSessionRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for "LivestreamService.DeleteDvrSession".
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the event resource, in the form of:
+          #     `projects/{project}/locations/{location}/channels/{channelId}/dvrSessions/{dvrSessionId}`.
+          # @!attribute [rw] request_id
+          #   @return [::String]
+          #     Optional. A request ID to identify requests. Specify a unique request ID
+          #     so that if you must retry your request, the server will know to ignore
+          #     the request if it has already been completed. The server will guarantee
+          #     that for at least 60 minutes since the first request.
+          #
+          #     For example, consider a situation where you make an initial request and the
+          #     request times out. If you make the request again with the same request ID,
+          #     the server can check if original operation with the same request ID was
+          #     received, and if so, will ignore the second request. This prevents clients
+          #     from accidentally creating duplicate commitments.
+          #
+          #     The request ID must be a valid UUID with the exception that zero UUID is
+          #     not supported `(00000000-0000-0000-0000-000000000000)`.
+          class DeleteDvrSessionRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for "LivestreamService.UpdateDvrSession".
+          # @!attribute [rw] update_mask
+          #   @return [::Google::Protobuf::FieldMask]
+          #     Required. Field mask is used to specify the fields to be overwritten in the
+          #     DvrSession resource by the update. You can only update the following
+          #     fields:
+          #
+          #     * `dvrWindows`
+          #
+          #     The fields specified in the update_mask are relative to the resource, not
+          #     the full request. A field will be overwritten if it is in the mask.
+          # @!attribute [rw] dvr_session
+          #   @return [::Google::Cloud::Video::LiveStream::V1::DvrSession]
+          #     Required. The DVR session resource to be updated.
+          # @!attribute [rw] request_id
+          #   @return [::String]
+          #     Optional. A request ID to identify requests. Specify a unique request ID
+          #     so that if you must retry your request, the server will know to ignore
+          #     the request if it has already been completed. The server will guarantee
+          #     that for at least 60 minutes since the first request.
+          #
+          #     For example, consider a situation where you make an initial request and the
+          #     request times out. If you make the request again with the same request ID,
+          #     the server can check if original operation with the same request ID was
+          #     received, and if so, will ignore the second request. This prevents clients
+          #     from accidentally creating duplicate commitments.
+          #
+          #     The request ID must be a valid UUID with the exception that zero UUID is
+          #     not supported `(00000000-0000-0000-0000-000000000000)`.
+          class UpdateDvrSessionRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
           # Represents the metadata of the long-running operation.
           # @!attribute [r] create_time
           #   @return [::Google::Protobuf::Timestamp]
@@ -730,9 +871,10 @@ module Google
           #   @return [::Boolean]
           #     Output only. Identifies whether the user has requested cancellation
           #     of the operation. Operations that have successfully been cancelled
-          #     have [Operation.error][] value with a
-          #     {::Google::Rpc::Status#code google.rpc.Status.code} of 1, corresponding to
-          #     `Code.CANCELLED`.
+          #     have
+          #     {::Google::Longrunning::Operation#error google.longrunning.Operation.error}
+          #     value with a {::Google::Rpc::Status#code google.rpc.Status.code} of 1,
+          #     corresponding to `Code.CANCELLED`.
           # @!attribute [r] api_version
           #   @return [::String]
           #     Output only. API version used to start the operation.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-video-live_stream-v1
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Google LLC