Class VideoIntelligenceServiceClient (2.0.27)

public class VideoIntelligenceServiceClient implements 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 = "inputUri470706498";
   List<Feature> features = new ArrayList<>();
   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);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > VideoIntelligenceServiceClient

Implements

BackgroundResource

Static Methods

create()

public static final VideoIntelligenceServiceClient create()

Constructs an instance of VideoIntelligenceServiceClient with default settings.

Returns
TypeDescription
VideoIntelligenceServiceClient
Exceptions
TypeDescription
IOException

create(VideoIntelligenceServiceSettings settings)

public static final VideoIntelligenceServiceClient create(VideoIntelligenceServiceSettings settings)

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.

Parameter
NameDescription
settingsVideoIntelligenceServiceSettings
Returns
TypeDescription
VideoIntelligenceServiceClient
Exceptions
TypeDescription
IOException

create(VideoIntelligenceServiceStub stub)

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 using create(VideoIntelligenceServiceSettings).

Parameter
NameDescription
stubVideoIntelligenceServiceStub
Returns
TypeDescription
VideoIntelligenceServiceClient

Constructors

VideoIntelligenceServiceClient(VideoIntelligenceServiceSettings settings)

protected VideoIntelligenceServiceClient(VideoIntelligenceServiceSettings settings)

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.

Parameter
NameDescription
settingsVideoIntelligenceServiceSettings

VideoIntelligenceServiceClient(VideoIntelligenceServiceStub stub)

protected VideoIntelligenceServiceClient(VideoIntelligenceServiceStub stub)
Parameter
NameDescription
stubVideoIntelligenceServiceStub

Methods

annotateVideoAsync(AnnotateVideoRequest request)

public final OperationFuture<AnnotateVideoResponse,AnnotateVideoProgress> annotateVideoAsync(AnnotateVideoRequest request)

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()) {
   AnnotateVideoRequest request =
       AnnotateVideoRequest.newBuilder()
           .setInputUri("inputUri470706498")
           .setInputContent(ByteString.EMPTY)
           .addAllFeatures(new ArrayList<Feature>())
           .setVideoContext(VideoContext.newBuilder().build())
           .setOutputUri("outputUri-2119300949")
           .setLocationId("locationId1541836720")
           .build();
   AnnotateVideoResponse response =
       videoIntelligenceServiceClient.annotateVideoAsync(request).get();
 }
 
Parameter
NameDescription
requestAnnotateVideoRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<AnnotateVideoResponse,AnnotateVideoProgress>

annotateVideoAsync(String inputUri, List<Feature> features)

public final 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 = "inputUri470706498";
   List<Feature> features = new ArrayList<>();
   AnnotateVideoResponse response =
       videoIntelligenceServiceClient.annotateVideoAsync(inputUri, features).get();
 }
 
Parameters
NameDescription
inputUriString

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.

featuresList<Feature>

Required. Requested video annotation features.

Returns
TypeDescription
OperationFuture<AnnotateVideoResponse,AnnotateVideoProgress>

annotateVideoCallable()

public final UnaryCallable<AnnotateVideoRequest,Operation> annotateVideoCallable()

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()) {
   AnnotateVideoRequest request =
       AnnotateVideoRequest.newBuilder()
           .setInputUri("inputUri470706498")
           .setInputContent(ByteString.EMPTY)
           .addAllFeatures(new ArrayList<Feature>())
           .setVideoContext(VideoContext.newBuilder().build())
           .setOutputUri("outputUri-2119300949")
           .setLocationId("locationId1541836720")
           .build();
   ApiFuture<Operation> future =
       videoIntelligenceServiceClient.annotateVideoCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<AnnotateVideoRequest,Operation>

annotateVideoOperationCallable()

public final OperationCallable<AnnotateVideoRequest,AnnotateVideoResponse,AnnotateVideoProgress> annotateVideoOperationCallable()

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()) {
   AnnotateVideoRequest request =
       AnnotateVideoRequest.newBuilder()
           .setInputUri("inputUri470706498")
           .setInputContent(ByteString.EMPTY)
           .addAllFeatures(new ArrayList<Feature>())
           .setVideoContext(VideoContext.newBuilder().build())
           .setOutputUri("outputUri-2119300949")
           .setLocationId("locationId1541836720")
           .build();
   OperationFuture<AnnotateVideoResponse, AnnotateVideoProgress> future =
       videoIntelligenceServiceClient.annotateVideoOperationCallable().futureCall(request);
   // Do something.
   AnnotateVideoResponse response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<AnnotateVideoRequest,AnnotateVideoResponse,AnnotateVideoProgress>

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
InterruptedException

close()

public final void close()

getOperationsClient()

public final OperationsClient getOperationsClient()

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

Returns
TypeDescription
OperationsClient

getSettings()

public final VideoIntelligenceServiceSettings getSettings()
Returns
TypeDescription
VideoIntelligenceServiceSettings

getStub()

public VideoIntelligenceServiceStub getStub()
Returns
TypeDescription
VideoIntelligenceServiceStub

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
boolean

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()