com.google.ads.admanager.v1.CustomTargetingValueServiceSettings Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ad-manager Show documentation
Google Ad Manager API The Ad Manager API enables an app to integrate with Google Ad Manager. You can read Ad Manager data and run reports using the API.
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.admanager.v1;

import static com.google.ads.admanager.v1.CustomTargetingValueServiceClient.ListCustomTargetingValuesPagedResponse;

import com.google.ads.admanager.v1.stub.CustomTargetingValueServiceStubSettings;
import com.google.api.core.ApiFunction;
import com.google.api.gax.core.GoogleCredentialsProvider;
import com.google.api.gax.core.InstantiatingExecutorProvider;
import com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider;
import com.google.api.gax.rpc.ApiClientHeaderProvider;
import com.google.api.gax.rpc.ClientContext;
import com.google.api.gax.rpc.ClientSettings;
import com.google.api.gax.rpc.PagedCallSettings;
import com.google.api.gax.rpc.TransportChannelProvider;
import com.google.api.gax.rpc.UnaryCallSettings;
import java.io.IOException;
import java.util.List;
import javax.annotation.Generated;

// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
 * Settings class to configure an instance of {@link CustomTargetingValueServiceClient}.
 *
 * The default instance has everything set to sensible defaults:
 *
 * 

 *   The default service address (admanager.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
 * [RetrySettings](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings)
 * of getCustomTargetingValue:
 *
 * 
{@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
 * CustomTargetingValueServiceSettings.Builder customTargetingValueServiceSettingsBuilder =
 *     CustomTargetingValueServiceSettings.newBuilder();
 * customTargetingValueServiceSettingsBuilder
 *     .getCustomTargetingValueSettings()
 *     .setRetrySettings(
 *         customTargetingValueServiceSettingsBuilder
 *             .getCustomTargetingValueSettings()
 *             .getRetrySettings()
 *             .toBuilder()
 *             .setInitialRetryDelayDuration(Duration.ofSeconds(1))
 *             .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
 *             .setMaxAttempts(5)
 *             .setMaxRetryDelayDuration(Duration.ofSeconds(30))
 *             .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
 *             .setRetryDelayMultiplier(1.3)
 *             .setRpcTimeoutMultiplier(1.5)
 *             .setTotalTimeoutDuration(Duration.ofSeconds(300))
 *             .build());
 * CustomTargetingValueServiceSettings customTargetingValueServiceSettings =
 *     customTargetingValueServiceSettingsBuilder.build();
 * }
 *
 * Please refer to the [Client Side Retry
 * Guide](https://github.com/googleapis/google-cloud-java/blob/main/docs/client_retries.md) for
 * additional support in setting retries.
 */
@Generated("by gapic-generator-java")
public class CustomTargetingValueServiceSettings
    extends ClientSettings {

  /** Returns the object with the settings used for calls to getCustomTargetingValue. */
  public UnaryCallSettings
      getCustomTargetingValueSettings() {
    return ((CustomTargetingValueServiceStubSettings) getStubSettings())
        .getCustomTargetingValueSettings();
  }

  /** Returns the object with the settings used for calls to listCustomTargetingValues. */
  public PagedCallSettings<
          ListCustomTargetingValuesRequest,
          ListCustomTargetingValuesResponse,
          ListCustomTargetingValuesPagedResponse>
      listCustomTargetingValuesSettings() {
    return ((CustomTargetingValueServiceStubSettings) getStubSettings())
        .listCustomTargetingValuesSettings();
  }

  public static final CustomTargetingValueServiceSettings create(
      CustomTargetingValueServiceStubSettings stub) throws IOException {
    return new CustomTargetingValueServiceSettings.Builder(stub.toBuilder()).build();
  }

  /** Returns a builder for the default ExecutorProvider for this service. */
  public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() {
    return CustomTargetingValueServiceStubSettings.defaultExecutorProviderBuilder();
  }

  /** Returns the default service endpoint. */
  public static String getDefaultEndpoint() {
    return CustomTargetingValueServiceStubSettings.getDefaultEndpoint();
  }

  /** Returns the default service scopes. */
  public static List getDefaultServiceScopes() {
    return CustomTargetingValueServiceStubSettings.getDefaultServiceScopes();
  }

  /** Returns a builder for the default credentials for this service. */
  public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() {
    return CustomTargetingValueServiceStubSettings.defaultCredentialsProviderBuilder();
  }

  /** Returns a builder for the default ChannelProvider for this service. */
  public static InstantiatingHttpJsonChannelProvider.Builder
      defaultHttpJsonTransportProviderBuilder() {
    return CustomTargetingValueServiceStubSettings.defaultHttpJsonTransportProviderBuilder();
  }

  public static TransportChannelProvider defaultTransportChannelProvider() {
    return CustomTargetingValueServiceStubSettings.defaultTransportChannelProvider();
  }

  public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
    return CustomTargetingValueServiceStubSettings.defaultApiClientHeaderProviderBuilder();
  }

  /** 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 CustomTargetingValueServiceSettings(Builder settingsBuilder) throws IOException {
    super(settingsBuilder);
  }

  /** Builder for CustomTargetingValueServiceSettings. */
  public static class Builder
      extends ClientSettings.Builder {

    protected Builder() throws IOException {
      this(((ClientContext) null));
    }

    protected Builder(ClientContext clientContext) {
      super(CustomTargetingValueServiceStubSettings.newBuilder(clientContext));
    }

    protected Builder(CustomTargetingValueServiceSettings settings) {
      super(settings.getStubSettings().toBuilder());
    }

    protected Builder(CustomTargetingValueServiceStubSettings.Builder stubSettings) {
      super(stubSettings);
    }

    private static Builder createDefault() {
      return new Builder(CustomTargetingValueServiceStubSettings.newBuilder());
    }

    public CustomTargetingValueServiceStubSettings.Builder getStubSettingsBuilder() {
      return ((CustomTargetingValueServiceStubSettings.Builder) getStubSettings());
    }

    /**
     * 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(
          getStubSettingsBuilder().unaryMethodSettingsBuilders(), settingsUpdater);
      return this;
    }

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

    /** Returns the builder for the settings used for calls to listCustomTargetingValues. */
    public PagedCallSettings.Builder<
            ListCustomTargetingValuesRequest,
            ListCustomTargetingValuesResponse,
            ListCustomTargetingValuesPagedResponse>
        listCustomTargetingValuesSettings() {
      return getStubSettingsBuilder().listCustomTargetingValuesSettings();
    }

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