Class: Google::Cloud::VideoIntelligence::V1p1beta1::VideoIntelligenceService::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/video_intelligence/v1p1beta1/video_intelligence_service/client.rb

Overview

Client for the VideoIntelligenceService service.

Service that implements Google Cloud Video Intelligence API.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new VideoIntelligenceService client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the VideoIntelligenceService client.

Yield Parameters:



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/google/cloud/video_intelligence/v1p1beta1/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/v1p1beta1/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::V1p1beta1::VideoIntelligenceService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Instance Attribute Details

#operations_client ⇒ ::Google::Cloud::VideoIntelligence::V1p1beta1::VideoIntelligenceService::Operations (readonly)

Get the associated client for long-running operations.

Returns:



159
160
161
 
# File 'lib/google/cloud/video_intelligence/v1p1beta1/video_intelligence_service/client.rb', line 159

def operations_client
  @operations_client
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the VideoIntelligenceService Client class.

See Configuration for a description of the configuration fields.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/google/cloud/video_intelligence/v1p1beta1/video_intelligence_service/client.rb', line 54

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "VideoIntelligence", "V1p1beta1"]
    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

Instance Method Details

#annotate_video(request, options = nil) ⇒ ::Gapic::Operation #annotate_video(input_uri: nil, input_content: nil, features: nil, video_context: nil, output_uri: nil, location_id: nil) ⇒ ::Gapic::Operation

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

Examples:

Basic example

require "google/cloud/video_intelligence/v1p1beta1"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::VideoIntelligence::V1p1beta1::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

Overloads:

  • #annotate_video(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to annotate_video via a request object, either of type AnnotateVideoRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::VideoIntelligence::V1p1beta1::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.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #annotate_video(input_uri: nil, input_content: nil, features: nil, video_context: nil, output_uri: nil, location_id: nil) ⇒ ::Gapic::Operation

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

    Parameters:

    • input_uri (::String) (defaults to: nil) —

      Input video location. Currently, only Google Cloud 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][google.rpc.Code.INVALID_ARGUMENT]). For more information, see Request 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.

    • input_content (::String) (defaults to: nil) —

      The video data bytes. If unset, the input video(s) should be specified via input_uri. If set, input_uri should be unset.

    • features (::Array<::Google::Cloud::VideoIntelligence::V1p1beta1::Feature>) (defaults to: nil) —

      Required. Requested video annotation features.

    • video_context (::Google::Cloud::VideoIntelligence::V1p1beta1::VideoContext, ::Hash) (defaults to: nil) —

      Additional video context and/or feature-specific parameters.

    • output_uri (::String) (defaults to: nil) —

      Optional. Location where the output (in JSON format) should be stored. Currently, only Google Cloud 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][google.rpc.Code.INVALID_ARGUMENT]). For more information, see Request URIs.

    • location_id (::String) (defaults to: nil) —

      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.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/google/cloud/video_intelligence/v1p1beta1/video_intelligence_service/client.rb', line 247

def annotate_video request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::VideoIntelligence::V1p1beta1::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::V1p1beta1::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| ... } ⇒ Client::Configuration

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

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



91
92
93
94
 
# File 'lib/google/cloud/video_intelligence/v1p1beta1/video_intelligence_service/client.rb', line 91

def configure
  yield @config if block_given?
  @config
end