google-cloud-bigquery-data_policies-v1 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 -99
- data/lib/google/cloud/bigquery/data_policies/v1/data_policy_service/client.rb +41 -9
- data/lib/google/cloud/bigquery/data_policies/v1/data_policy_service/rest/client.rb +181 -7
- data/lib/google/cloud/bigquery/data_policies/v1/data_policy_service/rest/service_stub.rb +14 -2
- data/lib/google/cloud/bigquery/data_policies/v1/version.rb +1 -1
- data/proto_docs/google/api/client.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: b5ba012113b1e0727530961477795e53f761793c3128c477007675bb4a2cd496
|
4
|
+
data.tar.gz: c7bfec44f7082648f21c5d13138381fb428ba3f9aa2238ac44aa7974564d7118
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5890f1258beb970efe0045a1f82b6f0de0af45d66db9cd8090435ddc3ba28d0cf41b6a155997ad2c36f3201dd0394edc2c089b206971682d5cb0cadd20e18976
|
7
|
+
data.tar.gz: 6e5baace90a74ca193d32ab59966f9f0681d7ceb48add241b5369b63171e189231d3e6c7c648ef0b7b2527ea1a6538afa4ace051ee60a769a8dd2df535d87900
|
data/AUTHENTICATION.md
CHANGED
@@ -1,149 +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-cloud-bigquery-data_policies-v1 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-cloud-bigquery-data_policies-v1 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-cloud-bigquery-data_policies-v1 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::Cloud::Bigquery::DataPolicies::V1::DataPolicyService::Credentials}):
|
34
|
+
Credentials are accepted in the following ways, in the following order or precedence:
|
68
35
|
|
69
|
-
|
70
|
-
|
71
|
-
|
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)
|
72
41
|
|
73
|
-
|
74
|
-
require "google/cloud/bigquery/data_policies/v1"
|
75
|
-
|
76
|
-
ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
|
42
|
+
### Configuration
|
77
43
|
|
78
|
-
client
|
79
|
-
|
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).
|
80
49
|
|
81
|
-
|
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.
|
82
53
|
|
83
|
-
|
84
|
-
it in an environment variable. Either on an individual client initialization:
|
54
|
+
To configure a credentials file for an individual client initialization:
|
85
55
|
|
86
56
|
```ruby
|
87
57
|
require "google/cloud/bigquery/data_policies/v1"
|
88
58
|
|
89
59
|
client = ::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicyService::Client.new do |config|
|
90
|
-
config.credentials = "path/to/
|
60
|
+
config.credentials = "path/to/credentialfile.json"
|
91
61
|
end
|
92
62
|
```
|
93
63
|
|
94
|
-
|
64
|
+
To configure a credentials file globally for all clients:
|
95
65
|
|
96
66
|
```ruby
|
97
67
|
require "google/cloud/bigquery/data_policies/v1"
|
98
68
|
|
99
69
|
::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicyService::Client.configure do |config|
|
100
|
-
config.credentials = "path/to/
|
70
|
+
config.credentials = "path/to/credentialfile.json"
|
101
71
|
end
|
102
72
|
|
103
73
|
client = ::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicyService::Client.new
|
104
74
|
```
|
105
75
|
|
106
|
-
###
|
76
|
+
### Environment Variables
|
107
77
|
|
108
|
-
|
109
|
-
|
110
|
-
|
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.
|
111
82
|
|
112
|
-
|
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).
|
113
87
|
|
114
|
-
|
115
|
-
|
116
|
-
|
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-cloud-bigquery-data_policies-v1
|
93
|
+
checks for credentials are:
|
117
94
|
|
118
|
-
|
119
|
-
*
|
95
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
96
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
120
97
|
|
121
|
-
|
98
|
+
```ruby
|
99
|
+
require "google/cloud/bigquery/data_policies/v1"
|
122
100
|
|
123
|
-
|
124
|
-
connect to the APIs. You will use the **JSON key file** to
|
125
|
-
connect to most services with google-cloud-bigquery-data_policies-v1.
|
101
|
+
ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
|
126
102
|
|
127
|
-
|
128
|
-
|
129
|
-
need a Google Developers service account.
|
103
|
+
client = ::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicyService::Client.new
|
104
|
+
```
|
130
105
|
|
131
|
-
|
132
|
-
2. Create a new project or click on an existing project.
|
133
|
-
3. Activate the menu in the upper left and select **APIs & Services**. From
|
134
|
-
here, you will enable the APIs that your application requires.
|
106
|
+
### Local ADC file
|
135
107
|
|
136
|
-
|
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.
|
137
111
|
|
138
|
-
|
112
|
+
Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
|
139
113
|
|
140
|
-
|
141
|
-
"Service account" to be guided through downloading a new JSON key file.
|
114
|
+
### Google Cloud Platform environments
|
142
115
|
|
143
|
-
|
144
|
-
|
145
|
-
|
146
|
-
|
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.
|
147
120
|
|
148
|
-
|
149
|
-
|
121
|
+
For more information, see
|
122
|
+
[Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
|
@@ -31,6 +31,9 @@ module Google
|
|
31
31
|
# Data Policy Service provides APIs for managing the label-policy bindings.
|
32
32
|
#
|
33
33
|
class Client
|
34
|
+
# @private
|
35
|
+
DEFAULT_ENDPOINT_TEMPLATE = "bigquerydatapolicy.$UNIVERSE_DOMAIN$"
|
36
|
+
|
34
37
|
include Paths
|
35
38
|
|
36
39
|
# @private
|
@@ -136,6 +139,15 @@ module Google
|
|
136
139
|
@config
|
137
140
|
end
|
138
141
|
|
142
|
+
##
|
143
|
+
# The effective universe domain
|
144
|
+
#
|
145
|
+
# @return [String]
|
146
|
+
#
|
147
|
+
def universe_domain
|
148
|
+
@data_policy_service_stub.universe_domain
|
149
|
+
end
|
150
|
+
|
139
151
|
##
|
140
152
|
# Create a new DataPolicyService client object.
|
141
153
|
#
|
@@ -169,8 +181,9 @@ module Google
|
|
169
181
|
credentials = @config.credentials
|
170
182
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
171
183
|
# but only if the default endpoint does not have a region prefix.
|
172
|
-
enable_self_signed_jwt = @config.endpoint
|
173
|
-
|
184
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
185
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
186
|
+
!@config.endpoint.split(".").first.include?("-"))
|
174
187
|
credentials ||= Credentials.default scope: @config.scope,
|
175
188
|
enable_self_signed_jwt: enable_self_signed_jwt
|
176
189
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
@@ -181,10 +194,13 @@ module Google
|
|
181
194
|
|
182
195
|
@data_policy_service_stub = ::Gapic::ServiceStub.new(
|
183
196
|
::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicyService::Stub,
|
184
|
-
credentials:
|
185
|
-
endpoint:
|
197
|
+
credentials: credentials,
|
198
|
+
endpoint: @config.endpoint,
|
199
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
200
|
+
universe_domain: @config.universe_domain,
|
186
201
|
channel_args: @config.channel_args,
|
187
|
-
interceptors: @config.interceptors
|
202
|
+
interceptors: @config.interceptors,
|
203
|
+
channel_pool_config: @config.channel_pool
|
188
204
|
)
|
189
205
|
end
|
190
206
|
|
@@ -1050,9 +1066,9 @@ module Google
|
|
1050
1066
|
# end
|
1051
1067
|
#
|
1052
1068
|
# @!attribute [rw] endpoint
|
1053
|
-
#
|
1054
|
-
#
|
1055
|
-
# @return [::String]
|
1069
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
1070
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
1071
|
+
# @return [::String,nil]
|
1056
1072
|
# @!attribute [rw] credentials
|
1057
1073
|
# Credentials to send with calls. You may provide any of the following types:
|
1058
1074
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -1098,13 +1114,20 @@ module Google
|
|
1098
1114
|
# @!attribute [rw] quota_project
|
1099
1115
|
# A separate project against which to charge quota.
|
1100
1116
|
# @return [::String]
|
1117
|
+
# @!attribute [rw] universe_domain
|
1118
|
+
# The universe domain within which to make requests. This determines the
|
1119
|
+
# default endpoint URL. The default value of nil uses the environment
|
1120
|
+
# universe (usually the default "googleapis.com" universe).
|
1121
|
+
# @return [::String,nil]
|
1101
1122
|
#
|
1102
1123
|
class Configuration
|
1103
1124
|
extend ::Gapic::Config
|
1104
1125
|
|
1126
|
+
# @private
|
1127
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
1105
1128
|
DEFAULT_ENDPOINT = "bigquerydatapolicy.googleapis.com"
|
1106
1129
|
|
1107
|
-
config_attr :endpoint,
|
1130
|
+
config_attr :endpoint, nil, ::String, nil
|
1108
1131
|
config_attr :credentials, nil do |value|
|
1109
1132
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
1110
1133
|
allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
|
@@ -1119,6 +1142,7 @@ module Google
|
|
1119
1142
|
config_attr :metadata, nil, ::Hash, nil
|
1120
1143
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
1121
1144
|
config_attr :quota_project, nil, ::String, nil
|
1145
|
+
config_attr :universe_domain, nil, ::String, nil
|
1122
1146
|
|
1123
1147
|
# @private
|
1124
1148
|
def initialize parent_config = nil
|
@@ -1139,6 +1163,14 @@ module Google
|
|
1139
1163
|
end
|
1140
1164
|
end
|
1141
1165
|
|
1166
|
+
##
|
1167
|
+
# Configuration for the channel pool
|
1168
|
+
# @return [::Gapic::ServiceStub::ChannelPool::Configuration]
|
1169
|
+
#
|
1170
|
+
def channel_pool
|
1171
|
+
@channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
|
1172
|
+
end
|
1173
|
+
|
1142
1174
|
##
|
1143
1175
|
# Configuration RPC class for the DataPolicyService API.
|
1144
1176
|
#
|
@@ -33,6 +33,9 @@ module Google
|
|
33
33
|
# Data Policy Service provides APIs for managing the label-policy bindings.
|
34
34
|
#
|
35
35
|
class Client
|
36
|
+
# @private
|
37
|
+
DEFAULT_ENDPOINT_TEMPLATE = "bigquerydatapolicy.$UNIVERSE_DOMAIN$"
|
38
|
+
|
36
39
|
include Paths
|
37
40
|
|
38
41
|
# @private
|
@@ -138,6 +141,15 @@ module Google
|
|
138
141
|
@config
|
139
142
|
end
|
140
143
|
|
144
|
+
##
|
145
|
+
# The effective universe domain
|
146
|
+
#
|
147
|
+
# @return [String]
|
148
|
+
#
|
149
|
+
def universe_domain
|
150
|
+
@data_policy_service_stub.universe_domain
|
151
|
+
end
|
152
|
+
|
141
153
|
##
|
142
154
|
# Create a new DataPolicyService REST client object.
|
143
155
|
#
|
@@ -165,8 +177,9 @@ module Google
|
|
165
177
|
credentials = @config.credentials
|
166
178
|
# Use self-signed JWT if the endpoint is unchanged from default,
|
167
179
|
# but only if the default endpoint does not have a region prefix.
|
168
|
-
enable_self_signed_jwt = @config.endpoint
|
169
|
-
|
180
|
+
enable_self_signed_jwt = @config.endpoint.nil? ||
|
181
|
+
(@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
|
182
|
+
!@config.endpoint.split(".").first.include?("-"))
|
170
183
|
credentials ||= Credentials.default scope: @config.scope,
|
171
184
|
enable_self_signed_jwt: enable_self_signed_jwt
|
172
185
|
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
@@ -176,7 +189,12 @@ module Google
|
|
176
189
|
@quota_project_id = @config.quota_project
|
177
190
|
@quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id
|
178
191
|
|
179
|
-
@data_policy_service_stub = ::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicyService::Rest::ServiceStub.new
|
192
|
+
@data_policy_service_stub = ::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicyService::Rest::ServiceStub.new(
|
193
|
+
endpoint: @config.endpoint,
|
194
|
+
endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
|
195
|
+
universe_domain: @config.universe_domain,
|
196
|
+
credentials: credentials
|
197
|
+
)
|
180
198
|
end
|
181
199
|
|
182
200
|
# Service calls
|
@@ -213,6 +231,22 @@ module Google
|
|
213
231
|
# @return [::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicy]
|
214
232
|
#
|
215
233
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
234
|
+
#
|
235
|
+
# @example Basic example
|
236
|
+
# require "google/cloud/bigquery/data_policies/v1"
|
237
|
+
#
|
238
|
+
# # Create a client object. The client can be reused for multiple calls.
|
239
|
+
# client = Google::Cloud::Bigquery::DataPolicies::V1::DataPolicyService::Rest::Client.new
|
240
|
+
#
|
241
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
242
|
+
# request = Google::Cloud::Bigquery::DataPolicies::V1::CreateDataPolicyRequest.new
|
243
|
+
#
|
244
|
+
# # Call the create_data_policy method.
|
245
|
+
# result = client.create_data_policy request
|
246
|
+
#
|
247
|
+
# # The returned object is of type Google::Cloud::Bigquery::DataPolicies::V1::DataPolicy.
|
248
|
+
# p result
|
249
|
+
#
|
216
250
|
def create_data_policy request, options = nil
|
217
251
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
218
252
|
|
@@ -286,6 +320,22 @@ module Google
|
|
286
320
|
# @return [::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicy]
|
287
321
|
#
|
288
322
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
323
|
+
#
|
324
|
+
# @example Basic example
|
325
|
+
# require "google/cloud/bigquery/data_policies/v1"
|
326
|
+
#
|
327
|
+
# # Create a client object. The client can be reused for multiple calls.
|
328
|
+
# client = Google::Cloud::Bigquery::DataPolicies::V1::DataPolicyService::Rest::Client.new
|
329
|
+
#
|
330
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
331
|
+
# request = Google::Cloud::Bigquery::DataPolicies::V1::UpdateDataPolicyRequest.new
|
332
|
+
#
|
333
|
+
# # Call the update_data_policy method.
|
334
|
+
# result = client.update_data_policy request
|
335
|
+
#
|
336
|
+
# # The returned object is of type Google::Cloud::Bigquery::DataPolicies::V1::DataPolicy.
|
337
|
+
# p result
|
338
|
+
#
|
289
339
|
def update_data_policy request, options = nil
|
290
340
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
291
341
|
|
@@ -351,6 +401,22 @@ module Google
|
|
351
401
|
# @return [::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicy]
|
352
402
|
#
|
353
403
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
404
|
+
#
|
405
|
+
# @example Basic example
|
406
|
+
# require "google/cloud/bigquery/data_policies/v1"
|
407
|
+
#
|
408
|
+
# # Create a client object. The client can be reused for multiple calls.
|
409
|
+
# client = Google::Cloud::Bigquery::DataPolicies::V1::DataPolicyService::Rest::Client.new
|
410
|
+
#
|
411
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
412
|
+
# request = Google::Cloud::Bigquery::DataPolicies::V1::RenameDataPolicyRequest.new
|
413
|
+
#
|
414
|
+
# # Call the rename_data_policy method.
|
415
|
+
# result = client.rename_data_policy request
|
416
|
+
#
|
417
|
+
# # The returned object is of type Google::Cloud::Bigquery::DataPolicies::V1::DataPolicy.
|
418
|
+
# p result
|
419
|
+
#
|
354
420
|
def rename_data_policy request, options = nil
|
355
421
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
356
422
|
|
@@ -414,6 +480,22 @@ module Google
|
|
414
480
|
# @return [::Google::Protobuf::Empty]
|
415
481
|
#
|
416
482
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
483
|
+
#
|
484
|
+
# @example Basic example
|
485
|
+
# require "google/cloud/bigquery/data_policies/v1"
|
486
|
+
#
|
487
|
+
# # Create a client object. The client can be reused for multiple calls.
|
488
|
+
# client = Google::Cloud::Bigquery::DataPolicies::V1::DataPolicyService::Rest::Client.new
|
489
|
+
#
|
490
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
491
|
+
# request = Google::Cloud::Bigquery::DataPolicies::V1::DeleteDataPolicyRequest.new
|
492
|
+
#
|
493
|
+
# # Call the delete_data_policy method.
|
494
|
+
# result = client.delete_data_policy request
|
495
|
+
#
|
496
|
+
# # The returned object is of type Google::Protobuf::Empty.
|
497
|
+
# p result
|
498
|
+
#
|
417
499
|
def delete_data_policy request, options = nil
|
418
500
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
419
501
|
|
@@ -477,6 +559,22 @@ module Google
|
|
477
559
|
# @return [::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicy]
|
478
560
|
#
|
479
561
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
562
|
+
#
|
563
|
+
# @example Basic example
|
564
|
+
# require "google/cloud/bigquery/data_policies/v1"
|
565
|
+
#
|
566
|
+
# # Create a client object. The client can be reused for multiple calls.
|
567
|
+
# client = Google::Cloud::Bigquery::DataPolicies::V1::DataPolicyService::Rest::Client.new
|
568
|
+
#
|
569
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
570
|
+
# request = Google::Cloud::Bigquery::DataPolicies::V1::GetDataPolicyRequest.new
|
571
|
+
#
|
572
|
+
# # Call the get_data_policy method.
|
573
|
+
# result = client.get_data_policy request
|
574
|
+
#
|
575
|
+
# # The returned object is of type Google::Cloud::Bigquery::DataPolicies::V1::DataPolicy.
|
576
|
+
# p result
|
577
|
+
#
|
480
578
|
def get_data_policy request, options = nil
|
481
579
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
482
580
|
|
@@ -556,6 +654,26 @@ module Google
|
|
556
654
|
# @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicy>]
|
557
655
|
#
|
558
656
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
657
|
+
#
|
658
|
+
# @example Basic example
|
659
|
+
# require "google/cloud/bigquery/data_policies/v1"
|
660
|
+
#
|
661
|
+
# # Create a client object. The client can be reused for multiple calls.
|
662
|
+
# client = Google::Cloud::Bigquery::DataPolicies::V1::DataPolicyService::Rest::Client.new
|
663
|
+
#
|
664
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
665
|
+
# request = Google::Cloud::Bigquery::DataPolicies::V1::ListDataPoliciesRequest.new
|
666
|
+
#
|
667
|
+
# # Call the list_data_policies method.
|
668
|
+
# result = client.list_data_policies request
|
669
|
+
#
|
670
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can iterate
|
671
|
+
# # over elements, and API calls will be issued to fetch pages as needed.
|
672
|
+
# result.each do |item|
|
673
|
+
# # Each element is of type ::Google::Cloud::Bigquery::DataPolicies::V1::DataPolicy.
|
674
|
+
# p item
|
675
|
+
# end
|
676
|
+
#
|
559
677
|
def list_data_policies request, options = nil
|
560
678
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
561
679
|
|
@@ -623,6 +741,22 @@ module Google
|
|
623
741
|
# @return [::Google::Iam::V1::Policy]
|
624
742
|
#
|
625
743
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
744
|
+
#
|
745
|
+
# @example Basic example
|
746
|
+
# require "google/cloud/bigquery/data_policies/v1"
|
747
|
+
#
|
748
|
+
# # Create a client object. The client can be reused for multiple calls.
|
749
|
+
# client = Google::Cloud::Bigquery::DataPolicies::V1::DataPolicyService::Rest::Client.new
|
750
|
+
#
|
751
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
752
|
+
# request = Google::Iam::V1::GetIamPolicyRequest.new
|
753
|
+
#
|
754
|
+
# # Call the get_iam_policy method.
|
755
|
+
# result = client.get_iam_policy request
|
756
|
+
#
|
757
|
+
# # The returned object is of type Google::Iam::V1::Policy.
|
758
|
+
# p result
|
759
|
+
#
|
626
760
|
def get_iam_policy request, options = nil
|
627
761
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
628
762
|
|
@@ -697,6 +831,22 @@ module Google
|
|
697
831
|
# @return [::Google::Iam::V1::Policy]
|
698
832
|
#
|
699
833
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
834
|
+
#
|
835
|
+
# @example Basic example
|
836
|
+
# require "google/cloud/bigquery/data_policies/v1"
|
837
|
+
#
|
838
|
+
# # Create a client object. The client can be reused for multiple calls.
|
839
|
+
# client = Google::Cloud::Bigquery::DataPolicies::V1::DataPolicyService::Rest::Client.new
|
840
|
+
#
|
841
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
842
|
+
# request = Google::Iam::V1::SetIamPolicyRequest.new
|
843
|
+
#
|
844
|
+
# # Call the set_iam_policy method.
|
845
|
+
# result = client.set_iam_policy request
|
846
|
+
#
|
847
|
+
# # The returned object is of type Google::Iam::V1::Policy.
|
848
|
+
# p result
|
849
|
+
#
|
700
850
|
def set_iam_policy request, options = nil
|
701
851
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
702
852
|
|
@@ -765,6 +915,22 @@ module Google
|
|
765
915
|
# @return [::Google::Iam::V1::TestIamPermissionsResponse]
|
766
916
|
#
|
767
917
|
# @raise [::Google::Cloud::Error] if the REST call is aborted.
|
918
|
+
#
|
919
|
+
# @example Basic example
|
920
|
+
# require "google/cloud/bigquery/data_policies/v1"
|
921
|
+
#
|
922
|
+
# # Create a client object. The client can be reused for multiple calls.
|
923
|
+
# client = Google::Cloud::Bigquery::DataPolicies::V1::DataPolicyService::Rest::Client.new
|
924
|
+
#
|
925
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
926
|
+
# request = Google::Iam::V1::TestIamPermissionsRequest.new
|
927
|
+
#
|
928
|
+
# # Call the test_iam_permissions method.
|
929
|
+
# result = client.test_iam_permissions request
|
930
|
+
#
|
931
|
+
# # The returned object is of type Google::Iam::V1::TestIamPermissionsResponse.
|
932
|
+
# p result
|
933
|
+
#
|
768
934
|
def test_iam_permissions request, options = nil
|
769
935
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
770
936
|
|
@@ -830,9 +996,9 @@ module Google
|
|
830
996
|
# end
|
831
997
|
#
|
832
998
|
# @!attribute [rw] endpoint
|
833
|
-
#
|
834
|
-
#
|
835
|
-
# @return [::String]
|
999
|
+
# A custom service endpoint, as a hostname or hostname:port. The default is
|
1000
|
+
# nil, indicating to use the default endpoint in the current universe domain.
|
1001
|
+
# @return [::String,nil]
|
836
1002
|
# @!attribute [rw] credentials
|
837
1003
|
# Credentials to send with calls. You may provide any of the following types:
|
838
1004
|
# * (`String`) The path to a service account key file in JSON format
|
@@ -869,13 +1035,20 @@ module Google
|
|
869
1035
|
# @!attribute [rw] quota_project
|
870
1036
|
# A separate project against which to charge quota.
|
871
1037
|
# @return [::String]
|
1038
|
+
# @!attribute [rw] universe_domain
|
1039
|
+
# The universe domain within which to make requests. This determines the
|
1040
|
+
# default endpoint URL. The default value of nil uses the environment
|
1041
|
+
# universe (usually the default "googleapis.com" universe).
|
1042
|
+
# @return [::String,nil]
|
872
1043
|
#
|
873
1044
|
class Configuration
|
874
1045
|
extend ::Gapic::Config
|
875
1046
|
|
1047
|
+
# @private
|
1048
|
+
# The endpoint specific to the default "googleapis.com" universe. Deprecated.
|
876
1049
|
DEFAULT_ENDPOINT = "bigquerydatapolicy.googleapis.com"
|
877
1050
|
|
878
|
-
config_attr :endpoint,
|
1051
|
+
config_attr :endpoint, nil, ::String, nil
|
879
1052
|
config_attr :credentials, nil do |value|
|
880
1053
|
allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
|
881
1054
|
allowed.any? { |klass| klass === value }
|
@@ -887,6 +1060,7 @@ module Google
|
|
887
1060
|
config_attr :metadata, nil, ::Hash, nil
|
888
1061
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
889
1062
|
config_attr :quota_project, nil, ::String, nil
|
1063
|
+
config_attr :universe_domain, nil, ::String, nil
|
890
1064
|
|
891
1065
|
# @private
|
892
1066
|
def initialize parent_config = nil
|
@@ -31,16 +31,28 @@ module Google
|
|
31
31
|
# including transcoding, making the REST call, and deserialing the response.
|
32
32
|
#
|
33
33
|
class ServiceStub
|
34
|
-
def initialize endpoint:, credentials:
|
34
|
+
def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
|
35
35
|
# These require statements are intentionally placed here to initialize
|
36
36
|
# the REST modules only when it's required.
|
37
37
|
require "gapic/rest"
|
38
38
|
|
39
|
-
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
39
|
+
@client_stub = ::Gapic::Rest::ClientStub.new endpoint: endpoint,
|
40
|
+
endpoint_template: endpoint_template,
|
41
|
+
universe_domain: universe_domain,
|
42
|
+
credentials: credentials,
|
40
43
|
numeric_enums: true,
|
41
44
|
raise_faraday_errors: false
|
42
45
|
end
|
43
46
|
|
47
|
+
##
|
48
|
+
# The effective universe domain
|
49
|
+
#
|
50
|
+
# @return [String]
|
51
|
+
#
|
52
|
+
def universe_domain
|
53
|
+
@client_stub.universe_domain
|
54
|
+
end
|
55
|
+
|
44
56
|
##
|
45
57
|
# Baseline implementation for the create_data_policy REST call
|
46
58
|
#
|
@@ -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
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-bigquery-data_policies-v1
|
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
|
@@ -228,7 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
228
228
|
- !ruby/object:Gem::Version
|
229
229
|
version: '0'
|
230
230
|
requirements: []
|
231
|
-
rubygems_version: 3.
|
231
|
+
rubygems_version: 3.5.3
|
232
232
|
signing_key:
|
233
233
|
specification_version: 4
|
234
234
|
summary: Allows users to manage BigQuery data policies.
|