Class: Google::Apis::VideointelligenceV1::CloudVideoIntelligenceService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
generated/google/apis/videointelligence_v1/service.rb

Overview

Cloud Video Intelligence API

Detects objects, explicit content, and scene changes in videos. It also specifies the region for annotation and transcribes speech to text.

Examples:

require 'google/apis/videointelligence_v1'

Videointelligence = Google::Apis::VideointelligenceV1 # Alias the module
service = Videointelligence::CloudVideoIntelligenceService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializeCloudVideoIntelligenceService


46
47
48
49
# File 'generated/google/apis/videointelligence_v1/service.rb', line 46

def initialize
  super('https://videointelligence.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#keyString


39
40
41
# File 'generated/google/apis/videointelligence_v1/service.rb', line 39

def key
  @key
end

#quota_userString


44
45
46
# File 'generated/google/apis/videointelligence_v1/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#annotate_video(google_cloud_videointelligence_v1_annotate_video_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VideointelligenceV1::GoogleLongrunningOperation

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

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


227
228
229
230
231
232
233
234
235
236
# File 'generated/google/apis/videointelligence_v1/service.rb', line 227

def annotate_video(google_cloud_videointelligence_v1_annotate_video_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/videos:annotate', options)
  command.request_representation = Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1AnnotateVideoRequest::Representation
  command.request_object = google_cloud_videointelligence_v1_annotate_video_request_object
  command.response_representation = Google::Apis::VideointelligenceV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::VideointelligenceV1::GoogleLongrunningOperation
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#cancel_operation(name, google_longrunning_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VideointelligenceV1::GoogleProtobufEmpty

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


81
82
83
84
85
86
87
88
89
90
91
# File 'generated/google/apis/videointelligence_v1/service.rb', line 81

def cancel_operation(name, google_longrunning_cancel_operation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1/operations/{+name}:cancel', options)
  command.request_representation = Google::Apis::VideointelligenceV1::GoogleLongrunningCancelOperationRequest::Representation
  command.request_object = google_longrunning_cancel_operation_request_object
  command.response_representation = Google::Apis::VideointelligenceV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::VideointelligenceV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VideointelligenceV1::GoogleProtobufEmpty

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


116
117
118
119
120
121
122
123
124
# File 'generated/google/apis/videointelligence_v1/service.rb', line 116

def delete_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1/operations/{+name}', options)
  command.response_representation = Google::Apis::VideointelligenceV1::GoogleProtobufEmpty::Representation
  command.response_class = Google::Apis::VideointelligenceV1::GoogleProtobufEmpty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VideointelligenceV1::GoogleLongrunningOperation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


148
149
150
151
152
153
154
155
156
# File 'generated/google/apis/videointelligence_v1/service.rb', line 148

def get_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/operations/{+name}', options)
  command.response_representation = Google::Apis::VideointelligenceV1::GoogleLongrunningOperation::Representation
  command.response_class = Google::Apis::VideointelligenceV1::GoogleLongrunningOperation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_operations(filter: nil, name: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::VideointelligenceV1::GoogleLongrunningListOperationsResponse

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/name=users/*/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


192
193
194
195
196
197
198
199
200
201
202
203
# File 'generated/google/apis/videointelligence_v1/service.rb', line 192

def list_operations(filter: nil, name: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1/operations', options)
  command.response_representation = Google::Apis::VideointelligenceV1::GoogleLongrunningListOperationsResponse::Representation
  command.response_class = Google::Apis::VideointelligenceV1::GoogleLongrunningListOperationsResponse
  command.query['filter'] = filter unless filter.nil?
  command.query['name'] = name unless name.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end