google-cloud-video_intelligence 1.4.0 → 2.0.0

data/lib/google/cloud/video_intelligence/v1beta1/doc/google/longrunning/operations.rb

@@ -1,51 +0,0 @@
-# Copyright 2019 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.
-
-
-module Google
-  module Longrunning
-    # This resource represents a long-running operation that is the result of a
-    # network API call.
-    # @!attribute [rw] name
-    #   @return [String]
-    #     The server-assigned name, which is only unique within the same service that
-    #     originally returns it. If you use the default HTTP mapping, the
-    #     `name` should have the format of `operations/some/unique/name`.
-    # @!attribute [rw] metadata
-    #   @return [Google::Protobuf::Any]
-    #     Service-specific metadata associated with the operation.  It typically
-    #     contains progress information and common metadata such as create time.
-    #     Some services might not provide such metadata.  Any method that returns a
-    #     long-running operation should document the metadata type, if any.
-    # @!attribute [rw] done
-    #   @return [true, false]
-    #     If the value is `false`, it means the operation is still in progress.
-    #     If `true`, the operation is completed, and either `error` or `response` is
-    #     available.
-    # @!attribute [rw] error
-    #   @return [Google::Rpc::Status]
-    #     The error result of the operation in case of failure or cancellation.
-    # @!attribute [rw] response
-    #   @return [Google::Protobuf::Any]
-    #     The normal response of the operation in case of success.  If the original
-    #     method returns no data on success, such as `Delete`, the response is
-    #     `google.protobuf.Empty`.  If the original method is standard
-    #     `Get`/`Create`/`Update`, the response should be the resource.  For other
-    #     methods, the response should have the type `XxxResponse`, where `Xxx`
-    #     is the original method name.  For example, if the original method name
-    #     is `TakeSnapshot()`, the inferred response type is
-    #     `TakeSnapshotResponse`.
-    class Operation; end
-  end
-end

data/lib/google/cloud/video_intelligence/v1beta1/doc/google/protobuf/any.rb

@@ -1,131 +0,0 @@
-# Copyright 2019 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.
-
-
-module Google
-  module Protobuf
-    # `Any` contains an arbitrary serialized protocol buffer message along with a
-    # URL that describes the type of the serialized message.
-    #
-    # Protobuf library provides support to pack/unpack Any values in the form
-    # of utility functions or additional generated methods of the Any type.
-    #
-    # Example 1: Pack and unpack a message in C++.
-    #
-    #     Foo foo = ...;
-    #     Any any;
-    #     any.PackFrom(foo);
-    #     ...
-    #     if (any.UnpackTo(&foo)) {
-    #       ...
-    #     }
-    #
-    # Example 2: Pack and unpack a message in Java.
-    #
-    #     Foo foo = ...;
-    #     Any any = Any.pack(foo);
-    #     ...
-    #     if (any.is(Foo.class)) {
-    #       foo = any.unpack(Foo.class);
-    #     }
-    #
-    #  Example 3: Pack and unpack a message in Python.
-    #
-    #     foo = Foo(...)
-    #     any = Any()
-    #     any.Pack(foo)
-    #     ...
-    #     if any.Is(Foo.DESCRIPTOR):
-    #       any.Unpack(foo)
-    #       ...
-    #
-    #  Example 4: Pack and unpack a message in Go
-    #
-    #      foo := &pb.Foo{...}
-    #      any, err := ptypes.MarshalAny(foo)
-    #      ...
-    #      foo := &pb.Foo{}
-    #      if err := ptypes.UnmarshalAny(any, foo); err != nil {
-    #        ...
-    #      }
-    #
-    # The pack methods provided by protobuf library will by default use
-    # 'type.googleapis.com/full.type.name' as the type URL and the unpack
-    # methods only use the fully qualified type name after the last '/'
-    # in the type URL, for example "foo.bar.com/x/y.z" will yield type
-    # name "y.z".
-    #
-    #
-    # = JSON
-    #
-    # The JSON representation of an `Any` value uses the regular
-    # representation of the deserialized, embedded message, with an
-    # additional field `@type` which contains the type URL. Example:
-    #
-    #     package google.profile;
-    #     message Person {
-    #       string first_name = 1;
-    #       string last_name = 2;
-    #     }
-    #
-    #     {
-    #       "@type": "type.googleapis.com/google.profile.Person",
-    #       "firstName": <string>,
-    #       "lastName": <string>
-    #     }
-    #
-    # If the embedded message type is well-known and has a custom JSON
-    # representation, that representation will be embedded adding a field
-    # `value` which holds the custom JSON in addition to the `@type`
-    # field. Example (for message {Google::Protobuf::Duration}):
-    #
-    #     {
-    #       "@type": "type.googleapis.com/google.protobuf.Duration",
-    #       "value": "1.212s"
-    #     }
-    # @!attribute [rw] type_url
-    #   @return [String]
-    #     A URL/resource name that uniquely identifies the type of the serialized
-    #     protocol buffer message. This string must contain at least
-    #     one "/" character. The last segment of the URL's path must represent
-    #     the fully qualified name of the type (as in
-    #     `path/google.protobuf.Duration`). The name should be in a canonical form
-    #     (e.g., leading "." is not accepted).
-    #
-    #     In practice, teams usually precompile into the binary all types that they
-    #     expect it to use in the context of Any. However, for URLs which use the
-    #     scheme `http`, `https`, or no scheme, one can optionally set up a type
-    #     server that maps type URLs to message definitions as follows:
-    #
-    #     * If no scheme is provided, `https` is assumed.
-    #     * An HTTP GET on the URL must yield a {Google::Protobuf::Type}
-    #       value in binary format, or produce an error.
-    #     * Applications are allowed to cache lookup results based on the
-    #       URL, or have them precompiled into a binary to avoid any
-    #       lookup. Therefore, binary compatibility needs to be preserved
-    #       on changes to types. (Use versioned type names to manage
-    #       breaking changes.)
-    #
-    #     Note: this functionality is not currently available in the official
-    #     protobuf release, and it is not used for type URLs beginning with
-    #     type.googleapis.com.
-    #
-    #     Schemes other than `http`, `https` (or the empty scheme) might be
-    #     used with implementation specific semantics.
-    # @!attribute [rw] value
-    #   @return [String]
-    #     Must be a valid serialized protocol buffer of the above specified type.
-    class Any; end
-  end
-end

data/lib/google/cloud/video_intelligence/v1beta1/doc/google/rpc/status.rb

@@ -1,87 +0,0 @@
-# Copyright 2019 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.
-
-
-module Google
-  module Rpc
-    # The `Status` type defines a logical error model that is suitable for
-    # different programming environments, including REST APIs and RPC APIs. It is
-    # used by [gRPC](https://github.com/grpc). The error model is designed to be:
-    #
-    # * Simple to use and understand for most users
-    # * Flexible enough to meet unexpected needs
-    #
-    # = Overview
-    #
-    # The `Status` message contains three pieces of data: error code, error
-    # message, and error details. The error code should be an enum value of
-    # {Google::Rpc::Code}, but it may accept additional error codes
-    # if needed.  The error message should be a developer-facing English message
-    # that helps developers *understand* and *resolve* the error. If a localized
-    # user-facing error message is needed, put the localized message in the error
-    # details or localize it in the client. The optional error details may contain
-    # arbitrary information about the error. There is a predefined set of error
-    # detail types in the package `google.rpc` that can be used for common error
-    # conditions.
-    #
-    # = Language mapping
-    #
-    # The `Status` message is the logical representation of the error model, but it
-    # is not necessarily the actual wire format. When the `Status` message is
-    # exposed in different client libraries and different wire protocols, it can be
-    # mapped differently. For example, it will likely be mapped to some exceptions
-    # in Java, but more likely mapped to some error codes in C.
-    #
-    # = Other uses
-    #
-    # The error model and the `Status` message can be used in a variety of
-    # environments, either with or without APIs, to provide a
-    # consistent developer experience across different environments.
-    #
-    # Example uses of this error model include:
-    #
-    # * Partial errors. If a service needs to return partial errors to the client,
-    #   it may embed the `Status` in the normal response to indicate the partial
-    #   errors.
-    #
-    # * Workflow errors. A typical workflow has multiple steps. Each step may
-    #   have a `Status` message for error reporting.
-    #
-    # * Batch operations. If a client uses batch request and batch response, the
-    #   `Status` message should be used directly inside batch response, one for
-    #   each error sub-response.
-    #
-    # * Asynchronous operations. If an API call embeds asynchronous operation
-    #   results in its response, the status of those operations should be
-    #   represented directly using the `Status` message.
-    #
-    # * Logging. If some API errors are stored in logs, the message `Status` could
-    #   be used directly after any stripping needed for security/privacy reasons.
-    # @!attribute [rw] code
-    #   @return [Integer]
-    #     The status code, which should be an enum value of
-    #     {Google::Rpc::Code}.
-    # @!attribute [rw] message
-    #   @return [String]
-    #     A developer-facing error message, which should be in English. Any
-    #     user-facing error message should be localized and sent in the
-    #     {Google::Rpc::Status#details} field, or localized
-    #     by the client.
-    # @!attribute [rw] details
-    #   @return [Array<Google::Protobuf::Any>]
-    #     A list of messages that carry the error details.  There is a common set of
-    #     message types for APIs to use.
-    class Status; end
-  end
-end

data/lib/google/cloud/video_intelligence/v1beta1/video_intelligence_service_client.rb

@@ -1,305 +0,0 @@
-# Copyright 2019 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.
-#
-# EDITING INSTRUCTIONS
-# This file was generated from the file
-# https://github.com/googleapis/googleapis/blob/master/google/cloud/videointelligence/v1beta1/video_intelligence.proto,
-# and updates to that file get reflected here through a refresh process.
-# For the short term, the refresh process will only be runnable by Google
-# engineers.
-
-
-require "json"
-require "pathname"
-
-require "google/gax"
-require "google/gax/operation"
-require "google/longrunning/operations_client"
-
-require "google/cloud/videointelligence/v1beta1/video_intelligence_pb"
-require "google/cloud/video_intelligence/v1beta1/credentials"
-require "google/cloud/video_intelligence/version"
-
-module Google
-  module Cloud
-    module VideoIntelligence
-      module V1beta1
-        # Service that implements Google Cloud Video Intelligence API.
-        #
-        # @!attribute [r] video_intelligence_service_stub
-        #   @return [Google::Cloud::VideoIntelligence::V1beta1::VideoIntelligenceService::Stub]
-        class VideoIntelligenceServiceClient
-          # @private
-          attr_reader :video_intelligence_service_stub
-
-          # The default address of the service.
-          SERVICE_ADDRESS = "videointelligence.googleapis.com".freeze
-
-          # The default port of the service.
-          DEFAULT_SERVICE_PORT = 443
-
-          # The default set of gRPC interceptors.
-          GRPC_INTERCEPTORS = []
-
-          DEFAULT_TIMEOUT = 30
-
-          # The scopes needed to make gRPC calls to all of the methods defined in
-          # this service.
-          ALL_SCOPES = [
-            "https://www.googleapis.com/auth/cloud-platform"
-          ].freeze
-
-          # @private
-          class OperationsClient < Google::Longrunning::OperationsClient
-            self::SERVICE_ADDRESS = VideoIntelligenceServiceClient::SERVICE_ADDRESS
-            self::GRPC_INTERCEPTORS = VideoIntelligenceServiceClient::GRPC_INTERCEPTORS
-          end
-
-          # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
-          #   Provides the means for authenticating requests made by the client. This parameter can
-          #   be many types.
-          #   A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
-          #   authenticating requests made by this client.
-          #   A `String` will be treated as the path to the keyfile to be used for the construction of
-          #   credentials for this client.
-          #   A `Hash` will be treated as the contents of a keyfile to be used for the construction of
-          #   credentials for this client.
-          #   A `GRPC::Core::Channel` will be used to make calls through.
-          #   A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
-          #   should already be composed with a `GRPC::Core::CallCredentials` object.
-          #   A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
-          #   metadata for requests, generally, to give OAuth credentials.
-          # @param scopes [Array<String>]
-          #   The OAuth scopes for this service. This parameter is ignored if
-          #   an updater_proc is supplied.
-          # @param client_config [Hash]
-          #   A Hash for call options for each method. See
-          #   Google::Gax#construct_settings for the structure of
-          #   this data. Falls back to the default config if not specified
-          #   or the specified config is missing data points.
-          # @param timeout [Numeric]
-          #   The default timeout, in seconds, for calls made through this client.
-          # @param metadata [Hash]
-          #   Default metadata to be sent with each request. This can be overridden on a per call basis.
-          # @param service_address [String]
-          #   Override for the service hostname, or `nil` to leave as the default.
-          # @param service_port [Integer]
-          #   Override for the service port, or `nil` to leave as the default.
-          # @param exception_transformer [Proc]
-          #   An optional proc that intercepts any exceptions raised during an API call to inject
-          #   custom error handling.
-          def initialize \
-              credentials: nil,
-              scopes: ALL_SCOPES,
-              client_config: {},
-              timeout: DEFAULT_TIMEOUT,
-              metadata: nil,
-              service_address: nil,
-              service_port: nil,
-              exception_transformer: nil,
-              lib_name: nil,
-              lib_version: ""
-            # These require statements are intentionally placed here to initialize
-            # the gRPC module only when it's required.
-            # See https://github.com/googleapis/toolkit/issues/446
-            require "google/gax/grpc"
-            require "google/cloud/videointelligence/v1beta1/video_intelligence_services_pb"
-
-            credentials ||= Google::Cloud::VideoIntelligence::V1beta1::Credentials.default
-
-            @operations_client = OperationsClient.new(
-              credentials: credentials,
-              scopes: scopes,
-              client_config: client_config,
-              timeout: timeout,
-              lib_name: lib_name,
-              service_address: service_address,
-              service_port: service_port,
-              lib_version: lib_version,
-              metadata: metadata,
-            )
-
-            if credentials.is_a?(String) || credentials.is_a?(Hash)
-              updater_proc = Google::Cloud::VideoIntelligence::V1beta1::Credentials.new(credentials).updater_proc
-            end
-            if credentials.is_a?(GRPC::Core::Channel)
-              channel = credentials
-            end
-            if credentials.is_a?(GRPC::Core::ChannelCredentials)
-              chan_creds = credentials
-            end
-            if credentials.is_a?(Proc)
-              updater_proc = credentials
-            end
-            if credentials.is_a?(Google::Auth::Credentials)
-              updater_proc = credentials.updater_proc
-            end
-
-            package_version = Google::Cloud::VideoIntelligence::VERSION
-
-            google_api_client = "gl-ruby/#{RUBY_VERSION}"
-            google_api_client << " #{lib_name}/#{lib_version}" if lib_name
-            google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}"
-            google_api_client << " grpc/#{GRPC::VERSION}"
-            google_api_client.freeze
-
-            headers = { :"x-goog-api-client" => google_api_client }
-            headers.merge!(metadata) unless metadata.nil?
-            client_config_file = Pathname.new(__dir__).join(
-              "video_intelligence_service_client_config.json"
-            )
-            defaults = client_config_file.open do |f|
-              Google::Gax.construct_settings(
-                "google.cloud.videointelligence.v1beta1.VideoIntelligenceService",
-                JSON.parse(f.read),
-                client_config,
-                Google::Gax::Grpc::STATUS_CODE_NAMES,
-                timeout,
-                errors: Google::Gax::Grpc::API_ERRORS,
-                metadata: headers
-              )
-            end
-
-            # Allow overriding the service path/port in subclasses.
-            service_path = service_address || self.class::SERVICE_ADDRESS
-            port = service_port || self.class::DEFAULT_SERVICE_PORT
-            interceptors = self.class::GRPC_INTERCEPTORS
-            @video_intelligence_service_stub = Google::Gax::Grpc.create_stub(
-              service_path,
-              port,
-              chan_creds: chan_creds,
-              channel: channel,
-              updater_proc: updater_proc,
-              scopes: scopes,
-              interceptors: interceptors,
-              &Google::Cloud::VideoIntelligence::V1beta1::VideoIntelligenceService::Stub.method(:new)
-            )
-
-            @annotate_video = Google::Gax.create_api_call(
-              @video_intelligence_service_stub.method(:annotate_video),
-              defaults["annotate_video"],
-              exception_transformer: exception_transformer
-            )
-          end
-
-          # Service calls
-
-          # Performs asynchronous video annotation. Progress and results can be
-          # retrieved through the `google.longrunning.Operations` interface.
-          # `Operation.metadata` contains `AnnotateVideoProgress` (progress).
-          # `Operation.response` contains `AnnotateVideoResponse` (results).
-          #
-          # @param input_uri [String]
-          #   Input video location. Currently, only
-          #   [Google Cloud Storage](https://cloud.google.com/storage/) URIs are
-          #   supported, which must be specified in the following format:
-          #   `gs://bucket-id/object-id` (other URI formats return
-          #   {Google::Rpc::Code::INVALID_ARGUMENT}). For
-          #   more information, see [Request URIs](https://cloud.google.com/storage/docs/reference-uris). A video
-          #   URI may include wildcards in `object-id`, and thus identify multiple
-          #   videos. Supported wildcards: '*' to match 0 or more characters;
-          #   '?' to match 1 character. If unset, the input video should be embedded
-          #   in the request as `input_content`. If set, `input_content` should be unset.
-          # @param features [Array<Google::Cloud::VideoIntelligence::V1beta1::Feature>]
-          #   Requested video annotation features.
-          # @param input_content [String]
-          #   The video data bytes. Encoding: base64. If unset, the input video(s)
-          #   should be specified via `input_uri`. If set, `input_uri` should be unset.
-          # @param video_context [Google::Cloud::VideoIntelligence::V1beta1::VideoContext | Hash]
-          #   Additional video context and/or feature-specific parameters.
-          #   A hash of the same form as `Google::Cloud::VideoIntelligence::V1beta1::VideoContext`
-          #   can also be provided.
-          # @param output_uri [String]
-          #   Optional location where the output (in JSON format) should be stored.
-          #   Currently, only [Google Cloud Storage](https://cloud.google.com/storage/)
-          #   URIs are supported, which must be specified in the following format:
-          #   `gs://bucket-id/object-id` (other URI formats return
-          #   {Google::Rpc::Code::INVALID_ARGUMENT}). For
-          #   more information, see [Request URIs](https://cloud.google.com/storage/docs/reference-uris).
-          # @param location_id [String]
-          #   Optional cloud region where annotation should take place. Supported cloud
-          #   regions: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no region
-          #   is specified, a region will be determined based on video file location.
-          # @param options [Google::Gax::CallOptions]
-          #   Overrides the default settings for this call, e.g, timeout,
-          #   retries, etc.
-          # @return [Google::Gax::Operation]
-          # @raise [Google::Gax::GaxError] if the RPC is aborted.
-          # @example
-          #   require "google/cloud/video_intelligence"
-          #
-          #   video_intelligence_client = Google::Cloud::VideoIntelligence.new(version: :v1beta1)
-          #   input_uri = "gs://cloud-samples-data/video/cat.mp4"
-          #   features_element = :LABEL_DETECTION
-          #   features = [features_element]
-          #
-          #   # Register a callback during the method call.
-          #   operation = video_intelligence_client.annotate_video(input_uri, features) do |op|
-          #     raise op.results.message if op.error?
-          #     op_results = op.results
-          #     # Process the results.
-          #
-          #     metadata = op.metadata
-          #     # Process the metadata.
-          #   end
-          #
-          #   # Or use the return value to register a callback.
-          #   operation.on_done do |op|
-          #     raise op.results.message if op.error?
-          #     op_results = op.results
-          #     # Process the results.
-          #
-          #     metadata = op.metadata
-          #     # Process the metadata.
-          #   end
-          #
-          #   # Manually reload the operation.
-          #   operation.reload!
-          #
-          #   # Or block until the operation completes, triggering callbacks on
-          #   # completion.
-          #   operation.wait_until_done!
-
-          def annotate_video \
-              input_uri,
-              features,
-              input_content: nil,
-              video_context: nil,
-              output_uri: nil,
-              location_id: nil,
-              options: nil
-            req = {
-              input_uri: input_uri,
-              features: features,
-              input_content: input_content,
-              video_context: video_context,
-              output_uri: output_uri,
-              location_id: location_id
-            }.delete_if { |_, v| v.nil? }
-            req = Google::Gax::to_proto(req, Google::Cloud::VideoIntelligence::V1beta1::AnnotateVideoRequest)
-            operation = Google::Gax::Operation.new(
-              @annotate_video.call(req, options),
-              @operations_client,
-              Google::Cloud::VideoIntelligence::V1beta1::AnnotateVideoResponse,
-              Google::Cloud::VideoIntelligence::V1beta1::AnnotateVideoProgress,
-              call_options: options
-            )
-            operation.on_done { |operation| yield(operation) } if block_given?
-            operation
-          end
-        end
-      end
-    end
-  end
-end