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