google-cloud-bigquery-reservation 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.yardopts +11 -0
- data/AUTHENTICATION.md +169 -0
- data/LICENSE.md +203 -0
- data/README.md +71 -0
- data/lib/google-cloud-bigquery-reservation.rb +19 -0
- data/lib/google/cloud/bigquery/reservation.rb +131 -0
- data/lib/google/cloud/bigquery/reservation/version.rb +28 -0
- metadata +191 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 0642c29b2d0e2e3b0915cfdc84ec771e291ab2d1bd1d830aaf33cf46cdd33e5a
|
4
|
+
data.tar.gz: 3857577f7c7547570de8b4e5602d5bb627de91ee06cef24a61ca5a4d523623b2
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 95af4e7f19d05323717d21cbad399c2ca1e944f512ffb7815af6528aafa82535ae7f3667d601a4683d0661ec2a99cce9dbfeec5b13a0abf34cbfd28cdbe38954
|
7
|
+
data.tar.gz: e2fc65b9a2cffa5876e2ccbe277583661e15da38fbc9eaeeb7cc99ff5632a0a524839a9f6d630343fb28e20ca0afc3e4f68cf79794ba4ac76957ba2999ed1d60
|
data/.yardopts
ADDED
data/AUTHENTICATION.md
ADDED
@@ -0,0 +1,169 @@
|
|
1
|
+
# Authentication
|
2
|
+
|
3
|
+
In general, the google-cloud-bigquery-reservation 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.
|
15
|
+
|
16
|
+
## Quickstart
|
17
|
+
|
18
|
+
1. [Create a service account and credentials](#creating-a-service-account).
|
19
|
+
2. Set the [environment variable](#environment-variables).
|
20
|
+
|
21
|
+
```sh
|
22
|
+
export BIGQUERY_RESERVATION_CREDENTIALS=path/to/keyfile.json
|
23
|
+
```
|
24
|
+
|
25
|
+
3. Initialize the client.
|
26
|
+
|
27
|
+
```ruby
|
28
|
+
require "google/cloud/bigquery/reservation"
|
29
|
+
|
30
|
+
client = Google::Cloud::Bigquery::Reservation.reservation_service
|
31
|
+
```
|
32
|
+
|
33
|
+
## Credential Lookup
|
34
|
+
|
35
|
+
The google-cloud-bigquery-reservation 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
|
49
|
+
|
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.
|
54
|
+
|
55
|
+
### Environment Variables
|
56
|
+
|
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.
|
64
|
+
|
65
|
+
The environment variables that google-cloud-bigquery-reservation
|
66
|
+
checks for credentials are configured on the service Credentials class (such as
|
67
|
+
`::Google::Cloud::Bigquery::Reservation::V1::ReservationService::Credentials`):
|
68
|
+
|
69
|
+
1. `BIGQUERY_RESERVATION_CREDENTIALS` - Path to JSON file, or JSON contents
|
70
|
+
2. `BIGQUERY_RESERVATION_KEYFILE` - Path to JSON file, or JSON contents
|
71
|
+
3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
72
|
+
4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
|
73
|
+
5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
74
|
+
|
75
|
+
```ruby
|
76
|
+
require "google/cloud/bigquery/reservation"
|
77
|
+
|
78
|
+
ENV["BIGQUERY_RESERVATION_CREDENTIALS"] = "path/to/keyfile.json"
|
79
|
+
|
80
|
+
client = Google::Cloud::Bigquery::Reservation.reservation_service
|
81
|
+
```
|
82
|
+
|
83
|
+
### Configuration
|
84
|
+
|
85
|
+
The **Credentials JSON** can be configured instead of placing them in
|
86
|
+
environment variables. Either on an individual client initialization:
|
87
|
+
|
88
|
+
```ruby
|
89
|
+
require "google/cloud/bigquery/reservation"
|
90
|
+
|
91
|
+
client = Google::Cloud::Bigquery::Reservation.reservation_service do |config|
|
92
|
+
config.credentials = "path/to/keyfile.json"
|
93
|
+
end
|
94
|
+
```
|
95
|
+
|
96
|
+
Or configured globally for all clients:
|
97
|
+
|
98
|
+
```ruby
|
99
|
+
require "google/cloud/bigquery/reservation"
|
100
|
+
|
101
|
+
Google::Cloud::Bigquery::Reservation.configure do |config|
|
102
|
+
config.credentials = "path/to/keyfile.json"
|
103
|
+
end
|
104
|
+
|
105
|
+
client = Google::Cloud::Bigquery::Reservation.reservation_service
|
106
|
+
```
|
107
|
+
|
108
|
+
### Cloud SDK
|
109
|
+
|
110
|
+
This option allows for an easy way to authenticate during development. If
|
111
|
+
credentials are not provided in code or in environment variables, then Cloud SDK
|
112
|
+
credentials are discovered.
|
113
|
+
|
114
|
+
To configure your system for this, simply:
|
115
|
+
|
116
|
+
1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
|
117
|
+
2. Authenticate using OAuth 2.0 `$ gcloud auth login`
|
118
|
+
3. Write code as if already authenticated.
|
119
|
+
|
120
|
+
**NOTE:** This is _not_ recommended for running in production. The Cloud SDK
|
121
|
+
*should* only be used during development.
|
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
|
+
## Creating a Service Account
|
133
|
+
|
134
|
+
Google Cloud requires **Service Account Credentials** to
|
135
|
+
connect to the APIs. You will use the **JSON key file** to
|
136
|
+
connect to most services with google-cloud-bigquery-reservation.
|
137
|
+
|
138
|
+
If you are not running this client within
|
139
|
+
[Google Cloud Platform environments](#google-cloud-platform-environments), you
|
140
|
+
need a Google Developers service account.
|
141
|
+
|
142
|
+
1. Visit the [Google Developers Console][dev-console].
|
143
|
+
2. Create a new project or click on an existing project.
|
144
|
+
3. Activate the slide-out navigation tray and select **API Manager**. From
|
145
|
+
here, you will enable the APIs that your application requires.
|
146
|
+
|
147
|
+
![Enable the APIs that your application requires][enable-apis]
|
148
|
+
|
149
|
+
*Note: You may need to enable billing in order to use these services.*
|
150
|
+
|
151
|
+
4. Select **Credentials** from the side navigation.
|
152
|
+
|
153
|
+
You should see a screen like one of the following.
|
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.
|
161
|
+
|
162
|
+
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, and click "Generate
|
164
|
+
new JSON key":
|
165
|
+
|
166
|
+
![Re-use an existing service account][reuse-service-account]
|
167
|
+
|
168
|
+
The key file you download will be used by this library to authenticate API
|
169
|
+
requests and should be stored in a secure location.
|
data/LICENSE.md
ADDED
@@ -0,0 +1,203 @@
|
|
1
|
+
Apache License
|
2
|
+
==============
|
3
|
+
|
4
|
+
* Version 2.0, January 2004
|
5
|
+
* https://www.apache.org/licenses/
|
6
|
+
|
7
|
+
### TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
8
|
+
|
9
|
+
1. **Definitions.**
|
10
|
+
|
11
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
12
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
13
|
+
|
14
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
15
|
+
the copyright owner that is granting the License.
|
16
|
+
|
17
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
18
|
+
other entities that control, are controlled by, or are under common
|
19
|
+
control with that entity. For the purposes of this definition,
|
20
|
+
"control" means (i) the power, direct or indirect, to cause the
|
21
|
+
direction or management of such entity, whether by contract or
|
22
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
23
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
24
|
+
|
25
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
26
|
+
exercising permissions granted by this License.
|
27
|
+
|
28
|
+
"Source" form shall mean the preferred form for making modifications,
|
29
|
+
including but not limited to software source code, documentation
|
30
|
+
source, and configuration files.
|
31
|
+
|
32
|
+
"Object" form shall mean any form resulting from mechanical
|
33
|
+
transformation or translation of a Source form, including but
|
34
|
+
not limited to compiled object code, generated documentation,
|
35
|
+
and conversions to other media types.
|
36
|
+
|
37
|
+
"Work" shall mean the work of authorship, whether in Source or
|
38
|
+
Object form, made available under the License, as indicated by a
|
39
|
+
copyright notice that is included in or attached to the work
|
40
|
+
(an example is provided in the Appendix below).
|
41
|
+
|
42
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
43
|
+
form, that is based on (or derived from) the Work and for which the
|
44
|
+
editorial revisions, annotations, elaborations, or other modifications
|
45
|
+
represent, as a whole, an original work of authorship. For the purposes
|
46
|
+
of this License, Derivative Works shall not include works that remain
|
47
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
48
|
+
the Work and Derivative Works thereof.
|
49
|
+
|
50
|
+
"Contribution" shall mean any work of authorship, including
|
51
|
+
the original version of the Work and any modifications or additions
|
52
|
+
to that Work or Derivative Works thereof, that is intentionally
|
53
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
54
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
55
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
56
|
+
means any form of electronic, verbal, or written communication sent
|
57
|
+
to the Licensor or its representatives, including but not limited to
|
58
|
+
communication on electronic mailing lists, source code control systems,
|
59
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
60
|
+
Licensor for the purpose of discussing and improving the Work, but
|
61
|
+
excluding communication that is conspicuously marked or otherwise
|
62
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
63
|
+
|
64
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
65
|
+
on behalf of whom a Contribution has been received by Licensor and
|
66
|
+
subsequently incorporated within the Work.
|
67
|
+
|
68
|
+
2. **Grant of Copyright License.** Subject to the terms and conditions of
|
69
|
+
this License, each Contributor hereby grants to You a perpetual,
|
70
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
71
|
+
copyright license to reproduce, prepare Derivative Works of,
|
72
|
+
publicly display, publicly perform, sublicense, and distribute the
|
73
|
+
Work and such Derivative Works in Source or Object form.
|
74
|
+
|
75
|
+
3. **Grant of Patent License.** Subject to the terms and conditions of
|
76
|
+
this License, each Contributor hereby grants to You a perpetual,
|
77
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
78
|
+
(except as stated in this section) patent license to make, have made,
|
79
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
80
|
+
where such license applies only to those patent claims licensable
|
81
|
+
by such Contributor that are necessarily infringed by their
|
82
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
83
|
+
with the Work to which such Contribution(s) was submitted. If You
|
84
|
+
institute patent litigation against any entity (including a
|
85
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
86
|
+
or a Contribution incorporated within the Work constitutes direct
|
87
|
+
or contributory patent infringement, then any patent licenses
|
88
|
+
granted to You under this License for that Work shall terminate
|
89
|
+
as of the date such litigation is filed.
|
90
|
+
|
91
|
+
4. **Redistribution.** You may reproduce and distribute copies of the
|
92
|
+
Work or Derivative Works thereof in any medium, with or without
|
93
|
+
modifications, and in Source or Object form, provided that You
|
94
|
+
meet the following conditions:
|
95
|
+
|
96
|
+
* **(a)** You must give any other recipients of the Work or
|
97
|
+
Derivative Works a copy of this License; and
|
98
|
+
|
99
|
+
* **(b)** You must cause any modified files to carry prominent notices
|
100
|
+
stating that You changed the files; and
|
101
|
+
|
102
|
+
* **(c)** You must retain, in the Source form of any Derivative Works
|
103
|
+
that You distribute, all copyright, patent, trademark, and
|
104
|
+
attribution notices from the Source form of the Work,
|
105
|
+
excluding those notices that do not pertain to any part of
|
106
|
+
the Derivative Works; and
|
107
|
+
|
108
|
+
* **(d)** If the Work includes a "NOTICE" text file as part of its
|
109
|
+
distribution, then any Derivative Works that You distribute must
|
110
|
+
include a readable copy of the attribution notices contained
|
111
|
+
within such NOTICE file, excluding those notices that do not
|
112
|
+
pertain to any part of the Derivative Works, in at least one
|
113
|
+
of the following places: within a NOTICE text file distributed
|
114
|
+
as part of the Derivative Works; within the Source form or
|
115
|
+
documentation, if provided along with the Derivative Works; or,
|
116
|
+
within a display generated by the Derivative Works, if and
|
117
|
+
wherever such third-party notices normally appear. The contents
|
118
|
+
of the NOTICE file are for informational purposes only and
|
119
|
+
do not modify the License. You may add Your own attribution
|
120
|
+
notices within Derivative Works that You distribute, alongside
|
121
|
+
or as an addendum to the NOTICE text from the Work, provided
|
122
|
+
that such additional attribution notices cannot be construed
|
123
|
+
as modifying the License.
|
124
|
+
|
125
|
+
You may add Your own copyright statement to Your modifications and
|
126
|
+
may provide additional or different license terms and conditions
|
127
|
+
for use, reproduction, or distribution of Your modifications, or
|
128
|
+
for any such Derivative Works as a whole, provided Your use,
|
129
|
+
reproduction, and distribution of the Work otherwise complies with
|
130
|
+
the conditions stated in this License.
|
131
|
+
|
132
|
+
5. **Submission of Contributions.** Unless You explicitly state otherwise,
|
133
|
+
any Contribution intentionally submitted for inclusion in the Work
|
134
|
+
by You to the Licensor shall be under the terms and conditions of
|
135
|
+
this License, without any additional terms or conditions.
|
136
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
137
|
+
the terms of any separate license agreement you may have executed
|
138
|
+
with Licensor regarding such Contributions.
|
139
|
+
|
140
|
+
6. **Trademarks.** This License does not grant permission to use the trade
|
141
|
+
names, trademarks, service marks, or product names of the Licensor,
|
142
|
+
except as required for reasonable and customary use in describing the
|
143
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
144
|
+
|
145
|
+
7. **Disclaimer of Warranty.** Unless required by applicable law or
|
146
|
+
agreed to in writing, Licensor provides the Work (and each
|
147
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
148
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
149
|
+
implied, including, without limitation, any warranties or conditions
|
150
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
151
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
152
|
+
appropriateness of using or redistributing the Work and assume any
|
153
|
+
risks associated with Your exercise of permissions under this License.
|
154
|
+
|
155
|
+
8. **Limitation of Liability.** In no event and under no legal theory,
|
156
|
+
whether in tort (including negligence), contract, or otherwise,
|
157
|
+
unless required by applicable law (such as deliberate and grossly
|
158
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
159
|
+
liable to You for damages, including any direct, indirect, special,
|
160
|
+
incidental, or consequential damages of any character arising as a
|
161
|
+
result of this License or out of the use or inability to use the
|
162
|
+
Work (including but not limited to damages for loss of goodwill,
|
163
|
+
work stoppage, computer failure or malfunction, or any and all
|
164
|
+
other commercial damages or losses), even if such Contributor
|
165
|
+
has been advised of the possibility of such damages.
|
166
|
+
|
167
|
+
9. **Accepting Warranty or Additional Liability.** While redistributing
|
168
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
169
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
170
|
+
or other liability obligations and/or rights consistent with this
|
171
|
+
License. However, in accepting such obligations, You may act only
|
172
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
173
|
+
of any other Contributor, and only if You agree to indemnify,
|
174
|
+
defend, and hold each Contributor harmless for any liability
|
175
|
+
incurred by, or claims asserted against, such Contributor by reason
|
176
|
+
of your accepting any such warranty or additional liability.
|
177
|
+
|
178
|
+
_END OF TERMS AND CONDITIONS_
|
179
|
+
|
180
|
+
### APPENDIX: How to apply the Apache License to your work.
|
181
|
+
|
182
|
+
To apply the Apache License to your work, attach the following
|
183
|
+
boilerplate notice, with the fields enclosed by brackets "`[]`"
|
184
|
+
replaced with your own identifying information. (Don't include
|
185
|
+
the brackets!) The text should be enclosed in the appropriate
|
186
|
+
comment syntax for the file format. We also recommend that a
|
187
|
+
file or class name and description of purpose be included on the
|
188
|
+
same "printed page" as the copyright notice for easier
|
189
|
+
identification within third-party archives.
|
190
|
+
|
191
|
+
Copyright [yyyy] [name of copyright owner]
|
192
|
+
|
193
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
194
|
+
you may not use this file except in compliance with the License.
|
195
|
+
You may obtain a copy of the License at
|
196
|
+
|
197
|
+
https://www.apache.org/licenses/LICENSE-2.0
|
198
|
+
|
199
|
+
Unless required by applicable law or agreed to in writing, software
|
200
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
201
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
202
|
+
See the License for the specific language governing permissions and
|
203
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,71 @@
|
|
1
|
+
# Ruby Client for the BigQuery Reservation API
|
2
|
+
|
3
|
+
API Client library for the BigQuery Reservation API
|
4
|
+
|
5
|
+
The BigQuery Reservation API provides the mechanisms by which enterprise users can provision and manage dedicated resources such as slots and BigQuery BI Engine memory allocations.
|
6
|
+
|
7
|
+
Actual client classes for the various versions of this API are defined in
|
8
|
+
_versioned_ client gems, with names of the form `google-cloud-bigquery-reservation-v*`.
|
9
|
+
The gem `google-cloud-bigquery-reservation` is a convenience wrapper library that brings the
|
10
|
+
verisoned gems in as dependencies, and provides high-level methods for
|
11
|
+
constructing clients.
|
12
|
+
|
13
|
+
View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-bigquery-reservation/latest)
|
14
|
+
for this library, google-cloud-bigquery-reservation, to see the convenience methods for
|
15
|
+
constructing client objects. Reference documentation for the client objects
|
16
|
+
themselves can be found in the client library documentation for the versioned
|
17
|
+
client gems:
|
18
|
+
[google-cloud-bigquery-reservation-v1](https://googleapis.dev/ruby/google-cloud-bigquery-reservation-v1/latest).
|
19
|
+
|
20
|
+
See also the [Product Documentation](https://cloud.google.com/bigquery/docs/reference/reservations)
|
21
|
+
for more usage information.
|
22
|
+
|
23
|
+
## Quick Start
|
24
|
+
|
25
|
+
```
|
26
|
+
$ gem install google-cloud-bigquery-reservation
|
27
|
+
```
|
28
|
+
|
29
|
+
In order to use this library, you first need to go through the following steps:
|
30
|
+
|
31
|
+
1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
|
32
|
+
1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
|
33
|
+
1. [Enable the API.](https://console.cloud.google.com/apis/library/bigqueryreservation.googleapis.com)
|
34
|
+
1. {file:AUTHENTICATION.md Set up authentication.}
|
35
|
+
|
36
|
+
## Enabling Logging
|
37
|
+
|
38
|
+
To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
|
39
|
+
The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
|
40
|
+
or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
|
41
|
+
that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
|
42
|
+
and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
|
43
|
+
|
44
|
+
Configuring a Ruby stdlib logger:
|
45
|
+
|
46
|
+
```ruby
|
47
|
+
require "logger"
|
48
|
+
|
49
|
+
module MyLogger
|
50
|
+
LOGGER = Logger.new $stderr, level: Logger::WARN
|
51
|
+
def logger
|
52
|
+
LOGGER
|
53
|
+
end
|
54
|
+
end
|
55
|
+
|
56
|
+
# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
|
57
|
+
module GRPC
|
58
|
+
extend MyLogger
|
59
|
+
end
|
60
|
+
```
|
61
|
+
|
62
|
+
## Supported Ruby Versions
|
63
|
+
|
64
|
+
This library is supported on Ruby 2.4+.
|
65
|
+
|
66
|
+
Google provides official support for Ruby versions that are actively supported
|
67
|
+
by Ruby Core—that is, Ruby versions that are either in normal maintenance or
|
68
|
+
in security maintenance, and not end of life. Currently, this means Ruby 2.4
|
69
|
+
and later. Older versions of Ruby _may_ still work, but are unsupported and not
|
70
|
+
recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
|
71
|
+
about the Ruby support schedule.
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2020 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
require "google/cloud/bigquery/reservation" unless defined? Google::Cloud::Bigquery::Reservation::VERSION
|
@@ -0,0 +1,131 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2020 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
# Require this file early so that the version constant gets defined before
|
20
|
+
# requiring "google/cloud". This is because google-cloud-core will load the
|
21
|
+
# entrypoint (gem name) file, which in turn re-requires this file (hence
|
22
|
+
# causing a require cycle) unless the version constant is already defined.
|
23
|
+
require "google/cloud/bigquery/reservation/version"
|
24
|
+
|
25
|
+
require "googleauth"
|
26
|
+
gem "google-cloud-core"
|
27
|
+
require "google/cloud" unless defined? ::Google::Cloud.new
|
28
|
+
require "google/cloud/config"
|
29
|
+
|
30
|
+
# Set the default configuration
|
31
|
+
::Google::Cloud.configure.add_config! :bigquery_reservation do |config|
|
32
|
+
config.add_field! :endpoint, "bigqueryreservation.googleapis.com", match: ::String
|
33
|
+
config.add_field! :credentials, nil, match: [::String, ::Hash, ::Google::Auth::Credentials]
|
34
|
+
config.add_field! :scope, nil, match: [::Array, ::String]
|
35
|
+
config.add_field! :lib_name, nil, match: ::String
|
36
|
+
config.add_field! :lib_version, nil, match: ::String
|
37
|
+
config.add_field! :interceptors, nil, match: ::Array
|
38
|
+
config.add_field! :timeout, nil, match: ::Numeric
|
39
|
+
config.add_field! :metadata, nil, match: ::Hash
|
40
|
+
config.add_field! :retry_policy, nil, match: [::Hash, ::Proc]
|
41
|
+
config.add_field! :quota_project, nil, match: ::String
|
42
|
+
end
|
43
|
+
|
44
|
+
module Google
|
45
|
+
module Cloud
|
46
|
+
module Bigquery
|
47
|
+
module Reservation
|
48
|
+
##
|
49
|
+
# Create a new client object for ReservationService.
|
50
|
+
#
|
51
|
+
# By default, this returns an instance of
|
52
|
+
# [Google::Cloud::Bigquery::Reservation::V1::ReservationService::Client](https://googleapis.dev/ruby/google-cloud-bigquery-reservation-v1/latest/Google/Cloud/Bigquery/Reservation/V1/ReservationService/Client.html)
|
53
|
+
# for version V1 of the API.
|
54
|
+
# However, you can specify specify a different API version by passing it in the
|
55
|
+
# `version` parameter. If the ReservationService service is
|
56
|
+
# supported by that API version, and the corresponding gem is available, the
|
57
|
+
# appropriate versioned client will be returned.
|
58
|
+
#
|
59
|
+
# ## About ReservationService
|
60
|
+
#
|
61
|
+
# This API allows users to manage their flat-rate BigQuery reservations.
|
62
|
+
#
|
63
|
+
# A reservation provides computational resource guarantees, in the form of
|
64
|
+
# [slots](https://cloud.google.com/bigquery/docs/slots), to users. A slot is a
|
65
|
+
# unit of computational power in BigQuery, and serves as the basic unit of
|
66
|
+
# parallelism. In a scan of a multi-partitioned table, a single slot operates
|
67
|
+
# on a single partition of the table. A reservation resource exists as a child
|
68
|
+
# resource of the admin project and location, e.g.:
|
69
|
+
# `projects/myproject/locations/US/reservations/reservationName`.
|
70
|
+
#
|
71
|
+
# A capacity commitment is a way to purchase compute capacity for BigQuery jobs
|
72
|
+
# (in the form of slots) with some committed period of usage. A capacity
|
73
|
+
# commitment resource exists as a child resource of the admin project and
|
74
|
+
# location, e.g.:
|
75
|
+
# `projects/myproject/locations/US/capacityCommitments/id`.
|
76
|
+
#
|
77
|
+
# @param version [::String, ::Symbol] The API version to connect to. Optional.
|
78
|
+
# Defaults to `:v1`.
|
79
|
+
# @return [ReservationService::Client] A client object for the specified version.
|
80
|
+
#
|
81
|
+
def self.reservation_service version: :v1, &block
|
82
|
+
require "google/cloud/bigquery/reservation/#{version.to_s.downcase}"
|
83
|
+
|
84
|
+
package_name = Google::Cloud::Bigquery::Reservation
|
85
|
+
.constants
|
86
|
+
.select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
|
87
|
+
.first
|
88
|
+
package_module = Google::Cloud::Bigquery::Reservation.const_get package_name
|
89
|
+
package_module.const_get(:ReservationService).const_get(:Client).new(&block)
|
90
|
+
end
|
91
|
+
|
92
|
+
##
|
93
|
+
# Configure the google-cloud-bigquery-reservation library.
|
94
|
+
#
|
95
|
+
# The following configuration parameters are supported:
|
96
|
+
#
|
97
|
+
# * `credentials` (*type:* `String, Hash, Google::Auth::Credentials`) -
|
98
|
+
# The path to the keyfile as a String, the contents of the keyfile as a
|
99
|
+
# Hash, or a Google::Auth::Credentials object.
|
100
|
+
# * `lib_name` (*type:* `String`) -
|
101
|
+
# The library name as recorded in instrumentation and logging.
|
102
|
+
# * `lib_version` (*type:* `String`) -
|
103
|
+
# The library version as recorded in instrumentation and logging.
|
104
|
+
# * `interceptors` (*type:* `Array<GRPC::ClientInterceptor>`) -
|
105
|
+
# An array of interceptors that are run before calls are executed.
|
106
|
+
# * `timeout` (*type:* `Integer`) -
|
107
|
+
# Default timeout in milliseconds.
|
108
|
+
# * `metadata` (*type:* `Hash{Symbol=>String}`) -
|
109
|
+
# Additional gRPC headers to be sent with the call.
|
110
|
+
# * `retry_policy` (*type:* `Hash`) -
|
111
|
+
# The retry policy. The value is a hash with the following keys:
|
112
|
+
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
113
|
+
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
114
|
+
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
115
|
+
# * `:retry_codes` (*type:* `Array<String>`) -
|
116
|
+
# The error codes that should trigger a retry.
|
117
|
+
#
|
118
|
+
# @return [::Google::Cloud::Config] The default configuration used by this library
|
119
|
+
#
|
120
|
+
def self.configure
|
121
|
+
yield ::Google::Cloud.configure.bigquery_reservation if block_given?
|
122
|
+
|
123
|
+
::Google::Cloud.configure.bigquery_reservation
|
124
|
+
end
|
125
|
+
end
|
126
|
+
end
|
127
|
+
end
|
128
|
+
end
|
129
|
+
|
130
|
+
helper_path = ::File.join __dir__, "reservation", "helpers.rb"
|
131
|
+
require "google/cloud/bigquery/reservation/helpers" if ::File.file? helper_path
|
@@ -0,0 +1,28 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Copyright 2020 Google LLC
|
4
|
+
#
|
5
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
6
|
+
# you may not use this file except in compliance with the License.
|
7
|
+
# You may obtain a copy of the License at
|
8
|
+
#
|
9
|
+
# https://www.apache.org/licenses/LICENSE-2.0
|
10
|
+
#
|
11
|
+
# Unless required by applicable law or agreed to in writing, software
|
12
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
13
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
14
|
+
# See the License for the specific language governing permissions and
|
15
|
+
# limitations under the License.
|
16
|
+
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
18
|
+
|
19
|
+
|
20
|
+
module Google
|
21
|
+
module Cloud
|
22
|
+
module Bigquery
|
23
|
+
module Reservation
|
24
|
+
VERSION = "0.1.0"
|
25
|
+
end
|
26
|
+
end
|
27
|
+
end
|
28
|
+
end
|
metadata
ADDED
@@ -0,0 +1,191 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: google-cloud-bigquery-reservation
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Google LLC
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2020-09-24 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: google-cloud-bigquery-reservation-v1
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0.0'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0.0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: google-cloud-core
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '1.5'
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '1.5'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: google-style
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: 1.24.0
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: 1.24.0
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: minitest
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '5.14'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '5.14'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: minitest-focus
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - "~>"
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '1.1'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - "~>"
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '1.1'
|
83
|
+
- !ruby/object:Gem::Dependency
|
84
|
+
name: minitest-rg
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - "~>"
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: '5.2'
|
90
|
+
type: :development
|
91
|
+
prerelease: false
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - "~>"
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: '5.2'
|
97
|
+
- !ruby/object:Gem::Dependency
|
98
|
+
name: rake
|
99
|
+
requirement: !ruby/object:Gem::Requirement
|
100
|
+
requirements:
|
101
|
+
- - ">="
|
102
|
+
- !ruby/object:Gem::Version
|
103
|
+
version: '12.0'
|
104
|
+
type: :development
|
105
|
+
prerelease: false
|
106
|
+
version_requirements: !ruby/object:Gem::Requirement
|
107
|
+
requirements:
|
108
|
+
- - ">="
|
109
|
+
- !ruby/object:Gem::Version
|
110
|
+
version: '12.0'
|
111
|
+
- !ruby/object:Gem::Dependency
|
112
|
+
name: redcarpet
|
113
|
+
requirement: !ruby/object:Gem::Requirement
|
114
|
+
requirements:
|
115
|
+
- - "~>"
|
116
|
+
- !ruby/object:Gem::Version
|
117
|
+
version: '3.0'
|
118
|
+
type: :development
|
119
|
+
prerelease: false
|
120
|
+
version_requirements: !ruby/object:Gem::Requirement
|
121
|
+
requirements:
|
122
|
+
- - "~>"
|
123
|
+
- !ruby/object:Gem::Version
|
124
|
+
version: '3.0'
|
125
|
+
- !ruby/object:Gem::Dependency
|
126
|
+
name: simplecov
|
127
|
+
requirement: !ruby/object:Gem::Requirement
|
128
|
+
requirements:
|
129
|
+
- - "~>"
|
130
|
+
- !ruby/object:Gem::Version
|
131
|
+
version: '0.9'
|
132
|
+
type: :development
|
133
|
+
prerelease: false
|
134
|
+
version_requirements: !ruby/object:Gem::Requirement
|
135
|
+
requirements:
|
136
|
+
- - "~>"
|
137
|
+
- !ruby/object:Gem::Version
|
138
|
+
version: '0.9'
|
139
|
+
- !ruby/object:Gem::Dependency
|
140
|
+
name: yard
|
141
|
+
requirement: !ruby/object:Gem::Requirement
|
142
|
+
requirements:
|
143
|
+
- - "~>"
|
144
|
+
- !ruby/object:Gem::Version
|
145
|
+
version: '0.9'
|
146
|
+
type: :development
|
147
|
+
prerelease: false
|
148
|
+
version_requirements: !ruby/object:Gem::Requirement
|
149
|
+
requirements:
|
150
|
+
- - "~>"
|
151
|
+
- !ruby/object:Gem::Version
|
152
|
+
version: '0.9'
|
153
|
+
description: The BigQuery Reservation API provides the mechanisms by which enterprise
|
154
|
+
users can provision and manage dedicated resources such as slots and BigQuery BI
|
155
|
+
Engine memory allocations.
|
156
|
+
email: googleapis-packages@google.com
|
157
|
+
executables: []
|
158
|
+
extensions: []
|
159
|
+
extra_rdoc_files: []
|
160
|
+
files:
|
161
|
+
- ".yardopts"
|
162
|
+
- AUTHENTICATION.md
|
163
|
+
- LICENSE.md
|
164
|
+
- README.md
|
165
|
+
- lib/google-cloud-bigquery-reservation.rb
|
166
|
+
- lib/google/cloud/bigquery/reservation.rb
|
167
|
+
- lib/google/cloud/bigquery/reservation/version.rb
|
168
|
+
homepage: https://github.com/googleapis/google-cloud-ruby
|
169
|
+
licenses:
|
170
|
+
- Apache-2.0
|
171
|
+
metadata: {}
|
172
|
+
post_install_message:
|
173
|
+
rdoc_options: []
|
174
|
+
require_paths:
|
175
|
+
- lib
|
176
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
177
|
+
requirements:
|
178
|
+
- - ">="
|
179
|
+
- !ruby/object:Gem::Version
|
180
|
+
version: '2.4'
|
181
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
182
|
+
requirements:
|
183
|
+
- - ">="
|
184
|
+
- !ruby/object:Gem::Version
|
185
|
+
version: '0'
|
186
|
+
requirements: []
|
187
|
+
rubygems_version: 3.1.4
|
188
|
+
signing_key:
|
189
|
+
specification_version: 4
|
190
|
+
summary: API Client library for the BigQuery Reservation API
|
191
|
+
test_files: []
|