From 9ea02531a710b72a646d73acc71315e505f3fc06 Mon Sep 17 00:00:00 2001 From: Lawrence Qiu Date: Thu, 11 Jul 2024 17:38:16 -0400 Subject: [PATCH 1/2] feat: Mark getDefaultEndpoint() with @ObsoleteApi --- .../common/AbstractServiceStubSettingsClassComposer.java | 9 +++++++++ .../grpc/goldens/ApiVersionTestingStubSettings.golden | 3 +++ .../grpc/goldens/DeprecatedServiceStubSettings.golden | 3 +++ .../gapic/composer/grpc/goldens/EchoStubSettings.golden | 3 +++ .../grpc/goldens/LoggingServiceV2StubSettings.golden | 3 +++ .../composer/grpc/goldens/PublisherStubSettings.golden | 3 +++ .../composer/grpcrest/goldens/EchoStubSettings.golden | 3 +++ .../composer/grpcrest/goldens/WickedStubSettings.golden | 3 +++ .../composer/rest/goldens/ComplianceStubSettings.golden | 3 +++ .../goldens/HttpJsonApiVersionTestingStubSettings.golden | 3 +++ .../showcase/v1beta1/stub/ComplianceStubSettings.java | 3 +++ .../google/showcase/v1beta1/stub/EchoStubSettings.java | 3 +++ .../showcase/v1beta1/stub/IdentityStubSettings.java | 3 +++ .../showcase/v1beta1/stub/MessagingStubSettings.java | 3 +++ .../v1beta1/stub/SequenceServiceStubSettings.java | 3 +++ .../showcase/v1beta1/stub/TestingStubSettings.java | 3 +++ .../v1/stub/ConnectionServiceStubSettings.java | 3 +++ .../cloud/apigeeconnect/v1/stub/TetherStubSettings.java | 3 +++ .../cloud/asset/v1/stub/AssetServiceStubSettings.java | 3 +++ .../bigtable/data/v2/stub/BigtableStubSettings.java | 3 +++ .../compute/v1small/stub/AddressesStubSettings.java | 3 +++ .../v1small/stub/RegionOperationsStubSettings.java | 3 +++ .../credentials/v1/stub/IamCredentialsStubSettings.java | 3 +++ .../com/google/iam/v1/stub/IAMPolicyStubSettings.java | 3 +++ .../kms/v1/stub/KeyManagementServiceStubSettings.java | 3 +++ .../library/v1/stub/LibraryServiceStubSettings.java | 3 +++ .../logging/v2/stub/ConfigServiceV2StubSettings.java | 3 +++ .../logging/v2/stub/LoggingServiceV2StubSettings.java | 3 +++ .../logging/v2/stub/MetricsServiceV2StubSettings.java | 3 +++ .../cloud/pubsub/v1/stub/PublisherStubSettings.java | 3 +++ .../cloud/pubsub/v1/stub/SchemaServiceStubSettings.java | 3 +++ .../cloud/pubsub/v1/stub/SubscriberStubSettings.java | 3 +++ .../cloud/redis/v1beta1/stub/CloudRedisStubSettings.java | 3 +++ .../com/google/storage/v2/stub/StorageStubSettings.java | 3 +++ 34 files changed, 108 insertions(+) diff --git a/gapic-generator-java/src/main/java/com/google/api/generator/gapic/composer/common/AbstractServiceStubSettingsClassComposer.java b/gapic-generator-java/src/main/java/com/google/api/generator/gapic/composer/common/AbstractServiceStubSettingsClassComposer.java index c13bc5f3f1..cd30aaf694 100644 --- a/gapic-generator-java/src/main/java/com/google/api/generator/gapic/composer/common/AbstractServiceStubSettingsClassComposer.java +++ b/gapic-generator-java/src/main/java/com/google/api/generator/gapic/composer/common/AbstractServiceStubSettingsClassComposer.java @@ -18,6 +18,7 @@ import com.google.api.core.ApiFunction; import com.google.api.core.ApiFuture; import com.google.api.core.BetaApi; +import com.google.api.core.ObsoleteApi; import com.google.api.gax.batching.BatchingSettings; import com.google.api.gax.batching.FlowControlSettings; import com.google.api.gax.batching.FlowController.LimitExceededBehavior; @@ -1190,6 +1191,13 @@ private List createDefaultHelperAndGetterMethods( .setReturnType(returnType) .setName("getDefaultEndpoint") .setReturnExpr(ValueExpr.withValue(StringObjectValue.withValue(service.defaultHost()))) + .setAnnotations( + ImmutableList.of( + AnnotationNode.builder() + .setType(FIXED_TYPESTORE.get(ObsoleteApi.class.getSimpleName())) + .setDescription( + "See https://github.com/googleapis/sdk-platform-java/issues/2346 for more information") + .build())) .build()); // Create the getDefaultMtlsEndpoint method. @@ -2068,6 +2076,7 @@ private static TypeStore createStaticTypes() { List.class, Lists.class, MonitoredResourceDescriptor.class, + ObsoleteApi.class, Operation.class, OperationCallSettings.class, OperationSnapshot.class, diff --git a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/ApiVersionTestingStubSettings.golden b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/ApiVersionTestingStubSettings.golden index c67187cf5e..7727609675 100644 --- a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/ApiVersionTestingStubSettings.golden +++ b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/ApiVersionTestingStubSettings.golden @@ -1,6 +1,7 @@ package com.google.api.version.test.stub; import com.google.api.core.ApiFunction; +import com.google.api.core.ObsoleteApi; import com.google.api.gax.core.GaxProperties; import com.google.api.gax.core.GoogleCredentialsProvider; import com.google.api.gax.core.InstantiatingExecutorProvider; @@ -91,6 +92,8 @@ public class EchoWithVersionStubSettings extends StubSettings { } /** Returns the default service endpoint. */ + @ObsoleteApi( + "See https://github.com/googleapis/sdk-platform-java/issues/2346 for more information") public static String getDefaultEndpoint() { return "localhost:7469"; } diff --git a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/LoggingServiceV2StubSettings.golden b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/LoggingServiceV2StubSettings.golden index 264f6da6ff..ca27444037 100644 --- a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/LoggingServiceV2StubSettings.golden +++ b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/LoggingServiceV2StubSettings.golden @@ -7,6 +7,7 @@ import static com.google.logging.v2.LoggingServiceV2Client.ListMonitoredResource import com.google.api.MonitoredResourceDescriptor; import com.google.api.core.ApiFunction; import com.google.api.core.ApiFuture; +import com.google.api.core.ObsoleteApi; import com.google.api.gax.batching.BatchingSettings; import com.google.api.gax.batching.FlowControlSettings; import com.google.api.gax.batching.FlowController; @@ -433,6 +434,8 @@ public class LoggingServiceV2StubSettings extends StubSettings { } /** Returns the default service endpoint. */ + @ObsoleteApi( + "See https://github.com/googleapis/sdk-platform-java/issues/2346 for more information") public static String getDefaultEndpoint() { return "pubsub.googleapis.com:443"; } diff --git a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpcrest/goldens/EchoStubSettings.golden b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpcrest/goldens/EchoStubSettings.golden index 565f38a483..7d3665627e 100644 --- a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpcrest/goldens/EchoStubSettings.golden +++ b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpcrest/goldens/EchoStubSettings.golden @@ -6,6 +6,7 @@ import static com.google.showcase.grpcrest.v1beta1.EchoClient.SimplePagedExpandP import com.google.api.core.ApiFunction; import com.google.api.core.ApiFuture; import com.google.api.core.BetaApi; +import com.google.api.core.ObsoleteApi; import com.google.api.gax.core.GaxProperties; import com.google.api.gax.core.GoogleCredentialsProvider; import com.google.api.gax.core.InstantiatingExecutorProvider; @@ -307,6 +308,8 @@ public class EchoStubSettings extends StubSettings { } /** Returns the default service endpoint. */ + @ObsoleteApi( + "See https://github.com/googleapis/sdk-platform-java/issues/2346 for more information") public static String getDefaultEndpoint() { return "localhost:7469"; } diff --git a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpcrest/goldens/WickedStubSettings.golden b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpcrest/goldens/WickedStubSettings.golden index 9a376f484a..f5ee0b8e34 100644 --- a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpcrest/goldens/WickedStubSettings.golden +++ b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpcrest/goldens/WickedStubSettings.golden @@ -2,6 +2,7 @@ package com.google.showcase.v1beta1.stub; import com.google.api.core.ApiFunction; import com.google.api.core.BetaApi; +import com.google.api.core.ObsoleteApi; import com.google.api.gax.core.GaxProperties; import com.google.api.gax.core.GoogleCredentialsProvider; import com.google.api.gax.core.InstantiatingExecutorProvider; @@ -105,6 +106,8 @@ public class WickedStubSettings extends StubSettings { } /** Returns the default service endpoint. */ + @ObsoleteApi( + "See https://github.com/googleapis/sdk-platform-java/issues/2346 for more information") public static String getDefaultEndpoint() { return "localhost:7469"; } diff --git a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/rest/goldens/ComplianceStubSettings.golden b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/rest/goldens/ComplianceStubSettings.golden index 21420a6a2e..eac9314369 100644 --- a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/rest/goldens/ComplianceStubSettings.golden +++ b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/rest/goldens/ComplianceStubSettings.golden @@ -2,6 +2,7 @@ package com.google.showcase.v1beta1.stub; import com.google.api.core.ApiFunction; import com.google.api.core.BetaApi; +import com.google.api.core.ObsoleteApi; import com.google.api.gax.core.GaxProperties; import com.google.api.gax.core.GoogleCredentialsProvider; import com.google.api.gax.core.InstantiatingExecutorProvider; @@ -137,6 +138,8 @@ public class ComplianceStubSettings extends StubSettings } /** Returns the default service endpoint. */ + @ObsoleteApi( + "See https://github.com/googleapis/sdk-platform-java/issues/2346 for more information") public static String getDefaultEndpoint() { return "localhost:7469"; } diff --git a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/rest/goldens/HttpJsonApiVersionTestingStubSettings.golden b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/rest/goldens/HttpJsonApiVersionTestingStubSettings.golden index 219800efd4..5d500e38e0 100644 --- a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/rest/goldens/HttpJsonApiVersionTestingStubSettings.golden +++ b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/rest/goldens/HttpJsonApiVersionTestingStubSettings.golden @@ -1,6 +1,7 @@ package com.google.api.version.test.stub; import com.google.api.core.ApiFunction; +import com.google.api.core.ObsoleteApi; import com.google.api.gax.core.GaxProperties; import com.google.api.gax.core.GoogleCredentialsProvider; import com.google.api.gax.core.InstantiatingExecutorProvider; @@ -91,6 +92,8 @@ public class EchoWithVersionStubSettings extends StubSettings Date: Fri, 12 Jul 2024 16:12:23 -0400 Subject: [PATCH 2/2] chore: Update ObsoleteApi text --- .../common/AbstractServiceStubSettingsClassComposer.java | 3 +-- .../composer/grpc/goldens/ApiVersionTestingStubSettings.golden | 3 +-- .../composer/grpc/goldens/DeprecatedServiceStubSettings.golden | 3 +-- .../gapic/composer/grpc/goldens/EchoStubSettings.golden | 3 +-- .../composer/grpc/goldens/LoggingServiceV2StubSettings.golden | 3 +-- .../gapic/composer/grpc/goldens/PublisherStubSettings.golden | 3 +-- .../gapic/composer/grpcrest/goldens/EchoStubSettings.golden | 3 +-- .../gapic/composer/grpcrest/goldens/WickedStubSettings.golden | 3 +-- .../gapic/composer/rest/goldens/ComplianceStubSettings.golden | 3 +-- .../rest/goldens/HttpJsonApiVersionTestingStubSettings.golden | 3 +-- .../google/showcase/v1beta1/stub/ComplianceStubSettings.java | 3 +-- .../com/google/showcase/v1beta1/stub/EchoStubSettings.java | 3 +-- .../com/google/showcase/v1beta1/stub/IdentityStubSettings.java | 3 +-- .../google/showcase/v1beta1/stub/MessagingStubSettings.java | 3 +-- .../showcase/v1beta1/stub/SequenceServiceStubSettings.java | 3 +-- .../com/google/showcase/v1beta1/stub/TestingStubSettings.java | 3 +-- .../apigeeconnect/v1/stub/ConnectionServiceStubSettings.java | 3 +-- .../google/cloud/apigeeconnect/v1/stub/TetherStubSettings.java | 3 +-- .../google/cloud/asset/v1/stub/AssetServiceStubSettings.java | 3 +-- .../cloud/bigtable/data/v2/stub/BigtableStubSettings.java | 3 +-- .../cloud/compute/v1small/stub/AddressesStubSettings.java | 3 +-- .../compute/v1small/stub/RegionOperationsStubSettings.java | 3 +-- .../iam/credentials/v1/stub/IamCredentialsStubSettings.java | 3 +-- .../iam/src/com/google/iam/v1/stub/IAMPolicyStubSettings.java | 3 +-- .../cloud/kms/v1/stub/KeyManagementServiceStubSettings.java | 3 +-- .../example/library/v1/stub/LibraryServiceStubSettings.java | 3 +-- .../cloud/logging/v2/stub/ConfigServiceV2StubSettings.java | 3 +-- .../cloud/logging/v2/stub/LoggingServiceV2StubSettings.java | 3 +-- .../cloud/logging/v2/stub/MetricsServiceV2StubSettings.java | 3 +-- .../com/google/cloud/pubsub/v1/stub/PublisherStubSettings.java | 3 +-- .../google/cloud/pubsub/v1/stub/SchemaServiceStubSettings.java | 3 +-- .../google/cloud/pubsub/v1/stub/SubscriberStubSettings.java | 3 +-- .../cloud/redis/v1beta1/stub/CloudRedisStubSettings.java | 3 +-- .../src/com/google/storage/v2/stub/StorageStubSettings.java | 3 +-- 34 files changed, 34 insertions(+), 68 deletions(-) diff --git a/gapic-generator-java/src/main/java/com/google/api/generator/gapic/composer/common/AbstractServiceStubSettingsClassComposer.java b/gapic-generator-java/src/main/java/com/google/api/generator/gapic/composer/common/AbstractServiceStubSettingsClassComposer.java index cd30aaf694..557b94663c 100644 --- a/gapic-generator-java/src/main/java/com/google/api/generator/gapic/composer/common/AbstractServiceStubSettingsClassComposer.java +++ b/gapic-generator-java/src/main/java/com/google/api/generator/gapic/composer/common/AbstractServiceStubSettingsClassComposer.java @@ -1195,8 +1195,7 @@ private List createDefaultHelperAndGetterMethods( ImmutableList.of( AnnotationNode.builder() .setType(FIXED_TYPESTORE.get(ObsoleteApi.class.getSimpleName())) - .setDescription( - "See https://github.com/googleapis/sdk-platform-java/issues/2346 for more information") + .setDescription("Use getEndpoint() instead") .build())) .build()); diff --git a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/ApiVersionTestingStubSettings.golden b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/ApiVersionTestingStubSettings.golden index 7727609675..0920230bd1 100644 --- a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/ApiVersionTestingStubSettings.golden +++ b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/ApiVersionTestingStubSettings.golden @@ -92,8 +92,7 @@ public class EchoWithVersionStubSettings extends StubSettings { } /** Returns the default service endpoint. */ - @ObsoleteApi( - "See https://github.com/googleapis/sdk-platform-java/issues/2346 for more information") + @ObsoleteApi("Use getEndpoint() instead") public static String getDefaultEndpoint() { return "localhost:7469"; } diff --git a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/LoggingServiceV2StubSettings.golden b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/LoggingServiceV2StubSettings.golden index ca27444037..39984fb5a7 100644 --- a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/LoggingServiceV2StubSettings.golden +++ b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpc/goldens/LoggingServiceV2StubSettings.golden @@ -434,8 +434,7 @@ public class LoggingServiceV2StubSettings extends StubSettings { } /** Returns the default service endpoint. */ - @ObsoleteApi( - "See https://github.com/googleapis/sdk-platform-java/issues/2346 for more information") + @ObsoleteApi("Use getEndpoint() instead") public static String getDefaultEndpoint() { return "pubsub.googleapis.com:443"; } diff --git a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpcrest/goldens/EchoStubSettings.golden b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpcrest/goldens/EchoStubSettings.golden index 7d3665627e..afb4998b5b 100644 --- a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpcrest/goldens/EchoStubSettings.golden +++ b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpcrest/goldens/EchoStubSettings.golden @@ -308,8 +308,7 @@ public class EchoStubSettings extends StubSettings { } /** Returns the default service endpoint. */ - @ObsoleteApi( - "See https://github.com/googleapis/sdk-platform-java/issues/2346 for more information") + @ObsoleteApi("Use getEndpoint() instead") public static String getDefaultEndpoint() { return "localhost:7469"; } diff --git a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpcrest/goldens/WickedStubSettings.golden b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpcrest/goldens/WickedStubSettings.golden index f5ee0b8e34..5a555d7001 100644 --- a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpcrest/goldens/WickedStubSettings.golden +++ b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/grpcrest/goldens/WickedStubSettings.golden @@ -106,8 +106,7 @@ public class WickedStubSettings extends StubSettings { } /** Returns the default service endpoint. */ - @ObsoleteApi( - "See https://github.com/googleapis/sdk-platform-java/issues/2346 for more information") + @ObsoleteApi("Use getEndpoint() instead") public static String getDefaultEndpoint() { return "localhost:7469"; } diff --git a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/rest/goldens/ComplianceStubSettings.golden b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/rest/goldens/ComplianceStubSettings.golden index eac9314369..0c6ab1cc1c 100644 --- a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/rest/goldens/ComplianceStubSettings.golden +++ b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/rest/goldens/ComplianceStubSettings.golden @@ -138,8 +138,7 @@ public class ComplianceStubSettings extends StubSettings } /** Returns the default service endpoint. */ - @ObsoleteApi( - "See https://github.com/googleapis/sdk-platform-java/issues/2346 for more information") + @ObsoleteApi("Use getEndpoint() instead") public static String getDefaultEndpoint() { return "localhost:7469"; } diff --git a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/rest/goldens/HttpJsonApiVersionTestingStubSettings.golden b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/rest/goldens/HttpJsonApiVersionTestingStubSettings.golden index 5d500e38e0..08b311156c 100644 --- a/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/rest/goldens/HttpJsonApiVersionTestingStubSettings.golden +++ b/gapic-generator-java/src/test/java/com/google/api/generator/gapic/composer/rest/goldens/HttpJsonApiVersionTestingStubSettings.golden @@ -92,8 +92,7 @@ public class EchoWithVersionStubSettings extends StubSettings