com.google.ads.admanager.v1.stub.RoleServiceStubSettings 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.
There is a newer version: 0.14.0
Show 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.stub;

import static com.google.ads.admanager.v1.RoleServiceClient.ListRolesPagedResponse;

import com.google.ads.admanager.v1.GetRoleRequest;
import com.google.ads.admanager.v1.ListRolesRequest;
import com.google.ads.admanager.v1.ListRolesResponse;
import com.google.ads.admanager.v1.Role;
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.httpjson.GaxHttpJsonProperties;
import com.google.api.gax.httpjson.HttpJsonTransportChannel;
import com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider;
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;

// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
 * Settings class to configure an instance of {@link RoleServiceStub}.
 *
 * 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 total timeout of getRole 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
 * RoleServiceStubSettings.Builder roleServiceSettingsBuilder =
 *     RoleServiceStubSettings.newBuilder();
 * roleServiceSettingsBuilder
 *     .getRoleSettings()
 *     .setRetrySettings(
 *         roleServiceSettingsBuilder
 *             .getRoleSettings()
 *             .getRetrySettings()
 *             .toBuilder()
 *             .setTotalTimeout(Duration.ofSeconds(30))
 *             .build());
 * RoleServiceStubSettings roleServiceSettings = roleServiceSettingsBuilder.build();
 * }
 */
@Generated("by gapic-generator-java")
public class RoleServiceStubSettings extends StubSettings {
  /** The default scopes of the service. */
  private static final ImmutableList DEFAULT_SERVICE_SCOPES =
      ImmutableList.builder().build();

  private final UnaryCallSettings getRoleSettings;
  private final PagedCallSettings
      listRolesSettings;

  private static final PagedListDescriptor
      LIST_ROLES_PAGE_STR_DESC =
          new PagedListDescriptor() {
            @Override
            public String emptyToken() {
              return "";
            }

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

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

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

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

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

  private static final PagedListResponseFactory<
          ListRolesRequest, ListRolesResponse, ListRolesPagedResponse>
      LIST_ROLES_PAGE_STR_FACT =
          new PagedListResponseFactory<
              ListRolesRequest, ListRolesResponse, ListRolesPagedResponse>() {
            @Override
            public ApiFuture getFuturePagedResponse(
                UnaryCallable callable,
                ListRolesRequest request,
                ApiCallContext context,
                ApiFuture futureResponse) {
              PageContext pageContext =
                  PageContext.create(callable, LIST_ROLES_PAGE_STR_DESC, request, context);
              return ListRolesPagedResponse.createAsync(pageContext, futureResponse);
            }
          };

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

  /** Returns the object with the settings used for calls to listRoles. */
  public PagedCallSettings
      listRolesSettings() {
    return listRolesSettings;
  }

  public RoleServiceStub createStub() throws IOException {
    if (getTransportChannelProvider()
        .getTransportName()
        .equals(HttpJsonTransportChannel.getHttpJsonTransportName())) {
      return HttpJsonRoleServiceStub.create(this);
    }
    throw new UnsupportedOperationException(
        String.format(
            "Transport not supported: %s", getTransportChannelProvider().getTransportName()));
  }

  /** Returns the default service name. */
  @Override
  public String getServiceName() {
    return "admanager";
  }

  /** 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 "admanager.googleapis.com:443";
  }

  /** Returns the default mTLS service endpoint. */
  public static String getDefaultMtlsEndpoint() {
    return "admanager.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 InstantiatingHttpJsonChannelProvider.Builder
      defaultHttpJsonTransportProviderBuilder() {
    return InstantiatingHttpJsonChannelProvider.newBuilder();
  }

  public static TransportChannelProvider defaultTransportChannelProvider() {
    return defaultHttpJsonTransportProviderBuilder().build();
  }

  public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
    return ApiClientHeaderProvider.newBuilder()
        .setGeneratedLibToken(
            "gapic", GaxProperties.getLibraryVersion(RoleServiceStubSettings.class))
        .setTransportToken(
            GaxHttpJsonProperties.getHttpJsonTokenName(),
            GaxHttpJsonProperties.getHttpJsonVersion());
  }

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

    getRoleSettings = settingsBuilder.getRoleSettings().build();
    listRolesSettings = settingsBuilder.listRolesSettings().build();
  }

  /** Builder for RoleServiceStubSettings. */
  public static class Builder extends StubSettings.Builder {
    private final ImmutableList> unaryMethodSettingsBuilders;
    private final UnaryCallSettings.Builder getRoleSettings;
    private final PagedCallSettings.Builder<
            ListRolesRequest, ListRolesResponse, ListRolesPagedResponse>
        listRolesSettings;
    private static final ImmutableMap>
        RETRYABLE_CODE_DEFINITIONS;

    static {
      ImmutableMap.Builder> definitions =
          ImmutableMap.builder();
      definitions.put("no_retry_codes", 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().setRpcTimeoutMultiplier(1.0).build();
      definitions.put("no_retry_params", settings);
      RETRY_PARAM_DEFINITIONS = definitions.build();
    }

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

    protected Builder(ClientContext clientContext) {
      super(clientContext);

      getRoleSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
      listRolesSettings = PagedCallSettings.newBuilder(LIST_ROLES_PAGE_STR_FACT);

      unaryMethodSettingsBuilders =
          ImmutableList.>of(getRoleSettings, listRolesSettings);
      initDefaults(this);
    }

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

      getRoleSettings = settings.getRoleSettings.toBuilder();
      listRolesSettings = settings.listRolesSettings.toBuilder();

      unaryMethodSettingsBuilders =
          ImmutableList.>of(getRoleSettings, listRolesSettings);
    }

    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
          .getRoleSettings()
          .setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("no_retry_codes"))
          .setRetrySettings(RETRY_PARAM_DEFINITIONS.get("no_retry_params"));

      builder
          .listRolesSettings()
          .setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("no_retry_codes"))
          .setRetrySettings(RETRY_PARAM_DEFINITIONS.get("no_retry_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 getRole. */
    public UnaryCallSettings.Builder getRoleSettings() {
      return getRoleSettings;
    }

    /** Returns the builder for the settings used for calls to listRoles. */
    public PagedCallSettings.Builder
        listRolesSettings() {
      return listRolesSettings;
    }

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