|
| 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.aiplatform.v1; |
| 18 | + |
| 19 | +import static com.google.cloud.aiplatform.v1.MatchServiceClient.ListLocationsPagedResponse; |
| 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.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.aiplatform.v1.stub.MatchServiceStubSettings; |
| 33 | +import com.google.cloud.location.GetLocationRequest; |
| 34 | +import com.google.cloud.location.ListLocationsRequest; |
| 35 | +import com.google.cloud.location.ListLocationsResponse; |
| 36 | +import com.google.cloud.location.Location; |
| 37 | +import com.google.iam.v1.GetIamPolicyRequest; |
| 38 | +import com.google.iam.v1.Policy; |
| 39 | +import com.google.iam.v1.SetIamPolicyRequest; |
| 40 | +import com.google.iam.v1.TestIamPermissionsRequest; |
| 41 | +import com.google.iam.v1.TestIamPermissionsResponse; |
| 42 | +import java.io.IOException; |
| 43 | +import java.util.List; |
| 44 | +import javax.annotation.Generated; |
| 45 | + |
| 46 | +// AUTO-GENERATED DOCUMENTATION AND CLASS. |
| 47 | +/** |
| 48 | + * Settings class to configure an instance of {@link MatchServiceClient}. |
| 49 | + * |
| 50 | + * <p>The default instance has everything set to sensible defaults: |
| 51 | + * |
| 52 | + * <ul> |
| 53 | + * <li>The default service address (aiplatform.googleapis.com) and default port (443) are used. |
| 54 | + * <li>Credentials are acquired automatically through Application Default Credentials. |
| 55 | + * <li>Retries are configured for idempotent methods but not for non-idempotent methods. |
| 56 | + * </ul> |
| 57 | + * |
| 58 | + * <p>The builder of this class is recursive, so contained classes are themselves builders. When |
| 59 | + * build() is called, the tree of builders is called to create the complete settings object. |
| 60 | + * |
| 61 | + * <p>For example, to set the total timeout of findNeighbors to 30 seconds: |
| 62 | + * |
| 63 | + * <pre>{@code |
| 64 | + * // This snippet has been automatically generated and should be regarded as a code template only. |
| 65 | + * // It will require modifications to work: |
| 66 | + * // - It may require correct/in-range values for request initialization. |
| 67 | + * // - It may require specifying regional endpoints when creating the service client as shown in |
| 68 | + * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library |
| 69 | + * MatchServiceSettings.Builder matchServiceSettingsBuilder = MatchServiceSettings.newBuilder(); |
| 70 | + * matchServiceSettingsBuilder |
| 71 | + * .findNeighborsSettings() |
| 72 | + * .setRetrySettings( |
| 73 | + * matchServiceSettingsBuilder |
| 74 | + * .findNeighborsSettings() |
| 75 | + * .getRetrySettings() |
| 76 | + * .toBuilder() |
| 77 | + * .setTotalTimeout(Duration.ofSeconds(30)) |
| 78 | + * .build()); |
| 79 | + * MatchServiceSettings matchServiceSettings = matchServiceSettingsBuilder.build(); |
| 80 | + * }</pre> |
| 81 | + */ |
| 82 | +@Generated("by gapic-generator-java") |
| 83 | +public class MatchServiceSettings extends ClientSettings<MatchServiceSettings> { |
| 84 | + |
| 85 | + /** Returns the object with the settings used for calls to findNeighbors. */ |
| 86 | + public UnaryCallSettings<FindNeighborsRequest, FindNeighborsResponse> findNeighborsSettings() { |
| 87 | + return ((MatchServiceStubSettings) getStubSettings()).findNeighborsSettings(); |
| 88 | + } |
| 89 | + |
| 90 | + /** Returns the object with the settings used for calls to readIndexDatapoints. */ |
| 91 | + public UnaryCallSettings<ReadIndexDatapointsRequest, ReadIndexDatapointsResponse> |
| 92 | + readIndexDatapointsSettings() { |
| 93 | + return ((MatchServiceStubSettings) getStubSettings()).readIndexDatapointsSettings(); |
| 94 | + } |
| 95 | + |
| 96 | + /** Returns the object with the settings used for calls to listLocations. */ |
| 97 | + public PagedCallSettings<ListLocationsRequest, ListLocationsResponse, ListLocationsPagedResponse> |
| 98 | + listLocationsSettings() { |
| 99 | + return ((MatchServiceStubSettings) getStubSettings()).listLocationsSettings(); |
| 100 | + } |
| 101 | + |
| 102 | + /** Returns the object with the settings used for calls to getLocation. */ |
| 103 | + public UnaryCallSettings<GetLocationRequest, Location> getLocationSettings() { |
| 104 | + return ((MatchServiceStubSettings) getStubSettings()).getLocationSettings(); |
| 105 | + } |
| 106 | + |
| 107 | + /** Returns the object with the settings used for calls to setIamPolicy. */ |
| 108 | + public UnaryCallSettings<SetIamPolicyRequest, Policy> setIamPolicySettings() { |
| 109 | + return ((MatchServiceStubSettings) getStubSettings()).setIamPolicySettings(); |
| 110 | + } |
| 111 | + |
| 112 | + /** Returns the object with the settings used for calls to getIamPolicy. */ |
| 113 | + public UnaryCallSettings<GetIamPolicyRequest, Policy> getIamPolicySettings() { |
| 114 | + return ((MatchServiceStubSettings) getStubSettings()).getIamPolicySettings(); |
| 115 | + } |
| 116 | + |
| 117 | + /** Returns the object with the settings used for calls to testIamPermissions. */ |
| 118 | + public UnaryCallSettings<TestIamPermissionsRequest, TestIamPermissionsResponse> |
| 119 | + testIamPermissionsSettings() { |
| 120 | + return ((MatchServiceStubSettings) getStubSettings()).testIamPermissionsSettings(); |
| 121 | + } |
| 122 | + |
| 123 | + public static final MatchServiceSettings create(MatchServiceStubSettings stub) |
| 124 | + throws IOException { |
| 125 | + return new MatchServiceSettings.Builder(stub.toBuilder()).build(); |
| 126 | + } |
| 127 | + |
| 128 | + /** Returns a builder for the default ExecutorProvider for this service. */ |
| 129 | + public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() { |
| 130 | + return MatchServiceStubSettings.defaultExecutorProviderBuilder(); |
| 131 | + } |
| 132 | + |
| 133 | + /** Returns the default service endpoint. */ |
| 134 | + public static String getDefaultEndpoint() { |
| 135 | + return MatchServiceStubSettings.getDefaultEndpoint(); |
| 136 | + } |
| 137 | + |
| 138 | + /** Returns the default service scopes. */ |
| 139 | + public static List<String> getDefaultServiceScopes() { |
| 140 | + return MatchServiceStubSettings.getDefaultServiceScopes(); |
| 141 | + } |
| 142 | + |
| 143 | + /** Returns a builder for the default credentials for this service. */ |
| 144 | + public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() { |
| 145 | + return MatchServiceStubSettings.defaultCredentialsProviderBuilder(); |
| 146 | + } |
| 147 | + |
| 148 | + /** Returns a builder for the default ChannelProvider for this service. */ |
| 149 | + public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() { |
| 150 | + return MatchServiceStubSettings.defaultGrpcTransportProviderBuilder(); |
| 151 | + } |
| 152 | + |
| 153 | + public static TransportChannelProvider defaultTransportChannelProvider() { |
| 154 | + return MatchServiceStubSettings.defaultTransportChannelProvider(); |
| 155 | + } |
| 156 | + |
| 157 | + @BetaApi("The surface for customizing headers is not stable yet and may change in the future.") |
| 158 | + public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() { |
| 159 | + return MatchServiceStubSettings.defaultApiClientHeaderProviderBuilder(); |
| 160 | + } |
| 161 | + |
| 162 | + /** Returns a new builder for this class. */ |
| 163 | + public static Builder newBuilder() { |
| 164 | + return Builder.createDefault(); |
| 165 | + } |
| 166 | + |
| 167 | + /** Returns a new builder for this class. */ |
| 168 | + public static Builder newBuilder(ClientContext clientContext) { |
| 169 | + return new Builder(clientContext); |
| 170 | + } |
| 171 | + |
| 172 | + /** Returns a builder containing all the values of this settings class. */ |
| 173 | + public Builder toBuilder() { |
| 174 | + return new Builder(this); |
| 175 | + } |
| 176 | + |
| 177 | + protected MatchServiceSettings(Builder settingsBuilder) throws IOException { |
| 178 | + super(settingsBuilder); |
| 179 | + } |
| 180 | + |
| 181 | + /** Builder for MatchServiceSettings. */ |
| 182 | + public static class Builder extends ClientSettings.Builder<MatchServiceSettings, Builder> { |
| 183 | + |
| 184 | + protected Builder() throws IOException { |
| 185 | + this(((ClientContext) null)); |
| 186 | + } |
| 187 | + |
| 188 | + protected Builder(ClientContext clientContext) { |
| 189 | + super(MatchServiceStubSettings.newBuilder(clientContext)); |
| 190 | + } |
| 191 | + |
| 192 | + protected Builder(MatchServiceSettings settings) { |
| 193 | + super(settings.getStubSettings().toBuilder()); |
| 194 | + } |
| 195 | + |
| 196 | + protected Builder(MatchServiceStubSettings.Builder stubSettings) { |
| 197 | + super(stubSettings); |
| 198 | + } |
| 199 | + |
| 200 | + private static Builder createDefault() { |
| 201 | + return new Builder(MatchServiceStubSettings.newBuilder()); |
| 202 | + } |
| 203 | + |
| 204 | + public MatchServiceStubSettings.Builder getStubSettingsBuilder() { |
| 205 | + return ((MatchServiceStubSettings.Builder) getStubSettings()); |
| 206 | + } |
| 207 | + |
| 208 | + /** |
| 209 | + * Applies the given settings updater function to all of the unary API methods in this service. |
| 210 | + * |
| 211 | + * <p>Note: This method does not support applying settings to streaming methods. |
| 212 | + */ |
| 213 | + public Builder applyToAllUnaryMethods( |
| 214 | + ApiFunction<UnaryCallSettings.Builder<?, ?>, Void> settingsUpdater) { |
| 215 | + super.applyToAllUnaryMethods( |
| 216 | + getStubSettingsBuilder().unaryMethodSettingsBuilders(), settingsUpdater); |
| 217 | + return this; |
| 218 | + } |
| 219 | + |
| 220 | + /** Returns the builder for the settings used for calls to findNeighbors. */ |
| 221 | + public UnaryCallSettings.Builder<FindNeighborsRequest, FindNeighborsResponse> |
| 222 | + findNeighborsSettings() { |
| 223 | + return getStubSettingsBuilder().findNeighborsSettings(); |
| 224 | + } |
| 225 | + |
| 226 | + /** Returns the builder for the settings used for calls to readIndexDatapoints. */ |
| 227 | + public UnaryCallSettings.Builder<ReadIndexDatapointsRequest, ReadIndexDatapointsResponse> |
| 228 | + readIndexDatapointsSettings() { |
| 229 | + return getStubSettingsBuilder().readIndexDatapointsSettings(); |
| 230 | + } |
| 231 | + |
| 232 | + /** Returns the builder for the settings used for calls to listLocations. */ |
| 233 | + public PagedCallSettings.Builder< |
| 234 | + ListLocationsRequest, ListLocationsResponse, ListLocationsPagedResponse> |
| 235 | + listLocationsSettings() { |
| 236 | + return getStubSettingsBuilder().listLocationsSettings(); |
| 237 | + } |
| 238 | + |
| 239 | + /** Returns the builder for the settings used for calls to getLocation. */ |
| 240 | + public UnaryCallSettings.Builder<GetLocationRequest, Location> getLocationSettings() { |
| 241 | + return getStubSettingsBuilder().getLocationSettings(); |
| 242 | + } |
| 243 | + |
| 244 | + /** Returns the builder for the settings used for calls to setIamPolicy. */ |
| 245 | + public UnaryCallSettings.Builder<SetIamPolicyRequest, Policy> setIamPolicySettings() { |
| 246 | + return getStubSettingsBuilder().setIamPolicySettings(); |
| 247 | + } |
| 248 | + |
| 249 | + /** Returns the builder for the settings used for calls to getIamPolicy. */ |
| 250 | + public UnaryCallSettings.Builder<GetIamPolicyRequest, Policy> getIamPolicySettings() { |
| 251 | + return getStubSettingsBuilder().getIamPolicySettings(); |
| 252 | + } |
| 253 | + |
| 254 | + /** Returns the builder for the settings used for calls to testIamPermissions. */ |
| 255 | + public UnaryCallSettings.Builder<TestIamPermissionsRequest, TestIamPermissionsResponse> |
| 256 | + testIamPermissionsSettings() { |
| 257 | + return getStubSettingsBuilder().testIamPermissionsSettings(); |
| 258 | + } |
| 259 | + |
| 260 | + @Override |
| 261 | + public MatchServiceSettings build() throws IOException { |
| 262 | + return new MatchServiceSettings(this); |
| 263 | + } |
| 264 | + } |
| 265 | +} |
![gcf-owl-bot[bot]](https://avatars.githubusercontent.com/in/99011?v=4&size=40){kind=avatar}
0 commit comments