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

com.google.cloud.discoveryengine.v1alpha.stub.SampleQueryServiceStubSettings Maven / Gradle / Ivy

Go to download

Discovery Engine API A Cloud API that offers search and recommendation discoverability for documents from different industry verticals (e.g. media, retail, etc.).

There is a newer version: 0.51.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.discoveryengine.v1alpha.stub;

import static com.google.cloud.discoveryengine.v1alpha.SampleQueryServiceClient.ListSampleQueriesPagedResponse;

import com.google.api.core.ApiFunction;
import com.google.api.core.ApiFuture;
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.ApiCallContext;
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.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.cloud.discoveryengine.v1alpha.CreateSampleQueryRequest;
import com.google.cloud.discoveryengine.v1alpha.DeleteSampleQueryRequest;
import com.google.cloud.discoveryengine.v1alpha.GetSampleQueryRequest;
import com.google.cloud.discoveryengine.v1alpha.ImportSampleQueriesMetadata;
import com.google.cloud.discoveryengine.v1alpha.ImportSampleQueriesRequest;
import com.google.cloud.discoveryengine.v1alpha.ImportSampleQueriesResponse;
import com.google.cloud.discoveryengine.v1alpha.ListSampleQueriesRequest;
import com.google.cloud.discoveryengine.v1alpha.ListSampleQueriesResponse;
import com.google.cloud.discoveryengine.v1alpha.SampleQuery;
import com.google.cloud.discoveryengine.v1alpha.UpdateSampleQueryRequest;
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 com.google.protobuf.Empty;
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 SampleQueryServiceStub}.
 *
 * 

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

    *
  • The default service address (discoveryengine.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 getSampleQuery 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
 * SampleQueryServiceStubSettings.Builder sampleQueryServiceSettingsBuilder =
 *     SampleQueryServiceStubSettings.newBuilder();
 * sampleQueryServiceSettingsBuilder
 *     .getSampleQuerySettings()
 *     .setRetrySettings(
 *         sampleQueryServiceSettingsBuilder
 *             .getSampleQuerySettings()
 *             .getRetrySettings()
 *             .toBuilder()
 *             .setTotalTimeout(Duration.ofSeconds(30))
 *             .build());
 * SampleQueryServiceStubSettings sampleQueryServiceSettings =
 *     sampleQueryServiceSettingsBuilder.build();
 * }
*/ @BetaApi @Generated("by gapic-generator-java") public class SampleQueryServiceStubSettings 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 getSampleQuerySettings; private final PagedCallSettings< ListSampleQueriesRequest, ListSampleQueriesResponse, ListSampleQueriesPagedResponse> listSampleQueriesSettings; private final UnaryCallSettings createSampleQuerySettings; private final UnaryCallSettings updateSampleQuerySettings; private final UnaryCallSettings deleteSampleQuerySettings; private final UnaryCallSettings importSampleQueriesSettings; private final OperationCallSettings< ImportSampleQueriesRequest, ImportSampleQueriesResponse, ImportSampleQueriesMetadata> importSampleQueriesOperationSettings; private static final PagedListDescriptor< ListSampleQueriesRequest, ListSampleQueriesResponse, SampleQuery> LIST_SAMPLE_QUERIES_PAGE_STR_DESC = new PagedListDescriptor< ListSampleQueriesRequest, ListSampleQueriesResponse, SampleQuery>() { @Override public String emptyToken() { return ""; } @Override public ListSampleQueriesRequest injectToken( ListSampleQueriesRequest payload, String token) { return ListSampleQueriesRequest.newBuilder(payload).setPageToken(token).build(); } @Override public ListSampleQueriesRequest injectPageSize( ListSampleQueriesRequest payload, int pageSize) { return ListSampleQueriesRequest.newBuilder(payload).setPageSize(pageSize).build(); } @Override public Integer extractPageSize(ListSampleQueriesRequest payload) { return payload.getPageSize(); } @Override public String extractNextToken(ListSampleQueriesResponse payload) { return payload.getNextPageToken(); } @Override public Iterable extractResources(ListSampleQueriesResponse payload) { return payload.getSampleQueriesList() == null ? ImmutableList.of() : payload.getSampleQueriesList(); } }; private static final PagedListResponseFactory< ListSampleQueriesRequest, ListSampleQueriesResponse, ListSampleQueriesPagedResponse> LIST_SAMPLE_QUERIES_PAGE_STR_FACT = new PagedListResponseFactory< ListSampleQueriesRequest, ListSampleQueriesResponse, ListSampleQueriesPagedResponse>() { @Override public ApiFuture getFuturePagedResponse( UnaryCallable callable, ListSampleQueriesRequest request, ApiCallContext context, ApiFuture futureResponse) { PageContext pageContext = PageContext.create( callable, LIST_SAMPLE_QUERIES_PAGE_STR_DESC, request, context); return ListSampleQueriesPagedResponse.createAsync(pageContext, futureResponse); } }; /** Returns the object with the settings used for calls to getSampleQuery. */ public UnaryCallSettings getSampleQuerySettings() { return getSampleQuerySettings; } /** Returns the object with the settings used for calls to listSampleQueries. */ public PagedCallSettings< ListSampleQueriesRequest, ListSampleQueriesResponse, ListSampleQueriesPagedResponse> listSampleQueriesSettings() { return listSampleQueriesSettings; } /** Returns the object with the settings used for calls to createSampleQuery. */ public UnaryCallSettings createSampleQuerySettings() { return createSampleQuerySettings; } /** Returns the object with the settings used for calls to updateSampleQuery. */ public UnaryCallSettings updateSampleQuerySettings() { return updateSampleQuerySettings; } /** Returns the object with the settings used for calls to deleteSampleQuery. */ public UnaryCallSettings deleteSampleQuerySettings() { return deleteSampleQuerySettings; } /** Returns the object with the settings used for calls to importSampleQueries. */ public UnaryCallSettings importSampleQueriesSettings() { return importSampleQueriesSettings; } /** Returns the object with the settings used for calls to importSampleQueries. */ public OperationCallSettings< ImportSampleQueriesRequest, ImportSampleQueriesResponse, ImportSampleQueriesMetadata> importSampleQueriesOperationSettings() { return importSampleQueriesOperationSettings; } public SampleQueryServiceStub createStub() throws IOException { if (getTransportChannelProvider() .getTransportName() .equals(GrpcTransportChannel.getGrpcTransportName())) { return GrpcSampleQueryServiceStub.create(this); } if (getTransportChannelProvider() .getTransportName() .equals(HttpJsonTransportChannel.getHttpJsonTransportName())) { return HttpJsonSampleQueryServiceStub.create(this); } throw new UnsupportedOperationException( String.format( "Transport not supported: %s", getTransportChannelProvider().getTransportName())); } /** Returns the default service name. */ @Override public String getServiceName() { return "discoveryengine"; } /** 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 "discoveryengine.googleapis.com:443"; } /** Returns the default mTLS service endpoint. */ public static String getDefaultMtlsEndpoint() { return "discoveryengine.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(SampleQueryServiceStubSettings.class)) .setTransportToken( GaxGrpcProperties.getGrpcTokenName(), GaxGrpcProperties.getGrpcVersion()); } public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder() { return ApiClientHeaderProvider.newBuilder() .setGeneratedLibToken( "gapic", GaxProperties.getLibraryVersion(SampleQueryServiceStubSettings.class)) .setTransportToken( GaxHttpJsonProperties.getHttpJsonTokenName(), GaxHttpJsonProperties.getHttpJsonVersion()); } public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() { return SampleQueryServiceStubSettings.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 SampleQueryServiceStubSettings(Builder settingsBuilder) throws IOException { super(settingsBuilder); getSampleQuerySettings = settingsBuilder.getSampleQuerySettings().build(); listSampleQueriesSettings = settingsBuilder.listSampleQueriesSettings().build(); createSampleQuerySettings = settingsBuilder.createSampleQuerySettings().build(); updateSampleQuerySettings = settingsBuilder.updateSampleQuerySettings().build(); deleteSampleQuerySettings = settingsBuilder.deleteSampleQuerySettings().build(); importSampleQueriesSettings = settingsBuilder.importSampleQueriesSettings().build(); importSampleQueriesOperationSettings = settingsBuilder.importSampleQueriesOperationSettings().build(); } /** Builder for SampleQueryServiceStubSettings. */ public static class Builder extends StubSettings.Builder { private final ImmutableList> unaryMethodSettingsBuilders; private final UnaryCallSettings.Builder getSampleQuerySettings; private final PagedCallSettings.Builder< ListSampleQueriesRequest, ListSampleQueriesResponse, ListSampleQueriesPagedResponse> listSampleQueriesSettings; private final UnaryCallSettings.Builder createSampleQuerySettings; private final UnaryCallSettings.Builder updateSampleQuerySettings; private final UnaryCallSettings.Builder deleteSampleQuerySettings; private final UnaryCallSettings.Builder importSampleQueriesSettings; private final OperationCallSettings.Builder< ImportSampleQueriesRequest, ImportSampleQueriesResponse, ImportSampleQueriesMetadata> importSampleQueriesOperationSettings; private static final ImmutableMap> RETRYABLE_CODE_DEFINITIONS; static { ImmutableMap.Builder> definitions = ImmutableMap.builder(); definitions.put( "retry_policy_1_codes", ImmutableSet.copyOf(Lists.newArrayList(StatusCode.Code.UNAVAILABLE))); 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(1000L)) .setRetryDelayMultiplier(1.3) .setMaxRetryDelay(Duration.ofMillis(10000L)) .setInitialRpcTimeout(Duration.ofMillis(30000L)) .setRpcTimeoutMultiplier(1.0) .setMaxRpcTimeout(Duration.ofMillis(30000L)) .setTotalTimeout(Duration.ofMillis(30000L)) .build(); definitions.put("retry_policy_1_params", settings); RETRY_PARAM_DEFINITIONS = definitions.build(); } protected Builder() { this(((ClientContext) null)); } protected Builder(ClientContext clientContext) { super(clientContext); getSampleQuerySettings = UnaryCallSettings.newUnaryCallSettingsBuilder(); listSampleQueriesSettings = PagedCallSettings.newBuilder(LIST_SAMPLE_QUERIES_PAGE_STR_FACT); createSampleQuerySettings = UnaryCallSettings.newUnaryCallSettingsBuilder(); updateSampleQuerySettings = UnaryCallSettings.newUnaryCallSettingsBuilder(); deleteSampleQuerySettings = UnaryCallSettings.newUnaryCallSettingsBuilder(); importSampleQueriesSettings = UnaryCallSettings.newUnaryCallSettingsBuilder(); importSampleQueriesOperationSettings = OperationCallSettings.newBuilder(); unaryMethodSettingsBuilders = ImmutableList.>of( getSampleQuerySettings, listSampleQueriesSettings, createSampleQuerySettings, updateSampleQuerySettings, deleteSampleQuerySettings, importSampleQueriesSettings); initDefaults(this); } protected Builder(SampleQueryServiceStubSettings settings) { super(settings); getSampleQuerySettings = settings.getSampleQuerySettings.toBuilder(); listSampleQueriesSettings = settings.listSampleQueriesSettings.toBuilder(); createSampleQuerySettings = settings.createSampleQuerySettings.toBuilder(); updateSampleQuerySettings = settings.updateSampleQuerySettings.toBuilder(); deleteSampleQuerySettings = settings.deleteSampleQuerySettings.toBuilder(); importSampleQueriesSettings = settings.importSampleQueriesSettings.toBuilder(); importSampleQueriesOperationSettings = settings.importSampleQueriesOperationSettings.toBuilder(); unaryMethodSettingsBuilders = ImmutableList.>of( getSampleQuerySettings, listSampleQueriesSettings, createSampleQuerySettings, updateSampleQuerySettings, deleteSampleQuerySettings, importSampleQueriesSettings); } 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 .getSampleQuerySettings() .setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_1_codes")) .setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_1_params")); builder .listSampleQueriesSettings() .setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_1_codes")) .setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_1_params")); builder .createSampleQuerySettings() .setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_1_codes")) .setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_1_params")); builder .updateSampleQuerySettings() .setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_1_codes")) .setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_1_params")); builder .deleteSampleQuerySettings() .setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_1_codes")) .setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_1_params")); builder .importSampleQueriesSettings() .setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_1_codes")) .setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_1_params")); builder .importSampleQueriesOperationSettings() .setInitialCallSettings( UnaryCallSettings .newUnaryCallSettingsBuilder() .setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_1_codes")) .setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_1_params")) .build()) .setResponseTransformer( ProtoOperationTransformers.ResponseTransformer.create( ImportSampleQueriesResponse.class)) .setMetadataTransformer( ProtoOperationTransformers.MetadataTransformer.create( ImportSampleQueriesMetadata.class)) .setPollingAlgorithm( OperationTimedPollAlgorithm.create( RetrySettings.newBuilder() .setInitialRetryDelay(Duration.ofMillis(5000L)) .setRetryDelayMultiplier(1.5) .setMaxRetryDelay(Duration.ofMillis(45000L)) .setInitialRpcTimeout(Duration.ZERO) .setRpcTimeoutMultiplier(1.0) .setMaxRpcTimeout(Duration.ZERO) .setTotalTimeout(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 getSampleQuery. */ public UnaryCallSettings.Builder getSampleQuerySettings() { return getSampleQuerySettings; } /** Returns the builder for the settings used for calls to listSampleQueries. */ public PagedCallSettings.Builder< ListSampleQueriesRequest, ListSampleQueriesResponse, ListSampleQueriesPagedResponse> listSampleQueriesSettings() { return listSampleQueriesSettings; } /** Returns the builder for the settings used for calls to createSampleQuery. */ public UnaryCallSettings.Builder createSampleQuerySettings() { return createSampleQuerySettings; } /** Returns the builder for the settings used for calls to updateSampleQuery. */ public UnaryCallSettings.Builder updateSampleQuerySettings() { return updateSampleQuerySettings; } /** Returns the builder for the settings used for calls to deleteSampleQuery. */ public UnaryCallSettings.Builder deleteSampleQuerySettings() { return deleteSampleQuerySettings; } /** Returns the builder for the settings used for calls to importSampleQueries. */ public UnaryCallSettings.Builder importSampleQueriesSettings() { return importSampleQueriesSettings; } /** Returns the builder for the settings used for calls to importSampleQueries. */ public OperationCallSettings.Builder< ImportSampleQueriesRequest, ImportSampleQueriesResponse, ImportSampleQueriesMetadata> importSampleQueriesOperationSettings() { return importSampleQueriesOperationSettings; } @Override public SampleQueryServiceStubSettings build() throws IOException { return new SampleQueryServiceStubSettings(this); } } }





© 2015 - 2025 Weber Informatics LLC | Privacy Policy