VideoIntelligenceServiceClient (Google Cloud 0.119.0-alpha API)

java.lang.Object
- com.google.cloud.videointelligence.v1beta2.VideoIntelligenceServiceClient

All Implemented Interfaces:

com.google.api.gax.core.BackgroundResource, AutoCloseable
```
@Generated(value="by gapic-generator")
 @BetaApi
public class VideoIntelligenceServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource
```
Service Description: Service that implements Google Cloud Video Intelligence API.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
```
 
 try (VideoIntelligenceServiceClient videoIntelligenceServiceClient = VideoIntelligenceServiceClient.create()) {
   String inputUri = "gs://cloud-samples-data/video/cat.mp4";
   Feature featuresElement = Feature.LABEL_DETECTION;
   List<Feature> features = Arrays.asList(featuresElement);
   AnnotateVideoResponse response = videoIntelligenceServiceClient.annotateVideoAsync(inputUri, features).get();
 }
 
 
```
Note: close() needs to be called on the videoIntelligenceServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of VideoIntelligenceServiceSettings to create(). For example:
To customize credentials:
```
 
 VideoIntelligenceServiceSettings videoIntelligenceServiceSettings =
     VideoIntelligenceServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 VideoIntelligenceServiceClient videoIntelligenceServiceClient =
     VideoIntelligenceServiceClient.create(videoIntelligenceServiceSettings);
 
 
```
To customize the endpoint:
```
 
 VideoIntelligenceServiceSettings videoIntelligenceServiceSettings =
     VideoIntelligenceServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 VideoIntelligenceServiceClient videoIntelligenceServiceClient =
     VideoIntelligenceServiceClient.create(videoIntelligenceServiceSettings);
 
 
```

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`VideoIntelligenceServiceClient(VideoIntelligenceServiceSettings settings)` Constructs an instance of VideoIntelligenceServiceClient, using the given settings.
`protected`	`VideoIntelligenceServiceClient(VideoIntelligenceServiceStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.gax.longrunning.OperationFuture<AnnotateVideoResponse,AnnotateVideoProgress>`	`annotateVideoAsync(AnnotateVideoRequest request)` Performs asynchronous video annotation.
`com.google.api.gax.longrunning.OperationFuture<AnnotateVideoResponse,AnnotateVideoProgress>`	`annotateVideoAsync(String inputUri, List<Feature> features)` Performs asynchronous video annotation.
`com.google.api.gax.rpc.UnaryCallable<AnnotateVideoRequest,com.google.longrunning.Operation>`	`annotateVideoCallable()` Performs asynchronous video annotation.
`com.google.api.gax.rpc.OperationCallable<AnnotateVideoRequest,AnnotateVideoResponse,AnnotateVideoProgress>`	`annotateVideoOperationCallable()` Performs asynchronous video annotation.
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static VideoIntelligenceServiceClient`	`create()` Constructs an instance of VideoIntelligenceServiceClient with default settings.
`static VideoIntelligenceServiceClient`	`create(VideoIntelligenceServiceSettings settings)` Constructs an instance of VideoIntelligenceServiceClient, using the given settings.
`static VideoIntelligenceServiceClient`	`create(VideoIntelligenceServiceStub stub)` Constructs an instance of VideoIntelligenceServiceClient, using the given stub for making calls.
`com.google.longrunning.OperationsClient`	`getOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`VideoIntelligenceServiceSettings`	`getSettings()`
`VideoIntelligenceServiceStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`void`	`shutdown()`
`void`	`shutdownNow()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VideoIntelligenceServiceClient
```
protected VideoIntelligenceServiceClient(VideoIntelligenceServiceSettings settings)
                                  throws IOException
```
Constructs an instance of VideoIntelligenceServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Throws:

IOException

VideoIntelligenceServiceClient

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
protected VideoIntelligenceServiceClient(VideoIntelligenceServiceStub stub)

Method Detail

create

public static final VideoIntelligenceServiceClient create()
                                                   throws IOException

Constructs an instance of VideoIntelligenceServiceClient with default settings.

Throws:: IOException

create
```
public static final VideoIntelligenceServiceClient create(VideoIntelligenceServiceSettings settings)
                                                   throws IOException
```
Constructs an instance of VideoIntelligenceServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Throws:

IOException

create

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public static final VideoIntelligenceServiceClient create(VideoIntelligenceServiceStub stub)

Constructs an instance of VideoIntelligenceServiceClient, using the given stub for making calls. This is for advanced usage - prefer to use VideoIntelligenceServiceSettings}.

getSettings

public final VideoIntelligenceServiceSettings getSettings()

getStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public VideoIntelligenceServiceStub getStub()

getOperationsClient

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.longrunning.OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

annotateVideoAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<AnnotateVideoResponse,AnnotateVideoProgress> annotateVideoAsync(String inputUri,
                                                                                                                                                                                                                                      List<Feature> features)

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

Sample code:


 try (VideoIntelligenceServiceClient videoIntelligenceServiceClient = VideoIntelligenceServiceClient.create()) {
   String inputUri = "gs://cloud-samples-data/video/cat.mp4";
   Feature featuresElement = Feature.LABEL_DETECTION;
   List<Feature> features = Arrays.asList(featuresElement);
   AnnotateVideoResponse response = videoIntelligenceServiceClient.annotateVideoAsync(inputUri, features).get();
 }

Parameters:: inputUri - 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][google.rpc.Code.INVALID_ARGUMENT]). For more information, see [Request URIs](/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.; features - Requested video annotation features.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

annotateVideoAsync

@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.")
public final com.google.api.gax.longrunning.OperationFuture<AnnotateVideoResponse,AnnotateVideoProgress> annotateVideoAsync(AnnotateVideoRequest request)

Sample code:


 try (VideoIntelligenceServiceClient videoIntelligenceServiceClient = VideoIntelligenceServiceClient.create()) {
   String inputUri = "gs://cloud-samples-data/video/cat.mp4";
   Feature featuresElement = Feature.LABEL_DETECTION;
   List<Feature> features = Arrays.asList(featuresElement);
   AnnotateVideoRequest request = AnnotateVideoRequest.newBuilder()
     .setInputUri(inputUri)
     .addAllFeatures(features)
     .build();
   AnnotateVideoResponse response = videoIntelligenceServiceClient.annotateVideoAsync(request).get();
 }

Parameters:: request - The request object containing all of the parameters for the API call.
Throws:: com.google.api.gax.rpc.ApiException - if the remote call fails

annotateVideoOperationCallable

@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.")
public final com.google.api.gax.rpc.OperationCallable<AnnotateVideoRequest,AnnotateVideoResponse,AnnotateVideoProgress> annotateVideoOperationCallable()

Sample code:


 try (VideoIntelligenceServiceClient videoIntelligenceServiceClient = VideoIntelligenceServiceClient.create()) {
   String inputUri = "gs://cloud-samples-data/video/cat.mp4";
   Feature featuresElement = Feature.LABEL_DETECTION;
   List<Feature> features = Arrays.asList(featuresElement);
   AnnotateVideoRequest request = AnnotateVideoRequest.newBuilder()
     .setInputUri(inputUri)
     .addAllFeatures(features)
     .build();
   OperationFuture<AnnotateVideoResponse, AnnotateVideoProgress> future = videoIntelligenceServiceClient.annotateVideoOperationCallable().futureCall(request);
   // Do something
   AnnotateVideoResponse response = future.get();
 }

annotateVideoCallable

public final com.google.api.gax.rpc.UnaryCallable<AnnotateVideoRequest,com.google.longrunning.Operation> annotateVideoCallable()

Sample code:


 try (VideoIntelligenceServiceClient videoIntelligenceServiceClient = VideoIntelligenceServiceClient.create()) {
   String inputUri = "gs://cloud-samples-data/video/cat.mp4";
   Feature featuresElement = Feature.LABEL_DETECTION;
   List<Feature> features = Arrays.asList(featuresElement);
   AnnotateVideoRequest request = AnnotateVideoRequest.newBuilder()
     .setInputUri(inputUri)
     .addAllFeatures(features)
     .build();
   ApiFuture<Operation> future = videoIntelligenceServiceClient.annotateVideoCallable().futureCall(request);
   // Do something
   Operation response = future.get();
 }

close
```
public final void close()
```
Specified by:

close in interface AutoCloseable

shutdown
```
public void shutdown()
```
Specified by:

shutdown in interface com.google.api.gax.core.BackgroundResource

isShutdown
```
public boolean isShutdown()
```
Specified by:

isShutdown in interface com.google.api.gax.core.BackgroundResource

isTerminated
```
public boolean isTerminated()
```
Specified by:

isTerminated in interface com.google.api.gax.core.BackgroundResource

shutdownNow
```
public void shutdownNow()
```
Specified by:

shutdownNow in interface com.google.api.gax.core.BackgroundResource

awaitTermination

public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException

Specified by:: awaitTermination in interface com.google.api.gax.core.BackgroundResource
Throws:: InterruptedException

Class VideoIntelligenceServiceClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VideoIntelligenceServiceClient

VideoIntelligenceServiceClient

Method Detail

create

create

create

getSettings

getStub

getOperationsClient

annotateVideoAsync

annotateVideoAsync

annotateVideoOperationCallable

annotateVideoCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination