• 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.RegionSslCertificatesClient.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.RegionSslCertificatesStubSettings;
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 RegionSslCertificatesClient}.
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  * RegionSslCertificatesSettings.Builder regionSslCertificatesSettingsBuilder =
62  *     RegionSslCertificatesSettings.newBuilder();
63  * regionSslCertificatesSettingsBuilder
64  *     .getSettings()
65  *     .setRetrySettings(
66  *         regionSslCertificatesSettingsBuilder
67  *             .getSettings()
68  *             .getRetrySettings()
69  *             .toBuilder()
70  *             .setTotalTimeout(Duration.ofSeconds(30))
71  *             .build());
72  * RegionSslCertificatesSettings regionSslCertificatesSettings =
73  *     regionSslCertificatesSettingsBuilder.build();
74  * }</pre>
75  */
76 @Generated("by gapic-generator-java")
77 public class RegionSslCertificatesSettings extends ClientSettings<RegionSslCertificatesSettings> {
78 
79   /** Returns the object with the settings used for calls to delete. */
deleteSettings()80   public UnaryCallSettings<DeleteRegionSslCertificateRequest, Operation> deleteSettings() {
81     return ((RegionSslCertificatesStubSettings) getStubSettings()).deleteSettings();
82   }
83 
84   /** Returns the object with the settings used for calls to delete. */
85   public OperationCallSettings<DeleteRegionSslCertificateRequest, Operation, Operation>
deleteOperationSettings()86       deleteOperationSettings() {
87     return ((RegionSslCertificatesStubSettings) getStubSettings()).deleteOperationSettings();
88   }
89 
90   /** Returns the object with the settings used for calls to get. */
getSettings()91   public UnaryCallSettings<GetRegionSslCertificateRequest, SslCertificate> getSettings() {
92     return ((RegionSslCertificatesStubSettings) getStubSettings()).getSettings();
93   }
94 
95   /** Returns the object with the settings used for calls to insert. */
insertSettings()96   public UnaryCallSettings<InsertRegionSslCertificateRequest, Operation> insertSettings() {
97     return ((RegionSslCertificatesStubSettings) getStubSettings()).insertSettings();
98   }
99 
100   /** Returns the object with the settings used for calls to insert. */
101   public OperationCallSettings<InsertRegionSslCertificateRequest, Operation, Operation>
insertOperationSettings()102       insertOperationSettings() {
103     return ((RegionSslCertificatesStubSettings) getStubSettings()).insertOperationSettings();
104   }
105 
106   /** Returns the object with the settings used for calls to list. */
107   public PagedCallSettings<ListRegionSslCertificatesRequest, SslCertificateList, ListPagedResponse>
listSettings()108       listSettings() {
109     return ((RegionSslCertificatesStubSettings) getStubSettings()).listSettings();
110   }
111 
create(RegionSslCertificatesStubSettings stub)112   public static final RegionSslCertificatesSettings create(RegionSslCertificatesStubSettings stub)
113       throws IOException {
114     return new RegionSslCertificatesSettings.Builder(stub.toBuilder()).build();
115   }
116 
117   /** Returns a builder for the default ExecutorProvider for this service. */
defaultExecutorProviderBuilder()118   public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() {
119     return RegionSslCertificatesStubSettings.defaultExecutorProviderBuilder();
120   }
121 
122   /** Returns the default service endpoint. */
getDefaultEndpoint()123   public static String getDefaultEndpoint() {
124     return RegionSslCertificatesStubSettings.getDefaultEndpoint();
125   }
126 
127   /** Returns the default service scopes. */
getDefaultServiceScopes()128   public static List<String> getDefaultServiceScopes() {
129     return RegionSslCertificatesStubSettings.getDefaultServiceScopes();
130   }
131 
132   /** Returns a builder for the default credentials for this service. */
defaultCredentialsProviderBuilder()133   public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() {
134     return RegionSslCertificatesStubSettings.defaultCredentialsProviderBuilder();
135   }
136 
137   /** Returns a builder for the default ChannelProvider for this service. */
138   public static InstantiatingHttpJsonChannelProvider.Builder
defaultHttpJsonTransportProviderBuilder()139       defaultHttpJsonTransportProviderBuilder() {
140     return RegionSslCertificatesStubSettings.defaultHttpJsonTransportProviderBuilder();
141   }
142 
defaultTransportChannelProvider()143   public static TransportChannelProvider defaultTransportChannelProvider() {
144     return RegionSslCertificatesStubSettings.defaultTransportChannelProvider();
145   }
146 
147   @BetaApi("The surface for customizing headers is not stable yet and may change in the future.")
defaultApiClientHeaderProviderBuilder()148   public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
149     return RegionSslCertificatesStubSettings.defaultApiClientHeaderProviderBuilder();
150   }
151 
152   /** Returns a new builder for this class. */
newBuilder()153   public static Builder newBuilder() {
154     return Builder.createDefault();
155   }
156 
157   /** Returns a new builder for this class. */
newBuilder(ClientContext clientContext)158   public static Builder newBuilder(ClientContext clientContext) {
159     return new Builder(clientContext);
160   }
161 
162   /** Returns a builder containing all the values of this settings class. */
toBuilder()163   public Builder toBuilder() {
164     return new Builder(this);
165   }
166 
RegionSslCertificatesSettings(Builder settingsBuilder)167   protected RegionSslCertificatesSettings(Builder settingsBuilder) throws IOException {
168     super(settingsBuilder);
169   }
170 
171   /** Builder for RegionSslCertificatesSettings. */
172   public static class Builder
173       extends ClientSettings.Builder<RegionSslCertificatesSettings, Builder> {
174 
Builder()175     protected Builder() throws IOException {
176       this(((ClientContext) null));
177     }
178 
Builder(ClientContext clientContext)179     protected Builder(ClientContext clientContext) {
180       super(RegionSslCertificatesStubSettings.newBuilder(clientContext));
181     }
182 
Builder(RegionSslCertificatesSettings settings)183     protected Builder(RegionSslCertificatesSettings settings) {
184       super(settings.getStubSettings().toBuilder());
185     }
186 
Builder(RegionSslCertificatesStubSettings.Builder stubSettings)187     protected Builder(RegionSslCertificatesStubSettings.Builder stubSettings) {
188       super(stubSettings);
189     }
190 
createDefault()191     private static Builder createDefault() {
192       return new Builder(RegionSslCertificatesStubSettings.newBuilder());
193     }
194 
getStubSettingsBuilder()195     public RegionSslCertificatesStubSettings.Builder getStubSettingsBuilder() {
196       return ((RegionSslCertificatesStubSettings.Builder) getStubSettings());
197     }
198 
199     /**
200      * Applies the given settings updater function to all of the unary API methods in this service.
201      *
202      * <p>Note: This method does not support applying settings to streaming methods.
203      */
applyToAllUnaryMethods( ApiFunction<UnaryCallSettings.Builder<?, ?>, Void> settingsUpdater)204     public Builder applyToAllUnaryMethods(
205         ApiFunction<UnaryCallSettings.Builder<?, ?>, Void> settingsUpdater) {
206       super.applyToAllUnaryMethods(
207           getStubSettingsBuilder().unaryMethodSettingsBuilders(), settingsUpdater);
208       return this;
209     }
210 
211     /** Returns the builder for the settings used for calls to delete. */
212     public UnaryCallSettings.Builder<DeleteRegionSslCertificateRequest, Operation>
deleteSettings()213         deleteSettings() {
214       return getStubSettingsBuilder().deleteSettings();
215     }
216 
217     /** Returns the builder for the settings used for calls to delete. */
218     public OperationCallSettings.Builder<DeleteRegionSslCertificateRequest, Operation, Operation>
deleteOperationSettings()219         deleteOperationSettings() {
220       return getStubSettingsBuilder().deleteOperationSettings();
221     }
222 
223     /** Returns the builder for the settings used for calls to get. */
getSettings()224     public UnaryCallSettings.Builder<GetRegionSslCertificateRequest, SslCertificate> getSettings() {
225       return getStubSettingsBuilder().getSettings();
226     }
227 
228     /** Returns the builder for the settings used for calls to insert. */
229     public UnaryCallSettings.Builder<InsertRegionSslCertificateRequest, Operation>
insertSettings()230         insertSettings() {
231       return getStubSettingsBuilder().insertSettings();
232     }
233 
234     /** Returns the builder for the settings used for calls to insert. */
235     public OperationCallSettings.Builder<InsertRegionSslCertificateRequest, Operation, Operation>
insertOperationSettings()236         insertOperationSettings() {
237       return getStubSettingsBuilder().insertOperationSettings();
238     }
239 
240     /** Returns the builder for the settings used for calls to list. */
241     public PagedCallSettings.Builder<
242             ListRegionSslCertificatesRequest, SslCertificateList, ListPagedResponse>
listSettings()243         listSettings() {
244       return getStubSettingsBuilder().listSettings();
245     }
246 
247     @Override
build()248     public RegionSslCertificatesSettings build() throws IOException {
249       return new RegionSslCertificatesSettings(this);
250     }
251   }
252 }
253