google-cloud-video-stitcher-v1 0.1.0

data/proto_docs/google/api/field_behavior.rb

@@ -0,0 +1,71 @@
+# 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 Api
+    # An indicator of the behavior of a given field (for example, that a field
+    # is required in requests, or given as output but ignored as input).
+    # This **does not** change the behavior in protocol buffers itself; it only
+    # denotes the behavior and may affect how API tooling handles the field.
+    #
+    # Note: This enum **may** receive new values in the future.
+    module FieldBehavior
+      # Conventional default for enums. Do not use this.
+      FIELD_BEHAVIOR_UNSPECIFIED = 0
+
+      # Specifically denotes a field as optional.
+      # While all fields in protocol buffers are optional, this may be specified
+      # for emphasis if appropriate.
+      OPTIONAL = 1
+
+      # Denotes a field as required.
+      # This indicates that the field **must** be provided as part of the request,
+      # and failure to do so will cause an error (usually `INVALID_ARGUMENT`).
+      REQUIRED = 2
+
+      # Denotes a field as output only.
+      # This indicates that the field is provided in responses, but including the
+      # field in a request does nothing (the server *must* ignore it and
+      # *must not* throw an error as a result of the field's presence).
+      OUTPUT_ONLY = 3
+
+      # Denotes a field as input only.
+      # This indicates that the field is provided in requests, and the
+      # corresponding field is not included in output.
+      INPUT_ONLY = 4
+
+      # Denotes a field as immutable.
+      # This indicates that the field may be set once in a request to create a
+      # resource, but may not be changed thereafter.
+      IMMUTABLE = 5
+
+      # Denotes that a (repeated) field is an unordered list.
+      # This indicates that the service may provide the elements of the list
+      # in any arbitrary  order, rather than the order the user originally
+      # provided. Additionally, the list's order may or may not be stable.
+      UNORDERED_LIST = 6
+
+      # Denotes that this field returns a non-empty default value if not set.
+      # This indicates that if the user provides the empty value in a request,
+      # a non-empty value will be returned. The user will not be aware of what
+      # non-empty value to expect.
+      NON_EMPTY_DEFAULT = 7
+    end
+  end
+end

data/proto_docs/google/api/resource.rb

@@ -0,0 +1,222 @@
+# 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 Api
+    # A simple descriptor of a resource type.
+    #
+    # ResourceDescriptor annotates a resource message (either by means of a
+    # protobuf annotation or use in the service config), and associates the
+    # resource's schema, the resource type, and the pattern of the resource name.
+    #
+    # Example:
+    #
+    #     message Topic {
+    #       // Indicates this message defines a resource schema.
+    #       // Declares the resource type in the format of {service}/{kind}.
+    #       // For Kubernetes resources, the format is {api group}/{kind}.
+    #       option (google.api.resource) = {
+    #         type: "pubsub.googleapis.com/Topic"
+    #         pattern: "projects/{project}/topics/{topic}"
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #     resources:
+    #     - type: "pubsub.googleapis.com/Topic"
+    #       pattern: "projects/{project}/topics/{topic}"
+    #
+    # Sometimes, resources have multiple patterns, typically because they can
+    # live under multiple parents.
+    #
+    # Example:
+    #
+    #     message LogEntry {
+    #       option (google.api.resource) = {
+    #         type: "logging.googleapis.com/LogEntry"
+    #         pattern: "projects/{project}/logs/{log}"
+    #         pattern: "folders/{folder}/logs/{log}"
+    #         pattern: "organizations/{organization}/logs/{log}"
+    #         pattern: "billingAccounts/{billing_account}/logs/{log}"
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #     resources:
+    #     - type: 'logging.googleapis.com/LogEntry'
+    #       pattern: "projects/{project}/logs/{log}"
+    #       pattern: "folders/{folder}/logs/{log}"
+    #       pattern: "organizations/{organization}/logs/{log}"
+    #       pattern: "billingAccounts/{billing_account}/logs/{log}"
+    # @!attribute [rw] type
+    #   @return [::String]
+    #     The resource type. It must be in the format of
+    #     \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
+    #     singular and must not include version numbers.
+    #
+    #     Example: `storage.googleapis.com/Bucket`
+    #
+    #     The value of the resource_type_kind must follow the regular expression
+    #     /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
+    #     should use PascalCase (UpperCamelCase). The maximum number of
+    #     characters allowed for the `resource_type_kind` is 100.
+    # @!attribute [rw] pattern
+    #   @return [::Array<::String>]
+    #     Optional. The relative resource name pattern associated with this resource
+    #     type. The DNS prefix of the full resource name shouldn't be specified here.
+    #
+    #     The path pattern must follow the syntax, which aligns with HTTP binding
+    #     syntax:
+    #
+    #         Template = Segment { "/" Segment } ;
+    #         Segment = LITERAL | Variable ;
+    #         Variable = "{" LITERAL "}" ;
+    #
+    #     Examples:
+    #
+    #         - "projects/\\{project}/topics/\\{topic}"
+    #         - "projects/\\{project}/knowledgeBases/\\{knowledge_base}"
+    #
+    #     The components in braces correspond to the IDs for each resource in the
+    #     hierarchy. It is expected that, if multiple patterns are provided,
+    #     the same component name (e.g. "project") refers to IDs of the same
+    #     type of resource.
+    # @!attribute [rw] name_field
+    #   @return [::String]
+    #     Optional. The field on the resource that designates the resource name
+    #     field. If omitted, this is assumed to be "name".
+    # @!attribute [rw] history
+    #   @return [::Google::Api::ResourceDescriptor::History]
+    #     Optional. The historical or future-looking state of the resource pattern.
+    #
+    #     Example:
+    #
+    #         // The InspectTemplate message originally only supported resource
+    #         // names with organization, and project was added later.
+    #         message InspectTemplate {
+    #           option (google.api.resource) = {
+    #             type: "dlp.googleapis.com/InspectTemplate"
+    #             pattern:
+    #             "organizations/{organization}/inspectTemplates/{inspect_template}"
+    #             pattern: "projects/{project}/inspectTemplates/{inspect_template}"
+    #             history: ORIGINALLY_SINGLE_PATTERN
+    #           };
+    #         }
+    # @!attribute [rw] plural
+    #   @return [::String]
+    #     The plural name used in the resource name and permission names, such as
+    #     'projects' for the resource name of 'projects/\\{project}' and the permission
+    #     name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
+    #     concept of the `plural` field in k8s CRD spec
+    #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
+    #
+    #     Note: The plural form is required even for singleton resources. See
+    #     https://aip.dev/156
+    # @!attribute [rw] singular
+    #   @return [::String]
+    #     The same concept of the `singular` field in k8s CRD spec
+    #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
+    #     Such as "project" for the `resourcemanager.googleapis.com/Project` type.
+    # @!attribute [rw] style
+    #   @return [::Array<::Google::Api::ResourceDescriptor::Style>]
+    #     Style flag(s) for this resource.
+    #     These indicate that a resource is expected to conform to a given
+    #     style. See the specific style flags for additional information.
+    class ResourceDescriptor
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+
+      # A description of the historical or future-looking state of the
+      # resource pattern.
+      module History
+        # The "unset" value.
+        HISTORY_UNSPECIFIED = 0
+
+        # The resource originally had one pattern and launched as such, and
+        # additional patterns were added later.
+        ORIGINALLY_SINGLE_PATTERN = 1
+
+        # The resource has one pattern, but the API owner expects to add more
+        # later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
+        # that from being necessary once there are multiple patterns.)
+        FUTURE_MULTI_PATTERN = 2
+      end
+
+      # A flag representing a specific style that a resource claims to conform to.
+      module Style
+        # The unspecified value. Do not use.
+        STYLE_UNSPECIFIED = 0
+
+        # This resource is intended to be "declarative-friendly".
+        #
+        # Declarative-friendly resources must be more strictly consistent, and
+        # setting this to true communicates to tools that this resource should
+        # adhere to declarative-friendly expectations.
+        #
+        # Note: This is used by the API linter (linter.aip.dev) to enable
+        # additional checks.
+        DECLARATIVE_FRIENDLY = 1
+      end
+    end
+
+    # Defines a proto annotation that describes a string field that refers to
+    # an API resource.
+    # @!attribute [rw] type
+    #   @return [::String]
+    #     The resource type that the annotated field references.
+    #
+    #     Example:
+    #
+    #         message Subscription {
+    #           string topic = 2 [(google.api.resource_reference) = {
+    #             type: "pubsub.googleapis.com/Topic"
+    #           }];
+    #         }
+    #
+    #     Occasionally, a field may reference an arbitrary resource. In this case,
+    #     APIs use the special value * in their resource reference.
+    #
+    #     Example:
+    #
+    #         message GetIamPolicyRequest {
+    #           string resource = 2 [(google.api.resource_reference) = {
+    #             type: "*"
+    #           }];
+    #         }
+    # @!attribute [rw] child_type
+    #   @return [::String]
+    #     The resource type of a child collection that the annotated field
+    #     references. This is useful for annotating the `parent` field that
+    #     doesn't have a fixed resource type.
+    #
+    #     Example:
+    #
+    #         message ListLogEntriesRequest {
+    #           string parent = 1 [(google.api.resource_reference) = {
+    #             child_type: "logging.googleapis.com/LogEntry"
+    #           };
+    #         }
+    class ResourceReference
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

data/proto_docs/google/cloud/video/stitcher/v1/ad_tag_details.rb

@@ -0,0 +1,102 @@
+# 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 Stitcher
+        module V1
+          # Container for a live session's ad tag detail.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     The resource name in the form of
+          #     `projects/{project}/locations/{location}/liveSessions/{live_session}/liveAdTagDetails/{id}`.
+          # @!attribute [rw] ad_requests
+          #   @return [::Array<::Google::Cloud::Video::Stitcher::V1::AdRequest>]
+          #     A list of ad requests.
+          class LiveAdTagDetail
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Information related to the details for one ad tag.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     The name of the ad tag detail for the specified VOD session, in the form of
+          #     `projects/{project}/locations/{location}/vodSessions/{vod_session_id}/vodAdTagDetails/{id}`.
+          # @!attribute [rw] ad_requests
+          #   @return [::Array<::Google::Cloud::Video::Stitcher::V1::AdRequest>]
+          #     A list of ad requests for one ad tag.
+          class VodAdTagDetail
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Details of an ad request to an ad server.
+          # @!attribute [rw] uri
+          #   @return [::String]
+          #     The ad tag URI processed with integrated macros.
+          # @!attribute [rw] request_metadata
+          #   @return [::Google::Cloud::Video::Stitcher::V1::RequestMetadata]
+          #     The request metadata used to make the ad request.
+          # @!attribute [rw] response_metadata
+          #   @return [::Google::Cloud::Video::Stitcher::V1::ResponseMetadata]
+          #     The response metadata received from the ad request.
+          class AdRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Metadata for an ad request.
+          # @!attribute [rw] headers
+          #   @return [::Google::Protobuf::Struct]
+          #     The HTTP headers of the ad request.
+          class RequestMetadata
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Metadata for the response of an ad request.
+          # @!attribute [rw] error
+          #   @return [::String]
+          #     Error message received when making the ad request.
+          # @!attribute [rw] headers
+          #   @return [::Google::Protobuf::Struct]
+          #     Headers from the response.
+          # @!attribute [rw] status_code
+          #   @return [::String]
+          #     Status code for the response.
+          # @!attribute [rw] size_bytes
+          #   @return [::Integer]
+          #     Size in bytes of the response.
+          # @!attribute [rw] duration
+          #   @return [::Google::Protobuf::Duration]
+          #     Total time elapsed for the response.
+          # @!attribute [rw] body
+          #   @return [::String]
+          #     The body of the response.
+          class ResponseMetadata
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/video/stitcher/v1/cdn_keys.rb

@@ -0,0 +1,71 @@
+# 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 Stitcher
+        module V1
+          # Configuration for a CDN key. Used by the Video Stitcher
+          # to sign URIs for fetching video manifests and signing
+          # media segments for playback.
+          # @!attribute [rw] google_cdn_key
+          #   @return [::Google::Cloud::Video::Stitcher::V1::GoogleCdnKey]
+          #     The configuration for a Google Cloud CDN key.
+          # @!attribute [rw] akamai_cdn_key
+          #   @return [::Google::Cloud::Video::Stitcher::V1::AkamaiCdnKey]
+          #     The configuration for an Akamai CDN key.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     The resource name of the CDN key, in the form of
+          #     `projects/{project}/locations/{location}/cdnKeys/{id}`.
+          #     The name is ignored when creating a CDN key.
+          # @!attribute [rw] hostname
+          #   @return [::String]
+          #     The hostname this key applies to.
+          class CdnKey
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Configuration for a Google Cloud CDN key.
+          # @!attribute [rw] private_key
+          #   @return [::String]
+          #     Input only. Secret for this Google Cloud CDN key.
+          # @!attribute [rw] key_name
+          #   @return [::String]
+          #     The public name of the Google Cloud CDN key.
+          class GoogleCdnKey
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Configuration for an Akamai CDN key.
+          # @!attribute [rw] token_key
+          #   @return [::String]
+          #     Input only. Token key for the Akamai CDN edge configuration.
+          class AkamaiCdnKey
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/video/stitcher/v1/companions.rb

@@ -0,0 +1,129 @@
+# 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 Stitcher
+        module V1
+          # Metadata for companion ads.
+          # @!attribute [rw] display_requirement
+          #   @return [::Google::Cloud::Video::Stitcher::V1::CompanionAds::DisplayRequirement]
+          #     Indicates how many of the companions should be displayed with the ad.
+          # @!attribute [rw] companions
+          #   @return [::Array<::Google::Cloud::Video::Stitcher::V1::Companion>]
+          #     List of companion ads.
+          class CompanionAds
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Indicates how many of the companions should be displayed with the ad.
+            module DisplayRequirement
+              # Required companions are not specified. The default is ALL.
+              DISPLAY_REQUIREMENT_UNSPECIFIED = 0
+
+              # All companions are required to be displayed.
+              ALL = 1
+
+              # At least one of companions needs to be displayed.
+              ANY = 2
+
+              # All companions are optional for display.
+              NONE = 3
+            end
+          end
+
+          # Metadata for a companion.
+          # @!attribute [rw] iframe_ad_resource
+          #   @return [::Google::Cloud::Video::Stitcher::V1::IframeAdResource]
+          #     The IFrame ad resource associated with the companion ad.
+          # @!attribute [rw] static_ad_resource
+          #   @return [::Google::Cloud::Video::Stitcher::V1::StaticAdResource]
+          #     The static ad resource associated with the companion ad.
+          # @!attribute [rw] html_ad_resource
+          #   @return [::Google::Cloud::Video::Stitcher::V1::HtmlAdResource]
+          #     The HTML ad resource associated with the companion ad.
+          # @!attribute [rw] api_framework
+          #   @return [::String]
+          #     The API necessary to communicate with the creative if available.
+          # @!attribute [rw] height_px
+          #   @return [::Integer]
+          #     The pixel height of the placement slot for the intended creative.
+          # @!attribute [rw] width_px
+          #   @return [::Integer]
+          #     The pixel width of the placement slot for the intended creative.
+          # @!attribute [rw] asset_height_px
+          #   @return [::Integer]
+          #     The pixel height of the creative.
+          # @!attribute [rw] expanded_height_px
+          #   @return [::Integer]
+          #     The maximum pixel height of the creative in its expanded state.
+          # @!attribute [rw] asset_width_px
+          #   @return [::Integer]
+          #     The pixel width of the creative.
+          # @!attribute [rw] expanded_width_px
+          #   @return [::Integer]
+          #     The maximum pixel width of the creative in its expanded state.
+          # @!attribute [rw] ad_slot_id
+          #   @return [::String]
+          #     The ID used to identify the desired placement on a publisher's page.
+          #     Values to be used should be discussed between publishers and
+          #     advertisers.
+          # @!attribute [rw] events
+          #   @return [::Array<::Google::Cloud::Video::Stitcher::V1::Event>]
+          #     The list of tracking events for the companion.
+          class Companion
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Metadata for an HTML ad resource.
+          # @!attribute [rw] html_source
+          #   @return [::String]
+          #     The HTML to display for the ad resource.
+          class HtmlAdResource
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Metadata for an IFrame ad resource.
+          # @!attribute [rw] uri
+          #   @return [::String]
+          #     URI source for an IFrame to display for the ad resource.
+          class IframeAdResource
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Metadata for a static ad resource.
+          # @!attribute [rw] uri
+          #   @return [::String]
+          #     URI to the static file for the ad resource.
+          # @!attribute [rw] creative_type
+          #   @return [::String]
+          #     Describes the MIME type of the ad resource.
+          class StaticAdResource
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end