google-cloud-bigtable 1.1.0 → 1.2.0

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d5a23f16f0330f474a569b573e9651402b1494e0d6549a93bd09a92e74276866
4
- data.tar.gz: 2f876607d84147ef39875f8fd476ee278fc0d31bad9e70db70d752eac33bc4fb
3
+ metadata.gz: 7482026aa78be2730c7c84f2f9eb94b777b99a900903757b432b554018609e59
4
+ data.tar.gz: 1bd67186d8e0b9b768dc15cf8c639dcdc17061fb8553c7102b3cd419540c3d88
5
5
  SHA512:
6
- metadata.gz: 8cceac32a50ad779a690fe989ba58c6723e876a0125045e9c380740e550781710a4b7c4c79b5954029d9b334dc43a87b29624cd09d1a769c0960fa0fc7e3027e
7
- data.tar.gz: afdb9a5c2ef03fd8471cc6fa1746ba2aecd8e96618dd3049a035ee42f6c5fbbc9439367c299101c59edf20731847eb0444b5937c72711a18d1de8c534fdc2759
6
+ metadata.gz: f55df34a047ea018755dfc3e0e68dd617f262fc0216ba53a65c6fd9b3d854aaf722d6a5cfa01d5d3cefc548767471688e049fcb309f5beccb3c92a8a66d6e43c
7
+ data.tar.gz: 34dd6cebddf95f056bb33d4e57206fbb8d5ac35865205d87c87c8a26288c44729a96b0e7d21941821d064302d88e955ad34bb1e59672edc571d22cf41c7c9acb
@@ -1,5 +1,11 @@
1
1
  # Release History
2
2
 
3
+ ### 1.2.0 / 2020-03-11
4
+
5
+ #### Features
6
+
7
+ * Support separate project setting for quota/billing
8
+
3
9
  ### 1.1.0 / 2020-02-10
4
10
 
5
11
  #### Features
@@ -5,6 +5,9 @@
5
5
  require 'google/protobuf'
6
6
 
7
7
  require 'google/api/annotations_pb'
8
+ require 'google/api/client_pb'
9
+ require 'google/api/field_behavior_pb'
10
+ require 'google/api/resource_pb'
8
11
  require 'google/bigtable/admin/v2/instance_pb'
9
12
  require 'google/iam/v1/iam_policy_pb'
10
13
  require 'google/iam/v1/policy_pb'
@@ -1,7 +1,7 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # Source: google/bigtable/admin/v2/bigtable_instance_admin.proto for package 'google.bigtable.admin.v2'
3
3
  # Original file comments:
4
- # Copyright 2018 Google LLC.
4
+ # Copyright 2019 Google LLC.
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -43,9 +43,12 @@ module Google
43
43
  rpc :GetInstance, GetInstanceRequest, Instance
44
44
  # Lists information about instances in a project.
45
45
  rpc :ListInstances, ListInstancesRequest, ListInstancesResponse
46
- # Updates an instance within a project.
46
+ # Updates an instance within a project. This method updates only the display
47
+ # name and type for an Instance. To update other Instance properties, such as
48
+ # labels, use PartialUpdateInstance.
47
49
  rpc :UpdateInstance, Instance, Instance
48
- # Partially updates an instance within a project.
50
+ # Partially updates an instance within a project. This method can modify all
51
+ # fields of an Instance and is the preferred way to update an Instance.
49
52
  rpc :PartialUpdateInstance, PartialUpdateInstanceRequest, Google::Longrunning::Operation
50
53
  # Delete an instance from a project.
51
54
  rpc :DeleteInstance, DeleteInstanceRequest, Google::Protobuf::Empty
@@ -5,6 +5,9 @@
5
5
  require 'google/protobuf'
6
6
 
7
7
  require 'google/api/annotations_pb'
8
+ require 'google/api/client_pb'
9
+ require 'google/api/field_behavior_pb'
10
+ require 'google/api/resource_pb'
8
11
  require 'google/bigtable/admin/v2/table_pb'
9
12
  require 'google/iam/v1/iam_policy_pb'
10
13
  require 'google/iam/v1/policy_pb'
@@ -1,7 +1,7 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # Source: google/bigtable/admin/v2/bigtable_table_admin.proto for package 'google.bigtable.admin.v2'
3
3
  # Original file comments:
4
- # Copyright 2018 Google LLC.
4
+ # Copyright 2019 Google LLC.
5
5
  #
6
6
  # Licensed under the Apache License, Version 2.0 (the "License");
7
7
  # you may not use this file except in compliance with the License.
@@ -109,11 +109,12 @@ module Google
109
109
  # recommended for production use. It is not subject to any SLA or deprecation
110
110
  # policy.
111
111
  rpc :DeleteSnapshot, DeleteSnapshotRequest, Google::Protobuf::Empty
112
- # Gets the access control policy for a table resource. Returns an empty
113
- # policy if an table exists but does not have a policy set.
112
+ # Gets the access control policy for a resource.
113
+ # Returns an empty policy if the resource exists but does not have a policy
114
+ # set.
114
115
  rpc :GetIamPolicy, Google::Iam::V1::GetIamPolicyRequest, Google::Iam::V1::Policy
115
- # Sets the access control policy on a table resource. Replaces any existing
116
- # policy.
116
+ # Sets the access control policy on a Table or Backup resource.
117
+ # Replaces any existing policy.
117
118
  rpc :SetIamPolicy, Google::Iam::V1::SetIamPolicyRequest, Google::Iam::V1::Policy
118
119
  # Returns permissions that the caller has on the specified table resource.
119
120
  rpc :TestIamPermissions, Google::Iam::V1::TestIamPermissionsRequest, Google::Iam::V1::TestIamPermissionsResponse
@@ -5,6 +5,8 @@
5
5
  require 'google/protobuf'
6
6
 
7
7
  require 'google/api/annotations_pb'
8
+ require 'google/api/field_behavior_pb'
9
+ require 'google/api/resource_pb'
8
10
  require 'google/bigtable/admin/v2/common_pb'
9
11
  Google::Protobuf::DescriptorPool.generated_pool.build do
10
12
  add_message "google.bigtable.admin.v2.Instance" do
@@ -5,6 +5,8 @@
5
5
  require 'google/protobuf'
6
6
 
7
7
  require 'google/api/annotations_pb'
8
+ require 'google/api/field_behavior_pb'
9
+ require 'google/api/resource_pb'
8
10
  require 'google/protobuf/duration_pb'
9
11
  require 'google/protobuf/timestamp_pb'
10
12
  Google::Protobuf::DescriptorPool.generated_pool.build do
@@ -22,10 +22,10 @@ module Google
22
22
  # rubocop:disable LineLength
23
23
 
24
24
  ##
25
- # # Ruby Client for Cloud Bigtable Admin API ([GA](https://github.com/googleapis/google-cloud-ruby#versioning))
25
+ # # Ruby Client for Cloud Bigtable Admin API
26
26
  #
27
27
  # [Cloud Bigtable Admin API][Product Documentation]:
28
- #
28
+ # Administer your Cloud Bigtable tables and instances.
29
29
  # - [Product Documentation][]
30
30
  #
31
31
  # ## Quick Start
@@ -25,10 +25,10 @@ module Google
25
25
  # rubocop:disable LineLength
26
26
 
27
27
  ##
28
- # # Ruby Client for Cloud Bigtable Admin API ([GA](https://github.com/googleapis/google-cloud-ruby#versioning))
28
+ # # Ruby Client for Cloud Bigtable Admin API
29
29
  #
30
30
  # [Cloud Bigtable Admin API][Product Documentation]:
31
- #
31
+ # Administer your Cloud Bigtable tables and instances.
32
32
  # - [Product Documentation][]
33
33
  #
34
34
  # ## Quick Start
@@ -262,6 +262,9 @@ module Google
262
262
  google_api_client.freeze
263
263
 
264
264
  headers = { :"x-goog-api-client" => google_api_client }
265
+ if credentials.respond_to?(:quota_project_id) && credentials.quota_project_id
266
+ headers[:"x-goog-user-project"] = credentials.quota_project_id
267
+ end
265
268
  headers.merge!(metadata) unless metadata.nil?
266
269
  client_config_file = Pathname.new(__dir__).join(
267
270
  "bigtable_instance_admin_client_config.json"
@@ -453,23 +456,23 @@ module Google
453
456
  # Create an instance within a project.
454
457
  #
455
458
  # @param parent [String]
456
- # The unique name of the project in which to create the new instance.
457
- # Values are of the form `projects/<project>`.
459
+ # Required. The unique name of the project in which to create the new instance.
460
+ # Values are of the form `projects/{project}`.
458
461
  # @param instance_id [String]
459
- # The ID to be used when referring to the new instance within its project,
462
+ # Required. The ID to be used when referring to the new instance within its project,
460
463
  # e.g., just `myinstance` rather than
461
464
  # `projects/myproject/instances/myinstance`.
462
465
  # @param instance [Google::Bigtable::Admin::V2::Instance | Hash]
463
- # The instance to create.
466
+ # Required. The instance to create.
464
467
  # Fields marked `OutputOnly` must be left blank.
465
468
  # A hash of the same form as `Google::Bigtable::Admin::V2::Instance`
466
469
  # can also be provided.
467
470
  # @param clusters [Hash{String => Google::Bigtable::Admin::V2::Cluster | Hash}]
468
- # The clusters to be created within the instance, mapped by desired
471
+ # Required. The clusters to be created within the instance, mapped by desired
469
472
  # cluster ID, e.g., just `mycluster` rather than
470
473
  # `projects/myproject/instances/myinstance/clusters/mycluster`.
471
474
  # Fields marked `OutputOnly` must be left blank.
472
- # Currently, at most two clusters can be specified.
475
+ # Currently, at most four clusters can be specified.
473
476
  # A hash of the same form as `Google::Bigtable::Admin::V2::Cluster`
474
477
  # can also be provided.
475
478
  # @param options [Google::Gax::CallOptions]
@@ -546,8 +549,8 @@ module Google
546
549
  # Gets information about an instance.
547
550
  #
548
551
  # @param name [String]
549
- # The unique name of the requested instance. Values are of the form
550
- # `projects/<project>/instances/<instance>`.
552
+ # Required. The unique name of the requested instance. Values are of the form
553
+ # `projects/{project}/instances/{instance}`.
551
554
  # @param options [Google::Gax::CallOptions]
552
555
  # Overrides the default settings for this call, e.g, timeout,
553
556
  # retries, etc.
@@ -577,8 +580,8 @@ module Google
577
580
  # Lists information about instances in a project.
578
581
  #
579
582
  # @param parent [String]
580
- # The unique name of the project for which a list of instances is requested.
581
- # Values are of the form `projects/<project>`.
583
+ # Required. The unique name of the project for which a list of instances is requested.
584
+ # Values are of the form `projects/{project}`.
582
585
  # @param page_token [String]
583
586
  # DEPRECATED: This field is unused and ignored.
584
587
  # @param options [Google::Gax::CallOptions]
@@ -609,14 +612,15 @@ module Google
609
612
  @list_instances.call(req, options, &block)
610
613
  end
611
614
 
612
- # Updates an instance within a project.
615
+ # Updates an instance within a project. This method updates only the display
616
+ # name and type for an Instance. To update other Instance properties, such as
617
+ # labels, use PartialUpdateInstance.
613
618
  #
614
619
  # @param name [String]
615
- # (`OutputOnly`)
616
620
  # The unique name of the instance. Values are of the form
617
- # `projects/<project>/instances/[a-z][a-z0-9\\-]+[a-z0-9]`.
621
+ # `projects/{project}/instances/[a-z][a-z0-9\\-]+[a-z0-9]`.
618
622
  # @param display_name [String]
619
- # The descriptive name for this instance as it appears in UIs.
623
+ # Required. The descriptive name for this instance as it appears in UIs.
620
624
  # Can be changed at any time, but should be kept globally unique
621
625
  # to avoid confusion.
622
626
  # @param type [Google::Bigtable::Admin::V2::Instance::Type]
@@ -679,14 +683,15 @@ module Google
679
683
  @update_instance.call(req, options, &block)
680
684
  end
681
685
 
682
- # Partially updates an instance within a project.
686
+ # Partially updates an instance within a project. This method can modify all
687
+ # fields of an Instance and is the preferred way to update an Instance.
683
688
  #
684
689
  # @param instance [Google::Bigtable::Admin::V2::Instance | Hash]
685
- # The Instance which will (partially) replace the current value.
690
+ # Required. The Instance which will (partially) replace the current value.
686
691
  # A hash of the same form as `Google::Bigtable::Admin::V2::Instance`
687
692
  # can also be provided.
688
693
  # @param update_mask [Google::Protobuf::FieldMask | Hash]
689
- # The subset of Instance fields which should be replaced.
694
+ # Required. The subset of Instance fields which should be replaced.
690
695
  # Must be explicitly set.
691
696
  # A hash of the same form as `Google::Protobuf::FieldMask`
692
697
  # can also be provided.
@@ -756,8 +761,8 @@ module Google
756
761
  # Delete an instance from a project.
757
762
  #
758
763
  # @param name [String]
759
- # The unique name of the instance to be deleted.
760
- # Values are of the form `projects/<project>/instances/<instance>`.
764
+ # Required. The unique name of the instance to be deleted.
765
+ # Values are of the form `projects/{project}/instances/{instance}`.
761
766
  # @param options [Google::Gax::CallOptions]
762
767
  # Overrides the default settings for this call, e.g, timeout,
763
768
  # retries, etc.
@@ -787,15 +792,15 @@ module Google
787
792
  # Creates a cluster within an instance.
788
793
  #
789
794
  # @param parent [String]
790
- # The unique name of the instance in which to create the new cluster.
795
+ # Required. The unique name of the instance in which to create the new cluster.
791
796
  # Values are of the form
792
- # `projects/<project>/instances/<instance>`.
797
+ # `projects/{project}/instances/{instance}`.
793
798
  # @param cluster_id [String]
794
- # The ID to be used when referring to the new cluster within its instance,
799
+ # Required. The ID to be used when referring to the new cluster within its instance,
795
800
  # e.g., just `mycluster` rather than
796
801
  # `projects/myproject/instances/myinstance/clusters/mycluster`.
797
802
  # @param cluster [Google::Bigtable::Admin::V2::Cluster | Hash]
798
- # The cluster to be created.
803
+ # Required. The cluster to be created.
799
804
  # Fields marked `OutputOnly` must be left blank.
800
805
  # A hash of the same form as `Google::Bigtable::Admin::V2::Cluster`
801
806
  # can also be provided.
@@ -868,8 +873,8 @@ module Google
868
873
  # Gets information about a cluster.
869
874
  #
870
875
  # @param name [String]
871
- # The unique name of the requested cluster. Values are of the form
872
- # `projects/<project>/instances/<instance>/clusters/<cluster>`.
876
+ # Required. The unique name of the requested cluster. Values are of the form
877
+ # `projects/{project}/instances/{instance}/clusters/{cluster}`.
873
878
  # @param options [Google::Gax::CallOptions]
874
879
  # Overrides the default settings for this call, e.g, timeout,
875
880
  # retries, etc.
@@ -899,9 +904,9 @@ module Google
899
904
  # Lists information about clusters in an instance.
900
905
  #
901
906
  # @param parent [String]
902
- # The unique name of the instance for which a list of clusters is requested.
903
- # Values are of the form `projects/<project>/instances/<instance>`.
904
- # Use `<instance> = '-'` to list Clusters for all Instances in a project,
907
+ # Required. The unique name of the instance for which a list of clusters is requested.
908
+ # Values are of the form `projects/{project}/instances/{instance}`.
909
+ # Use `{instance} = '-'` to list Clusters for all Instances in a project,
905
910
  # e.g., `projects/myproject/instances/-`.
906
911
  # @param page_token [String]
907
912
  # DEPRECATED: This field is unused and ignored.
@@ -936,20 +941,18 @@ module Google
936
941
  # Updates a cluster within an instance.
937
942
  #
938
943
  # @param name [String]
939
- # (`OutputOnly`)
940
944
  # The unique name of the cluster. Values are of the form
941
- # `projects/<project>/instances/<instance>/clusters/[a-z][-a-z0-9]*`.
945
+ # `projects/{project}/instances/{instance}/clusters/[a-z][-a-z0-9]*`.
942
946
  # @param serve_nodes [Integer]
943
- # The number of nodes allocated to this cluster. More nodes enable higher
947
+ # Required. The number of nodes allocated to this cluster. More nodes enable higher
944
948
  # throughput and more consistent performance.
945
949
  # @param location [String]
946
950
  # (`CreationOnly`)
947
951
  # The location where this cluster's nodes and storage reside. For best
948
952
  # performance, clients should be located as close as possible to this
949
953
  # cluster. Currently only zones are supported, so values should be of the
950
- # form `projects/<project>/locations/<zone>`.
954
+ # form `projects/{project}/locations/{zone}`.
951
955
  # @param state [Google::Bigtable::Admin::V2::Cluster::State]
952
- # (`OutputOnly`)
953
956
  # The current state of the cluster.
954
957
  # @param default_storage_type [Google::Bigtable::Admin::V2::StorageType]
955
958
  # (`CreationOnly`)
@@ -1025,8 +1028,8 @@ module Google
1025
1028
  # Deletes a cluster from an instance.
1026
1029
  #
1027
1030
  # @param name [String]
1028
- # The unique name of the cluster to be deleted. Values are of the form
1029
- # `projects/<project>/instances/<instance>/clusters/<cluster>`.
1031
+ # Required. The unique name of the cluster to be deleted. Values are of the form
1032
+ # `projects/{project}/instances/{instance}/clusters/{cluster}`.
1030
1033
  # @param options [Google::Gax::CallOptions]
1031
1034
  # Overrides the default settings for this call, e.g, timeout,
1032
1035
  # retries, etc.
@@ -1056,15 +1059,15 @@ module Google
1056
1059
  # Creates an app profile within an instance.
1057
1060
  #
1058
1061
  # @param parent [String]
1059
- # The unique name of the instance in which to create the new app profile.
1062
+ # Required. The unique name of the instance in which to create the new app profile.
1060
1063
  # Values are of the form
1061
- # `projects/<project>/instances/<instance>`.
1064
+ # `projects/{project}/instances/{instance}`.
1062
1065
  # @param app_profile_id [String]
1063
- # The ID to be used when referring to the new app profile within its
1066
+ # Required. The ID to be used when referring to the new app profile within its
1064
1067
  # instance, e.g., just `myprofile` rather than
1065
1068
  # `projects/myproject/instances/myinstance/appProfiles/myprofile`.
1066
1069
  # @param app_profile [Google::Bigtable::Admin::V2::AppProfile | Hash]
1067
- # The app profile to be created.
1070
+ # Required. The app profile to be created.
1068
1071
  # Fields marked `OutputOnly` will be ignored.
1069
1072
  # A hash of the same form as `Google::Bigtable::Admin::V2::AppProfile`
1070
1073
  # can also be provided.
@@ -1111,8 +1114,8 @@ module Google
1111
1114
  # Gets information about an app profile.
1112
1115
  #
1113
1116
  # @param name [String]
1114
- # The unique name of the requested app profile. Values are of the form
1115
- # `projects/<project>/instances/<instance>/appProfiles/<app_profile>`.
1117
+ # Required. The unique name of the requested app profile. Values are of the form
1118
+ # `projects/{project}/instances/{instance}/appProfiles/{app_profile}`.
1116
1119
  # @param options [Google::Gax::CallOptions]
1117
1120
  # Overrides the default settings for this call, e.g, timeout,
1118
1121
  # retries, etc.
@@ -1142,14 +1145,21 @@ module Google
1142
1145
  # Lists information about app profiles in an instance.
1143
1146
  #
1144
1147
  # @param parent [String]
1145
- # The unique name of the instance for which a list of app profiles is
1148
+ # Required. The unique name of the instance for which a list of app profiles is
1146
1149
  # requested. Values are of the form
1147
- # `projects/<project>/instances/<instance>`.
1148
- # Use `<instance> = '-'` to list AppProfiles for all Instances in a project,
1150
+ # `projects/{project}/instances/{instance}`.
1151
+ # Use `{instance} = '-'` to list AppProfiles for all Instances in a project,
1149
1152
  # e.g., `projects/myproject/instances/-`.
1150
1153
  # @param page_size [Integer]
1151
1154
  # Maximum number of results per page.
1152
- # CURRENTLY UNIMPLEMENTED AND IGNORED.
1155
+ #
1156
+ # A page_size of zero lets the server choose the number of items to return.
1157
+ # A page_size which is strictly positive will return at most that many items.
1158
+ # A negative page_size will cause an error.
1159
+ #
1160
+ # Following the first request, subsequent paginated calls are not required
1161
+ # to pass a page_size. If a page_size is set in subsequent calls, it must
1162
+ # match the page_size given in the first request.
1153
1163
  # @param options [Google::Gax::CallOptions]
1154
1164
  # Overrides the default settings for this call, e.g, timeout,
1155
1165
  # retries, etc.
@@ -1197,11 +1207,11 @@ module Google
1197
1207
  # Updates an app profile within an instance.
1198
1208
  #
1199
1209
  # @param app_profile [Google::Bigtable::Admin::V2::AppProfile | Hash]
1200
- # The app profile which will (partially) replace the current value.
1210
+ # Required. The app profile which will (partially) replace the current value.
1201
1211
  # A hash of the same form as `Google::Bigtable::Admin::V2::AppProfile`
1202
1212
  # can also be provided.
1203
1213
  # @param update_mask [Google::Protobuf::FieldMask | Hash]
1204
- # The subset of app profile fields which should be replaced.
1214
+ # Required. The subset of app profile fields which should be replaced.
1205
1215
  # If unset, all fields will be replaced.
1206
1216
  # A hash of the same form as `Google::Protobuf::FieldMask`
1207
1217
  # can also be provided.
@@ -1275,8 +1285,8 @@ module Google
1275
1285
  # Deletes an app profile from an instance.
1276
1286
  #
1277
1287
  # @param name [String]
1278
- # The unique name of the app profile to be deleted. Values are of the form
1279
- # `projects/<project>/instances/<instance>/appProfiles/<app_profile>`.
1288
+ # Required. The unique name of the app profile to be deleted. Values are of the form
1289
+ # `projects/{project}/instances/{instance}/appProfiles/{app_profile}`.
1280
1290
  # @param ignore_warnings [true, false]
1281
1291
  # If true, ignore safety checks when deleting the app profile.
1282
1292
  # @param options [Google::Gax::CallOptions]
@@ -39,7 +39,7 @@
39
39
  },
40
40
  "methods": {
41
41
  "CreateInstance": {
42
- "timeout_millis": 60000,
42
+ "timeout_millis": 300000,
43
43
  "retry_codes_name": "non_idempotent",
44
44
  "retry_params_name": "non_idempotent_heavy_params"
45
45
  },
@@ -257,6 +257,9 @@ module Google
257
257
  google_api_client.freeze
258
258
 
259
259
  headers = { :"x-goog-api-client" => google_api_client }
260
+ if credentials.respond_to?(:quota_project_id) && credentials.quota_project_id
261
+ headers[:"x-goog-user-project"] = credentials.quota_project_id
262
+ end
260
263
  headers.merge!(metadata) unless metadata.nil?
261
264
  client_config_file = Pathname.new(__dir__).join(
262
265
  "bigtable_table_admin_client_config.json"
@@ -426,13 +429,14 @@ module Google
426
429
  # specified in the request.
427
430
  #
428
431
  # @param parent [String]
429
- # The unique name of the instance in which to create the table.
430
- # Values are of the form `projects/<project>/instances/<instance>`.
432
+ # Required. The unique name of the instance in which to create the table.
433
+ # Values are of the form `projects/{project}/instances/{instance}`.
431
434
  # @param table_id [String]
432
- # The name by which the new table should be referred to within the parent
433
- # instance, e.g., `foobar` rather than `<parent>/tables/foobar`.
435
+ # Required. The name by which the new table should be referred to within the parent
436
+ # instance, e.g., `foobar` rather than `{parent}/tables/foobar`.
437
+ # Maximum 50 characters.
434
438
  # @param table [Google::Bigtable::Admin::V2::Table | Hash]
435
- # The Table to create.
439
+ # Required. The Table to create.
436
440
  # A hash of the same form as `Google::Bigtable::Admin::V2::Table`
437
441
  # can also be provided.
438
442
  # @param initial_splits [Array<Google::Bigtable::Admin::V2::CreateTableRequest::Split | Hash>]
@@ -502,16 +506,16 @@ module Google
502
506
  # policy.
503
507
  #
504
508
  # @param parent [String]
505
- # The unique name of the instance in which to create the table.
506
- # Values are of the form `projects/<project>/instances/<instance>`.
509
+ # Required. The unique name of the instance in which to create the table.
510
+ # Values are of the form `projects/{project}/instances/{instance}`.
507
511
  # @param table_id [String]
508
- # The name by which the new table should be referred to within the parent
509
- # instance, e.g., `foobar` rather than `<parent>/tables/foobar`.
512
+ # Required. The name by which the new table should be referred to within the parent
513
+ # instance, e.g., `foobar` rather than `{parent}/tables/foobar`.
510
514
  # @param source_snapshot [String]
511
- # The unique name of the snapshot from which to restore the table. The
515
+ # Required. The unique name of the snapshot from which to restore the table. The
512
516
  # snapshot and the table must be in the same instance.
513
517
  # Values are of the form
514
- # `projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>`.
518
+ # `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
515
519
  # @param options [Google::Gax::CallOptions]
516
520
  # Overrides the default settings for this call, e.g, timeout,
517
521
  # retries, etc.
@@ -581,14 +585,21 @@ module Google
581
585
  # Lists all tables served from a specified instance.
582
586
  #
583
587
  # @param parent [String]
584
- # The unique name of the instance for which tables should be listed.
585
- # Values are of the form `projects/<project>/instances/<instance>`.
588
+ # Required. The unique name of the instance for which tables should be listed.
589
+ # Values are of the form `projects/{project}/instances/{instance}`.
586
590
  # @param view [Google::Bigtable::Admin::V2::Table::View]
587
591
  # The view to be applied to the returned tables' fields.
588
- # Defaults to `NAME_ONLY` if unspecified; no others are currently supported.
592
+ # Only NAME_ONLY view (default) and REPLICATION_VIEW are supported.
589
593
  # @param page_size [Integer]
590
594
  # Maximum number of results per page.
591
- # CURRENTLY UNIMPLEMENTED AND IGNORED.
595
+ #
596
+ # A page_size of zero lets the server choose the number of items to return.
597
+ # A page_size which is strictly positive will return at most that many items.
598
+ # A negative page_size will cause an error.
599
+ #
600
+ # Following the first request, subsequent paginated calls are not required
601
+ # to pass a page_size. If a page_size is set in subsequent calls, it must
602
+ # match the page_size given in the first request.
592
603
  # @param options [Google::Gax::CallOptions]
593
604
  # Overrides the default settings for this call, e.g, timeout,
594
605
  # retries, etc.
@@ -638,9 +649,9 @@ module Google
638
649
  # Gets metadata information about the specified table.
639
650
  #
640
651
  # @param name [String]
641
- # The unique name of the requested table.
652
+ # Required. The unique name of the requested table.
642
653
  # Values are of the form
643
- # `projects/<project>/instances/<instance>/tables/<table>`.
654
+ # `projects/{project}/instances/{instance}/tables/{table}`.
644
655
  # @param view [Google::Bigtable::Admin::V2::Table::View]
645
656
  # The view to be applied to the returned table's fields.
646
657
  # Defaults to `SCHEMA_VIEW` if unspecified.
@@ -675,9 +686,9 @@ module Google
675
686
  # Permanently deletes a specified table and all of its data.
676
687
  #
677
688
  # @param name [String]
678
- # The unique name of the table to be deleted.
689
+ # Required. The unique name of the table to be deleted.
679
690
  # Values are of the form
680
- # `projects/<project>/instances/<instance>/tables/<table>`.
691
+ # `projects/{project}/instances/{instance}/tables/{table}`.
681
692
  # @param options [Google::Gax::CallOptions]
682
693
  # Overrides the default settings for this call, e.g, timeout,
683
694
  # retries, etc.
@@ -710,11 +721,11 @@ module Google
710
721
  # where only some modifications have taken effect.
711
722
  #
712
723
  # @param name [String]
713
- # The unique name of the table whose families should be modified.
724
+ # Required. The unique name of the table whose families should be modified.
714
725
  # Values are of the form
715
- # `projects/<project>/instances/<instance>/tables/<table>`.
726
+ # `projects/{project}/instances/{instance}/tables/{table}`.
716
727
  # @param modifications [Array<Google::Bigtable::Admin::V2::ModifyColumnFamiliesRequest::Modification | Hash>]
717
- # Modifications to be atomically applied to the specified table's families.
728
+ # Required. Modifications to be atomically applied to the specified table's families.
718
729
  # Entries are applied in order, meaning that earlier modifications can be
719
730
  # masked by later ones (in the case of repeated updates to the same family,
720
731
  # for example).
@@ -756,9 +767,9 @@ module Google
756
767
  # particular prefix.
757
768
  #
758
769
  # @param name [String]
759
- # The unique name of the table on which to drop a range of rows.
770
+ # Required. The unique name of the table on which to drop a range of rows.
760
771
  # Values are of the form
761
- # `projects/<project>/instances/<instance>/tables/<table>`.
772
+ # `projects/{project}/instances/{instance}/tables/{table}`.
762
773
  # @param row_key_prefix [String]
763
774
  # Delete all rows that start with this row key prefix. Prefix cannot be
764
775
  # zero length.
@@ -800,9 +811,9 @@ module Google
800
811
  # for 90 days.
801
812
  #
802
813
  # @param name [String]
803
- # The unique name of the Table for which to create a consistency token.
814
+ # Required. The unique name of the Table for which to create a consistency token.
804
815
  # Values are of the form
805
- # `projects/<project>/instances/<instance>/tables/<table>`.
816
+ # `projects/{project}/instances/{instance}/tables/{table}`.
806
817
  # @param options [Google::Gax::CallOptions]
807
818
  # Overrides the default settings for this call, e.g, timeout,
808
819
  # retries, etc.
@@ -834,11 +845,11 @@ module Google
834
845
  # and the check request.
835
846
  #
836
847
  # @param name [String]
837
- # The unique name of the Table for which to check replication consistency.
848
+ # Required. The unique name of the Table for which to check replication consistency.
838
849
  # Values are of the form
839
- # `projects/<project>/instances/<instance>/tables/<table>`.
850
+ # `projects/{project}/instances/{instance}/tables/{table}`.
840
851
  # @param consistency_token [String]
841
- # The token created using GenerateConsistencyToken for the Table.
852
+ # Required. The token created using GenerateConsistencyToken for the Table.
842
853
  # @param options [Google::Gax::CallOptions]
843
854
  # Overrides the default settings for this call, e.g, timeout,
844
855
  # retries, etc.
@@ -870,8 +881,9 @@ module Google
870
881
  @check_consistency.call(req, options, &block)
871
882
  end
872
883
 
873
- # Gets the access control policy for a table resource. Returns an empty
874
- # policy if an table exists but does not have a policy set.
884
+ # Gets the access control policy for a resource.
885
+ # Returns an empty policy if the resource exists but does not have a policy
886
+ # set.
875
887
  #
876
888
  # @param resource [String]
877
889
  # REQUIRED: The resource for which the policy is being requested.
@@ -909,8 +921,8 @@ module Google
909
921
  @get_iam_policy.call(req, options, &block)
910
922
  end
911
923
 
912
- # Sets the access control policy on a table resource. Replaces any existing
913
- # policy.
924
+ # Sets the access control policy on a Table or Backup resource.
925
+ # Replaces any existing policy.
914
926
  #
915
927
  # @param resource [String]
916
928
  # REQUIRED: The resource for which the policy is being specified.
@@ -1006,16 +1018,16 @@ module Google
1006
1018
  # @param name [String]
1007
1019
  # The unique name of the table to have the snapshot taken.
1008
1020
  # Values are of the form
1009
- # `projects/<project>/instances/<instance>/tables/<table>`.
1021
+ # `projects/{project}/instances/{instance}/tables/{table}`.
1010
1022
  # @param cluster [String]
1011
1023
  # The name of the cluster where the snapshot will be created in.
1012
1024
  # Values are of the form
1013
- # `projects/<project>/instances/<instance>/clusters/<cluster>`.
1025
+ # `projects/{project}/instances/{instance}/clusters/{cluster}`.
1014
1026
  # @param snapshot_id [String]
1015
1027
  # The ID by which the new snapshot should be referred to within the parent
1016
1028
  # cluster, e.g., `mysnapshot` of the form: `[_a-zA-Z0-9][-_.a-zA-Z0-9]*`
1017
1029
  # rather than
1018
- # `projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/mysnapshot`.
1030
+ # `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/mysnapshot`.
1019
1031
  # @param description [String]
1020
1032
  # Description of the snapshot.
1021
1033
  # @param ttl [Google::Protobuf::Duration | Hash]
@@ -1107,9 +1119,9 @@ module Google
1107
1119
  # policy.
1108
1120
  #
1109
1121
  # @param name [String]
1110
- # The unique name of the requested snapshot.
1122
+ # Required. The unique name of the requested snapshot.
1111
1123
  # Values are of the form
1112
- # `projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>`.
1124
+ # `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
1113
1125
  # @param options [Google::Gax::CallOptions]
1114
1126
  # Overrides the default settings for this call, e.g, timeout,
1115
1127
  # retries, etc.
@@ -1145,11 +1157,11 @@ module Google
1145
1157
  # policy.
1146
1158
  #
1147
1159
  # @param parent [String]
1148
- # The unique name of the cluster for which snapshots should be listed.
1160
+ # Required. The unique name of the cluster for which snapshots should be listed.
1149
1161
  # Values are of the form
1150
- # `projects/<project>/instances/<instance>/clusters/<cluster>`.
1151
- # Use `<cluster> = '-'` to list snapshots for all clusters in an instance,
1152
- # e.g., `projects/<project>/instances/<instance>/clusters/-`.
1162
+ # `projects/{project}/instances/{instance}/clusters/{cluster}`.
1163
+ # Use `{cluster} = '-'` to list snapshots for all clusters in an instance,
1164
+ # e.g., `projects/{project}/instances/{instance}/clusters/-`.
1153
1165
  # @param page_size [Integer]
1154
1166
  # The maximum number of resources contained in the underlying API
1155
1167
  # response. If page streaming is performed per-resource, this
@@ -1209,9 +1221,9 @@ module Google
1209
1221
  # policy.
1210
1222
  #
1211
1223
  # @param name [String]
1212
- # The unique name of the snapshot to be deleted.
1224
+ # Required. The unique name of the snapshot to be deleted.
1213
1225
  # Values are of the form
1214
- # `projects/<project>/instances/<instance>/clusters/<cluster>/snapshots/<snapshot>`.
1226
+ # `projects/{project}/instances/{instance}/clusters/{cluster}/snapshots/{snapshot}`.
1215
1227
  # @param options [Google::Gax::CallOptions]
1216
1228
  # Overrides the default settings for this call, e.g, timeout,
1217
1229
  # retries, etc.