Skip to content

Commit 62bbaa1

Browse files
authored
feat(bigtable): update legacy escape hatch to return V2 admin clients (googleapis#13375)
This PR updates the legacy `BigtableTableAdminClient` and `BigtableInstanceAdminClient` escape hatches (`getBaseClient()`) to return the modern V2 admin clients (`BigtableTableAdminClientV2` and `BigtableInstanceAdminClientV2`) instead of the autogenerated base clients (`BaseBigtableTableAdminClient` and `BaseBigtableInstanceAdminClient`).
1 parent 0a0fcc6 commit 62bbaa1

4 files changed

Lines changed: 71 additions & 16 deletions

File tree

java-bigtable/google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/admin/v2/BigtableInstanceAdminClient.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@
125125
public final class BigtableInstanceAdminClient implements AutoCloseable {
126126
private final String projectId;
127127
private final BigtableInstanceAdminStub stub;
128-
private final BaseBigtableInstanceAdminClient baseClient;
128+
private final BigtableInstanceAdminClientV2 v2Client;
129129

130130
/** Constructs an instance of BigtableInstanceAdminClient with the given project ID. */
131131
public static BigtableInstanceAdminClient create(@Nonnull String projectId) throws IOException {
@@ -148,7 +148,7 @@ private BigtableInstanceAdminClient(
148148
@Nonnull String projectId, @Nonnull BigtableInstanceAdminStub stub) {
149149
this.projectId = projectId;
150150
this.stub = stub;
151-
this.baseClient = BaseBigtableInstanceAdminClient.create(stub);
151+
this.v2Client = new BigtableInstanceAdminClientV2(stub);
152152
}
153153

154154
/** Gets the project ID this client is associated with. */
@@ -157,11 +157,11 @@ public String getProjectId() {
157157
}
158158

159159
/**
160-
* Returns the modern autogenerated client. This provides access to the newest features and
161-
* proto-based methods.
160+
* Returns the modern V2 client. This provides access to the newest features and proto-based
161+
* methods.
162162
*/
163-
public BaseBigtableInstanceAdminClient getBaseClient() {
164-
return baseClient;
163+
public BigtableInstanceAdminClientV2 getBaseClient() {
164+
return v2Client;
165165
}
166166

167167
/** Closes the client and frees all resources associated with it (like thread pools). */

java-bigtable/google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/admin/v2/BigtableTableAdminClient.java

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,7 @@
8989
import java.util.List;
9090
import java.util.Map;
9191
import java.util.concurrent.ExecutionException;
92+
import java.util.concurrent.ScheduledExecutorService;
9293
import javax.annotation.Nonnull;
9394

9495
/**
@@ -169,7 +170,7 @@ public final class BigtableTableAdminClient implements AutoCloseable {
169170
private final EnhancedBigtableTableAdminStub stub;
170171
private final String projectId;
171172
private final String instanceId;
172-
private final BaseBigtableTableAdminClient baseClient;
173+
private BigtableTableAdminClientV2 v2Client;
173174

174175
/** Constructs an instance of BigtableTableAdminClient with the given project and instance IDs. */
175176
public static BigtableTableAdminClient create(
@@ -209,7 +210,6 @@ private BigtableTableAdminClient(
209210
this.projectId = projectId;
210211
this.instanceId = instanceId;
211212
this.stub = stub;
212-
this.baseClient = BaseBigtableTableAdminClient.create(stub);
213213
}
214214

215215
/** Gets the project ID of the instance whose tables this client manages. */
@@ -223,11 +223,29 @@ public String getInstanceId() {
223223
}
224224

225225
/**
226-
* Returns the modern autogenerated client. This provides access to the newest features and
227-
* proto-based methods.
228-
*/
229-
public BaseBigtableTableAdminClient getBaseClient() {
230-
return baseClient;
226+
* Returns the modern V2 client. This provides access to the newest features and proto-based
227+
* methods.
228+
*/
229+
public synchronized BigtableTableAdminClientV2 getBaseClient() {
230+
if (v2Client == null) {
231+
ScheduledExecutorService backgroundExecutor =
232+
stub.getSettings().getBackgroundExecutorProvider().getExecutor();
233+
boolean shouldAutoClose =
234+
stub.getSettings().getBackgroundExecutorProvider().shouldAutoClose();
235+
236+
try {
237+
v2Client =
238+
BigtableTableAdminClientV2.create(
239+
stub,
240+
stub.getSettings(),
241+
stub.getClientContext().getClock(),
242+
backgroundExecutor,
243+
shouldAutoClose);
244+
} catch (IOException e) {
245+
throw new IllegalStateException("Failed to initialize modern V2 table admin client", e);
246+
}
247+
}
248+
return v2Client;
231249
}
232250

233251
@Override

java-bigtable/google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/admin/v2/BigtableTableAdminClientV2.java

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,8 @@ public static final BigtableTableAdminClientV2 create(BaseBigtableTableAdminSett
108108

109109
OperationCallable<Void, Empty, OptimizeRestoredTableMetadata>
110110
optimizeRestoredTableOperationBaseCallable =
111-
createOptimizeRestoredTableOperationBaseCallable(stub, settings, backgroundExecutor);
111+
createOptimizeRestoredTableOperationBaseCallable(
112+
stub, settings.getStubSettings().getClock(), backgroundExecutor);
112113

113114
return new BigtableTableAdminClientV2(
114115
stub,
@@ -118,6 +119,34 @@ public static final BigtableTableAdminClientV2 create(BaseBigtableTableAdminSett
118119
optimizeRestoredTableOperationBaseCallable);
119120
}
120121

122+
/**
123+
* Package-private factory method to construct an instance of {@link BigtableTableAdminClientV2}
124+
* by reusing an existing stub, settings, clock, and background executor.
125+
*
126+
* <p>This is used by the legacy {@code BigtableTableAdminClient}'s escape hatch ({@code
127+
* getBaseClient()}) to wrap the legacy client's active stub, ensuring the underlying gRPC channel
128+
* and resources are shared rather than recreated.
129+
*/
130+
static BigtableTableAdminClientV2 create(
131+
GrpcBigtableTableAdminStub stub,
132+
BigtableTableAdminStubSettings settings,
133+
ApiClock clock,
134+
ScheduledExecutorService backgroundExecutor,
135+
boolean shouldAutoClose)
136+
throws IOException {
137+
AwaitConsistencyCallableV2 awaitConsistencyCallable =
138+
createAwaitConsistencyCallable(stub, settings, clock, backgroundExecutor);
139+
OperationCallable<Void, Empty, OptimizeRestoredTableMetadata>
140+
optimizeRestoredTableOperationBaseCallable =
141+
createOptimizeRestoredTableOperationBaseCallable(stub, clock, backgroundExecutor);
142+
return new BigtableTableAdminClientV2(
143+
stub,
144+
backgroundExecutor,
145+
shouldAutoClose,
146+
awaitConsistencyCallable,
147+
optimizeRestoredTableOperationBaseCallable);
148+
}
149+
121150
protected BigtableTableAdminClientV2(
122151
GrpcBigtableTableAdminStub stub,
123152
@Nullable ScheduledExecutorService backgroundExecutor,
@@ -156,7 +185,7 @@ private static AwaitConsistencyCallableV2 createAwaitConsistencyCallable(
156185
private static OperationCallable<Void, Empty, OptimizeRestoredTableMetadata>
157186
createOptimizeRestoredTableOperationBaseCallable(
158187
GrpcBigtableTableAdminStub stub,
159-
BaseBigtableTableAdminSettings settings,
188+
ApiClock clock,
160189
ScheduledExecutorService backgroundExecutor)
161190
throws IOException {
162191

@@ -229,7 +258,7 @@ public Empty apply(OperationSnapshot input) {
229258
// (including channels, credentials, and headers) for executing the polling RPCs.
230259
ClientContext clientContext =
231260
ClientContext.newBuilder()
232-
.setClock(settings.getStubSettings().getClock())
261+
.setClock(clock)
233262
.setExecutor(backgroundExecutor)
234263
.setDefaultCallContext(GrpcCallContext.createDefault())
235264
.build();

java-bigtable/google-cloud-bigtable/src/main/java/com/google/cloud/bigtable/admin/v2/stub/EnhancedBigtableTableAdminStub.java

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -245,4 +245,12 @@ public UnaryCallable<ConsistencyRequest, Void> awaitConsistencyCallable() {
245245
awaitOptimizeRestoredTableCallable() {
246246
return optimizeRestoredTableOperationBaseCallable;
247247
}
248+
249+
public BigtableTableAdminStubSettings getSettings() {
250+
return settings;
251+
}
252+
253+
public ClientContext getClientContext() {
254+
return clientContext;
255+
}
248256
}

0 commit comments

Comments
 (0)