All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.google.ads.googleads.v17.services.stub.GoogleAdsServiceStubSettings Maven / Gradle / Ivy

The newest version!
/*
 * Copyright 2024 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.ads.googleads.v17.services.stub;

import static com.google.ads.googleads.v17.services.GoogleAdsServiceClient.SearchPagedResponse;

import com.google.ads.googleads.v17.services.GoogleAdsRow;
import com.google.ads.googleads.v17.services.MutateGoogleAdsRequest;
import com.google.ads.googleads.v17.services.MutateGoogleAdsResponse;
import com.google.ads.googleads.v17.services.SearchGoogleAdsRequest;
import com.google.ads.googleads.v17.services.SearchGoogleAdsResponse;
import com.google.ads.googleads.v17.services.SearchGoogleAdsStreamRequest;
import com.google.ads.googleads.v17.services.SearchGoogleAdsStreamResponse;
import com.google.api.core.ApiFunction;
import com.google.api.core.ApiFuture;
import com.google.api.core.ObsoleteApi;
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.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.ServerStreamingCallSettings;
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.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Lists;
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 GoogleAdsServiceStub}.
 *
 * 

The default instance has everything set to sensible defaults: * *

    *
  • The default service address (googleads.googleapis.com) and default port (443) are used. *
  • Credentials are acquired automatically through Application Default Credentials. *
  • Retries are configured for idempotent methods but not for non-idempotent methods. *
* *

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. * *

For example, to set the total timeout of mutate to 30 seconds: * *

{@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
 * GoogleAdsServiceStubSettings.Builder googleAdsServiceSettingsBuilder =
 *     GoogleAdsServiceStubSettings.newBuilder();
 * googleAdsServiceSettingsBuilder
 *     .mutateSettings()
 *     .setRetrySettings(
 *         googleAdsServiceSettingsBuilder
 *             .mutateSettings()
 *             .getRetrySettings()
 *             .toBuilder()
 *             .setTotalTimeout(Duration.ofSeconds(30))
 *             .build());
 * GoogleAdsServiceStubSettings googleAdsServiceSettings = googleAdsServiceSettingsBuilder.build();
 * }
*/ @Generated("by gapic-generator-java") public class GoogleAdsServiceStubSettings extends StubSettings { /** The default scopes of the service. */ private static final ImmutableList DEFAULT_SERVICE_SCOPES = ImmutableList.builder().add("https://www.googleapis.com/auth/adwords").build(); private final PagedCallSettings< SearchGoogleAdsRequest, SearchGoogleAdsResponse, SearchPagedResponse> searchSettings; private final ServerStreamingCallSettings< SearchGoogleAdsStreamRequest, SearchGoogleAdsStreamResponse> searchStreamSettings; private final UnaryCallSettings mutateSettings; private static final PagedListDescriptor< SearchGoogleAdsRequest, SearchGoogleAdsResponse, GoogleAdsRow> SEARCH_PAGE_STR_DESC = new PagedListDescriptor() { @Override public String emptyToken() { return ""; } @Override public SearchGoogleAdsRequest injectToken( SearchGoogleAdsRequest payload, String token) { return SearchGoogleAdsRequest.newBuilder(payload).setPageToken(token).build(); } @Override public SearchGoogleAdsRequest injectPageSize( SearchGoogleAdsRequest payload, int pageSize) { return SearchGoogleAdsRequest.newBuilder(payload).setPageSize(pageSize).build(); } @Override public Integer extractPageSize(SearchGoogleAdsRequest payload) { return payload.getPageSize(); } @Override public String extractNextToken(SearchGoogleAdsResponse payload) { return payload.getNextPageToken(); } @Override public Iterable extractResources(SearchGoogleAdsResponse payload) { return payload.getResultsList() == null ? ImmutableList.of() : payload.getResultsList(); } }; private static final PagedListResponseFactory< SearchGoogleAdsRequest, SearchGoogleAdsResponse, SearchPagedResponse> SEARCH_PAGE_STR_FACT = new PagedListResponseFactory< SearchGoogleAdsRequest, SearchGoogleAdsResponse, SearchPagedResponse>() { @Override public ApiFuture getFuturePagedResponse( UnaryCallable callable, SearchGoogleAdsRequest request, ApiCallContext context, ApiFuture futureResponse) { PageContext pageContext = PageContext.create(callable, SEARCH_PAGE_STR_DESC, request, context); return SearchPagedResponse.createAsync(pageContext, futureResponse); } }; /** Returns the object with the settings used for calls to search. */ public PagedCallSettings searchSettings() { return searchSettings; } /** Returns the object with the settings used for calls to searchStream. */ public ServerStreamingCallSettings searchStreamSettings() { return searchStreamSettings; } /** Returns the object with the settings used for calls to mutate. */ public UnaryCallSettings mutateSettings() { return mutateSettings; } public GoogleAdsServiceStub createStub() throws IOException { if (getTransportChannelProvider() .getTransportName() .equals(GrpcTransportChannel.getGrpcTransportName())) { return GrpcGoogleAdsServiceStub.create(this); } throw new UnsupportedOperationException( String.format( "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } /** Returns the default service name. */ @Override public String getServiceName() { return "googleads"; } /** Returns a builder for the default ExecutorProvider for this service. */ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { return InstantiatingExecutorProvider.newBuilder(); } /** Returns the default service endpoint. */ @ObsoleteApi("Use getEndpoint() instead") public static String getDefaultEndpoint() { return "googleads.googleapis.com:443"; } /** Returns the default mTLS service endpoint. */ public static String getDefaultMtlsEndpoint() { return "googleads.mtls.googleapis.com:443"; } /** Returns the default service scopes. */ public static List 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 ChannelProvider for this service. */ public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() { return InstantiatingGrpcChannelProvider.newBuilder() .setMaxInboundMessageSize(Integer.MAX_VALUE); } public static TransportChannelProvider defaultTransportChannelProvider() { return defaultGrpcTransportProviderBuilder().build(); } public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() { return ApiClientHeaderProvider.newBuilder() .setGeneratedLibToken( "gapic", GaxProperties.getLibraryVersion(GoogleAdsServiceStubSettings.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 GoogleAdsServiceStubSettings(Builder settingsBuilder) throws IOException { super(settingsBuilder); searchSettings = settingsBuilder.searchSettings().build(); searchStreamSettings = settingsBuilder.searchStreamSettings().build(); mutateSettings = settingsBuilder.mutateSettings().build(); } /** Builder for GoogleAdsServiceStubSettings. */ public static class Builder extends StubSettings.Builder { private final ImmutableList> unaryMethodSettingsBuilders; private final PagedCallSettings.Builder< SearchGoogleAdsRequest, SearchGoogleAdsResponse, SearchPagedResponse> searchSettings; private final ServerStreamingCallSettings.Builder< SearchGoogleAdsStreamRequest, SearchGoogleAdsStreamResponse> searchStreamSettings; private final UnaryCallSettings.Builder mutateSettings; private static final ImmutableMap> RETRYABLE_CODE_DEFINITIONS; static { ImmutableMap.Builder> definitions = ImmutableMap.builder(); definitions.put( "retry_policy_0_codes", ImmutableSet.copyOf( Lists.newArrayList( StatusCode.Code.UNAVAILABLE, StatusCode.Code.DEADLINE_EXCEEDED))); 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(5000L)) .setRetryDelayMultiplier(1.3) .setMaxRetryDelay(Duration.ofMillis(60000L)) .setInitialRpcTimeout(Duration.ofMillis(14400000L)) .setRpcTimeoutMultiplier(1.0) .setMaxRpcTimeout(Duration.ofMillis(14400000L)) .setTotalTimeout(Duration.ofMillis(14400000L)) .build(); definitions.put("retry_policy_0_params", settings); RETRY_PARAM_DEFINITIONS = definitions.build(); } protected Builder() { this(((ClientContext) null)); } protected Builder(ClientContext clientContext) { super(clientContext); searchSettings = PagedCallSettings.newBuilder(SEARCH_PAGE_STR_FACT); searchStreamSettings = ServerStreamingCallSettings.newBuilder(); mutateSettings = UnaryCallSettings.newUnaryCallSettingsBuilder(); unaryMethodSettingsBuilders = ImmutableList.>of(searchSettings, mutateSettings); initDefaults(this); } protected Builder(GoogleAdsServiceStubSettings settings) { super(settings); searchSettings = settings.searchSettings.toBuilder(); searchStreamSettings = settings.searchStreamSettings.toBuilder(); mutateSettings = settings.mutateSettings.toBuilder(); unaryMethodSettingsBuilders = ImmutableList.>of(searchSettings, mutateSettings); } private static Builder createDefault() { Builder builder = new Builder(((ClientContext) null)); builder.setTransportChannelProvider(defaultTransportChannelProvider()); builder.setCredentialsProvider(defaultCredentialsProviderBuilder().build()); builder.setInternalHeaderProvider(defaultApiClientHeaderProviderBuilder().build()); builder.setMtlsEndpoint(getDefaultMtlsEndpoint()); builder.setSwitchToMtlsEndpointAllowed(true); return initDefaults(builder); } private static Builder initDefaults(Builder builder) { builder .searchSettings() .setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_0_codes")) .setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_0_params")); builder .searchStreamSettings() .setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_0_codes")) .setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_0_params")); builder .mutateSettings() .setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_0_codes")) .setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_0_params")); return builder; } /** * 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) { super.applyToAllUnaryMethods(unaryMethodSettingsBuilders, settingsUpdater); return this; } public ImmutableList> unaryMethodSettingsBuilders() { return unaryMethodSettingsBuilders; } /** Returns the builder for the settings used for calls to search. */ public PagedCallSettings.Builder< SearchGoogleAdsRequest, SearchGoogleAdsResponse, SearchPagedResponse> searchSettings() { return searchSettings; } /** Returns the builder for the settings used for calls to searchStream. */ public ServerStreamingCallSettings.Builder< SearchGoogleAdsStreamRequest, SearchGoogleAdsStreamResponse> searchStreamSettings() { return searchStreamSettings; } /** Returns the builder for the settings used for calls to mutate. */ public UnaryCallSettings.Builder mutateSettings() { return mutateSettings; } @Override public GoogleAdsServiceStubSettings build() throws IOException { return new GoogleAdsServiceStubSettings(this); } } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy