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.trace.v1; 18 19 import static com.google.cloud.trace.v1.TraceServiceClient.ListTracesPagedResponse; 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.httpjson.InstantiatingHttpJsonChannelProvider; 27 import com.google.api.gax.rpc.ApiClientHeaderProvider; 28 import com.google.api.gax.rpc.ClientContext; 29 import com.google.api.gax.rpc.ClientSettings; 30 import com.google.api.gax.rpc.PagedCallSettings; 31 import com.google.api.gax.rpc.TransportChannelProvider; 32 import com.google.api.gax.rpc.UnaryCallSettings; 33 import com.google.cloud.trace.v1.stub.TraceServiceStubSettings; 34 import com.google.devtools.cloudtrace.v1.GetTraceRequest; 35 import com.google.devtools.cloudtrace.v1.ListTracesRequest; 36 import com.google.devtools.cloudtrace.v1.ListTracesResponse; 37 import com.google.devtools.cloudtrace.v1.PatchTracesRequest; 38 import com.google.devtools.cloudtrace.v1.Trace; 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 TraceServiceClient}. 47 * 48 * <p>The default instance has everything set to sensible defaults: 49 * 50 * <ul> 51 * <li>The default service address (cloudtrace.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 getTrace 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 * TraceServiceSettings.Builder traceServiceSettingsBuilder = TraceServiceSettings.newBuilder(); 68 * traceServiceSettingsBuilder 69 * .getTraceSettings() 70 * .setRetrySettings( 71 * traceServiceSettingsBuilder 72 * .getTraceSettings() 73 * .getRetrySettings() 74 * .toBuilder() 75 * .setTotalTimeout(Duration.ofSeconds(30)) 76 * .build()); 77 * TraceServiceSettings traceServiceSettings = traceServiceSettingsBuilder.build(); 78 * }</pre> 79 */ 80 @Generated("by gapic-generator-java") 81 public class TraceServiceSettings extends ClientSettings<TraceServiceSettings> { 82 83 /** Returns the object with the settings used for calls to listTraces. */ 84 public PagedCallSettings<ListTracesRequest, ListTracesResponse, ListTracesPagedResponse> listTracesSettings()85 listTracesSettings() { 86 return ((TraceServiceStubSettings) getStubSettings()).listTracesSettings(); 87 } 88 89 /** Returns the object with the settings used for calls to getTrace. */ getTraceSettings()90 public UnaryCallSettings<GetTraceRequest, Trace> getTraceSettings() { 91 return ((TraceServiceStubSettings) getStubSettings()).getTraceSettings(); 92 } 93 94 /** Returns the object with the settings used for calls to patchTraces. */ patchTracesSettings()95 public UnaryCallSettings<PatchTracesRequest, Empty> patchTracesSettings() { 96 return ((TraceServiceStubSettings) getStubSettings()).patchTracesSettings(); 97 } 98 create(TraceServiceStubSettings stub)99 public static final TraceServiceSettings create(TraceServiceStubSettings stub) 100 throws IOException { 101 return new TraceServiceSettings.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 TraceServiceStubSettings.defaultExecutorProviderBuilder(); 107 } 108 109 /** Returns the default service endpoint. */ getDefaultEndpoint()110 public static String getDefaultEndpoint() { 111 return TraceServiceStubSettings.getDefaultEndpoint(); 112 } 113 114 /** Returns the default service scopes. */ getDefaultServiceScopes()115 public static List<String> getDefaultServiceScopes() { 116 return TraceServiceStubSettings.getDefaultServiceScopes(); 117 } 118 119 /** Returns a builder for the default credentials for this service. */ defaultCredentialsProviderBuilder()120 public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() { 121 return TraceServiceStubSettings.defaultCredentialsProviderBuilder(); 122 } 123 124 /** Returns a builder for the default gRPC ChannelProvider for this service. */ defaultGrpcTransportProviderBuilder()125 public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() { 126 return TraceServiceStubSettings.defaultGrpcTransportProviderBuilder(); 127 } 128 129 /** Returns a builder for the default REST ChannelProvider for this service. */ 130 @BetaApi 131 public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()132 defaultHttpJsonTransportProviderBuilder() { 133 return TraceServiceStubSettings.defaultHttpJsonTransportProviderBuilder(); 134 } 135 defaultTransportChannelProvider()136 public static TransportChannelProvider defaultTransportChannelProvider() { 137 return TraceServiceStubSettings.defaultTransportChannelProvider(); 138 } 139 140 @BetaApi("The surface for customizing headers is not stable yet and may change in the future.") defaultApiClientHeaderProviderBuilder()141 public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() { 142 return TraceServiceStubSettings.defaultApiClientHeaderProviderBuilder(); 143 } 144 145 /** Returns a new gRPC builder for this class. */ newBuilder()146 public static Builder newBuilder() { 147 return Builder.createDefault(); 148 } 149 150 /** Returns a new REST builder for this class. */ 151 @BetaApi newHttpJsonBuilder()152 public static Builder newHttpJsonBuilder() { 153 return Builder.createHttpJsonDefault(); 154 } 155 156 /** Returns a new builder for this class. */ newBuilder(ClientContext clientContext)157 public static Builder newBuilder(ClientContext clientContext) { 158 return new Builder(clientContext); 159 } 160 161 /** Returns a builder containing all the values of this settings class. */ toBuilder()162 public Builder toBuilder() { 163 return new Builder(this); 164 } 165 TraceServiceSettings(Builder settingsBuilder)166 protected TraceServiceSettings(Builder settingsBuilder) throws IOException { 167 super(settingsBuilder); 168 } 169 170 /** Builder for TraceServiceSettings. */ 171 public static class Builder extends ClientSettings.Builder<TraceServiceSettings, Builder> { 172 Builder()173 protected Builder() throws IOException { 174 this(((ClientContext) null)); 175 } 176 Builder(ClientContext clientContext)177 protected Builder(ClientContext clientContext) { 178 super(TraceServiceStubSettings.newBuilder(clientContext)); 179 } 180 Builder(TraceServiceSettings settings)181 protected Builder(TraceServiceSettings settings) { 182 super(settings.getStubSettings().toBuilder()); 183 } 184 Builder(TraceServiceStubSettings.Builder stubSettings)185 protected Builder(TraceServiceStubSettings.Builder stubSettings) { 186 super(stubSettings); 187 } 188 createDefault()189 private static Builder createDefault() { 190 return new Builder(TraceServiceStubSettings.newBuilder()); 191 } 192 193 @BetaApi createHttpJsonDefault()194 private static Builder createHttpJsonDefault() { 195 return new Builder(TraceServiceStubSettings.newHttpJsonBuilder()); 196 } 197 getStubSettingsBuilder()198 public TraceServiceStubSettings.Builder getStubSettingsBuilder() { 199 return ((TraceServiceStubSettings.Builder) getStubSettings()); 200 } 201 202 /** 203 * Applies the given settings updater function to all of the unary API methods in this service. 204 * 205 * <p>Note: This method does not support applying settings to streaming methods. 206 */ applyToAllUnaryMethods( ApiFunction<UnaryCallSettings.Builder<?, ?>, Void> settingsUpdater)207 public Builder applyToAllUnaryMethods( 208 ApiFunction<UnaryCallSettings.Builder<?, ?>, Void> settingsUpdater) { 209 super.applyToAllUnaryMethods( 210 getStubSettingsBuilder().unaryMethodSettingsBuilders(), settingsUpdater); 211 return this; 212 } 213 214 /** Returns the builder for the settings used for calls to listTraces. */ 215 public PagedCallSettings.Builder<ListTracesRequest, ListTracesResponse, ListTracesPagedResponse> listTracesSettings()216 listTracesSettings() { 217 return getStubSettingsBuilder().listTracesSettings(); 218 } 219 220 /** Returns the builder for the settings used for calls to getTrace. */ getTraceSettings()221 public UnaryCallSettings.Builder<GetTraceRequest, Trace> getTraceSettings() { 222 return getStubSettingsBuilder().getTraceSettings(); 223 } 224 225 /** Returns the builder for the settings used for calls to patchTraces. */ patchTracesSettings()226 public UnaryCallSettings.Builder<PatchTracesRequest, Empty> patchTracesSettings() { 227 return getStubSettingsBuilder().patchTracesSettings(); 228 } 229 230 @Override build()231 public TraceServiceSettings build() throws IOException { 232 return new TraceServiceSettings(this); 233 } 234 } 235 } 236