google-area120-tables-v1alpha1 0.5.0 → 0.7.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +72 -101
- data/lib/google/area120/tables/v1alpha1/tables_service/client.rb +41 -9
- data/lib/google/area120/tables/v1alpha1/tables_service/rest/client.rb +237 -7
- data/lib/google/area120/tables/v1alpha1/tables_service/rest/service_stub.rb +14 -2
- data/lib/google/area120/tables/v1alpha1/version.rb +1 -1
- data/proto_docs/google/api/client.rb +14 -0
- data/proto_docs/google/api/field_behavior.rb +14 -0
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 41bdf1f204ef69d061ff7bff8a2febfe42f8934a5709ea0eb90b98e6447e9fb1
|
4
|
+
data.tar.gz: 91517390622f21a81007c19ce0d88626132feacfaa5171e1b35b44a2488f8751
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: f73aa38fc1dd16ffdc20202c7396626509b1e7b4bf0d7606ae999aa39ff26f860c67e14ee970c74f3fb76228f9eb82cba8567624135afa071ab3dcf8e9dfab73
|
7
|
+
data.tar.gz: 9f90259ef81db17f79a5fc3d32d5c33bb26ac83061eea55f6f76e1e987087a6893ccd4a927419512a14938a5658a338e212b088bdac0330a783eba1d2ef1ae6f
|
data/AUTHENTICATION.md
CHANGED
@@ -1,151 +1,122 @@
|
|
1
1
|
# Authentication
|
2
2
|
|
3
|
-
|
4
|
-
[
|
5
|
-
|
6
|
-
[Google Cloud Platform environments](#google-cloud-platform-environments) the
|
7
|
-
credentials will be discovered automatically. When running on other
|
8
|
-
environments, the Service Account credentials can be specified by providing the
|
9
|
-
path to the
|
10
|
-
[JSON keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
|
11
|
-
for the account (or the JSON itself) in
|
12
|
-
[environment variables](#environment-variables). Additionally, Cloud SDK
|
13
|
-
credentials can also be discovered automatically, but this is only recommended
|
14
|
-
during development.
|
3
|
+
The recommended way to authenticate to the google-area120-tables-v1alpha1 library is to use
|
4
|
+
[Application Default Credentials (ADC)](https://cloud.google.com/docs/authentication/application-default-credentials).
|
5
|
+
To review all of your authentication options, see [Credentials lookup](#credential-lookup).
|
15
6
|
|
16
7
|
## Quickstart
|
17
8
|
|
18
|
-
|
19
|
-
|
9
|
+
The following example shows how to set up authentication for a local development
|
10
|
+
environment with your user credentials.
|
20
11
|
|
21
|
-
|
22
|
-
|
23
|
-
```
|
24
|
-
|
25
|
-
3. Initialize the client.
|
12
|
+
**NOTE:** This method is _not_ recommended for running in production. User credentials
|
13
|
+
should be used only during development.
|
26
14
|
|
27
|
-
|
28
|
-
|
15
|
+
1. [Download and install the Google Cloud CLI](https://cloud.google.com/sdk).
|
16
|
+
2. Set up a local ADC file with your user credentials:
|
29
17
|
|
30
|
-
|
18
|
+
```sh
|
19
|
+
gcloud auth application-default login
|
31
20
|
```
|
32
21
|
|
33
|
-
|
34
|
-
|
35
|
-
The google-area120-tables-v1alpha1 library aims to make authentication
|
36
|
-
as simple as possible, and provides several mechanisms to configure your system
|
37
|
-
without requiring **Service Account Credentials** directly in code.
|
38
|
-
|
39
|
-
**Credentials** are discovered in the following order:
|
40
|
-
|
41
|
-
1. Specify credentials in method arguments
|
42
|
-
2. Specify credentials in configuration
|
43
|
-
3. Discover credentials path in environment variables
|
44
|
-
4. Discover credentials JSON in environment variables
|
45
|
-
5. Discover credentials file in the Cloud SDK's path
|
46
|
-
6. Discover GCP credentials
|
47
|
-
|
48
|
-
### Google Cloud Platform environments
|
22
|
+
3. Write code as if already authenticated.
|
49
23
|
|
50
|
-
|
51
|
-
|
52
|
-
Functions (GCF) and Cloud Run, **Credentials** are discovered automatically.
|
53
|
-
Code should be written as if already authenticated.
|
24
|
+
For more information about setting up authentication for a local development environment, see
|
25
|
+
[Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-dev).
|
54
26
|
|
55
|
-
|
27
|
+
## Credential Lookup
|
56
28
|
|
57
|
-
The
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
**Credentials JSON** file can be stored in the environment variable, or the
|
62
|
-
**Credentials JSON** itself can be stored for environments such as Docker
|
63
|
-
containers where writing files is difficult or not encouraged.
|
29
|
+
The google-area120-tables-v1alpha1 library provides several mechanisms to configure your system.
|
30
|
+
Generally, using Application Default Credentials to facilitate automatic
|
31
|
+
credentials discovery is the easist method. But if you need to explicitly specify
|
32
|
+
credentials, there are several methods available to you.
|
64
33
|
|
65
|
-
|
66
|
-
checks for credentials are configured on the service Credentials class (such as
|
67
|
-
{::Google::Area120::Tables::V1alpha1::TablesService::Credentials}):
|
34
|
+
Credentials are accepted in the following ways, in the following order or precedence:
|
68
35
|
|
69
|
-
|
70
|
-
|
71
|
-
|
72
|
-
|
73
|
-
|
36
|
+
1. Credentials specified in method arguments
|
37
|
+
2. Credentials specified in configuration
|
38
|
+
3. Credentials pointed to or included in environment variables
|
39
|
+
4. Credentials found in local ADC file
|
40
|
+
5. Credentials returned by the metadata server for the attached service account (GCP)
|
74
41
|
|
75
|
-
|
76
|
-
require "google/area120/tables/v1alpha1"
|
77
|
-
|
78
|
-
ENV["AREA120_TABLES_CREDENTIALS"] = "path/to/keyfile.json"
|
42
|
+
### Configuration
|
79
43
|
|
80
|
-
client
|
81
|
-
|
44
|
+
You can configure a path to a JSON credentials file, either for an individual client object or
|
45
|
+
globally, for all client objects. The JSON file can contain credentials created for
|
46
|
+
[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
|
47
|
+
[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
|
48
|
+
[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
|
82
49
|
|
83
|
-
|
50
|
+
Note: Service account keys are a security risk if not managed correctly. You should
|
51
|
+
[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
|
52
|
+
whenever possible.
|
84
53
|
|
85
|
-
|
86
|
-
it in an environment variable. Either on an individual client initialization:
|
54
|
+
To configure a credentials file for an individual client initialization:
|
87
55
|
|
88
56
|
```ruby
|
89
57
|
require "google/area120/tables/v1alpha1"
|
90
58
|
|
91
59
|
client = ::Google::Area120::Tables::V1alpha1::TablesService::Client.new do |config|
|
92
|
-
config.credentials = "path/to/
|
60
|
+
config.credentials = "path/to/credentialfile.json"
|
93
61
|
end
|
94
62
|
```
|
95
63
|
|
96
|
-
|
64
|
+
To configure a credentials file globally for all clients:
|
97
65
|
|
98
66
|
```ruby
|
99
67
|
require "google/area120/tables/v1alpha1"
|
100
68
|
|
101
69
|
::Google::Area120::Tables::V1alpha1::TablesService::Client.configure do |config|
|
102
|
-
config.credentials = "path/to/
|
70
|
+
config.credentials = "path/to/credentialfile.json"
|
103
71
|
end
|
104
72
|
|
105
73
|
client = ::Google::Area120::Tables::V1alpha1::TablesService::Client.new
|
106
74
|
```
|
107
75
|
|
108
|
-
###
|
76
|
+
### Environment Variables
|
109
77
|
|
110
|
-
|
111
|
-
|
112
|
-
|
78
|
+
You can also use an environment variable to provide a JSON credentials file.
|
79
|
+
The environment variable can contain a path to the credentials file or, for
|
80
|
+
environments such as Docker containers where writing files is not encouraged,
|
81
|
+
you can include the credentials file itself.
|
113
82
|
|
114
|
-
|
83
|
+
The JSON file can contain credentials created for
|
84
|
+
[workload identity federation](https://cloud.google.com/iam/docs/workload-identity-federation),
|
85
|
+
[workforce identity federation](https://cloud.google.com/iam/docs/workforce-identity-federation), or a
|
86
|
+
[service account key](https://cloud.google.com/docs/authentication/provide-credentials-adc#local-key).
|
115
87
|
|
116
|
-
|
117
|
-
|
118
|
-
|
88
|
+
Note: Service account keys are a security risk if not managed correctly. You should
|
89
|
+
[choose a more secure alternative to service account keys](https://cloud.google.com/docs/authentication#auth-decision-tree)
|
90
|
+
whenever possible.
|
91
|
+
|
92
|
+
The environment variables that google-area120-tables-v1alpha1
|
93
|
+
checks for credentials are:
|
119
94
|
|
120
|
-
|
121
|
-
*
|
95
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
96
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
122
97
|
|
123
|
-
|
98
|
+
```ruby
|
99
|
+
require "google/area120/tables/v1alpha1"
|
124
100
|
|
125
|
-
|
126
|
-
connect to the APIs. You will use the **JSON key file** to
|
127
|
-
connect to most services with google-area120-tables-v1alpha1.
|
101
|
+
ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
|
128
102
|
|
129
|
-
|
130
|
-
|
131
|
-
need a Google Developers service account.
|
103
|
+
client = ::Google::Area120::Tables::V1alpha1::TablesService::Client.new
|
104
|
+
```
|
132
105
|
|
133
|
-
|
134
|
-
2. Create a new project or click on an existing project.
|
135
|
-
3. Activate the menu in the upper left and select **APIs & Services**. From
|
136
|
-
here, you will enable the APIs that your application requires.
|
106
|
+
### Local ADC file
|
137
107
|
|
138
|
-
|
108
|
+
You can set up a local ADC file with your user credentials for authentication during
|
109
|
+
development. If credentials are not provided in code or in environment variables,
|
110
|
+
then the local ADC credentials are discovered.
|
139
111
|
|
140
|
-
|
112
|
+
Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
|
141
113
|
|
142
|
-
|
143
|
-
"Service account" to be guided through downloading a new JSON key file.
|
114
|
+
### Google Cloud Platform environments
|
144
115
|
|
145
|
-
|
146
|
-
|
147
|
-
|
148
|
-
|
116
|
+
When running on Google Cloud Platform (GCP), including Google Compute Engine
|
117
|
+
(GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
|
118
|
+
Functions (GCF) and Cloud Run, credentials are retrieved from the attached
|
119
|
+
service account automatically. Code should be written as if already authenticated.
|
149
120
|
|
150
|
-
|
151
|
-
|
121
|
+
For more information, see
|
122
|
+
[Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
|
@@ -41,6 +41,9 @@ module Google
|
|
41
41
|
# resources, named `workspaces/*`.
|
42
42
|
#
|
43
43
|
class Client
|
44
|
+
# @private
|
45
|
+
DEFAULT_ENDPOINT_TEMPLATE = "area120tables.$UNIVERSE_DOMAIN$"
|
46
|
+
|
44
47
|
include Paths
|
45
48
|
|
46
49
|
# @private
|
@@ -130,6 +133,15 @@ module Google
|
|
130
133
|
@config
|
131
134
|
end
|
132
135
|
|
136
|
+
##
|
137
|
+
# The effective universe domain
|
138
|
+
#
|
139
|
+
# @return [String]
|
140
|
+
#
|
141
|
+
def universe_domain
|
142
|
+
@tables_service_stub.universe_domain
|
143
|
+
end
|
144
|
+
|
133
145
|
##
|
134
146
|
# Create a new TablesService client object.
|
135
147
|
#
|
@@ -163,8 +175,9 @@ module Google
|
|
163
175
|
credentials = @config.credentials
|
164
176
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
165
177
|
# but only if the default endpoint does not have a region prefix.
|
166
|
-
enable_self_signed_jwt = @config.endpoint
|
167
|
-
|
178
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
179
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
180
|
+
!@config.endpoint.split(".").first.include?("-"))
|
168
181
|
credentials ||= Credentials.default scope: @config.scope,
|
169
182
|
enable_self_signed_jwt: enable_self_signed_jwt
|
170
183
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
@@ -175,10 +188,13 @@ module Google
|
|
175
188
|
|
176
189
|
@tables_service_stub = ::Gapic::ServiceStub.new(
|
177
190
|
::Google::Area120::Tables::V1alpha1::TablesService::Stub,
|
178
|
-
credentials:
|
179
|
-
endpoint:
|
191
|
+
credentials: credentials,
|
192
|
+
endpoint: @config.endpoint,
|
193
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
194
|
+
universe_domain: @config.universe_domain,
|
180
195
|
channel_args: @config.channel_args,
|
181
|
-
interceptors: @config.interceptors
|
196
|
+
interceptors: @config.interceptors,
|
197
|
+
channel_pool_config: @config.channel_pool
|
182
198
|
)
|
183
199
|
end
|
184
200
|
|
@@ -1307,9 +1323,9 @@ module Google
|
|
1307
1323
|
# end
|
1308
1324
|
#
|
1309
1325
|
# @!attribute [rw] endpoint
|
1310
|
-
#
|
1311
|
-
#
|
1312
|
-
# @return [::String]
|
1326
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
1327
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
1328
|
+
# @return [::String,nil]
|
1313
1329
|
# @!attribute [rw] credentials
|
1314
1330
|
# Credentials to send with calls. You may provide any of the following types:
|
1315
1331
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -1355,13 +1371,20 @@ module Google
|
|
1355
1371
|
# @!attribute [rw] quota_project
|
1356
1372
|
# A separate project against which to charge quota.
|
1357
1373
|
# @return [::String]
|
1374
|
+
# @!attribute [rw] universe_domain
|
1375
|
+
# The universe domain within which to make requests. This determines the
|
1376
|
+
# default endpoint URL. The default value of nil uses the environment
|
1377
|
+
# universe (usually the default "googleapis.com" universe).
|
1378
|
+
# @return [::String,nil]
|
1358
1379
|
#
|
1359
1380
|
class Configuration
|
1360
1381
|
extend ::Gapic::Config
|
1361
1382
|
|
1383
|
+
# @private
|
1384
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
1362
1385
|
DEFAULT_ENDPOINT = "area120tables.googleapis.com"
|
1363
1386
|
|
1364
|
-
config_attr :endpoint,
|
1387
|
+
config_attr :endpoint, nil, ::String, nil
|
1365
1388
|
config_attr :credentials, nil do |value|
|
1366
1389
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
1367
1390
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
@@ -1376,6 +1399,7 @@ module Google
|
|
1376
1399
|
config_attr :metadata, nil, ::Hash, nil
|
1377
1400
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
1378
1401
|
config_attr :quota_project, nil, ::String, nil
|
1402
|
+
config_attr :universe_domain, nil, ::String, nil
|
1379
1403
|
|
1380
1404
|
# @private
|
1381
1405
|
def initialize parent_config = nil
|
@@ -1396,6 +1420,14 @@ module Google
|
|
1396
1420
|
end
|
1397
1421
|
end
|
1398
1422
|
|
1423
|
+
##
|
1424
|
+
# Configuration for the channel pool
|
1425
|
+
# @return [::Gapic::ServiceStub::ChannelPool::Configuration]
|
1426
|
+
#
|
1427
|
+
def channel_pool
|
1428
|
+
@channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
|
1429
|
+
end
|
1430
|
+
|
1399
1431
|
##
|
1400
1432
|
# Configuration RPC class for the TablesService API.
|
1401
1433
|
#
|
@@ -43,6 +43,9 @@ module Google
|
|
43
43
|
# resources, named `workspaces/*`.
|
44
44
|
#
|
45
45
|
class Client
|
46
|
+
# @private
|
47
|
+
DEFAULT_ENDPOINT_TEMPLATE = "area120tables.$UNIVERSE_DOMAIN$"
|
48
|
+
|
46
49
|
include Paths
|
47
50
|
|
48
51
|
# @private
|
@@ -132,6 +135,15 @@ module Google
|
|
132
135
|
@config
|
133
136
|
end
|
134
137
|
|
138
|
+
##
|
139
|
+
# The effective universe domain
|
140
|
+
#
|
141
|
+
# @return [String]
|
142
|
+
#
|
143
|
+
def universe_domain
|
144
|
+
@tables_service_stub.universe_domain
|
145
|
+
end
|
146
|
+
|
135
147
|
##
|
136
148
|
# Create a new TablesService REST client object.
|
137
149
|
#
|
@@ -159,8 +171,9 @@ module Google
|
|
159
171
|
credentials = @config.credentials
|
160
172
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
161
173
|
# but only if the default endpoint does not have a region prefix.
|
162
|
-
enable_self_signed_jwt = @config.endpoint
|
163
|
-
|
174
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
175
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
176
|
+
!@config.endpoint.split(".").first.include?("-"))
|
164
177
|
credentials ||= Credentials.default scope: @config.scope,
|
165
178
|
enable_self_signed_jwt: enable_self_signed_jwt
|
166
179
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
@@ -170,7 +183,12 @@ module Google
|
|
170
183
|
@quota_project_id = @config.quota_project
|
171
184
|
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
172
185
|
|
173
|
-
@tables_service_stub = ::Google::Area120::Tables::V1alpha1::TablesService::Rest::ServiceStub.new
|
186
|
+
@tables_service_stub = ::Google::Area120::Tables::V1alpha1::TablesService::Rest::ServiceStub.new(
|
187
|
+
endpoint: @config.endpoint,
|
188
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
189
|
+
universe_domain: @config.universe_domain,
|
190
|
+
credentials: credentials
|
191
|
+
)
|
174
192
|
end
|
175
193
|
|
176
194
|
# Service calls
|
@@ -203,6 +221,22 @@ module Google
|
|
203
221
|
# @return [::Google::Area120::Tables::V1alpha1::Table]
|
204
222
|
#
|
205
223
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
224
|
+
#
|
225
|
+
# @example Basic example
|
226
|
+
# require "google/area120/tables/v1alpha1"
|
227
|
+
#
|
228
|
+
# # Create a client object. The client can be reused for multiple calls.
|
229
|
+
# client = Google::Area120::Tables::V1alpha1::TablesService::Rest::Client.new
|
230
|
+
#
|
231
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
232
|
+
# request = Google::Area120::Tables::V1alpha1::GetTableRequest.new
|
233
|
+
#
|
234
|
+
# # Call the get_table method.
|
235
|
+
# result = client.get_table request
|
236
|
+
#
|
237
|
+
# # The returned object is of type Google::Area120::Tables::V1alpha1::Table.
|
238
|
+
# p result
|
239
|
+
#
|
206
240
|
def get_table request, options = nil
|
207
241
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
208
242
|
|
@@ -275,6 +309,26 @@ module Google
|
|
275
309
|
# @return [::Gapic::Rest::PagedEnumerable<::Google::Area120::Tables::V1alpha1::Table>]
|
276
310
|
#
|
277
311
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
312
|
+
#
|
313
|
+
# @example Basic example
|
314
|
+
# require "google/area120/tables/v1alpha1"
|
315
|
+
#
|
316
|
+
# # Create a client object. The client can be reused for multiple calls.
|
317
|
+
# client = Google::Area120::Tables::V1alpha1::TablesService::Rest::Client.new
|
318
|
+
#
|
319
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
320
|
+
# request = Google::Area120::Tables::V1alpha1::ListTablesRequest.new
|
321
|
+
#
|
322
|
+
# # Call the list_tables method.
|
323
|
+
# result = client.list_tables request
|
324
|
+
#
|
325
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
326
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
327
|
+
# result.each do |item|
|
328
|
+
# # Each element is of type ::Google::Area120::Tables::V1alpha1::Table.
|
329
|
+
# p item
|
330
|
+
# end
|
331
|
+
#
|
278
332
|
def list_tables request, options = nil
|
279
333
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
280
334
|
|
@@ -339,6 +393,22 @@ module Google
|
|
339
393
|
# @return [::Google::Area120::Tables::V1alpha1::Workspace]
|
340
394
|
#
|
341
395
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
396
|
+
#
|
397
|
+
# @example Basic example
|
398
|
+
# require "google/area120/tables/v1alpha1"
|
399
|
+
#
|
400
|
+
# # Create a client object. The client can be reused for multiple calls.
|
401
|
+
# client = Google::Area120::Tables::V1alpha1::TablesService::Rest::Client.new
|
402
|
+
#
|
403
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
404
|
+
# request = Google::Area120::Tables::V1alpha1::GetWorkspaceRequest.new
|
405
|
+
#
|
406
|
+
# # Call the get_workspace method.
|
407
|
+
# result = client.get_workspace request
|
408
|
+
#
|
409
|
+
# # The returned object is of type Google::Area120::Tables::V1alpha1::Workspace.
|
410
|
+
# p result
|
411
|
+
#
|
342
412
|
def get_workspace request, options = nil
|
343
413
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
344
414
|
|
@@ -411,6 +481,26 @@ module Google
|
|
411
481
|
# @return [::Gapic::Rest::PagedEnumerable<::Google::Area120::Tables::V1alpha1::Workspace>]
|
412
482
|
#
|
413
483
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
484
|
+
#
|
485
|
+
# @example Basic example
|
486
|
+
# require "google/area120/tables/v1alpha1"
|
487
|
+
#
|
488
|
+
# # Create a client object. The client can be reused for multiple calls.
|
489
|
+
# client = Google::Area120::Tables::V1alpha1::TablesService::Rest::Client.new
|
490
|
+
#
|
491
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
492
|
+
# request = Google::Area120::Tables::V1alpha1::ListWorkspacesRequest.new
|
493
|
+
#
|
494
|
+
# # Call the list_workspaces method.
|
495
|
+
# result = client.list_workspaces request
|
496
|
+
#
|
497
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
498
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
499
|
+
# result.each do |item|
|
500
|
+
# # Each element is of type ::Google::Area120::Tables::V1alpha1::Workspace.
|
501
|
+
# p item
|
502
|
+
# end
|
503
|
+
#
|
414
504
|
def list_workspaces request, options = nil
|
415
505
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
416
506
|
|
@@ -478,6 +568,22 @@ module Google
|
|
478
568
|
# @return [::Google::Area120::Tables::V1alpha1::Row]
|
479
569
|
#
|
480
570
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
571
|
+
#
|
572
|
+
# @example Basic example
|
573
|
+
# require "google/area120/tables/v1alpha1"
|
574
|
+
#
|
575
|
+
# # Create a client object. The client can be reused for multiple calls.
|
576
|
+
# client = Google::Area120::Tables::V1alpha1::TablesService::Rest::Client.new
|
577
|
+
#
|
578
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
579
|
+
# request = Google::Area120::Tables::V1alpha1::GetRowRequest.new
|
580
|
+
#
|
581
|
+
# # Call the get_row method.
|
582
|
+
# result = client.get_row request
|
583
|
+
#
|
584
|
+
# # The returned object is of type Google::Area120::Tables::V1alpha1::Row.
|
585
|
+
# p result
|
586
|
+
#
|
481
587
|
def get_row request, options = nil
|
482
588
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
483
589
|
|
@@ -560,6 +666,26 @@ module Google
|
|
560
666
|
# @return [::Gapic::Rest::PagedEnumerable<::Google::Area120::Tables::V1alpha1::Row>]
|
561
667
|
#
|
562
668
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
669
|
+
#
|
670
|
+
# @example Basic example
|
671
|
+
# require "google/area120/tables/v1alpha1"
|
672
|
+
#
|
673
|
+
# # Create a client object. The client can be reused for multiple calls.
|
674
|
+
# client = Google::Area120::Tables::V1alpha1::TablesService::Rest::Client.new
|
675
|
+
#
|
676
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
677
|
+
# request = Google::Area120::Tables::V1alpha1::ListRowsRequest.new
|
678
|
+
#
|
679
|
+
# # Call the list_rows method.
|
680
|
+
# result = client.list_rows request
|
681
|
+
#
|
682
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
683
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
684
|
+
# result.each do |item|
|
685
|
+
# # Each element is of type ::Google::Area120::Tables::V1alpha1::Row.
|
686
|
+
# p item
|
687
|
+
# end
|
688
|
+
#
|
563
689
|
def list_rows request, options = nil
|
564
690
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
565
691
|
|
@@ -629,6 +755,22 @@ module Google
|
|
629
755
|
# @return [::Google::Area120::Tables::V1alpha1::Row]
|
630
756
|
#
|
631
757
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
758
|
+
#
|
759
|
+
# @example Basic example
|
760
|
+
# require "google/area120/tables/v1alpha1"
|
761
|
+
#
|
762
|
+
# # Create a client object. The client can be reused for multiple calls.
|
763
|
+
# client = Google::Area120::Tables::V1alpha1::TablesService::Rest::Client.new
|
764
|
+
#
|
765
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
766
|
+
# request = Google::Area120::Tables::V1alpha1::CreateRowRequest.new
|
767
|
+
#
|
768
|
+
# # Call the create_row method.
|
769
|
+
# result = client.create_row request
|
770
|
+
#
|
771
|
+
# # The returned object is of type Google::Area120::Tables::V1alpha1::Row.
|
772
|
+
# p result
|
773
|
+
#
|
632
774
|
def create_row request, options = nil
|
633
775
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
634
776
|
|
@@ -696,6 +838,22 @@ module Google
|
|
696
838
|
# @return [::Google::Area120::Tables::V1alpha1::BatchCreateRowsResponse]
|
697
839
|
#
|
698
840
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
841
|
+
#
|
842
|
+
# @example Basic example
|
843
|
+
# require "google/area120/tables/v1alpha1"
|
844
|
+
#
|
845
|
+
# # Create a client object. The client can be reused for multiple calls.
|
846
|
+
# client = Google::Area120::Tables::V1alpha1::TablesService::Rest::Client.new
|
847
|
+
#
|
848
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
849
|
+
# request = Google::Area120::Tables::V1alpha1::BatchCreateRowsRequest.new
|
850
|
+
#
|
851
|
+
# # Call the batch_create_rows method.
|
852
|
+
# result = client.batch_create_rows request
|
853
|
+
#
|
854
|
+
# # The returned object is of type Google::Area120::Tables::V1alpha1::BatchCreateRowsResponse.
|
855
|
+
# p result
|
856
|
+
#
|
699
857
|
def batch_create_rows request, options = nil
|
700
858
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
701
859
|
|
@@ -763,6 +921,22 @@ module Google
|
|
763
921
|
# @return [::Google::Area120::Tables::V1alpha1::Row]
|
764
922
|
#
|
765
923
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
924
|
+
#
|
925
|
+
# @example Basic example
|
926
|
+
# require "google/area120/tables/v1alpha1"
|
927
|
+
#
|
928
|
+
# # Create a client object. The client can be reused for multiple calls.
|
929
|
+
# client = Google::Area120::Tables::V1alpha1::TablesService::Rest::Client.new
|
930
|
+
#
|
931
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
932
|
+
# request = Google::Area120::Tables::V1alpha1::UpdateRowRequest.new
|
933
|
+
#
|
934
|
+
# # Call the update_row method.
|
935
|
+
# result = client.update_row request
|
936
|
+
#
|
937
|
+
# # The returned object is of type Google::Area120::Tables::V1alpha1::Row.
|
938
|
+
# p result
|
939
|
+
#
|
766
940
|
def update_row request, options = nil
|
767
941
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
768
942
|
|
@@ -830,6 +1004,22 @@ module Google
|
|
830
1004
|
# @return [::Google::Area120::Tables::V1alpha1::BatchUpdateRowsResponse]
|
831
1005
|
#
|
832
1006
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1007
|
+
#
|
1008
|
+
# @example Basic example
|
1009
|
+
# require "google/area120/tables/v1alpha1"
|
1010
|
+
#
|
1011
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1012
|
+
# client = Google::Area120::Tables::V1alpha1::TablesService::Rest::Client.new
|
1013
|
+
#
|
1014
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1015
|
+
# request = Google::Area120::Tables::V1alpha1::BatchUpdateRowsRequest.new
|
1016
|
+
#
|
1017
|
+
# # Call the batch_update_rows method.
|
1018
|
+
# result = client.batch_update_rows request
|
1019
|
+
#
|
1020
|
+
# # The returned object is of type Google::Area120::Tables::V1alpha1::BatchUpdateRowsResponse.
|
1021
|
+
# p result
|
1022
|
+
#
|
833
1023
|
def batch_update_rows request, options = nil
|
834
1024
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
835
1025
|
|
@@ -893,6 +1083,22 @@ module Google
|
|
893
1083
|
# @return [::Google::Protobuf::Empty]
|
894
1084
|
#
|
895
1085
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1086
|
+
#
|
1087
|
+
# @example Basic example
|
1088
|
+
# require "google/area120/tables/v1alpha1"
|
1089
|
+
#
|
1090
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1091
|
+
# client = Google::Area120::Tables::V1alpha1::TablesService::Rest::Client.new
|
1092
|
+
#
|
1093
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1094
|
+
# request = Google::Area120::Tables::V1alpha1::DeleteRowRequest.new
|
1095
|
+
#
|
1096
|
+
# # Call the delete_row method.
|
1097
|
+
# result = client.delete_row request
|
1098
|
+
#
|
1099
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
1100
|
+
# p result
|
1101
|
+
#
|
896
1102
|
def delete_row request, options = nil
|
897
1103
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
898
1104
|
|
@@ -961,6 +1167,22 @@ module Google
|
|
961
1167
|
# @return [::Google::Protobuf::Empty]
|
962
1168
|
#
|
963
1169
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
1170
|
+
#
|
1171
|
+
# @example Basic example
|
1172
|
+
# require "google/area120/tables/v1alpha1"
|
1173
|
+
#
|
1174
|
+
# # Create a client object. The client can be reused for multiple calls.
|
1175
|
+
# client = Google::Area120::Tables::V1alpha1::TablesService::Rest::Client.new
|
1176
|
+
#
|
1177
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
1178
|
+
# request = Google::Area120::Tables::V1alpha1::BatchDeleteRowsRequest.new
|
1179
|
+
#
|
1180
|
+
# # Call the batch_delete_rows method.
|
1181
|
+
# result = client.batch_delete_rows request
|
1182
|
+
#
|
1183
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
1184
|
+
# p result
|
1185
|
+
#
|
964
1186
|
def batch_delete_rows request, options = nil
|
965
1187
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
966
1188
|
|
@@ -1026,9 +1248,9 @@ module Google
|
|
1026
1248
|
# end
|
1027
1249
|
#
|
1028
1250
|
# @!attribute [rw] endpoint
|
1029
|
-
#
|
1030
|
-
#
|
1031
|
-
# @return [::String]
|
1251
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
1252
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
1253
|
+
# @return [::String,nil]
|
1032
1254
|
# @!attribute [rw] credentials
|
1033
1255
|
# Credentials to send with calls. You may provide any of the following types:
|
1034
1256
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -1065,13 +1287,20 @@ module Google
|
|
1065
1287
|
# @!attribute [rw] quota_project
|
1066
1288
|
# A separate project against which to charge quota.
|
1067
1289
|
# @return [::String]
|
1290
|
+
# @!attribute [rw] universe_domain
|
1291
|
+
# The universe domain within which to make requests. This determines the
|
1292
|
+
# default endpoint URL. The default value of nil uses the environment
|
1293
|
+
# universe (usually the default "googleapis.com" universe).
|
1294
|
+
# @return [::String,nil]
|
1068
1295
|
#
|
1069
1296
|
class Configuration
|
1070
1297
|
extend ::Gapic::Config
|
1071
1298
|
|
1299
|
+
# @private
|
1300
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
1072
1301
|
DEFAULT_ENDPOINT = "area120tables.googleapis.com"
|
1073
1302
|
|
1074
|
-
config_attr :endpoint,
|
1303
|
+
config_attr :endpoint, nil, ::String, nil
|
1075
1304
|
config_attr :credentials, nil do |value|
|
1076
1305
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
1077
1306
|
allowed.any? { |klass| klass === value }
|
@@ -1083,6 +1312,7 @@ module Google
|
|
1083
1312
|
config_attr :metadata, nil, ::Hash, nil
|
1084
1313
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
1085
1314
|
config_attr :quota_project, nil, ::String, nil
|
1315
|
+
config_attr :universe_domain, nil, ::String, nil
|
1086
1316
|
|
1087
1317
|
# @private
|
1088
1318
|
def initialize parent_config = nil
|
@@ -30,16 +30,28 @@ module Google
|
|
30
30
|
# including transcoding, making the REST call, and deserialing the response.
|
31
31
|
#
|
32
32
|
class ServiceStub
|
33
|
-
def initialize endpoint:, credentials:
|
33
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
34
34
|
# These require statements are intentionally placed here to initialize
|
35
35
|
# the REST modules only when it's required.
|
36
36
|
require "gapic/rest"
|
37
37
|
|
38
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
38
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
39
|
+
endpoint_template: endpoint_template,
|
40
|
+
universe_domain: universe_domain,
|
41
|
+
credentials: credentials,
|
39
42
|
numeric_enums: true,
|
40
43
|
raise_faraday_errors: false
|
41
44
|
end
|
42
45
|
|
46
|
+
##
|
47
|
+
# The effective universe domain
|
48
|
+
#
|
49
|
+
# @return [String]
|
50
|
+
#
|
51
|
+
def universe_domain
|
52
|
+
@client_stub.universe_domain
|
53
|
+
end
|
54
|
+
|
43
55
|
##
|
44
56
|
# Baseline implementation for the get_table REST call
|
45
57
|
#
|
@@ -21,6 +21,7 @@ module Google
|
|
21
21
|
module Api
|
22
22
|
# Required information for every language.
|
23
23
|
# @!attribute [rw] reference_docs_uri
|
24
|
+
# @deprecated This field is deprecated and may be removed in the next major version update.
|
24
25
|
# @return [::String]
|
25
26
|
# Link to automatically generated reference documentation. Example:
|
26
27
|
# https://cloud.google.com/nodejs/docs/reference/asset/latest
|
@@ -304,6 +305,19 @@ module Google
|
|
304
305
|
# seconds: 360 # 6 minutes
|
305
306
|
# total_poll_timeout:
|
306
307
|
# seconds: 54000 # 90 minutes
|
308
|
+
# @!attribute [rw] auto_populated_fields
|
309
|
+
# @return [::Array<::String>]
|
310
|
+
# List of top-level fields of the request message, that should be
|
311
|
+
# automatically populated by the client libraries based on their
|
312
|
+
# (google.api.field_info).format. Currently supported format: UUID4.
|
313
|
+
#
|
314
|
+
# Example of a YAML configuration:
|
315
|
+
#
|
316
|
+
# publishing:
|
317
|
+
# method_settings:
|
318
|
+
# - selector: google.example.v1.ExampleService.CreateExample
|
319
|
+
# auto_populated_fields:
|
320
|
+
# - request_id
|
307
321
|
class MethodSettings
|
308
322
|
include ::Google::Protobuf::MessageExts
|
309
323
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
@@ -66,6 +66,20 @@ module Google
|
|
66
66
|
# a non-empty value will be returned. The user will not be aware of what
|
67
67
|
# non-empty value to expect.
|
68
68
|
NON_EMPTY_DEFAULT = 7
|
69
|
+
|
70
|
+
# Denotes that the field in a resource (a message annotated with
|
71
|
+
# google.api.resource) is used in the resource name to uniquely identify the
|
72
|
+
# resource. For AIP-compliant APIs, this should only be applied to the
|
73
|
+
# `name` field on the resource.
|
74
|
+
#
|
75
|
+
# This behavior should not be applied to references to other resources within
|
76
|
+
# the message.
|
77
|
+
#
|
78
|
+
# The identifier field of resources often have different field behavior
|
79
|
+
# depending on the request it is embedded in (e.g. for Create methods name
|
80
|
+
# is optional and unused, while for Update methods it is required). Instead
|
81
|
+
# of method-specific annotations, only `IDENTIFIER` is required.
|
82
|
+
IDENTIFIER = 8
|
69
83
|
end
|
70
84
|
end
|
71
85
|
end
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-area120-tables-v1alpha1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.7.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2024-01-11 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|
@@ -16,7 +16,7 @@ dependencies:
|
|
16
16
|
requirements:
|
17
17
|
- - ">="
|
18
18
|
- !ruby/object:Gem::Version
|
19
|
-
version: 0.
|
19
|
+
version: 0.21.1
|
20
20
|
- - "<"
|
21
21
|
- !ruby/object:Gem::Version
|
22
22
|
version: 2.a
|
@@ -26,7 +26,7 @@ dependencies:
|
|
26
26
|
requirements:
|
27
27
|
- - ">="
|
28
28
|
- !ruby/object:Gem::Version
|
29
|
-
version: 0.
|
29
|
+
version: 0.21.1
|
30
30
|
- - "<"
|
31
31
|
- !ruby/object:Gem::Version
|
32
32
|
version: 2.a
|
@@ -211,7 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
211
211
|
- !ruby/object:Gem::Version
|
212
212
|
version: '0'
|
213
213
|
requirements: []
|
214
|
-
rubygems_version: 3.
|
214
|
+
rubygems_version: 3.5.3
|
215
215
|
signing_key:
|
216
216
|
specification_version: 4
|
217
217
|
summary: API Client library for the Area 120 Tables V1alpha1 API
|