# 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. # # 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. # # 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" require "google/gax" require "google/gax/operation" require "google/longrunning/operations_client" require "google/cloud/videointelligence/v1beta1/video_intelligence_pb" 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 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 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 # @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 scopes [Array] # 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 initialize \ service_path: SERVICE_ADDRESS, port: DEFAULT_SERVICE_PORT, channel: nil, chan_creds: nil, updater_proc: 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 # 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" @operations_client = Google::Longrunning::OperationsClient.new( service_path: service_path, port: port, channel: channel, chan_creds: chan_creds, updater_proc: updater_proc, 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." end google_api_client = "gl-ruby/#{RUBY_VERSION}" google_api_client << " #{lib_name}/#{lib_version}" if lib_name google_api_client << " gapic/0.6.8 gax/#{Google::Gax::VERSION}" google_api_client << " grpc/#{GRPC::VERSION}" google_api_client.freeze headers = { :"x-goog-api-client" => google_api_client } 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, kwargs: headers ) end @video_intelligence_service_stub = Google::Gax::Grpc.create_stub( service_path, port, chan_creds: chan_creds, channel: channel, updater_proc: updater_proc, scopes: scopes, &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"] ) 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] # 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] # Additional video context and/or feature-specific parameters. # @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/v1beta1" # # video_intelligence_service_client = Google::Cloud::VideoIntelligence::V1beta1::VideoIntelligenceServiceClient.new # input_uri = '' # features = [] # # # Register a callback during the method call. # operation = video_intelligence_service_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 = Google::Cloud::Videointelligence::V1beta1::AnnotateVideoRequest.new({ 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? }) 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