Class: Google::Cloud::VideoIntelligence::V1beta2::VideoIntelligenceService::Client
- Inherits:
-
Object
- Object
- Google::Cloud::VideoIntelligence::V1beta2::VideoIntelligenceService::Client
- Defined in:
- lib/google/cloud/video_intelligence/v1beta2/video_intelligence_service/client.rb
Overview
Client for the VideoIntelligenceService service.
Service that implements Google Cloud Video Intelligence API.
Defined Under Namespace
Classes: Configuration
Instance Attribute Summary collapse
-
#operations_client ⇒ ::Google::Cloud::VideoIntelligence::V1beta2::VideoIntelligenceService::Operations
readonly
Get the associated client for long-running operations.
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the VideoIntelligenceService Client class.
Instance Method Summary collapse
-
#annotate_video(request, options = nil) {|response, operation| ... } ⇒ ::Gapic::Operation
Performs asynchronous video annotation.
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the VideoIntelligenceService Client instance.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new VideoIntelligenceService client object.
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new VideoIntelligenceService client object.
Examples
To create a new VideoIntelligenceService client with the default configuration:
client = ::Google::Cloud::VideoIntelligence::V1beta2::VideoIntelligenceService::Client.new
To create a new VideoIntelligenceService client with a custom configuration:
client = ::Google::Cloud::VideoIntelligence::V1beta2::VideoIntelligenceService::Client.new do |config|
config.timeout = 10.0
end
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 |
# File 'lib/google/cloud/video_intelligence/v1beta2/video_intelligence_service/client.rb', line 120 def initialize # 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 "gapic/grpc" require "google/cloud/videointelligence/v1beta2/video_intelligence_services_pb" # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials credentials ||= Credentials.default scope: @config.scope 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 = Operations.new do |config| config.credentials = credentials config.endpoint = @config.endpoint end @video_intelligence_service_stub = ::Gapic::ServiceStub.new( ::Google::Cloud::VideoIntelligence::V1beta2::VideoIntelligenceService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end |
Instance Attribute Details
#operations_client ⇒ ::Google::Cloud::VideoIntelligence::V1beta2::VideoIntelligenceService::Operations (readonly)
Get the associated client for long-running operations.
161 162 163 |
# File 'lib/google/cloud/video_intelligence/v1beta2/video_intelligence_service/client.rb', line 161 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.
Example
To modify the configuration for all VideoIntelligenceService clients:
::Google::Cloud::VideoIntelligence::V1beta2::VideoIntelligenceService::Client.configure do |config|
config.timeout = 10.0
end
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/google/cloud/video_intelligence/v1beta2/video_intelligence_service/client.rb', line 55 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "VideoIntelligence", "V1beta2"] 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).
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 |
# File 'lib/google/cloud/video_intelligence/v1beta2/video_intelligence_service/client.rb', line 225 def annotate_video request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::VideoIntelligence::V1beta2::AnnotateVideoRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.annotate_video..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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::V1beta2::VERSION [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.annotate_video.timeout, metadata: , retry_policy: @config.rpcs.annotate_video.retry_policy .apply_defaults metadata: @config., retry_policy: @config.retry_policy @video_intelligence_service_stub.call_rpc :annotate_video, request, options: do |response, operation| response = ::Gapic::Operation.new response, @operations_client, options: yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => 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.
95 96 97 98 |
# File 'lib/google/cloud/video_intelligence/v1beta2/video_intelligence_service/client.rb', line 95 def configure yield @config if block_given? @config end |