1 /* 2 * Copyright 2022 Google LLC 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * https://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17 package com.google.cloud.retail.v2; 18 19 import static com.google.cloud.retail.v2.SearchServiceClient.SearchPagedResponse; 20 21 import com.google.api.core.ApiFunction; 22 import com.google.api.core.BetaApi; 23 import com.google.api.gax.core.GoogleCredentialsProvider; 24 import com.google.api.gax.core.InstantiatingExecutorProvider; 25 import com.google.api.gax.grpc.InstantiatingGrpcChannelProvider; 26 import com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider; 27 import com.google.api.gax.rpc.ApiClientHeaderProvider; 28 import com.google.api.gax.rpc.ClientContext; 29 import com.google.api.gax.rpc.ClientSettings; 30 import com.google.api.gax.rpc.PagedCallSettings; 31 import com.google.api.gax.rpc.TransportChannelProvider; 32 import com.google.api.gax.rpc.UnaryCallSettings; 33 import com.google.cloud.retail.v2.stub.SearchServiceStubSettings; 34 import java.io.IOException; 35 import java.util.List; 36 import javax.annotation.Generated; 37 38 // AUTO-GENERATED DOCUMENTATION AND CLASS. 39 /** 40 * Settings class to configure an instance of {@link SearchServiceClient}. 41 * 42 * <p>The default instance has everything set to sensible defaults: 43 * 44 * <ul> 45 * <li>The default service address (retail.googleapis.com) and default port (443) are used. 46 * <li>Credentials are acquired automatically through Application Default Credentials. 47 * <li>Retries are configured for idempotent methods but not for non-idempotent methods. 48 * </ul> 49 * 50 * <p>The builder of this class is recursive, so contained classes are themselves builders. When 51 * build() is called, the tree of builders is called to create the complete settings object. 52 * 53 * <p>For example, to set the total timeout of search to 30 seconds: 54 * 55 * <pre>{@code 56 * // This snippet has been automatically generated and should be regarded as a code template only. 57 * // It will require modifications to work: 58 * // - It may require correct/in-range values for request initialization. 59 * // - It may require specifying regional endpoints when creating the service client as shown in 60 * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 61 * SearchServiceSettings.Builder searchServiceSettingsBuilder = SearchServiceSettings.newBuilder(); 62 * searchServiceSettingsBuilder 63 * .searchSettings() 64 * .setRetrySettings( 65 * searchServiceSettingsBuilder 66 * .searchSettings() 67 * .getRetrySettings() 68 * .toBuilder() 69 * .setTotalTimeout(Duration.ofSeconds(30)) 70 * .build()); 71 * SearchServiceSettings searchServiceSettings = searchServiceSettingsBuilder.build(); 72 * }</pre> 73 */ 74 @Generated("by gapic-generator-java") 75 public class SearchServiceSettings extends ClientSettings<SearchServiceSettings> { 76 77 /** Returns the object with the settings used for calls to search. */ searchSettings()78 public PagedCallSettings<SearchRequest, SearchResponse, SearchPagedResponse> searchSettings() { 79 return ((SearchServiceStubSettings) getStubSettings()).searchSettings(); 80 } 81 create(SearchServiceStubSettings stub)82 public static final SearchServiceSettings create(SearchServiceStubSettings stub) 83 throws IOException { 84 return new SearchServiceSettings.Builder(stub.toBuilder()).build(); 85 } 86 87 /** Returns a builder for the default ExecutorProvider for this service. */ defaultExecutorProviderBuilder()88 public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { 89 return SearchServiceStubSettings.defaultExecutorProviderBuilder(); 90 } 91 92 /** Returns the default service endpoint. */ getDefaultEndpoint()93 public static String getDefaultEndpoint() { 94 return SearchServiceStubSettings.getDefaultEndpoint(); 95 } 96 97 /** Returns the default service scopes. */ getDefaultServiceScopes()98 public static List<String> getDefaultServiceScopes() { 99 return SearchServiceStubSettings.getDefaultServiceScopes(); 100 } 101 102 /** Returns a builder for the default credentials for this service. */ defaultCredentialsProviderBuilder()103 public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() { 104 return SearchServiceStubSettings.defaultCredentialsProviderBuilder(); 105 } 106 107 /** Returns a builder for the default gRPC ChannelProvider for this service. */ defaultGrpcTransportProviderBuilder()108 public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() { 109 return SearchServiceStubSettings.defaultGrpcTransportProviderBuilder(); 110 } 111 112 /** Returns a builder for the default REST ChannelProvider for this service. */ 113 @BetaApi 114 public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()115 defaultHttpJsonTransportProviderBuilder() { 116 return SearchServiceStubSettings.defaultHttpJsonTransportProviderBuilder(); 117 } 118 defaultTransportChannelProvider()119 public static TransportChannelProvider defaultTransportChannelProvider() { 120 return SearchServiceStubSettings.defaultTransportChannelProvider(); 121 } 122 123 @BetaApi("The surface for customizing headers is not stable yet and may change in the future.") defaultApiClientHeaderProviderBuilder()124 public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() { 125 return SearchServiceStubSettings.defaultApiClientHeaderProviderBuilder(); 126 } 127 128 /** Returns a new gRPC builder for this class. */ newBuilder()129 public static Builder newBuilder() { 130 return Builder.createDefault(); 131 } 132 133 /** Returns a new REST builder for this class. */ 134 @BetaApi newHttpJsonBuilder()135 public static Builder newHttpJsonBuilder() { 136 return Builder.createHttpJsonDefault(); 137 } 138 139 /** Returns a new builder for this class. */ newBuilder(ClientContext clientContext)140 public static Builder newBuilder(ClientContext clientContext) { 141 return new Builder(clientContext); 142 } 143 144 /** Returns a builder containing all the values of this settings class. */ toBuilder()145 public Builder toBuilder() { 146 return new Builder(this); 147 } 148 SearchServiceSettings(Builder settingsBuilder)149 protected SearchServiceSettings(Builder settingsBuilder) throws IOException { 150 super(settingsBuilder); 151 } 152 153 /** Builder for SearchServiceSettings. */ 154 public static class Builder extends ClientSettings.Builder<SearchServiceSettings, Builder> { 155 Builder()156 protected Builder() throws IOException { 157 this(((ClientContext) null)); 158 } 159 Builder(ClientContext clientContext)160 protected Builder(ClientContext clientContext) { 161 super(SearchServiceStubSettings.newBuilder(clientContext)); 162 } 163 Builder(SearchServiceSettings settings)164 protected Builder(SearchServiceSettings settings) { 165 super(settings.getStubSettings().toBuilder()); 166 } 167 Builder(SearchServiceStubSettings.Builder stubSettings)168 protected Builder(SearchServiceStubSettings.Builder stubSettings) { 169 super(stubSettings); 170 } 171 createDefault()172 private static Builder createDefault() { 173 return new Builder(SearchServiceStubSettings.newBuilder()); 174 } 175 176 @BetaApi createHttpJsonDefault()177 private static Builder createHttpJsonDefault() { 178 return new Builder(SearchServiceStubSettings.newHttpJsonBuilder()); 179 } 180 getStubSettingsBuilder()181 public SearchServiceStubSettings.Builder getStubSettingsBuilder() { 182 return ((SearchServiceStubSettings.Builder) getStubSettings()); 183 } 184 185 /** 186 * Applies the given settings updater function to all of the unary API methods in this service. 187 * 188 * <p>Note: This method does not support applying settings to streaming methods. 189 */ applyToAllUnaryMethods( ApiFunction<UnaryCallSettings.Builder<?, ?>, Void> settingsUpdater)190 public Builder applyToAllUnaryMethods( 191 ApiFunction<UnaryCallSettings.Builder<?, ?>, Void> settingsUpdater) { 192 super.applyToAllUnaryMethods( 193 getStubSettingsBuilder().unaryMethodSettingsBuilders(), settingsUpdater); 194 return this; 195 } 196 197 /** Returns the builder for the settings used for calls to search. */ 198 public PagedCallSettings.Builder<SearchRequest, SearchResponse, SearchPagedResponse> searchSettings()199 searchSettings() { 200 return getStubSettingsBuilder().searchSettings(); 201 } 202 203 @Override build()204 public SearchServiceSettings build() throws IOException { 205 return new SearchServiceSettings(this); 206 } 207 } 208 } 209