ServicesStubSettings.java
/*
* Copyright 2022 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.appengine.v1.stub;
import static com.google.appengine.v1.ServicesClient.ListServicesPagedResponse;
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.grpc.InstantiatingGrpcChannelProvider;
import com.google.api.gax.grpc.ProtoOperationTransformers;
import com.google.api.gax.httpjson.GaxHttpJsonProperties;
import com.google.api.gax.httpjson.HttpJsonTransportChannel;
import com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider;
import com.google.api.gax.longrunning.OperationSnapshot;
import com.google.api.gax.longrunning.OperationTimedPollAlgorithm;
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.OperationCallSettings;
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.TransportChannelProvider;
import com.google.api.gax.rpc.UnaryCallSettings;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.appengine.v1.DeleteServiceRequest;
import com.google.appengine.v1.GetServiceRequest;
import com.google.appengine.v1.ListServicesRequest;
import com.google.appengine.v1.ListServicesResponse;
import com.google.appengine.v1.OperationMetadataV1;
import com.google.appengine.v1.Service;
import com.google.appengine.v1.UpdateServiceRequest;
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.Operation;
import com.google.protobuf.Empty;
import java.io.IOException;
import java.util.List;
import javax.annotation.Generated;
import org.threeten.bp.Duration;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Settings class to configure an instance of {@link ServicesStub}.
*
* <p>The default instance has everything set to sensible defaults:
*
* <ul>
* <li>The default service address (appengine.googleapis.com) and default port (443) are used.
* <li>Credentials are acquired automatically through Application Default Credentials.
* <li>Retries are configured for idempotent methods but not for non-idempotent methods.
* </ul>
*
* <p>The builder of this class is recursive, so contained classes are themselves builders. When
* build() is called, the tree of builders is called to create the complete settings object.
*
* <p>For example, to set the total timeout of getService to 30 seconds:
*
* <pre>{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* ServicesStubSettings.Builder servicesSettingsBuilder = ServicesStubSettings.newBuilder();
* servicesSettingsBuilder
* .getServiceSettings()
* .setRetrySettings(
* servicesSettingsBuilder.getServiceSettings().getRetrySettings().toBuilder()
* .setTotalTimeout(Duration.ofSeconds(30))
* .build());
* ServicesStubSettings servicesSettings = servicesSettingsBuilder.build();
* }</pre>
*/
@Generated("by gapic-generator-java")
public class ServicesStubSettings extends StubSettings<ServicesStubSettings> {
/** The default scopes of the service. */
private static final ImmutableList<String> DEFAULT_SERVICE_SCOPES =
ImmutableList.<String>builder()
.add("https://www.googleapis.com/auth/appengine.admin")
.add("https://www.googleapis.com/auth/cloud-platform")
.add("https://www.googleapis.com/auth/cloud-platform.read-only")
.build();
private final PagedCallSettings<
ListServicesRequest, ListServicesResponse, ListServicesPagedResponse>
listServicesSettings;
private final UnaryCallSettings<GetServiceRequest, Service> getServiceSettings;
private final UnaryCallSettings<UpdateServiceRequest, Operation> updateServiceSettings;
private final OperationCallSettings<UpdateServiceRequest, Service, OperationMetadataV1>
updateServiceOperationSettings;
private final UnaryCallSettings<DeleteServiceRequest, Operation> deleteServiceSettings;
private final OperationCallSettings<DeleteServiceRequest, Empty, OperationMetadataV1>
deleteServiceOperationSettings;
private static final PagedListDescriptor<ListServicesRequest, ListServicesResponse, Service>
LIST_SERVICES_PAGE_STR_DESC =
new PagedListDescriptor<ListServicesRequest, ListServicesResponse, Service>() {
@Override
public String emptyToken() {
return "";
}
@Override
public ListServicesRequest injectToken(ListServicesRequest payload, String token) {
return ListServicesRequest.newBuilder(payload).setPageToken(token).build();
}
@Override
public ListServicesRequest injectPageSize(ListServicesRequest payload, int pageSize) {
return ListServicesRequest.newBuilder(payload).setPageSize(pageSize).build();
}
@Override
public Integer extractPageSize(ListServicesRequest payload) {
return payload.getPageSize();
}
@Override
public String extractNextToken(ListServicesResponse payload) {
return payload.getNextPageToken();
}
@Override
public Iterable<Service> extractResources(ListServicesResponse payload) {
return payload.getServicesList() == null
? ImmutableList.<Service>of()
: payload.getServicesList();
}
};
private static final PagedListResponseFactory<
ListServicesRequest, ListServicesResponse, ListServicesPagedResponse>
LIST_SERVICES_PAGE_STR_FACT =
new PagedListResponseFactory<
ListServicesRequest, ListServicesResponse, ListServicesPagedResponse>() {
@Override
public ApiFuture<ListServicesPagedResponse> getFuturePagedResponse(
UnaryCallable<ListServicesRequest, ListServicesResponse> callable,
ListServicesRequest request,
ApiCallContext context,
ApiFuture<ListServicesResponse> futureResponse) {
PageContext<ListServicesRequest, ListServicesResponse, Service> pageContext =
PageContext.create(callable, LIST_SERVICES_PAGE_STR_DESC, request, context);
return ListServicesPagedResponse.createAsync(pageContext, futureResponse);
}
};
/** Returns the object with the settings used for calls to listServices. */
public PagedCallSettings<ListServicesRequest, ListServicesResponse, ListServicesPagedResponse>
listServicesSettings() {
return listServicesSettings;
}
/** Returns the object with the settings used for calls to getService. */
public UnaryCallSettings<GetServiceRequest, Service> getServiceSettings() {
return getServiceSettings;
}
/** Returns the object with the settings used for calls to updateService. */
public UnaryCallSettings<UpdateServiceRequest, Operation> updateServiceSettings() {
return updateServiceSettings;
}
/** Returns the object with the settings used for calls to updateService. */
public OperationCallSettings<UpdateServiceRequest, Service, OperationMetadataV1>
updateServiceOperationSettings() {
return updateServiceOperationSettings;
}
/** Returns the object with the settings used for calls to deleteService. */
public UnaryCallSettings<DeleteServiceRequest, Operation> deleteServiceSettings() {
return deleteServiceSettings;
}
/** Returns the object with the settings used for calls to deleteService. */
public OperationCallSettings<DeleteServiceRequest, Empty, OperationMetadataV1>
deleteServiceOperationSettings() {
return deleteServiceOperationSettings;
}
public ServicesStub createStub() throws IOException {
if (getTransportChannelProvider()
.getTransportName()
.equals(GrpcTransportChannel.getGrpcTransportName())) {
return GrpcServicesStub.create(this);
}
if (getTransportChannelProvider()
.getTransportName()
.equals(HttpJsonTransportChannel.getHttpJsonTransportName())) {
return HttpJsonServicesStub.create(this);
}
throw new UnsupportedOperationException(
String.format(
"Transport not supported: %s", getTransportChannelProvider().getTransportName()));
}
/** Returns a builder for the default ExecutorProvider for this service. */
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() {
return InstantiatingExecutorProvider.newBuilder();
}
/** Returns the default service endpoint. */
public static String getDefaultEndpoint() {
return "appengine.googleapis.com:443";
}
/** Returns the default mTLS service endpoint. */
public static String getDefaultMtlsEndpoint() {
return "appengine.mtls.googleapis.com:443";
}
/** Returns the default service scopes. */
public static List<String> getDefaultServiceScopes() {
return DEFAULT_SERVICE_SCOPES;
}
/** Returns a builder for the default credentials for this service. */
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() {
return GoogleCredentialsProvider.newBuilder()
.setScopesToApply(DEFAULT_SERVICE_SCOPES)
.setUseJwtAccessWithScope(true);
}
/** Returns a builder for the default gRPC ChannelProvider for this service. */
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
return InstantiatingGrpcChannelProvider.newBuilder()
.setMaxInboundMessageSize(Integer.MAX_VALUE);
}
/** Returns a builder for the default REST ChannelProvider for this service. */
@BetaApi
public static InstantiatingHttpJsonChannelProvider.Builder
defaultHttpJsonTransportProviderBuilder() {
return InstantiatingHttpJsonChannelProvider.newBuilder();
}
public static TransportChannelProvider defaultTransportChannelProvider() {
return defaultGrpcTransportProviderBuilder().build();
}
@BetaApi("The surface for customizing headers is not stable yet and may change in the future.")
public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder() {
return ApiClientHeaderProvider.newBuilder()
.setGeneratedLibToken("gapic", GaxProperties.getLibraryVersion(ServicesStubSettings.class))
.setTransportToken(
GaxGrpcProperties.getGrpcTokenName(), GaxGrpcProperties.getGrpcVersion());
}
@BetaApi("The surface for customizing headers is not stable yet and may change in the future.")
public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder() {
return ApiClientHeaderProvider.newBuilder()
.setGeneratedLibToken("gapic", GaxProperties.getLibraryVersion(ServicesStubSettings.class))
.setTransportToken(
GaxHttpJsonProperties.getHttpJsonTokenName(),
GaxHttpJsonProperties.getHttpJsonVersion());
}
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
return ServicesStubSettings.defaultGrpcApiClientHeaderProviderBuilder();
}
/** Returns a new gRPC builder for this class. */
public static Builder newBuilder() {
return Builder.createDefault();
}
/** Returns a new REST builder for this class. */
public static Builder newHttpJsonBuilder() {
return Builder.createHttpJsonDefault();
}
/** 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 ServicesStubSettings(Builder settingsBuilder) throws IOException {
super(settingsBuilder);
listServicesSettings = settingsBuilder.listServicesSettings().build();
getServiceSettings = settingsBuilder.getServiceSettings().build();
updateServiceSettings = settingsBuilder.updateServiceSettings().build();
updateServiceOperationSettings = settingsBuilder.updateServiceOperationSettings().build();
deleteServiceSettings = settingsBuilder.deleteServiceSettings().build();
deleteServiceOperationSettings = settingsBuilder.deleteServiceOperationSettings().build();
}
/** Builder for ServicesStubSettings. */
public static class Builder extends StubSettings.Builder<ServicesStubSettings, Builder> {
private final ImmutableList<UnaryCallSettings.Builder<?, ?>> unaryMethodSettingsBuilders;
private final PagedCallSettings.Builder<
ListServicesRequest, ListServicesResponse, ListServicesPagedResponse>
listServicesSettings;
private final UnaryCallSettings.Builder<GetServiceRequest, Service> getServiceSettings;
private final UnaryCallSettings.Builder<UpdateServiceRequest, Operation> updateServiceSettings;
private final OperationCallSettings.Builder<UpdateServiceRequest, Service, OperationMetadataV1>
updateServiceOperationSettings;
private final UnaryCallSettings.Builder<DeleteServiceRequest, Operation> deleteServiceSettings;
private final OperationCallSettings.Builder<DeleteServiceRequest, Empty, OperationMetadataV1>
deleteServiceOperationSettings;
private static final ImmutableMap<String, ImmutableSet<StatusCode.Code>>
RETRYABLE_CODE_DEFINITIONS;
static {
ImmutableMap.Builder<String, ImmutableSet<StatusCode.Code>> definitions =
ImmutableMap.builder();
definitions.put(
"no_retry_0_codes", 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()
.setInitialRpcTimeout(Duration.ofMillis(60000L))
.setRpcTimeoutMultiplier(1.0)
.setMaxRpcTimeout(Duration.ofMillis(60000L))
.setTotalTimeout(Duration.ofMillis(60000L))
.build();
definitions.put("no_retry_0_params", settings);
RETRY_PARAM_DEFINITIONS = definitions.build();
}
protected Builder() {
this(((ClientContext) null));
}
protected Builder(ClientContext clientContext) {
super(clientContext);
listServicesSettings = PagedCallSettings.newBuilder(LIST_SERVICES_PAGE_STR_FACT);
getServiceSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
updateServiceSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
updateServiceOperationSettings = OperationCallSettings.newBuilder();
deleteServiceSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
deleteServiceOperationSettings = OperationCallSettings.newBuilder();
unaryMethodSettingsBuilders =
ImmutableList.<UnaryCallSettings.Builder<?, ?>>of(
listServicesSettings,
getServiceSettings,
updateServiceSettings,
deleteServiceSettings);
initDefaults(this);
}
protected Builder(ServicesStubSettings settings) {
super(settings);
listServicesSettings = settings.listServicesSettings.toBuilder();
getServiceSettings = settings.getServiceSettings.toBuilder();
updateServiceSettings = settings.updateServiceSettings.toBuilder();
updateServiceOperationSettings = settings.updateServiceOperationSettings.toBuilder();
deleteServiceSettings = settings.deleteServiceSettings.toBuilder();
deleteServiceOperationSettings = settings.deleteServiceOperationSettings.toBuilder();
unaryMethodSettingsBuilders =
ImmutableList.<UnaryCallSettings.Builder<?, ?>>of(
listServicesSettings,
getServiceSettings,
updateServiceSettings,
deleteServiceSettings);
}
private static Builder createDefault() {
Builder builder = new Builder(((ClientContext) null));
builder.setTransportChannelProvider(defaultTransportChannelProvider());
builder.setCredentialsProvider(defaultCredentialsProviderBuilder().build());
builder.setInternalHeaderProvider(defaultApiClientHeaderProviderBuilder().build());
builder.setEndpoint(getDefaultEndpoint());
builder.setMtlsEndpoint(getDefaultMtlsEndpoint());
builder.setSwitchToMtlsEndpointAllowed(true);
return initDefaults(builder);
}
private static Builder createHttpJsonDefault() {
Builder builder = new Builder(((ClientContext) null));
builder.setTransportChannelProvider(defaultHttpJsonTransportProviderBuilder().build());
builder.setCredentialsProvider(defaultCredentialsProviderBuilder().build());
builder.setInternalHeaderProvider(defaultHttpJsonApiClientHeaderProviderBuilder().build());
builder.setEndpoint(getDefaultEndpoint());
builder.setMtlsEndpoint(getDefaultMtlsEndpoint());
builder.setSwitchToMtlsEndpointAllowed(true);
return initDefaults(builder);
}
private static Builder initDefaults(Builder builder) {
builder
.listServicesSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("no_retry_0_codes"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("no_retry_0_params"));
builder
.getServiceSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("no_retry_0_codes"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("no_retry_0_params"));
builder
.updateServiceSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("no_retry_0_codes"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("no_retry_0_params"));
builder
.deleteServiceSettings()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("no_retry_0_codes"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("no_retry_0_params"));
builder
.updateServiceOperationSettings()
.setInitialCallSettings(
UnaryCallSettings
.<UpdateServiceRequest, OperationSnapshot>newUnaryCallSettingsBuilder()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("no_retry_0_codes"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("no_retry_0_params"))
.build())
.setResponseTransformer(
ProtoOperationTransformers.ResponseTransformer.create(Service.class))
.setMetadataTransformer(
ProtoOperationTransformers.MetadataTransformer.create(OperationMetadataV1.class))
.setPollingAlgorithm(
OperationTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelay(Duration.ofMillis(5000L))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelay(Duration.ofMillis(45000L))
.setInitialRpcTimeout(Duration.ZERO)
.setRpcTimeoutMultiplier(1.0)
.setMaxRpcTimeout(Duration.ZERO)
.setTotalTimeout(Duration.ofMillis(300000L))
.build()));
builder
.deleteServiceOperationSettings()
.setInitialCallSettings(
UnaryCallSettings
.<DeleteServiceRequest, OperationSnapshot>newUnaryCallSettingsBuilder()
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("no_retry_0_codes"))
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("no_retry_0_params"))
.build())
.setResponseTransformer(
ProtoOperationTransformers.ResponseTransformer.create(Empty.class))
.setMetadataTransformer(
ProtoOperationTransformers.MetadataTransformer.create(OperationMetadataV1.class))
.setPollingAlgorithm(
OperationTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelay(Duration.ofMillis(5000L))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelay(Duration.ofMillis(45000L))
.setInitialRpcTimeout(Duration.ZERO)
.setRpcTimeoutMultiplier(1.0)
.setMaxRpcTimeout(Duration.ZERO)
.setTotalTimeout(Duration.ofMillis(300000L))
.build()));
return builder;
}
/**
* 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) {
super.applyToAllUnaryMethods(unaryMethodSettingsBuilders, settingsUpdater);
return this;
}
public ImmutableList<UnaryCallSettings.Builder<?, ?>> unaryMethodSettingsBuilders() {
return unaryMethodSettingsBuilders;
}
/** Returns the builder for the settings used for calls to listServices. */
public PagedCallSettings.Builder<
ListServicesRequest, ListServicesResponse, ListServicesPagedResponse>
listServicesSettings() {
return listServicesSettings;
}
/** Returns the builder for the settings used for calls to getService. */
public UnaryCallSettings.Builder<GetServiceRequest, Service> getServiceSettings() {
return getServiceSettings;
}
/** Returns the builder for the settings used for calls to updateService. */
public UnaryCallSettings.Builder<UpdateServiceRequest, Operation> updateServiceSettings() {
return updateServiceSettings;
}
/** Returns the builder for the settings used for calls to updateService. */
@BetaApi(
"The surface for use by generated code is not stable yet and may change in the future.")
public OperationCallSettings.Builder<UpdateServiceRequest, Service, OperationMetadataV1>
updateServiceOperationSettings() {
return updateServiceOperationSettings;
}
/** Returns the builder for the settings used for calls to deleteService. */
public UnaryCallSettings.Builder<DeleteServiceRequest, Operation> deleteServiceSettings() {
return deleteServiceSettings;
}
/** Returns the builder for the settings used for calls to deleteService. */
@BetaApi(
"The surface for use by generated code is not stable yet and may change in the future.")
public OperationCallSettings.Builder<DeleteServiceRequest, Empty, OperationMetadataV1>
deleteServiceOperationSettings() {
return deleteServiceOperationSettings;
}
@Override
public ServicesStubSettings build() throws IOException {
return new ServicesStubSettings(this);
}
}
}