google-cloud-bigtable 2.30.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- google/cloud/bigtable/__init__.py +25 -0
- google/cloud/bigtable/app_profile.py +377 -0
- google/cloud/bigtable/backup.py +490 -0
- google/cloud/bigtable/batcher.py +414 -0
- google/cloud/bigtable/client.py +475 -0
- google/cloud/bigtable/cluster.py +541 -0
- google/cloud/bigtable/column_family.py +362 -0
- google/cloud/bigtable/data/__init__.py +103 -0
- google/cloud/bigtable/data/_async/__init__.py +25 -0
- google/cloud/bigtable/data/_async/_mutate_rows.py +226 -0
- google/cloud/bigtable/data/_async/_read_rows.py +363 -0
- google/cloud/bigtable/data/_async/client.py +1522 -0
- google/cloud/bigtable/data/_async/mutations_batcher.py +534 -0
- google/cloud/bigtable/data/_cross_sync/__init__.py +20 -0
- google/cloud/bigtable/data/_cross_sync/_decorators.py +441 -0
- google/cloud/bigtable/data/_cross_sync/_mapping_meta.py +64 -0
- google/cloud/bigtable/data/_cross_sync/cross_sync.py +334 -0
- google/cloud/bigtable/data/_helpers.py +249 -0
- google/cloud/bigtable/data/_sync_autogen/_mutate_rows.py +182 -0
- google/cloud/bigtable/data/_sync_autogen/_read_rows.py +304 -0
- google/cloud/bigtable/data/_sync_autogen/client.py +1293 -0
- google/cloud/bigtable/data/_sync_autogen/mutations_batcher.py +449 -0
- google/cloud/bigtable/data/exceptions.py +340 -0
- google/cloud/bigtable/data/execute_query/__init__.py +43 -0
- google/cloud/bigtable/data/execute_query/_async/__init__.py +13 -0
- google/cloud/bigtable/data/execute_query/_async/execute_query_iterator.py +291 -0
- google/cloud/bigtable/data/execute_query/_byte_cursor.py +123 -0
- google/cloud/bigtable/data/execute_query/_checksum.py +43 -0
- google/cloud/bigtable/data/execute_query/_parameters_formatting.py +155 -0
- google/cloud/bigtable/data/execute_query/_query_result_parsing_utils.py +134 -0
- google/cloud/bigtable/data/execute_query/_reader.py +122 -0
- google/cloud/bigtable/data/execute_query/_sync_autogen/execute_query_iterator.py +239 -0
- google/cloud/bigtable/data/execute_query/metadata.py +399 -0
- google/cloud/bigtable/data/execute_query/values.py +123 -0
- google/cloud/bigtable/data/mutations.py +380 -0
- google/cloud/bigtable/data/read_modify_write_rules.py +112 -0
- google/cloud/bigtable/data/read_rows_query.py +536 -0
- google/cloud/bigtable/data/row.py +535 -0
- google/cloud/bigtable/data/row_filters.py +968 -0
- google/cloud/bigtable/encryption_info.py +64 -0
- google/cloud/bigtable/enums.py +223 -0
- google/cloud/bigtable/error.py +64 -0
- google/cloud/bigtable/gapic_version.py +16 -0
- google/cloud/bigtable/helpers.py +31 -0
- google/cloud/bigtable/instance.py +789 -0
- google/cloud/bigtable/policy.py +255 -0
- google/cloud/bigtable/row.py +1267 -0
- google/cloud/bigtable/row_data.py +380 -0
- google/cloud/bigtable/row_filters.py +838 -0
- google/cloud/bigtable/row_merger.py +250 -0
- google/cloud/bigtable/row_set.py +213 -0
- google/cloud/bigtable/table.py +1409 -0
- google/cloud/bigtable_admin/__init__.py +410 -0
- google/cloud/bigtable_admin/gapic_version.py +16 -0
- google/cloud/bigtable_admin/py.typed +2 -0
- google/cloud/bigtable_admin_v2/__init__.py +250 -0
- google/cloud/bigtable_admin_v2/gapic_metadata.json +962 -0
- google/cloud/bigtable_admin_v2/gapic_version.py +16 -0
- google/cloud/bigtable_admin_v2/py.typed +2 -0
- google/cloud/bigtable_admin_v2/services/__init__.py +15 -0
- google/cloud/bigtable_admin_v2/services/bigtable_instance_admin/__init__.py +22 -0
- google/cloud/bigtable_admin_v2/services/bigtable_instance_admin/async_client.py +3465 -0
- google/cloud/bigtable_admin_v2/services/bigtable_instance_admin/client.py +3944 -0
- google/cloud/bigtable_admin_v2/services/bigtable_instance_admin/pagers.py +681 -0
- google/cloud/bigtable_admin_v2/services/bigtable_instance_admin/transports/__init__.py +40 -0
- google/cloud/bigtable_admin_v2/services/bigtable_instance_admin/transports/base.py +751 -0
- google/cloud/bigtable_admin_v2/services/bigtable_instance_admin/transports/grpc.py +1249 -0
- google/cloud/bigtable_admin_v2/services/bigtable_instance_admin/transports/grpc_asyncio.py +1579 -0
- google/cloud/bigtable_admin_v2/services/bigtable_instance_admin/transports/rest.py +6820 -0
- google/cloud/bigtable_admin_v2/services/bigtable_instance_admin/transports/rest_base.py +1746 -0
- google/cloud/bigtable_admin_v2/services/bigtable_table_admin/__init__.py +22 -0
- google/cloud/bigtable_admin_v2/services/bigtable_table_admin/async_client.py +3472 -0
- google/cloud/bigtable_admin_v2/services/bigtable_table_admin/client.py +3949 -0
- google/cloud/bigtable_admin_v2/services/bigtable_table_admin/pagers.py +669 -0
- google/cloud/bigtable_admin_v2/services/bigtable_table_admin/transports/__init__.py +40 -0
- google/cloud/bigtable_admin_v2/services/bigtable_table_admin/transports/base.py +708 -0
- google/cloud/bigtable_admin_v2/services/bigtable_table_admin/transports/grpc.py +1257 -0
- google/cloud/bigtable_admin_v2/services/bigtable_table_admin/transports/grpc_asyncio.py +1549 -0
- google/cloud/bigtable_admin_v2/services/bigtable_table_admin/transports/rest.py +6609 -0
- google/cloud/bigtable_admin_v2/services/bigtable_table_admin/transports/rest_base.py +1714 -0
- google/cloud/bigtable_admin_v2/types/__init__.py +248 -0
- google/cloud/bigtable_admin_v2/types/bigtable_instance_admin.py +1364 -0
- google/cloud/bigtable_admin_v2/types/bigtable_table_admin.py +1715 -0
- google/cloud/bigtable_admin_v2/types/common.py +81 -0
- google/cloud/bigtable_admin_v2/types/instance.py +819 -0
- google/cloud/bigtable_admin_v2/types/table.py +1028 -0
- google/cloud/bigtable_admin_v2/types/types.py +776 -0
- google/cloud/bigtable_v2/__init__.py +136 -0
- google/cloud/bigtable_v2/gapic_metadata.json +193 -0
- google/cloud/bigtable_v2/gapic_version.py +16 -0
- google/cloud/bigtable_v2/py.typed +2 -0
- google/cloud/bigtable_v2/services/__init__.py +15 -0
- google/cloud/bigtable_v2/services/bigtable/__init__.py +22 -0
- google/cloud/bigtable_v2/services/bigtable/async_client.py +1741 -0
- google/cloud/bigtable_v2/services/bigtable/client.py +2194 -0
- google/cloud/bigtable_v2/services/bigtable/transports/__init__.py +38 -0
- google/cloud/bigtable_v2/services/bigtable/transports/base.py +343 -0
- google/cloud/bigtable_v2/services/bigtable/transports/grpc.py +660 -0
- google/cloud/bigtable_v2/services/bigtable/transports/grpc_asyncio.py +762 -0
- google/cloud/bigtable_v2/services/bigtable/transports/rest.py +2489 -0
- google/cloud/bigtable_v2/services/bigtable/transports/rest_base.py +711 -0
- google/cloud/bigtable_v2/types/__init__.py +138 -0
- google/cloud/bigtable_v2/types/bigtable.py +1531 -0
- google/cloud/bigtable_v2/types/data.py +1612 -0
- google/cloud/bigtable_v2/types/feature_flags.py +119 -0
- google/cloud/bigtable_v2/types/request_stats.py +171 -0
- google/cloud/bigtable_v2/types/response_params.py +64 -0
- google/cloud/bigtable_v2/types/types.py +579 -0
- google_cloud_bigtable-2.30.0.data/scripts/fixup_bigtable_admin_v2_keywords.py +233 -0
- google_cloud_bigtable-2.30.0.data/scripts/fixup_bigtable_v2_keywords.py +186 -0
- google_cloud_bigtable-2.30.0.dist-info/LICENSE +202 -0
- google_cloud_bigtable-2.30.0.dist-info/METADATA +154 -0
- google_cloud_bigtable-2.30.0.dist-info/RECORD +115 -0
- google_cloud_bigtable-2.30.0.dist-info/WHEEL +5 -0
- google_cloud_bigtable-2.30.0.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,1715 @@
|
|
|
1
|
+
# -*- coding: utf-8 -*-
|
|
2
|
+
# Copyright 2024 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 __future__ import annotations
|
|
17
|
+
|
|
18
|
+
from typing import MutableMapping, MutableSequence
|
|
19
|
+
|
|
20
|
+
import proto # type: ignore
|
|
21
|
+
|
|
22
|
+
from google.cloud.bigtable_admin_v2.types import common
|
|
23
|
+
from google.cloud.bigtable_admin_v2.types import table as gba_table
|
|
24
|
+
from google.protobuf import duration_pb2 # type: ignore
|
|
25
|
+
from google.protobuf import field_mask_pb2 # type: ignore
|
|
26
|
+
from google.protobuf import timestamp_pb2 # type: ignore
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
__protobuf__ = proto.module(
|
|
30
|
+
package="google.bigtable.admin.v2",
|
|
31
|
+
manifest={
|
|
32
|
+
"RestoreTableRequest",
|
|
33
|
+
"RestoreTableMetadata",
|
|
34
|
+
"OptimizeRestoredTableMetadata",
|
|
35
|
+
"CreateTableRequest",
|
|
36
|
+
"CreateTableFromSnapshotRequest",
|
|
37
|
+
"DropRowRangeRequest",
|
|
38
|
+
"ListTablesRequest",
|
|
39
|
+
"ListTablesResponse",
|
|
40
|
+
"GetTableRequest",
|
|
41
|
+
"UpdateTableRequest",
|
|
42
|
+
"UpdateTableMetadata",
|
|
43
|
+
"DeleteTableRequest",
|
|
44
|
+
"UndeleteTableRequest",
|
|
45
|
+
"UndeleteTableMetadata",
|
|
46
|
+
"ModifyColumnFamiliesRequest",
|
|
47
|
+
"GenerateConsistencyTokenRequest",
|
|
48
|
+
"GenerateConsistencyTokenResponse",
|
|
49
|
+
"CheckConsistencyRequest",
|
|
50
|
+
"StandardReadRemoteWrites",
|
|
51
|
+
"DataBoostReadLocalWrites",
|
|
52
|
+
"CheckConsistencyResponse",
|
|
53
|
+
"SnapshotTableRequest",
|
|
54
|
+
"GetSnapshotRequest",
|
|
55
|
+
"ListSnapshotsRequest",
|
|
56
|
+
"ListSnapshotsResponse",
|
|
57
|
+
"DeleteSnapshotRequest",
|
|
58
|
+
"SnapshotTableMetadata",
|
|
59
|
+
"CreateTableFromSnapshotMetadata",
|
|
60
|
+
"CreateBackupRequest",
|
|
61
|
+
"CreateBackupMetadata",
|
|
62
|
+
"UpdateBackupRequest",
|
|
63
|
+
"GetBackupRequest",
|
|
64
|
+
"DeleteBackupRequest",
|
|
65
|
+
"ListBackupsRequest",
|
|
66
|
+
"ListBackupsResponse",
|
|
67
|
+
"CopyBackupRequest",
|
|
68
|
+
"CopyBackupMetadata",
|
|
69
|
+
"CreateAuthorizedViewRequest",
|
|
70
|
+
"CreateAuthorizedViewMetadata",
|
|
71
|
+
"ListAuthorizedViewsRequest",
|
|
72
|
+
"ListAuthorizedViewsResponse",
|
|
73
|
+
"GetAuthorizedViewRequest",
|
|
74
|
+
"UpdateAuthorizedViewRequest",
|
|
75
|
+
"UpdateAuthorizedViewMetadata",
|
|
76
|
+
"DeleteAuthorizedViewRequest",
|
|
77
|
+
},
|
|
78
|
+
)
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
class RestoreTableRequest(proto.Message):
|
|
82
|
+
r"""The request for
|
|
83
|
+
[RestoreTable][google.bigtable.admin.v2.BigtableTableAdmin.RestoreTable].
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
|
|
87
|
+
|
|
88
|
+
Attributes:
|
|
89
|
+
parent (str):
|
|
90
|
+
Required. The name of the instance in which to create the
|
|
91
|
+
restored table. Values are of the form
|
|
92
|
+
``projects/<project>/instances/<instance>``.
|
|
93
|
+
table_id (str):
|
|
94
|
+
Required. The id of the table to create and restore to. This
|
|
95
|
+
table must not already exist. The ``table_id`` appended to
|
|
96
|
+
``parent`` forms the full table name of the form
|
|
97
|
+
``projects/<project>/instances/<instance>/tables/<table_id>``.
|
|
98
|
+
backup (str):
|
|
99
|
+
Name of the backup from which to restore. Values are of the
|
|
100
|
+
form
|
|
101
|
+
``projects/<project>/instances/<instance>/clusters/<cluster>/backups/<backup>``.
|
|
102
|
+
|
|
103
|
+
This field is a member of `oneof`_ ``source``.
|
|
104
|
+
"""
|
|
105
|
+
|
|
106
|
+
parent: str = proto.Field(
|
|
107
|
+
proto.STRING,
|
|
108
|
+
number=1,
|
|
109
|
+
)
|
|
110
|
+
table_id: str = proto.Field(
|
|
111
|
+
proto.STRING,
|
|
112
|
+
number=2,
|
|
113
|
+
)
|
|
114
|
+
backup: str = proto.Field(
|
|
115
|
+
proto.STRING,
|
|
116
|
+
number=3,
|
|
117
|
+
oneof="source",
|
|
118
|
+
)
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
class RestoreTableMetadata(proto.Message):
|
|
122
|
+
r"""Metadata type for the long-running operation returned by
|
|
123
|
+
[RestoreTable][google.bigtable.admin.v2.BigtableTableAdmin.RestoreTable].
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
|
|
127
|
+
|
|
128
|
+
Attributes:
|
|
129
|
+
name (str):
|
|
130
|
+
Name of the table being created and restored
|
|
131
|
+
to.
|
|
132
|
+
source_type (google.cloud.bigtable_admin_v2.types.RestoreSourceType):
|
|
133
|
+
The type of the restore source.
|
|
134
|
+
backup_info (google.cloud.bigtable_admin_v2.types.BackupInfo):
|
|
135
|
+
|
|
136
|
+
This field is a member of `oneof`_ ``source_info``.
|
|
137
|
+
optimize_table_operation_name (str):
|
|
138
|
+
If exists, the name of the long-running operation that will
|
|
139
|
+
be used to track the post-restore optimization process to
|
|
140
|
+
optimize the performance of the restored table. The metadata
|
|
141
|
+
type of the long-running operation is
|
|
142
|
+
[OptimizeRestoreTableMetadata][]. The response type is
|
|
143
|
+
[Empty][google.protobuf.Empty]. This long-running operation
|
|
144
|
+
may be automatically created by the system if applicable
|
|
145
|
+
after the RestoreTable long-running operation completes
|
|
146
|
+
successfully. This operation may not be created if the table
|
|
147
|
+
is already optimized or the restore was not successful.
|
|
148
|
+
progress (google.cloud.bigtable_admin_v2.types.OperationProgress):
|
|
149
|
+
The progress of the
|
|
150
|
+
[RestoreTable][google.bigtable.admin.v2.BigtableTableAdmin.RestoreTable]
|
|
151
|
+
operation.
|
|
152
|
+
"""
|
|
153
|
+
|
|
154
|
+
name: str = proto.Field(
|
|
155
|
+
proto.STRING,
|
|
156
|
+
number=1,
|
|
157
|
+
)
|
|
158
|
+
source_type: gba_table.RestoreSourceType = proto.Field(
|
|
159
|
+
proto.ENUM,
|
|
160
|
+
number=2,
|
|
161
|
+
enum=gba_table.RestoreSourceType,
|
|
162
|
+
)
|
|
163
|
+
backup_info: gba_table.BackupInfo = proto.Field(
|
|
164
|
+
proto.MESSAGE,
|
|
165
|
+
number=3,
|
|
166
|
+
oneof="source_info",
|
|
167
|
+
message=gba_table.BackupInfo,
|
|
168
|
+
)
|
|
169
|
+
optimize_table_operation_name: str = proto.Field(
|
|
170
|
+
proto.STRING,
|
|
171
|
+
number=4,
|
|
172
|
+
)
|
|
173
|
+
progress: common.OperationProgress = proto.Field(
|
|
174
|
+
proto.MESSAGE,
|
|
175
|
+
number=5,
|
|
176
|
+
message=common.OperationProgress,
|
|
177
|
+
)
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
class OptimizeRestoredTableMetadata(proto.Message):
|
|
181
|
+
r"""Metadata type for the long-running operation used to track
|
|
182
|
+
the progress of optimizations performed on a newly restored
|
|
183
|
+
table. This long-running operation is automatically created by
|
|
184
|
+
the system after the successful completion of a table restore,
|
|
185
|
+
and cannot be cancelled.
|
|
186
|
+
|
|
187
|
+
Attributes:
|
|
188
|
+
name (str):
|
|
189
|
+
Name of the restored table being optimized.
|
|
190
|
+
progress (google.cloud.bigtable_admin_v2.types.OperationProgress):
|
|
191
|
+
The progress of the post-restore
|
|
192
|
+
optimizations.
|
|
193
|
+
"""
|
|
194
|
+
|
|
195
|
+
name: str = proto.Field(
|
|
196
|
+
proto.STRING,
|
|
197
|
+
number=1,
|
|
198
|
+
)
|
|
199
|
+
progress: common.OperationProgress = proto.Field(
|
|
200
|
+
proto.MESSAGE,
|
|
201
|
+
number=2,
|
|
202
|
+
message=common.OperationProgress,
|
|
203
|
+
)
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
class CreateTableRequest(proto.Message):
|
|
207
|
+
r"""Request message for
|
|
208
|
+
[google.bigtable.admin.v2.BigtableTableAdmin.CreateTable][google.bigtable.admin.v2.BigtableTableAdmin.CreateTable]
|
|
209
|
+
|
|
210
|
+
Attributes:
|
|
211
|
+
parent (str):
|
|
212
|
+
Required. The unique name of the instance in which to create
|
|
213
|
+
the table. Values are of the form
|
|
214
|
+
``projects/{project}/instances/{instance}``.
|
|
215
|
+
table_id (str):
|
|
216
|
+
Required. The name by which the new table should be referred
|
|
217
|
+
to within the parent instance, e.g., ``foobar`` rather than
|
|
218
|
+
``{parent}/tables/foobar``. Maximum 50 characters.
|
|
219
|
+
table (google.cloud.bigtable_admin_v2.types.Table):
|
|
220
|
+
Required. The Table to create.
|
|
221
|
+
initial_splits (MutableSequence[google.cloud.bigtable_admin_v2.types.CreateTableRequest.Split]):
|
|
222
|
+
The optional list of row keys that will be used to initially
|
|
223
|
+
split the table into several tablets (tablets are similar to
|
|
224
|
+
HBase regions). Given two split keys, ``s1`` and ``s2``,
|
|
225
|
+
three tablets will be created, spanning the key ranges:
|
|
226
|
+
``[, s1), [s1, s2), [s2, )``.
|
|
227
|
+
|
|
228
|
+
Example:
|
|
229
|
+
|
|
230
|
+
- Row keys :=
|
|
231
|
+
``["a", "apple", "custom", "customer_1", "customer_2",``
|
|
232
|
+
``"other", "zz"]``
|
|
233
|
+
- initial_split_keys :=
|
|
234
|
+
``["apple", "customer_1", "customer_2", "other"]``
|
|
235
|
+
- Key assignment:
|
|
236
|
+
|
|
237
|
+
- Tablet 1 ``[, apple) => {"a"}.``
|
|
238
|
+
- Tablet 2
|
|
239
|
+
``[apple, customer_1) => {"apple", "custom"}.``
|
|
240
|
+
- Tablet 3
|
|
241
|
+
``[customer_1, customer_2) => {"customer_1"}.``
|
|
242
|
+
- Tablet 4 ``[customer_2, other) => {"customer_2"}.``
|
|
243
|
+
- Tablet 5 ``[other, ) => {"other", "zz"}.``
|
|
244
|
+
"""
|
|
245
|
+
|
|
246
|
+
class Split(proto.Message):
|
|
247
|
+
r"""An initial split point for a newly created table.
|
|
248
|
+
|
|
249
|
+
Attributes:
|
|
250
|
+
key (bytes):
|
|
251
|
+
Row key to use as an initial tablet boundary.
|
|
252
|
+
"""
|
|
253
|
+
|
|
254
|
+
key: bytes = proto.Field(
|
|
255
|
+
proto.BYTES,
|
|
256
|
+
number=1,
|
|
257
|
+
)
|
|
258
|
+
|
|
259
|
+
parent: str = proto.Field(
|
|
260
|
+
proto.STRING,
|
|
261
|
+
number=1,
|
|
262
|
+
)
|
|
263
|
+
table_id: str = proto.Field(
|
|
264
|
+
proto.STRING,
|
|
265
|
+
number=2,
|
|
266
|
+
)
|
|
267
|
+
table: gba_table.Table = proto.Field(
|
|
268
|
+
proto.MESSAGE,
|
|
269
|
+
number=3,
|
|
270
|
+
message=gba_table.Table,
|
|
271
|
+
)
|
|
272
|
+
initial_splits: MutableSequence[Split] = proto.RepeatedField(
|
|
273
|
+
proto.MESSAGE,
|
|
274
|
+
number=4,
|
|
275
|
+
message=Split,
|
|
276
|
+
)
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
class CreateTableFromSnapshotRequest(proto.Message):
|
|
280
|
+
r"""Request message for
|
|
281
|
+
[google.bigtable.admin.v2.BigtableTableAdmin.CreateTableFromSnapshot][google.bigtable.admin.v2.BigtableTableAdmin.CreateTableFromSnapshot]
|
|
282
|
+
|
|
283
|
+
Note: This is a private alpha release of Cloud Bigtable snapshots.
|
|
284
|
+
This feature is not currently available to most Cloud Bigtable
|
|
285
|
+
customers. This feature might be changed in backward-incompatible
|
|
286
|
+
ways and is not recommended for production use. It is not subject to
|
|
287
|
+
any SLA or deprecation policy.
|
|
288
|
+
|
|
289
|
+
Attributes:
|
|
290
|
+
parent (str):
|
|
291
|
+
Required. The unique name of the instance in which to create
|
|
292
|
+
the table. Values are of the form
|
|
293
|
+
``projects/{project}/instances/{instance}``.
|
|
294
|
+
table_id (str):
|
|
295
|
+
Required. The name by which the new table should be referred
|
|
296
|
+
to within the parent instance, e.g., ``foobar`` rather than
|
|
297
|
+
``{parent}/tables/foobar``.
|
|
298
|
+
source_snapshot (str):
|
|
299
|
+
Required. The unique name of the snapshot from which to
|
|
300
|
+
restore the table. The snapshot and the table must be in the
|
|
301
|
+
same instance. Values are of the form
|
|
302
|
+
``projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}``.
|
|
303
|
+
"""
|
|
304
|
+
|
|
305
|
+
parent: str = proto.Field(
|
|
306
|
+
proto.STRING,
|
|
307
|
+
number=1,
|
|
308
|
+
)
|
|
309
|
+
table_id: str = proto.Field(
|
|
310
|
+
proto.STRING,
|
|
311
|
+
number=2,
|
|
312
|
+
)
|
|
313
|
+
source_snapshot: str = proto.Field(
|
|
314
|
+
proto.STRING,
|
|
315
|
+
number=3,
|
|
316
|
+
)
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
class DropRowRangeRequest(proto.Message):
|
|
320
|
+
r"""Request message for
|
|
321
|
+
[google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange][google.bigtable.admin.v2.BigtableTableAdmin.DropRowRange]
|
|
322
|
+
|
|
323
|
+
This message has `oneof`_ fields (mutually exclusive fields).
|
|
324
|
+
For each oneof, at most one member field can be set at the same time.
|
|
325
|
+
Setting any member of the oneof automatically clears all other
|
|
326
|
+
members.
|
|
327
|
+
|
|
328
|
+
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
|
|
329
|
+
|
|
330
|
+
Attributes:
|
|
331
|
+
name (str):
|
|
332
|
+
Required. The unique name of the table on which to drop a
|
|
333
|
+
range of rows. Values are of the form
|
|
334
|
+
``projects/{project}/instances/{instance}/tables/{table}``.
|
|
335
|
+
row_key_prefix (bytes):
|
|
336
|
+
Delete all rows that start with this row key
|
|
337
|
+
prefix. Prefix cannot be zero length.
|
|
338
|
+
|
|
339
|
+
This field is a member of `oneof`_ ``target``.
|
|
340
|
+
delete_all_data_from_table (bool):
|
|
341
|
+
Delete all rows in the table. Setting this to
|
|
342
|
+
false is a no-op.
|
|
343
|
+
|
|
344
|
+
This field is a member of `oneof`_ ``target``.
|
|
345
|
+
"""
|
|
346
|
+
|
|
347
|
+
name: str = proto.Field(
|
|
348
|
+
proto.STRING,
|
|
349
|
+
number=1,
|
|
350
|
+
)
|
|
351
|
+
row_key_prefix: bytes = proto.Field(
|
|
352
|
+
proto.BYTES,
|
|
353
|
+
number=2,
|
|
354
|
+
oneof="target",
|
|
355
|
+
)
|
|
356
|
+
delete_all_data_from_table: bool = proto.Field(
|
|
357
|
+
proto.BOOL,
|
|
358
|
+
number=3,
|
|
359
|
+
oneof="target",
|
|
360
|
+
)
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
class ListTablesRequest(proto.Message):
|
|
364
|
+
r"""Request message for
|
|
365
|
+
[google.bigtable.admin.v2.BigtableTableAdmin.ListTables][google.bigtable.admin.v2.BigtableTableAdmin.ListTables]
|
|
366
|
+
|
|
367
|
+
Attributes:
|
|
368
|
+
parent (str):
|
|
369
|
+
Required. The unique name of the instance for which tables
|
|
370
|
+
should be listed. Values are of the form
|
|
371
|
+
``projects/{project}/instances/{instance}``.
|
|
372
|
+
view (google.cloud.bigtable_admin_v2.types.Table.View):
|
|
373
|
+
The view to be applied to the returned tables' fields.
|
|
374
|
+
NAME_ONLY view (default) and REPLICATION_VIEW are supported.
|
|
375
|
+
page_size (int):
|
|
376
|
+
Maximum number of results per page.
|
|
377
|
+
|
|
378
|
+
A page_size of zero lets the server choose the number of
|
|
379
|
+
items to return. A page_size which is strictly positive will
|
|
380
|
+
return at most that many items. A negative page_size will
|
|
381
|
+
cause an error.
|
|
382
|
+
|
|
383
|
+
Following the first request, subsequent paginated calls are
|
|
384
|
+
not required to pass a page_size. If a page_size is set in
|
|
385
|
+
subsequent calls, it must match the page_size given in the
|
|
386
|
+
first request.
|
|
387
|
+
page_token (str):
|
|
388
|
+
The value of ``next_page_token`` returned by a previous
|
|
389
|
+
call.
|
|
390
|
+
"""
|
|
391
|
+
|
|
392
|
+
parent: str = proto.Field(
|
|
393
|
+
proto.STRING,
|
|
394
|
+
number=1,
|
|
395
|
+
)
|
|
396
|
+
view: gba_table.Table.View = proto.Field(
|
|
397
|
+
proto.ENUM,
|
|
398
|
+
number=2,
|
|
399
|
+
enum=gba_table.Table.View,
|
|
400
|
+
)
|
|
401
|
+
page_size: int = proto.Field(
|
|
402
|
+
proto.INT32,
|
|
403
|
+
number=4,
|
|
404
|
+
)
|
|
405
|
+
page_token: str = proto.Field(
|
|
406
|
+
proto.STRING,
|
|
407
|
+
number=3,
|
|
408
|
+
)
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
class ListTablesResponse(proto.Message):
|
|
412
|
+
r"""Response message for
|
|
413
|
+
[google.bigtable.admin.v2.BigtableTableAdmin.ListTables][google.bigtable.admin.v2.BigtableTableAdmin.ListTables]
|
|
414
|
+
|
|
415
|
+
Attributes:
|
|
416
|
+
tables (MutableSequence[google.cloud.bigtable_admin_v2.types.Table]):
|
|
417
|
+
The tables present in the requested instance.
|
|
418
|
+
next_page_token (str):
|
|
419
|
+
Set if not all tables could be returned in a single
|
|
420
|
+
response. Pass this value to ``page_token`` in another
|
|
421
|
+
request to get the next page of results.
|
|
422
|
+
"""
|
|
423
|
+
|
|
424
|
+
@property
|
|
425
|
+
def raw_page(self):
|
|
426
|
+
return self
|
|
427
|
+
|
|
428
|
+
tables: MutableSequence[gba_table.Table] = proto.RepeatedField(
|
|
429
|
+
proto.MESSAGE,
|
|
430
|
+
number=1,
|
|
431
|
+
message=gba_table.Table,
|
|
432
|
+
)
|
|
433
|
+
next_page_token: str = proto.Field(
|
|
434
|
+
proto.STRING,
|
|
435
|
+
number=2,
|
|
436
|
+
)
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
class GetTableRequest(proto.Message):
|
|
440
|
+
r"""Request message for
|
|
441
|
+
[google.bigtable.admin.v2.BigtableTableAdmin.GetTable][google.bigtable.admin.v2.BigtableTableAdmin.GetTable]
|
|
442
|
+
|
|
443
|
+
Attributes:
|
|
444
|
+
name (str):
|
|
445
|
+
Required. The unique name of the requested table. Values are
|
|
446
|
+
of the form
|
|
447
|
+
``projects/{project}/instances/{instance}/tables/{table}``.
|
|
448
|
+
view (google.cloud.bigtable_admin_v2.types.Table.View):
|
|
449
|
+
The view to be applied to the returned table's fields.
|
|
450
|
+
Defaults to ``SCHEMA_VIEW`` if unspecified.
|
|
451
|
+
"""
|
|
452
|
+
|
|
453
|
+
name: str = proto.Field(
|
|
454
|
+
proto.STRING,
|
|
455
|
+
number=1,
|
|
456
|
+
)
|
|
457
|
+
view: gba_table.Table.View = proto.Field(
|
|
458
|
+
proto.ENUM,
|
|
459
|
+
number=2,
|
|
460
|
+
enum=gba_table.Table.View,
|
|
461
|
+
)
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
class UpdateTableRequest(proto.Message):
|
|
465
|
+
r"""The request for
|
|
466
|
+
[UpdateTable][google.bigtable.admin.v2.BigtableTableAdmin.UpdateTable].
|
|
467
|
+
|
|
468
|
+
Attributes:
|
|
469
|
+
table (google.cloud.bigtable_admin_v2.types.Table):
|
|
470
|
+
Required. The table to update. The table's ``name`` field is
|
|
471
|
+
used to identify the table to update.
|
|
472
|
+
update_mask (google.protobuf.field_mask_pb2.FieldMask):
|
|
473
|
+
Required. The list of fields to update. A mask specifying
|
|
474
|
+
which fields (e.g. ``change_stream_config``) in the
|
|
475
|
+
``table`` field should be updated. This mask is relative to
|
|
476
|
+
the ``table`` field, not to the request message. The
|
|
477
|
+
wildcard (*) path is currently not supported. Currently
|
|
478
|
+
UpdateTable is only supported for the following fields:
|
|
479
|
+
|
|
480
|
+
- ``change_stream_config``
|
|
481
|
+
- ``change_stream_config.retention_period``
|
|
482
|
+
- ``deletion_protection``
|
|
483
|
+
- ``row_key_schema``
|
|
484
|
+
|
|
485
|
+
If ``column_families`` is set in ``update_mask``, it will
|
|
486
|
+
return an UNIMPLEMENTED error.
|
|
487
|
+
ignore_warnings (bool):
|
|
488
|
+
Optional. If true, ignore safety checks when
|
|
489
|
+
updating the table.
|
|
490
|
+
"""
|
|
491
|
+
|
|
492
|
+
table: gba_table.Table = proto.Field(
|
|
493
|
+
proto.MESSAGE,
|
|
494
|
+
number=1,
|
|
495
|
+
message=gba_table.Table,
|
|
496
|
+
)
|
|
497
|
+
update_mask: field_mask_pb2.FieldMask = proto.Field(
|
|
498
|
+
proto.MESSAGE,
|
|
499
|
+
number=2,
|
|
500
|
+
message=field_mask_pb2.FieldMask,
|
|
501
|
+
)
|
|
502
|
+
ignore_warnings: bool = proto.Field(
|
|
503
|
+
proto.BOOL,
|
|
504
|
+
number=3,
|
|
505
|
+
)
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
class UpdateTableMetadata(proto.Message):
|
|
509
|
+
r"""Metadata type for the operation returned by
|
|
510
|
+
[UpdateTable][google.bigtable.admin.v2.BigtableTableAdmin.UpdateTable].
|
|
511
|
+
|
|
512
|
+
Attributes:
|
|
513
|
+
name (str):
|
|
514
|
+
The name of the table being updated.
|
|
515
|
+
start_time (google.protobuf.timestamp_pb2.Timestamp):
|
|
516
|
+
The time at which this operation started.
|
|
517
|
+
end_time (google.protobuf.timestamp_pb2.Timestamp):
|
|
518
|
+
If set, the time at which this operation
|
|
519
|
+
finished or was canceled.
|
|
520
|
+
"""
|
|
521
|
+
|
|
522
|
+
name: str = proto.Field(
|
|
523
|
+
proto.STRING,
|
|
524
|
+
number=1,
|
|
525
|
+
)
|
|
526
|
+
start_time: timestamp_pb2.Timestamp = proto.Field(
|
|
527
|
+
proto.MESSAGE,
|
|
528
|
+
number=2,
|
|
529
|
+
message=timestamp_pb2.Timestamp,
|
|
530
|
+
)
|
|
531
|
+
end_time: timestamp_pb2.Timestamp = proto.Field(
|
|
532
|
+
proto.MESSAGE,
|
|
533
|
+
number=3,
|
|
534
|
+
message=timestamp_pb2.Timestamp,
|
|
535
|
+
)
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
class DeleteTableRequest(proto.Message):
|
|
539
|
+
r"""Request message for
|
|
540
|
+
[google.bigtable.admin.v2.BigtableTableAdmin.DeleteTable][google.bigtable.admin.v2.BigtableTableAdmin.DeleteTable]
|
|
541
|
+
|
|
542
|
+
Attributes:
|
|
543
|
+
name (str):
|
|
544
|
+
Required. The unique name of the table to be deleted. Values
|
|
545
|
+
are of the form
|
|
546
|
+
``projects/{project}/instances/{instance}/tables/{table}``.
|
|
547
|
+
"""
|
|
548
|
+
|
|
549
|
+
name: str = proto.Field(
|
|
550
|
+
proto.STRING,
|
|
551
|
+
number=1,
|
|
552
|
+
)
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
class UndeleteTableRequest(proto.Message):
|
|
556
|
+
r"""Request message for
|
|
557
|
+
[google.bigtable.admin.v2.BigtableTableAdmin.UndeleteTable][google.bigtable.admin.v2.BigtableTableAdmin.UndeleteTable]
|
|
558
|
+
|
|
559
|
+
Attributes:
|
|
560
|
+
name (str):
|
|
561
|
+
Required. The unique name of the table to be restored.
|
|
562
|
+
Values are of the form
|
|
563
|
+
``projects/{project}/instances/{instance}/tables/{table}``.
|
|
564
|
+
"""
|
|
565
|
+
|
|
566
|
+
name: str = proto.Field(
|
|
567
|
+
proto.STRING,
|
|
568
|
+
number=1,
|
|
569
|
+
)
|
|
570
|
+
|
|
571
|
+
|
|
572
|
+
class UndeleteTableMetadata(proto.Message):
|
|
573
|
+
r"""Metadata type for the operation returned by
|
|
574
|
+
[google.bigtable.admin.v2.BigtableTableAdmin.UndeleteTable][google.bigtable.admin.v2.BigtableTableAdmin.UndeleteTable].
|
|
575
|
+
|
|
576
|
+
Attributes:
|
|
577
|
+
name (str):
|
|
578
|
+
The name of the table being restored.
|
|
579
|
+
start_time (google.protobuf.timestamp_pb2.Timestamp):
|
|
580
|
+
The time at which this operation started.
|
|
581
|
+
end_time (google.protobuf.timestamp_pb2.Timestamp):
|
|
582
|
+
If set, the time at which this operation
|
|
583
|
+
finished or was cancelled.
|
|
584
|
+
"""
|
|
585
|
+
|
|
586
|
+
name: str = proto.Field(
|
|
587
|
+
proto.STRING,
|
|
588
|
+
number=1,
|
|
589
|
+
)
|
|
590
|
+
start_time: timestamp_pb2.Timestamp = proto.Field(
|
|
591
|
+
proto.MESSAGE,
|
|
592
|
+
number=2,
|
|
593
|
+
message=timestamp_pb2.Timestamp,
|
|
594
|
+
)
|
|
595
|
+
end_time: timestamp_pb2.Timestamp = proto.Field(
|
|
596
|
+
proto.MESSAGE,
|
|
597
|
+
number=3,
|
|
598
|
+
message=timestamp_pb2.Timestamp,
|
|
599
|
+
)
|
|
600
|
+
|
|
601
|
+
|
|
602
|
+
class ModifyColumnFamiliesRequest(proto.Message):
|
|
603
|
+
r"""Request message for
|
|
604
|
+
[google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamilies][google.bigtable.admin.v2.BigtableTableAdmin.ModifyColumnFamilies]
|
|
605
|
+
|
|
606
|
+
Attributes:
|
|
607
|
+
name (str):
|
|
608
|
+
Required. The unique name of the table whose families should
|
|
609
|
+
be modified. Values are of the form
|
|
610
|
+
``projects/{project}/instances/{instance}/tables/{table}``.
|
|
611
|
+
modifications (MutableSequence[google.cloud.bigtable_admin_v2.types.ModifyColumnFamiliesRequest.Modification]):
|
|
612
|
+
Required. Modifications to be atomically
|
|
613
|
+
applied to the specified table's families.
|
|
614
|
+
Entries are applied in order, meaning that
|
|
615
|
+
earlier modifications can be masked by later
|
|
616
|
+
ones (in the case of repeated updates to the
|
|
617
|
+
same family, for example).
|
|
618
|
+
ignore_warnings (bool):
|
|
619
|
+
Optional. If true, ignore safety checks when
|
|
620
|
+
modifying the column families.
|
|
621
|
+
"""
|
|
622
|
+
|
|
623
|
+
class Modification(proto.Message):
|
|
624
|
+
r"""A create, update, or delete of a particular column family.
|
|
625
|
+
|
|
626
|
+
This message has `oneof`_ fields (mutually exclusive fields).
|
|
627
|
+
For each oneof, at most one member field can be set at the same time.
|
|
628
|
+
Setting any member of the oneof automatically clears all other
|
|
629
|
+
members.
|
|
630
|
+
|
|
631
|
+
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
|
|
632
|
+
|
|
633
|
+
Attributes:
|
|
634
|
+
id (str):
|
|
635
|
+
The ID of the column family to be modified.
|
|
636
|
+
create (google.cloud.bigtable_admin_v2.types.ColumnFamily):
|
|
637
|
+
Create a new column family with the specified
|
|
638
|
+
schema, or fail if one already exists with the
|
|
639
|
+
given ID.
|
|
640
|
+
|
|
641
|
+
This field is a member of `oneof`_ ``mod``.
|
|
642
|
+
update (google.cloud.bigtable_admin_v2.types.ColumnFamily):
|
|
643
|
+
Update an existing column family to the
|
|
644
|
+
specified schema, or fail if no column family
|
|
645
|
+
exists with the given ID.
|
|
646
|
+
|
|
647
|
+
This field is a member of `oneof`_ ``mod``.
|
|
648
|
+
drop (bool):
|
|
649
|
+
Drop (delete) the column family with the
|
|
650
|
+
given ID, or fail if no such family exists.
|
|
651
|
+
|
|
652
|
+
This field is a member of `oneof`_ ``mod``.
|
|
653
|
+
update_mask (google.protobuf.field_mask_pb2.FieldMask):
|
|
654
|
+
Optional. A mask specifying which fields (e.g. ``gc_rule``)
|
|
655
|
+
in the ``update`` mod should be updated, ignored for other
|
|
656
|
+
modification types. If unset or empty, we treat it as
|
|
657
|
+
updating ``gc_rule`` to be backward compatible.
|
|
658
|
+
"""
|
|
659
|
+
|
|
660
|
+
id: str = proto.Field(
|
|
661
|
+
proto.STRING,
|
|
662
|
+
number=1,
|
|
663
|
+
)
|
|
664
|
+
create: gba_table.ColumnFamily = proto.Field(
|
|
665
|
+
proto.MESSAGE,
|
|
666
|
+
number=2,
|
|
667
|
+
oneof="mod",
|
|
668
|
+
message=gba_table.ColumnFamily,
|
|
669
|
+
)
|
|
670
|
+
update: gba_table.ColumnFamily = proto.Field(
|
|
671
|
+
proto.MESSAGE,
|
|
672
|
+
number=3,
|
|
673
|
+
oneof="mod",
|
|
674
|
+
message=gba_table.ColumnFamily,
|
|
675
|
+
)
|
|
676
|
+
drop: bool = proto.Field(
|
|
677
|
+
proto.BOOL,
|
|
678
|
+
number=4,
|
|
679
|
+
oneof="mod",
|
|
680
|
+
)
|
|
681
|
+
update_mask: field_mask_pb2.FieldMask = proto.Field(
|
|
682
|
+
proto.MESSAGE,
|
|
683
|
+
number=6,
|
|
684
|
+
message=field_mask_pb2.FieldMask,
|
|
685
|
+
)
|
|
686
|
+
|
|
687
|
+
name: str = proto.Field(
|
|
688
|
+
proto.STRING,
|
|
689
|
+
number=1,
|
|
690
|
+
)
|
|
691
|
+
modifications: MutableSequence[Modification] = proto.RepeatedField(
|
|
692
|
+
proto.MESSAGE,
|
|
693
|
+
number=2,
|
|
694
|
+
message=Modification,
|
|
695
|
+
)
|
|
696
|
+
ignore_warnings: bool = proto.Field(
|
|
697
|
+
proto.BOOL,
|
|
698
|
+
number=3,
|
|
699
|
+
)
|
|
700
|
+
|
|
701
|
+
|
|
702
|
+
class GenerateConsistencyTokenRequest(proto.Message):
|
|
703
|
+
r"""Request message for
|
|
704
|
+
[google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken][google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken]
|
|
705
|
+
|
|
706
|
+
Attributes:
|
|
707
|
+
name (str):
|
|
708
|
+
Required. The unique name of the Table for which to create a
|
|
709
|
+
consistency token. Values are of the form
|
|
710
|
+
``projects/{project}/instances/{instance}/tables/{table}``.
|
|
711
|
+
"""
|
|
712
|
+
|
|
713
|
+
name: str = proto.Field(
|
|
714
|
+
proto.STRING,
|
|
715
|
+
number=1,
|
|
716
|
+
)
|
|
717
|
+
|
|
718
|
+
|
|
719
|
+
class GenerateConsistencyTokenResponse(proto.Message):
|
|
720
|
+
r"""Response message for
|
|
721
|
+
[google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken][google.bigtable.admin.v2.BigtableTableAdmin.GenerateConsistencyToken]
|
|
722
|
+
|
|
723
|
+
Attributes:
|
|
724
|
+
consistency_token (str):
|
|
725
|
+
The generated consistency token.
|
|
726
|
+
"""
|
|
727
|
+
|
|
728
|
+
consistency_token: str = proto.Field(
|
|
729
|
+
proto.STRING,
|
|
730
|
+
number=1,
|
|
731
|
+
)
|
|
732
|
+
|
|
733
|
+
|
|
734
|
+
class CheckConsistencyRequest(proto.Message):
|
|
735
|
+
r"""Request message for
|
|
736
|
+
[google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency][google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency]
|
|
737
|
+
|
|
738
|
+
This message has `oneof`_ fields (mutually exclusive fields).
|
|
739
|
+
For each oneof, at most one member field can be set at the same time.
|
|
740
|
+
Setting any member of the oneof automatically clears all other
|
|
741
|
+
members.
|
|
742
|
+
|
|
743
|
+
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
|
|
744
|
+
|
|
745
|
+
Attributes:
|
|
746
|
+
name (str):
|
|
747
|
+
Required. The unique name of the Table for which to check
|
|
748
|
+
replication consistency. Values are of the form
|
|
749
|
+
``projects/{project}/instances/{instance}/tables/{table}``.
|
|
750
|
+
consistency_token (str):
|
|
751
|
+
Required. The token created using
|
|
752
|
+
GenerateConsistencyToken for the Table.
|
|
753
|
+
standard_read_remote_writes (google.cloud.bigtable_admin_v2.types.StandardReadRemoteWrites):
|
|
754
|
+
Checks that reads using an app profile with
|
|
755
|
+
``StandardIsolation`` can see all writes committed before
|
|
756
|
+
the token was created, even if the read and write target
|
|
757
|
+
different clusters.
|
|
758
|
+
|
|
759
|
+
This field is a member of `oneof`_ ``mode``.
|
|
760
|
+
data_boost_read_local_writes (google.cloud.bigtable_admin_v2.types.DataBoostReadLocalWrites):
|
|
761
|
+
Checks that reads using an app profile with
|
|
762
|
+
``DataBoostIsolationReadOnly`` can see all writes committed
|
|
763
|
+
before the token was created, but only if the read and write
|
|
764
|
+
target the same cluster.
|
|
765
|
+
|
|
766
|
+
This field is a member of `oneof`_ ``mode``.
|
|
767
|
+
"""
|
|
768
|
+
|
|
769
|
+
name: str = proto.Field(
|
|
770
|
+
proto.STRING,
|
|
771
|
+
number=1,
|
|
772
|
+
)
|
|
773
|
+
consistency_token: str = proto.Field(
|
|
774
|
+
proto.STRING,
|
|
775
|
+
number=2,
|
|
776
|
+
)
|
|
777
|
+
standard_read_remote_writes: "StandardReadRemoteWrites" = proto.Field(
|
|
778
|
+
proto.MESSAGE,
|
|
779
|
+
number=3,
|
|
780
|
+
oneof="mode",
|
|
781
|
+
message="StandardReadRemoteWrites",
|
|
782
|
+
)
|
|
783
|
+
data_boost_read_local_writes: "DataBoostReadLocalWrites" = proto.Field(
|
|
784
|
+
proto.MESSAGE,
|
|
785
|
+
number=4,
|
|
786
|
+
oneof="mode",
|
|
787
|
+
message="DataBoostReadLocalWrites",
|
|
788
|
+
)
|
|
789
|
+
|
|
790
|
+
|
|
791
|
+
class StandardReadRemoteWrites(proto.Message):
|
|
792
|
+
r"""Checks that all writes before the consistency token was
|
|
793
|
+
generated are replicated in every cluster and readable.
|
|
794
|
+
|
|
795
|
+
"""
|
|
796
|
+
|
|
797
|
+
|
|
798
|
+
class DataBoostReadLocalWrites(proto.Message):
|
|
799
|
+
r"""Checks that all writes before the consistency token was
|
|
800
|
+
generated in the same cluster are readable by Databoost.
|
|
801
|
+
|
|
802
|
+
"""
|
|
803
|
+
|
|
804
|
+
|
|
805
|
+
class CheckConsistencyResponse(proto.Message):
|
|
806
|
+
r"""Response message for
|
|
807
|
+
[google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency][google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency]
|
|
808
|
+
|
|
809
|
+
Attributes:
|
|
810
|
+
consistent (bool):
|
|
811
|
+
True only if the token is consistent. A token
|
|
812
|
+
is consistent if replication has caught up with
|
|
813
|
+
the restrictions specified in the request.
|
|
814
|
+
"""
|
|
815
|
+
|
|
816
|
+
consistent: bool = proto.Field(
|
|
817
|
+
proto.BOOL,
|
|
818
|
+
number=1,
|
|
819
|
+
)
|
|
820
|
+
|
|
821
|
+
|
|
822
|
+
class SnapshotTableRequest(proto.Message):
|
|
823
|
+
r"""Request message for
|
|
824
|
+
[google.bigtable.admin.v2.BigtableTableAdmin.SnapshotTable][google.bigtable.admin.v2.BigtableTableAdmin.SnapshotTable]
|
|
825
|
+
|
|
826
|
+
Note: This is a private alpha release of Cloud Bigtable snapshots.
|
|
827
|
+
This feature is not currently available to most Cloud Bigtable
|
|
828
|
+
customers. This feature might be changed in backward-incompatible
|
|
829
|
+
ways and is not recommended for production use. It is not subject to
|
|
830
|
+
any SLA or deprecation policy.
|
|
831
|
+
|
|
832
|
+
Attributes:
|
|
833
|
+
name (str):
|
|
834
|
+
Required. The unique name of the table to have the snapshot
|
|
835
|
+
taken. Values are of the form
|
|
836
|
+
``projects/{project}/instances/{instance}/tables/{table}``.
|
|
837
|
+
cluster (str):
|
|
838
|
+
Required. The name of the cluster where the snapshot will be
|
|
839
|
+
created in. Values are of the form
|
|
840
|
+
``projects/{project}/instances/{instance}/clusters/{cluster}``.
|
|
841
|
+
snapshot_id (str):
|
|
842
|
+
Required. The ID by which the new snapshot should be
|
|
843
|
+
referred to within the parent cluster, e.g., ``mysnapshot``
|
|
844
|
+
of the form: ``[_a-zA-Z0-9][-_.a-zA-Z0-9]*`` rather than
|
|
845
|
+
``projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/mysnapshot``.
|
|
846
|
+
ttl (google.protobuf.duration_pb2.Duration):
|
|
847
|
+
The amount of time that the new snapshot can
|
|
848
|
+
stay active after it is created. Once 'ttl'
|
|
849
|
+
expires, the snapshot will get deleted. The
|
|
850
|
+
maximum amount of time a snapshot can stay
|
|
851
|
+
active is 7 days. If 'ttl' is not specified, the
|
|
852
|
+
default value of 24 hours will be used.
|
|
853
|
+
description (str):
|
|
854
|
+
Description of the snapshot.
|
|
855
|
+
"""
|
|
856
|
+
|
|
857
|
+
name: str = proto.Field(
|
|
858
|
+
proto.STRING,
|
|
859
|
+
number=1,
|
|
860
|
+
)
|
|
861
|
+
cluster: str = proto.Field(
|
|
862
|
+
proto.STRING,
|
|
863
|
+
number=2,
|
|
864
|
+
)
|
|
865
|
+
snapshot_id: str = proto.Field(
|
|
866
|
+
proto.STRING,
|
|
867
|
+
number=3,
|
|
868
|
+
)
|
|
869
|
+
ttl: duration_pb2.Duration = proto.Field(
|
|
870
|
+
proto.MESSAGE,
|
|
871
|
+
number=4,
|
|
872
|
+
message=duration_pb2.Duration,
|
|
873
|
+
)
|
|
874
|
+
description: str = proto.Field(
|
|
875
|
+
proto.STRING,
|
|
876
|
+
number=5,
|
|
877
|
+
)
|
|
878
|
+
|
|
879
|
+
|
|
880
|
+
class GetSnapshotRequest(proto.Message):
|
|
881
|
+
r"""Request message for
|
|
882
|
+
[google.bigtable.admin.v2.BigtableTableAdmin.GetSnapshot][google.bigtable.admin.v2.BigtableTableAdmin.GetSnapshot]
|
|
883
|
+
|
|
884
|
+
Note: This is a private alpha release of Cloud Bigtable snapshots.
|
|
885
|
+
This feature is not currently available to most Cloud Bigtable
|
|
886
|
+
customers. This feature might be changed in backward-incompatible
|
|
887
|
+
ways and is not recommended for production use. It is not subject to
|
|
888
|
+
any SLA or deprecation policy.
|
|
889
|
+
|
|
890
|
+
Attributes:
|
|
891
|
+
name (str):
|
|
892
|
+
Required. The unique name of the requested snapshot. Values
|
|
893
|
+
are of the form
|
|
894
|
+
``projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}``.
|
|
895
|
+
"""
|
|
896
|
+
|
|
897
|
+
name: str = proto.Field(
|
|
898
|
+
proto.STRING,
|
|
899
|
+
number=1,
|
|
900
|
+
)
|
|
901
|
+
|
|
902
|
+
|
|
903
|
+
class ListSnapshotsRequest(proto.Message):
|
|
904
|
+
r"""Request message for
|
|
905
|
+
[google.bigtable.admin.v2.BigtableTableAdmin.ListSnapshots][google.bigtable.admin.v2.BigtableTableAdmin.ListSnapshots]
|
|
906
|
+
|
|
907
|
+
Note: This is a private alpha release of Cloud Bigtable snapshots.
|
|
908
|
+
This feature is not currently available to most Cloud Bigtable
|
|
909
|
+
customers. This feature might be changed in backward-incompatible
|
|
910
|
+
ways and is not recommended for production use. It is not subject to
|
|
911
|
+
any SLA or deprecation policy.
|
|
912
|
+
|
|
913
|
+
Attributes:
|
|
914
|
+
parent (str):
|
|
915
|
+
Required. The unique name of the cluster for which snapshots
|
|
916
|
+
should be listed. Values are of the form
|
|
917
|
+
``projects/{project}/instances/{instance}/clusters/{cluster}``.
|
|
918
|
+
Use ``{cluster} = '-'`` to list snapshots for all clusters
|
|
919
|
+
in an instance, e.g.,
|
|
920
|
+
``projects/{project}/instances/{instance}/clusters/-``.
|
|
921
|
+
page_size (int):
|
|
922
|
+
The maximum number of snapshots to return per
|
|
923
|
+
page. CURRENTLY UNIMPLEMENTED AND IGNORED.
|
|
924
|
+
page_token (str):
|
|
925
|
+
The value of ``next_page_token`` returned by a previous
|
|
926
|
+
call.
|
|
927
|
+
"""
|
|
928
|
+
|
|
929
|
+
parent: str = proto.Field(
|
|
930
|
+
proto.STRING,
|
|
931
|
+
number=1,
|
|
932
|
+
)
|
|
933
|
+
page_size: int = proto.Field(
|
|
934
|
+
proto.INT32,
|
|
935
|
+
number=2,
|
|
936
|
+
)
|
|
937
|
+
page_token: str = proto.Field(
|
|
938
|
+
proto.STRING,
|
|
939
|
+
number=3,
|
|
940
|
+
)
|
|
941
|
+
|
|
942
|
+
|
|
943
|
+
class ListSnapshotsResponse(proto.Message):
|
|
944
|
+
r"""Response message for
|
|
945
|
+
[google.bigtable.admin.v2.BigtableTableAdmin.ListSnapshots][google.bigtable.admin.v2.BigtableTableAdmin.ListSnapshots]
|
|
946
|
+
|
|
947
|
+
Note: This is a private alpha release of Cloud Bigtable snapshots.
|
|
948
|
+
This feature is not currently available to most Cloud Bigtable
|
|
949
|
+
customers. This feature might be changed in backward-incompatible
|
|
950
|
+
ways and is not recommended for production use. It is not subject to
|
|
951
|
+
any SLA or deprecation policy.
|
|
952
|
+
|
|
953
|
+
Attributes:
|
|
954
|
+
snapshots (MutableSequence[google.cloud.bigtable_admin_v2.types.Snapshot]):
|
|
955
|
+
The snapshots present in the requested
|
|
956
|
+
cluster.
|
|
957
|
+
next_page_token (str):
|
|
958
|
+
Set if not all snapshots could be returned in a single
|
|
959
|
+
response. Pass this value to ``page_token`` in another
|
|
960
|
+
request to get the next page of results.
|
|
961
|
+
"""
|
|
962
|
+
|
|
963
|
+
@property
|
|
964
|
+
def raw_page(self):
|
|
965
|
+
return self
|
|
966
|
+
|
|
967
|
+
snapshots: MutableSequence[gba_table.Snapshot] = proto.RepeatedField(
|
|
968
|
+
proto.MESSAGE,
|
|
969
|
+
number=1,
|
|
970
|
+
message=gba_table.Snapshot,
|
|
971
|
+
)
|
|
972
|
+
next_page_token: str = proto.Field(
|
|
973
|
+
proto.STRING,
|
|
974
|
+
number=2,
|
|
975
|
+
)
|
|
976
|
+
|
|
977
|
+
|
|
978
|
+
class DeleteSnapshotRequest(proto.Message):
|
|
979
|
+
r"""Request message for
|
|
980
|
+
[google.bigtable.admin.v2.BigtableTableAdmin.DeleteSnapshot][google.bigtable.admin.v2.BigtableTableAdmin.DeleteSnapshot]
|
|
981
|
+
|
|
982
|
+
Note: This is a private alpha release of Cloud Bigtable snapshots.
|
|
983
|
+
This feature is not currently available to most Cloud Bigtable
|
|
984
|
+
customers. This feature might be changed in backward-incompatible
|
|
985
|
+
ways and is not recommended for production use. It is not subject to
|
|
986
|
+
any SLA or deprecation policy.
|
|
987
|
+
|
|
988
|
+
Attributes:
|
|
989
|
+
name (str):
|
|
990
|
+
Required. The unique name of the snapshot to be deleted.
|
|
991
|
+
Values are of the form
|
|
992
|
+
``projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}``.
|
|
993
|
+
"""
|
|
994
|
+
|
|
995
|
+
name: str = proto.Field(
|
|
996
|
+
proto.STRING,
|
|
997
|
+
number=1,
|
|
998
|
+
)
|
|
999
|
+
|
|
1000
|
+
|
|
1001
|
+
class SnapshotTableMetadata(proto.Message):
|
|
1002
|
+
r"""The metadata for the Operation returned by SnapshotTable.
|
|
1003
|
+
|
|
1004
|
+
Note: This is a private alpha release of Cloud Bigtable
|
|
1005
|
+
snapshots. This feature is not currently available to most Cloud
|
|
1006
|
+
Bigtable customers. This feature might be changed in
|
|
1007
|
+
backward-incompatible ways and is not recommended for production
|
|
1008
|
+
use. It is not subject to any SLA or deprecation policy.
|
|
1009
|
+
|
|
1010
|
+
Attributes:
|
|
1011
|
+
original_request (google.cloud.bigtable_admin_v2.types.SnapshotTableRequest):
|
|
1012
|
+
The request that prompted the initiation of
|
|
1013
|
+
this SnapshotTable operation.
|
|
1014
|
+
request_time (google.protobuf.timestamp_pb2.Timestamp):
|
|
1015
|
+
The time at which the original request was
|
|
1016
|
+
received.
|
|
1017
|
+
finish_time (google.protobuf.timestamp_pb2.Timestamp):
|
|
1018
|
+
The time at which the operation failed or was
|
|
1019
|
+
completed successfully.
|
|
1020
|
+
"""
|
|
1021
|
+
|
|
1022
|
+
original_request: "SnapshotTableRequest" = proto.Field(
|
|
1023
|
+
proto.MESSAGE,
|
|
1024
|
+
number=1,
|
|
1025
|
+
message="SnapshotTableRequest",
|
|
1026
|
+
)
|
|
1027
|
+
request_time: timestamp_pb2.Timestamp = proto.Field(
|
|
1028
|
+
proto.MESSAGE,
|
|
1029
|
+
number=2,
|
|
1030
|
+
message=timestamp_pb2.Timestamp,
|
|
1031
|
+
)
|
|
1032
|
+
finish_time: timestamp_pb2.Timestamp = proto.Field(
|
|
1033
|
+
proto.MESSAGE,
|
|
1034
|
+
number=3,
|
|
1035
|
+
message=timestamp_pb2.Timestamp,
|
|
1036
|
+
)
|
|
1037
|
+
|
|
1038
|
+
|
|
1039
|
+
class CreateTableFromSnapshotMetadata(proto.Message):
|
|
1040
|
+
r"""The metadata for the Operation returned by
|
|
1041
|
+
CreateTableFromSnapshot.
|
|
1042
|
+
Note: This is a private alpha release of Cloud Bigtable
|
|
1043
|
+
snapshots. This feature is not currently available to most Cloud
|
|
1044
|
+
Bigtable customers. This feature might be changed in
|
|
1045
|
+
backward-incompatible ways and is not recommended for production
|
|
1046
|
+
use. It is not subject to any SLA or deprecation policy.
|
|
1047
|
+
|
|
1048
|
+
Attributes:
|
|
1049
|
+
original_request (google.cloud.bigtable_admin_v2.types.CreateTableFromSnapshotRequest):
|
|
1050
|
+
The request that prompted the initiation of
|
|
1051
|
+
this CreateTableFromSnapshot operation.
|
|
1052
|
+
request_time (google.protobuf.timestamp_pb2.Timestamp):
|
|
1053
|
+
The time at which the original request was
|
|
1054
|
+
received.
|
|
1055
|
+
finish_time (google.protobuf.timestamp_pb2.Timestamp):
|
|
1056
|
+
The time at which the operation failed or was
|
|
1057
|
+
completed successfully.
|
|
1058
|
+
"""
|
|
1059
|
+
|
|
1060
|
+
original_request: "CreateTableFromSnapshotRequest" = proto.Field(
|
|
1061
|
+
proto.MESSAGE,
|
|
1062
|
+
number=1,
|
|
1063
|
+
message="CreateTableFromSnapshotRequest",
|
|
1064
|
+
)
|
|
1065
|
+
request_time: timestamp_pb2.Timestamp = proto.Field(
|
|
1066
|
+
proto.MESSAGE,
|
|
1067
|
+
number=2,
|
|
1068
|
+
message=timestamp_pb2.Timestamp,
|
|
1069
|
+
)
|
|
1070
|
+
finish_time: timestamp_pb2.Timestamp = proto.Field(
|
|
1071
|
+
proto.MESSAGE,
|
|
1072
|
+
number=3,
|
|
1073
|
+
message=timestamp_pb2.Timestamp,
|
|
1074
|
+
)
|
|
1075
|
+
|
|
1076
|
+
|
|
1077
|
+
class CreateBackupRequest(proto.Message):
|
|
1078
|
+
r"""The request for
|
|
1079
|
+
[CreateBackup][google.bigtable.admin.v2.BigtableTableAdmin.CreateBackup].
|
|
1080
|
+
|
|
1081
|
+
Attributes:
|
|
1082
|
+
parent (str):
|
|
1083
|
+
Required. This must be one of the clusters in the instance
|
|
1084
|
+
in which this table is located. The backup will be stored in
|
|
1085
|
+
this cluster. Values are of the form
|
|
1086
|
+
``projects/{project}/instances/{instance}/clusters/{cluster}``.
|
|
1087
|
+
backup_id (str):
|
|
1088
|
+
Required. The id of the backup to be created. The
|
|
1089
|
+
``backup_id`` along with the parent ``parent`` are combined
|
|
1090
|
+
as {parent}/backups/{backup_id} to create the full backup
|
|
1091
|
+
name, of the form:
|
|
1092
|
+
``projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id}``.
|
|
1093
|
+
This string must be between 1 and 50 characters in length
|
|
1094
|
+
and match the regex [*a-zA-Z0-9][-*.a-zA-Z0-9]*.
|
|
1095
|
+
backup (google.cloud.bigtable_admin_v2.types.Backup):
|
|
1096
|
+
Required. The backup to create.
|
|
1097
|
+
"""
|
|
1098
|
+
|
|
1099
|
+
parent: str = proto.Field(
|
|
1100
|
+
proto.STRING,
|
|
1101
|
+
number=1,
|
|
1102
|
+
)
|
|
1103
|
+
backup_id: str = proto.Field(
|
|
1104
|
+
proto.STRING,
|
|
1105
|
+
number=2,
|
|
1106
|
+
)
|
|
1107
|
+
backup: gba_table.Backup = proto.Field(
|
|
1108
|
+
proto.MESSAGE,
|
|
1109
|
+
number=3,
|
|
1110
|
+
message=gba_table.Backup,
|
|
1111
|
+
)
|
|
1112
|
+
|
|
1113
|
+
|
|
1114
|
+
class CreateBackupMetadata(proto.Message):
|
|
1115
|
+
r"""Metadata type for the operation returned by
|
|
1116
|
+
[CreateBackup][google.bigtable.admin.v2.BigtableTableAdmin.CreateBackup].
|
|
1117
|
+
|
|
1118
|
+
Attributes:
|
|
1119
|
+
name (str):
|
|
1120
|
+
The name of the backup being created.
|
|
1121
|
+
source_table (str):
|
|
1122
|
+
The name of the table the backup is created
|
|
1123
|
+
from.
|
|
1124
|
+
start_time (google.protobuf.timestamp_pb2.Timestamp):
|
|
1125
|
+
The time at which this operation started.
|
|
1126
|
+
end_time (google.protobuf.timestamp_pb2.Timestamp):
|
|
1127
|
+
If set, the time at which this operation
|
|
1128
|
+
finished or was cancelled.
|
|
1129
|
+
"""
|
|
1130
|
+
|
|
1131
|
+
name: str = proto.Field(
|
|
1132
|
+
proto.STRING,
|
|
1133
|
+
number=1,
|
|
1134
|
+
)
|
|
1135
|
+
source_table: str = proto.Field(
|
|
1136
|
+
proto.STRING,
|
|
1137
|
+
number=2,
|
|
1138
|
+
)
|
|
1139
|
+
start_time: timestamp_pb2.Timestamp = proto.Field(
|
|
1140
|
+
proto.MESSAGE,
|
|
1141
|
+
number=3,
|
|
1142
|
+
message=timestamp_pb2.Timestamp,
|
|
1143
|
+
)
|
|
1144
|
+
end_time: timestamp_pb2.Timestamp = proto.Field(
|
|
1145
|
+
proto.MESSAGE,
|
|
1146
|
+
number=4,
|
|
1147
|
+
message=timestamp_pb2.Timestamp,
|
|
1148
|
+
)
|
|
1149
|
+
|
|
1150
|
+
|
|
1151
|
+
class UpdateBackupRequest(proto.Message):
|
|
1152
|
+
r"""The request for
|
|
1153
|
+
[UpdateBackup][google.bigtable.admin.v2.BigtableTableAdmin.UpdateBackup].
|
|
1154
|
+
|
|
1155
|
+
Attributes:
|
|
1156
|
+
backup (google.cloud.bigtable_admin_v2.types.Backup):
|
|
1157
|
+
Required. The backup to update. ``backup.name``, and the
|
|
1158
|
+
fields to be updated as specified by ``update_mask`` are
|
|
1159
|
+
required. Other fields are ignored. Update is only supported
|
|
1160
|
+
for the following fields:
|
|
1161
|
+
|
|
1162
|
+
- ``backup.expire_time``.
|
|
1163
|
+
update_mask (google.protobuf.field_mask_pb2.FieldMask):
|
|
1164
|
+
Required. A mask specifying which fields (e.g.
|
|
1165
|
+
``expire_time``) in the Backup resource should be updated.
|
|
1166
|
+
This mask is relative to the Backup resource, not to the
|
|
1167
|
+
request message. The field mask must always be specified;
|
|
1168
|
+
this prevents any future fields from being erased
|
|
1169
|
+
accidentally by clients that do not know about them.
|
|
1170
|
+
"""
|
|
1171
|
+
|
|
1172
|
+
backup: gba_table.Backup = proto.Field(
|
|
1173
|
+
proto.MESSAGE,
|
|
1174
|
+
number=1,
|
|
1175
|
+
message=gba_table.Backup,
|
|
1176
|
+
)
|
|
1177
|
+
update_mask: field_mask_pb2.FieldMask = proto.Field(
|
|
1178
|
+
proto.MESSAGE,
|
|
1179
|
+
number=2,
|
|
1180
|
+
message=field_mask_pb2.FieldMask,
|
|
1181
|
+
)
|
|
1182
|
+
|
|
1183
|
+
|
|
1184
|
+
class GetBackupRequest(proto.Message):
|
|
1185
|
+
r"""The request for
|
|
1186
|
+
[GetBackup][google.bigtable.admin.v2.BigtableTableAdmin.GetBackup].
|
|
1187
|
+
|
|
1188
|
+
Attributes:
|
|
1189
|
+
name (str):
|
|
1190
|
+
Required. Name of the backup. Values are of the form
|
|
1191
|
+
``projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}``.
|
|
1192
|
+
"""
|
|
1193
|
+
|
|
1194
|
+
name: str = proto.Field(
|
|
1195
|
+
proto.STRING,
|
|
1196
|
+
number=1,
|
|
1197
|
+
)
|
|
1198
|
+
|
|
1199
|
+
|
|
1200
|
+
class DeleteBackupRequest(proto.Message):
|
|
1201
|
+
r"""The request for
|
|
1202
|
+
[DeleteBackup][google.bigtable.admin.v2.BigtableTableAdmin.DeleteBackup].
|
|
1203
|
+
|
|
1204
|
+
Attributes:
|
|
1205
|
+
name (str):
|
|
1206
|
+
Required. Name of the backup to delete. Values are of the
|
|
1207
|
+
form
|
|
1208
|
+
``projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup}``.
|
|
1209
|
+
"""
|
|
1210
|
+
|
|
1211
|
+
name: str = proto.Field(
|
|
1212
|
+
proto.STRING,
|
|
1213
|
+
number=1,
|
|
1214
|
+
)
|
|
1215
|
+
|
|
1216
|
+
|
|
1217
|
+
class ListBackupsRequest(proto.Message):
|
|
1218
|
+
r"""The request for
|
|
1219
|
+
[ListBackups][google.bigtable.admin.v2.BigtableTableAdmin.ListBackups].
|
|
1220
|
+
|
|
1221
|
+
Attributes:
|
|
1222
|
+
parent (str):
|
|
1223
|
+
Required. The cluster to list backups from. Values are of
|
|
1224
|
+
the form
|
|
1225
|
+
``projects/{project}/instances/{instance}/clusters/{cluster}``.
|
|
1226
|
+
Use ``{cluster} = '-'`` to list backups for all clusters in
|
|
1227
|
+
an instance, e.g.,
|
|
1228
|
+
``projects/{project}/instances/{instance}/clusters/-``.
|
|
1229
|
+
filter (str):
|
|
1230
|
+
A filter expression that filters backups listed in the
|
|
1231
|
+
response. The expression must specify the field name, a
|
|
1232
|
+
comparison operator, and the value that you want to use for
|
|
1233
|
+
filtering. The value must be a string, a number, or a
|
|
1234
|
+
boolean. The comparison operator must be <, >, <=, >=, !=,
|
|
1235
|
+
=, or :. Colon ':' represents a HAS operator which is
|
|
1236
|
+
roughly synonymous with equality. Filter rules are case
|
|
1237
|
+
insensitive.
|
|
1238
|
+
|
|
1239
|
+
The fields eligible for filtering are:
|
|
1240
|
+
|
|
1241
|
+
- ``name``
|
|
1242
|
+
- ``source_table``
|
|
1243
|
+
- ``state``
|
|
1244
|
+
- ``start_time`` (and values are of the format
|
|
1245
|
+
YYYY-MM-DDTHH:MM:SSZ)
|
|
1246
|
+
- ``end_time`` (and values are of the format
|
|
1247
|
+
YYYY-MM-DDTHH:MM:SSZ)
|
|
1248
|
+
- ``expire_time`` (and values are of the format
|
|
1249
|
+
YYYY-MM-DDTHH:MM:SSZ)
|
|
1250
|
+
- ``size_bytes``
|
|
1251
|
+
|
|
1252
|
+
To filter on multiple expressions, provide each separate
|
|
1253
|
+
expression within parentheses. By default, each expression
|
|
1254
|
+
is an AND expression. However, you can include AND, OR, and
|
|
1255
|
+
NOT expressions explicitly.
|
|
1256
|
+
|
|
1257
|
+
Some examples of using filters are:
|
|
1258
|
+
|
|
1259
|
+
- ``name:"exact"`` --> The backup's name is the string
|
|
1260
|
+
"exact".
|
|
1261
|
+
- ``name:howl`` --> The backup's name contains the string
|
|
1262
|
+
"howl".
|
|
1263
|
+
- ``source_table:prod`` --> The source_table's name
|
|
1264
|
+
contains the string "prod".
|
|
1265
|
+
- ``state:CREATING`` --> The backup is pending creation.
|
|
1266
|
+
- ``state:READY`` --> The backup is fully created and ready
|
|
1267
|
+
for use.
|
|
1268
|
+
- ``(name:howl) AND (start_time < \"2018-03-28T14:50:00Z\")``
|
|
1269
|
+
--> The backup name contains the string "howl" and
|
|
1270
|
+
start_time of the backup is before 2018-03-28T14:50:00Z.
|
|
1271
|
+
- ``size_bytes > 10000000000`` --> The backup's size is
|
|
1272
|
+
greater than 10GB
|
|
1273
|
+
order_by (str):
|
|
1274
|
+
An expression for specifying the sort order of the results
|
|
1275
|
+
of the request. The string value should specify one or more
|
|
1276
|
+
fields in [Backup][google.bigtable.admin.v2.Backup]. The
|
|
1277
|
+
full syntax is described at https://aip.dev/132#ordering.
|
|
1278
|
+
|
|
1279
|
+
Fields supported are:
|
|
1280
|
+
|
|
1281
|
+
- name
|
|
1282
|
+
- source_table
|
|
1283
|
+
- expire_time
|
|
1284
|
+
- start_time
|
|
1285
|
+
- end_time
|
|
1286
|
+
- size_bytes
|
|
1287
|
+
- state
|
|
1288
|
+
|
|
1289
|
+
For example, "start_time". The default sorting order is
|
|
1290
|
+
ascending. To specify descending order for the field, a
|
|
1291
|
+
suffix " desc" should be appended to the field name. For
|
|
1292
|
+
example, "start_time desc". Redundant space characters in
|
|
1293
|
+
the syntax are insigificant.
|
|
1294
|
+
|
|
1295
|
+
If order_by is empty, results will be sorted by
|
|
1296
|
+
``start_time`` in descending order starting from the most
|
|
1297
|
+
recently created backup.
|
|
1298
|
+
page_size (int):
|
|
1299
|
+
Number of backups to be returned in the
|
|
1300
|
+
response. If 0 or less, defaults to the server's
|
|
1301
|
+
maximum allowed page size.
|
|
1302
|
+
page_token (str):
|
|
1303
|
+
If non-empty, ``page_token`` should contain a
|
|
1304
|
+
[next_page_token][google.bigtable.admin.v2.ListBackupsResponse.next_page_token]
|
|
1305
|
+
from a previous
|
|
1306
|
+
[ListBackupsResponse][google.bigtable.admin.v2.ListBackupsResponse]
|
|
1307
|
+
to the same ``parent`` and with the same ``filter``.
|
|
1308
|
+
"""
|
|
1309
|
+
|
|
1310
|
+
parent: str = proto.Field(
|
|
1311
|
+
proto.STRING,
|
|
1312
|
+
number=1,
|
|
1313
|
+
)
|
|
1314
|
+
filter: str = proto.Field(
|
|
1315
|
+
proto.STRING,
|
|
1316
|
+
number=2,
|
|
1317
|
+
)
|
|
1318
|
+
order_by: str = proto.Field(
|
|
1319
|
+
proto.STRING,
|
|
1320
|
+
number=3,
|
|
1321
|
+
)
|
|
1322
|
+
page_size: int = proto.Field(
|
|
1323
|
+
proto.INT32,
|
|
1324
|
+
number=4,
|
|
1325
|
+
)
|
|
1326
|
+
page_token: str = proto.Field(
|
|
1327
|
+
proto.STRING,
|
|
1328
|
+
number=5,
|
|
1329
|
+
)
|
|
1330
|
+
|
|
1331
|
+
|
|
1332
|
+
class ListBackupsResponse(proto.Message):
|
|
1333
|
+
r"""The response for
|
|
1334
|
+
[ListBackups][google.bigtable.admin.v2.BigtableTableAdmin.ListBackups].
|
|
1335
|
+
|
|
1336
|
+
Attributes:
|
|
1337
|
+
backups (MutableSequence[google.cloud.bigtable_admin_v2.types.Backup]):
|
|
1338
|
+
The list of matching backups.
|
|
1339
|
+
next_page_token (str):
|
|
1340
|
+
``next_page_token`` can be sent in a subsequent
|
|
1341
|
+
[ListBackups][google.bigtable.admin.v2.BigtableTableAdmin.ListBackups]
|
|
1342
|
+
call to fetch more of the matching backups.
|
|
1343
|
+
"""
|
|
1344
|
+
|
|
1345
|
+
@property
|
|
1346
|
+
def raw_page(self):
|
|
1347
|
+
return self
|
|
1348
|
+
|
|
1349
|
+
backups: MutableSequence[gba_table.Backup] = proto.RepeatedField(
|
|
1350
|
+
proto.MESSAGE,
|
|
1351
|
+
number=1,
|
|
1352
|
+
message=gba_table.Backup,
|
|
1353
|
+
)
|
|
1354
|
+
next_page_token: str = proto.Field(
|
|
1355
|
+
proto.STRING,
|
|
1356
|
+
number=2,
|
|
1357
|
+
)
|
|
1358
|
+
|
|
1359
|
+
|
|
1360
|
+
class CopyBackupRequest(proto.Message):
|
|
1361
|
+
r"""The request for
|
|
1362
|
+
[CopyBackup][google.bigtable.admin.v2.BigtableTableAdmin.CopyBackup].
|
|
1363
|
+
|
|
1364
|
+
Attributes:
|
|
1365
|
+
parent (str):
|
|
1366
|
+
Required. The name of the destination cluster that will
|
|
1367
|
+
contain the backup copy. The cluster must already exist.
|
|
1368
|
+
Values are of the form:
|
|
1369
|
+
``projects/{project}/instances/{instance}/clusters/{cluster}``.
|
|
1370
|
+
backup_id (str):
|
|
1371
|
+
Required. The id of the new backup. The ``backup_id`` along
|
|
1372
|
+
with ``parent`` are combined as {parent}/backups/{backup_id}
|
|
1373
|
+
to create the full backup name, of the form:
|
|
1374
|
+
``projects/{project}/instances/{instance}/clusters/{cluster}/backups/{backup_id}``.
|
|
1375
|
+
This string must be between 1 and 50 characters in length
|
|
1376
|
+
and match the regex [*a-zA-Z0-9][-*.a-zA-Z0-9]*.
|
|
1377
|
+
source_backup (str):
|
|
1378
|
+
Required. The source backup to be copied from. The source
|
|
1379
|
+
backup needs to be in READY state for it to be copied.
|
|
1380
|
+
Copying a copied backup is not allowed. Once CopyBackup is
|
|
1381
|
+
in progress, the source backup cannot be deleted or cleaned
|
|
1382
|
+
up on expiration until CopyBackup is finished. Values are of
|
|
1383
|
+
the form:
|
|
1384
|
+
``projects/<project>/instances/<instance>/clusters/<cluster>/backups/<backup>``.
|
|
1385
|
+
expire_time (google.protobuf.timestamp_pb2.Timestamp):
|
|
1386
|
+
Required. Required. The expiration time of the copied backup
|
|
1387
|
+
with microsecond granularity that must be at least 6 hours
|
|
1388
|
+
and at most 30 days from the time the request is received.
|
|
1389
|
+
Once the ``expire_time`` has passed, Cloud Bigtable will
|
|
1390
|
+
delete the backup and free the resources used by the backup.
|
|
1391
|
+
"""
|
|
1392
|
+
|
|
1393
|
+
parent: str = proto.Field(
|
|
1394
|
+
proto.STRING,
|
|
1395
|
+
number=1,
|
|
1396
|
+
)
|
|
1397
|
+
backup_id: str = proto.Field(
|
|
1398
|
+
proto.STRING,
|
|
1399
|
+
number=2,
|
|
1400
|
+
)
|
|
1401
|
+
source_backup: str = proto.Field(
|
|
1402
|
+
proto.STRING,
|
|
1403
|
+
number=3,
|
|
1404
|
+
)
|
|
1405
|
+
expire_time: timestamp_pb2.Timestamp = proto.Field(
|
|
1406
|
+
proto.MESSAGE,
|
|
1407
|
+
number=4,
|
|
1408
|
+
message=timestamp_pb2.Timestamp,
|
|
1409
|
+
)
|
|
1410
|
+
|
|
1411
|
+
|
|
1412
|
+
class CopyBackupMetadata(proto.Message):
|
|
1413
|
+
r"""Metadata type for the google.longrunning.Operation returned by
|
|
1414
|
+
[CopyBackup][google.bigtable.admin.v2.BigtableTableAdmin.CopyBackup].
|
|
1415
|
+
|
|
1416
|
+
Attributes:
|
|
1417
|
+
name (str):
|
|
1418
|
+
The name of the backup being created through the copy
|
|
1419
|
+
operation. Values are of the form
|
|
1420
|
+
``projects/<project>/instances/<instance>/clusters/<cluster>/backups/<backup>``.
|
|
1421
|
+
source_backup_info (google.cloud.bigtable_admin_v2.types.BackupInfo):
|
|
1422
|
+
Information about the source backup that is
|
|
1423
|
+
being copied from.
|
|
1424
|
+
progress (google.cloud.bigtable_admin_v2.types.OperationProgress):
|
|
1425
|
+
The progress of the
|
|
1426
|
+
[CopyBackup][google.bigtable.admin.v2.BigtableTableAdmin.CopyBackup]
|
|
1427
|
+
operation.
|
|
1428
|
+
"""
|
|
1429
|
+
|
|
1430
|
+
name: str = proto.Field(
|
|
1431
|
+
proto.STRING,
|
|
1432
|
+
number=1,
|
|
1433
|
+
)
|
|
1434
|
+
source_backup_info: gba_table.BackupInfo = proto.Field(
|
|
1435
|
+
proto.MESSAGE,
|
|
1436
|
+
number=2,
|
|
1437
|
+
message=gba_table.BackupInfo,
|
|
1438
|
+
)
|
|
1439
|
+
progress: common.OperationProgress = proto.Field(
|
|
1440
|
+
proto.MESSAGE,
|
|
1441
|
+
number=3,
|
|
1442
|
+
message=common.OperationProgress,
|
|
1443
|
+
)
|
|
1444
|
+
|
|
1445
|
+
|
|
1446
|
+
class CreateAuthorizedViewRequest(proto.Message):
|
|
1447
|
+
r"""The request for
|
|
1448
|
+
[CreateAuthorizedView][google.bigtable.admin.v2.BigtableTableAdmin.CreateAuthorizedView]
|
|
1449
|
+
|
|
1450
|
+
Attributes:
|
|
1451
|
+
parent (str):
|
|
1452
|
+
Required. This is the name of the table the AuthorizedView
|
|
1453
|
+
belongs to. Values are of the form
|
|
1454
|
+
``projects/{project}/instances/{instance}/tables/{table}``.
|
|
1455
|
+
authorized_view_id (str):
|
|
1456
|
+
Required. The id of the AuthorizedView to create. This
|
|
1457
|
+
AuthorizedView must not already exist. The
|
|
1458
|
+
``authorized_view_id`` appended to ``parent`` forms the full
|
|
1459
|
+
AuthorizedView name of the form
|
|
1460
|
+
``projects/{project}/instances/{instance}/tables/{table}/authorizedView/{authorized_view}``.
|
|
1461
|
+
authorized_view (google.cloud.bigtable_admin_v2.types.AuthorizedView):
|
|
1462
|
+
Required. The AuthorizedView to create.
|
|
1463
|
+
"""
|
|
1464
|
+
|
|
1465
|
+
parent: str = proto.Field(
|
|
1466
|
+
proto.STRING,
|
|
1467
|
+
number=1,
|
|
1468
|
+
)
|
|
1469
|
+
authorized_view_id: str = proto.Field(
|
|
1470
|
+
proto.STRING,
|
|
1471
|
+
number=2,
|
|
1472
|
+
)
|
|
1473
|
+
authorized_view: gba_table.AuthorizedView = proto.Field(
|
|
1474
|
+
proto.MESSAGE,
|
|
1475
|
+
number=3,
|
|
1476
|
+
message=gba_table.AuthorizedView,
|
|
1477
|
+
)
|
|
1478
|
+
|
|
1479
|
+
|
|
1480
|
+
class CreateAuthorizedViewMetadata(proto.Message):
|
|
1481
|
+
r"""The metadata for the Operation returned by
|
|
1482
|
+
CreateAuthorizedView.
|
|
1483
|
+
|
|
1484
|
+
Attributes:
|
|
1485
|
+
original_request (google.cloud.bigtable_admin_v2.types.CreateAuthorizedViewRequest):
|
|
1486
|
+
The request that prompted the initiation of
|
|
1487
|
+
this CreateInstance operation.
|
|
1488
|
+
request_time (google.protobuf.timestamp_pb2.Timestamp):
|
|
1489
|
+
The time at which the original request was
|
|
1490
|
+
received.
|
|
1491
|
+
finish_time (google.protobuf.timestamp_pb2.Timestamp):
|
|
1492
|
+
The time at which the operation failed or was
|
|
1493
|
+
completed successfully.
|
|
1494
|
+
"""
|
|
1495
|
+
|
|
1496
|
+
original_request: "CreateAuthorizedViewRequest" = proto.Field(
|
|
1497
|
+
proto.MESSAGE,
|
|
1498
|
+
number=1,
|
|
1499
|
+
message="CreateAuthorizedViewRequest",
|
|
1500
|
+
)
|
|
1501
|
+
request_time: timestamp_pb2.Timestamp = proto.Field(
|
|
1502
|
+
proto.MESSAGE,
|
|
1503
|
+
number=2,
|
|
1504
|
+
message=timestamp_pb2.Timestamp,
|
|
1505
|
+
)
|
|
1506
|
+
finish_time: timestamp_pb2.Timestamp = proto.Field(
|
|
1507
|
+
proto.MESSAGE,
|
|
1508
|
+
number=3,
|
|
1509
|
+
message=timestamp_pb2.Timestamp,
|
|
1510
|
+
)
|
|
1511
|
+
|
|
1512
|
+
|
|
1513
|
+
class ListAuthorizedViewsRequest(proto.Message):
|
|
1514
|
+
r"""Request message for
|
|
1515
|
+
[google.bigtable.admin.v2.BigtableTableAdmin.ListAuthorizedViews][google.bigtable.admin.v2.BigtableTableAdmin.ListAuthorizedViews]
|
|
1516
|
+
|
|
1517
|
+
Attributes:
|
|
1518
|
+
parent (str):
|
|
1519
|
+
Required. The unique name of the table for which
|
|
1520
|
+
AuthorizedViews should be listed. Values are of the form
|
|
1521
|
+
``projects/{project}/instances/{instance}/tables/{table}``.
|
|
1522
|
+
page_size (int):
|
|
1523
|
+
Optional. Maximum number of results per page.
|
|
1524
|
+
|
|
1525
|
+
A page_size of zero lets the server choose the number of
|
|
1526
|
+
items to return. A page_size which is strictly positive will
|
|
1527
|
+
return at most that many items. A negative page_size will
|
|
1528
|
+
cause an error.
|
|
1529
|
+
|
|
1530
|
+
Following the first request, subsequent paginated calls are
|
|
1531
|
+
not required to pass a page_size. If a page_size is set in
|
|
1532
|
+
subsequent calls, it must match the page_size given in the
|
|
1533
|
+
first request.
|
|
1534
|
+
page_token (str):
|
|
1535
|
+
Optional. The value of ``next_page_token`` returned by a
|
|
1536
|
+
previous call.
|
|
1537
|
+
view (google.cloud.bigtable_admin_v2.types.AuthorizedView.ResponseView):
|
|
1538
|
+
Optional. The resource_view to be applied to the returned
|
|
1539
|
+
views' fields. Default to NAME_ONLY.
|
|
1540
|
+
"""
|
|
1541
|
+
|
|
1542
|
+
parent: str = proto.Field(
|
|
1543
|
+
proto.STRING,
|
|
1544
|
+
number=1,
|
|
1545
|
+
)
|
|
1546
|
+
page_size: int = proto.Field(
|
|
1547
|
+
proto.INT32,
|
|
1548
|
+
number=2,
|
|
1549
|
+
)
|
|
1550
|
+
page_token: str = proto.Field(
|
|
1551
|
+
proto.STRING,
|
|
1552
|
+
number=3,
|
|
1553
|
+
)
|
|
1554
|
+
view: gba_table.AuthorizedView.ResponseView = proto.Field(
|
|
1555
|
+
proto.ENUM,
|
|
1556
|
+
number=4,
|
|
1557
|
+
enum=gba_table.AuthorizedView.ResponseView,
|
|
1558
|
+
)
|
|
1559
|
+
|
|
1560
|
+
|
|
1561
|
+
class ListAuthorizedViewsResponse(proto.Message):
|
|
1562
|
+
r"""Response message for
|
|
1563
|
+
[google.bigtable.admin.v2.BigtableTableAdmin.ListAuthorizedViews][google.bigtable.admin.v2.BigtableTableAdmin.ListAuthorizedViews]
|
|
1564
|
+
|
|
1565
|
+
Attributes:
|
|
1566
|
+
authorized_views (MutableSequence[google.cloud.bigtable_admin_v2.types.AuthorizedView]):
|
|
1567
|
+
The AuthorizedViews present in the requested
|
|
1568
|
+
table.
|
|
1569
|
+
next_page_token (str):
|
|
1570
|
+
Set if not all tables could be returned in a single
|
|
1571
|
+
response. Pass this value to ``page_token`` in another
|
|
1572
|
+
request to get the next page of results.
|
|
1573
|
+
"""
|
|
1574
|
+
|
|
1575
|
+
@property
|
|
1576
|
+
def raw_page(self):
|
|
1577
|
+
return self
|
|
1578
|
+
|
|
1579
|
+
authorized_views: MutableSequence[gba_table.AuthorizedView] = proto.RepeatedField(
|
|
1580
|
+
proto.MESSAGE,
|
|
1581
|
+
number=1,
|
|
1582
|
+
message=gba_table.AuthorizedView,
|
|
1583
|
+
)
|
|
1584
|
+
next_page_token: str = proto.Field(
|
|
1585
|
+
proto.STRING,
|
|
1586
|
+
number=2,
|
|
1587
|
+
)
|
|
1588
|
+
|
|
1589
|
+
|
|
1590
|
+
class GetAuthorizedViewRequest(proto.Message):
|
|
1591
|
+
r"""Request message for
|
|
1592
|
+
[google.bigtable.admin.v2.BigtableTableAdmin.GetAuthorizedView][google.bigtable.admin.v2.BigtableTableAdmin.GetAuthorizedView]
|
|
1593
|
+
|
|
1594
|
+
Attributes:
|
|
1595
|
+
name (str):
|
|
1596
|
+
Required. The unique name of the requested AuthorizedView.
|
|
1597
|
+
Values are of the form
|
|
1598
|
+
``projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}``.
|
|
1599
|
+
view (google.cloud.bigtable_admin_v2.types.AuthorizedView.ResponseView):
|
|
1600
|
+
Optional. The resource_view to be applied to the returned
|
|
1601
|
+
AuthorizedView's fields. Default to BASIC.
|
|
1602
|
+
"""
|
|
1603
|
+
|
|
1604
|
+
name: str = proto.Field(
|
|
1605
|
+
proto.STRING,
|
|
1606
|
+
number=1,
|
|
1607
|
+
)
|
|
1608
|
+
view: gba_table.AuthorizedView.ResponseView = proto.Field(
|
|
1609
|
+
proto.ENUM,
|
|
1610
|
+
number=2,
|
|
1611
|
+
enum=gba_table.AuthorizedView.ResponseView,
|
|
1612
|
+
)
|
|
1613
|
+
|
|
1614
|
+
|
|
1615
|
+
class UpdateAuthorizedViewRequest(proto.Message):
|
|
1616
|
+
r"""The request for
|
|
1617
|
+
[UpdateAuthorizedView][google.bigtable.admin.v2.BigtableTableAdmin.UpdateAuthorizedView].
|
|
1618
|
+
|
|
1619
|
+
Attributes:
|
|
1620
|
+
authorized_view (google.cloud.bigtable_admin_v2.types.AuthorizedView):
|
|
1621
|
+
Required. The AuthorizedView to update. The ``name`` in
|
|
1622
|
+
``authorized_view`` is used to identify the AuthorizedView.
|
|
1623
|
+
AuthorizedView name must in this format
|
|
1624
|
+
projects//instances//tables//authorizedViews/<authorized_view>
|
|
1625
|
+
update_mask (google.protobuf.field_mask_pb2.FieldMask):
|
|
1626
|
+
Optional. The list of fields to update. A mask specifying
|
|
1627
|
+
which fields in the AuthorizedView resource should be
|
|
1628
|
+
updated. This mask is relative to the AuthorizedView
|
|
1629
|
+
resource, not to the request message. A field will be
|
|
1630
|
+
overwritten if it is in the mask. If empty, all fields set
|
|
1631
|
+
in the request will be overwritten. A special value ``*``
|
|
1632
|
+
means to overwrite all fields (including fields not set in
|
|
1633
|
+
the request).
|
|
1634
|
+
ignore_warnings (bool):
|
|
1635
|
+
Optional. If true, ignore the safety checks
|
|
1636
|
+
when updating the AuthorizedView.
|
|
1637
|
+
"""
|
|
1638
|
+
|
|
1639
|
+
authorized_view: gba_table.AuthorizedView = proto.Field(
|
|
1640
|
+
proto.MESSAGE,
|
|
1641
|
+
number=1,
|
|
1642
|
+
message=gba_table.AuthorizedView,
|
|
1643
|
+
)
|
|
1644
|
+
update_mask: field_mask_pb2.FieldMask = proto.Field(
|
|
1645
|
+
proto.MESSAGE,
|
|
1646
|
+
number=2,
|
|
1647
|
+
message=field_mask_pb2.FieldMask,
|
|
1648
|
+
)
|
|
1649
|
+
ignore_warnings: bool = proto.Field(
|
|
1650
|
+
proto.BOOL,
|
|
1651
|
+
number=3,
|
|
1652
|
+
)
|
|
1653
|
+
|
|
1654
|
+
|
|
1655
|
+
class UpdateAuthorizedViewMetadata(proto.Message):
|
|
1656
|
+
r"""Metadata for the google.longrunning.Operation returned by
|
|
1657
|
+
[UpdateAuthorizedView][google.bigtable.admin.v2.BigtableTableAdmin.UpdateAuthorizedView].
|
|
1658
|
+
|
|
1659
|
+
Attributes:
|
|
1660
|
+
original_request (google.cloud.bigtable_admin_v2.types.UpdateAuthorizedViewRequest):
|
|
1661
|
+
The request that prompted the initiation of
|
|
1662
|
+
this UpdateAuthorizedView operation.
|
|
1663
|
+
request_time (google.protobuf.timestamp_pb2.Timestamp):
|
|
1664
|
+
The time at which the original request was
|
|
1665
|
+
received.
|
|
1666
|
+
finish_time (google.protobuf.timestamp_pb2.Timestamp):
|
|
1667
|
+
The time at which the operation failed or was
|
|
1668
|
+
completed successfully.
|
|
1669
|
+
"""
|
|
1670
|
+
|
|
1671
|
+
original_request: "UpdateAuthorizedViewRequest" = proto.Field(
|
|
1672
|
+
proto.MESSAGE,
|
|
1673
|
+
number=1,
|
|
1674
|
+
message="UpdateAuthorizedViewRequest",
|
|
1675
|
+
)
|
|
1676
|
+
request_time: timestamp_pb2.Timestamp = proto.Field(
|
|
1677
|
+
proto.MESSAGE,
|
|
1678
|
+
number=2,
|
|
1679
|
+
message=timestamp_pb2.Timestamp,
|
|
1680
|
+
)
|
|
1681
|
+
finish_time: timestamp_pb2.Timestamp = proto.Field(
|
|
1682
|
+
proto.MESSAGE,
|
|
1683
|
+
number=3,
|
|
1684
|
+
message=timestamp_pb2.Timestamp,
|
|
1685
|
+
)
|
|
1686
|
+
|
|
1687
|
+
|
|
1688
|
+
class DeleteAuthorizedViewRequest(proto.Message):
|
|
1689
|
+
r"""Request message for
|
|
1690
|
+
[google.bigtable.admin.v2.BigtableTableAdmin.DeleteAuthorizedView][google.bigtable.admin.v2.BigtableTableAdmin.DeleteAuthorizedView]
|
|
1691
|
+
|
|
1692
|
+
Attributes:
|
|
1693
|
+
name (str):
|
|
1694
|
+
Required. The unique name of the AuthorizedView to be
|
|
1695
|
+
deleted. Values are of the form
|
|
1696
|
+
``projects/{project}/instances/{instance}/tables/{table}/authorizedViews/{authorized_view}``.
|
|
1697
|
+
etag (str):
|
|
1698
|
+
Optional. The current etag of the
|
|
1699
|
+
AuthorizedView. If an etag is provided and does
|
|
1700
|
+
not match the current etag of the
|
|
1701
|
+
AuthorizedView, deletion will be blocked and an
|
|
1702
|
+
ABORTED error will be returned.
|
|
1703
|
+
"""
|
|
1704
|
+
|
|
1705
|
+
name: str = proto.Field(
|
|
1706
|
+
proto.STRING,
|
|
1707
|
+
number=1,
|
|
1708
|
+
)
|
|
1709
|
+
etag: str = proto.Field(
|
|
1710
|
+
proto.STRING,
|
|
1711
|
+
number=2,
|
|
1712
|
+
)
|
|
1713
|
+
|
|
1714
|
+
|
|
1715
|
+
__all__ = tuple(sorted(__protobuf__.manifest))
|