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.dialogflow.cx.v3; 18 19 import static com.google.cloud.dialogflow.cx.v3.PagesClient.ListLocationsPagedResponse; 20 import static com.google.cloud.dialogflow.cx.v3.PagesClient.ListPagesPagedResponse; 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.dialogflow.cx.v3.stub.PagesStubSettings; 35 import com.google.cloud.location.GetLocationRequest; 36 import com.google.cloud.location.ListLocationsRequest; 37 import com.google.cloud.location.ListLocationsResponse; 38 import com.google.cloud.location.Location; 39 import com.google.protobuf.Empty; 40 import java.io.IOException; 41 import java.util.List; 42 import javax.annotation.Generated; 43 44 // AUTO-GENERATED DOCUMENTATION AND CLASS. 45 /** 46 * Settings class to configure an instance of {@link PagesClient}. 47 * 48 * <p>The default instance has everything set to sensible defaults: 49 * 50 * <ul> 51 * <li>The default service address (dialogflow.googleapis.com) and default port (443) are used. 52 * <li>Credentials are acquired automatically through Application Default Credentials. 53 * <li>Retries are configured for idempotent methods but not for non-idempotent methods. 54 * </ul> 55 * 56 * <p>The builder of this class is recursive, so contained classes are themselves builders. When 57 * build() is called, the tree of builders is called to create the complete settings object. 58 * 59 * <p>For example, to set the total timeout of getPage to 30 seconds: 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 * PagesSettings.Builder pagesSettingsBuilder = PagesSettings.newBuilder(); 68 * pagesSettingsBuilder 69 * .getPageSettings() 70 * .setRetrySettings( 71 * pagesSettingsBuilder 72 * .getPageSettings() 73 * .getRetrySettings() 74 * .toBuilder() 75 * .setTotalTimeout(Duration.ofSeconds(30)) 76 * .build()); 77 * PagesSettings pagesSettings = pagesSettingsBuilder.build(); 78 * }</pre> 79 */ 80 @Generated("by gapic-generator-java") 81 public class PagesSettings extends ClientSettings<PagesSettings> { 82 83 /** Returns the object with the settings used for calls to listPages. */ 84 public PagedCallSettings<ListPagesRequest, ListPagesResponse, ListPagesPagedResponse> listPagesSettings()85 listPagesSettings() { 86 return ((PagesStubSettings) getStubSettings()).listPagesSettings(); 87 } 88 89 /** Returns the object with the settings used for calls to getPage. */ getPageSettings()90 public UnaryCallSettings<GetPageRequest, Page> getPageSettings() { 91 return ((PagesStubSettings) getStubSettings()).getPageSettings(); 92 } 93 94 /** Returns the object with the settings used for calls to createPage. */ createPageSettings()95 public UnaryCallSettings<CreatePageRequest, Page> createPageSettings() { 96 return ((PagesStubSettings) getStubSettings()).createPageSettings(); 97 } 98 99 /** Returns the object with the settings used for calls to updatePage. */ updatePageSettings()100 public UnaryCallSettings<UpdatePageRequest, Page> updatePageSettings() { 101 return ((PagesStubSettings) getStubSettings()).updatePageSettings(); 102 } 103 104 /** Returns the object with the settings used for calls to deletePage. */ deletePageSettings()105 public UnaryCallSettings<DeletePageRequest, Empty> deletePageSettings() { 106 return ((PagesStubSettings) getStubSettings()).deletePageSettings(); 107 } 108 109 /** Returns the object with the settings used for calls to listLocations. */ 110 public PagedCallSettings<ListLocationsRequest, ListLocationsResponse, ListLocationsPagedResponse> listLocationsSettings()111 listLocationsSettings() { 112 return ((PagesStubSettings) getStubSettings()).listLocationsSettings(); 113 } 114 115 /** Returns the object with the settings used for calls to getLocation. */ getLocationSettings()116 public UnaryCallSettings<GetLocationRequest, Location> getLocationSettings() { 117 return ((PagesStubSettings) getStubSettings()).getLocationSettings(); 118 } 119 create(PagesStubSettings stub)120 public static final PagesSettings create(PagesStubSettings stub) throws IOException { 121 return new PagesSettings.Builder(stub.toBuilder()).build(); 122 } 123 124 /** Returns a builder for the default ExecutorProvider for this service. */ defaultExecutorProviderBuilder()125 public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { 126 return PagesStubSettings.defaultExecutorProviderBuilder(); 127 } 128 129 /** Returns the default service endpoint. */ getDefaultEndpoint()130 public static String getDefaultEndpoint() { 131 return PagesStubSettings.getDefaultEndpoint(); 132 } 133 134 /** Returns the default service scopes. */ getDefaultServiceScopes()135 public static List<String> getDefaultServiceScopes() { 136 return PagesStubSettings.getDefaultServiceScopes(); 137 } 138 139 /** Returns a builder for the default credentials for this service. */ defaultCredentialsProviderBuilder()140 public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() { 141 return PagesStubSettings.defaultCredentialsProviderBuilder(); 142 } 143 144 /** Returns a builder for the default gRPC ChannelProvider for this service. */ defaultGrpcTransportProviderBuilder()145 public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() { 146 return PagesStubSettings.defaultGrpcTransportProviderBuilder(); 147 } 148 149 /** Returns a builder for the default REST ChannelProvider for this service. */ 150 @BetaApi 151 public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()152 defaultHttpJsonTransportProviderBuilder() { 153 return PagesStubSettings.defaultHttpJsonTransportProviderBuilder(); 154 } 155 defaultTransportChannelProvider()156 public static TransportChannelProvider defaultTransportChannelProvider() { 157 return PagesStubSettings.defaultTransportChannelProvider(); 158 } 159 160 @BetaApi("The surface for customizing headers is not stable yet and may change in the future.") defaultApiClientHeaderProviderBuilder()161 public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() { 162 return PagesStubSettings.defaultApiClientHeaderProviderBuilder(); 163 } 164 165 /** Returns a new gRPC builder for this class. */ newBuilder()166 public static Builder newBuilder() { 167 return Builder.createDefault(); 168 } 169 170 /** Returns a new REST builder for this class. */ 171 @BetaApi newHttpJsonBuilder()172 public static Builder newHttpJsonBuilder() { 173 return Builder.createHttpJsonDefault(); 174 } 175 176 /** Returns a new builder for this class. */ newBuilder(ClientContext clientContext)177 public static Builder newBuilder(ClientContext clientContext) { 178 return new Builder(clientContext); 179 } 180 181 /** Returns a builder containing all the values of this settings class. */ toBuilder()182 public Builder toBuilder() { 183 return new Builder(this); 184 } 185 PagesSettings(Builder settingsBuilder)186 protected PagesSettings(Builder settingsBuilder) throws IOException { 187 super(settingsBuilder); 188 } 189 190 /** Builder for PagesSettings. */ 191 public static class Builder extends ClientSettings.Builder<PagesSettings, Builder> { 192 Builder()193 protected Builder() throws IOException { 194 this(((ClientContext) null)); 195 } 196 Builder(ClientContext clientContext)197 protected Builder(ClientContext clientContext) { 198 super(PagesStubSettings.newBuilder(clientContext)); 199 } 200 Builder(PagesSettings settings)201 protected Builder(PagesSettings settings) { 202 super(settings.getStubSettings().toBuilder()); 203 } 204 Builder(PagesStubSettings.Builder stubSettings)205 protected Builder(PagesStubSettings.Builder stubSettings) { 206 super(stubSettings); 207 } 208 createDefault()209 private static Builder createDefault() { 210 return new Builder(PagesStubSettings.newBuilder()); 211 } 212 213 @BetaApi createHttpJsonDefault()214 private static Builder createHttpJsonDefault() { 215 return new Builder(PagesStubSettings.newHttpJsonBuilder()); 216 } 217 getStubSettingsBuilder()218 public PagesStubSettings.Builder getStubSettingsBuilder() { 219 return ((PagesStubSettings.Builder) getStubSettings()); 220 } 221 222 /** 223 * Applies the given settings updater function to all of the unary API methods in this service. 224 * 225 * <p>Note: This method does not support applying settings to streaming methods. 226 */ applyToAllUnaryMethods( ApiFunction<UnaryCallSettings.Builder<?, ?>, Void> settingsUpdater)227 public Builder applyToAllUnaryMethods( 228 ApiFunction<UnaryCallSettings.Builder<?, ?>, Void> settingsUpdater) { 229 super.applyToAllUnaryMethods( 230 getStubSettingsBuilder().unaryMethodSettingsBuilders(), settingsUpdater); 231 return this; 232 } 233 234 /** Returns the builder for the settings used for calls to listPages. */ 235 public PagedCallSettings.Builder<ListPagesRequest, ListPagesResponse, ListPagesPagedResponse> listPagesSettings()236 listPagesSettings() { 237 return getStubSettingsBuilder().listPagesSettings(); 238 } 239 240 /** Returns the builder for the settings used for calls to getPage. */ getPageSettings()241 public UnaryCallSettings.Builder<GetPageRequest, Page> getPageSettings() { 242 return getStubSettingsBuilder().getPageSettings(); 243 } 244 245 /** Returns the builder for the settings used for calls to createPage. */ createPageSettings()246 public UnaryCallSettings.Builder<CreatePageRequest, Page> createPageSettings() { 247 return getStubSettingsBuilder().createPageSettings(); 248 } 249 250 /** Returns the builder for the settings used for calls to updatePage. */ updatePageSettings()251 public UnaryCallSettings.Builder<UpdatePageRequest, Page> updatePageSettings() { 252 return getStubSettingsBuilder().updatePageSettings(); 253 } 254 255 /** Returns the builder for the settings used for calls to deletePage. */ deletePageSettings()256 public UnaryCallSettings.Builder<DeletePageRequest, Empty> deletePageSettings() { 257 return getStubSettingsBuilder().deletePageSettings(); 258 } 259 260 /** Returns the builder for the settings used for calls to listLocations. */ 261 public PagedCallSettings.Builder< 262 ListLocationsRequest, ListLocationsResponse, ListLocationsPagedResponse> listLocationsSettings()263 listLocationsSettings() { 264 return getStubSettingsBuilder().listLocationsSettings(); 265 } 266 267 /** Returns the builder for the settings used for calls to getLocation. */ getLocationSettings()268 public UnaryCallSettings.Builder<GetLocationRequest, Location> getLocationSettings() { 269 return getStubSettingsBuilder().getLocationSettings(); 270 } 271 272 @Override build()273 public PagesSettings build() throws IOException { 274 return new PagesSettings(this); 275 } 276 } 277 } 278