com.google.cloud.privatecatalog.v1beta1.PrivateCatalogSettings Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of google-cloud-private-catalog Show documentation
Private Catalog allows developers and cloud admins to make their solutions discoverable to their internal enterprise users. Cloud admins can manage their solutions and ensure their users are always launching the latest versions.
There is a newer version: 0.56.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.cloud.privatecatalog.v1beta1;

import static com.google.cloud.privatecatalog.v1beta1.PrivateCatalogClient.SearchCatalogsPagedResponse;
import static com.google.cloud.privatecatalog.v1beta1.PrivateCatalogClient.SearchProductsPagedResponse;
import static com.google.cloud.privatecatalog.v1beta1.PrivateCatalogClient.SearchVersionsPagedResponse;

import com.google.api.core.ApiFunction;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.GoogleCredentialsProvider;
import com.google.api.gax.core.InstantiatingExecutorProvider;
import com.google.api.gax.grpc.InstantiatingGrpcChannelProvider;
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 com.google.cloud.privatecatalog.v1beta1.stub.PrivateCatalogStubSettings;
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 PrivateCatalogClient}.
 *
 * The default instance has everything set to sensible defaults:
 *
 * 

 *   The default service address (cloudprivatecatalog.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 searchCatalogs:
 *
 * 
{@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
 * PrivateCatalogSettings.Builder privateCatalogSettingsBuilder =
 *     PrivateCatalogSettings.newBuilder();
 * privateCatalogSettingsBuilder
 *     .searchCatalogsSettings()
 *     .setRetrySettings(
 *         privateCatalogSettingsBuilder
 *             .searchCatalogsSettings()
 *             .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());
 * PrivateCatalogSettings privateCatalogSettings = privateCatalogSettingsBuilder.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.
 */
@BetaApi
@Generated("by gapic-generator-java")
public class PrivateCatalogSettings extends ClientSettings {

  /** Returns the object with the settings used for calls to searchCatalogs. */
  public PagedCallSettings<
          SearchCatalogsRequest, SearchCatalogsResponse, SearchCatalogsPagedResponse>
      searchCatalogsSettings() {
    return ((PrivateCatalogStubSettings) getStubSettings()).searchCatalogsSettings();
  }

  /** Returns the object with the settings used for calls to searchProducts. */
  public PagedCallSettings<
          SearchProductsRequest, SearchProductsResponse, SearchProductsPagedResponse>
      searchProductsSettings() {
    return ((PrivateCatalogStubSettings) getStubSettings()).searchProductsSettings();
  }

  /** Returns the object with the settings used for calls to searchVersions. */
  public PagedCallSettings<
          SearchVersionsRequest, SearchVersionsResponse, SearchVersionsPagedResponse>
      searchVersionsSettings() {
    return ((PrivateCatalogStubSettings) getStubSettings()).searchVersionsSettings();
  }

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

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

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

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

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

  /** Returns a builder for the default gRPC ChannelProvider for this service. */
  public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
    return PrivateCatalogStubSettings.defaultGrpcTransportProviderBuilder();
  }

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

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

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

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

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

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

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

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

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

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

    private static Builder createHttpJsonDefault() {
      return new Builder(PrivateCatalogStubSettings.newHttpJsonBuilder());
    }

    public PrivateCatalogStubSettings.Builder getStubSettingsBuilder() {
      return ((PrivateCatalogStubSettings.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 searchCatalogs. */
    public PagedCallSettings.Builder<
            SearchCatalogsRequest, SearchCatalogsResponse, SearchCatalogsPagedResponse>
        searchCatalogsSettings() {
      return getStubSettingsBuilder().searchCatalogsSettings();
    }

    /** Returns the builder for the settings used for calls to searchProducts. */
    public PagedCallSettings.Builder<
            SearchProductsRequest, SearchProductsResponse, SearchProductsPagedResponse>
        searchProductsSettings() {
      return getStubSettingsBuilder().searchProductsSettings();
    }

    /** Returns the builder for the settings used for calls to searchVersions. */
    public PagedCallSettings.Builder<
            SearchVersionsRequest, SearchVersionsResponse, SearchVersionsPagedResponse>
        searchVersionsSettings() {
      return getStubSettingsBuilder().searchVersionsSettings();
    }

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