class Google::Cloud::VideoIntelligence::V1p3beta1::VideoIntelligenceService::Client

Client for the VideoIntelligenceService service.

Service that implements the Video Intelligence API.

Attributes

operations_client[R]

Get the associated client for long-running operations.

@return [::Google::Cloud::VideoIntelligence::V1p3beta1::VideoIntelligenceService::Operations]

video_intelligence_service_stub[R]

@private

Public Class Methods

configure() { |configure| ... } click to toggle source

Configure the VideoIntelligenceService Client class.

See {::Google::Cloud::VideoIntelligence::V1p3beta1::VideoIntelligenceService::Client::Configuration} for a description of the configuration fields.

@example

# Modify the configuration for all VideoIntelligenceService clients
::Google::Cloud::VideoIntelligence::V1p3beta1::VideoIntelligenceService::Client.configure do |config|
  config.timeout = 10.0
end

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/video_intelligence/v1p3beta1/video_intelligence_service/client.rb, line 54
def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "VideoIntelligence", "V1p3beta1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.rpcs.annotate_video.timeout = 600.0
    default_config.rpcs.annotate_video.retry_policy = {
      initial_delay: 1.0, max_delay: 120.0, multiplier: 2.5, retry_codes: [14, 4]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end
new() { |config| ... } click to toggle source

Create a new VideoIntelligenceService client object.

@example

# Create a client using the default configuration
client = ::Google::Cloud::VideoIntelligence::V1p3beta1::VideoIntelligenceService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::VideoIntelligence::V1p3beta1::VideoIntelligenceService::Client.new do |config|
  config.timeout = 10.0
end

@yield [config] Configure the VideoIntelligenceService client. @yieldparam config [Client::Configuration]

# File lib/google/cloud/video_intelligence/v1p3beta1/video_intelligence_service/client.rb, line 112
def initialize
  # 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 "gapic/grpc"
  require "google/cloud/videointelligence/v1p3beta1/video_intelligence_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                           !@config.endpoint.split(".").first.include?("-")
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @operations_client = Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
  end

  @video_intelligence_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::VideoIntelligence::V1p3beta1::VideoIntelligenceService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Public Instance Methods

annotate_video(request, options = nil) { |response, operation| ... } click to toggle source

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).

@overload annotate_video(request, options = nil)

Pass arguments to `annotate_video` via a request object, either of type
{::Google::Cloud::VideoIntelligence::V1p3beta1::AnnotateVideoRequest} or an equivalent Hash.

@param request [::Google::Cloud::VideoIntelligence::V1p3beta1::AnnotateVideoRequest, ::Hash]
  A request object representing the call parameters. Required. To specify no
  parameters, or to keep all the default parameter values, pass an empty Hash.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload annotate_video(input_uri: nil, input_content: nil, features: nil, video_context: nil, output_uri: nil, location_id: nil)

Pass arguments to `annotate_video` via keyword arguments. Note that at
least one keyword argument is required. To specify no parameters, or to keep all
the default parameter values, pass an empty Hash as a request object (see above).

@param input_uri [::String]
  Input video location. Currently, only
  [Cloud Storage](https://cloud.google.com/storage/) URIs are
  supported. URIs must be specified in the following format:
  `gs://bucket-id/object-id` (other URI formats return
  [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For
  more information, see [Request
  URIs](https://cloud.google.com/storage/docs/request-endpoints). To identify
  multiple videos, a video URI may include wildcards in the `object-id`.
  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` must be unset.
@param input_content [::String]
  The video data bytes.
  If unset, the input video(s) should be specified via the `input_uri`.
  If set, `input_uri` must be unset.
@param features [::Array<::Google::Cloud::VideoIntelligence::V1p3beta1::Feature>]
  Required. Requested video annotation features.
@param video_context [::Google::Cloud::VideoIntelligence::V1p3beta1::VideoContext, ::Hash]
  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 [Cloud Storage](https://cloud.google.com/storage/)
  URIs are supported. These must be specified in the following format:
  `gs://bucket-id/object-id` (other URI formats return
  [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]). For
  more information, see [Request
  URIs](https://cloud.google.com/storage/docs/request-endpoints).
@param location_id [::String]
  Optional. Cloud region where annotation should take place. Supported cloud
  regions are: `us-east1`, `us-west1`, `europe-west1`, `asia-east1`. If no
  region is specified, the region will be determined based on video file
  location.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Gapic::Operation] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Gapic::Operation]

@raise [::Google::Cloud::Error] if the RPC is aborted.

@example Basic example

require "google/cloud/video_intelligence/v1p3beta1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::VideoIntelligence::V1p3beta1::VideoIntelligenceService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VideoIntelligence::V1p3beta1::AnnotateVideoRequest.new

# Call the annotate_video method.
result = client.annotate_video request

# The returned object is of type Gapic::Operation. You can use this
# object to check the status of an operation, cancel it, or wait
# for results. Here is how to block until completion:
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "Error!"
end
# File lib/google/cloud/video_intelligence/v1p3beta1/video_intelligence_service/client.rb, line 248
def annotate_video request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::VideoIntelligence::V1p3beta1::AnnotateVideoRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.annotate_video.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::VideoIntelligence::V1p3beta1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.annotate_video.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.annotate_video.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @video_intelligence_service_stub.call_rpc :annotate_video, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end
configure() { |config| ... } click to toggle source

Configure the VideoIntelligenceService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on {Client.configure}.

See {::Google::Cloud::VideoIntelligence::V1p3beta1::VideoIntelligenceService::Client::Configuration} for a description of the configuration fields.

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/video_intelligence/v1p3beta1/video_intelligence_service/client.rb, line 91
def configure
  yield @config if block_given?
  @config
end