Skip to content

Commit e46648f

Browse files
authored
feat: Mark getDefaultEndpoint() with @ObsoleteApi (googleapis#2347)
Client libraries no longer always use the default endpoint. The resolved endpoint will be determined by the EndpointContext and used by the client.
1 parent 98b5bd7 commit e46648f

File tree

34 files changed

+74
-0
lines changed

34 files changed

+74
-0
lines changed

gapic-generator-java/src/main/java/com/google/api/generator/gapic/composer/common/AbstractServiceStubSettingsClassComposer.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
import com.google.api.core.ApiFunction;
1919
import com.google.api.core.ApiFuture;
2020
import com.google.api.core.BetaApi;
21+
import com.google.api.core.ObsoleteApi;
2122
import com.google.api.gax.batching.BatchingSettings;
2223
import com.google.api.gax.batching.FlowControlSettings;
2324
import com.google.api.gax.batching.FlowController.LimitExceededBehavior;
@@ -1190,6 +1191,12 @@ private List<MethodDefinition> createDefaultHelperAndGetterMethods(
11901191
.setReturnType(returnType)
11911192
.setName("getDefaultEndpoint")
11921193
.setReturnExpr(ValueExpr.withValue(StringObjectValue.withValue(service.defaultHost())))
1194+
.setAnnotations(
1195+
ImmutableList.of(
1196+
AnnotationNode.builder()
1197+
.setType(FIXED_TYPESTORE.get(ObsoleteApi.class.getSimpleName()))
1198+
.setDescription("Use getEndpoint() instead")
1199+
.build()))
11931200
.build());
11941201

11951202
// Create the getDefaultMtlsEndpoint method.
@@ -2068,6 +2075,7 @@ private static TypeStore createStaticTypes() {
20682075
List.class,
20692076
Lists.class,
20702077
MonitoredResourceDescriptor.class,
2078+
ObsoleteApi.class,
20712079
Operation.class,
20722080
OperationCallSettings.class,
20732081
OperationSnapshot.class,

gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/ApiVersionTestingStubSettings.golden

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
package com.google.api.version.test.stub;
22

33
import com.google.api.core.ApiFunction;
4+
import com.google.api.core.ObsoleteApi;
45
import com.google.api.gax.core.GaxProperties;
56
import com.google.api.gax.core.GoogleCredentialsProvider;
67
import com.google.api.gax.core.InstantiatingExecutorProvider;
@@ -91,6 +92,7 @@ public class EchoWithVersionStubSettings extends StubSettings<EchoWithVersionStu
9192
}
9293

9394
/** Returns the default service endpoint. */
95+
@ObsoleteApi("Use getEndpoint() instead")
9496
public static String getDefaultEndpoint() {
9597
return "localhost:7469";
9698
}

gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/DeprecatedServiceStubSettings.golden

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
package com.google.testdata.v1.stub;
22

33
import com.google.api.core.ApiFunction;
4+
import com.google.api.core.ObsoleteApi;
45
import com.google.api.gax.core.GaxProperties;
56
import com.google.api.gax.core.GoogleCredentialsProvider;
67
import com.google.api.gax.core.InstantiatingExecutorProvider;
@@ -107,6 +108,7 @@ public class DeprecatedServiceStubSettings extends StubSettings<DeprecatedServic
107108
}
108109

109110
/** Returns the default service endpoint. */
111+
@ObsoleteApi("Use getEndpoint() instead")
110112
public static String getDefaultEndpoint() {
111113
return "localhost:7469";
112114
}

gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/EchoStubSettings.golden

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import static com.google.showcase.v1beta1.EchoClient.SimplePagedExpandPagedRespo
66
import com.google.api.core.ApiFunction;
77
import com.google.api.core.ApiFuture;
88
import com.google.api.core.BetaApi;
9+
import com.google.api.core.ObsoleteApi;
910
import com.google.api.gax.core.GaxProperties;
1011
import com.google.api.gax.core.GoogleCredentialsProvider;
1112
import com.google.api.gax.core.InstantiatingExecutorProvider;
@@ -291,6 +292,7 @@ public class EchoStubSettings extends StubSettings<EchoStubSettings> {
291292
}
292293

293294
/** Returns the default service endpoint. */
295+
@ObsoleteApi("Use getEndpoint() instead")
294296
public static String getDefaultEndpoint() {
295297
return "localhost:7469";
296298
}

gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/LoggingServiceV2StubSettings.golden

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ import static com.google.logging.v2.LoggingServiceV2Client.ListMonitoredResource
77
import com.google.api.MonitoredResourceDescriptor;
88
import com.google.api.core.ApiFunction;
99
import com.google.api.core.ApiFuture;
10+
import com.google.api.core.ObsoleteApi;
1011
import com.google.api.gax.batching.BatchingSettings;
1112
import com.google.api.gax.batching.FlowControlSettings;
1213
import com.google.api.gax.batching.FlowController;
@@ -433,6 +434,7 @@ public class LoggingServiceV2StubSettings extends StubSettings<LoggingServiceV2S
433434
}
434435

435436
/** Returns the default service endpoint. */
437+
@ObsoleteApi("Use getEndpoint() instead")
436438
public static String getDefaultEndpoint() {
437439
return "logging.googleapis.com:443";
438440
}

gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/PublisherStubSettings.golden

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import static com.google.pubsub.v1.PublisherClient.ListTopicsPagedResponse;
66

77
import com.google.api.core.ApiFunction;
88
import com.google.api.core.ApiFuture;
9+
import com.google.api.core.ObsoleteApi;
910
import com.google.api.gax.batching.BatchingSettings;
1011
import com.google.api.gax.batching.FlowControlSettings;
1112
import com.google.api.gax.batching.FlowController;
@@ -442,6 +443,7 @@ public class PublisherStubSettings extends StubSettings<PublisherStubSettings> {
442443
}
443444

444445
/** Returns the default service endpoint. */
446+
@ObsoleteApi("Use getEndpoint() instead")
445447
public static String getDefaultEndpoint() {
446448
return "pubsub.googleapis.com:443";
447449
}

gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpcrest/goldens/EchoStubSettings.golden

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import static com.google.showcase.grpcrest.v1beta1.EchoClient.SimplePagedExpandP
66
import com.google.api.core.ApiFunction;
77
import com.google.api.core.ApiFuture;
88
import com.google.api.core.BetaApi;
9+
import com.google.api.core.ObsoleteApi;
910
import com.google.api.gax.core.GaxProperties;
1011
import com.google.api.gax.core.GoogleCredentialsProvider;
1112
import com.google.api.gax.core.InstantiatingExecutorProvider;
@@ -307,6 +308,7 @@ public class EchoStubSettings extends StubSettings<EchoStubSettings> {
307308
}
308309

309310
/** Returns the default service endpoint. */
311+
@ObsoleteApi("Use getEndpoint() instead")
310312
public static String getDefaultEndpoint() {
311313
return "localhost:7469";
312314
}

gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpcrest/goldens/WickedStubSettings.golden

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ package com.google.showcase.v1beta1.stub;
22

33
import com.google.api.core.ApiFunction;
44
import com.google.api.core.BetaApi;
5+
import com.google.api.core.ObsoleteApi;
56
import com.google.api.gax.core.GaxProperties;
67
import com.google.api.gax.core.GoogleCredentialsProvider;
78
import com.google.api.gax.core.InstantiatingExecutorProvider;
@@ -105,6 +106,7 @@ public class WickedStubSettings extends StubSettings<WickedStubSettings> {
105106
}
106107

107108
/** Returns the default service endpoint. */
109+
@ObsoleteApi("Use getEndpoint() instead")
108110
public static String getDefaultEndpoint() {
109111
return "localhost:7469";
110112
}

gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/rest/goldens/ComplianceStubSettings.golden

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ package com.google.showcase.v1beta1.stub;
22

33
import com.google.api.core.ApiFunction;
44
import com.google.api.core.BetaApi;
5+
import com.google.api.core.ObsoleteApi;
56
import com.google.api.gax.core.GaxProperties;
67
import com.google.api.gax.core.GoogleCredentialsProvider;
78
import com.google.api.gax.core.InstantiatingExecutorProvider;
@@ -137,6 +138,7 @@ public class ComplianceStubSettings extends StubSettings<ComplianceStubSettings>
137138
}
138139

139140
/** Returns the default service endpoint. */
141+
@ObsoleteApi("Use getEndpoint() instead")
140142
public static String getDefaultEndpoint() {
141143
return "localhost:7469";
142144
}

gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/rest/goldens/HttpJsonApiVersionTestingStubSettings.golden

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
package com.google.api.version.test.stub;
22

33
import com.google.api.core.ApiFunction;
4+
import com.google.api.core.ObsoleteApi;
45
import com.google.api.gax.core.GaxProperties;
56
import com.google.api.gax.core.GoogleCredentialsProvider;
67
import com.google.api.gax.core.InstantiatingExecutorProvider;
@@ -91,6 +92,7 @@ public class EchoWithVersionStubSettings extends StubSettings<EchoWithVersionStu
9192
}
9293

9394
/** Returns the default service endpoint. */
95+
@ObsoleteApi("Use getEndpoint() instead")
9496
public static String getDefaultEndpoint() {
9597
return "localhost:7469";
9698
}

0 commit comments

Comments
 (0)