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