• 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.v1p5beta1;
18 
19 import static com.google.cloud.asset.v1p5beta1.AssetServiceClient.ListAssetsPagedResponse;
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.grpc.InstantiatingGrpcChannelProvider;
26 import com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider;
27 import com.google.api.gax.rpc.ApiClientHeaderProvider;
28 import com.google.api.gax.rpc.ClientContext;
29 import com.google.api.gax.rpc.ClientSettings;
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.asset.v1p5beta1.stub.AssetServiceStubSettings;
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 AssetServiceClient}.
41  *
42  * <p>The default instance has everything set to sensible defaults:
43  *
44  * <ul>
45  *   <li>The default service address (cloudasset.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 listAssets 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  * AssetServiceSettings.Builder assetServiceSettingsBuilder = AssetServiceSettings.newBuilder();
62  * assetServiceSettingsBuilder
63  *     .listAssetsSettings()
64  *     .setRetrySettings(
65  *         assetServiceSettingsBuilder
66  *             .listAssetsSettings()
67  *             .getRetrySettings()
68  *             .toBuilder()
69  *             .setTotalTimeout(Duration.ofSeconds(30))
70  *             .build());
71  * AssetServiceSettings assetServiceSettings = assetServiceSettingsBuilder.build();
72  * }</pre>
73  */
74 @BetaApi
75 @Generated("by gapic-generator-java")
76 public class AssetServiceSettings extends ClientSettings<AssetServiceSettings> {
77 
78   /** Returns the object with the settings used for calls to listAssets. */
79   public PagedCallSettings<ListAssetsRequest, ListAssetsResponse, ListAssetsPagedResponse>
listAssetsSettings()80       listAssetsSettings() {
81     return ((AssetServiceStubSettings) getStubSettings()).listAssetsSettings();
82   }
83 
create(AssetServiceStubSettings stub)84   public static final AssetServiceSettings create(AssetServiceStubSettings stub)
85       throws IOException {
86     return new AssetServiceSettings.Builder(stub.toBuilder()).build();
87   }
88 
89   /** Returns a builder for the default ExecutorProvider for this service. */
defaultExecutorProviderBuilder()90   public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() {
91     return AssetServiceStubSettings.defaultExecutorProviderBuilder();
92   }
93 
94   /** Returns the default service endpoint. */
getDefaultEndpoint()95   public static String getDefaultEndpoint() {
96     return AssetServiceStubSettings.getDefaultEndpoint();
97   }
98 
99   /** Returns the default service scopes. */
getDefaultServiceScopes()100   public static List<String> getDefaultServiceScopes() {
101     return AssetServiceStubSettings.getDefaultServiceScopes();
102   }
103 
104   /** Returns a builder for the default credentials for this service. */
defaultCredentialsProviderBuilder()105   public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() {
106     return AssetServiceStubSettings.defaultCredentialsProviderBuilder();
107   }
108 
109   /** Returns a builder for the default gRPC ChannelProvider for this service. */
defaultGrpcTransportProviderBuilder()110   public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
111     return AssetServiceStubSettings.defaultGrpcTransportProviderBuilder();
112   }
113 
114   /** Returns a builder for the default REST ChannelProvider for this service. */
115   @BetaApi
116   public static InstantiatingHttpJsonChannelProvider.Builder
defaultHttpJsonTransportProviderBuilder()117       defaultHttpJsonTransportProviderBuilder() {
118     return AssetServiceStubSettings.defaultHttpJsonTransportProviderBuilder();
119   }
120 
defaultTransportChannelProvider()121   public static TransportChannelProvider defaultTransportChannelProvider() {
122     return AssetServiceStubSettings.defaultTransportChannelProvider();
123   }
124 
125   @BetaApi("The surface for customizing headers is not stable yet and may change in the future.")
defaultApiClientHeaderProviderBuilder()126   public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
127     return AssetServiceStubSettings.defaultApiClientHeaderProviderBuilder();
128   }
129 
130   /** Returns a new gRPC builder for this class. */
newBuilder()131   public static Builder newBuilder() {
132     return Builder.createDefault();
133   }
134 
135   /** Returns a new REST builder for this class. */
136   @BetaApi
newHttpJsonBuilder()137   public static Builder newHttpJsonBuilder() {
138     return Builder.createHttpJsonDefault();
139   }
140 
141   /** Returns a new builder for this class. */
newBuilder(ClientContext clientContext)142   public static Builder newBuilder(ClientContext clientContext) {
143     return new Builder(clientContext);
144   }
145 
146   /** Returns a builder containing all the values of this settings class. */
toBuilder()147   public Builder toBuilder() {
148     return new Builder(this);
149   }
150 
AssetServiceSettings(Builder settingsBuilder)151   protected AssetServiceSettings(Builder settingsBuilder) throws IOException {
152     super(settingsBuilder);
153   }
154 
155   /** Builder for AssetServiceSettings. */
156   public static class Builder extends ClientSettings.Builder<AssetServiceSettings, Builder> {
157 
Builder()158     protected Builder() throws IOException {
159       this(((ClientContext) null));
160     }
161 
Builder(ClientContext clientContext)162     protected Builder(ClientContext clientContext) {
163       super(AssetServiceStubSettings.newBuilder(clientContext));
164     }
165 
Builder(AssetServiceSettings settings)166     protected Builder(AssetServiceSettings settings) {
167       super(settings.getStubSettings().toBuilder());
168     }
169 
Builder(AssetServiceStubSettings.Builder stubSettings)170     protected Builder(AssetServiceStubSettings.Builder stubSettings) {
171       super(stubSettings);
172     }
173 
createDefault()174     private static Builder createDefault() {
175       return new Builder(AssetServiceStubSettings.newBuilder());
176     }
177 
178     @BetaApi
createHttpJsonDefault()179     private static Builder createHttpJsonDefault() {
180       return new Builder(AssetServiceStubSettings.newHttpJsonBuilder());
181     }
182 
getStubSettingsBuilder()183     public AssetServiceStubSettings.Builder getStubSettingsBuilder() {
184       return ((AssetServiceStubSettings.Builder) getStubSettings());
185     }
186 
187     /**
188      * Applies the given settings updater function to all of the unary API methods in this service.
189      *
190      * <p>Note: This method does not support applying settings to streaming methods.
191      */
applyToAllUnaryMethods( ApiFunction<UnaryCallSettings.Builder<?, ?>, Void> settingsUpdater)192     public Builder applyToAllUnaryMethods(
193         ApiFunction<UnaryCallSettings.Builder<?, ?>, Void> settingsUpdater) {
194       super.applyToAllUnaryMethods(
195           getStubSettingsBuilder().unaryMethodSettingsBuilders(), settingsUpdater);
196       return this;
197     }
198 
199     /** Returns the builder for the settings used for calls to listAssets. */
200     public PagedCallSettings.Builder<ListAssetsRequest, ListAssetsResponse, ListAssetsPagedResponse>
listAssetsSettings()201         listAssetsSettings() {
202       return getStubSettingsBuilder().listAssetsSettings();
203     }
204 
205     @Override
build()206     public AssetServiceSettings build() throws IOException {
207       return new AssetServiceSettings(this);
208     }
209   }
210 }
211