Class: Google::Cloud::VideoIntelligence::V1::VideoIntelligenceServiceClient

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

Overview

Service that implements Google Cloud Video Intelligence API.

Constant Summary collapse

SERVICE_ADDRESS =

The default address of the service.

"videointelligence.googleapis.com".freeze
DEFAULT_SERVICE_PORT =

The default port of the service.

443
DEFAULT_TIMEOUT = 
30
ALL_SCOPES =

The scopes needed to make gRPC calls to all of the methods defined in this service.

[
  "https://www.googleapis.com/auth/cloud-platform"
].freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(service_path: SERVICE_ADDRESS, port: DEFAULT_SERVICE_PORT, credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, lib_name: nil, lib_version: "") ⇒ VideoIntelligenceServiceClient

Returns a new instance of VideoIntelligenceServiceClient

Parameters:

  • credentials (Google::Auth::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::Auth::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.

  • scopes (Array<String>) —

    The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.

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

  • timeout (Numeric) —

    The default timeout, in seconds, for calls made through this client.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/google/cloud/video_intelligence/v1/video_intelligence_service_client.rb', line 84

def initialize \
    service_path: SERVICE_ADDRESS,
    port: DEFAULT_SERVICE_PORT,
    credentials: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    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/v1/video_intelligence_services_pb"

  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,
    timeout: timeout,
    lib_name: lib_name,
    lib_version: lib_version,
  )

  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::Auth::Credentials)
    updater_proc = credentials.updater_proc
  end

  google_api_client = "gl-ruby/#{RUBY_VERSION}"
  google_api_client << " #{lib_name}/#{lib_version}" if lib_name
  google_api_client << " gapic/0.1.0 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.v1.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::V1::VideoIntelligenceService::Stub.method(:new)
  )

  @annotate_video = Google::Gax.create_api_call(
    @video_intelligence_service_stub.method(:annotate_video),
    defaults["annotate_video"]
  )
end

Instance Attribute Details

#video_intelligence_service_stub ⇒ Google::Cloud::Videointelligence::V1::VideoIntelligenceService::Stub (readonly)

Returns:

  • (Google::Cloud::Videointelligence::V1::VideoIntelligenceService::Stub) 


43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
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
 
# File 'lib/google/cloud/video_intelligence/v1/video_intelligence_service_client.rb', line 43

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 credentials [Google::Auth::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::Auth::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 initialize \
      service_path: SERVICE_ADDRESS,
      port: DEFAULT_SERVICE_PORT,
      credentials: nil,
      scopes: ALL_SCOPES,
      client_config: {},
      timeout: DEFAULT_TIMEOUT,
      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/v1/video_intelligence_services_pb"

    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,
      timeout: timeout,
      lib_name: lib_name,
      lib_version: lib_version,
    )

    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::Auth::Credentials)
      updater_proc = credentials.updater_proc
    end

    google_api_client = "gl-ruby/#{RUBY_VERSION}"
    google_api_client << " #{lib_name}/#{lib_version}" if lib_name
    google_api_client << " gapic/0.1.0 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.v1.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::V1::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 input_content [String]
  #   The video data bytes.
  #   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::V1::Feature>]
  #   Requested video annotation features.
  # @param video_context [Google::Cloud::Videointelligence::V1::VideoContext | Hash]
  #   Additional video context and/or feature-specific parameters.
  #   A hash of the same form as `Google::Cloud::Videointelligence::V1::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/)
  #   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/v1"
  #
  #   video_intelligence_service_client = Google::Cloud::VideoIntelligence::V1.new
  #
  #   # Register a callback during the method call.
  #   operation = video_intelligence_service_client.annotate_video 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: nil,
      input_content: nil,
      features: nil,
      video_context: nil,
      output_uri: nil,
      location_id: nil,
      options: nil
    req = {
      input_uri: input_uri,
      input_content: input_content,
      features: features,
      video_context: video_context,
      output_uri: output_uri,
      location_id: location_id
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Cloud::Videointelligence::V1::AnnotateVideoRequest)
    operation = Google::Gax::Operation.new(
      @annotate_video.call(req, options),
      @operations_client,
      Google::Cloud::Videointelligence::V1::AnnotateVideoResponse,
      Google::Cloud::Videointelligence::V1::AnnotateVideoProgress,
      call_options: options
    )
    operation.on_done { |operation| yield(operation) } if block_given?
    operation
  end
end

Instance Method Details

#annotate_video(input_uri: nil, input_content: nil, features: nil, video_context: nil, output_uri: nil, location_id: nil, options: nil) ⇒ Google::Gax::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:

require "google/cloud/video_intelligence/v1"

video_intelligence_service_client = Google::Cloud::VideoIntelligence::V1.new

# Register a callback during the method call.
operation = video_intelligence_service_client.annotate_video 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!

Parameters:

  • input_uri (String) —

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

    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::V1::Feature>) —

    Requested video annotation features.

  • video_context (Google::Cloud::Videointelligence::V1::VideoContext | Hash) —

    Additional video context and/or feature-specific parameters. A hash of the same form as Google::Cloud::Videointelligence::V1::VideoContext can also be provided.

  • output_uri (String) —

    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 Rpc::Code::INVALID_ARGUMENT). For more information, see Request URIs.

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

  • options (Google::Gax::CallOptions) —

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

Returns:

  • (Google::Gax::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/google/cloud/video_intelligence/v1/video_intelligence_service_client.rb', line 244

def annotate_video \
    input_uri: nil,
    input_content: nil,
    features: nil,
    video_context: nil,
    output_uri: nil,
    location_id: nil,
    options: nil
  req = {
    input_uri: input_uri,
    input_content: input_content,
    features: features,
    video_context: video_context,
    output_uri: output_uri,
    location_id: location_id
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Videointelligence::V1::AnnotateVideoRequest)
  operation = Google::Gax::Operation.new(
    @annotate_video.call(req, options),
    @operations_client,
    Google::Cloud::Videointelligence::V1::AnnotateVideoResponse,
    Google::Cloud::Videointelligence::V1::AnnotateVideoProgress,
    call_options: options
  )
  operation.on_done { |operation| yield(operation) } if block_given?
  operation
end