Skip to content

Commit e46648f

Browse files
authored
feat: Mark getDefaultEndpoint() with @ObsoleteApi (#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

+8
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

+2
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

+2
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

+2
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

+2
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

+2
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

+2
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

+2
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

+2
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

+2
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
}

showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/stub/ComplianceStubSettings.java

+2
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
import com.google.api.core.ApiFunction;
2222
import com.google.api.core.ApiFuture;
2323
import com.google.api.core.BetaApi;
24+
import com.google.api.core.ObsoleteApi;
2425
import com.google.api.gax.core.GaxProperties;
2526
import com.google.api.gax.core.GoogleCredentialsProvider;
2627
import com.google.api.gax.core.InstantiatingExecutorProvider;
@@ -279,6 +280,7 @@ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuild
279280
}
280281

281282
/** Returns the default service endpoint. */
283+
@ObsoleteApi("Use getEndpoint() instead")
282284
public static String getDefaultEndpoint() {
283285
return "localhost:7469";
284286
}

showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/stub/EchoStubSettings.java

+2
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
import com.google.api.core.ApiFunction;
2424
import com.google.api.core.ApiFuture;
2525
import com.google.api.core.BetaApi;
26+
import com.google.api.core.ObsoleteApi;
2627
import com.google.api.gax.core.GaxProperties;
2728
import com.google.api.gax.core.GoogleCredentialsProvider;
2829
import com.google.api.gax.core.InstantiatingExecutorProvider;
@@ -438,6 +439,7 @@ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuild
438439
}
439440

440441
/** Returns the default service endpoint. */
442+
@ObsoleteApi("Use getEndpoint() instead")
441443
public static String getDefaultEndpoint() {
442444
return "localhost:7469";
443445
}

showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/stub/IdentityStubSettings.java

+2
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
import com.google.api.core.ApiFunction;
2323
import com.google.api.core.ApiFuture;
2424
import com.google.api.core.BetaApi;
25+
import com.google.api.core.ObsoleteApi;
2526
import com.google.api.gax.core.GaxProperties;
2627
import com.google.api.gax.core.GoogleCredentialsProvider;
2728
import com.google.api.gax.core.InstantiatingExecutorProvider;
@@ -309,6 +310,7 @@ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuild
309310
}
310311

311312
/** Returns the default service endpoint. */
313+
@ObsoleteApi("Use getEndpoint() instead")
312314
public static String getDefaultEndpoint() {
313315
return "localhost:7469";
314316
}

showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/stub/MessagingStubSettings.java

+2
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
import com.google.api.core.ApiFunction;
2424
import com.google.api.core.ApiFuture;
2525
import com.google.api.core.BetaApi;
26+
import com.google.api.core.ObsoleteApi;
2627
import com.google.api.gax.core.GaxProperties;
2728
import com.google.api.gax.core.GoogleCredentialsProvider;
2829
import com.google.api.gax.core.InstantiatingExecutorProvider;
@@ -451,6 +452,7 @@ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuild
451452
}
452453

453454
/** Returns the default service endpoint. */
455+
@ObsoleteApi("Use getEndpoint() instead")
454456
public static String getDefaultEndpoint() {
455457
return "localhost:7469";
456458
}

showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/stub/SequenceServiceStubSettings.java

+2
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
import com.google.api.core.ApiFunction;
2222
import com.google.api.core.ApiFuture;
2323
import com.google.api.core.BetaApi;
24+
import com.google.api.core.ObsoleteApi;
2425
import com.google.api.gax.core.GaxProperties;
2526
import com.google.api.gax.core.GoogleCredentialsProvider;
2627
import com.google.api.gax.core.InstantiatingExecutorProvider;
@@ -274,6 +275,7 @@ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuild
274275
}
275276

276277
/** Returns the default service endpoint. */
278+
@ObsoleteApi("Use getEndpoint() instead")
277279
public static String getDefaultEndpoint() {
278280
return "localhost:7469";
279281
}

showcase/gapic-showcase/src/main/java/com/google/showcase/v1beta1/stub/TestingStubSettings.java

+2
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
import com.google.api.core.ApiFunction;
2424
import com.google.api.core.ApiFuture;
2525
import com.google.api.core.BetaApi;
26+
import com.google.api.core.ObsoleteApi;
2627
import com.google.api.gax.core.GaxProperties;
2728
import com.google.api.gax.core.GoogleCredentialsProvider;
2829
import com.google.api.gax.core.InstantiatingExecutorProvider;
@@ -391,6 +392,7 @@ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuild
391392
}
392393

393394
/** Returns the default service endpoint. */
395+
@ObsoleteApi("Use getEndpoint() instead")
394396
public static String getDefaultEndpoint() {
395397
return "localhost:7469";
396398
}

test/integration/goldens/apigeeconnect/src/com/google/cloud/apigeeconnect/v1/stub/ConnectionServiceStubSettings.java

+2
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
import com.google.api.core.ApiFunction;
2222
import com.google.api.core.ApiFuture;
2323
import com.google.api.core.BetaApi;
24+
import com.google.api.core.ObsoleteApi;
2425
import com.google.api.gax.core.GaxProperties;
2526
import com.google.api.gax.core.GoogleCredentialsProvider;
2627
import com.google.api.gax.core.InstantiatingExecutorProvider;
@@ -194,6 +195,7 @@ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuild
194195
}
195196

196197
/** Returns the default service endpoint. */
198+
@ObsoleteApi("Use getEndpoint() instead")
197199
public static String getDefaultEndpoint() {
198200
return "apigeeconnect.googleapis.com:443";
199201
}

test/integration/goldens/apigeeconnect/src/com/google/cloud/apigeeconnect/v1/stub/TetherStubSettings.java

+2
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
package com.google.cloud.apigeeconnect.v1.stub;
1818

1919
import com.google.api.core.ApiFunction;
20+
import com.google.api.core.ObsoleteApi;
2021
import com.google.api.gax.core.GaxProperties;
2122
import com.google.api.gax.core.GoogleCredentialsProvider;
2223
import com.google.api.gax.core.InstantiatingExecutorProvider;
@@ -113,6 +114,7 @@ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuild
113114
}
114115

115116
/** Returns the default service endpoint. */
117+
@ObsoleteApi("Use getEndpoint() instead")
116118
public static String getDefaultEndpoint() {
117119
return "apigeeconnect.googleapis.com:443";
118120
}

test/integration/goldens/asset/src/com/google/cloud/asset/v1/stub/AssetServiceStubSettings.java

+2
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
import com.google.api.core.ApiFunction;
2525
import com.google.api.core.ApiFuture;
2626
import com.google.api.core.BetaApi;
27+
import com.google.api.core.ObsoleteApi;
2728
import com.google.api.gax.core.GaxProperties;
2829
import com.google.api.gax.core.GoogleCredentialsProvider;
2930
import com.google.api.gax.core.InstantiatingExecutorProvider;
@@ -583,6 +584,7 @@ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuild
583584
}
584585

585586
/** Returns the default service endpoint. */
587+
@ObsoleteApi("Use getEndpoint() instead")
586588
public static String getDefaultEndpoint() {
587589
return "cloudasset.googleapis.com:443";
588590
}

test/integration/goldens/bigtable/src/com/google/cloud/bigtable/data/v2/stub/BigtableStubSettings.java

+2
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
package com.google.cloud.bigtable.data.v2.stub;
1818

1919
import com.google.api.core.ApiFunction;
20+
import com.google.api.core.ObsoleteApi;
2021
import com.google.api.gax.core.GaxProperties;
2122
import com.google.api.gax.core.GoogleCredentialsProvider;
2223
import com.google.api.gax.core.InstantiatingExecutorProvider;
@@ -177,6 +178,7 @@ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuild
177178
}
178179

179180
/** Returns the default service endpoint. */
181+
@ObsoleteApi("Use getEndpoint() instead")
180182
public static String getDefaultEndpoint() {
181183
return "bigtable.googleapis.com:443";
182184
}

test/integration/goldens/compute/src/com/google/cloud/compute/v1small/stub/AddressesStubSettings.java

+2
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121

2222
import com.google.api.core.ApiFunction;
2323
import com.google.api.core.ApiFuture;
24+
import com.google.api.core.ObsoleteApi;
2425
import com.google.api.gax.core.GaxProperties;
2526
import com.google.api.gax.core.GoogleCredentialsProvider;
2627
import com.google.api.gax.core.InstantiatingExecutorProvider;
@@ -300,6 +301,7 @@ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuild
300301
}
301302

302303
/** Returns the default service endpoint. */
304+
@ObsoleteApi("Use getEndpoint() instead")
303305
public static String getDefaultEndpoint() {
304306
return "compute.googleapis.com:443";
305307
}

test/integration/goldens/compute/src/com/google/cloud/compute/v1small/stub/RegionOperationsStubSettings.java

+2
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
package com.google.cloud.compute.v1small.stub;
1818

1919
import com.google.api.core.ApiFunction;
20+
import com.google.api.core.ObsoleteApi;
2021
import com.google.api.gax.core.GaxProperties;
2122
import com.google.api.gax.core.GoogleCredentialsProvider;
2223
import com.google.api.gax.core.InstantiatingExecutorProvider;
@@ -125,6 +126,7 @@ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuild
125126
}
126127

127128
/** Returns the default service endpoint. */
129+
@ObsoleteApi("Use getEndpoint() instead")
128130
public static String getDefaultEndpoint() {
129131
return "compute.googleapis.com:443";
130132
}

test/integration/goldens/credentials/src/com/google/cloud/iam/credentials/v1/stub/IamCredentialsStubSettings.java

+2
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818

1919
import com.google.api.core.ApiFunction;
2020
import com.google.api.core.BetaApi;
21+
import com.google.api.core.ObsoleteApi;
2122
import com.google.api.gax.core.GaxProperties;
2223
import com.google.api.gax.core.GoogleCredentialsProvider;
2324
import com.google.api.gax.core.InstantiatingExecutorProvider;
@@ -152,6 +153,7 @@ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuild
152153
}
153154

154155
/** Returns the default service endpoint. */
156+
@ObsoleteApi("Use getEndpoint() instead")
155157
public static String getDefaultEndpoint() {
156158
return "iamcredentials.googleapis.com:443";
157159
}

test/integration/goldens/iam/src/com/google/iam/v1/stub/IAMPolicyStubSettings.java

+2
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
package com.google.iam.v1.stub;
1818

1919
import com.google.api.core.ApiFunction;
20+
import com.google.api.core.ObsoleteApi;
2021
import com.google.api.gax.core.GaxProperties;
2122
import com.google.api.gax.core.GoogleCredentialsProvider;
2223
import com.google.api.gax.core.InstantiatingExecutorProvider;
@@ -130,6 +131,7 @@ public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuild
130131
}
131132

132133
/** Returns the default service endpoint. */
134+
@ObsoleteApi("Use getEndpoint() instead")
133135
public static String getDefaultEndpoint() {
134136
return "iam-meta-api.googleapis.com:443";
135137
}

0 commit comments

Comments
 (0)