google-cloud-bigtable 1.1.0 → 1.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (22) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +6 -0
  3. data/lib/google/bigtable/admin/v2/bigtable_instance_admin_pb.rb +3 -0
  4. data/lib/google/bigtable/admin/v2/bigtable_instance_admin_services_pb.rb +6 -3
  5. data/lib/google/bigtable/admin/v2/bigtable_table_admin_pb.rb +3 -0
  6. data/lib/google/bigtable/admin/v2/bigtable_table_admin_services_pb.rb +6 -5
  7. data/lib/google/bigtable/admin/v2/instance_pb.rb +2 -0
  8. data/lib/google/bigtable/admin/v2/table_pb.rb +2 -0
  9. data/lib/google/cloud/bigtable/admin.rb +2 -2
  10. data/lib/google/cloud/bigtable/admin/v2.rb +2 -2
  11. data/lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client.rb +59 -49
  12. data/lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin_client_config.json +1 -1
  13. data/lib/google/cloud/bigtable/admin/v2/bigtable_table_admin_client.rb +56 -44
  14. data/lib/google/cloud/bigtable/admin/v2/bigtable_table_admin_client_config.json +1 -1
  15. data/lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/bigtable_instance_admin.rb +46 -39
  16. data/lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/bigtable_table_admin.rb +48 -40
  17. data/lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/instance.rb +14 -16
  18. data/lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/table.rb +13 -23
  19. data/lib/google/cloud/bigtable/v2.rb +1 -1
  20. data/lib/google/cloud/bigtable/v2/bigtable_client.rb +3 -0
  21. data/lib/google/cloud/bigtable/version.rb +1 -1
  22. metadata +2 -2
data/lib/google/cloud/bigtable/admin/v2/bigtable_table_admin_client_config.json CHANGED
@@ -73,7 +73,7 @@
73
73
  "retry_params_name": "non_idempotent_params"
74
74
  },
75
75
  "ModifyColumnFamilies": {
76
- "timeout_millis": 60000,
76
+ "timeout_millis": 300000,
77
77
  "retry_codes_name": "non_idempotent",
78
78
  "retry_params_name": "non_idempotent_heavy_params"
79
79
  },
data/lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/bigtable_instance_admin.rb CHANGED
@@ -20,38 +20,38 @@ module Google
20
20
  # Request message for BigtableInstanceAdmin.CreateInstance.
21
21
  # @!attribute [rw] parent
22
22
  # @return [String]
23
- # The unique name of the project in which to create the new instance.
24
- # Values are of the form `projects/<project>`.
23
+ # Required. The unique name of the project in which to create the new instance.
24
+ # Values are of the form `projects/{project}`.
25
25
  # @!attribute [rw] instance_id
26
26
  # @return [String]
27
- # The ID to be used when referring to the new instance within its project,
27
+ # Required. The ID to be used when referring to the new instance within its project,
28
28
  # e.g., just `myinstance` rather than
29
29
  # `projects/myproject/instances/myinstance`.
30
30
  # @!attribute [rw] instance
31
31
  # @return [Google::Bigtable::Admin::V2::Instance]
32
- # The instance to create.
32
+ # Required. The instance to create.
33
33
  # Fields marked `OutputOnly` must be left blank.
34
34
  # @!attribute [rw] clusters
35
35
  # @return [Hash{String => Google::Bigtable::Admin::V2::Cluster}]
36
- # The clusters to be created within the instance, mapped by desired
36
+ # Required. The clusters to be created within the instance, mapped by desired
37
37
  # cluster ID, e.g., just `mycluster` rather than
38
38
  # `projects/myproject/instances/myinstance/clusters/mycluster`.
39
39
  # Fields marked `OutputOnly` must be left blank.
40
- # Currently, at most two clusters can be specified.
40
+ # Currently, at most four clusters can be specified.
41
41
  class CreateInstanceRequest; end
42
42
 
43
43
  # Request message for BigtableInstanceAdmin.GetInstance.
44
44
  # @!attribute [rw] name
45
45
  # @return [String]
46
- # The unique name of the requested instance. Values are of the form
47
- # `projects/<project>/instances/<instance>`.
46
+ # Required. The unique name of the requested instance. Values are of the form
47
+ # `projects/{project}/instances/{instance}`.
48
48
  class GetInstanceRequest; end
49
49
 
50
50
  # Request message for BigtableInstanceAdmin.ListInstances.
51
51
  # @!attribute [rw] parent
52
52
  # @return [String]
53
- # The unique name of the project for which a list of instances is requested.
54
- # Values are of the form `projects/<project>`.
53
+ # Required. The unique name of the project for which a list of instances is requested.
54
+ # Values are of the form `projects/{project}`.
55
55
  # @!attribute [rw] page_token
56
56
  # @return [String]
57
57
  # DEPRECATED: This field is unused and ignored.
@@ -77,50 +77,50 @@ module Google
77
77
  # Request message for BigtableInstanceAdmin.PartialUpdateInstance.
78
78
  # @!attribute [rw] instance
79
79
  # @return [Google::Bigtable::Admin::V2::Instance]
80
- # The Instance which will (partially) replace the current value.
80
+ # Required. The Instance which will (partially) replace the current value.
81
81
  # @!attribute [rw] update_mask
82
82
  # @return [Google::Protobuf::FieldMask]
83
- # The subset of Instance fields which should be replaced.
83
+ # Required. The subset of Instance fields which should be replaced.
84
84
  # Must be explicitly set.
85
85
  class PartialUpdateInstanceRequest; end
86
86
 
87
87
  # Request message for BigtableInstanceAdmin.DeleteInstance.
88
88
  # @!attribute [rw] name
89
89
  # @return [String]
90
- # The unique name of the instance to be deleted.
91
- # Values are of the form `projects/<project>/instances/<instance>`.
90
+ # Required. The unique name of the instance to be deleted.
91
+ # Values are of the form `projects/{project}/instances/{instance}`.
92
92
  class DeleteInstanceRequest; end
93
93
 
94
94
  # Request message for BigtableInstanceAdmin.CreateCluster.
95
95
  # @!attribute [rw] parent
96
96
  # @return [String]
97
- # The unique name of the instance in which to create the new cluster.
97
+ # Required. The unique name of the instance in which to create the new cluster.
98
98
  # Values are of the form
99
- # `projects/<project>/instances/<instance>`.
99
+ # `projects/{project}/instances/{instance}`.
100
100
  # @!attribute [rw] cluster_id
101
101
  # @return [String]
102
- # The ID to be used when referring to the new cluster within its instance,
102
+ # Required. The ID to be used when referring to the new cluster within its instance,
103
103
  # e.g., just `mycluster` rather than
104
104
  # `projects/myproject/instances/myinstance/clusters/mycluster`.
105
105
  # @!attribute [rw] cluster
106
106
  # @return [Google::Bigtable::Admin::V2::Cluster]
107
- # The cluster to be created.
107
+ # Required. The cluster to be created.
108
108
  # Fields marked `OutputOnly` must be left blank.
109
109
  class CreateClusterRequest; end
110
110
 
111
111
  # Request message for BigtableInstanceAdmin.GetCluster.
112
112
  # @!attribute [rw] name
113
113
  # @return [String]
114
- # The unique name of the requested cluster. Values are of the form
115
- # `projects/<project>/instances/<instance>/clusters/<cluster>`.
114
+ # Required. The unique name of the requested cluster. Values are of the form
115
+ # `projects/{project}/instances/{instance}/clusters/{cluster}`.
116
116
  class GetClusterRequest; end
117
117
 
118
118
  # Request message for BigtableInstanceAdmin.ListClusters.
119
119
  # @!attribute [rw] parent
120
120
  # @return [String]
121
- # The unique name of the instance for which a list of clusters is requested.
122
- # Values are of the form `projects/<project>/instances/<instance>`.
123
- # Use `<instance> = '-'` to list Clusters for all Instances in a project,
121
+ # Required. The unique name of the instance for which a list of clusters is requested.
122
+ # Values are of the form `projects/{project}/instances/{instance}`.
123
+ # Use `{instance} = '-'` to list Clusters for all Instances in a project,
124
124
  # e.g., `projects/myproject/instances/-`.
125
125
  # @!attribute [rw] page_token
126
126
  # @return [String]
@@ -146,8 +146,8 @@ module Google
146
146
  # Request message for BigtableInstanceAdmin.DeleteCluster.
147
147
  # @!attribute [rw] name
148
148
  # @return [String]
149
- # The unique name of the cluster to be deleted. Values are of the form
150
- # `projects/<project>/instances/<instance>/clusters/<cluster>`.
149
+ # Required. The unique name of the cluster to be deleted. Values are of the form
150
+ # `projects/{project}/instances/{instance}/clusters/{cluster}`.
151
151
  class DeleteClusterRequest; end
152
152
 
153
153
  # The metadata for the Operation returned by CreateInstance.
@@ -201,17 +201,17 @@ module Google
201
201
  # Request message for BigtableInstanceAdmin.CreateAppProfile.
202
202
  # @!attribute [rw] parent
203
203
  # @return [String]
204
- # The unique name of the instance in which to create the new app profile.
204
+ # Required. The unique name of the instance in which to create the new app profile.
205
205
  # Values are of the form
206
- # `projects/<project>/instances/<instance>`.
206
+ # `projects/{project}/instances/{instance}`.
207
207
  # @!attribute [rw] app_profile_id
208
208
  # @return [String]
209
- # The ID to be used when referring to the new app profile within its
209
+ # Required. The ID to be used when referring to the new app profile within its
210
210
  # instance, e.g., just `myprofile` rather than
211
211
  # `projects/myproject/instances/myinstance/appProfiles/myprofile`.
212
212
  # @!attribute [rw] app_profile
213
213
  # @return [Google::Bigtable::Admin::V2::AppProfile]
214
- # The app profile to be created.
214
+ # Required. The app profile to be created.
215
215
  # Fields marked `OutputOnly` will be ignored.
216
216
  # @!attribute [rw] ignore_warnings
217
217
  # @return [true, false]
@@ -221,22 +221,29 @@ module Google
221
221
  # Request message for BigtableInstanceAdmin.GetAppProfile.
222
222
  # @!attribute [rw] name
223
223
  # @return [String]
224
- # The unique name of the requested app profile. Values are of the form
225
- # `projects/<project>/instances/<instance>/appProfiles/<app_profile>`.
224
+ # Required. The unique name of the requested app profile. Values are of the form
225
+ # `projects/{project}/instances/{instance}/appProfiles/{app_profile}`.
226
226
  class GetAppProfileRequest; end
227
227
 
228
228
  # Request message for BigtableInstanceAdmin.ListAppProfiles.
229
229
  # @!attribute [rw] parent
230
230
  # @return [String]
231
- # The unique name of the instance for which a list of app profiles is
231
+ # Required. The unique name of the instance for which a list of app profiles is
232
232
  # requested. Values are of the form
233
- # `projects/<project>/instances/<instance>`.
234
- # Use `<instance> = '-'` to list AppProfiles for all Instances in a project,
233
+ # `projects/{project}/instances/{instance}`.
234
+ # Use `{instance} = '-'` to list AppProfiles for all Instances in a project,
235
235
  # e.g., `projects/myproject/instances/-`.
236
236
  # @!attribute [rw] page_size
237
237
  # @return [Integer]
238
238
  # Maximum number of results per page.
239
- # CURRENTLY UNIMPLEMENTED AND IGNORED.
239
+ #
240
+ # A page_size of zero lets the server choose the number of items to return.
241
+ # A page_size which is strictly positive will return at most that many items.
242
+ # A negative page_size will cause an error.
243
+ #
244
+ # Following the first request, subsequent paginated calls are not required
245
+ # to pass a page_size. If a page_size is set in subsequent calls, it must
246
+ # match the page_size given in the first request.
240
247
  # @!attribute [rw] page_token
241
248
  # @return [String]
242
249
  # The value of `next_page_token` returned by a previous call.
@@ -262,10 +269,10 @@ module Google
262
269
  # Request message for BigtableInstanceAdmin.UpdateAppProfile.
263
270
  # @!attribute [rw] app_profile
264
271
  # @return [Google::Bigtable::Admin::V2::AppProfile]
265
- # The app profile which will (partially) replace the current value.
272
+ # Required. The app profile which will (partially) replace the current value.
266
273
  # @!attribute [rw] update_mask
267
274
  # @return [Google::Protobuf::FieldMask]
268
- # The subset of app profile fields which should be replaced.
275
+ # Required. The subset of app profile fields which should be replaced.
269
276
  # If unset, all fields will be replaced.
270
277
  # @!attribute [rw] ignore_warnings
271
278
  # @return [true, false]
@@ -275,8 +282,8 @@ module Google
275
282
  # Request message for BigtableInstanceAdmin.DeleteAppProfile.
276
283
  # @!attribute [rw] name
277
284
  # @return [String]
278
- # The unique name of the app profile to be deleted. Values are of the form
279
- # `projects/<project>/instances/<instance>/appProfiles/<app_profile>`.
285
+ # Required. The unique name of the app profile to be deleted. Values are of the form
286
+ # `projects/{project}/instances/{instance}/appProfiles/{app_profile}`.
280
287
  # @!attribute [rw] ignore_warnings
281
288
  # @return [true, false]
282
289
  # If true, ignore safety checks when deleting the app profile.
data/lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/bigtable_table_admin.rb CHANGED
@@ -21,15 +21,16 @@ module Google
21
21
  # {Google::Bigtable::Admin::V2::BigtableTableAdmin::CreateTable}
22
22
  # @!attribute [rw] parent
23
23
  # @return [String]
24
- # The unique name of the instance in which to create the table.
25
- # Values are of the form `projects/<project>/instances/<instance>`.
24
+ # Required. The unique name of the instance in which to create the table.
25
+ # Values are of the form `projects/{project}/instances/{instance}`.
26
26
  # @!attribute [rw] table_id
27
27
  # @return [String]
28
- # The name by which the new table should be referred to within the parent
29
- # instance, e.g., `foobar` rather than `<parent>/tables/foobar`.
28
+ # Required. The name by which the new table should be referred to within the parent
29
+ # instance, e.g., `foobar` rather than `{parent}/tables/foobar`.
30
+ # Maximum 50 characters.
30
31
  # @!attribute [rw] table
31
32
  # @return [Google::Bigtable::Admin::V2::Table]
32
- # The Table to create.
33
+ # Required. The Table to create.
33
34
  # @!attribute [rw] initial_splits
34
35
  # @return [Array<Google::Bigtable::Admin::V2::CreateTableRequest::Split>]
35
36
  # The optional list of row keys that will be used to initially split the
@@ -65,27 +66,27 @@ module Google
65
66
  # for production use. It is not subject to any SLA or deprecation policy.
66
67
  # @!attribute [rw] parent
67
68
  # @return [String]
68
- # The unique name of the instance in which to create the table.
69
- # Values are of the form `projects/<project>/instances/<instance>`.
69
+ # Required. The unique name of the instance in which to create the table.
70
+ # Values are of the form `projects/{project}/instances/{instance}`.
70
71
  # @!attribute [rw] table_id
71
72
  # @return [String]
72
- # The name by which the new table should be referred to within the parent
73
- # instance, e.g., `foobar` rather than `<parent>/tables/foobar`.
73
+ # Required. The name by which the new table should be referred to within the parent
74
+ # instance, e.g., `foobar` rather than `{parent}/tables/foobar`.
74
75
  # @!attribute [rw] source_snapshot
75
76
  # @return [String]
76
- # The unique name of the snapshot from which to restore the table. The
77
+ # Required. The unique name of the snapshot from which to restore the table. The
77
78
  # snapshot and the table must be in the same instance.
78
79
  # Values are of the form
79
- # `projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>`.
80
+ # `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
80
81
  class CreateTableFromSnapshotRequest; end
81
82
 
82
83
  # Request message for
83
84
  # {Google::Bigtable::Admin::V2::BigtableTableAdmin::DropRowRange}
84
85
  # @!attribute [rw] name
85
86
  # @return [String]
86
- # The unique name of the table on which to drop a range of rows.
87
+ # Required. The unique name of the table on which to drop a range of rows.
87
88
  # Values are of the form
88
- # `projects/<project>/instances/<instance>/tables/<table>`.
89
+ # `projects/{project}/instances/{instance}/tables/{table}`.
89
90
  # @!attribute [rw] row_key_prefix
90
91
  # @return [String]
91
92
  # Delete all rows that start with this row key prefix. Prefix cannot be
@@ -99,16 +100,23 @@ module Google
99
100
  # {Google::Bigtable::Admin::V2::BigtableTableAdmin::ListTables}
100
101
  # @!attribute [rw] parent
101
102
  # @return [String]
102
- # The unique name of the instance for which tables should be listed.
103
- # Values are of the form `projects/<project>/instances/<instance>`.
103
+ # Required. The unique name of the instance for which tables should be listed.
104
+ # Values are of the form `projects/{project}/instances/{instance}`.
104
105
  # @!attribute [rw] view
105
106
  # @return [Google::Bigtable::Admin::V2::Table::View]
106
107
  # The view to be applied to the returned tables' fields.
107
- # Defaults to `NAME_ONLY` if unspecified; no others are currently supported.
108
+ # Only NAME_ONLY view (default) and REPLICATION_VIEW are supported.
108
109
  # @!attribute [rw] page_size
109
110
  # @return [Integer]
110
111
  # Maximum number of results per page.
111
- # CURRENTLY UNIMPLEMENTED AND IGNORED.
112
+ #
113
+ # A page_size of zero lets the server choose the number of items to return.
114
+ # A page_size which is strictly positive will return at most that many items.
115
+ # A negative page_size will cause an error.
116
+ #
117
+ # Following the first request, subsequent paginated calls are not required
118
+ # to pass a page_size. If a page_size is set in subsequent calls, it must
119
+ # match the page_size given in the first request.
112
120
  # @!attribute [rw] page_token
113
121
  # @return [String]
114
122
  # The value of `next_page_token` returned by a previous call.
@@ -130,9 +138,9 @@ module Google
130
138
  # {Google::Bigtable::Admin::V2::BigtableTableAdmin::GetTable}
131
139
  # @!attribute [rw] name
132
140
  # @return [String]
133
- # The unique name of the requested table.
141
+ # Required. The unique name of the requested table.
134
142
  # Values are of the form
135
- # `projects/<project>/instances/<instance>/tables/<table>`.
143
+ # `projects/{project}/instances/{instance}/tables/{table}`.
136
144
  # @!attribute [rw] view
137
145
  # @return [Google::Bigtable::Admin::V2::Table::View]
138
146
  # The view to be applied to the returned table's fields.
@@ -143,21 +151,21 @@ module Google
143
151
  # {Google::Bigtable::Admin::V2::BigtableTableAdmin::DeleteTable}
144
152
  # @!attribute [rw] name
145
153
  # @return [String]
146
- # The unique name of the table to be deleted.
154
+ # Required. The unique name of the table to be deleted.
147
155
  # Values are of the form
148
- # `projects/<project>/instances/<instance>/tables/<table>`.
156
+ # `projects/{project}/instances/{instance}/tables/{table}`.
149
157
  class DeleteTableRequest; end
150
158
 
151
159
  # Request message for
152
160
  # {Google::Bigtable::Admin::V2::BigtableTableAdmin::ModifyColumnFamilies}
153
161
  # @!attribute [rw] name
154
162
  # @return [String]
155
- # The unique name of the table whose families should be modified.
163
+ # Required. The unique name of the table whose families should be modified.
156
164
  # Values are of the form
157
- # `projects/<project>/instances/<instance>/tables/<table>`.
165
+ # `projects/{project}/instances/{instance}/tables/{table}`.
158
166
  # @!attribute [rw] modifications
159
167
  # @return [Array<Google::Bigtable::Admin::V2::ModifyColumnFamiliesRequest::Modification>]
160
- # Modifications to be atomically applied to the specified table's families.
168
+ # Required. Modifications to be atomically applied to the specified table's families.
161
169
  # Entries are applied in order, meaning that earlier modifications can be
162
170
  # masked by later ones (in the case of repeated updates to the same family,
163
171
  # for example).
@@ -185,9 +193,9 @@ module Google
185
193
  # {Google::Bigtable::Admin::V2::BigtableTableAdmin::GenerateConsistencyToken}
186
194
  # @!attribute [rw] name
187
195
  # @return [String]
188
- # The unique name of the Table for which to create a consistency token.
196
+ # Required. The unique name of the Table for which to create a consistency token.
189
197
  # Values are of the form
190
- # `projects/<project>/instances/<instance>/tables/<table>`.
198
+ # `projects/{project}/instances/{instance}/tables/{table}`.
191
199
  class GenerateConsistencyTokenRequest; end
192
200
 
193
201
  # Response message for
@@ -201,12 +209,12 @@ module Google
201
209
  # {Google::Bigtable::Admin::V2::BigtableTableAdmin::CheckConsistency}
202
210
  # @!attribute [rw] name
203
211
  # @return [String]
204
- # The unique name of the Table for which to check replication consistency.
212
+ # Required. The unique name of the Table for which to check replication consistency.
205
213
  # Values are of the form
206
- # `projects/<project>/instances/<instance>/tables/<table>`.
214
+ # `projects/{project}/instances/{instance}/tables/{table}`.
207
215
  # @!attribute [rw] consistency_token
208
216
  # @return [String]
209
- # The token created using GenerateConsistencyToken for the Table.
217
+ # Required. The token created using GenerateConsistencyToken for the Table.
210
218
  class CheckConsistencyRequest; end
211
219
 
212
220
  # Response message for
@@ -228,18 +236,18 @@ module Google
228
236
  # @return [String]
229
237
  # The unique name of the table to have the snapshot taken.
230
238
  # Values are of the form
231
- # `projects/<project>/instances/<instance>/tables/<table>`.
239
+ # `projects/{project}/instances/{instance}/tables/{table}`.
232
240
  # @!attribute [rw] cluster
233
241
  # @return [String]
234
242
  # The name of the cluster where the snapshot will be created in.
235
243
  # Values are of the form
236
- # `projects/<project>/instances/<instance>/clusters/<cluster>`.
244
+ # `projects/{project}/instances/{instance}/clusters/{cluster}`.
237
245
  # @!attribute [rw] snapshot_id
238
246
  # @return [String]
239
247
  # The ID by which the new snapshot should be referred to within the parent
240
248
  # cluster, e.g., `mysnapshot` of the form: `[_a-zA-Z0-9][-_.a-zA-Z0-9]*`
241
249
  # rather than
242
- # `projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/mysnapshot`.
250
+ # `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/mysnapshot`.
243
251
  # @!attribute [rw] ttl
244
252
  # @return [Google::Protobuf::Duration]
245
253
  # The amount of time that the new snapshot can stay active after it is
@@ -260,9 +268,9 @@ module Google
260
268
  # for production use. It is not subject to any SLA or deprecation policy.
261
269
  # @!attribute [rw] name
262
270
  # @return [String]
263
- # The unique name of the requested snapshot.
271
+ # Required. The unique name of the requested snapshot.
264
272
  # Values are of the form
265
- # `projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>`.
273
+ # `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
266
274
  class GetSnapshotRequest; end
267
275
 
268
276
  # Request message for
@@ -274,11 +282,11 @@ module Google
274
282
  # for production use. It is not subject to any SLA or deprecation policy.
275
283
  # @!attribute [rw] parent
276
284
  # @return [String]
277
- # The unique name of the cluster for which snapshots should be listed.
285
+ # Required. The unique name of the cluster for which snapshots should be listed.
278
286
  # Values are of the form
279
- # `projects/<project>/instances/<instance>/clusters/<cluster>`.
280
- # Use `<cluster> = '-'` to list snapshots for all clusters in an instance,
281
- # e.g., `projects/<project>/instances/<instance>/clusters/-`.
287
+ # `projects/{project}/instances/{instance}/clusters/{cluster}`.
288
+ # Use `{cluster} = '-'` to list snapshots for all clusters in an instance,
289
+ # e.g., `projects/{project}/instances/{instance}/clusters/-`.
282
290
  # @!attribute [rw] page_size
283
291
  # @return [Integer]
284
292
  # The maximum number of snapshots to return per page.
@@ -314,9 +322,9 @@ module Google
314
322
  # for production use. It is not subject to any SLA or deprecation policy.
315
323
  # @!attribute [rw] name
316
324
  # @return [String]
317
- # The unique name of the snapshot to be deleted.
325
+ # Required. The unique name of the snapshot to be deleted.
318
326
  # Values are of the form
319
- # `projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>`.
327
+ # `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
320
328
  class DeleteSnapshotRequest; end
321
329
 
322
330
  # The metadata for the Operation returned by SnapshotTable.
data/lib/google/cloud/bigtable/admin/v2/doc/google/bigtable/admin/v2/instance.rb CHANGED
@@ -19,16 +19,15 @@ module Google
19
19
  module V2
20
20
  # A collection of Bigtable {Google::Bigtable::Admin::V2::Table Tables} and
21
21
  # the resources that serve them.
22
- # All tables in an instance are served from a single
23
- # {Google::Bigtable::Admin::V2::Cluster Cluster}.
22
+ # All tables in an instance are served from all
23
+ # {Google::Bigtable::Admin::V2::Cluster Clusters} in the instance.
24
24
  # @!attribute [rw] name
25
25
  # @return [String]
26
- # (`OutputOnly`)
27
26
  # The unique name of the instance. Values are of the form
28
- # `projects/<project>/instances/[a-z][a-z0-9\\-]+[a-z0-9]`.
27
+ # `projects/{project}/instances/[a-z][a-z0-9\\-]+[a-z0-9]`.
29
28
  # @!attribute [rw] display_name
30
29
  # @return [String]
31
- # The descriptive name for this instance as it appears in UIs.
30
+ # Required. The descriptive name for this instance as it appears in UIs.
32
31
  # Can be changed at any time, but should be kept globally unique
33
32
  # to avoid confusion.
34
33
  # @!attribute [rw] state
@@ -93,23 +92,21 @@ module Google
93
92
  # {Google::Bigtable::Admin::V2::Instance Instance}.
94
93
  # @!attribute [rw] name
95
94
  # @return [String]
96
- # (`OutputOnly`)
97
95
  # The unique name of the cluster. Values are of the form
98
- # `projects/<project>/instances/<instance>/clusters/[a-z][-a-z0-9]*`.
96
+ # `projects/{project}/instances/{instance}/clusters/[a-z][-a-z0-9]*`.
99
97
  # @!attribute [rw] location
100
98
  # @return [String]
101
99
  # (`CreationOnly`)
102
100
  # The location where this cluster's nodes and storage reside. For best
103
101
  # performance, clients should be located as close as possible to this
104
102
  # cluster. Currently only zones are supported, so values should be of the
105
- # form `projects/<project>/locations/<zone>`.
103
+ # form `projects/{project}/locations/{zone}`.
106
104
  # @!attribute [rw] state
107
105
  # @return [Google::Bigtable::Admin::V2::Cluster::State]
108
- # (`OutputOnly`)
109
106
  # The current state of the cluster.
110
107
  # @!attribute [rw] serve_nodes
111
108
  # @return [Integer]
112
- # The number of nodes allocated to this cluster. More nodes enable higher
109
+ # Required. The number of nodes allocated to this cluster. More nodes enable higher
113
110
  # throughput and more consistent performance.
114
111
  # @!attribute [rw] default_storage_type
115
112
  # @return [Google::Bigtable::Admin::V2::StorageType]
@@ -165,19 +162,20 @@ module Google
165
162
  # Optional long form description of the use case for this AppProfile.
166
163
  # @!attribute [rw] multi_cluster_routing_use_any
167
164
  # @return [Google::Bigtable::Admin::V2::AppProfile::MultiClusterRoutingUseAny]
168
- # Use a multi-cluster routing policy that may pick any cluster.
165
+ # Use a multi-cluster routing policy.
169
166
  # @!attribute [rw] single_cluster_routing
170
167
  # @return [Google::Bigtable::Admin::V2::AppProfile::SingleClusterRouting]
171
168
  # Use a single-cluster routing policy.
172
169
  class AppProfile
173
- # Read/write requests may be routed to any cluster in the instance, and will
174
- # fail over to another cluster in the event of transient errors or delays.
175
- # Choosing this option sacrifices read-your-writes consistency to improve
176
- # availability.
170
+ # Read/write requests are routed to the nearest cluster in the instance, and
171
+ # will fail over to the nearest cluster that is available in the event of
172
+ # transient errors or delays. Clusters in a region are considered
173
+ # equidistant. Choosing this option sacrifices read-your-writes consistency
174
+ # to improve availability.
177
175
  class MultiClusterRoutingUseAny; end
178
176
 
179
177
  # Unconditionally routes all read/write requests to a specific cluster.
180
- # This option preserves read-your-writes consistency, but does not improve
178
+ # This option preserves read-your-writes consistency but does not improve
181
179
  # availability.
182
180
  # @!attribute [rw] cluster_id
183
181
  # @return [String]