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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-ads-stubs-v17 Show documentation
Stubs for GAAPI version google-ads-stubs-v17
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.KeywordPlanIdeaServiceClient.GenerateKeywordIdeasPagedResponse;

import com.google.ads.googleads.v17.services.GenerateAdGroupThemesRequest;
import com.google.ads.googleads.v17.services.GenerateAdGroupThemesResponse;
import com.google.ads.googleads.v17.services.GenerateKeywordForecastMetricsRequest;
import com.google.ads.googleads.v17.services.GenerateKeywordForecastMetricsResponse;
import com.google.ads.googleads.v17.services.GenerateKeywordHistoricalMetricsRequest;
import com.google.ads.googleads.v17.services.GenerateKeywordHistoricalMetricsResponse;
import com.google.ads.googleads.v17.services.GenerateKeywordIdeaResponse;
import com.google.ads.googleads.v17.services.GenerateKeywordIdeaResult;
import com.google.ads.googleads.v17.services.GenerateKeywordIdeasRequest;
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.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 KeywordPlanIdeaServiceStub}.
 *
 * 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 generateKeywordHistoricalMetrics 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
 * KeywordPlanIdeaServiceStubSettings.Builder keywordPlanIdeaServiceSettingsBuilder =
 *     KeywordPlanIdeaServiceStubSettings.newBuilder();
 * keywordPlanIdeaServiceSettingsBuilder
 *     .generateKeywordHistoricalMetricsSettings()
 *     .setRetrySettings(
 *         keywordPlanIdeaServiceSettingsBuilder
 *             .generateKeywordHistoricalMetricsSettings()
 *             .getRetrySettings()
 *             .toBuilder()
 *             .setTotalTimeout(Duration.ofSeconds(30))
 *             .build());
 * KeywordPlanIdeaServiceStubSettings keywordPlanIdeaServiceSettings =
 *     keywordPlanIdeaServiceSettingsBuilder.build();
 * }
 */
@Generated("by gapic-generator-java")
public class KeywordPlanIdeaServiceStubSettings
    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<
          GenerateKeywordIdeasRequest,
          GenerateKeywordIdeaResponse,
          GenerateKeywordIdeasPagedResponse>
      generateKeywordIdeasSettings;
  private final UnaryCallSettings<
          GenerateKeywordHistoricalMetricsRequest, GenerateKeywordHistoricalMetricsResponse>
      generateKeywordHistoricalMetricsSettings;
  private final UnaryCallSettings
      generateAdGroupThemesSettings;
  private final UnaryCallSettings<
          GenerateKeywordForecastMetricsRequest, GenerateKeywordForecastMetricsResponse>
      generateKeywordForecastMetricsSettings;

  private static final PagedListDescriptor<
          GenerateKeywordIdeasRequest, GenerateKeywordIdeaResponse, GenerateKeywordIdeaResult>
      GENERATE_KEYWORD_IDEAS_PAGE_STR_DESC =
          new PagedListDescriptor<
              GenerateKeywordIdeasRequest,
              GenerateKeywordIdeaResponse,
              GenerateKeywordIdeaResult>() {
            @Override
            public String emptyToken() {
              return "";
            }

            @Override
            public GenerateKeywordIdeasRequest injectToken(
                GenerateKeywordIdeasRequest payload, String token) {
              return GenerateKeywordIdeasRequest.newBuilder(payload).setPageToken(token).build();
            }

            @Override
            public GenerateKeywordIdeasRequest injectPageSize(
                GenerateKeywordIdeasRequest payload, int pageSize) {
              return GenerateKeywordIdeasRequest.newBuilder(payload).setPageSize(pageSize).build();
            }

            @Override
            public Integer extractPageSize(GenerateKeywordIdeasRequest payload) {
              return payload.getPageSize();
            }

            @Override
            public String extractNextToken(GenerateKeywordIdeaResponse payload) {
              return payload.getNextPageToken();
            }

            @Override
            public Iterable extractResources(
                GenerateKeywordIdeaResponse payload) {
              return payload.getResultsList() == null
                  ? ImmutableList.of()
                  : payload.getResultsList();
            }
          };

  private static final PagedListResponseFactory<
          GenerateKeywordIdeasRequest,
          GenerateKeywordIdeaResponse,
          GenerateKeywordIdeasPagedResponse>
      GENERATE_KEYWORD_IDEAS_PAGE_STR_FACT =
          new PagedListResponseFactory<
              GenerateKeywordIdeasRequest,
              GenerateKeywordIdeaResponse,
              GenerateKeywordIdeasPagedResponse>() {
            @Override
            public ApiFuture getFuturePagedResponse(
                UnaryCallable callable,
                GenerateKeywordIdeasRequest request,
                ApiCallContext context,
                ApiFuture futureResponse) {
              PageContext<
                      GenerateKeywordIdeasRequest,
                      GenerateKeywordIdeaResponse,
                      GenerateKeywordIdeaResult>
                  pageContext =
                      PageContext.create(
                          callable, GENERATE_KEYWORD_IDEAS_PAGE_STR_DESC, request, context);
              return GenerateKeywordIdeasPagedResponse.createAsync(pageContext, futureResponse);
            }
          };

  /** Returns the object with the settings used for calls to generateKeywordIdeas. */
  public PagedCallSettings<
          GenerateKeywordIdeasRequest,
          GenerateKeywordIdeaResponse,
          GenerateKeywordIdeasPagedResponse>
      generateKeywordIdeasSettings() {
    return generateKeywordIdeasSettings;
  }

  /** Returns the object with the settings used for calls to generateKeywordHistoricalMetrics. */
  public UnaryCallSettings<
          GenerateKeywordHistoricalMetricsRequest, GenerateKeywordHistoricalMetricsResponse>
      generateKeywordHistoricalMetricsSettings() {
    return generateKeywordHistoricalMetricsSettings;
  }

  /** Returns the object with the settings used for calls to generateAdGroupThemes. */
  public UnaryCallSettings
      generateAdGroupThemesSettings() {
    return generateAdGroupThemesSettings;
  }

  /** Returns the object with the settings used for calls to generateKeywordForecastMetrics. */
  public UnaryCallSettings<
          GenerateKeywordForecastMetricsRequest, GenerateKeywordForecastMetricsResponse>
      generateKeywordForecastMetricsSettings() {
    return generateKeywordForecastMetricsSettings;
  }

  public KeywordPlanIdeaServiceStub createStub() throws IOException {
    if (getTransportChannelProvider()
        .getTransportName()
        .equals(GrpcTransportChannel.getGrpcTransportName())) {
      return GrpcKeywordPlanIdeaServiceStub.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(KeywordPlanIdeaServiceStubSettings.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 KeywordPlanIdeaServiceStubSettings(Builder settingsBuilder) throws IOException {
    super(settingsBuilder);

    generateKeywordIdeasSettings = settingsBuilder.generateKeywordIdeasSettings().build();
    generateKeywordHistoricalMetricsSettings =
        settingsBuilder.generateKeywordHistoricalMetricsSettings().build();
    generateAdGroupThemesSettings = settingsBuilder.generateAdGroupThemesSettings().build();
    generateKeywordForecastMetricsSettings =
        settingsBuilder.generateKeywordForecastMetricsSettings().build();
  }

  /** Builder for KeywordPlanIdeaServiceStubSettings. */
  public static class Builder
      extends StubSettings.Builder {
    private final ImmutableList> unaryMethodSettingsBuilders;
    private final PagedCallSettings.Builder<
            GenerateKeywordIdeasRequest,
            GenerateKeywordIdeaResponse,
            GenerateKeywordIdeasPagedResponse>
        generateKeywordIdeasSettings;
    private final UnaryCallSettings.Builder<
            GenerateKeywordHistoricalMetricsRequest, GenerateKeywordHistoricalMetricsResponse>
        generateKeywordHistoricalMetricsSettings;
    private final UnaryCallSettings.Builder<
            GenerateAdGroupThemesRequest, GenerateAdGroupThemesResponse>
        generateAdGroupThemesSettings;
    private final UnaryCallSettings.Builder<
            GenerateKeywordForecastMetricsRequest, GenerateKeywordForecastMetricsResponse>
        generateKeywordForecastMetricsSettings;
    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);

      generateKeywordIdeasSettings =
          PagedCallSettings.newBuilder(GENERATE_KEYWORD_IDEAS_PAGE_STR_FACT);
      generateKeywordHistoricalMetricsSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
      generateAdGroupThemesSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
      generateKeywordForecastMetricsSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();

      unaryMethodSettingsBuilders =
          ImmutableList.>of(
              generateKeywordIdeasSettings,
              generateKeywordHistoricalMetricsSettings,
              generateAdGroupThemesSettings,
              generateKeywordForecastMetricsSettings);
      initDefaults(this);
    }

    protected Builder(KeywordPlanIdeaServiceStubSettings settings) {
      super(settings);

      generateKeywordIdeasSettings = settings.generateKeywordIdeasSettings.toBuilder();
      generateKeywordHistoricalMetricsSettings =
          settings.generateKeywordHistoricalMetricsSettings.toBuilder();
      generateAdGroupThemesSettings = settings.generateAdGroupThemesSettings.toBuilder();
      generateKeywordForecastMetricsSettings =
          settings.generateKeywordForecastMetricsSettings.toBuilder();

      unaryMethodSettingsBuilders =
          ImmutableList.>of(
              generateKeywordIdeasSettings,
              generateKeywordHistoricalMetricsSettings,
              generateAdGroupThemesSettings,
              generateKeywordForecastMetricsSettings);
    }

    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
          .generateKeywordIdeasSettings()
          .setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_0_codes"))
          .setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_0_params"));

      builder
          .generateKeywordHistoricalMetricsSettings()
          .setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_0_codes"))
          .setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_0_params"));

      builder
          .generateAdGroupThemesSettings()
          .setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_0_codes"))
          .setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_0_params"));

      builder
          .generateKeywordForecastMetricsSettings()
          .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 generateKeywordIdeas. */
    public PagedCallSettings.Builder<
            GenerateKeywordIdeasRequest,
            GenerateKeywordIdeaResponse,
            GenerateKeywordIdeasPagedResponse>
        generateKeywordIdeasSettings() {
      return generateKeywordIdeasSettings;
    }

    /** Returns the builder for the settings used for calls to generateKeywordHistoricalMetrics. */
    public UnaryCallSettings.Builder<
            GenerateKeywordHistoricalMetricsRequest, GenerateKeywordHistoricalMetricsResponse>
        generateKeywordHistoricalMetricsSettings() {
      return generateKeywordHistoricalMetricsSettings;
    }

    /** Returns the builder for the settings used for calls to generateAdGroupThemes. */
    public UnaryCallSettings.Builder
        generateAdGroupThemesSettings() {
      return generateAdGroupThemesSettings;
    }

    /** Returns the builder for the settings used for calls to generateKeywordForecastMetrics. */
    public UnaryCallSettings.Builder<
            GenerateKeywordForecastMetricsRequest, GenerateKeywordForecastMetricsResponse>
        generateKeywordForecastMetricsSettings() {
      return generateKeywordForecastMetricsSettings;
    }

    @Override
    public KeywordPlanIdeaServiceStubSettings build() throws IOException {
      return new KeywordPlanIdeaServiceStubSettings(this);
    }
  }
}