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

com.google.cloud.retail.v2alpha.stub.ProjectServiceStubSettings 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.cloud.retail.v2alpha.stub;

import com.google.api.core.ApiFunction;
import com.google.api.core.BetaApi;
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.grpc.ProtoOperationTransformers;
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.longrunning.OperationSnapshot;
import com.google.api.gax.longrunning.OperationTimedPollAlgorithm;
import com.google.api.gax.retrying.RetrySettings;
import com.google.api.gax.rpc.ApiClientHeaderProvider;
import com.google.api.gax.rpc.ClientContext;
import com.google.api.gax.rpc.OperationCallSettings;
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.cloud.retail.v2alpha.AcceptTermsRequest;
import com.google.cloud.retail.v2alpha.AlertConfig;
import com.google.cloud.retail.v2alpha.EnrollSolutionMetadata;
import com.google.cloud.retail.v2alpha.EnrollSolutionRequest;
import com.google.cloud.retail.v2alpha.EnrollSolutionResponse;
import com.google.cloud.retail.v2alpha.GetAlertConfigRequest;
import com.google.cloud.retail.v2alpha.GetLoggingConfigRequest;
import com.google.cloud.retail.v2alpha.GetProjectRequest;
import com.google.cloud.retail.v2alpha.ListEnrolledSolutionsRequest;
import com.google.cloud.retail.v2alpha.ListEnrolledSolutionsResponse;
import com.google.cloud.retail.v2alpha.LoggingConfig;
import com.google.cloud.retail.v2alpha.Project;
import com.google.cloud.retail.v2alpha.UpdateAlertConfigRequest;
import com.google.cloud.retail.v2alpha.UpdateLoggingConfigRequest;
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 com.google.longrunning.Operation;
import java.io.IOException;
import java.time.Duration;
import java.util.List;
import javax.annotation.Generated;

// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
 * Settings class to configure an instance of {@link ProjectServiceStub}.
 *
 * 

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

    *
  • The default service address (retail.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 getProject: * *

{@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
 * ProjectServiceStubSettings.Builder projectServiceSettingsBuilder =
 *     ProjectServiceStubSettings.newBuilder();
 * projectServiceSettingsBuilder
 *     .getProjectSettings()
 *     .setRetrySettings(
 *         projectServiceSettingsBuilder
 *             .getProjectSettings()
 *             .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());
 * ProjectServiceStubSettings projectServiceSettings = projectServiceSettingsBuilder.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. * *

To configure the RetrySettings of a Long Running Operation method, create an * OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to * configure the RetrySettings for enrollSolution: * *

{@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
 * ProjectServiceStubSettings.Builder projectServiceSettingsBuilder =
 *     ProjectServiceStubSettings.newBuilder();
 * TimedRetryAlgorithm timedRetryAlgorithm =
 *     OperationalTimedPollAlgorithm.create(
 *         RetrySettings.newBuilder()
 *             .setInitialRetryDelayDuration(Duration.ofMillis(500))
 *             .setRetryDelayMultiplier(1.5)
 *             .setMaxRetryDelayDuration(Duration.ofMillis(5000))
 *             .setTotalTimeoutDuration(Duration.ofHours(24))
 *             .build());
 * projectServiceSettingsBuilder
 *     .createClusterOperationSettings()
 *     .setPollingAlgorithm(timedRetryAlgorithm)
 *     .build();
 * }
*/ @BetaApi @Generated("by gapic-generator-java") public class ProjectServiceStubSettings extends StubSettings { /** The default scopes of the service. */ private static final ImmutableList DEFAULT_SERVICE_SCOPES = ImmutableList.builder().add("https://www.googleapis.com/auth/cloud-platform").build(); private final UnaryCallSettings getProjectSettings; private final UnaryCallSettings acceptTermsSettings; private final UnaryCallSettings enrollSolutionSettings; private final OperationCallSettings< EnrollSolutionRequest, EnrollSolutionResponse, EnrollSolutionMetadata> enrollSolutionOperationSettings; private final UnaryCallSettings listEnrolledSolutionsSettings; private final UnaryCallSettings getLoggingConfigSettings; private final UnaryCallSettings updateLoggingConfigSettings; private final UnaryCallSettings getAlertConfigSettings; private final UnaryCallSettings updateAlertConfigSettings; /** Returns the object with the settings used for calls to getProject. */ public UnaryCallSettings getProjectSettings() { return getProjectSettings; } /** Returns the object with the settings used for calls to acceptTerms. */ public UnaryCallSettings acceptTermsSettings() { return acceptTermsSettings; } /** Returns the object with the settings used for calls to enrollSolution. */ public UnaryCallSettings enrollSolutionSettings() { return enrollSolutionSettings; } /** Returns the object with the settings used for calls to enrollSolution. */ public OperationCallSettings< EnrollSolutionRequest, EnrollSolutionResponse, EnrollSolutionMetadata> enrollSolutionOperationSettings() { return enrollSolutionOperationSettings; } /** Returns the object with the settings used for calls to listEnrolledSolutions. */ public UnaryCallSettings listEnrolledSolutionsSettings() { return listEnrolledSolutionsSettings; } /** Returns the object with the settings used for calls to getLoggingConfig. */ public UnaryCallSettings getLoggingConfigSettings() { return getLoggingConfigSettings; } /** Returns the object with the settings used for calls to updateLoggingConfig. */ public UnaryCallSettings updateLoggingConfigSettings() { return updateLoggingConfigSettings; } /** Returns the object with the settings used for calls to getAlertConfig. */ public UnaryCallSettings getAlertConfigSettings() { return getAlertConfigSettings; } /** Returns the object with the settings used for calls to updateAlertConfig. */ public UnaryCallSettings updateAlertConfigSettings() { return updateAlertConfigSettings; } public ProjectServiceStub createStub() throws IOException { if (getTransportChannelProvider() .getTransportName() .equals(GrpcTransportChannel.getGrpcTransportName())) { return GrpcProjectServiceStub.create(this); } if (getTransportChannelProvider() .getTransportName() .equals(HttpJsonTransportChannel.getHttpJsonTransportName())) { return HttpJsonProjectServiceStub.create(this); } throw new UnsupportedOperationException( String.format( "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } /** Returns the default service name. */ @Override public String getServiceName() { return "retail"; } /** 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 "retail.googleapis.com:443"; } /** Returns the default mTLS service endpoint. */ public static String getDefaultMtlsEndpoint() { return "retail.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 gRPC ChannelProvider for this service. */ public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() { return InstantiatingGrpcChannelProvider.newBuilder() .setMaxInboundMessageSize(Integer.MAX_VALUE); } /** Returns a builder for the default REST ChannelProvider for this service. */ @BetaApi public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder() { return InstantiatingHttpJsonChannelProvider.newBuilder(); } public static TransportChannelProvider defaultTransportChannelProvider() { return defaultGrpcTransportProviderBuilder().build(); } public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder() { return ApiClientHeaderProvider.newBuilder() .setGeneratedLibToken( "gapic", GaxProperties.getLibraryVersion(ProjectServiceStubSettings.class)) .setTransportToken( GaxGrpcProperties.getGrpcTokenName(), GaxGrpcProperties.getGrpcVersion()); } public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder() { return ApiClientHeaderProvider.newBuilder() .setGeneratedLibToken( "gapic", GaxProperties.getLibraryVersion(ProjectServiceStubSettings.class)) .setTransportToken( GaxHttpJsonProperties.getHttpJsonTokenName(), GaxHttpJsonProperties.getHttpJsonVersion()); } public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() { return ProjectServiceStubSettings.defaultGrpcApiClientHeaderProviderBuilder(); } /** 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 ProjectServiceStubSettings(Builder settingsBuilder) throws IOException { super(settingsBuilder); getProjectSettings = settingsBuilder.getProjectSettings().build(); acceptTermsSettings = settingsBuilder.acceptTermsSettings().build(); enrollSolutionSettings = settingsBuilder.enrollSolutionSettings().build(); enrollSolutionOperationSettings = settingsBuilder.enrollSolutionOperationSettings().build(); listEnrolledSolutionsSettings = settingsBuilder.listEnrolledSolutionsSettings().build(); getLoggingConfigSettings = settingsBuilder.getLoggingConfigSettings().build(); updateLoggingConfigSettings = settingsBuilder.updateLoggingConfigSettings().build(); getAlertConfigSettings = settingsBuilder.getAlertConfigSettings().build(); updateAlertConfigSettings = settingsBuilder.updateAlertConfigSettings().build(); } /** Builder for ProjectServiceStubSettings. */ public static class Builder extends StubSettings.Builder { private final ImmutableList> unaryMethodSettingsBuilders; private final UnaryCallSettings.Builder getProjectSettings; private final UnaryCallSettings.Builder acceptTermsSettings; private final UnaryCallSettings.Builder enrollSolutionSettings; private final OperationCallSettings.Builder< EnrollSolutionRequest, EnrollSolutionResponse, EnrollSolutionMetadata> enrollSolutionOperationSettings; private final UnaryCallSettings.Builder< ListEnrolledSolutionsRequest, ListEnrolledSolutionsResponse> listEnrolledSolutionsSettings; private final UnaryCallSettings.Builder getLoggingConfigSettings; private final UnaryCallSettings.Builder updateLoggingConfigSettings; private final UnaryCallSettings.Builder getAlertConfigSettings; private final UnaryCallSettings.Builder updateAlertConfigSettings; private static final ImmutableMap> RETRYABLE_CODE_DEFINITIONS; static { ImmutableMap.Builder> definitions = ImmutableMap.builder(); definitions.put( "retry_policy_3_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() .setInitialRetryDelayDuration(Duration.ofMillis(100L)) .setRetryDelayMultiplier(1.3) .setMaxRetryDelayDuration(Duration.ofMillis(30000L)) .setInitialRpcTimeoutDuration(Duration.ofMillis(30000L)) .setRpcTimeoutMultiplier(1.0) .setMaxRpcTimeoutDuration(Duration.ofMillis(30000L)) .setTotalTimeoutDuration(Duration.ofMillis(30000L)) .build(); definitions.put("retry_policy_3_params", settings); RETRY_PARAM_DEFINITIONS = definitions.build(); } protected Builder() { this(((ClientContext) null)); } protected Builder(ClientContext clientContext) { super(clientContext); getProjectSettings = UnaryCallSettings.newUnaryCallSettingsBuilder(); acceptTermsSettings = UnaryCallSettings.newUnaryCallSettingsBuilder(); enrollSolutionSettings = UnaryCallSettings.newUnaryCallSettingsBuilder(); enrollSolutionOperationSettings = OperationCallSettings.newBuilder(); listEnrolledSolutionsSettings = UnaryCallSettings.newUnaryCallSettingsBuilder(); getLoggingConfigSettings = UnaryCallSettings.newUnaryCallSettingsBuilder(); updateLoggingConfigSettings = UnaryCallSettings.newUnaryCallSettingsBuilder(); getAlertConfigSettings = UnaryCallSettings.newUnaryCallSettingsBuilder(); updateAlertConfigSettings = UnaryCallSettings.newUnaryCallSettingsBuilder(); unaryMethodSettingsBuilders = ImmutableList.>of( getProjectSettings, acceptTermsSettings, enrollSolutionSettings, listEnrolledSolutionsSettings, getLoggingConfigSettings, updateLoggingConfigSettings, getAlertConfigSettings, updateAlertConfigSettings); initDefaults(this); } protected Builder(ProjectServiceStubSettings settings) { super(settings); getProjectSettings = settings.getProjectSettings.toBuilder(); acceptTermsSettings = settings.acceptTermsSettings.toBuilder(); enrollSolutionSettings = settings.enrollSolutionSettings.toBuilder(); enrollSolutionOperationSettings = settings.enrollSolutionOperationSettings.toBuilder(); listEnrolledSolutionsSettings = settings.listEnrolledSolutionsSettings.toBuilder(); getLoggingConfigSettings = settings.getLoggingConfigSettings.toBuilder(); updateLoggingConfigSettings = settings.updateLoggingConfigSettings.toBuilder(); getAlertConfigSettings = settings.getAlertConfigSettings.toBuilder(); updateAlertConfigSettings = settings.updateAlertConfigSettings.toBuilder(); unaryMethodSettingsBuilders = ImmutableList.>of( getProjectSettings, acceptTermsSettings, enrollSolutionSettings, listEnrolledSolutionsSettings, getLoggingConfigSettings, updateLoggingConfigSettings, getAlertConfigSettings, updateAlertConfigSettings); } 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 createHttpJsonDefault() { Builder builder = new Builder(((ClientContext) null)); builder.setTransportChannelProvider(defaultHttpJsonTransportProviderBuilder().build()); builder.setCredentialsProvider(defaultCredentialsProviderBuilder().build()); builder.setInternalHeaderProvider(defaultHttpJsonApiClientHeaderProviderBuilder().build()); builder.setMtlsEndpoint(getDefaultMtlsEndpoint()); builder.setSwitchToMtlsEndpointAllowed(true); return initDefaults(builder); } private static Builder initDefaults(Builder builder) { builder .getProjectSettings() .setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_3_codes")) .setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_3_params")); builder .acceptTermsSettings() .setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_3_codes")) .setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_3_params")); builder .enrollSolutionSettings() .setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_3_codes")) .setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_3_params")); builder .listEnrolledSolutionsSettings() .setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_3_codes")) .setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_3_params")); builder .getLoggingConfigSettings() .setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_3_codes")) .setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_3_params")); builder .updateLoggingConfigSettings() .setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_3_codes")) .setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_3_params")); builder .getAlertConfigSettings() .setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_3_codes")) .setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_3_params")); builder .updateAlertConfigSettings() .setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_3_codes")) .setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_3_params")); builder .enrollSolutionOperationSettings() .setInitialCallSettings( UnaryCallSettings .newUnaryCallSettingsBuilder() .setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_3_codes")) .setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_3_params")) .build()) .setResponseTransformer( ProtoOperationTransformers.ResponseTransformer.create(EnrollSolutionResponse.class)) .setMetadataTransformer( ProtoOperationTransformers.MetadataTransformer.create(EnrollSolutionMetadata.class)) .setPollingAlgorithm( OperationTimedPollAlgorithm.create( RetrySettings.newBuilder() .setInitialRetryDelayDuration(Duration.ofMillis(5000L)) .setRetryDelayMultiplier(1.5) .setMaxRetryDelayDuration(Duration.ofMillis(45000L)) .setInitialRpcTimeoutDuration(Duration.ZERO) .setRpcTimeoutMultiplier(1.0) .setMaxRpcTimeoutDuration(Duration.ZERO) .setTotalTimeoutDuration(Duration.ofMillis(300000L)) .build())); 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 getProject. */ public UnaryCallSettings.Builder getProjectSettings() { return getProjectSettings; } /** Returns the builder for the settings used for calls to acceptTerms. */ public UnaryCallSettings.Builder acceptTermsSettings() { return acceptTermsSettings; } /** Returns the builder for the settings used for calls to enrollSolution. */ public UnaryCallSettings.Builder enrollSolutionSettings() { return enrollSolutionSettings; } /** Returns the builder for the settings used for calls to enrollSolution. */ public OperationCallSettings.Builder< EnrollSolutionRequest, EnrollSolutionResponse, EnrollSolutionMetadata> enrollSolutionOperationSettings() { return enrollSolutionOperationSettings; } /** Returns the builder for the settings used for calls to listEnrolledSolutions. */ public UnaryCallSettings.Builder listEnrolledSolutionsSettings() { return listEnrolledSolutionsSettings; } /** Returns the builder for the settings used for calls to getLoggingConfig. */ public UnaryCallSettings.Builder getLoggingConfigSettings() { return getLoggingConfigSettings; } /** Returns the builder for the settings used for calls to updateLoggingConfig. */ public UnaryCallSettings.Builder updateLoggingConfigSettings() { return updateLoggingConfigSettings; } /** Returns the builder for the settings used for calls to getAlertConfig. */ public UnaryCallSettings.Builder getAlertConfigSettings() { return getAlertConfigSettings; } /** Returns the builder for the settings used for calls to updateAlertConfig. */ public UnaryCallSettings.Builder updateAlertConfigSettings() { return updateAlertConfigSettings; } @Override public ProjectServiceStubSettings build() throws IOException { return new ProjectServiceStubSettings(this); } } }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy