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.language.v1beta2; 18 19 import com.google.api.core.ApiFunction; 20 import com.google.api.core.BetaApi; 21 import com.google.api.gax.core.GoogleCredentialsProvider; 22 import com.google.api.gax.core.InstantiatingExecutorProvider; 23 import com.google.api.gax.grpc.InstantiatingGrpcChannelProvider; 24 import com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider; 25 import com.google.api.gax.rpc.ApiClientHeaderProvider; 26 import com.google.api.gax.rpc.ClientContext; 27 import com.google.api.gax.rpc.ClientSettings; 28 import com.google.api.gax.rpc.TransportChannelProvider; 29 import com.google.api.gax.rpc.UnaryCallSettings; 30 import com.google.cloud.language.v1beta2.stub.LanguageServiceStubSettings; 31 import java.io.IOException; 32 import java.util.List; 33 import javax.annotation.Generated; 34 35 // AUTO-GENERATED DOCUMENTATION AND CLASS. 36 /** 37 * Settings class to configure an instance of {@link LanguageServiceClient}. 38 * 39 * <p>The default instance has everything set to sensible defaults: 40 * 41 * <ul> 42 * <li>The default service address (language.googleapis.com) and default port (443) are used. 43 * <li>Credentials are acquired automatically through Application Default Credentials. 44 * <li>Retries are configured for idempotent methods but not for non-idempotent methods. 45 * </ul> 46 * 47 * <p>The builder of this class is recursive, so contained classes are themselves builders. When 48 * build() is called, the tree of builders is called to create the complete settings object. 49 * 50 * <p>For example, to set the total timeout of analyzeSentiment to 30 seconds: 51 * 52 * <pre>{@code 53 * // This snippet has been automatically generated and should be regarded as a code template only. 54 * // It will require modifications to work: 55 * // - It may require correct/in-range values for request initialization. 56 * // - It may require specifying regional endpoints when creating the service client as shown in 57 * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library 58 * LanguageServiceSettings.Builder languageServiceSettingsBuilder = 59 * LanguageServiceSettings.newBuilder(); 60 * languageServiceSettingsBuilder 61 * .analyzeSentimentSettings() 62 * .setRetrySettings( 63 * languageServiceSettingsBuilder 64 * .analyzeSentimentSettings() 65 * .getRetrySettings() 66 * .toBuilder() 67 * .setTotalTimeout(Duration.ofSeconds(30)) 68 * .build()); 69 * LanguageServiceSettings languageServiceSettings = languageServiceSettingsBuilder.build(); 70 * }</pre> 71 */ 72 @BetaApi 73 @Generated("by gapic-generator-java") 74 public class LanguageServiceSettings extends ClientSettings<LanguageServiceSettings> { 75 76 /** Returns the object with the settings used for calls to analyzeSentiment. */ 77 public UnaryCallSettings<AnalyzeSentimentRequest, AnalyzeSentimentResponse> analyzeSentimentSettings()78 analyzeSentimentSettings() { 79 return ((LanguageServiceStubSettings) getStubSettings()).analyzeSentimentSettings(); 80 } 81 82 /** Returns the object with the settings used for calls to analyzeEntities. */ 83 public UnaryCallSettings<AnalyzeEntitiesRequest, AnalyzeEntitiesResponse> analyzeEntitiesSettings()84 analyzeEntitiesSettings() { 85 return ((LanguageServiceStubSettings) getStubSettings()).analyzeEntitiesSettings(); 86 } 87 88 /** Returns the object with the settings used for calls to analyzeEntitySentiment. */ 89 public UnaryCallSettings<AnalyzeEntitySentimentRequest, AnalyzeEntitySentimentResponse> analyzeEntitySentimentSettings()90 analyzeEntitySentimentSettings() { 91 return ((LanguageServiceStubSettings) getStubSettings()).analyzeEntitySentimentSettings(); 92 } 93 94 /** Returns the object with the settings used for calls to analyzeSyntax. */ analyzeSyntaxSettings()95 public UnaryCallSettings<AnalyzeSyntaxRequest, AnalyzeSyntaxResponse> analyzeSyntaxSettings() { 96 return ((LanguageServiceStubSettings) getStubSettings()).analyzeSyntaxSettings(); 97 } 98 99 /** Returns the object with the settings used for calls to classifyText. */ classifyTextSettings()100 public UnaryCallSettings<ClassifyTextRequest, ClassifyTextResponse> classifyTextSettings() { 101 return ((LanguageServiceStubSettings) getStubSettings()).classifyTextSettings(); 102 } 103 104 /** Returns the object with the settings used for calls to annotateText. */ annotateTextSettings()105 public UnaryCallSettings<AnnotateTextRequest, AnnotateTextResponse> annotateTextSettings() { 106 return ((LanguageServiceStubSettings) getStubSettings()).annotateTextSettings(); 107 } 108 create(LanguageServiceStubSettings stub)109 public static final LanguageServiceSettings create(LanguageServiceStubSettings stub) 110 throws IOException { 111 return new LanguageServiceSettings.Builder(stub.toBuilder()).build(); 112 } 113 114 /** Returns a builder for the default ExecutorProvider for this service. */ defaultExecutorProviderBuilder()115 public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { 116 return LanguageServiceStubSettings.defaultExecutorProviderBuilder(); 117 } 118 119 /** Returns the default service endpoint. */ getDefaultEndpoint()120 public static String getDefaultEndpoint() { 121 return LanguageServiceStubSettings.getDefaultEndpoint(); 122 } 123 124 /** Returns the default service scopes. */ getDefaultServiceScopes()125 public static List<String> getDefaultServiceScopes() { 126 return LanguageServiceStubSettings.getDefaultServiceScopes(); 127 } 128 129 /** Returns a builder for the default credentials for this service. */ defaultCredentialsProviderBuilder()130 public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() { 131 return LanguageServiceStubSettings.defaultCredentialsProviderBuilder(); 132 } 133 134 /** Returns a builder for the default gRPC ChannelProvider for this service. */ defaultGrpcTransportProviderBuilder()135 public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() { 136 return LanguageServiceStubSettings.defaultGrpcTransportProviderBuilder(); 137 } 138 139 /** Returns a builder for the default REST ChannelProvider for this service. */ 140 @BetaApi 141 public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()142 defaultHttpJsonTransportProviderBuilder() { 143 return LanguageServiceStubSettings.defaultHttpJsonTransportProviderBuilder(); 144 } 145 defaultTransportChannelProvider()146 public static TransportChannelProvider defaultTransportChannelProvider() { 147 return LanguageServiceStubSettings.defaultTransportChannelProvider(); 148 } 149 150 @BetaApi("The surface for customizing headers is not stable yet and may change in the future.") defaultApiClientHeaderProviderBuilder()151 public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() { 152 return LanguageServiceStubSettings.defaultApiClientHeaderProviderBuilder(); 153 } 154 155 /** Returns a new gRPC builder for this class. */ newBuilder()156 public static Builder newBuilder() { 157 return Builder.createDefault(); 158 } 159 160 /** Returns a new REST builder for this class. */ 161 @BetaApi newHttpJsonBuilder()162 public static Builder newHttpJsonBuilder() { 163 return Builder.createHttpJsonDefault(); 164 } 165 166 /** Returns a new builder for this class. */ newBuilder(ClientContext clientContext)167 public static Builder newBuilder(ClientContext clientContext) { 168 return new Builder(clientContext); 169 } 170 171 /** Returns a builder containing all the values of this settings class. */ toBuilder()172 public Builder toBuilder() { 173 return new Builder(this); 174 } 175 LanguageServiceSettings(Builder settingsBuilder)176 protected LanguageServiceSettings(Builder settingsBuilder) throws IOException { 177 super(settingsBuilder); 178 } 179 180 /** Builder for LanguageServiceSettings. */ 181 public static class Builder extends ClientSettings.Builder<LanguageServiceSettings, Builder> { 182 Builder()183 protected Builder() throws IOException { 184 this(((ClientContext) null)); 185 } 186 Builder(ClientContext clientContext)187 protected Builder(ClientContext clientContext) { 188 super(LanguageServiceStubSettings.newBuilder(clientContext)); 189 } 190 Builder(LanguageServiceSettings settings)191 protected Builder(LanguageServiceSettings settings) { 192 super(settings.getStubSettings().toBuilder()); 193 } 194 Builder(LanguageServiceStubSettings.Builder stubSettings)195 protected Builder(LanguageServiceStubSettings.Builder stubSettings) { 196 super(stubSettings); 197 } 198 createDefault()199 private static Builder createDefault() { 200 return new Builder(LanguageServiceStubSettings.newBuilder()); 201 } 202 203 @BetaApi createHttpJsonDefault()204 private static Builder createHttpJsonDefault() { 205 return new Builder(LanguageServiceStubSettings.newHttpJsonBuilder()); 206 } 207 getStubSettingsBuilder()208 public LanguageServiceStubSettings.Builder getStubSettingsBuilder() { 209 return ((LanguageServiceStubSettings.Builder) getStubSettings()); 210 } 211 212 /** 213 * Applies the given settings updater function to all of the unary API methods in this service. 214 * 215 * <p>Note: This method does not support applying settings to streaming methods. 216 */ applyToAllUnaryMethods( ApiFunction<UnaryCallSettings.Builder<?, ?>, Void> settingsUpdater)217 public Builder applyToAllUnaryMethods( 218 ApiFunction<UnaryCallSettings.Builder<?, ?>, Void> settingsUpdater) { 219 super.applyToAllUnaryMethods( 220 getStubSettingsBuilder().unaryMethodSettingsBuilders(), settingsUpdater); 221 return this; 222 } 223 224 /** Returns the builder for the settings used for calls to analyzeSentiment. */ 225 public UnaryCallSettings.Builder<AnalyzeSentimentRequest, AnalyzeSentimentResponse> analyzeSentimentSettings()226 analyzeSentimentSettings() { 227 return getStubSettingsBuilder().analyzeSentimentSettings(); 228 } 229 230 /** Returns the builder for the settings used for calls to analyzeEntities. */ 231 public UnaryCallSettings.Builder<AnalyzeEntitiesRequest, AnalyzeEntitiesResponse> analyzeEntitiesSettings()232 analyzeEntitiesSettings() { 233 return getStubSettingsBuilder().analyzeEntitiesSettings(); 234 } 235 236 /** Returns the builder for the settings used for calls to analyzeEntitySentiment. */ 237 public UnaryCallSettings.Builder<AnalyzeEntitySentimentRequest, AnalyzeEntitySentimentResponse> analyzeEntitySentimentSettings()238 analyzeEntitySentimentSettings() { 239 return getStubSettingsBuilder().analyzeEntitySentimentSettings(); 240 } 241 242 /** Returns the builder for the settings used for calls to analyzeSyntax. */ 243 public UnaryCallSettings.Builder<AnalyzeSyntaxRequest, AnalyzeSyntaxResponse> analyzeSyntaxSettings()244 analyzeSyntaxSettings() { 245 return getStubSettingsBuilder().analyzeSyntaxSettings(); 246 } 247 248 /** Returns the builder for the settings used for calls to classifyText. */ 249 public UnaryCallSettings.Builder<ClassifyTextRequest, ClassifyTextResponse> classifyTextSettings()250 classifyTextSettings() { 251 return getStubSettingsBuilder().classifyTextSettings(); 252 } 253 254 /** Returns the builder for the settings used for calls to annotateText. */ 255 public UnaryCallSettings.Builder<AnnotateTextRequest, AnnotateTextResponse> annotateTextSettings()256 annotateTextSettings() { 257 return getStubSettingsBuilder().annotateTextSettings(); 258 } 259 260 @Override build()261 public LanguageServiceSettings build() throws IOException { 262 return new LanguageServiceSettings(this); 263 } 264 } 265 } 266