google-cloud-dataform-v1beta1 0.4.0 → 0.6.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (15) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +72 -99
  3. data/README.md +1 -1
  4. data/lib/google/cloud/dataform/v1beta1/bindings_override.rb +81 -0
  5. data/lib/google/cloud/dataform/v1beta1/dataform/client.rb +2238 -713
  6. data/lib/google/cloud/dataform/v1beta1/dataform/paths.rb +42 -0
  7. data/lib/google/cloud/dataform/v1beta1/dataform/rest/client.rb +2106 -684
  8. data/lib/google/cloud/dataform/v1beta1/dataform/rest/service_stub.rb +967 -65
  9. data/lib/google/cloud/dataform/v1beta1/dataform_pb.rb +41 -4
  10. data/lib/google/cloud/dataform/v1beta1/dataform_services_pb.rb +34 -0
  11. data/lib/google/cloud/dataform/v1beta1/version.rb +1 -1
  12. data/proto_docs/google/api/client.rb +14 -0
  13. data/proto_docs/google/cloud/dataform/v1beta1/dataform.rb +802 -177
  14. data/proto_docs/google/rpc/status.rb +48 -0
  15. metadata +12 -10
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: d74c4de18dfcb3e61193dcd67609f46c30cbd792a5fe302ea719576d722f58d8
4
- data.tar.gz: c4bc349255d0085efb1181f5dbec1f3aeae89a911d1ca77c7d1da78239528c8e
3
+ metadata.gz: 82fff7d75592915618d7f6f9f1c47493c4ceb15674c3d9bc3532b19a46b9a49d
4
+ data.tar.gz: 7b0f6bb658db05a66a3c0174556fa19c13bd3244ca1d0772d52ac1f5e996a553
5
5
  SHA512:
6
- metadata.gz: add097fe8c07b8c0dd11f430ddb113de25305ba282ff0addd5a25eaf99797c18cd286c80c32140c1580bc7d4f08a99661d4777fa09ad887e022c925df9d805c7
7
- data.tar.gz: b1528a985c79546baa7258179e5cc872e4b4d111452197d52c6eaad71f0bdc6d15b0e225872724fd4a79a972eb3b2c599500c92767aa842846c5f30bc799daf0
6
+ metadata.gz: 192207be0a2c50d9cb237d57fc3f28ff1b8e0968562e1c9e4c14193367aa1c0ad5707ea65c1941a3bc29dd8d94d8be86871d66915d6c024fb54b0d7d103b9651
7
+ data.tar.gz: 483f87eb9debcabd7b1b6b2a145506c4778756ee2ce1fbd8ce485eb9954fc48e2f3ca1992a53224de2d08ad291d5cba58854e60317af1b7a9caac965fe01e4d7
data/AUTHENTICATION.md CHANGED
@@ -1,149 +1,122 @@
1
1
  # Authentication
2
2
 
3
- In general, the google-cloud-dataform-v1beta1 library uses
4
- [Service Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
5
- credentials to connect to Google Cloud services. When running within
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-dataform-v1beta1 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
- 1. [Create a service account and credentials](#creating-a-service-account).
19
- 2. Set the [environment variable](#environment-variables).
9
+ The following example shows how to set up authentication for a local development
10
+ environment with your user credentials.
20
11
 
21
- ```sh
22
- export GOOGLE_CLOUD_CREDENTIALS=path/to/keyfile.json
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
- ```ruby
28
- require "google/cloud/dataform/v1beta1"
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
- client = ::Google::Cloud::Dataform::V1beta1::Dataform::Client.new
18
+ ```sh
19
+ gcloud auth application-default login
31
20
  ```
32
21
 
33
- ## Credential Lookup
34
-
35
- The google-cloud-dataform-v1beta1 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
- When running on Google Cloud Platform (GCP), including Google Compute Engine
51
- (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
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
- ### Environment Variables
27
+ ## Credential Lookup
56
28
 
57
- The **Credentials JSON** can be placed in environment variables instead of
58
- declaring them directly in code. Each service has its own environment variable,
59
- allowing for different service accounts to be used for different services. (See
60
- the READMEs for the individual service gems for details.) The path to the
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-dataform-v1beta1 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
- The environment variables that google-cloud-dataform-v1beta1
66
- checks for credentials are configured on the service Credentials class (such as
67
- {::Google::Cloud::Dataform::V1beta1::Dataform::Credentials}):
34
+ Credentials are accepted in the following ways, in the following order or precedence:
68
35
 
69
- * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
70
- * `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
71
- * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
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
- ```ruby
74
- require "google/cloud/dataform/v1beta1"
75
-
76
- ENV["GOOGLE_CLOUD_CREDENTIALS"] = "path/to/keyfile.json"
42
+ ### Configuration
77
43
 
78
- client = ::Google::Cloud::Dataform::V1beta1::Dataform::Client.new
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
- ### Configuration
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
- The path to the **Credentials JSON** file can be configured instead of storing
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/dataform/v1beta1"
88
58
 
89
59
  client = ::Google::Cloud::Dataform::V1beta1::Dataform::Client.new do |config|
90
- config.credentials = "path/to/keyfile.json"
60
+ config.credentials = "path/to/credentialfile.json"
91
61
  end
92
62
  ```
93
63
 
94
- Or globally for all clients:
64
+ To configure a credentials file globally for all clients:
95
65
 
96
66
  ```ruby
97
67
  require "google/cloud/dataform/v1beta1"
98
68
 
99
69
  ::Google::Cloud::Dataform::V1beta1::Dataform::Client.configure do |config|
100
- config.credentials = "path/to/keyfile.json"
70
+ config.credentials = "path/to/credentialfile.json"
101
71
  end
102
72
 
103
73
  client = ::Google::Cloud::Dataform::V1beta1::Dataform::Client.new
104
74
  ```
105
75
 
106
- ### Cloud SDK
76
+ ### Environment Variables
107
77
 
108
- This option allows for an easy way to authenticate during development. If
109
- credentials are not provided in code or in environment variables, then Cloud SDK
110
- credentials are discovered.
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
- To configure your system for this, simply:
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
- 1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
115
- 2. Authenticate using OAuth 2.0 `$ gcloud auth application-default login`
116
- 3. Write code as if already authenticated.
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-dataform-v1beta1
93
+ checks for credentials are:
117
94
 
118
- **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
119
- *should* only be used during development.
95
+ * `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
96
+ * `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
120
97
 
121
- ## Creating a Service Account
98
+ ```ruby
99
+ require "google/cloud/dataform/v1beta1"
122
100
 
123
- Google Cloud requires **Service Account Credentials** to
124
- connect to the APIs. You will use the **JSON key file** to
125
- connect to most services with google-cloud-dataform-v1beta1.
101
+ ENV["GOOGLE_APPLICATION_CREDENTIALS"] = "path/to/credentialfile.json"
126
102
 
127
- If you are not running this client within
128
- [Google Cloud Platform environments](#google-cloud-platform-environments), you
129
- need a Google Developers service account.
103
+ client = ::Google::Cloud::Dataform::V1beta1::Dataform::Client.new
104
+ ```
130
105
 
131
- 1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
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
- *Note: You may need to enable billing in order to use these services.*
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
- 4. Select **Credentials** from the side navigation.
112
+ Follow the steps in [Quickstart](#quickstart) to set up a local ADC file.
139
113
 
140
- Find the "Create credentials" drop down near the top of the page, and select
141
- "Service account" to be guided through downloading a new JSON key file.
114
+ ### Google Cloud Platform environments
142
115
 
143
- If you want to re-use an existing service account, you can easily generate a
144
- new key file. Just select the account you wish to re-use, click the pencil
145
- tool on the right side to edit the service account, select the **Keys** tab,
146
- and then select **Add Key**.
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
- The key file you download will be used by this library to authenticate API
149
- requests and should be stored in a secure location.
121
+ For more information, see
122
+ [Set up ADC for Google Cloud services](https://cloud.google.com/docs/authentication/provide-credentials-adc#attached-sa).
data/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # Ruby Client for the Dataform V1beta1 API
2
2
 
3
- API Client library for the Dataform V1beta1 API
3
+ Service to develop, version control, and operationalize SQL pipelines in BigQuery.
4
4
 
5
5
  Dataform is a service for data analysts to develop, test, version control, and schedule complex SQL workflows for data transformation in BigQuery.
6
6
 
data/lib/google/cloud/dataform/v1beta1/bindings_override.rb CHANGED
@@ -64,6 +64,87 @@ module Google
64
64
  body: nil
65
65
  )
66
66
  ]
67
+ default_config.bindings_override["google.iam.v1.IAMPolicy.GetIamPolicy"] = [
68
+
69
+ Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
70
+ uri_method: :get,
71
+ uri_template: "/v1beta1/{resource}:getIamPolicy",
72
+ matches: [
73
+ ["resource", %r{^projects/[^/]+/locations/[^/]+/repositories/[^/]+/?$}, false]
74
+ ],
75
+ body: nil
76
+ ),
77
+ Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
78
+ uri_method: :get,
79
+ uri_template: "/v1beta1/{resource}:getIamPolicy",
80
+ matches: [
81
+ ["resource", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/?$}, false]
82
+ ],
83
+ body: nil
84
+ ),
85
+ Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
86
+ uri_method: :get,
87
+ uri_template: "/v1beta1/{resource}:getIamPolicy",
88
+ matches: [
89
+ ["resource", %r{^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+/?$}, false]
90
+ ],
91
+ body: nil
92
+ )
93
+ ]
94
+ default_config.bindings_override["google.iam.v1.IAMPolicy.SetIamPolicy"] = [
95
+
96
+ Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
97
+ uri_method: :post,
98
+ uri_template: "/v1beta1/{resource}:setIamPolicy",
99
+ matches: [
100
+ ["resource", %r{^projects/[^/]+/locations/[^/]+/repositories/[^/]+/?$}, false]
101
+ ],
102
+ body: "*"
103
+ ),
104
+ Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
105
+ uri_method: :post,
106
+ uri_template: "/v1beta1/{resource}:setIamPolicy",
107
+ matches: [
108
+ ["resource", %r{^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+/?$}, false]
109
+ ],
110
+ body: "*"
111
+ ),
112
+ Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
113
+ uri_method: :post,
114
+ uri_template: "/v1beta1/{resource}:setIamPolicy",
115
+ matches: [
116
+ ["resource", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/?$}, false]
117
+ ],
118
+ body: "*"
119
+ )
120
+ ]
121
+ default_config.bindings_override["google.iam.v1.IAMPolicy.TestIamPermissions"] = [
122
+
123
+ Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
124
+ uri_method: :post,
125
+ uri_template: "/v1beta1/{resource}:testIamPermissions",
126
+ matches: [
127
+ ["resource", %r{^projects/[^/]+/locations/[^/]+/repositories/[^/]+/?$}, false]
128
+ ],
129
+ body: "*"
130
+ ),
131
+ Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
132
+ uri_method: :post,
133
+ uri_template: "/v1beta1/{resource}:testIamPermissions",
134
+ matches: [
135
+ ["resource", %r{^projects/[^/]+/locations/[^/]+/collections/[^/]+/?$}, false]
136
+ ],
137
+ body: "*"
138
+ ),
139
+ Gapic::Rest::GrpcTranscoder::HttpBinding.create_with_validation(
140
+ uri_method: :post,
141
+ uri_template: "/v1beta1/{resource}:testIamPermissions",
142
+ matches: [
143
+ ["resource", %r{^projects/[^/]+/locations/[^/]+/repositories/[^/]+/workspaces/[^/]+/?$}, false]
144
+ ],
145
+ body: "*"
146
+ )
147
+ ]
67
148
  default_config
68
149
  end
69
150
  yield @configure if block_given?