This repository has been archived by the owner on Sep 26, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 119
/
OperationsStubSettings.java
389 lines (330 loc) · 16.2 KB
/
OperationsStubSettings.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
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
/*
* Copyright 2018 Google LLC
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Google LLC nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package com.google.longrunning.stub;
import static com.google.longrunning.OperationsClient.ListOperationsPagedResponse;
import com.google.api.core.ApiFunction;
import com.google.api.core.ApiFuture;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.GaxProperties;
import com.google.api.gax.core.GoogleCredentialsProvider;
import com.google.api.gax.core.InstantiatingExecutorProvider;
import com.google.api.gax.grpc.GaxGrpcProperties;
import com.google.api.gax.grpc.GrpcTransportChannel;
import com.google.api.gax.retrying.RetrySettings;
import com.google.api.gax.rpc.ApiCallContext;
import com.google.api.gax.rpc.ApiClientHeaderProvider;
import com.google.api.gax.rpc.ClientContext;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.PagedCallSettings;
import com.google.api.gax.rpc.PagedListDescriptor;
import com.google.api.gax.rpc.PagedListResponseFactory;
import com.google.api.gax.rpc.StatusCode;
import com.google.api.gax.rpc.StubSettings;
import com.google.api.gax.rpc.UnaryCallSettings;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Lists;
import com.google.longrunning.CancelOperationRequest;
import com.google.longrunning.DeleteOperationRequest;
import com.google.longrunning.GetOperationRequest;
import com.google.longrunning.ListOperationsRequest;
import com.google.longrunning.ListOperationsResponse;
import com.google.longrunning.Operation;
import com.google.longrunning.WaitOperationRequest;
import com.google.protobuf.Empty;
import java.io.IOException;
import org.threeten.bp.Duration;
/** Settings class to configure an instance of {@link OperationsStub}. */
@BetaApi
public class OperationsStubSettings extends StubSettings<OperationsStubSettings> {
private final UnaryCallSettings<GetOperationRequest, Operation> getOperationSettings;
private final PagedCallSettings<
ListOperationsRequest, ListOperationsResponse, ListOperationsPagedResponse>
listOperationsSettings;
private final UnaryCallSettings<CancelOperationRequest, Empty> cancelOperationSettings;
private final UnaryCallSettings<DeleteOperationRequest, Empty> deleteOperationSettings;
private final UnaryCallSettings<WaitOperationRequest, Operation> waitOperationSettings;
/** Returns the object with the settings used for calls to getOperation. */
public UnaryCallSettings<GetOperationRequest, Operation> getOperationSettings() {
return getOperationSettings;
}
/** Returns the object with the settings used for calls to listOperations. */
public PagedCallSettings<
ListOperationsRequest, ListOperationsResponse, ListOperationsPagedResponse>
listOperationsSettings() {
return listOperationsSettings;
}
/** Returns the object with the settings used for calls to cancelOperation. */
public UnaryCallSettings<CancelOperationRequest, Empty> cancelOperationSettings() {
return cancelOperationSettings;
}
/** Returns the object with the settings used for calls to deleteOperation. */
public UnaryCallSettings<DeleteOperationRequest, Empty> deleteOperationSettings() {
return deleteOperationSettings;
}
/** Returns the object with the settings used for calls to waitOperation. */
public UnaryCallSettings<WaitOperationRequest, Operation> waitOperationSettings() {
return waitOperationSettings;
}
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public OperationsStub createStub() throws IOException {
if (getTransportChannelProvider()
.getTransportName()
.equals(GrpcTransportChannel.getGrpcTransportName())) {
return GrpcOperationsStub.create(this);
} else {
throw new UnsupportedOperationException(
"Transport not supported: " + getTransportChannelProvider().getTransportName());
}
}
/** Returns a builder for the default ExecutorProvider for this service. */
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() {
return InstantiatingExecutorProvider.newBuilder();
}
/** Returns a builder for the default credentials for this service. */
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() {
return GoogleCredentialsProvider.newBuilder();
}
@BetaApi("The surface for customizing headers is not stable yet and may change in the future.")
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
return ApiClientHeaderProvider.newBuilder()
.setGeneratedLibToken(
"gapic", GaxProperties.getLibraryVersion(OperationsStubSettings.class))
.setTransportToken(
GaxGrpcProperties.getGrpcTokenName(), GaxGrpcProperties.getGrpcVersion());
}
/** Returns a new builder for this class. */
public static Builder newBuilder() {
return Builder.createDefault();
}
/** Returns a new builder for this class. */
public static Builder newBuilder(ClientContext clientContext) {
return new Builder(clientContext);
}
/** Returns a builder containing all the values of this settings class. */
public Builder toBuilder() {
return new Builder(this);
}
protected OperationsStubSettings(Builder settingsBuilder) throws IOException {
super(settingsBuilder);
getOperationSettings = settingsBuilder.getOperationSettings().build();
listOperationsSettings = settingsBuilder.listOperationsSettings().build();
cancelOperationSettings = settingsBuilder.cancelOperationSettings().build();
deleteOperationSettings = settingsBuilder.deleteOperationSettings().build();
waitOperationSettings = settingsBuilder.waitOperationSettings().build();
}
private static final PagedListDescriptor<ListOperationsRequest, ListOperationsResponse, Operation>
LIST_OPERATIONS_PAGE_STR_DESC =
new PagedListDescriptor<ListOperationsRequest, ListOperationsResponse, Operation>() {
@Override
public String emptyToken() {
return "";
}
@Override
public ListOperationsRequest injectToken(ListOperationsRequest payload, String token) {
return ListOperationsRequest.newBuilder(payload).setPageToken(token).build();
}
@Override
public ListOperationsRequest injectPageSize(
ListOperationsRequest payload, int pageSize) {
return ListOperationsRequest.newBuilder(payload).setPageSize(pageSize).build();
}
@Override
public Integer extractPageSize(ListOperationsRequest payload) {
return payload.getPageSize();
}
@Override
public String extractNextToken(ListOperationsResponse payload) {
return payload.getNextPageToken();
}
@Override
public Iterable<Operation> extractResources(ListOperationsResponse payload) {
return payload.getOperationsList();
}
};
private static final PagedListResponseFactory<
ListOperationsRequest, ListOperationsResponse, ListOperationsPagedResponse>
LIST_OPERATIONS_PAGE_STR_FACT =
new PagedListResponseFactory<
ListOperationsRequest, ListOperationsResponse, ListOperationsPagedResponse>() {
@Override
public ApiFuture<ListOperationsPagedResponse> getFuturePagedResponse(
UnaryCallable<ListOperationsRequest, ListOperationsResponse> callable,
ListOperationsRequest request,
ApiCallContext context,
ApiFuture<ListOperationsResponse> futureResponse) {
PageContext<ListOperationsRequest, ListOperationsResponse, Operation> pageContext =
PageContext.create(callable, LIST_OPERATIONS_PAGE_STR_DESC, request, context);
return ListOperationsPagedResponse.createAsync(pageContext, futureResponse);
}
};
/** Builder for OperationsStubSettings. */
public static class Builder extends StubSettings.Builder<OperationsStubSettings, Builder> {
private final ImmutableList<UnaryCallSettings.Builder<?, ?>> unaryMethodSettingsBuilders;
private final UnaryCallSettings.Builder<GetOperationRequest, Operation> getOperationSettings;
private final PagedCallSettings.Builder<
ListOperationsRequest, ListOperationsResponse, ListOperationsPagedResponse>
listOperationsSettings;
private final UnaryCallSettings.Builder<CancelOperationRequest, Empty> cancelOperationSettings;
private final UnaryCallSettings.Builder<DeleteOperationRequest, Empty> deleteOperationSettings;
private final UnaryCallSettings.Builder<WaitOperationRequest, Operation> waitOperationSettings;
private static final ImmutableMap<String, ImmutableSet<StatusCode.Code>>
RETRYABLE_CODE_DEFINITIONS;
static {
ImmutableMap.Builder<String, ImmutableSet<StatusCode.Code>> definitions =
ImmutableMap.builder();
definitions.put(
"idempotent",
ImmutableSet.copyOf(
Lists.<StatusCode.Code>newArrayList(
StatusCode.Code.DEADLINE_EXCEEDED, StatusCode.Code.UNAVAILABLE)));
definitions.put("non_idempotent", ImmutableSet.copyOf(Lists.<StatusCode.Code>newArrayList()));
RETRYABLE_CODE_DEFINITIONS = definitions.build();
}
private static final ImmutableMap<String, RetrySettings> RETRY_PARAM_DEFINITIONS;
static {
ImmutableMap.Builder<String, RetrySettings> definitions = ImmutableMap.builder();
RetrySettings settings = null;
settings =
RetrySettings.newBuilder()
.setInitialRetryDelay(Duration.ofMillis(100L))
.setRetryDelayMultiplier(1.3)
.setMaxRetryDelay(Duration.ofMillis(60000L))
.setInitialRpcTimeout(Duration.ofMillis(90000L))
.setRpcTimeoutMultiplier(1.0)
.setMaxRpcTimeout(Duration.ofMillis(90000L))
.setTotalTimeout(Duration.ofMillis(600000L))
.build();
definitions.put("default", settings);
RETRY_PARAM_DEFINITIONS = definitions.build();
}
protected Builder() {
this((ClientContext) null);
}
protected Builder(ClientContext clientContext) {
super(clientContext);
getOperationSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
listOperationsSettings = PagedCallSettings.newBuilder(LIST_OPERATIONS_PAGE_STR_FACT);
cancelOperationSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
deleteOperationSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
waitOperationSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
unaryMethodSettingsBuilders =
ImmutableList.<UnaryCallSettings.Builder<?, ?>>of(
getOperationSettings,
listOperationsSettings,
cancelOperationSettings,
deleteOperationSettings);
initDefaults(this);
}
private static Builder createDefault() {
Builder builder = new Builder((ClientContext) null);
return initDefaults(builder);
}
private static Builder initDefaults(Builder builder) {
builder
.getOperationSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("idempotent"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("default"));
builder
.listOperationsSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("idempotent"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("default"));
builder
.cancelOperationSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("idempotent"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("default"));
builder
.deleteOperationSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("idempotent"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("default"));
builder
.waitOperationSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("idempotent"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("default"));
return builder;
}
protected Builder(OperationsStubSettings settings) {
super(settings);
getOperationSettings = settings.getOperationSettings.toBuilder();
listOperationsSettings = settings.listOperationsSettings.toBuilder();
cancelOperationSettings = settings.cancelOperationSettings.toBuilder();
deleteOperationSettings = settings.deleteOperationSettings.toBuilder();
waitOperationSettings = settings.waitOperationSettings.toBuilder();
unaryMethodSettingsBuilders =
ImmutableList.<UnaryCallSettings.Builder<?, ?>>of(
getOperationSettings,
listOperationsSettings,
cancelOperationSettings,
deleteOperationSettings,
waitOperationSettings);
}
/**
* Applies the given settings updater function to all of the unary API methods in this service.
*
* <p>Note: This method does not support applying settings to streaming methods.
*/
public Builder applyToAllUnaryMethods(
ApiFunction<UnaryCallSettings.Builder<?, ?>, Void> settingsUpdater) throws Exception {
super.applyToAllUnaryMethods(unaryMethodSettingsBuilders, settingsUpdater);
return this;
}
public ImmutableList<UnaryCallSettings.Builder<?, ?>> unaryMethodSettingsBuilders() {
return unaryMethodSettingsBuilders;
}
/** Returns the builder for the settings used for calls to getOperation. */
public UnaryCallSettings.Builder<GetOperationRequest, Operation> getOperationSettings() {
return getOperationSettings;
}
/** Returns the builder for the settings used for calls to listOperations. */
public PagedCallSettings.Builder<
ListOperationsRequest, ListOperationsResponse, ListOperationsPagedResponse>
listOperationsSettings() {
return listOperationsSettings;
}
/** Returns the builder for the settings used for calls to cancelOperation. */
public UnaryCallSettings.Builder<CancelOperationRequest, Empty> cancelOperationSettings() {
return cancelOperationSettings;
}
/** Returns the builder for the settings used for calls to deleteOperation. */
public UnaryCallSettings.Builder<DeleteOperationRequest, Empty> deleteOperationSettings() {
return deleteOperationSettings;
}
/** Returns the builder for the settings used for calls to waitOperation. */
public UnaryCallSettings.Builder<WaitOperationRequest, Operation> waitOperationSettings() {
return waitOperationSettings;
}
@Override
public OperationsStubSettings build() throws IOException {
return new OperationsStubSettings(this);
}
}
}