• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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.compute.v1;
18 
19 import static com.google.cloud.compute.v1.TargetSslProxiesClient.ListPagedResponse;
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.httpjson.InstantiatingHttpJsonChannelProvider;
26 import com.google.api.gax.rpc.ApiClientHeaderProvider;
27 import com.google.api.gax.rpc.ClientContext;
28 import com.google.api.gax.rpc.ClientSettings;
29 import com.google.api.gax.rpc.OperationCallSettings;
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.compute.v1.stub.TargetSslProxiesStubSettings;
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 TargetSslProxiesClient}.
41  *
42  * <p>The default instance has everything set to sensible defaults:
43  *
44  * <ul>
45  *   <li>The default service address (compute.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 get 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  * TargetSslProxiesSettings.Builder targetSslProxiesSettingsBuilder =
62  *     TargetSslProxiesSettings.newBuilder();
63  * targetSslProxiesSettingsBuilder
64  *     .getSettings()
65  *     .setRetrySettings(
66  *         targetSslProxiesSettingsBuilder
67  *             .getSettings()
68  *             .getRetrySettings()
69  *             .toBuilder()
70  *             .setTotalTimeout(Duration.ofSeconds(30))
71  *             .build());
72  * TargetSslProxiesSettings targetSslProxiesSettings = targetSslProxiesSettingsBuilder.build();
73  * }</pre>
74  */
75 @Generated("by gapic-generator-java")
76 public class TargetSslProxiesSettings extends ClientSettings<TargetSslProxiesSettings> {
77 
78   /** Returns the object with the settings used for calls to delete. */
deleteSettings()79   public UnaryCallSettings<DeleteTargetSslProxyRequest, Operation> deleteSettings() {
80     return ((TargetSslProxiesStubSettings) getStubSettings()).deleteSettings();
81   }
82 
83   /** Returns the object with the settings used for calls to delete. */
84   public OperationCallSettings<DeleteTargetSslProxyRequest, Operation, Operation>
deleteOperationSettings()85       deleteOperationSettings() {
86     return ((TargetSslProxiesStubSettings) getStubSettings()).deleteOperationSettings();
87   }
88 
89   /** Returns the object with the settings used for calls to get. */
getSettings()90   public UnaryCallSettings<GetTargetSslProxyRequest, TargetSslProxy> getSettings() {
91     return ((TargetSslProxiesStubSettings) getStubSettings()).getSettings();
92   }
93 
94   /** Returns the object with the settings used for calls to insert. */
insertSettings()95   public UnaryCallSettings<InsertTargetSslProxyRequest, Operation> insertSettings() {
96     return ((TargetSslProxiesStubSettings) getStubSettings()).insertSettings();
97   }
98 
99   /** Returns the object with the settings used for calls to insert. */
100   public OperationCallSettings<InsertTargetSslProxyRequest, Operation, Operation>
insertOperationSettings()101       insertOperationSettings() {
102     return ((TargetSslProxiesStubSettings) getStubSettings()).insertOperationSettings();
103   }
104 
105   /** Returns the object with the settings used for calls to list. */
106   public PagedCallSettings<ListTargetSslProxiesRequest, TargetSslProxyList, ListPagedResponse>
listSettings()107       listSettings() {
108     return ((TargetSslProxiesStubSettings) getStubSettings()).listSettings();
109   }
110 
111   /** Returns the object with the settings used for calls to setBackendService. */
112   public UnaryCallSettings<SetBackendServiceTargetSslProxyRequest, Operation>
setBackendServiceSettings()113       setBackendServiceSettings() {
114     return ((TargetSslProxiesStubSettings) getStubSettings()).setBackendServiceSettings();
115   }
116 
117   /** Returns the object with the settings used for calls to setBackendService. */
118   public OperationCallSettings<SetBackendServiceTargetSslProxyRequest, Operation, Operation>
setBackendServiceOperationSettings()119       setBackendServiceOperationSettings() {
120     return ((TargetSslProxiesStubSettings) getStubSettings()).setBackendServiceOperationSettings();
121   }
122 
123   /** Returns the object with the settings used for calls to setCertificateMap. */
124   public UnaryCallSettings<SetCertificateMapTargetSslProxyRequest, Operation>
setCertificateMapSettings()125       setCertificateMapSettings() {
126     return ((TargetSslProxiesStubSettings) getStubSettings()).setCertificateMapSettings();
127   }
128 
129   /** Returns the object with the settings used for calls to setCertificateMap. */
130   public OperationCallSettings<SetCertificateMapTargetSslProxyRequest, Operation, Operation>
setCertificateMapOperationSettings()131       setCertificateMapOperationSettings() {
132     return ((TargetSslProxiesStubSettings) getStubSettings()).setCertificateMapOperationSettings();
133   }
134 
135   /** Returns the object with the settings used for calls to setProxyHeader. */
136   public UnaryCallSettings<SetProxyHeaderTargetSslProxyRequest, Operation>
setProxyHeaderSettings()137       setProxyHeaderSettings() {
138     return ((TargetSslProxiesStubSettings) getStubSettings()).setProxyHeaderSettings();
139   }
140 
141   /** Returns the object with the settings used for calls to setProxyHeader. */
142   public OperationCallSettings<SetProxyHeaderTargetSslProxyRequest, Operation, Operation>
setProxyHeaderOperationSettings()143       setProxyHeaderOperationSettings() {
144     return ((TargetSslProxiesStubSettings) getStubSettings()).setProxyHeaderOperationSettings();
145   }
146 
147   /** Returns the object with the settings used for calls to setSslCertificates. */
148   public UnaryCallSettings<SetSslCertificatesTargetSslProxyRequest, Operation>
setSslCertificatesSettings()149       setSslCertificatesSettings() {
150     return ((TargetSslProxiesStubSettings) getStubSettings()).setSslCertificatesSettings();
151   }
152 
153   /** Returns the object with the settings used for calls to setSslCertificates. */
154   public OperationCallSettings<SetSslCertificatesTargetSslProxyRequest, Operation, Operation>
setSslCertificatesOperationSettings()155       setSslCertificatesOperationSettings() {
156     return ((TargetSslProxiesStubSettings) getStubSettings()).setSslCertificatesOperationSettings();
157   }
158 
159   /** Returns the object with the settings used for calls to setSslPolicy. */
setSslPolicySettings()160   public UnaryCallSettings<SetSslPolicyTargetSslProxyRequest, Operation> setSslPolicySettings() {
161     return ((TargetSslProxiesStubSettings) getStubSettings()).setSslPolicySettings();
162   }
163 
164   /** Returns the object with the settings used for calls to setSslPolicy. */
165   public OperationCallSettings<SetSslPolicyTargetSslProxyRequest, Operation, Operation>
setSslPolicyOperationSettings()166       setSslPolicyOperationSettings() {
167     return ((TargetSslProxiesStubSettings) getStubSettings()).setSslPolicyOperationSettings();
168   }
169 
create(TargetSslProxiesStubSettings stub)170   public static final TargetSslProxiesSettings create(TargetSslProxiesStubSettings stub)
171       throws IOException {
172     return new TargetSslProxiesSettings.Builder(stub.toBuilder()).build();
173   }
174 
175   /** Returns a builder for the default ExecutorProvider for this service. */
defaultExecutorProviderBuilder()176   public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() {
177     return TargetSslProxiesStubSettings.defaultExecutorProviderBuilder();
178   }
179 
180   /** Returns the default service endpoint. */
getDefaultEndpoint()181   public static String getDefaultEndpoint() {
182     return TargetSslProxiesStubSettings.getDefaultEndpoint();
183   }
184 
185   /** Returns the default service scopes. */
getDefaultServiceScopes()186   public static List<String> getDefaultServiceScopes() {
187     return TargetSslProxiesStubSettings.getDefaultServiceScopes();
188   }
189 
190   /** Returns a builder for the default credentials for this service. */
defaultCredentialsProviderBuilder()191   public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() {
192     return TargetSslProxiesStubSettings.defaultCredentialsProviderBuilder();
193   }
194 
195   /** Returns a builder for the default ChannelProvider for this service. */
196   public static InstantiatingHttpJsonChannelProvider.Builder
defaultHttpJsonTransportProviderBuilder()197       defaultHttpJsonTransportProviderBuilder() {
198     return TargetSslProxiesStubSettings.defaultHttpJsonTransportProviderBuilder();
199   }
200 
defaultTransportChannelProvider()201   public static TransportChannelProvider defaultTransportChannelProvider() {
202     return TargetSslProxiesStubSettings.defaultTransportChannelProvider();
203   }
204 
205   @BetaApi("The surface for customizing headers is not stable yet and may change in the future.")
defaultApiClientHeaderProviderBuilder()206   public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
207     return TargetSslProxiesStubSettings.defaultApiClientHeaderProviderBuilder();
208   }
209 
210   /** Returns a new builder for this class. */
newBuilder()211   public static Builder newBuilder() {
212     return Builder.createDefault();
213   }
214 
215   /** Returns a new builder for this class. */
newBuilder(ClientContext clientContext)216   public static Builder newBuilder(ClientContext clientContext) {
217     return new Builder(clientContext);
218   }
219 
220   /** Returns a builder containing all the values of this settings class. */
toBuilder()221   public Builder toBuilder() {
222     return new Builder(this);
223   }
224 
TargetSslProxiesSettings(Builder settingsBuilder)225   protected TargetSslProxiesSettings(Builder settingsBuilder) throws IOException {
226     super(settingsBuilder);
227   }
228 
229   /** Builder for TargetSslProxiesSettings. */
230   public static class Builder extends ClientSettings.Builder<TargetSslProxiesSettings, Builder> {
231 
Builder()232     protected Builder() throws IOException {
233       this(((ClientContext) null));
234     }
235 
Builder(ClientContext clientContext)236     protected Builder(ClientContext clientContext) {
237       super(TargetSslProxiesStubSettings.newBuilder(clientContext));
238     }
239 
Builder(TargetSslProxiesSettings settings)240     protected Builder(TargetSslProxiesSettings settings) {
241       super(settings.getStubSettings().toBuilder());
242     }
243 
Builder(TargetSslProxiesStubSettings.Builder stubSettings)244     protected Builder(TargetSslProxiesStubSettings.Builder stubSettings) {
245       super(stubSettings);
246     }
247 
createDefault()248     private static Builder createDefault() {
249       return new Builder(TargetSslProxiesStubSettings.newBuilder());
250     }
251 
getStubSettingsBuilder()252     public TargetSslProxiesStubSettings.Builder getStubSettingsBuilder() {
253       return ((TargetSslProxiesStubSettings.Builder) getStubSettings());
254     }
255 
256     /**
257      * Applies the given settings updater function to all of the unary API methods in this service.
258      *
259      * <p>Note: This method does not support applying settings to streaming methods.
260      */
applyToAllUnaryMethods( ApiFunction<UnaryCallSettings.Builder<?, ?>, Void> settingsUpdater)261     public Builder applyToAllUnaryMethods(
262         ApiFunction<UnaryCallSettings.Builder<?, ?>, Void> settingsUpdater) {
263       super.applyToAllUnaryMethods(
264           getStubSettingsBuilder().unaryMethodSettingsBuilders(), settingsUpdater);
265       return this;
266     }
267 
268     /** Returns the builder for the settings used for calls to delete. */
deleteSettings()269     public UnaryCallSettings.Builder<DeleteTargetSslProxyRequest, Operation> deleteSettings() {
270       return getStubSettingsBuilder().deleteSettings();
271     }
272 
273     /** Returns the builder for the settings used for calls to delete. */
274     public OperationCallSettings.Builder<DeleteTargetSslProxyRequest, Operation, Operation>
deleteOperationSettings()275         deleteOperationSettings() {
276       return getStubSettingsBuilder().deleteOperationSettings();
277     }
278 
279     /** Returns the builder for the settings used for calls to get. */
getSettings()280     public UnaryCallSettings.Builder<GetTargetSslProxyRequest, TargetSslProxy> getSettings() {
281       return getStubSettingsBuilder().getSettings();
282     }
283 
284     /** Returns the builder for the settings used for calls to insert. */
insertSettings()285     public UnaryCallSettings.Builder<InsertTargetSslProxyRequest, Operation> insertSettings() {
286       return getStubSettingsBuilder().insertSettings();
287     }
288 
289     /** Returns the builder for the settings used for calls to insert. */
290     public OperationCallSettings.Builder<InsertTargetSslProxyRequest, Operation, Operation>
insertOperationSettings()291         insertOperationSettings() {
292       return getStubSettingsBuilder().insertOperationSettings();
293     }
294 
295     /** Returns the builder for the settings used for calls to list. */
296     public PagedCallSettings.Builder<
297             ListTargetSslProxiesRequest, TargetSslProxyList, ListPagedResponse>
listSettings()298         listSettings() {
299       return getStubSettingsBuilder().listSettings();
300     }
301 
302     /** Returns the builder for the settings used for calls to setBackendService. */
303     public UnaryCallSettings.Builder<SetBackendServiceTargetSslProxyRequest, Operation>
setBackendServiceSettings()304         setBackendServiceSettings() {
305       return getStubSettingsBuilder().setBackendServiceSettings();
306     }
307 
308     /** Returns the builder for the settings used for calls to setBackendService. */
309     public OperationCallSettings.Builder<
310             SetBackendServiceTargetSslProxyRequest, Operation, Operation>
setBackendServiceOperationSettings()311         setBackendServiceOperationSettings() {
312       return getStubSettingsBuilder().setBackendServiceOperationSettings();
313     }
314 
315     /** Returns the builder for the settings used for calls to setCertificateMap. */
316     public UnaryCallSettings.Builder<SetCertificateMapTargetSslProxyRequest, Operation>
setCertificateMapSettings()317         setCertificateMapSettings() {
318       return getStubSettingsBuilder().setCertificateMapSettings();
319     }
320 
321     /** Returns the builder for the settings used for calls to setCertificateMap. */
322     public OperationCallSettings.Builder<
323             SetCertificateMapTargetSslProxyRequest, Operation, Operation>
setCertificateMapOperationSettings()324         setCertificateMapOperationSettings() {
325       return getStubSettingsBuilder().setCertificateMapOperationSettings();
326     }
327 
328     /** Returns the builder for the settings used for calls to setProxyHeader. */
329     public UnaryCallSettings.Builder<SetProxyHeaderTargetSslProxyRequest, Operation>
setProxyHeaderSettings()330         setProxyHeaderSettings() {
331       return getStubSettingsBuilder().setProxyHeaderSettings();
332     }
333 
334     /** Returns the builder for the settings used for calls to setProxyHeader. */
335     public OperationCallSettings.Builder<SetProxyHeaderTargetSslProxyRequest, Operation, Operation>
setProxyHeaderOperationSettings()336         setProxyHeaderOperationSettings() {
337       return getStubSettingsBuilder().setProxyHeaderOperationSettings();
338     }
339 
340     /** Returns the builder for the settings used for calls to setSslCertificates. */
341     public UnaryCallSettings.Builder<SetSslCertificatesTargetSslProxyRequest, Operation>
setSslCertificatesSettings()342         setSslCertificatesSettings() {
343       return getStubSettingsBuilder().setSslCertificatesSettings();
344     }
345 
346     /** Returns the builder for the settings used for calls to setSslCertificates. */
347     public OperationCallSettings.Builder<
348             SetSslCertificatesTargetSslProxyRequest, Operation, Operation>
setSslCertificatesOperationSettings()349         setSslCertificatesOperationSettings() {
350       return getStubSettingsBuilder().setSslCertificatesOperationSettings();
351     }
352 
353     /** Returns the builder for the settings used for calls to setSslPolicy. */
354     public UnaryCallSettings.Builder<SetSslPolicyTargetSslProxyRequest, Operation>
setSslPolicySettings()355         setSslPolicySettings() {
356       return getStubSettingsBuilder().setSslPolicySettings();
357     }
358 
359     /** Returns the builder for the settings used for calls to setSslPolicy. */
360     public OperationCallSettings.Builder<SetSslPolicyTargetSslProxyRequest, Operation, Operation>
setSslPolicyOperationSettings()361         setSslPolicyOperationSettings() {
362       return getStubSettingsBuilder().setSslPolicyOperationSettings();
363     }
364 
365     @Override
build()366     public TargetSslProxiesSettings build() throws IOException {
367       return new TargetSslProxiesSettings(this);
368     }
369   }
370 }
371