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.v1; 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.v1.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 @Generated("by gapic-generator-java") 73 public class LanguageServiceSettings extends ClientSettings<LanguageServiceSettings> { 74 75 /** Returns the object with the settings used for calls to analyzeSentiment. */ 76 public UnaryCallSettings<AnalyzeSentimentRequest, AnalyzeSentimentResponse> analyzeSentimentSettings()77 analyzeSentimentSettings() { 78 return ((LanguageServiceStubSettings) getStubSettings()).analyzeSentimentSettings(); 79 } 80 81 /** Returns the object with the settings used for calls to analyzeEntities. */ 82 public UnaryCallSettings<AnalyzeEntitiesRequest, AnalyzeEntitiesResponse> analyzeEntitiesSettings()83 analyzeEntitiesSettings() { 84 return ((LanguageServiceStubSettings) getStubSettings()).analyzeEntitiesSettings(); 85 } 86 87 /** Returns the object with the settings used for calls to analyzeEntitySentiment. */ 88 public UnaryCallSettings<AnalyzeEntitySentimentRequest, AnalyzeEntitySentimentResponse> analyzeEntitySentimentSettings()89 analyzeEntitySentimentSettings() { 90 return ((LanguageServiceStubSettings) getStubSettings()).analyzeEntitySentimentSettings(); 91 } 92 93 /** Returns the object with the settings used for calls to analyzeSyntax. */ analyzeSyntaxSettings()94 public UnaryCallSettings<AnalyzeSyntaxRequest, AnalyzeSyntaxResponse> analyzeSyntaxSettings() { 95 return ((LanguageServiceStubSettings) getStubSettings()).analyzeSyntaxSettings(); 96 } 97 98 /** Returns the object with the settings used for calls to classifyText. */ classifyTextSettings()99 public UnaryCallSettings<ClassifyTextRequest, ClassifyTextResponse> classifyTextSettings() { 100 return ((LanguageServiceStubSettings) getStubSettings()).classifyTextSettings(); 101 } 102 103 /** Returns the object with the settings used for calls to annotateText. */ annotateTextSettings()104 public UnaryCallSettings<AnnotateTextRequest, AnnotateTextResponse> annotateTextSettings() { 105 return ((LanguageServiceStubSettings) getStubSettings()).annotateTextSettings(); 106 } 107 create(LanguageServiceStubSettings stub)108 public static final LanguageServiceSettings create(LanguageServiceStubSettings stub) 109 throws IOException { 110 return new LanguageServiceSettings.Builder(stub.toBuilder()).build(); 111 } 112 113 /** Returns a builder for the default ExecutorProvider for this service. */ defaultExecutorProviderBuilder()114 public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { 115 return LanguageServiceStubSettings.defaultExecutorProviderBuilder(); 116 } 117 118 /** Returns the default service endpoint. */ getDefaultEndpoint()119 public static String getDefaultEndpoint() { 120 return LanguageServiceStubSettings.getDefaultEndpoint(); 121 } 122 123 /** Returns the default service scopes. */ getDefaultServiceScopes()124 public static List<String> getDefaultServiceScopes() { 125 return LanguageServiceStubSettings.getDefaultServiceScopes(); 126 } 127 128 /** Returns a builder for the default credentials for this service. */ defaultCredentialsProviderBuilder()129 public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() { 130 return LanguageServiceStubSettings.defaultCredentialsProviderBuilder(); 131 } 132 133 /** Returns a builder for the default gRPC ChannelProvider for this service. */ defaultGrpcTransportProviderBuilder()134 public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() { 135 return LanguageServiceStubSettings.defaultGrpcTransportProviderBuilder(); 136 } 137 138 /** Returns a builder for the default REST ChannelProvider for this service. */ 139 @BetaApi 140 public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()141 defaultHttpJsonTransportProviderBuilder() { 142 return LanguageServiceStubSettings.defaultHttpJsonTransportProviderBuilder(); 143 } 144 defaultTransportChannelProvider()145 public static TransportChannelProvider defaultTransportChannelProvider() { 146 return LanguageServiceStubSettings.defaultTransportChannelProvider(); 147 } 148 149 @BetaApi("The surface for customizing headers is not stable yet and may change in the future.") defaultApiClientHeaderProviderBuilder()150 public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() { 151 return LanguageServiceStubSettings.defaultApiClientHeaderProviderBuilder(); 152 } 153 154 /** Returns a new gRPC builder for this class. */ newBuilder()155 public static Builder newBuilder() { 156 return Builder.createDefault(); 157 } 158 159 /** Returns a new REST builder for this class. */ 160 @BetaApi newHttpJsonBuilder()161 public static Builder newHttpJsonBuilder() { 162 return Builder.createHttpJsonDefault(); 163 } 164 165 /** Returns a new builder for this class. */ newBuilder(ClientContext clientContext)166 public static Builder newBuilder(ClientContext clientContext) { 167 return new Builder(clientContext); 168 } 169 170 /** Returns a builder containing all the values of this settings class. */ toBuilder()171 public Builder toBuilder() { 172 return new Builder(this); 173 } 174 LanguageServiceSettings(Builder settingsBuilder)175 protected LanguageServiceSettings(Builder settingsBuilder) throws IOException { 176 super(settingsBuilder); 177 } 178 179 /** Builder for LanguageServiceSettings. */ 180 public static class Builder extends ClientSettings.Builder<LanguageServiceSettings, Builder> { 181 Builder()182 protected Builder() throws IOException { 183 this(((ClientContext) null)); 184 } 185 Builder(ClientContext clientContext)186 protected Builder(ClientContext clientContext) { 187 super(LanguageServiceStubSettings.newBuilder(clientContext)); 188 } 189 Builder(LanguageServiceSettings settings)190 protected Builder(LanguageServiceSettings settings) { 191 super(settings.getStubSettings().toBuilder()); 192 } 193 Builder(LanguageServiceStubSettings.Builder stubSettings)194 protected Builder(LanguageServiceStubSettings.Builder stubSettings) { 195 super(stubSettings); 196 } 197 createDefault()198 private static Builder createDefault() { 199 return new Builder(LanguageServiceStubSettings.newBuilder()); 200 } 201 202 @BetaApi createHttpJsonDefault()203 private static Builder createHttpJsonDefault() { 204 return new Builder(LanguageServiceStubSettings.newHttpJsonBuilder()); 205 } 206 getStubSettingsBuilder()207 public LanguageServiceStubSettings.Builder getStubSettingsBuilder() { 208 return ((LanguageServiceStubSettings.Builder) getStubSettings()); 209 } 210 211 /** 212 * Applies the given settings updater function to all of the unary API methods in this service. 213 * 214 * <p>Note: This method does not support applying settings to streaming methods. 215 */ applyToAllUnaryMethods( ApiFunction<UnaryCallSettings.Builder<?, ?>, Void> settingsUpdater)216 public Builder applyToAllUnaryMethods( 217 ApiFunction<UnaryCallSettings.Builder<?, ?>, Void> settingsUpdater) { 218 super.applyToAllUnaryMethods( 219 getStubSettingsBuilder().unaryMethodSettingsBuilders(), settingsUpdater); 220 return this; 221 } 222 223 /** Returns the builder for the settings used for calls to analyzeSentiment. */ 224 public UnaryCallSettings.Builder<AnalyzeSentimentRequest, AnalyzeSentimentResponse> analyzeSentimentSettings()225 analyzeSentimentSettings() { 226 return getStubSettingsBuilder().analyzeSentimentSettings(); 227 } 228 229 /** Returns the builder for the settings used for calls to analyzeEntities. */ 230 public UnaryCallSettings.Builder<AnalyzeEntitiesRequest, AnalyzeEntitiesResponse> analyzeEntitiesSettings()231 analyzeEntitiesSettings() { 232 return getStubSettingsBuilder().analyzeEntitiesSettings(); 233 } 234 235 /** Returns the builder for the settings used for calls to analyzeEntitySentiment. */ 236 public UnaryCallSettings.Builder<AnalyzeEntitySentimentRequest, AnalyzeEntitySentimentResponse> analyzeEntitySentimentSettings()237 analyzeEntitySentimentSettings() { 238 return getStubSettingsBuilder().analyzeEntitySentimentSettings(); 239 } 240 241 /** Returns the builder for the settings used for calls to analyzeSyntax. */ 242 public UnaryCallSettings.Builder<AnalyzeSyntaxRequest, AnalyzeSyntaxResponse> analyzeSyntaxSettings()243 analyzeSyntaxSettings() { 244 return getStubSettingsBuilder().analyzeSyntaxSettings(); 245 } 246 247 /** Returns the builder for the settings used for calls to classifyText. */ 248 public UnaryCallSettings.Builder<ClassifyTextRequest, ClassifyTextResponse> classifyTextSettings()249 classifyTextSettings() { 250 return getStubSettingsBuilder().classifyTextSettings(); 251 } 252 253 /** Returns the builder for the settings used for calls to annotateText. */ 254 public UnaryCallSettings.Builder<AnnotateTextRequest, AnnotateTextResponse> annotateTextSettings()255 annotateTextSettings() { 256 return getStubSettingsBuilder().annotateTextSettings(); 257 } 258 259 @Override build()260 public LanguageServiceSettings build() throws IOException { 261 return new LanguageServiceSettings(this); 262 } 263 } 264 } 265