Class: Google::Cloud::VideoIntelligence::V1::VideoIntelligenceService::Rest::Client

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

Overview

REST client for the VideoIntelligenceService service.

Service that implements the 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 REST client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the VideoIntelligenceService client.

Yield Parameters:



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/google/cloud/video_intelligence/v1/video_intelligence_service/rest/client.rb', line 129

def initialize
  # 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.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_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 = ::Google::Cloud::VideoIntelligence::V1::VideoIntelligenceService::Rest::Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
    config.universe_domain = @config.universe_domain
  end

  @video_intelligence_service_stub = ::Google::Cloud::VideoIntelligence::V1::VideoIntelligenceService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials
  )
end

Instance Attribute Details

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

Get the associated client for long-running operations.

Returns:



172
173
174
 
# File 'lib/google/cloud/video_intelligence/v1/video_intelligence_service/rest/client.rb', line 172

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::V1::VideoIntelligenceService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/google/cloud/video_intelligence/v1/video_intelligence_service/rest/client.rb', line 62

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

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

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

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

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
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::V1::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 Cloud 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. 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.

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

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

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

      Required. Requested video annotation features.

    • video_context (::Google::Cloud::VideoIntelligence::V1::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 Cloud 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.

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

      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.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

  • result (::Gapic::Operation)
  • operation (::Gapic::Rest::TransportOperation)

Returns:

  • (::Gapic::Operation)

Raises:

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

    if the REST call is aborted.



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/google/cloud/video_intelligence/v1/video_intelligence_service/rest/client.rb', line 260

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::VideoIntelligence::V1::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
  call_metadata = @config.rpcs.annotate_video.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_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::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.annotate_video.timeout,
                         metadata:     call_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.annotate_video request, options do |result, operation|
    result = ::Gapic::Operation.new result, @operations_client, options: options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => 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:



99
100
101
102
 
# File 'lib/google/cloud/video_intelligence/v1/video_intelligence_service/rest/client.rb', line 99

def configure
  yield @config if block_given?
  @config
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


109
110
111
 
# File 'lib/google/cloud/video_intelligence/v1/video_intelligence_service/rest/client.rb', line 109

def universe_domain
  @video_intelligence_service_stub.universe_domain
end