@Generated(value="by gapic-generator") @BetaApi public class VideoIntelligenceServiceClient extends Object implements BackgroundResource
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://demomaker/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:
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);
Modifier | Constructor and Description |
---|---|
protected |
VideoIntelligenceServiceClient(VideoIntelligenceServiceSettings settings)
Constructs an instance of VideoIntelligenceServiceClient, using the given settings.
|
protected |
VideoIntelligenceServiceClient(VideoIntelligenceServiceStub stub) |
Modifier and Type | Method and Description |
---|---|
OperationFuture<com.google.cloud.videointelligence.v1.AnnotateVideoResponse,com.google.cloud.videointelligence.v1.AnnotateVideoProgress> |
annotateVideoAsync(com.google.cloud.videointelligence.v1.AnnotateVideoRequest request)
Performs asynchronous video annotation.
|
OperationFuture<com.google.cloud.videointelligence.v1.AnnotateVideoResponse,com.google.cloud.videointelligence.v1.AnnotateVideoProgress> |
annotateVideoAsync(String inputUri,
List<com.google.cloud.videointelligence.v1.Feature> features)
Performs asynchronous video annotation.
|
UnaryCallable<com.google.cloud.videointelligence.v1.AnnotateVideoRequest,Operation> |
annotateVideoCallable()
Performs asynchronous video annotation.
|
OperationCallable<com.google.cloud.videointelligence.v1.AnnotateVideoRequest,com.google.cloud.videointelligence.v1.AnnotateVideoResponse,com.google.cloud.videointelligence.v1.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.
|
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() |
protected VideoIntelligenceServiceClient(VideoIntelligenceServiceSettings settings) throws IOException
IOException
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future") protected VideoIntelligenceServiceClient(VideoIntelligenceServiceStub stub)
public static final VideoIntelligenceServiceClient create() throws IOException
IOException
public static final VideoIntelligenceServiceClient create(VideoIntelligenceServiceSettings settings) throws IOException
IOException
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future") public static final VideoIntelligenceServiceClient create(VideoIntelligenceServiceStub stub)
public final VideoIntelligenceServiceSettings getSettings()
@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future") public VideoIntelligenceServiceStub getStub()
@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.") public final OperationsClient getOperationsClient()
@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.") public final OperationFuture<com.google.cloud.videointelligence.v1.AnnotateVideoResponse,com.google.cloud.videointelligence.v1.AnnotateVideoProgress> annotateVideoAsync(String inputUri, List<com.google.cloud.videointelligence.v1.Feature> features)
Sample code:
try (VideoIntelligenceServiceClient videoIntelligenceServiceClient = VideoIntelligenceServiceClient.create()) {
String inputUri = "gs://demomaker/cat.mp4";
Feature featuresElement = Feature.LABEL_DETECTION;
List<Feature> features = Arrays.asList(featuresElement);
AnnotateVideoResponse response = videoIntelligenceServiceClient.annotateVideoAsync(inputUri, features).get();
}
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.ApiException
- if the remote call fails@BetaApi(value="The surface for long-running operations is not stable yet and may change in the future.") public final OperationFuture<com.google.cloud.videointelligence.v1.AnnotateVideoResponse,com.google.cloud.videointelligence.v1.AnnotateVideoProgress> annotateVideoAsync(com.google.cloud.videointelligence.v1.AnnotateVideoRequest request)
Sample code:
try (VideoIntelligenceServiceClient videoIntelligenceServiceClient = VideoIntelligenceServiceClient.create()) {
String inputUri = "gs://demomaker/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();
}
request
- The request object containing all of the parameters for the API call.ApiException
- if the remote call fails@BetaApi(value="The surface for use by generated code is not stable yet and may change in the future.") public final OperationCallable<com.google.cloud.videointelligence.v1.AnnotateVideoRequest,com.google.cloud.videointelligence.v1.AnnotateVideoResponse,com.google.cloud.videointelligence.v1.AnnotateVideoProgress> annotateVideoOperationCallable()
Sample code:
try (VideoIntelligenceServiceClient videoIntelligenceServiceClient = VideoIntelligenceServiceClient.create()) {
String inputUri = "gs://demomaker/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();
}
public final UnaryCallable<com.google.cloud.videointelligence.v1.AnnotateVideoRequest,Operation> annotateVideoCallable()
Sample code:
try (VideoIntelligenceServiceClient videoIntelligenceServiceClient = VideoIntelligenceServiceClient.create()) {
String inputUri = "gs://demomaker/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();
}
public final void close()
close
in interface AutoCloseable
public void shutdown()
shutdown
in interface BackgroundResource
public boolean isShutdown()
isShutdown
in interface BackgroundResource
public boolean isTerminated()
isTerminated
in interface BackgroundResource
public void shutdownNow()
shutdownNow
in interface BackgroundResource
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
awaitTermination
in interface BackgroundResource
InterruptedException
Copyright © 2019 Google LLC. All rights reserved.