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