RubyGems - google-cloud-video_intelligence - Versions diffs - 0.22.0 → 0.23.0 - Mend

google-cloud-video_intelligence 0.22.0 → 0.23.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (16) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '0528c58f3c19e758c482d7b308194497a8a2d271'
-  data.tar.gz: 50ae9c0cbed07324df3fe5cfa3de8421022b469c
+  metadata.gz: a19ec0a75a0302b5f7117fc05bbffa67fe0d732a
+  data.tar.gz: ee059f64f413d6752ac91db1ddef5fa4920de100
 SHA512:
-  metadata.gz: 98aa437537080fd57492fcf4161167d357d9e34227f33dd482db23b9e1a1d1f5522510faa22bc0d422c89867a9e04f1a260e7c43cd6c451fa31bc1b3c2a815d9
-  data.tar.gz: 1c705eca2f8940bf5c9653d40a62e8f055807cb59b40a11d0f39cf1e9cea848e3ed563d3d1561a11922bf082d84a17e5ef66aab289b7dee70584aecc904da107
+  metadata.gz: 15f41f0ce2b8399dba88a0e7cdd0a3d5dfa4dce673c677d68acfbcb2f14b4b01bc3ca3d6fde1c9b0a9c59c46db84476d90aa1e0f74c75746dd2f56af94bceb1c
+  data.tar.gz: 1c6bde9c9911eca52d74fc57dd9d4e12e878991f10ec52b81224bbd19c49485956fe3f28e04df67ab8e7832f2d4f55464c7fb55c0863a593486ebedf7a48c46b

data/README.md CHANGED Viewed

@@ -18,6 +18,44 @@ steps:
 $ gem install google-cloud-video_intelligence
 ```
+### Preview
+#### VideoIntelligenceServiceClient
+```rb
+ require "google/cloud/video_intelligence/v1beta2"
+ video_intelligence_service_client = Google::Cloud::VideoIntelligence.new
+ input_uri = "gs://cloud-ml-sandbox/video/chicago.mp4"
+ features_element = :LABEL_DETECTION
+ features = [features_element]
+ # Register a callback during the method call.
+ operation = video_intelligence_service_client.annotate_video(input_uri: input_uri, features: 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!
+```
 ### Next Steps
 - Read the [Client Library Documentation][] for Google Cloud Video Intelligence API
   to see other available methods on the client.

data/lib/google/cloud/video_intelligence.rb CHANGED Viewed

@@ -34,9 +34,42 @@ module Google
     # 2. [Enable the Google Cloud Video Intelligence API.](https://console.cloud.google.com/apis/api/video-intelligence)
     # 3. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
     #
-    # ### Installation
-    # ```
-    # $ gem install google-cloud-video_intelligence
+    # ### Preview
+    # #### VideoIntelligenceServiceClient
+    # ```rb
+    # require "google/cloud/video_intelligence"
+    #
+    # video_intelligence_service_client = Google::Cloud::VideoIntelligence.new
+    # input_uri = "gs://cloud-ml-sandbox/video/chicago.mp4"
+    # features_element = :LABEL_DETECTION
+    # features = [features_element]
+    #
+    # # Register a callback during the method call.
+    # operation = video_intelligence_service_client.annotate_video(input_uri: input_uri, features: 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!
     # ```
     #
     # ### Next Steps
@@ -54,20 +87,19 @@ module Google
       FILE_DIR = File.realdirpath(Pathname.new(__FILE__).join("..").join("video_intelligence"))
       AVAILABLE_VERSIONS = Dir["#{FILE_DIR}/*"]
-        .select {|file| File.directory?(file)}
-        .select {|dir| Google::Gax::VERSION_MATCHER.match(File.basename(dir))}
-        .select {|dir| File.exist?(dir + ".rb")}
-        .map {|dir| File.basename(dir)}
+        .select { |file| File.directory?(file) }
+        .select { |dir| Google::Gax::VERSION_MATCHER.match(File.basename(dir)) }
+        .select { |dir| File.exist?(dir + ".rb") }
+        .map { |dir| File.basename(dir) }
       ##
       # Service that implements Google Cloud Video Intelligence API.
       #
-      # @overload self.new(version: :v1beta2, credentials: nil, scopes: nil, client_config: nil, timeout: nil)
-      #   @param version [Symbol, String]
-      #     The major version of the service to be used. By default :v1beta2
-      #     is used.
-      #   @param credentials
-      #     [Google::Gax::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
+      # @param version [Symbol, String]
+      #   The major version of the service to be used. By default :v1beta2
+      #   is used.
+      # @overload
+      #   @param credentials [Google::Gax::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::Gax::Credentials` uses a the properties of its represented keyfile for

data/lib/google/cloud/video_intelligence/v1beta1.rb CHANGED Viewed

@@ -1,4 +1,5 @@
 # Copyright 2017, Google Inc. All rights reserved.
+#
 # 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
@@ -12,3 +13,99 @@
 # limitations under the License.
 require "google/cloud/video_intelligence/v1beta1/video_intelligence_service_client"
+module Google
+  module Cloud
+    # rubocop:disable LineLength
+    ##
+    # # Ruby Client for Google Cloud Video Intelligence API ([Alpha](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 the Google Cloud Video Intelligence API.](https://console.cloud.google.com/apis/api/video-intelligence)
+    # 3. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
+    #
+    # ### Installation
+    # ```
+    # $ gem install google-cloud-video_intelligence
+    # ```
+    #
+    # ### 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
+      module V1beta1
+        # rubocop:enable LineLength
+        ##
+        # Service that implements Google Cloud Video Intelligence API.
+        #
+        # @param credentials [Google::Gax::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::Gax::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.
+        def self.new \
+            service_path: nil,
+            port: nil,
+            channel: nil,
+            chan_creds: nil,
+            updater_proc: nil,
+            credentials: nil,
+            scopes: nil,
+            client_config: nil,
+            timeout: nil,
+            lib_name: nil,
+            lib_version: nil
+          kwargs = {
+            service_path: service_path,
+            port: port,
+            channel: channel,
+            chan_creds: chan_creds,
+            updater_proc: updater_proc,
+            credentials: credentials,
+            scopes: scopes,
+            client_config: client_config,
+            timeout: timeout,
+            lib_name: lib_name,
+            lib_version: lib_version
+          }.select { |_, v| v != nil }
+          Google::Cloud::VideoIntelligence::V1beta1::VideoIntelligenceServiceClient.new(**kwargs)
+        end
+      end
+    end
+  end
+end

data/lib/google/cloud/video_intelligence/v1beta1/doc/google/cloud/videointelligence/v1beta1/video_intelligence.rb CHANGED Viewed

@@ -15,16 +15,27 @@
 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::V1beta1 |
+      #
+      # [VideoIntelligenceServiceClient]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-video_intelligence/latest/google/cloud/videointelligence/v1beta1/videointelligenceserviceclient
+      # [Data Types]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-video_intelligence/latest/google/cloud/videointelligence/v1beta1/datatypes
+      #
       module V1beta1
         # Video annotation request.
         # @!attribute [rw] input_uri
         #   @return [String]
         #     Input video location. Currently, only
-        #     {Google Cloud Storage}[https://cloud.google.com/storage/] URIs are
+        #     [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].
+        #     {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
@@ -42,11 +53,11 @@ module Google
         # @!attribute [rw] output_uri
         #   @return [String]
         #     Optional location where the output (in JSON format) should be stored.
-        #     Currently, only {Google Cloud Storage}[https://cloud.google.com/storage/]
+        #     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].
+        #     {Google::Rpc::Code::INVALID_ARGUMENT}). For more information, see
+        #     [Request URIs](https://cloud.google.com/storage/docs/reference-uris).
         # @!attribute [rw] location_id
         #   @return [String]
         #     Optional cloud region where annotation should take place. Supported cloud
@@ -191,7 +202,7 @@ module Google
         # @!attribute [rw] input_uri
         #   @return [String]
         #     Video file location in
-        #     {Google Cloud Storage}[https://cloud.google.com/storage/].
+        #     [Google Cloud Storage](https://cloud.google.com/storage/).
         # @!attribute [rw] label_annotations
         #   @return [Array<Google::Cloud::Videointelligence::V1beta1::LabelAnnotation>]
         #     Label annotations. There is exactly one element for each unique label.
@@ -222,7 +233,7 @@ module Google
         # @!attribute [rw] input_uri
         #   @return [String]
         #     Video file location in
-        #     {Google Cloud Storage}[https://cloud.google.com/storage/].
+        #     [Google Cloud Storage](https://cloud.google.com/storage/).
         # @!attribute [rw] progress_percent
         #   @return [Integer]
         #     Approximate percentage processed thus far.

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

@@ -49,6 +49,16 @@ module Google
     #       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 '/'
@@ -77,7 +87,7 @@ module Google
     # 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):
+    # field. Example (for message {Google::Protobuf::Duration}):
     #
     #     {
     #       "@type": "type.googleapis.com/google.protobuf.Duration",
@@ -96,7 +106,7 @@ module Google
     #       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).
-    #     * An HTTP GET on the URL must yield a Google::Protobuf::Type
+    #     * 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

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

@@ -16,7 +16,7 @@ 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:
+    # [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
@@ -25,13 +25,13 @@ module Google
     #
     # 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
+    # {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+ which can be used for common error conditions.
+    # in the package +google.rpc+ that can be used for common error conditions.
     #
     # = Language mapping
     #
@@ -54,7 +54,7 @@ module Google
     #   errors.
     #
     # * Workflow errors. A typical workflow has multiple steps. Each step may
-    #   have a +Status+ message for error reporting purpose.
+    #   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
@@ -68,16 +68,16 @@ module Google
     #   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.
+    #     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.
+    #     {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 will be a
-    #     common set of message types for APIs to use.
+    #     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 CHANGED Viewed

@@ -30,6 +30,7 @@ require "google/gax/operation"
 require "google/longrunning/operations_client"
 require "google/cloud/videointelligence/v1beta1/video_intelligence_pb"
+require "google/cloud/video_intelligence/credentials"
 module Google
   module Cloud
@@ -56,17 +57,20 @@ module Google
             "https://www.googleapis.com/auth/cloud-platform"
           ].freeze
-          # @param service_path [String]
-          #   The domain name of the API remote host.
-          # @param port [Integer]
-          #   The port on which to connect to the remote host.
-          # @param channel [Channel]
-          #   A Channel object through which to make calls.
-          # @param chan_creds [Grpc::ChannelCredentials]
-          #   A ChannelCredentials for the setting up the RPC client.
-          # @param updater_proc [Proc]
-          #   A function that transforms the metadata for requests, e.g., to give
-          #   OAuth credentials.
+          # @param credentials [Google::Gax::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::Gax::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.
@@ -83,11 +87,10 @@ module Google
               channel: nil,
               chan_creds: nil,
               updater_proc: nil,
+              credentials: nil,
               scopes: ALL_SCOPES,
               client_config: {},
               timeout: DEFAULT_TIMEOUT,
-              app_name: nil,
-              app_version: nil,
               lib_name: nil,
               lib_version: ""
             # These require statements are intentionally placed here to initialize
@@ -96,23 +99,43 @@ module Google
             require "google/gax/grpc"
             require "google/cloud/videointelligence/v1beta1/video_intelligence_services_pb"
+            if channel || chan_creds || updater_proc
+              warn "The `channel`, `chan_creds`, and `updater_proc` parameters will be removed " \
+                "on 2017/09/08"
+              credentials ||= channel
+              credentials ||= chan_creds
+              credentials ||= updater_proc
+            end
+            if service_path != SERVICE_ADDRESS || port != DEFAULT_SERVICE_PORT
+              warn "`service_path` and `port` parameters are deprecated and will be removed"
+            end
+            credentials ||= Google::Cloud::VideoIntelligence::Credentials.default
             @operations_client = Google::Longrunning::OperationsClient.new(
               service_path: service_path,
-              port: port,
-              channel: channel,
-              chan_creds: chan_creds,
-              updater_proc: updater_proc,
+              credentials: credentials,
               scopes: scopes,
               client_config: client_config,
               timeout: timeout,
-              app_name: app_name,
-              app_version: app_version,
               lib_name: lib_name,
               lib_version: lib_version,
             )
-            if app_name || app_version
-              warn "`app_name` and `app_version` are no longer being used in the request headers."
+            if credentials.is_a?(String) || credentials.is_a?(Hash)
+              updater_proc = Google::Cloud::VideoIntelligence::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::Gax::Credentials)
+              updater_proc = credentials.updater_proc
             end
             google_api_client = "gl-ruby/#{RUBY_VERSION}"
@@ -161,11 +184,11 @@ module Google
           #
           # @param input_uri [String]
           #   Input video location. Currently, only
-          #   {Google Cloud Storage}[https://cloud.google.com/storage/] URIs are
+          #   [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].
+          #   {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
@@ -175,15 +198,17 @@ module Google
           # @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]
+          # @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/]
+          #   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].
+          #   {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
@@ -196,7 +221,7 @@ module Google
           # @example
           #   require "google/cloud/video_intelligence/v1beta1"
           #
-          #   video_intelligence_service_client = Google::Cloud::VideoIntelligence::V1beta1::VideoIntelligenceServiceClient.new
+          #   video_intelligence_service_client = Google::Cloud::VideoIntelligence::V1beta1.new
           #   input_uri = ''
           #   features = []
           #
@@ -235,14 +260,15 @@ module Google
               output_uri: nil,
               location_id: nil,
               options: nil
-            req = Google::Cloud::Videointelligence::V1beta1::AnnotateVideoRequest.new({
+            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? })
+            }.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,

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

@@ -33,9 +33,42 @@ module Google
     # 2. [Enable the Google Cloud Video Intelligence API.](https://console.cloud.google.com/apis/api/video-intelligence)
     # 3. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
     #
-    # ### Installation
-    # ```
-    # $ gem install google-cloud-video_intelligence
+    # ### Preview
+    # #### VideoIntelligenceServiceClient
+    # ```rb
+    # require "google/cloud/video_intelligence/v1beta2"
+    #
+    # video_intelligence_service_client = Google::Cloud::VideoIntelligence.new
+    # input_uri = "gs://cloud-ml-sandbox/video/chicago.mp4"
+    # features_element = :LABEL_DETECTION
+    # features = [features_element]
+    #
+    # # Register a callback during the method call.
+    # operation = video_intelligence_service_client.annotate_video(input_uri: input_uri, features: 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!
     # ```
     #
     # ### Next Steps
@@ -48,51 +81,62 @@ module Google
     #
     #
     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/v1beta2/videointelligenceserviceclient
-      # [Data Types]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-video_intelligence/latest/google/cloud/videointelligence/v1beta2/v1beta2/datatypes
-      #
       module V1beta2
         # rubocop:enable LineLength
         ##
         # Service that implements Google Cloud Video Intelligence API.
         #
-        # @overload self.new(credentials: nil, scopes: nil, client_config: nil, timeout: nil)
-        #   @param credentials
-        #     [Google::Gax::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::Gax::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.
-        def self.new(*args, **kwargs)
-          Google::Cloud::VideoIntelligence::V1beta2::VideoIntelligenceServiceClient.new(*args, **kwargs)
+        # @param credentials [Google::Gax::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::Gax::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.
+        def self.new \
+            service_path: nil,
+            port: nil,
+            channel: nil,
+            chan_creds: nil,
+            updater_proc: nil,
+            credentials: nil,
+            scopes: nil,
+            client_config: nil,
+            timeout: nil,
+            lib_name: nil,
+            lib_version: nil
+          kwargs = {
+            service_path: service_path,
+            port: port,
+            channel: channel,
+            chan_creds: chan_creds,
+            updater_proc: updater_proc,
+            credentials: credentials,
+            scopes: scopes,
+            client_config: client_config,
+            timeout: timeout,
+            lib_name: lib_name,
+            lib_version: lib_version
+          }.select { |_, v| v != nil }
+          Google::Cloud::VideoIntelligence::V1beta2::VideoIntelligenceServiceClient.new(**kwargs)
         end
       end
     end

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

@@ -15,6 +15,17 @@
 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/protobuf/any.rb CHANGED Viewed

@@ -49,6 +49,16 @@ module Google
     #       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 '/'

data/lib/google/cloud/video_intelligence/v1beta2/doc/google/protobuf/duration.rb CHANGED Viewed

@@ -21,6 +21,8 @@ module Google
     # two Timestamp values is a Duration and it can be added or subtracted
     # from a Timestamp. Range is approximately +-10,000 years.
     #
+    # = Examples
+    #
     # Example 1: Compute Duration from two Timestamps in pseudo code.
     #
     #     Timestamp start = ...;
@@ -60,10 +62,21 @@ module Google
     #     td = datetime.timedelta(days=3, minutes=10)
     #     duration = Duration()
     #     duration.FromTimedelta(td)
+    #
+    # = JSON Mapping
+    #
+    # In JSON format, the Duration type is encoded as a string rather than an
+    # object, where the string ends in the suffix "s" (indicating seconds) and
+    # is preceded by the number of seconds, with nanoseconds expressed as
+    # fractional seconds. For example, 3 seconds with 0 nanoseconds should be
+    # encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
+    # be expressed in JSON format as "3.000000001s", and 3 seconds and 1
+    # microsecond should be expressed in JSON format as "3.000001s".
     # @!attribute [rw] seconds
     #   @return [Integer]
     #     Signed seconds of the span of time. Must be from -315,576,000,000
-    #     to +315,576,000,000 inclusive.
+    #     to +315,576,000,000 inclusive. Note: these bounds are computed from:
+    #     60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
     # @!attribute [rw] nanos
     #   @return [Integer]
     #     Signed fractions of a second at nanosecond resolution of the span

data/lib/google/cloud/video_intelligence/v1beta2/doc/google/rpc/status.rb CHANGED Viewed

@@ -31,7 +31,7 @@ module Google
     # 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+ which can be used for common error conditions.
+    # in the package +google.rpc+ that can be used for common error conditions.
     #
     # = Language mapping
     #
@@ -54,7 +54,7 @@ module Google
     #   errors.
     #
     # * Workflow errors. A typical workflow has multiple steps. Each step may
-    #   have a +Status+ message for error reporting purpose.
+    #   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
@@ -76,8 +76,8 @@ module Google
     #     {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 will be a
-    #     common set of message types for APIs to use.
+    #     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/v1beta2/doc/overview.rb ADDED Viewed

@@ -0,0 +1,91 @@
+# Copyright 2017, Google Inc. All rights reserved.
+#
+# 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
+#
+#     http://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 Cloud
+    # rubocop:disable LineLength
+    ##
+    # # Ruby Client for Google Cloud Video Intelligence API ([Alpha](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 the Google Cloud Video Intelligence API.](https://console.cloud.google.com/apis/api/video-intelligence)
+    # 3. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
+    #
+    # ### Installation
+    # ```
+    # $ gem install google-cloud-video_intelligence
+    # ```
+    #
+    # ### Preview
+    # #### VideoIntelligenceServiceClient
+    # ```rb
+    # require "google/cloud/video_intelligence"
+    #
+    # video_intelligence_service_client = Google::Cloud::VideoIntelligence.new
+    # input_uri = "gs://cloud-ml-sandbox/video/chicago.mp4"
+    # features_element = :LABEL_DETECTION
+    # features = [features_element]
+    #
+    # # Register a callback during the method call.
+    # operation = video_intelligence_service_client.annotate_video(input_uri: input_uri, features: 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!
+    # ```
+    #
+    # ### 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
+      module V1beta2
+      end
+    end
+  end
+end

data/lib/google/cloud/video_intelligence/v1beta2/video_intelligence_service_client.rb CHANGED Viewed

@@ -106,13 +106,14 @@ module Google
               credentials ||= chan_creds
               credentials ||= updater_proc
             end
-            if service_path || port
+            if service_path != SERVICE_ADDRESS || port != DEFAULT_SERVICE_PORT
               warn "`service_path` and `port` parameters are deprecated and will be removed"
             end
             credentials ||= Google::Cloud::VideoIntelligence::Credentials.default
             @operations_client = Google::Longrunning::OperationsClient.new(
+              service_path: service_path,
               credentials: credentials,
               scopes: scopes,
               client_config: client_config,
@@ -192,11 +193,11 @@ module Google
           #   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::V1beta2::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 features [Array<Google::Cloud::Videointelligence::V1beta2::Feature>]
+          #   Requested video annotation features.
           # @param video_context [Google::Cloud::Videointelligence::V1beta2::VideoContext | Hash]
           #   Additional video context and/or feature-specific parameters.
           #   A hash of the same form as `Google::Cloud::Videointelligence::V1beta2::VideoContext`
@@ -221,11 +222,9 @@ module Google
           #   require "google/cloud/video_intelligence/v1beta2"
           #
           #   video_intelligence_service_client = Google::Cloud::VideoIntelligence::V1beta2.new
-          #   input_uri = ''
-          #   features = []
           #
           #   # Register a callback during the method call.
-          #   operation = video_intelligence_service_client.annotate_video(input_uri, features) do |op|
+          #   operation = video_intelligence_service_client.annotate_video do |op|
           #     raise op.results.message if op.error?
           #     op_results = op.results
           #     # Process the results.
@@ -252,17 +251,17 @@ module Google
           #   operation.wait_until_done!
           def annotate_video \
-              input_uri,
-              features,
+              input_uri: nil,
               input_content: nil,
+              features: nil,
               video_context: nil,
               output_uri: nil,
               location_id: nil,
               options: nil
             req = {
               input_uri: input_uri,
-              features: features,
               input_content: input_content,
+              features: features,
               video_context: video_context,
               output_uri: output_uri,
               location_id: location_id

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-video_intelligence
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.23.0
 platform: ruby
 authors:
 - Google Inc
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-09-07 00:00:00.000000000 Z
+date: 2017-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-gax
@@ -131,6 +131,7 @@ files:
 - lib/google/cloud/video_intelligence/v1beta2/doc/google/protobuf/any.rb
 - lib/google/cloud/video_intelligence/v1beta2/doc/google/protobuf/duration.rb
 - lib/google/cloud/video_intelligence/v1beta2/doc/google/rpc/status.rb
+- lib/google/cloud/video_intelligence/v1beta2/doc/overview.rb
 - lib/google/cloud/video_intelligence/v1beta2/video_intelligence_service_client.rb
 - lib/google/cloud/video_intelligence/v1beta2/video_intelligence_service_client_config.json
 - lib/google/cloud/videointelligence/v1beta1/video_intelligence_pb.rb