google-cloud-bigtable-admin-v2 0.6.1 → 0.8.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.yardopts +1 -1
- data/AUTHENTICATION.md +7 -25
- data/README.md +1 -1
- data/lib/google/bigtable/admin/v2/bigtable_instance_admin_pb.rb +13 -2
- data/lib/google/bigtable/admin/v2/bigtable_instance_admin_services_pb.rb +30 -1
- data/lib/google/bigtable/admin/v2/bigtable_table_admin_pb.rb +2 -2
- data/lib/google/bigtable/admin/v2/bigtable_table_admin_services_pb.rb +1 -1
- data/lib/google/bigtable/admin/v2/common_pb.rb +2 -1
- data/lib/google/bigtable/admin/v2/instance_pb.rb +26 -2
- data/lib/google/bigtable/admin/v2/table_pb.rb +2 -2
- data/lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin/client.rb +562 -60
- data/lib/google/cloud/bigtable/admin/v2/bigtable_instance_admin/operations.rb +115 -12
- data/lib/google/cloud/bigtable/admin/v2/bigtable_table_admin/client.rb +487 -66
- data/lib/google/cloud/bigtable/admin/v2/bigtable_table_admin/operations.rb +115 -12
- data/lib/google/cloud/bigtable/admin/v2/version.rb +1 -1
- data/proto_docs/google/api/resource.rb +10 -71
- data/proto_docs/google/bigtable/admin/v2/bigtable_instance_admin.rb +28 -0
- data/proto_docs/google/bigtable/admin/v2/instance.rb +54 -2
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 51f4a626f785e699393c2700bc86993e8144c23a0ff90f9dfa1f56277117b474
|
4
|
+
data.tar.gz: 7608be0bfdc048ca02d8ea8956803875406ae5e9bfeb56564740c5a2ef4200d6
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ddea900bdaadc1c8429f84861347edf7cf40a7dbb6782f92d7439085372f6af38e454922c060a6c4bd963a4090ae1a8857e1aa2a2be70743fb992dcdde8d930f
|
7
|
+
data.tar.gz: 428a46c00c62bd2342296ee21edb33e7da3728c4f56a349eb0dda37b59672cea917259a4597ce6b5a51418e052ea36f529407f5a67f662945864f6821df8864c
|
data/.yardopts
CHANGED
data/AUTHENTICATION.md
CHANGED
@@ -120,15 +120,6 @@ To configure your system for this, simply:
|
|
120
120
|
**NOTE:** This is _not_ recommended for running in production. The Cloud SDK
|
121
121
|
*should* only be used during development.
|
122
122
|
|
123
|
-
[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
|
124
|
-
[dev-console]: https://console.cloud.google.com/project
|
125
|
-
|
126
|
-
[enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
|
127
|
-
|
128
|
-
[create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
|
129
|
-
[create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
|
130
|
-
[reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
|
131
|
-
|
132
123
|
## Creating a Service Account
|
133
124
|
|
134
125
|
Google Cloud requires **Service Account Credentials** to
|
@@ -139,31 +130,22 @@ If you are not running this client within
|
|
139
130
|
[Google Cloud Platform environments](#google-cloud-platform-environments), you
|
140
131
|
need a Google Developers service account.
|
141
132
|
|
142
|
-
1. Visit the [Google
|
133
|
+
1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
|
143
134
|
2. Create a new project or click on an existing project.
|
144
|
-
3. Activate the
|
135
|
+
3. Activate the menu in the upper left and select **APIs & Services**. From
|
145
136
|
here, you will enable the APIs that your application requires.
|
146
137
|
|
147
|
-
![Enable the APIs that your application requires][enable-apis]
|
148
|
-
|
149
138
|
*Note: You may need to enable billing in order to use these services.*
|
150
139
|
|
151
140
|
4. Select **Credentials** from the side navigation.
|
152
141
|
|
153
|
-
|
154
|
-
|
155
|
-
![Create a new service account][create-new-service-account]
|
156
|
-
|
157
|
-
![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
|
158
|
-
|
159
|
-
Find the "Add credentials" drop down and select "Service account" to be
|
160
|
-
guided through downloading a new JSON key file.
|
142
|
+
Find the "Create credentials" drop down near the top of the page, and select
|
143
|
+
"Service account" to be guided through downloading a new JSON key file.
|
161
144
|
|
162
145
|
If you want to re-use an existing service account, you can easily generate a
|
163
|
-
new key file. Just select the account you wish to re-use,
|
164
|
-
|
165
|
-
|
166
|
-
![Re-use an existing service account][reuse-service-account]
|
146
|
+
new key file. Just select the account you wish to re-use, click the pencil
|
147
|
+
tool on the right side to edit the service account, select the **Keys** tab,
|
148
|
+
and then select **Add Key**.
|
167
149
|
|
168
150
|
The key file you download will be used by this library to authenticate API
|
169
151
|
requests and should be stored in a secure location.
|
data/README.md
CHANGED
@@ -24,7 +24,7 @@ In order to use this library, you first need to go through the following steps:
|
|
24
24
|
|
25
25
|
1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
|
26
26
|
1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
|
27
|
-
1. [Enable the API.](https://console.cloud.google.com/apis/library/
|
27
|
+
1. [Enable the API.](https://console.cloud.google.com/apis/library/bigtableadmin.googleapis.com)
|
28
28
|
1. {file:AUTHENTICATION.md Set up authentication.}
|
29
29
|
|
30
30
|
## Quick Start
|
@@ -1,8 +1,6 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# source: google/bigtable/admin/v2/bigtable_instance_admin.proto
|
3
3
|
|
4
|
-
require 'google/protobuf'
|
5
|
-
|
6
4
|
require 'google/api/annotations_pb'
|
7
5
|
require 'google/api/client_pb'
|
8
6
|
require 'google/api/field_behavior_pb'
|
@@ -14,6 +12,8 @@ require 'google/longrunning/operations_pb'
|
|
14
12
|
require 'google/protobuf/empty_pb'
|
15
13
|
require 'google/protobuf/field_mask_pb'
|
16
14
|
require 'google/protobuf/timestamp_pb'
|
15
|
+
require 'google/protobuf'
|
16
|
+
|
17
17
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
18
18
|
add_file("google/bigtable/admin/v2/bigtable_instance_admin.proto", :syntax => :proto3) do
|
19
19
|
add_message "google.bigtable.admin.v2.CreateInstanceRequest" do
|
@@ -81,6 +81,15 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
81
81
|
optional :request_time, :message, 2, "google.protobuf.Timestamp"
|
82
82
|
optional :finish_time, :message, 3, "google.protobuf.Timestamp"
|
83
83
|
end
|
84
|
+
add_message "google.bigtable.admin.v2.PartialUpdateClusterMetadata" do
|
85
|
+
optional :request_time, :message, 1, "google.protobuf.Timestamp"
|
86
|
+
optional :finish_time, :message, 2, "google.protobuf.Timestamp"
|
87
|
+
optional :original_request, :message, 3, "google.bigtable.admin.v2.PartialUpdateClusterRequest"
|
88
|
+
end
|
89
|
+
add_message "google.bigtable.admin.v2.PartialUpdateClusterRequest" do
|
90
|
+
optional :cluster, :message, 1, "google.bigtable.admin.v2.Cluster"
|
91
|
+
optional :update_mask, :message, 2, "google.protobuf.FieldMask"
|
92
|
+
end
|
84
93
|
add_message "google.bigtable.admin.v2.CreateAppProfileRequest" do
|
85
94
|
optional :parent, :string, 1
|
86
95
|
optional :app_profile_id, :string, 2
|
@@ -134,6 +143,8 @@ module Google
|
|
134
143
|
UpdateInstanceMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.UpdateInstanceMetadata").msgclass
|
135
144
|
CreateClusterMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.CreateClusterMetadata").msgclass
|
136
145
|
UpdateClusterMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.UpdateClusterMetadata").msgclass
|
146
|
+
PartialUpdateClusterMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.PartialUpdateClusterMetadata").msgclass
|
147
|
+
PartialUpdateClusterRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.PartialUpdateClusterRequest").msgclass
|
137
148
|
CreateAppProfileRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.CreateAppProfileRequest").msgclass
|
138
149
|
GetAppProfileRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.GetAppProfileRequest").msgclass
|
139
150
|
ListAppProfilesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.ListAppProfilesRequest").msgclass
|
@@ -30,13 +30,19 @@ module Google
|
|
30
30
|
# tables' metadata or data stored in those tables.
|
31
31
|
class Service
|
32
32
|
|
33
|
-
include GRPC::GenericService
|
33
|
+
include ::GRPC::GenericService
|
34
34
|
|
35
35
|
self.marshal_class_method = :encode
|
36
36
|
self.unmarshal_class_method = :decode
|
37
37
|
self.service_name = 'google.bigtable.admin.v2.BigtableInstanceAdmin'
|
38
38
|
|
39
39
|
# Create an instance within a project.
|
40
|
+
#
|
41
|
+
# Note that exactly one of Cluster.serve_nodes and
|
42
|
+
# Cluster.cluster_config.cluster_autoscaling_config can be set. If
|
43
|
+
# serve_nodes is set to non-zero, then the cluster is manually scaled. If
|
44
|
+
# cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is
|
45
|
+
# enabled.
|
40
46
|
rpc :CreateInstance, ::Google::Cloud::Bigtable::Admin::V2::CreateInstanceRequest, ::Google::Longrunning::Operation
|
41
47
|
# Gets information about an instance.
|
42
48
|
rpc :GetInstance, ::Google::Cloud::Bigtable::Admin::V2::GetInstanceRequest, ::Google::Cloud::Bigtable::Admin::V2::Instance
|
@@ -52,13 +58,36 @@ module Google
|
|
52
58
|
# Delete an instance from a project.
|
53
59
|
rpc :DeleteInstance, ::Google::Cloud::Bigtable::Admin::V2::DeleteInstanceRequest, ::Google::Protobuf::Empty
|
54
60
|
# Creates a cluster within an instance.
|
61
|
+
#
|
62
|
+
# Note that exactly one of Cluster.serve_nodes and
|
63
|
+
# Cluster.cluster_config.cluster_autoscaling_config can be set. If
|
64
|
+
# serve_nodes is set to non-zero, then the cluster is manually scaled. If
|
65
|
+
# cluster_config.cluster_autoscaling_config is non-empty, then autoscaling is
|
66
|
+
# enabled.
|
55
67
|
rpc :CreateCluster, ::Google::Cloud::Bigtable::Admin::V2::CreateClusterRequest, ::Google::Longrunning::Operation
|
56
68
|
# Gets information about a cluster.
|
57
69
|
rpc :GetCluster, ::Google::Cloud::Bigtable::Admin::V2::GetClusterRequest, ::Google::Cloud::Bigtable::Admin::V2::Cluster
|
58
70
|
# Lists information about clusters in an instance.
|
59
71
|
rpc :ListClusters, ::Google::Cloud::Bigtable::Admin::V2::ListClustersRequest, ::Google::Cloud::Bigtable::Admin::V2::ListClustersResponse
|
60
72
|
# Updates a cluster within an instance.
|
73
|
+
#
|
74
|
+
# Note that UpdateCluster does not support updating
|
75
|
+
# cluster_config.cluster_autoscaling_config. In order to update it, you
|
76
|
+
# must use PartialUpdateCluster.
|
61
77
|
rpc :UpdateCluster, ::Google::Cloud::Bigtable::Admin::V2::Cluster, ::Google::Longrunning::Operation
|
78
|
+
# Partially updates a cluster within a project. This method is the preferred
|
79
|
+
# way to update a Cluster.
|
80
|
+
#
|
81
|
+
# To enable and update autoscaling, set
|
82
|
+
# cluster_config.cluster_autoscaling_config. When autoscaling is enabled,
|
83
|
+
# serve_nodes is treated as an OUTPUT_ONLY field, meaning that updates to it
|
84
|
+
# are ignored. Note that an update cannot simultaneously set serve_nodes to
|
85
|
+
# non-zero and cluster_config.cluster_autoscaling_config to non-empty, and
|
86
|
+
# also specify both in the update_mask.
|
87
|
+
#
|
88
|
+
# To disable autoscaling, clear cluster_config.cluster_autoscaling_config,
|
89
|
+
# and explicitly set a serve_node count via the update_mask.
|
90
|
+
rpc :PartialUpdateCluster, ::Google::Cloud::Bigtable::Admin::V2::PartialUpdateClusterRequest, ::Google::Longrunning::Operation
|
62
91
|
# Deletes a cluster from an instance.
|
63
92
|
rpc :DeleteCluster, ::Google::Cloud::Bigtable::Admin::V2::DeleteClusterRequest, ::Google::Protobuf::Empty
|
64
93
|
# Creates an app profile within an instance.
|
@@ -1,8 +1,6 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# source: google/bigtable/admin/v2/bigtable_table_admin.proto
|
3
3
|
|
4
|
-
require 'google/protobuf'
|
5
|
-
|
6
4
|
require 'google/api/annotations_pb'
|
7
5
|
require 'google/api/client_pb'
|
8
6
|
require 'google/api/field_behavior_pb'
|
@@ -16,6 +14,8 @@ require 'google/protobuf/duration_pb'
|
|
16
14
|
require 'google/protobuf/empty_pb'
|
17
15
|
require 'google/protobuf/field_mask_pb'
|
18
16
|
require 'google/protobuf/timestamp_pb'
|
17
|
+
require 'google/protobuf'
|
18
|
+
|
19
19
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
20
20
|
add_file("google/bigtable/admin/v2/bigtable_table_admin.proto", :syntax => :proto3) do
|
21
21
|
add_message "google.bigtable.admin.v2.RestoreTableRequest" do
|
@@ -1,9 +1,10 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# source: google/bigtable/admin/v2/common.proto
|
3
3
|
|
4
|
+
require 'google/protobuf/timestamp_pb'
|
5
|
+
require 'google/api/annotations_pb'
|
4
6
|
require 'google/protobuf'
|
5
7
|
|
6
|
-
require 'google/protobuf/timestamp_pb'
|
7
8
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
8
9
|
add_file("google/bigtable/admin/v2/common.proto", :syntax => :proto3) do
|
9
10
|
add_message "google.bigtable.admin.v2.OperationProgress" do
|
@@ -1,11 +1,13 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# source: google/bigtable/admin/v2/instance.proto
|
3
3
|
|
4
|
-
require 'google/protobuf'
|
5
|
-
|
6
4
|
require 'google/api/field_behavior_pb'
|
7
5
|
require 'google/api/resource_pb'
|
8
6
|
require 'google/bigtable/admin/v2/common_pb'
|
7
|
+
require 'google/protobuf/timestamp_pb'
|
8
|
+
require 'google/api/annotations_pb'
|
9
|
+
require 'google/protobuf'
|
10
|
+
|
9
11
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
10
12
|
add_file("google/bigtable/admin/v2/instance.proto", :syntax => :proto3) do
|
11
13
|
add_message "google.bigtable.admin.v2.Instance" do
|
@@ -14,6 +16,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
14
16
|
optional :state, :enum, 3, "google.bigtable.admin.v2.Instance.State"
|
15
17
|
optional :type, :enum, 4, "google.bigtable.admin.v2.Instance.Type"
|
16
18
|
map :labels, :string, :string, 5
|
19
|
+
optional :create_time, :message, 7, "google.protobuf.Timestamp"
|
17
20
|
end
|
18
21
|
add_enum "google.bigtable.admin.v2.Instance.State" do
|
19
22
|
value :STATE_NOT_KNOWN, 0
|
@@ -25,6 +28,13 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
25
28
|
value :PRODUCTION, 1
|
26
29
|
value :DEVELOPMENT, 2
|
27
30
|
end
|
31
|
+
add_message "google.bigtable.admin.v2.AutoscalingTargets" do
|
32
|
+
optional :cpu_utilization_percent, :int32, 2
|
33
|
+
end
|
34
|
+
add_message "google.bigtable.admin.v2.AutoscalingLimits" do
|
35
|
+
optional :min_serve_nodes, :int32, 1
|
36
|
+
optional :max_serve_nodes, :int32, 2
|
37
|
+
end
|
28
38
|
add_message "google.bigtable.admin.v2.Cluster" do
|
29
39
|
optional :name, :string, 1
|
30
40
|
optional :location, :string, 2
|
@@ -32,6 +42,16 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
|
|
32
42
|
optional :serve_nodes, :int32, 4
|
33
43
|
optional :default_storage_type, :enum, 5, "google.bigtable.admin.v2.StorageType"
|
34
44
|
optional :encryption_config, :message, 6, "google.bigtable.admin.v2.Cluster.EncryptionConfig"
|
45
|
+
oneof :config do
|
46
|
+
optional :cluster_config, :message, 7, "google.bigtable.admin.v2.Cluster.ClusterConfig"
|
47
|
+
end
|
48
|
+
end
|
49
|
+
add_message "google.bigtable.admin.v2.Cluster.ClusterAutoscalingConfig" do
|
50
|
+
optional :autoscaling_limits, :message, 1, "google.bigtable.admin.v2.AutoscalingLimits"
|
51
|
+
optional :autoscaling_targets, :message, 2, "google.bigtable.admin.v2.AutoscalingTargets"
|
52
|
+
end
|
53
|
+
add_message "google.bigtable.admin.v2.Cluster.ClusterConfig" do
|
54
|
+
optional :cluster_autoscaling_config, :message, 1, "google.bigtable.admin.v2.Cluster.ClusterAutoscalingConfig"
|
35
55
|
end
|
36
56
|
add_message "google.bigtable.admin.v2.Cluster.EncryptionConfig" do
|
37
57
|
optional :kms_key_name, :string, 1
|
@@ -70,7 +90,11 @@ module Google
|
|
70
90
|
Instance = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.Instance").msgclass
|
71
91
|
Instance::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.Instance.State").enummodule
|
72
92
|
Instance::Type = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.Instance.Type").enummodule
|
93
|
+
AutoscalingTargets = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.AutoscalingTargets").msgclass
|
94
|
+
AutoscalingLimits = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.AutoscalingLimits").msgclass
|
73
95
|
Cluster = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.Cluster").msgclass
|
96
|
+
Cluster::ClusterAutoscalingConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.Cluster.ClusterAutoscalingConfig").msgclass
|
97
|
+
Cluster::ClusterConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.Cluster.ClusterConfig").msgclass
|
74
98
|
Cluster::EncryptionConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.Cluster.EncryptionConfig").msgclass
|
75
99
|
Cluster::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.Cluster.State").enummodule
|
76
100
|
AppProfile = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.bigtable.admin.v2.AppProfile").msgclass
|
@@ -1,13 +1,13 @@
|
|
1
1
|
# Generated by the protocol buffer compiler. DO NOT EDIT!
|
2
2
|
# source: google/bigtable/admin/v2/table.proto
|
3
3
|
|
4
|
-
require 'google/protobuf'
|
5
|
-
|
6
4
|
require 'google/api/field_behavior_pb'
|
7
5
|
require 'google/api/resource_pb'
|
8
6
|
require 'google/protobuf/duration_pb'
|
9
7
|
require 'google/protobuf/timestamp_pb'
|
10
8
|
require 'google/rpc/status_pb'
|
9
|
+
require 'google/protobuf'
|
10
|
+
|
11
11
|
Google::Protobuf::DescriptorPool.generated_pool.build do
|
12
12
|
add_file("google/bigtable/admin/v2/table.proto", :syntax => :proto3) do
|
13
13
|
add_message "google.bigtable.admin.v2.RestoreInfo" do
|