Skip to content

Commit df95ceb

Browse files
committed
chore: Set the transport options via the builder
1 parent 0271060 commit df95ceb

8 files changed

Lines changed: 32 additions & 23 deletions

File tree

java-datastore/google-cloud-datastore/src/main/java/com/google/cloud/datastore/DatastoreOptions.java

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -180,12 +180,16 @@ public Builder setTransportOptions(@Nonnull TransportOptions transportOptions) {
180180
}
181181

182182
/**
183-
* Sets the transport to gRPC. Note this functionality is experimental and subject to change.
183+
* This method deprecated. Prefer to use {@link #setTransportOptions(TransportOptions)} instead.
184+
* When using the transport-neutral variant, you may need to cast to TransportOptions when using
185+
* a GrpcTransportOptions class, otherwise it will default to the deprecated method.
186+
*
187+
* <p>Sets the transport to gRPC. Note this functionality is experimental and subject to change.
184188
*/
189+
@Deprecated
185190
@BetaApi
186191
public Builder setTransportOptions(GrpcTransportOptions transportOptions) {
187-
this.transportOptions = transportOptions;
188-
return super.setTransportOptions(transportOptions);
192+
return setTransportOptions((TransportOptions) transportOptions);
189193
}
190194

191195
@Override

java-datastore/google-cloud-datastore/src/main/java/com/google/cloud/datastore/testing/LocalDatastoreHelper.java

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
import com.google.api.core.InternalApi;
2323
import com.google.cloud.NoCredentials;
2424
import com.google.cloud.ServiceOptions;
25+
import com.google.cloud.TransportOptions;
2526
import com.google.cloud.datastore.DatastoreOptions;
2627
import com.google.cloud.grpc.GrpcTransportOptions;
2728
import com.google.cloud.testing.BaseEmulatorHelper;
@@ -242,11 +243,14 @@ public DatastoreOptions getOptions(String namespace) {
242243
}
243244

244245
/**
245-
* Returns a {@link DatastoreOptions} instance that sets the host to use the Datastore emulator on
246-
* localhost. The transportOptions is set to {@code grpcTransportOptions}.
246+
* Prefer to set the TransportOptions via the Options Builder.
247+
*
248+
* <p>Returns a {@link DatastoreOptions} instance that sets the host to use the Datastore emulator
249+
* on localhost. The transportOptions is set to {@code grpcTransportOptions}.
247250
*/
251+
@Deprecated
248252
public DatastoreOptions getGrpcTransportOptions(GrpcTransportOptions grpcTransportOptions) {
249-
return optionsBuilder.setTransportOptions(grpcTransportOptions).build();
253+
return optionsBuilder.setTransportOptions((TransportOptions) grpcTransportOptions).build();
250254
}
251255

252256
public DatastoreOptions.Builder setNamespace(String namespace) {

java-datastore/google-cloud-datastore/src/test/java/com/google/cloud/datastore/DatastoreImplMetricsTest.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
import com.google.api.gax.rpc.StatusCode;
2222
import com.google.cloud.NoCredentials;
2323
import com.google.cloud.ServiceOptions;
24+
import com.google.cloud.TransportOptions;
2425
import com.google.cloud.datastore.spi.DatastoreRpcFactory;
2526
import com.google.cloud.datastore.spi.v1.DatastoreRpc;
2627
import com.google.cloud.datastore.telemetry.DatastoreMetricsRecorder;
@@ -115,7 +116,7 @@ public void setUp() {
115116
.build());
116117

117118
if (TelemetryConstants.Transport.GRPC.equals(transport)) {
118-
builder.setTransportOptions(GrpcTransportOptions.newBuilder().build());
119+
builder.setTransportOptions((TransportOptions) GrpcTransportOptions.newBuilder().build());
119120
} else {
120121
builder.setTransportOptions(HttpTransportOptions.newBuilder().build());
121122
}

java-datastore/google-cloud-datastore/src/test/java/com/google/cloud/datastore/DatastoreOptionsTest.java

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
import com.google.api.gax.grpc.ChannelPoolSettings;
2828
import com.google.api.gax.grpc.InstantiatingGrpcChannelProvider;
2929
import com.google.cloud.NoCredentials;
30+
import com.google.cloud.TransportOptions;
3031
import com.google.cloud.datastore.spi.DatastoreRpcFactory;
3132
import com.google.cloud.datastore.spi.v1.DatastoreRpc;
3233
import com.google.cloud.datastore.v1.DatastoreSettings;
@@ -217,7 +218,7 @@ public void testGrpcDefaultChannelConfigurations() {
217218
.setServiceRpcFactory(datastoreRpcFactory)
218219
.setProjectId(PROJECT_ID)
219220
.setDatabaseId(DATABASE_ID)
220-
.setTransportOptions(GrpcTransportOptions.newBuilder().build())
221+
.setTransportOptions((TransportOptions) GrpcTransportOptions.newBuilder().build())
221222
.setCredentials(NoCredentials.getInstance())
222223
.setHost("http://localhost:" + PORT)
223224
.build();
@@ -250,7 +251,7 @@ public void testCustomChannelAndCredentials() {
250251
.setServiceRpcFactory(datastoreRpcFactory)
251252
.setProjectId(PROJECT_ID)
252253
.setDatabaseId(DATABASE_ID)
253-
.setTransportOptions(GrpcTransportOptions.newBuilder().build())
254+
.setTransportOptions((TransportOptions) GrpcTransportOptions.newBuilder().build())
254255
.setChannelProvider(channelProvider)
255256
.setCredentials(NoCredentials.getInstance())
256257
.setHost("http://localhost:" + PORT)
@@ -296,7 +297,7 @@ public void testTransport() {
296297
// custom grpc transport
297298
DatastoreOptions grpcTransportOptions =
298299
DatastoreOptions.newBuilder()
299-
.setTransportOptions(GrpcTransportOptions.newBuilder().build())
300+
.setTransportOptions((TransportOptions) GrpcTransportOptions.newBuilder().build())
300301
.setProjectId(PROJECT_ID)
301302
.setCredentials(NoCredentials.getInstance())
302303
.build();
@@ -309,7 +310,7 @@ public void testTransport() {
309310
public void testHostWithGrpcAndHttp() {
310311
DatastoreOptions grpcTransportOptions =
311312
DatastoreOptions.newBuilder()
312-
.setTransportOptions(GrpcTransportOptions.newBuilder().build())
313+
.setTransportOptions((TransportOptions) GrpcTransportOptions.newBuilder().build())
313314
.setProjectId(PROJECT_ID)
314315
.setCredentials(NoCredentials.getInstance())
315316
.build();
@@ -319,7 +320,7 @@ public void testHostWithGrpcAndHttp() {
319320
String customHost = "http://localhost:" + PORT;
320321
DatastoreOptions grpcTransportOptionsCustomHost =
321322
DatastoreOptions.newBuilder()
322-
.setTransportOptions(GrpcTransportOptions.newBuilder().build())
323+
.setTransportOptions((TransportOptions) GrpcTransportOptions.newBuilder().build())
323324
.setHost(customHost)
324325
.setProjectId(PROJECT_ID)
325326
.setCredentials(NoCredentials.getInstance())

java-datastore/google-cloud-datastore/src/test/java/com/google/cloud/datastore/DatastoreTestGrpc.java

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@
1717
package com.google.cloud.datastore;
1818

1919
import com.google.cloud.datastore.testing.LocalDatastoreHelper;
20-
import com.google.cloud.grpc.GrpcTransportOptions;
2120
import com.google.common.truth.Truth;
2221
import java.io.IOException;
2322
import java.time.Duration;
@@ -32,8 +31,7 @@ public class DatastoreTestGrpc extends AbstractDatastoreTest {
3231

3332
private static final LocalDatastoreHelper helper = LocalDatastoreHelper.create(1.0, 9090);
3433

35-
private static DatastoreOptions options =
36-
helper.getGrpcTransportOptions(GrpcTransportOptions.newBuilder().build());
34+
private static DatastoreOptions options = helper.getOptions();
3735
private static Datastore datastore = options.getService();
3836

3937
public DatastoreTestGrpc(DatastoreOptions options, Datastore datastore) {
@@ -48,7 +46,7 @@ public static Iterable<Object[]> data() {
4846
@BeforeClass
4947
public static void beforeClass() throws IOException, InterruptedException {
5048
helper.start();
51-
options = helper.getGrpcTransportOptions(GrpcTransportOptions.newBuilder().build());
49+
options = helper.getOptions();
5250
datastore = options.getService();
5351
}
5452

java-datastore/google-cloud-datastore/src/test/java/com/google/cloud/datastore/DatastoreTestHttp.java

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
package com.google.cloud.datastore;
1818

1919
import com.google.cloud.datastore.testing.LocalDatastoreHelper;
20-
import com.google.cloud.grpc.GrpcTransportOptions;
20+
import com.google.cloud.http.HttpTransportOptions;
2121
import java.io.IOException;
2222
import java.time.Duration;
2323
import java.util.Arrays;
@@ -46,7 +46,10 @@ public static Iterable<Object[]> data() {
4646
@BeforeClass
4747
public static void beforeClass() throws IOException, InterruptedException {
4848
helper.start();
49-
options = helper.getGrpcTransportOptions(GrpcTransportOptions.newBuilder().build());
49+
options =
50+
helper.getOptions().toBuilder()
51+
.setTransportOptions(HttpTransportOptions.newBuilder().build())
52+
.build();
5053
datastore = options.getService();
5154
}
5255

java-datastore/google-cloud-datastore/src/test/java/com/google/cloud/datastore/it/ITDatastoreClientSideMetrics.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@
2828
import com.google.cloud.datastore.Key;
2929
import com.google.cloud.datastore.telemetry.TelemetryConstants;
3030
import com.google.cloud.grpc.GrpcTransportOptions;
31-
import com.google.cloud.http.HttpTransportOptions;
3231
import io.opentelemetry.api.common.AttributeKey;
3332
import io.opentelemetry.sdk.OpenTelemetrySdk;
3433
import io.opentelemetry.sdk.metrics.SdkMeterProvider;
@@ -124,9 +123,9 @@ public void setUp() {
124123
.build());
125124

126125
if (transportOptions instanceof GrpcTransportOptions) {
127-
builder.setTransportOptions((GrpcTransportOptions) transportOptions);
126+
builder.setTransportOptions(transportOptions);
128127
} else {
129-
builder.setTransportOptions((HttpTransportOptions) transportOptions);
128+
builder.setTransportOptions(transportOptions);
130129
}
131130

132131
datastore = builder.build().getService();

java-datastore/google-cloud-datastore/src/test/java/com/google/cloud/datastore/testing/RemoteDatastoreHelper.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -114,8 +114,7 @@ public static RemoteDatastoreHelper create(
114114
.setNamespace(UUID.randomUUID().toString())
115115
.setRetrySettings(retrySettings());
116116
if (transportOptions instanceof GrpcTransportOptions) {
117-
datastoreOptionBuilder =
118-
datastoreOptionBuilder.setTransportOptions((GrpcTransportOptions) transportOptions);
117+
datastoreOptionBuilder = datastoreOptionBuilder.setTransportOptions(transportOptions);
119118
} else {
120119
datastoreOptionBuilder = datastoreOptionBuilder.setTransportOptions(transportOptions);
121120
}

0 commit comments

Comments
 (0)