|
| 1 | +/* |
| 2 | + * Copyright 2025 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.iam.v3beta; |
| 18 | + |
| 19 | +import static com.google.iam.v3beta.PolicyBindingsClient.ListPolicyBindingsPagedResponse; |
| 20 | +import static com.google.iam.v3beta.PolicyBindingsClient.SearchTargetPolicyBindingsPagedResponse; |
| 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.OperationCallSettings; |
| 32 | +import com.google.api.gax.rpc.PagedCallSettings; |
| 33 | +import com.google.api.gax.rpc.TransportChannelProvider; |
| 34 | +import com.google.api.gax.rpc.UnaryCallSettings; |
| 35 | +import com.google.iam.v3beta.stub.PolicyBindingsStubSettings; |
| 36 | +import com.google.longrunning.Operation; |
| 37 | +import com.google.protobuf.Empty; |
| 38 | +import java.io.IOException; |
| 39 | +import java.util.List; |
| 40 | +import javax.annotation.Generated; |
| 41 | + |
| 42 | +// AUTO-GENERATED DOCUMENTATION AND CLASS. |
| 43 | +/** |
| 44 | + * Settings class to configure an instance of {@link PolicyBindingsClient}. |
| 45 | + * |
| 46 | + * <p>The default instance has everything set to sensible defaults: |
| 47 | + * |
| 48 | + * <ul> |
| 49 | + * <li>The default service address (iam.googleapis.com) and default port (443) are used. |
| 50 | + * <li>Credentials are acquired automatically through Application Default Credentials. |
| 51 | + * <li>Retries are configured for idempotent methods but not for non-idempotent methods. |
| 52 | + * </ul> |
| 53 | + * |
| 54 | + * <p>The builder of this class is recursive, so contained classes are themselves builders. When |
| 55 | + * build() is called, the tree of builders is called to create the complete settings object. |
| 56 | + * |
| 57 | + * <p>For example, to set the |
| 58 | + * [RetrySettings](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) |
| 59 | + * of getPolicyBinding: |
| 60 | + * |
| 61 | + * <pre>{@code |
| 62 | + * // This snippet has been automatically generated and should be regarded as a code template only. |
| 63 | + * // It will require modifications to work: |
| 64 | + * // - It may require correct/in-range values for request initialization. |
| 65 | + * // - It may require specifying regional endpoints when creating the service client as shown in |
| 66 | + * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library |
| 67 | + * PolicyBindingsSettings.Builder policyBindingsSettingsBuilder = |
| 68 | + * PolicyBindingsSettings.newBuilder(); |
| 69 | + * policyBindingsSettingsBuilder |
| 70 | + * .getPolicyBindingSettings() |
| 71 | + * .setRetrySettings( |
| 72 | + * policyBindingsSettingsBuilder |
| 73 | + * .getPolicyBindingSettings() |
| 74 | + * .getRetrySettings() |
| 75 | + * .toBuilder() |
| 76 | + * .setInitialRetryDelayDuration(Duration.ofSeconds(1)) |
| 77 | + * .setInitialRpcTimeoutDuration(Duration.ofSeconds(5)) |
| 78 | + * .setMaxAttempts(5) |
| 79 | + * .setMaxRetryDelayDuration(Duration.ofSeconds(30)) |
| 80 | + * .setMaxRpcTimeoutDuration(Duration.ofSeconds(60)) |
| 81 | + * .setRetryDelayMultiplier(1.3) |
| 82 | + * .setRpcTimeoutMultiplier(1.5) |
| 83 | + * .setTotalTimeoutDuration(Duration.ofSeconds(300)) |
| 84 | + * .build()); |
| 85 | + * PolicyBindingsSettings policyBindingsSettings = policyBindingsSettingsBuilder.build(); |
| 86 | + * }</pre> |
| 87 | + * |
| 88 | + * Please refer to the [Client Side Retry |
| 89 | + * Guide](https://github.com/googleapis/google-cloud-java/blob/main/docs/client_retries.md) for |
| 90 | + * additional support in setting retries. |
| 91 | + * |
| 92 | + * <p>To configure the RetrySettings of a Long Running Operation method, create an |
| 93 | + * OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to |
| 94 | + * configure the RetrySettings for createPolicyBinding: |
| 95 | + * |
| 96 | + * <pre>{@code |
| 97 | + * // This snippet has been automatically generated and should be regarded as a code template only. |
| 98 | + * // It will require modifications to work: |
| 99 | + * // - It may require correct/in-range values for request initialization. |
| 100 | + * // - It may require specifying regional endpoints when creating the service client as shown in |
| 101 | + * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library |
| 102 | + * PolicyBindingsSettings.Builder policyBindingsSettingsBuilder = |
| 103 | + * PolicyBindingsSettings.newBuilder(); |
| 104 | + * TimedRetryAlgorithm timedRetryAlgorithm = |
| 105 | + * OperationalTimedPollAlgorithm.create( |
| 106 | + * RetrySettings.newBuilder() |
| 107 | + * .setInitialRetryDelayDuration(Duration.ofMillis(500)) |
| 108 | + * .setRetryDelayMultiplier(1.5) |
| 109 | + * .setMaxRetryDelayDuration(Duration.ofMillis(5000)) |
| 110 | + * .setTotalTimeoutDuration(Duration.ofHours(24)) |
| 111 | + * .build()); |
| 112 | + * policyBindingsSettingsBuilder |
| 113 | + * .createClusterOperationSettings() |
| 114 | + * .setPollingAlgorithm(timedRetryAlgorithm) |
| 115 | + * .build(); |
| 116 | + * }</pre> |
| 117 | + */ |
| 118 | +@BetaApi |
| 119 | +@Generated("by gapic-generator-java") |
| 120 | +public class PolicyBindingsSettings extends ClientSettings<PolicyBindingsSettings> { |
| 121 | + |
| 122 | + /** Returns the object with the settings used for calls to createPolicyBinding. */ |
| 123 | + public UnaryCallSettings<CreatePolicyBindingRequest, Operation> createPolicyBindingSettings() { |
| 124 | + return ((PolicyBindingsStubSettings) getStubSettings()).createPolicyBindingSettings(); |
| 125 | + } |
| 126 | + |
| 127 | + /** Returns the object with the settings used for calls to createPolicyBinding. */ |
| 128 | + public OperationCallSettings<CreatePolicyBindingRequest, PolicyBinding, OperationMetadata> |
| 129 | + createPolicyBindingOperationSettings() { |
| 130 | + return ((PolicyBindingsStubSettings) getStubSettings()).createPolicyBindingOperationSettings(); |
| 131 | + } |
| 132 | + |
| 133 | + /** Returns the object with the settings used for calls to getPolicyBinding. */ |
| 134 | + public UnaryCallSettings<GetPolicyBindingRequest, PolicyBinding> getPolicyBindingSettings() { |
| 135 | + return ((PolicyBindingsStubSettings) getStubSettings()).getPolicyBindingSettings(); |
| 136 | + } |
| 137 | + |
| 138 | + /** Returns the object with the settings used for calls to updatePolicyBinding. */ |
| 139 | + public UnaryCallSettings<UpdatePolicyBindingRequest, Operation> updatePolicyBindingSettings() { |
| 140 | + return ((PolicyBindingsStubSettings) getStubSettings()).updatePolicyBindingSettings(); |
| 141 | + } |
| 142 | + |
| 143 | + /** Returns the object with the settings used for calls to updatePolicyBinding. */ |
| 144 | + public OperationCallSettings<UpdatePolicyBindingRequest, PolicyBinding, OperationMetadata> |
| 145 | + updatePolicyBindingOperationSettings() { |
| 146 | + return ((PolicyBindingsStubSettings) getStubSettings()).updatePolicyBindingOperationSettings(); |
| 147 | + } |
| 148 | + |
| 149 | + /** Returns the object with the settings used for calls to deletePolicyBinding. */ |
| 150 | + public UnaryCallSettings<DeletePolicyBindingRequest, Operation> deletePolicyBindingSettings() { |
| 151 | + return ((PolicyBindingsStubSettings) getStubSettings()).deletePolicyBindingSettings(); |
| 152 | + } |
| 153 | + |
| 154 | + /** Returns the object with the settings used for calls to deletePolicyBinding. */ |
| 155 | + public OperationCallSettings<DeletePolicyBindingRequest, Empty, OperationMetadata> |
| 156 | + deletePolicyBindingOperationSettings() { |
| 157 | + return ((PolicyBindingsStubSettings) getStubSettings()).deletePolicyBindingOperationSettings(); |
| 158 | + } |
| 159 | + |
| 160 | + /** Returns the object with the settings used for calls to listPolicyBindings. */ |
| 161 | + public PagedCallSettings< |
| 162 | + ListPolicyBindingsRequest, ListPolicyBindingsResponse, ListPolicyBindingsPagedResponse> |
| 163 | + listPolicyBindingsSettings() { |
| 164 | + return ((PolicyBindingsStubSettings) getStubSettings()).listPolicyBindingsSettings(); |
| 165 | + } |
| 166 | + |
| 167 | + /** Returns the object with the settings used for calls to searchTargetPolicyBindings. */ |
| 168 | + public PagedCallSettings< |
| 169 | + SearchTargetPolicyBindingsRequest, |
| 170 | + SearchTargetPolicyBindingsResponse, |
| 171 | + SearchTargetPolicyBindingsPagedResponse> |
| 172 | + searchTargetPolicyBindingsSettings() { |
| 173 | + return ((PolicyBindingsStubSettings) getStubSettings()).searchTargetPolicyBindingsSettings(); |
| 174 | + } |
| 175 | + |
| 176 | + public static final PolicyBindingsSettings create(PolicyBindingsStubSettings stub) |
| 177 | + throws IOException { |
| 178 | + return new PolicyBindingsSettings.Builder(stub.toBuilder()).build(); |
| 179 | + } |
| 180 | + |
| 181 | + /** Returns a builder for the default ExecutorProvider for this service. */ |
| 182 | + public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { |
| 183 | + return PolicyBindingsStubSettings.defaultExecutorProviderBuilder(); |
| 184 | + } |
| 185 | + |
| 186 | + /** Returns the default service endpoint. */ |
| 187 | + public static String getDefaultEndpoint() { |
| 188 | + return PolicyBindingsStubSettings.getDefaultEndpoint(); |
| 189 | + } |
| 190 | + |
| 191 | + /** Returns the default service scopes. */ |
| 192 | + public static List<String> getDefaultServiceScopes() { |
| 193 | + return PolicyBindingsStubSettings.getDefaultServiceScopes(); |
| 194 | + } |
| 195 | + |
| 196 | + /** Returns a builder for the default credentials for this service. */ |
| 197 | + public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() { |
| 198 | + return PolicyBindingsStubSettings.defaultCredentialsProviderBuilder(); |
| 199 | + } |
| 200 | + |
| 201 | + /** Returns a builder for the default gRPC ChannelProvider for this service. */ |
| 202 | + public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() { |
| 203 | + return PolicyBindingsStubSettings.defaultGrpcTransportProviderBuilder(); |
| 204 | + } |
| 205 | + |
| 206 | + /** Returns a builder for the default REST ChannelProvider for this service. */ |
| 207 | + @BetaApi |
| 208 | + public static InstantiatingHttpJsonChannelProvider.Builder |
| 209 | + defaultHttpJsonTransportProviderBuilder() { |
| 210 | + return PolicyBindingsStubSettings.defaultHttpJsonTransportProviderBuilder(); |
| 211 | + } |
| 212 | + |
| 213 | + public static TransportChannelProvider defaultTransportChannelProvider() { |
| 214 | + return PolicyBindingsStubSettings.defaultTransportChannelProvider(); |
| 215 | + } |
| 216 | + |
| 217 | + public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() { |
| 218 | + return PolicyBindingsStubSettings.defaultApiClientHeaderProviderBuilder(); |
| 219 | + } |
| 220 | + |
| 221 | + /** Returns a new gRPC builder for this class. */ |
| 222 | + public static Builder newBuilder() { |
| 223 | + return Builder.createDefault(); |
| 224 | + } |
| 225 | + |
| 226 | + /** Returns a new REST builder for this class. */ |
| 227 | + public static Builder newHttpJsonBuilder() { |
| 228 | + return Builder.createHttpJsonDefault(); |
| 229 | + } |
| 230 | + |
| 231 | + /** Returns a new builder for this class. */ |
| 232 | + public static Builder newBuilder(ClientContext clientContext) { |
| 233 | + return new Builder(clientContext); |
| 234 | + } |
| 235 | + |
| 236 | + /** Returns a builder containing all the values of this settings class. */ |
| 237 | + public Builder toBuilder() { |
| 238 | + return new Builder(this); |
| 239 | + } |
| 240 | + |
| 241 | + protected PolicyBindingsSettings(Builder settingsBuilder) throws IOException { |
| 242 | + super(settingsBuilder); |
| 243 | + } |
| 244 | + |
| 245 | + /** Builder for PolicyBindingsSettings. */ |
| 246 | + public static class Builder extends ClientSettings.Builder<PolicyBindingsSettings, Builder> { |
| 247 | + |
| 248 | + protected Builder() throws IOException { |
| 249 | + this(((ClientContext) null)); |
| 250 | + } |
| 251 | + |
| 252 | + protected Builder(ClientContext clientContext) { |
| 253 | + super(PolicyBindingsStubSettings.newBuilder(clientContext)); |
| 254 | + } |
| 255 | + |
| 256 | + protected Builder(PolicyBindingsSettings settings) { |
| 257 | + super(settings.getStubSettings().toBuilder()); |
| 258 | + } |
| 259 | + |
| 260 | + protected Builder(PolicyBindingsStubSettings.Builder stubSettings) { |
| 261 | + super(stubSettings); |
| 262 | + } |
| 263 | + |
| 264 | + private static Builder createDefault() { |
| 265 | + return new Builder(PolicyBindingsStubSettings.newBuilder()); |
| 266 | + } |
| 267 | + |
| 268 | + private static Builder createHttpJsonDefault() { |
| 269 | + return new Builder(PolicyBindingsStubSettings.newHttpJsonBuilder()); |
| 270 | + } |
| 271 | + |
| 272 | + public PolicyBindingsStubSettings.Builder getStubSettingsBuilder() { |
| 273 | + return ((PolicyBindingsStubSettings.Builder) getStubSettings()); |
| 274 | + } |
| 275 | + |
| 276 | + /** |
| 277 | + * Applies the given settings updater function to all of the unary API methods in this service. |
| 278 | + * |
| 279 | + * <p>Note: This method does not support applying settings to streaming methods. |
| 280 | + */ |
| 281 | + public Builder applyToAllUnaryMethods( |
| 282 | + ApiFunction<UnaryCallSettings.Builder<?, ?>, Void> settingsUpdater) { |
| 283 | + super.applyToAllUnaryMethods( |
| 284 | + getStubSettingsBuilder().unaryMethodSettingsBuilders(), settingsUpdater); |
| 285 | + return this; |
| 286 | + } |
| 287 | + |
| 288 | + /** Returns the builder for the settings used for calls to createPolicyBinding. */ |
| 289 | + public UnaryCallSettings.Builder<CreatePolicyBindingRequest, Operation> |
| 290 | + createPolicyBindingSettings() { |
| 291 | + return getStubSettingsBuilder().createPolicyBindingSettings(); |
| 292 | + } |
| 293 | + |
| 294 | + /** Returns the builder for the settings used for calls to createPolicyBinding. */ |
| 295 | + public OperationCallSettings.Builder< |
| 296 | + CreatePolicyBindingRequest, PolicyBinding, OperationMetadata> |
| 297 | + createPolicyBindingOperationSettings() { |
| 298 | + return getStubSettingsBuilder().createPolicyBindingOperationSettings(); |
| 299 | + } |
| 300 | + |
| 301 | + /** Returns the builder for the settings used for calls to getPolicyBinding. */ |
| 302 | + public UnaryCallSettings.Builder<GetPolicyBindingRequest, PolicyBinding> |
| 303 | + getPolicyBindingSettings() { |
| 304 | + return getStubSettingsBuilder().getPolicyBindingSettings(); |
| 305 | + } |
| 306 | + |
| 307 | + /** Returns the builder for the settings used for calls to updatePolicyBinding. */ |
| 308 | + public UnaryCallSettings.Builder<UpdatePolicyBindingRequest, Operation> |
| 309 | + updatePolicyBindingSettings() { |
| 310 | + return getStubSettingsBuilder().updatePolicyBindingSettings(); |
| 311 | + } |
| 312 | + |
| 313 | + /** Returns the builder for the settings used for calls to updatePolicyBinding. */ |
| 314 | + public OperationCallSettings.Builder< |
| 315 | + UpdatePolicyBindingRequest, PolicyBinding, OperationMetadata> |
| 316 | + updatePolicyBindingOperationSettings() { |
| 317 | + return getStubSettingsBuilder().updatePolicyBindingOperationSettings(); |
| 318 | + } |
| 319 | + |
| 320 | + /** Returns the builder for the settings used for calls to deletePolicyBinding. */ |
| 321 | + public UnaryCallSettings.Builder<DeletePolicyBindingRequest, Operation> |
| 322 | + deletePolicyBindingSettings() { |
| 323 | + return getStubSettingsBuilder().deletePolicyBindingSettings(); |
| 324 | + } |
| 325 | + |
| 326 | + /** Returns the builder for the settings used for calls to deletePolicyBinding. */ |
| 327 | + public OperationCallSettings.Builder<DeletePolicyBindingRequest, Empty, OperationMetadata> |
| 328 | + deletePolicyBindingOperationSettings() { |
| 329 | + return getStubSettingsBuilder().deletePolicyBindingOperationSettings(); |
| 330 | + } |
| 331 | + |
| 332 | + /** Returns the builder for the settings used for calls to listPolicyBindings. */ |
| 333 | + public PagedCallSettings.Builder< |
| 334 | + ListPolicyBindingsRequest, ListPolicyBindingsResponse, ListPolicyBindingsPagedResponse> |
| 335 | + listPolicyBindingsSettings() { |
| 336 | + return getStubSettingsBuilder().listPolicyBindingsSettings(); |
| 337 | + } |
| 338 | + |
| 339 | + /** Returns the builder for the settings used for calls to searchTargetPolicyBindings. */ |
| 340 | + public PagedCallSettings.Builder< |
| 341 | + SearchTargetPolicyBindingsRequest, |
| 342 | + SearchTargetPolicyBindingsResponse, |
| 343 | + SearchTargetPolicyBindingsPagedResponse> |
| 344 | + searchTargetPolicyBindingsSettings() { |
| 345 | + return getStubSettingsBuilder().searchTargetPolicyBindingsSettings(); |
| 346 | + } |
| 347 | + |
| 348 | + @Override |
| 349 | + public PolicyBindingsSettings build() throws IOException { |
| 350 | + return new PolicyBindingsSettings(this); |
| 351 | + } |
| 352 | + } |
| 353 | +} |
0 commit comments