nl.topicus.jdbc.shaded.com.google.longrunning.OperationsSettings Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of spanner-jdbc Show documentation
Show all versions of spanner-jdbc Show documentation
JDBC Driver for Google Cloud Spanner
/*
* Copyright 2017, Google LLC All rights reserved.
*
* 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 nl.topicus.jdbc.shaded.com.google.longrunning;
import static nl.topicus.jdbc.shaded.com.google.longrunning.PagedResponseWrappers.ListOperationsPagedResponse;
import nl.topicus.jdbc.shaded.com.google.api.core.ApiFunction;
import nl.topicus.jdbc.shaded.com.google.api.core.ApiFuture;
import nl.topicus.jdbc.shaded.com.google.api.core.BetaApi;
import nl.topicus.jdbc.shaded.com.google.api.gax.core.GaxProperties;
import nl.topicus.jdbc.shaded.com.google.api.gax.core.GoogleCredentialsProvider;
import nl.topicus.jdbc.shaded.com.google.api.gax.core.InstantiatingExecutorProvider;
import nl.topicus.jdbc.shaded.com.google.api.gax.grpc.GaxGrpcProperties;
import nl.topicus.jdbc.shaded.com.google.api.gax.grpc.GrpcTransportChannel;
import nl.topicus.jdbc.shaded.com.google.api.gax.retrying.RetrySettings;
import nl.topicus.jdbc.shaded.com.google.api.gax.rpc.ApiCallContext;
import nl.topicus.jdbc.shaded.com.google.api.gax.rpc.ApiClientHeaderProvider;
import nl.topicus.jdbc.shaded.com.google.api.gax.rpc.ClientContext;
import nl.topicus.jdbc.shaded.com.google.api.gax.rpc.ClientSettings;
import nl.topicus.jdbc.shaded.com.google.api.gax.rpc.PageContext;
import nl.topicus.jdbc.shaded.com.google.api.gax.rpc.PagedCallSettings;
import nl.topicus.jdbc.shaded.com.google.api.gax.rpc.PagedListDescriptor;
import nl.topicus.jdbc.shaded.com.google.api.gax.rpc.PagedListResponseFactory;
import nl.topicus.jdbc.shaded.com.google.api.gax.rpc.StatusCode;
import nl.topicus.jdbc.shaded.com.google.api.gax.rpc.UnaryCallSettings;
import nl.topicus.jdbc.shaded.com.google.api.gax.rpc.UnaryCallable;
import nl.topicus.jdbc.shaded.com.google.common.collect.ImmutableList;
import nl.topicus.jdbc.shaded.com.google.common.collect.ImmutableMap;
import nl.topicus.jdbc.shaded.com.google.common.collect.ImmutableSet;
import nl.topicus.jdbc.shaded.com.google.common.collect.Lists;
import nl.topicus.jdbc.shaded.com.google.longrunning.stub.GrpcOperationsStub;
import nl.topicus.jdbc.shaded.com.google.longrunning.stub.OperationsStub;
import nl.topicus.jdbc.shaded.com.google.protobuf.Empty;
import java.io.IOException;
import nl.topicus.jdbc.shaded.javax.annotation.Generated;
import nl.topicus.jdbc.shaded.org.threeten.bp.Duration;
// AUTO-GENERATED DOCUMENTATION AND CLASS
/** Settings class to configure an instance of {@link OperationsClient}. */
@Generated("by GAPIC v0.0.5")
@BetaApi
public class OperationsSettings extends ClientSettings {
private final UnaryCallSettings getOperationSettings;
private final PagedCallSettings<
ListOperationsRequest, ListOperationsResponse, ListOperationsPagedResponse>
listOperationsSettings;
private final UnaryCallSettings cancelOperationSettings;
private final UnaryCallSettings deleteOperationSettings;
/** Returns the object with the settings used for calls to getOperation. */
public UnaryCallSettings 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 cancelOperationSettings() {
return cancelOperationSettings;
}
/** Returns the object with the settings used for calls to deleteOperation. */
public UnaryCallSettings deleteOperationSettings() {
return deleteOperationSettings;
}
@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(OperationsSettings.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);
}
private OperationsSettings(Builder settingsBuilder) throws IOException {
super(settingsBuilder);
getOperationSettings = settingsBuilder.getOperationSettings().build();
listOperationsSettings = settingsBuilder.listOperationsSettings().build();
cancelOperationSettings = settingsBuilder.cancelOperationSettings().build();
deleteOperationSettings = settingsBuilder.deleteOperationSettings().build();
}
private static final PagedListDescriptor
LIST_OPERATIONS_PAGE_STR_DESC =
new PagedListDescriptor() {
@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 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 getFuturePagedResponse(
UnaryCallable callable,
ListOperationsRequest request,
ApiCallContext context,
ApiFuture futureResponse) {
PageContext pageContext =
PageContext.create(callable, LIST_OPERATIONS_PAGE_STR_DESC, request, context);
return ListOperationsPagedResponse.createAsync(pageContext, futureResponse);
}
};
/** Builder for OperationsSettings. */
public static class Builder extends ClientSettings.Builder {
private final ImmutableList> unaryMethodSettingsBuilders;
private final UnaryCallSettings.Builder getOperationSettings;
private final PagedCallSettings.Builder<
ListOperationsRequest, ListOperationsResponse, ListOperationsPagedResponse>
listOperationsSettings;
private final UnaryCallSettings.Builder cancelOperationSettings;
private final UnaryCallSettings.Builder deleteOperationSettings;
private static final ImmutableMap>
RETRYABLE_CODE_DEFINITIONS;
static {
ImmutableMap.Builder> definitions =
ImmutableMap.builder();
definitions.put(
"idempotent",
ImmutableSet.copyOf(
Lists.newArrayList(
StatusCode.Code.DEADLINE_EXCEEDED, StatusCode.Code.UNAVAILABLE)));
definitions.put("non_idempotent", ImmutableSet.copyOf(Lists.newArrayList()));
RETRYABLE_CODE_DEFINITIONS = definitions.build();
}
private static final ImmutableMap RETRY_PARAM_DEFINITIONS;
static {
ImmutableMap.Builder 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();
}
private Builder() {
this((ClientContext) null);
}
private Builder(ClientContext clientContext) {
super(clientContext);
getOperationSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
listOperationsSettings = PagedCallSettings.newBuilder(LIST_OPERATIONS_PAGE_STR_FACT);
cancelOperationSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
deleteOperationSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
unaryMethodSettingsBuilders =
ImmutableList.>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"));
return builder;
}
private Builder(OperationsSettings settings) {
super(settings);
getOperationSettings = settings.getOperationSettings.toBuilder();
listOperationsSettings = settings.listOperationsSettings.toBuilder();
cancelOperationSettings = settings.cancelOperationSettings.toBuilder();
deleteOperationSettings = settings.deleteOperationSettings.toBuilder();
unaryMethodSettingsBuilders =
ImmutableList.>of(
getOperationSettings,
listOperationsSettings,
cancelOperationSettings,
deleteOperationSettings);
}
/**
* Applies the given settings updater function to all of the unary API methods in this service.
*
* Note: This method does not support applying settings to streaming methods.
*/
public Builder applyToAllUnaryMethods(
ApiFunction, Void> settingsUpdater) throws Exception {
super.applyToAllUnaryMethods(unaryMethodSettingsBuilders, settingsUpdater);
return this;
}
/** Returns the builder for the settings used for calls to getOperation. */
public UnaryCallSettings.Builder 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 cancelOperationSettings() {
return cancelOperationSettings;
}
/** Returns the builder for the settings used for calls to deleteOperation. */
public UnaryCallSettings.Builder deleteOperationSettings() {
return deleteOperationSettings;
}
@Override
public OperationsSettings build() throws IOException {
return new OperationsSettings(this);
}
}
}