This repository has been archived by the owner on Sep 16, 2023. It is now read-only.
/
VideoIntelligenceServiceClient.java
327 lines (307 loc) · 13.7 KB
/
VideoIntelligenceServiceClient.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.videointelligence.v1p1beta1;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.longrunning.OperationFuture;
import com.google.api.gax.rpc.OperationCallable;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.videointelligence.v1p1beta1.stub.VideoIntelligenceServiceStub;
import com.google.cloud.videointelligence.v1p1beta1.stub.VideoIntelligenceServiceStubSettings;
import com.google.longrunning.Operation;
import com.google.longrunning.OperationsClient;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND SERVICE
/**
* Service Description: Service that implements Google Cloud Video Intelligence API.
*
* <p>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:
*
* <pre>
* <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();
* }
* </code>
* </pre>
*
* <p>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().
*
* <p>The surface of this class includes several types of Java methods for each of the API's
* methods:
*
* <ol>
* <li>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.
* <li>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.
* <li>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.
* </ol>
*
* <p>See the individual methods for example code.
*
* <p>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.
*
* <p>This class can be customized by passing in a custom instance of
* VideoIntelligenceServiceSettings to create(). For example:
*
* <p>To customize credentials:
*
* <pre>
* <code>
* VideoIntelligenceServiceSettings videoIntelligenceServiceSettings =
* VideoIntelligenceServiceSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* VideoIntelligenceServiceClient videoIntelligenceServiceClient =
* VideoIntelligenceServiceClient.create(videoIntelligenceServiceSettings);
* </code>
* </pre>
*
* To customize the endpoint:
*
* <pre>
* <code>
* VideoIntelligenceServiceSettings videoIntelligenceServiceSettings =
* VideoIntelligenceServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
* VideoIntelligenceServiceClient videoIntelligenceServiceClient =
* VideoIntelligenceServiceClient.create(videoIntelligenceServiceSettings);
* </code>
* </pre>
*/
@Generated("by gapic-generator")
@BetaApi
public class VideoIntelligenceServiceClient implements BackgroundResource {
private final VideoIntelligenceServiceSettings settings;
private final VideoIntelligenceServiceStub stub;
private final OperationsClient operationsClient;
/** Constructs an instance of VideoIntelligenceServiceClient with default settings. */
public static final VideoIntelligenceServiceClient create() throws IOException {
return create(VideoIntelligenceServiceSettings.newBuilder().build());
}
/**
* 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.
*/
public static final VideoIntelligenceServiceClient create(
VideoIntelligenceServiceSettings settings) throws IOException {
return new VideoIntelligenceServiceClient(settings);
}
/**
* Constructs an instance of VideoIntelligenceServiceClient, using the given stub for making
* calls. This is for advanced usage - prefer to use VideoIntelligenceServiceSettings}.
*/
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public static final VideoIntelligenceServiceClient create(VideoIntelligenceServiceStub stub) {
return new VideoIntelligenceServiceClient(stub);
}
/**
* 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.
*/
protected VideoIntelligenceServiceClient(VideoIntelligenceServiceSettings settings)
throws IOException {
this.settings = settings;
this.stub = ((VideoIntelligenceServiceStubSettings) settings.getStubSettings()).createStub();
this.operationsClient = OperationsClient.create(this.stub.getOperationsStub());
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
protected VideoIntelligenceServiceClient(VideoIntelligenceServiceStub stub) {
this.settings = null;
this.stub = stub;
this.operationsClient = OperationsClient.create(this.stub.getOperationsStub());
}
public final VideoIntelligenceServiceSettings getSettings() {
return settings;
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public VideoIntelligenceServiceStub getStub() {
return stub;
}
/**
* Returns the OperationsClient that can be used to query the status of a long-running operation
* returned by another API method call.
*/
@BetaApi(
"The surface for long-running operations is not stable yet and may change in the future.")
public final OperationsClient getOperationsClient() {
return operationsClient;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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).
*
* <p>Sample code:
*
* <pre><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();
* }
* </code></pre>
*
* @param 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.
* @param features Required. Requested video annotation features.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
@BetaApi(
"The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<AnnotateVideoResponse, AnnotateVideoProgress> annotateVideoAsync(
String inputUri, List<Feature> features) {
AnnotateVideoRequest request =
AnnotateVideoRequest.newBuilder().setInputUri(inputUri).addAllFeatures(features).build();
return annotateVideoAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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).
*
* <p>Sample code:
*
* <pre><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();
* }
* </code></pre>
*
* @param 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
*/
@BetaApi(
"The surface for long-running operations is not stable yet and may change in the future.")
public final OperationFuture<AnnotateVideoResponse, AnnotateVideoProgress> annotateVideoAsync(
AnnotateVideoRequest request) {
return annotateVideoOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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).
*
* <p>Sample code:
*
* <pre><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();
* }
* </code></pre>
*/
@BetaApi("The surface for use by generated code is not stable yet and may change in the future.")
public final OperationCallable<AnnotateVideoRequest, AnnotateVideoResponse, AnnotateVideoProgress>
annotateVideoOperationCallable() {
return stub.annotateVideoOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD
/**
* 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).
*
* <p>Sample code:
*
* <pre><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();
* }
* </code></pre>
*/
public final UnaryCallable<AnnotateVideoRequest, Operation> annotateVideoCallable() {
return stub.annotateVideoCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
}