Skip to content

Commit 6e0b4e4

Browse files
gkevinzhenggkevinzheng
authored
chore: Moved admin client to google.cloud.bigtable.admin (#1204)
Changes: 1. Moved the admin library from `google.cloud.bigtable_admin/bigtable_admin_v2` to `google.cloud.bigtable.admin`. The autogenerated portion of the library was generated as follows: ``` py_gapic_library( name = "bigtable_admin_py_gapic", srcs = [":admin_proto"], grpc_service_config = "bigtableadmin_grpc_service_config.json", opt_args = [ "python-gapic-namespace=google.cloud.bigtable", "python-gapic-name=admin", ], rest_numeric_enums = True, service_yaml = "bigtableadmin_v2.yaml", transport = "grpc+rest", deps = [ "//google/iam/v1:iam_policy_py_proto", ], ) ``` This change will be committed close to when we will release the v3 client. 2. Created import aliasing to make sure that old imports from `bigtable_admin/bigtable_admin_v2` still work as intended. 1. Created unit tests for the import aliasing. Since there's an existing layer of import aliasing for objects within the GAPIC library, we create unit tests to make sure the composition of existing and new import aliasing works as intended. 1. Made the classic client use the new selective GAPIC `BigtableTableAdminClient` instead of the `BaseBigtableTableAdminClient` as its table admin client. Fixes #1155
1 parent 94bc9db commit 6e0b4e4

File tree

221 files changed

+2954
-3486
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

221 files changed

+2954
-3486
lines changed

‎docs/admin_client/admin_client_usage.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ Admin Client
88

99
..
1010
This should be the only handwritten RST file in this directory.
11-
Everything else should be autogenerated.
11+
Everything else should be autogenerated.

‎docs/admin_client/bigtable_instance_admin.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
BigtableInstanceAdmin
22
---------------------------------------
33

4-
.. automodule:: google.cloud.bigtable_admin_v2.services.bigtable_instance_admin
4+
.. automodule:: google.cloud.bigtable.admin.services.bigtable_instance_admin
55
:members:
66
:inherited-members:
77

8-
.. automodule:: google.cloud.bigtable_admin_v2.services.bigtable_instance_admin.pagers
8+
.. automodule:: google.cloud.bigtable.admin.services.bigtable_instance_admin.pagers
99
:members:
1010
:inherited-members:

‎docs/admin_client/bigtable_table_admin.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
BigtableTableAdmin
22
------------------------------------
33

4-
.. automodule:: google.cloud.bigtable_admin_v2.overlay.services.bigtable_table_admin
4+
.. automodule:: google.cloud.bigtable.admin.overlay.services.bigtable_table_admin
55
:members:
66
:inherited-members:
77

8-
.. automodule:: google.cloud.bigtable_admin_v2.services.bigtable_table_admin.pagers
8+
.. automodule:: google.cloud.bigtable.admin.services.bigtable_table_admin.pagers
99
:members:
1010
:inherited-members:

‎docs/admin_client/types_.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
Types for Google Cloud Bigtable Admin v2 API
22
============================================
33

4-
.. automodule:: google.cloud.bigtable_admin_v2.types
4+
.. automodule:: google.cloud.bigtable.admin.types
55
:members:
66
:show-inheritance:
77

8-
.. automodule:: google.cloud.bigtable_admin_v2.overlay.types
8+
.. automodule:: google.cloud.bigtable.admin.overlay.types
99
:members:
1010
:show-inheritance:

‎docs/scripts/patch_devsite_toc.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -252,9 +252,9 @@ def validate_toc(toc_file_path, expected_section_list, added_sections):
252252
TocSection(dir_name="data_client", index_file_name="data_client_usage.rst"),
253253
UIDFilteredTocSection(
254254
toc_file_path=toc_path,
255-
section_name="Bigtable Admin V2",
255+
section_name="Bigtable",
256256
title="Admin Client",
257-
uid_prefix="google.cloud.bigtable_admin_v2",
257+
uid_prefix="google.cloud.bigtable.admin",
258258
),
259259
TocSection(dir_name="classic_client", index_file_name="usage.rst"),
260260
]

‎google/cloud/bigtable/admin/__init__.py‎

Lines changed: 274 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,274 @@
1+
# -*- coding: utf-8 -*-
2+
# Copyright 2025 Google LLC
3+
#
4+
# Licensed under the Apache License, Version 2.0 (the "License");
5+
# you may not use this file except in compliance with the License.
6+
# You may obtain a copy of the License at
7+
#
8+
# http://www.apache.org/licenses/LICENSE-2.0
9+
#
10+
# Unless required by applicable law or agreed to in writing, software
11+
# distributed under the License is distributed on an "AS IS" BASIS,
12+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
# See the License for the specific language governing permissions and
14+
# limitations under the License.
15+
#
16+
from google.cloud.bigtable.admin import gapic_version as package_version
17+
18+
__version__ = package_version.__version__
19+
20+
21+
from .services.bigtable_instance_admin import BigtableInstanceAdminClient
22+
from .services.bigtable_instance_admin import BigtableInstanceAdminAsyncClient
23+
from .services.bigtable_table_admin import BaseBigtableTableAdminClient
24+
from .services.bigtable_table_admin import BaseBigtableTableAdminAsyncClient
25+
26+
from .types.bigtable_instance_admin import CreateAppProfileRequest
27+
from .types.bigtable_instance_admin import CreateClusterMetadata
28+
from .types.bigtable_instance_admin import CreateClusterRequest
29+
from .types.bigtable_instance_admin import CreateInstanceMetadata
30+
from .types.bigtable_instance_admin import CreateInstanceRequest
31+
from .types.bigtable_instance_admin import CreateLogicalViewMetadata
32+
from .types.bigtable_instance_admin import CreateLogicalViewRequest
33+
from .types.bigtable_instance_admin import CreateMaterializedViewMetadata
34+
from .types.bigtable_instance_admin import CreateMaterializedViewRequest
35+
from .types.bigtable_instance_admin import DeleteAppProfileRequest
36+
from .types.bigtable_instance_admin import DeleteClusterRequest
37+
from .types.bigtable_instance_admin import DeleteInstanceRequest
38+
from .types.bigtable_instance_admin import DeleteLogicalViewRequest
39+
from .types.bigtable_instance_admin import DeleteMaterializedViewRequest
40+
from .types.bigtable_instance_admin import GetAppProfileRequest
41+
from .types.bigtable_instance_admin import GetClusterRequest
42+
from .types.bigtable_instance_admin import GetInstanceRequest
43+
from .types.bigtable_instance_admin import GetLogicalViewRequest
44+
from .types.bigtable_instance_admin import GetMaterializedViewRequest
45+
from .types.bigtable_instance_admin import ListAppProfilesRequest
46+
from .types.bigtable_instance_admin import ListAppProfilesResponse
47+
from .types.bigtable_instance_admin import ListClustersRequest
48+
from .types.bigtable_instance_admin import ListClustersResponse
49+
from .types.bigtable_instance_admin import ListHotTabletsRequest
50+
from .types.bigtable_instance_admin import ListHotTabletsResponse
51+
from .types.bigtable_instance_admin import ListInstancesRequest
52+
from .types.bigtable_instance_admin import ListInstancesResponse
53+
from .types.bigtable_instance_admin import ListLogicalViewsRequest
54+
from .types.bigtable_instance_admin import ListLogicalViewsResponse
55+
from .types.bigtable_instance_admin import ListMaterializedViewsRequest
56+
from .types.bigtable_instance_admin import ListMaterializedViewsResponse
57+
from .types.bigtable_instance_admin import PartialUpdateClusterMetadata
58+
from .types.bigtable_instance_admin import PartialUpdateClusterRequest
59+
from .types.bigtable_instance_admin import PartialUpdateInstanceRequest
60+
from .types.bigtable_instance_admin import UpdateAppProfileMetadata
61+
from .types.bigtable_instance_admin import UpdateAppProfileRequest
62+
from .types.bigtable_instance_admin import UpdateClusterMetadata
63+
from .types.bigtable_instance_admin import UpdateInstanceMetadata
64+
from .types.bigtable_instance_admin import UpdateLogicalViewMetadata
65+
from .types.bigtable_instance_admin import UpdateLogicalViewRequest
66+
from .types.bigtable_instance_admin import UpdateMaterializedViewMetadata
67+
from .types.bigtable_instance_admin import UpdateMaterializedViewRequest
68+
from .types.bigtable_table_admin import CheckConsistencyRequest
69+
from .types.bigtable_table_admin import CheckConsistencyResponse
70+
from .types.bigtable_table_admin import CopyBackupMetadata
71+
from .types.bigtable_table_admin import CopyBackupRequest
72+
from .types.bigtable_table_admin import CreateAuthorizedViewMetadata
73+
from .types.bigtable_table_admin import CreateAuthorizedViewRequest
74+
from .types.bigtable_table_admin import CreateBackupMetadata
75+
from .types.bigtable_table_admin import CreateBackupRequest
76+
from .types.bigtable_table_admin import CreateSchemaBundleMetadata
77+
from .types.bigtable_table_admin import CreateSchemaBundleRequest
78+
from .types.bigtable_table_admin import CreateTableFromSnapshotMetadata
79+
from .types.bigtable_table_admin import CreateTableFromSnapshotRequest
80+
from .types.bigtable_table_admin import CreateTableRequest
81+
from .types.bigtable_table_admin import DataBoostReadLocalWrites
82+
from .types.bigtable_table_admin import DeleteAuthorizedViewRequest
83+
from .types.bigtable_table_admin import DeleteBackupRequest
84+
from .types.bigtable_table_admin import DeleteSchemaBundleRequest
85+
from .types.bigtable_table_admin import DeleteSnapshotRequest
86+
from .types.bigtable_table_admin import DeleteTableRequest
87+
from .types.bigtable_table_admin import DropRowRangeRequest
88+
from .types.bigtable_table_admin import GenerateConsistencyTokenRequest
89+
from .types.bigtable_table_admin import GenerateConsistencyTokenResponse
90+
from .types.bigtable_table_admin import GetAuthorizedViewRequest
91+
from .types.bigtable_table_admin import GetBackupRequest
92+
from .types.bigtable_table_admin import GetSchemaBundleRequest
93+
from .types.bigtable_table_admin import GetSnapshotRequest
94+
from .types.bigtable_table_admin import GetTableRequest
95+
from .types.bigtable_table_admin import ListAuthorizedViewsRequest
96+
from .types.bigtable_table_admin import ListAuthorizedViewsResponse
97+
from .types.bigtable_table_admin import ListBackupsRequest
98+
from .types.bigtable_table_admin import ListBackupsResponse
99+
from .types.bigtable_table_admin import ListSchemaBundlesRequest
100+
from .types.bigtable_table_admin import ListSchemaBundlesResponse
101+
from .types.bigtable_table_admin import ListSnapshotsRequest
102+
from .types.bigtable_table_admin import ListSnapshotsResponse
103+
from .types.bigtable_table_admin import ListTablesRequest
104+
from .types.bigtable_table_admin import ListTablesResponse
105+
from .types.bigtable_table_admin import ModifyColumnFamiliesRequest
106+
from .types.bigtable_table_admin import OptimizeRestoredTableMetadata
107+
from .types.bigtable_table_admin import RestoreTableMetadata
108+
from .types.bigtable_table_admin import RestoreTableRequest
109+
from .types.bigtable_table_admin import SnapshotTableMetadata
110+
from .types.bigtable_table_admin import SnapshotTableRequest
111+
from .types.bigtable_table_admin import StandardReadRemoteWrites
112+
from .types.bigtable_table_admin import UndeleteTableMetadata
113+
from .types.bigtable_table_admin import UndeleteTableRequest
114+
from .types.bigtable_table_admin import UpdateAuthorizedViewMetadata
115+
from .types.bigtable_table_admin import UpdateAuthorizedViewRequest
116+
from .types.bigtable_table_admin import UpdateBackupRequest
117+
from .types.bigtable_table_admin import UpdateSchemaBundleMetadata
118+
from .types.bigtable_table_admin import UpdateSchemaBundleRequest
119+
from .types.bigtable_table_admin import UpdateTableMetadata
120+
from .types.bigtable_table_admin import UpdateTableRequest
121+
from .types.common import OperationProgress
122+
from .types.common import StorageType
123+
from .types.instance import AppProfile
124+
from .types.instance import AutoscalingLimits
125+
from .types.instance import AutoscalingTargets
126+
from .types.instance import Cluster
127+
from .types.instance import HotTablet
128+
from .types.instance import Instance
129+
from .types.instance import LogicalView
130+
from .types.instance import MaterializedView
131+
from .types.table import AuthorizedView
132+
from .types.table import Backup
133+
from .types.table import BackupInfo
134+
from .types.table import ChangeStreamConfig
135+
from .types.table import ColumnFamily
136+
from .types.table import EncryptionInfo
137+
from .types.table import GcRule
138+
from .types.table import ProtoSchema
139+
from .types.table import RestoreInfo
140+
from .types.table import SchemaBundle
141+
from .types.table import Snapshot
142+
from .types.table import Table
143+
from .types.table import RestoreSourceType
144+
from .types.types import Type
145+
146+
__all__ = (
147+
"BaseBigtableTableAdminAsyncClient",
148+
"BigtableInstanceAdminAsyncClient",
149+
"AppProfile",
150+
"AuthorizedView",
151+
"AutoscalingLimits",
152+
"AutoscalingTargets",
153+
"Backup",
154+
"BackupInfo",
155+
"BaseBigtableTableAdminClient",
156+
"BigtableInstanceAdminClient",
157+
"ChangeStreamConfig",
158+
"CheckConsistencyRequest",
159+
"CheckConsistencyResponse",
160+
"Cluster",
161+
"ColumnFamily",
162+
"CopyBackupMetadata",
163+
"CopyBackupRequest",
164+
"CreateAppProfileRequest",
165+
"CreateAuthorizedViewMetadata",
166+
"CreateAuthorizedViewRequest",
167+
"CreateBackupMetadata",
168+
"CreateBackupRequest",
169+
"CreateClusterMetadata",
170+
"CreateClusterRequest",
171+
"CreateInstanceMetadata",
172+
"CreateInstanceRequest",
173+
"CreateLogicalViewMetadata",
174+
"CreateLogicalViewRequest",
175+
"CreateMaterializedViewMetadata",
176+
"CreateMaterializedViewRequest",
177+
"CreateSchemaBundleMetadata",
178+
"CreateSchemaBundleRequest",
179+
"CreateTableFromSnapshotMetadata",
180+
"CreateTableFromSnapshotRequest",
181+
"CreateTableRequest",
182+
"DataBoostReadLocalWrites",
183+
"DeleteAppProfileRequest",
184+
"DeleteAuthorizedViewRequest",
185+
"DeleteBackupRequest",
186+
"DeleteClusterRequest",
187+
"DeleteInstanceRequest",
188+
"DeleteLogicalViewRequest",
189+
"DeleteMaterializedViewRequest",
190+
"DeleteSchemaBundleRequest",
191+
"DeleteSnapshotRequest",
192+
"DeleteTableRequest",
193+
"DropRowRangeRequest",
194+
"EncryptionInfo",
195+
"GcRule",
196+
"GenerateConsistencyTokenRequest",
197+
"GenerateConsistencyTokenResponse",
198+
"GetAppProfileRequest",
199+
"GetAuthorizedViewRequest",
200+
"GetBackupRequest",
201+
"GetClusterRequest",
202+
"GetInstanceRequest",
203+
"GetLogicalViewRequest",
204+
"GetMaterializedViewRequest",
205+
"GetSchemaBundleRequest",
206+
"GetSnapshotRequest",
207+
"GetTableRequest",
208+
"HotTablet",
209+
"Instance",
210+
"ListAppProfilesRequest",
211+
"ListAppProfilesResponse",
212+
"ListAuthorizedViewsRequest",
213+
"ListAuthorizedViewsResponse",
214+
"ListBackupsRequest",
215+
"ListBackupsResponse",
216+
"ListClustersRequest",
217+
"ListClustersResponse",
218+
"ListHotTabletsRequest",
219+
"ListHotTabletsResponse",
220+
"ListInstancesRequest",
221+
"ListInstancesResponse",
222+
"ListLogicalViewsRequest",
223+
"ListLogicalViewsResponse",
224+
"ListMaterializedViewsRequest",
225+
"ListMaterializedViewsResponse",
226+
"ListSchemaBundlesRequest",
227+
"ListSchemaBundlesResponse",
228+
"ListSnapshotsRequest",
229+
"ListSnapshotsResponse",
230+
"ListTablesRequest",
231+
"ListTablesResponse",
232+
"LogicalView",
233+
"MaterializedView",
234+
"ModifyColumnFamiliesRequest",
235+
"OperationProgress",
236+
"OptimizeRestoredTableMetadata",
237+
"PartialUpdateClusterMetadata",
238+
"PartialUpdateClusterRequest",
239+
"PartialUpdateInstanceRequest",
240+
"ProtoSchema",
241+
"RestoreInfo",
242+
"RestoreSourceType",
243+
"RestoreTableMetadata",
244+
"RestoreTableRequest",
245+
"SchemaBundle",
246+
"Snapshot",
247+
"SnapshotTableMetadata",
248+
"SnapshotTableRequest",
249+
"StandardReadRemoteWrites",
250+
"StorageType",
251+
"Table",
252+
"Type",
253+
"UndeleteTableMetadata",
254+
"UndeleteTableRequest",
255+
"UpdateAppProfileMetadata",
256+
"UpdateAppProfileRequest",
257+
"UpdateAuthorizedViewMetadata",
258+
"UpdateAuthorizedViewRequest",
259+
"UpdateBackupRequest",
260+
"UpdateClusterMetadata",
261+
"UpdateInstanceMetadata",
262+
"UpdateLogicalViewMetadata",
263+
"UpdateLogicalViewRequest",
264+
"UpdateMaterializedViewMetadata",
265+
"UpdateMaterializedViewRequest",
266+
"UpdateSchemaBundleMetadata",
267+
"UpdateSchemaBundleRequest",
268+
"UpdateTableMetadata",
269+
"UpdateTableRequest",
270+
)
271+
272+
from .overlay import * # noqa: F403
273+
274+
__all__ += overlay.__all__ # noqa: F405

google/cloud/bigtable_admin_v2/gapic_metadata.json renamed to google/cloud/bigtable/admin/gapic_metadata.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"comment": "This file maps proto services/RPCs to the corresponding library clients/methods",
33
"language": "python",
4-
"libraryPackage": "google.cloud.bigtable_admin_v2",
4+
"libraryPackage": "google.cloud.bigtable.admin",
55
"protoPackage": "google.bigtable.admin.v2",
66
"schema": "1.0",
77
"services": {

google/cloud/bigtable_admin/gapic_version.py renamed to google/cloud/bigtable/admin/gapic_version.py

File renamed without changes.

google/cloud/bigtable_admin_v2/overlay/__init__.py renamed to google/cloud/bigtable/admin/overlay/__init__.py

File renamed without changes.

google/cloud/bigtable_admin_v2/overlay/services/__init__.py renamed to google/cloud/bigtable/admin/overlay/services/__init__.py

File renamed without changes.

0 commit comments

Comments
 (0)