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