Class: Google::Apis::VideointelligenceV1beta1::GoogleCloudVideointelligenceV1beta1AnnotateVideoRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/videointelligence_v1beta1/classes.rb,
generated/google/apis/videointelligence_v1beta1/representations.rb,
generated/google/apis/videointelligence_v1beta1/representations.rb

Overview

Video annotation request.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleCloudVideointelligenceV1beta1AnnotateVideoRequest

Returns a new instance of GoogleCloudVideointelligenceV1beta1AnnotateVideoRequest



475
476
477
 
# File 'generated/google/apis/videointelligence_v1beta1/classes.rb', line 475

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#features ⇒ Array<String>

Requested video annotation features. Corresponds to the JSON property features

Returns:

  • (Array<String>) 


431
432
433
 
# File 'generated/google/apis/videointelligence_v1beta1/classes.rb', line 431

def features
  @features
end

#input_content ⇒ String

The video data bytes. Encoding: base64. If unset, the input video(s) should be specified via input_uri. If set, input_uri should be unset. Corresponds to the JSON property inputContent

Returns:

  • (String) 


437
438
439
 
# File 'generated/google/apis/videointelligence_v1beta1/classes.rb', line 437

def input_content
  @input_content
end

#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 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. Corresponds to the JSON property inputUri

Returns:

  • (String) 


451
452
453
 
# File 'generated/google/apis/videointelligence_v1beta1/classes.rb', line 451

def input_uri
  @input_uri
end

#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. Corresponds to the JSON property locationId

Returns:

  • (String) 


458
459
460
 
# File 'generated/google/apis/videointelligence_v1beta1/classes.rb', line 458

def location_id
  @location_id
end

#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 google.rpc.Code.INVALID_ARGUMENT). For more information, see Request URIs. Corresponds to the JSON property outputUri

Returns:

  • (String) 


468
469
470
 
# File 'generated/google/apis/videointelligence_v1beta1/classes.rb', line 468

def output_uri
  @output_uri
end

#video_context ⇒ Google::Apis::VideointelligenceV1beta1::GoogleCloudVideointelligenceV1beta1VideoContext

Video context and/or feature-specific parameters. Corresponds to the JSON property videoContext

Returns:



473
474
475
 
# File 'generated/google/apis/videointelligence_v1beta1/classes.rb', line 473

def video_context
  @video_context
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



480
481
482
483
484
485
486
487
 
# File 'generated/google/apis/videointelligence_v1beta1/classes.rb', line 480

def update!(**args)
  @features = args[:features] if args.key?(:features)
  @input_content = args[:input_content] if args.key?(:input_content)
  @input_uri = args[:input_uri] if args.key?(:input_uri)
  @location_id = args[:location_id] if args.key?(:location_id)
  @output_uri = args[:output_uri] if args.key?(:output_uri)
  @video_context = args[:video_context] if args.key?(:video_context)
end