google-cloud-video-live_stream-v1 0.1.0

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

@@ -0,0 +1,523 @@
+# frozen_string_literal: true
+
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Video
+      module LiveStream
+        module V1
+          # Request message for "LivestreamService.CreateChannel".
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The parent location for the resource, in the form of:
+          #     `projects/{project}/locations/{location}`.
+          # @!attribute [rw] channel
+          #   @return [::Google::Cloud::Video::LiveStream::V1::Channel]
+          #     Required. The channel resource to be created.
+          # @!attribute [rw] channel_id
+          #   @return [::String]
+          #     Required. The ID of the channel resource to be created.
+          #     This value must be 1-63 characters, begin and end with `[a-z0-9]`,
+          #     could contain dashes (-) in between.
+          # @!attribute [rw] request_id
+          #   @return [::String]
+          #     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 CreateChannelRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for "LivestreamService.ListChannels".
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The parent location for the resource, in the form of:
+          #     `projects/{project}/locations/{location}`.
+          # @!attribute [rw] page_size
+          #   @return [::Integer]
+          #     The maximum number of items to return. If unspecified, server
+          #     will pick an appropriate default. Server may return fewer items than
+          #     requested. A caller should only rely on response's
+          #     {::Google::Cloud::Video::LiveStream::V1::ListChannelsResponse#next_page_token next_page_token} to
+          #     determine if there are more items left to be queried.
+          # @!attribute [rw] page_token
+          #   @return [::String]
+          #     The next_page_token value returned from a previous List request, if any.
+          # @!attribute [rw] filter
+          #   @return [::String]
+          #     The filter to apply to list results.
+          # @!attribute [rw] order_by
+          #   @return [::String]
+          #     Specifies the ordering of results following syntax at
+          #     https://cloud.google.com/apis/design/design_patterns#sorting_order.
+          class ListChannelsRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Response message for "LivestreamService.ListChannels".
+          # @!attribute [rw] channels
+          #   @return [::Array<::Google::Cloud::Video::LiveStream::V1::Channel>]
+          #     A list of channels.
+          # @!attribute [rw] next_page_token
+          #   @return [::String]
+          #     Token to retrieve the next page of results, or empty if there are no more
+          #     results in the list.
+          # @!attribute [rw] unreachable
+          #   @return [::Array<::String>]
+          #     Locations that could not be reached.
+          class ListChannelsResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for "LivestreamService.GetChannel".
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the channel resource, in the form of:
+          #     `projects/{project}/locations/{location}/channels/{channelId}`.
+          class GetChannelRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for "LivestreamService.DeleteChannel".
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the channel resource, in the form of:
+          #     `projects/{project}/locations/{location}/channels/{channelId}`.
+          # @!attribute [rw] request_id
+          #   @return [::String]
+          #     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 after 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)`.
+          # @!attribute [rw] force
+          #   @return [::Boolean]
+          #     If the `force` field is set to the default value of `false`, you must
+          #     delete all of a channel's events before you can delete the channel itself.
+          #     If the field is set to `true`, requests to delete a channel also delete
+          #     associated channel events.
+          class DeleteChannelRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for "LivestreamService.UpdateChannel".
+          # @!attribute [rw] update_mask
+          #   @return [::Google::Protobuf::FieldMask]
+          #     Field mask is used to specify the fields to be overwritten in the Channel
+          #     resource by the update. You can only update the following fields:
+          #
+          #     * [`inputAttachments`](https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.channels#inputattachment)
+          #     * [`output`](https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.channels#output)
+          #     * [`elementaryStreams`](https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.channels#ElementaryStream)
+          #     * [`muxStreams`](https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.channels#muxstream)
+          #     * [`manifests`](https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.channels#Manifest)
+          #     * [`spritesheets`](https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.channels#spritesheet)
+          #
+          #     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] channel
+          #   @return [::Google::Cloud::Video::LiveStream::V1::Channel]
+          #     Required. The channel resource to be updated.
+          # @!attribute [rw] request_id
+          #   @return [::String]
+          #     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 UpdateChannelRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for "LivestreamService.StartChannel".
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the channel resource, in the form of:
+          #     `projects/{project}/locations/{location}/channels/{channelId}`.
+          # @!attribute [rw] request_id
+          #   @return [::String]
+          #     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 StartChannelRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for "LivestreamService.StopChannel".
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the channel resource, in the form of:
+          #     `projects/{project}/locations/{location}/channels/{channelId}`.
+          # @!attribute [rw] request_id
+          #   @return [::String]
+          #     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 StopChannelRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for "LivestreamService.CreateInput".
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The parent location for the resource, in the form of:
+          #     `projects/{project}/locations/{location}`.
+          # @!attribute [rw] input
+          #   @return [::Google::Cloud::Video::LiveStream::V1::Input]
+          #     Required. The input resource to be created.
+          # @!attribute [rw] input_id
+          #   @return [::String]
+          #     Required. The ID of the input resource to be created.
+          #     This value must be 1-63 characters, begin and end with `[a-z0-9]`,
+          #     could contain dashes (-) in between.
+          # @!attribute [rw] request_id
+          #   @return [::String]
+          #     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 CreateInputRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for "LivestreamService.ListInputs".
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The parent location for the resource, in the form of:
+          #     `projects/{project}/locations/{location}`.
+          # @!attribute [rw] page_size
+          #   @return [::Integer]
+          #     The maximum number of items to return. If unspecified, server
+          #     will pick an appropriate default. Server may return fewer items than
+          #     requested. A caller should only rely on response's
+          #     {::Google::Cloud::Video::LiveStream::V1::ListInputsResponse#next_page_token next_page_token} to
+          #     determine if there are more items left to be queried.
+          # @!attribute [rw] page_token
+          #   @return [::String]
+          #     The next_page_token value returned from a previous List request, if any.
+          # @!attribute [rw] filter
+          #   @return [::String]
+          #     The filter to apply to list results.
+          # @!attribute [rw] order_by
+          #   @return [::String]
+          #     Specifies the ordering of results following syntax at [Sorting
+          #     Order](https://cloud.google.com/apis/design/design_patterns#sorting_order).
+          class ListInputsRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Response message for "LivestreamService.ListInputs".
+          # @!attribute [rw] inputs
+          #   @return [::Array<::Google::Cloud::Video::LiveStream::V1::Input>]
+          #     A list of inputs.
+          # @!attribute [rw] next_page_token
+          #   @return [::String]
+          #     Token to retrieve the next page of results, or empty if there are no more
+          #     results in the list.
+          # @!attribute [rw] unreachable
+          #   @return [::Array<::String>]
+          #     Locations that could not be reached.
+          class ListInputsResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for "LivestreamService.GetInput".
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the input resource, in the form of:
+          #     `projects/{project}/locations/{location}/inputs/{inputId}`.
+          class GetInputRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for "LivestreamService.DeleteInput".
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the input resource, in the form of:
+          #     `projects/{project}/locations/{location}/inputs/{inputId}`.
+          # @!attribute [rw] request_id
+          #   @return [::String]
+          #     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 DeleteInputRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for "LivestreamService.UpdateInput".
+          # @!attribute [rw] update_mask
+          #   @return [::Google::Protobuf::FieldMask]
+          #     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:
+          #
+          #     * [`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)
+          #
+          #     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] input
+          #   @return [::Google::Cloud::Video::LiveStream::V1::Input]
+          #     Required. The input resource to be updated.
+          # @!attribute [rw] request_id
+          #   @return [::String]
+          #     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 UpdateInputRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for "LivestreamService.CreateEvent".
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The parent channel for the resource, in the form of:
+          #     `projects/{project}/locations/{location}/channels/{channelId}`.
+          # @!attribute [rw] event
+          #   @return [::Google::Cloud::Video::LiveStream::V1::Event]
+          #     Required. The event resource to be created.
+          # @!attribute [rw] event_id
+          #   @return [::String]
+          #     Required. The ID of the event resource to be created.
+          #     This value must be 1-63 characters, begin and end with `[a-z0-9]`,
+          #     could contain dashes (-) in between.
+          # @!attribute [rw] request_id
+          #   @return [::String]
+          #     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 CreateEventRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for "LivestreamService.ListEvents".
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. The parent channel for the resource, in the form of:
+          #     `projects/{project}/locations/{location}/channels/{channelId}`.
+          # @!attribute [rw] page_size
+          #   @return [::Integer]
+          #     The maximum number of items to return. If unspecified, server
+          #     will pick an appropriate default. Server may return fewer items than
+          #     requested. A caller should only rely on response's
+          #     {::Google::Cloud::Video::LiveStream::V1::ListEventsResponse#next_page_token next_page_token} to
+          #     determine if there are more items left to be queried.
+          # @!attribute [rw] page_token
+          #   @return [::String]
+          #     The next_page_token value returned from a previous List request, if any.
+          # @!attribute [rw] filter
+          #   @return [::String]
+          #     The filter to apply to list results.
+          # @!attribute [rw] order_by
+          #   @return [::String]
+          #     Specifies the ordering of results following syntax at
+          #     https://cloud.google.com/apis/design/design_patterns#sorting_order.
+          class ListEventsRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Response message for "LivestreamService.ListEvents".
+          # @!attribute [rw] events
+          #   @return [::Array<::Google::Cloud::Video::LiveStream::V1::Event>]
+          #     A list of events.
+          # @!attribute [rw] next_page_token
+          #   @return [::String]
+          #     Token to retrieve the next page of results, or empty if there are no more
+          #     results in the list.
+          # @!attribute [rw] unreachable
+          #   @return [::Array<::String>]
+          #     Locations that could not be reached.
+          class ListEventsResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for "LivestreamService.GetEvent".
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the event resource, in the form of:
+          #     `projects/{project}/locations/{location}/channels/{channelId}/events/{eventId}`.
+          class GetEventRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Request message for "LivestreamService.DeleteEvent".
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. The name of the event resource, in the form of:
+          #     `projects/{project}/locations/{location}/channels/{channelId}/events/{eventId}`.
+          # @!attribute [rw] request_id
+          #   @return [::String]
+          #     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 DeleteEventRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Response message for Start/Stop Channel long-running operations.
+          class ChannelOperationResponse
+            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]
+          #     Output only. The time the operation was created.
+          # @!attribute [r] end_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Output only. The time the operation finished running.
+          # @!attribute [r] target
+          #   @return [::String]
+          #     Output only. Server-defined resource path for the target of the operation.
+          # @!attribute [r] verb
+          #   @return [::String]
+          #     Output only. Name of the verb executed by the operation.
+          # @!attribute [r] requested_cancellation
+          #   @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`.
+          # @!attribute [r] api_version
+          #   @return [::String]
+          #     Output only. API version used to start the operation.
+          class OperationMetadata
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end