Class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1AnnotateVideoRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/videointelligence_v1/classes.rb,
generated/google/apis/videointelligence_v1/representations.rb,
generated/google/apis/videointelligence_v1/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) ⇒ GoogleCloudVideointelligenceV1AnnotateVideoRequest

Returns a new instance of GoogleCloudVideointelligenceV1AnnotateVideoRequest.



100
101
102
# File 'generated/google/apis/videointelligence_v1/classes.rb', line 100

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

Instance Attribute Details

#featuresArray<String>

Required. Requested video annotation features. Corresponds to the JSON property features

Returns:

  • (Array<String>)


53
54
55
# File 'generated/google/apis/videointelligence_v1/classes.rb', line 53

def features
  @features
end

#input_contentString

The video data bytes. If unset, the input video(s) should be specified via the input_uri. If set, input_uri must be unset. Corresponds to the JSON property inputContent NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String)


61
62
63
# File 'generated/google/apis/videointelligence_v1/classes.rb', line 61

def input_content
  @input_content
end

#input_uriString

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

Returns:

  • (String)


75
76
77
# File 'generated/google/apis/videointelligence_v1/classes.rb', line 75

def input_uri
  @input_uri
end

#location_idString

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

Returns:

  • (String)


83
84
85
# File 'generated/google/apis/videointelligence_v1/classes.rb', line 83

def location_id
  @location_id
end

#output_uriString

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

Returns:

  • (String)


93
94
95
# File 'generated/google/apis/videointelligence_v1/classes.rb', line 93

def output_uri
  @output_uri
end

#video_contextGoogle::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1VideoContext

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



98
99
100
# File 'generated/google/apis/videointelligence_v1/classes.rb', line 98

def video_context
  @video_context
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



105
106
107
108
109
110
111
112
# File 'generated/google/apis/videointelligence_v1/classes.rb', line 105

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