google-cloud-video_intelligence 1.0.0 → 1.1.0

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

@@ -1,4 +1,4 @@
-# Copyright 2017 Google LLC
+# Copyright 2018 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

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

@@ -1,4 +1,4 @@
-# Copyright 2017 Google LLC
+# Copyright 2018 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/video_intelligence/v1beta1/doc/overview.rb

@@ -1,4 +1,4 @@
-# Copyright 2017 Google LLC
+# Copyright 2018 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -17,7 +17,7 @@ module Google
     # rubocop:disable LineLength
 
     ##
-    # # Ruby Client for Google Cloud Video Intelligence API ([Beta](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
+    # # Ruby Client for Google Cloud Video Intelligence API ([GA](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
     #
     # [Google Cloud Video Intelligence API][Product Documentation]:
     # Google Cloud Video Intelligence API.
@@ -29,7 +29,7 @@ module Google
     #
     # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
     # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
-    # 3. [Enable the Google Cloud Video Intelligence API.](https://console.cloud.google.com/apis/api/video-intelligence)
+    # 3. [Enable the Google Cloud Video Intelligence API.](https://console.cloud.google.com/apis/library/videointelligence.googleapis.com)
     # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
     #
     # ### Installation
@@ -45,6 +45,31 @@ module Google
     #
     # [Product Documentation]: https://cloud.google.com/video-intelligence
     #
+    # ## Enabling Logging
+    #
+    # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
+    # The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
+    # or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
+    # that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
+    # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
+    #
+    # Configuring a Ruby stdlib logger:
+    #
+    # ```ruby
+    # require "logger"
+    #
+    # module MyLogger
+    #   LOGGER = Logger.new $stderr, level: Logger::WARN
+    #   def logger
+    #     LOGGER
+    #   end
+    # end
+    #
+    # # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
+    # module GRPC
+    #   extend MyLogger
+    # end
+    # ```
     #
     module VideoIntelligence
       module V1beta1

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

@@ -1,4 +1,4 @@
-# Copyright 2017 Google LLC
+# Copyright 2018 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -18,9 +18,6 @@
 # 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.
-#
-# The only allowed edits are to method and file documentation. A 3-way
-# merge preserves those additions if the generated source changes.
 
 require "json"
 require "pathname"
@@ -30,7 +27,7 @@ require "google/gax/operation"
 require "google/longrunning/operations_client"
 
 require "google/cloud/videointelligence/v1beta1/video_intelligence_pb"
-require "google/cloud/video_intelligence/credentials"
+require "google/cloud/video_intelligence/v1beta1/credentials"
 
 module Google
   module Cloud
@@ -49,6 +46,9 @@ module Google
           # 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
@@ -57,8 +57,10 @@ module Google
             "https://www.googleapis.com/auth/cloud-platform"
           ].freeze
 
+          # @private
           class OperationsClient < Google::Longrunning::OperationsClient
-            SERVICE_ADDRESS = SERVICE_ADDRESS
+            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]
@@ -85,11 +87,18 @@ module Google
           #   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 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,
+              exception_transformer: nil,
               lib_name: nil,
               lib_version: ""
             # These require statements are intentionally placed here to initialize
@@ -98,7 +107,7 @@ module Google
             require "google/gax/grpc"
             require "google/cloud/videointelligence/v1beta1/video_intelligence_services_pb"
 
-            credentials ||= Google::Cloud::VideoIntelligence::Credentials.default
+            credentials ||= Google::Cloud::VideoIntelligence::V1beta1::Credentials.default
 
             @operations_client = OperationsClient.new(
               credentials: credentials,
@@ -110,7 +119,7 @@ module Google
             )
 
             if credentials.is_a?(String) || credentials.is_a?(Hash)
-              updater_proc = Google::Cloud::VideoIntelligence::Credentials.new(credentials).updater_proc
+              updater_proc = Google::Cloud::VideoIntelligence::V1beta1::Credentials.new(credentials).updater_proc
             end
             if credentials.is_a?(GRPC::Core::Channel)
               channel = credentials
@@ -134,6 +143,7 @@ module Google
             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"
             )
@@ -145,13 +155,14 @@ module Google
                 Google::Gax::Grpc::STATUS_CODE_NAMES,
                 timeout,
                 errors: Google::Gax::Grpc::API_ERRORS,
-                kwargs: headers
+                metadata: headers
               )
             end
 
             # Allow overriding the service path/port in subclasses.
             service_path = self.class::SERVICE_ADDRESS
             port = self.class::DEFAULT_SERVICE_PORT
+            interceptors = self.class::GRPC_INTERCEPTORS
             @video_intelligence_service_stub = Google::Gax::Grpc.create_stub(
               service_path,
               port,
@@ -159,12 +170,14 @@ module Google
               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"]
+              defaults["annotate_video"],
+              exception_transformer: exception_transformer
             )
           end
 
@@ -212,9 +225,9 @@ module Google
           # @return [Google::Gax::Operation]
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/video_intelligence/v1beta1"
+          #   require "google/cloud/video_intelligence"
           #
-          #   video_intelligence_service_client = Google::Cloud::VideoIntelligence::V1beta1.new
+          #   video_intelligence_service_client = Google::Cloud::VideoIntelligence.new(version: :v1beta1)
           #   input_uri = "gs://demomaker/cat.mp4"
           #   features_element = :LABEL_DETECTION
           #   features = [features_element]

data/lib/google/cloud/video_intelligence/v1beta2.rb

@@ -1,4 +1,4 @@
-# Copyright 2017 Google LLC
+# Copyright 2018 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -13,37 +13,64 @@
 # limitations under the License.
 
 require "google/cloud/video_intelligence/v1beta2/video_intelligence_service_client"
+require "google/cloud/videointelligence/v1beta2/video_intelligence_pb"
+require "google/rpc/status_pb"
 
 module Google
   module Cloud
-    # rubocop:disable LineLength
-
-    ##
-    # # Ruby Client for Google Cloud Video Intelligence API ([Beta](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
-    #
-    # [Google Cloud Video Intelligence API][Product Documentation]:
-    # Google Cloud Video Intelligence API.
-    # - [Product Documentation][]
-    #
-    # ## Quick Start
-    # In order to use this library, you first need to go through the following
-    # steps:
-    #
-    # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
-    # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
-    # 3. [Enable the Google Cloud Video Intelligence API.](https://console.cloud.google.com/apis/api/video-intelligence)
-    # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
-    #
-    # ### Next Steps
-    # - Read the [Google Cloud Video Intelligence API Product documentation][Product Documentation]
-    #   to learn more about the product and see How-to Guides.
-    # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
-    #   to see the full list of Cloud APIs that we cover.
-    #
-    # [Product Documentation]: https://cloud.google.com/video-intelligence
-    #
-    #
     module VideoIntelligence
+      # rubocop:disable LineLength
+
+      ##
+      # # Ruby Client for Google Cloud Video Intelligence API ([GA](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
+      #
+      # [Google Cloud Video Intelligence API][Product Documentation]:
+      # Google Cloud Video Intelligence API.
+      # - [Product Documentation][]
+      #
+      # ## Quick Start
+      # In order to use this library, you first need to go through the following
+      # steps:
+      #
+      # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
+      # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
+      # 3. [Enable the Google Cloud Video Intelligence API.](https://console.cloud.google.com/apis/library/videointelligence.googleapis.com)
+      # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
+      #
+      # ### Next Steps
+      # - Read the [Google Cloud Video Intelligence API Product documentation][Product Documentation]
+      #   to learn more about the product and see How-to Guides.
+      # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
+      #   to see the full list of Cloud APIs that we cover.
+      #
+      # [Product Documentation]: https://cloud.google.com/video-intelligence
+      #
+      # ## Enabling Logging
+      #
+      # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
+      # The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
+      # or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
+      # that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
+      # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
+      #
+      # Configuring a Ruby stdlib logger:
+      #
+      # ```ruby
+      # require "logger"
+      #
+      # module MyLogger
+      #   LOGGER = Logger.new $stderr, level: Logger::WARN
+      #   def logger
+      #     LOGGER
+      #   end
+      # end
+      #
+      # # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
+      # module GRPC
+      #   extend MyLogger
+      # end
+      # ```
+      #
       module V1beta2
         # rubocop:enable LineLength
 
@@ -74,11 +101,18 @@ module Google
         #   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 exception_transformer [Proc]
+        #   An optional proc that intercepts any exceptions raised during an API call to inject
+        #   custom error handling.
         def self.new \
             credentials: nil,
             scopes: nil,
             client_config: nil,
             timeout: nil,
+            metadata: nil,
+            exception_transformer: nil,
             lib_name: nil,
             lib_version: nil
           kwargs = {
@@ -86,6 +120,8 @@ module Google
             scopes: scopes,
             client_config: client_config,
             timeout: timeout,
+            metadata: metadata,
+            exception_transformer: exception_transformer,
             lib_name: lib_name,
             lib_version: lib_version
           }.select { |_, v| v != nil }

data/lib/google/cloud/video_intelligence/v1beta2/credentials.rb

@@ -0,0 +1,40 @@
+# Copyright 2018 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.
+
+require "googleauth"
+
+module Google
+  module Cloud
+    module VideoIntelligence
+      module V1beta2
+        class Credentials < Google::Auth::Credentials
+          SCOPE = [
+            "https://www.googleapis.com/auth/cloud-platform"
+          ].freeze
+          PATH_ENV_VARS = %w(VIDEO_INTELLIGENCE_CREDENTIALS
+                             VIDEO_INTELLIGENCE_KEYFILE
+                             GOOGLE_CLOUD_CREDENTIALS
+                             GOOGLE_CLOUD_KEYFILE
+                             GCLOUD_KEYFILE)
+          JSON_ENV_VARS = %w(VIDEO_INTELLIGENCE_CREDENTIALS_JSON
+                             VIDEO_INTELLIGENCE_KEYFILE_JSON
+                             GOOGLE_CLOUD_CREDENTIALS_JSON
+                             GOOGLE_CLOUD_KEYFILE_JSON
+                             GCLOUD_KEYFILE_JSON)
+          DEFAULT_PATHS = ["~/.config/gcloud/application_default_credentials.json"]
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/video_intelligence/v1beta2/doc/google/cloud/videointelligence/v1beta2/video_intelligence.rb

@@ -1,4 +1,4 @@
-# Copyright 2017 Google LLC
+# Copyright 2018 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,17 +15,6 @@
 module Google
   module Cloud
     module Videointelligence
-      ##
-      # # Google Cloud Video Intelligence API Contents
-      #
-      # | Class | Description |
-      # | ----- | ----------- |
-      # | [VideoIntelligenceServiceClient][] | Google Cloud Video Intelligence API. |
-      # | [Data Types][] | Data types for Google::Cloud::VideoIntelligence::V1beta2 |
-      #
-      # [VideoIntelligenceServiceClient]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-video_intelligence/latest/google/cloud/videointelligence/v1beta2/videointelligenceserviceclient
-      # [Data Types]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-video_intelligence/latest/google/cloud/videointelligence/v1beta2/datatypes
-      #
       module V1beta2
         # Video annotation request.
         # @!attribute [rw] input_uri

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

@@ -0,0 +1,92 @@
+# Copyright 2018 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
+
+    # The request message for {Google::Longrunning::Operations::GetOperation Operations::GetOperation}.
+    # @!attribute [rw] name
+    #   @return [String]
+    #     The name of the operation resource.
+    class GetOperationRequest; end
+
+    # The request message for {Google::Longrunning::Operations::ListOperations Operations::ListOperations}.
+    # @!attribute [rw] name
+    #   @return [String]
+    #     The name of the operation collection.
+    # @!attribute [rw] filter
+    #   @return [String]
+    #     The standard list filter.
+    # @!attribute [rw] page_size
+    #   @return [Integer]
+    #     The standard list page size.
+    # @!attribute [rw] page_token
+    #   @return [String]
+    #     The standard list page token.
+    class ListOperationsRequest; end
+
+    # The response message for {Google::Longrunning::Operations::ListOperations Operations::ListOperations}.
+    # @!attribute [rw] operations
+    #   @return [Array<Google::Longrunning::Operation>]
+    #     A list of operations that matches the specified filter in the request.
+    # @!attribute [rw] next_page_token
+    #   @return [String]
+    #     The standard List next-page token.
+    class ListOperationsResponse; end
+
+    # The request message for {Google::Longrunning::Operations::CancelOperation Operations::CancelOperation}.
+    # @!attribute [rw] name
+    #   @return [String]
+    #     The name of the operation resource to be cancelled.
+    class CancelOperationRequest; end
+
+    # The request message for {Google::Longrunning::Operations::DeleteOperation Operations::DeleteOperation}.
+    # @!attribute [rw] name
+    #   @return [String]
+    #     The name of the operation resource to be deleted.
+    class DeleteOperationRequest; end
+  end
+end