google-cloud-recommender-v1 0.5.3 → 0.8.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/AUTHENTICATION.md +8 -8
- data/LICENSE.md +188 -190
- data/README.md +67 -3
- data/lib/google/cloud/recommender/v1.rb +3 -0
- data/lib/google/cloud/recommender/v1/recommender/client.rb +28 -30
- data/lib/google/cloud/recommender/v1/recommender/paths.rb +268 -40
- data/lib/google/cloud/recommender/v1/version.rb +1 -1
- data/proto_docs/google/api/field_behavior.rb +12 -0
- data/proto_docs/google/cloud/recommender/v1/recommendation.rb +3 -3
- data/proto_docs/google/cloud/recommender/v1/recommender_service.rb +4 -0
- data/proto_docs/google/protobuf/timestamp.rb +10 -1
- data/proto_docs/google/type/money.rb +1 -1
- metadata +19 -11
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: ec7756e9a0e31fde382f9706da2e18cae67b33c3083354b791f233300ce6d665
|
|
4
|
+
data.tar.gz: 80c72c0fd3338f19c232ca38ea0bc35f56724875e3a2b64bc8c08748ea43cc85
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 0b15073ad1232c4bd29f38729906f24e2d9c20a21560ae022d0ca993ecfe6f46b89770d0122911a93e5e245d9aa66df4281bf2493d70126f87c4581e29d1802c
|
|
7
|
+
data.tar.gz: 13ce52ff348219586b1837d5fbf5ee672f554b48da8524e4d4a670544a281a994bccd7bf2028059f06e910d4aae64f973eaee4662146dfcb99fa88db08d56b22
|
data/AUTHENTICATION.md
CHANGED
|
@@ -66,11 +66,11 @@ The environment variables that google-cloud-recommender-v1
|
|
|
66
66
|
checks for credentials are configured on the service Credentials class (such as
|
|
67
67
|
{::Google::Cloud::Recommender::V1::Recommender::Credentials}):
|
|
68
68
|
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
69
|
+
* `RECOMMENDER_CREDENTIALS` - Path to JSON file, or JSON contents
|
|
70
|
+
* `RECOMMENDER_KEYFILE` - Path to JSON file, or JSON contents
|
|
71
|
+
* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
|
|
72
|
+
* `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
|
|
73
|
+
* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
|
|
74
74
|
|
|
75
75
|
```ruby
|
|
76
76
|
require "google/cloud/recommender/v1"
|
|
@@ -82,8 +82,8 @@ client = ::Google::Cloud::Recommender::V1::Recommender::Client.new
|
|
|
82
82
|
|
|
83
83
|
### Configuration
|
|
84
84
|
|
|
85
|
-
The **Credentials JSON** can be configured instead of
|
|
86
|
-
environment
|
|
85
|
+
The path to the **Credentials JSON** file can be configured instead of storing
|
|
86
|
+
it in an environment variable. Either on an individual client initialization:
|
|
87
87
|
|
|
88
88
|
```ruby
|
|
89
89
|
require "google/cloud/recommender/v1"
|
|
@@ -93,7 +93,7 @@ client = ::Google::Cloud::Recommender::V1::Recommender::Client.new do |config|
|
|
|
93
93
|
end
|
|
94
94
|
```
|
|
95
95
|
|
|
96
|
-
Or
|
|
96
|
+
Or globally for all clients:
|
|
97
97
|
|
|
98
98
|
```ruby
|
|
99
99
|
require "google/cloud/recommender/v1"
|
data/LICENSE.md
CHANGED
|
@@ -1,192 +1,190 @@
|
|
|
1
|
-
Apache License
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
same "printed page" as the copyright notice for easier
|
|
189
|
-
identification within third-party archives.
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
190
188
|
|
|
191
189
|
Copyright [yyyy] [name of copyright owner]
|
|
192
190
|
|
|
@@ -194,7 +192,7 @@ identification within third-party archives.
|
|
|
194
192
|
you may not use this file except in compliance with the License.
|
|
195
193
|
You may obtain a copy of the License at
|
|
196
194
|
|
|
197
|
-
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
198
196
|
|
|
199
197
|
Unless required by applicable law or agreed to in writing, software
|
|
200
198
|
distributed under the License is distributed on an "AS IS" BASIS,
|
data/README.md
CHANGED
|
@@ -6,6 +6,12 @@ Recommender is a service on Google Cloud that provides usage recommendations for
|
|
|
6
6
|
|
|
7
7
|
https://github.com/googleapis/google-cloud-ruby
|
|
8
8
|
|
|
9
|
+
This gem is a _versioned_ client. It provides basic client classes for a
|
|
10
|
+
specific version of the Recommender V1 API. Most users should consider using
|
|
11
|
+
the main client gem,
|
|
12
|
+
[google-cloud-recommender](https://rubygems.org/gems/google-cloud-recommender).
|
|
13
|
+
See the section below titled *Which client should I use?* for more information.
|
|
14
|
+
|
|
9
15
|
## Installation
|
|
10
16
|
|
|
11
17
|
```
|
|
@@ -27,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
|
|
|
27
33
|
require "google/cloud/recommender/v1"
|
|
28
34
|
|
|
29
35
|
client = ::Google::Cloud::Recommender::V1::Recommender::Client.new
|
|
30
|
-
request =
|
|
36
|
+
request = ::Google::Cloud::Recommender::V1::ListInsightsRequest.new # (request fields as keyword arguments...)
|
|
31
37
|
response = client.list_insights request
|
|
32
38
|
```
|
|
33
39
|
|
|
@@ -65,11 +71,69 @@ end
|
|
|
65
71
|
|
|
66
72
|
## Supported Ruby Versions
|
|
67
73
|
|
|
68
|
-
This library is supported on Ruby 2.
|
|
74
|
+
This library is supported on Ruby 2.5+.
|
|
69
75
|
|
|
70
76
|
Google provides official support for Ruby versions that are actively supported
|
|
71
77
|
by Ruby Core—that is, Ruby versions that are either in normal maintenance or
|
|
72
|
-
in security maintenance, and not end of life. Currently, this means Ruby 2.
|
|
78
|
+
in security maintenance, and not end of life. Currently, this means Ruby 2.5
|
|
73
79
|
and later. Older versions of Ruby _may_ still work, but are unsupported and not
|
|
74
80
|
recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
|
|
75
81
|
about the Ruby support schedule.
|
|
82
|
+
|
|
83
|
+
## Which client should I use?
|
|
84
|
+
|
|
85
|
+
Most modern Ruby client libraries for Google APIs come in two flavors: the main
|
|
86
|
+
client library with a name such as `google-cloud-recommender`,
|
|
87
|
+
and lower-level _versioned_ client libraries with names such as
|
|
88
|
+
`google-cloud-recommender-v1`.
|
|
89
|
+
_In most cases, you should install the main client._
|
|
90
|
+
|
|
91
|
+
### What's the difference between the main client and a versioned client?
|
|
92
|
+
|
|
93
|
+
A _versioned client_ provides a basic set of data types and client classes for
|
|
94
|
+
a _single version_ of a specific service. (That is, for a service with multiple
|
|
95
|
+
versions, there might be a separate versioned client for each service version.)
|
|
96
|
+
Most versioned clients are written and maintained by a code generator.
|
|
97
|
+
|
|
98
|
+
The _main client_ is designed to provide you with the _recommended_ client
|
|
99
|
+
interfaces for the service. There will be only one main client for any given
|
|
100
|
+
service, even a service with multiple versions. The main client includes
|
|
101
|
+
factory methods for constructing the client objects we recommend for most
|
|
102
|
+
users. In some cases, those will be classes provided by an underlying versioned
|
|
103
|
+
client; in other cases, they will be handwritten higher-level client objects
|
|
104
|
+
with additional capabilities, convenience methods, or best practices built in.
|
|
105
|
+
Generally, the main client will default to a recommended service version,
|
|
106
|
+
although in some cases you can override this if you need to talk to a specific
|
|
107
|
+
service version.
|
|
108
|
+
|
|
109
|
+
### Why would I want to use the main client?
|
|
110
|
+
|
|
111
|
+
We recommend that most users install the main client gem for a service. You can
|
|
112
|
+
identify this gem as the one _without_ a version in its name, e.g.
|
|
113
|
+
`google-cloud-recommender`.
|
|
114
|
+
The main client is recommended because it will embody the best practices for
|
|
115
|
+
accessing the service, and may also provide more convenient interfaces or
|
|
116
|
+
tighter integration into frameworks and third-party libraries. In addition, the
|
|
117
|
+
documentation and samples published by Google will generally demonstrate use of
|
|
118
|
+
the main client.
|
|
119
|
+
|
|
120
|
+
### Why would I want to use a versioned client?
|
|
121
|
+
|
|
122
|
+
You can use a versioned client if you are content with a possibly lower-level
|
|
123
|
+
class interface, you explicitly want to avoid features provided by the main
|
|
124
|
+
client, or you want to access a specific service version not be covered by the
|
|
125
|
+
main client. You can identify versioned client gems because the service version
|
|
126
|
+
is part of the name, e.g. `google-cloud-recommender-v1`.
|
|
127
|
+
|
|
128
|
+
### What about the google-apis-<name> clients?
|
|
129
|
+
|
|
130
|
+
Client library gems with names that begin with `google-apis-` are based on an
|
|
131
|
+
older code generation technology. They talk to a REST/JSON backend (whereas
|
|
132
|
+
most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
|
|
133
|
+
not offer the same performance, features, and ease of use provided by more
|
|
134
|
+
modern clients.
|
|
135
|
+
|
|
136
|
+
The `google-apis-` clients have wide coverage across Google services, so you
|
|
137
|
+
might need to use one if there is no modern client available for the service.
|
|
138
|
+
However, if a modern client is available, we generally recommend it over the
|
|
139
|
+
older `google-apis-` clients.
|
|
@@ -63,43 +63,31 @@ module Google
|
|
|
63
63
|
parent_config = while namespace.any?
|
|
64
64
|
parent_name = namespace.join "::"
|
|
65
65
|
parent_const = const_get parent_name
|
|
66
|
-
break parent_const.configure if parent_const
|
|
66
|
+
break parent_const.configure if parent_const.respond_to? :configure
|
|
67
67
|
namespace.pop
|
|
68
68
|
end
|
|
69
69
|
default_config = Client::Configuration.new parent_config
|
|
70
70
|
|
|
71
71
|
default_config.rpcs.list_insights.timeout = 60.0
|
|
72
72
|
default_config.rpcs.list_insights.retry_policy = {
|
|
73
|
-
initial_delay: 0.1,
|
|
74
|
-
max_delay: 60.0,
|
|
75
|
-
multiplier: 1.3,
|
|
76
|
-
retry_codes: [4, 14]
|
|
73
|
+
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
|
|
77
74
|
}
|
|
78
75
|
|
|
79
76
|
default_config.rpcs.get_insight.timeout = 60.0
|
|
80
77
|
default_config.rpcs.get_insight.retry_policy = {
|
|
81
|
-
initial_delay: 0.1,
|
|
82
|
-
max_delay: 60.0,
|
|
83
|
-
multiplier: 1.3,
|
|
84
|
-
retry_codes: [4, 14]
|
|
78
|
+
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
|
|
85
79
|
}
|
|
86
80
|
|
|
87
81
|
default_config.rpcs.mark_insight_accepted.timeout = 60.0
|
|
88
82
|
|
|
89
83
|
default_config.rpcs.list_recommendations.timeout = 60.0
|
|
90
84
|
default_config.rpcs.list_recommendations.retry_policy = {
|
|
91
|
-
initial_delay: 0.1,
|
|
92
|
-
max_delay: 60.0,
|
|
93
|
-
multiplier: 1.3,
|
|
94
|
-
retry_codes: [4, 14]
|
|
85
|
+
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
|
|
95
86
|
}
|
|
96
87
|
|
|
97
88
|
default_config.rpcs.get_recommendation.timeout = 60.0
|
|
98
89
|
default_config.rpcs.get_recommendation.retry_policy = {
|
|
99
|
-
initial_delay: 0.1,
|
|
100
|
-
max_delay: 60.0,
|
|
101
|
-
multiplier: 1.3,
|
|
102
|
-
retry_codes: [4, 14]
|
|
90
|
+
initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
|
|
103
91
|
}
|
|
104
92
|
|
|
105
93
|
default_config.rpcs.mark_recommendation_claimed.timeout = 60.0
|
|
@@ -169,8 +157,14 @@ module Google
|
|
|
169
157
|
|
|
170
158
|
# Create credentials
|
|
171
159
|
credentials = @config.credentials
|
|
172
|
-
|
|
173
|
-
if
|
|
160
|
+
# Use self-signed JWT if the scope and endpoint are unchanged from default,
|
|
161
|
+
# but only if the default endpoint does not have a region prefix.
|
|
162
|
+
enable_self_signed_jwt = @config.scope == Client.configure.scope &&
|
|
163
|
+
@config.endpoint == Client.configure.endpoint &&
|
|
164
|
+
!@config.endpoint.split(".").first.include?("-")
|
|
165
|
+
credentials ||= Credentials.default scope: @config.scope,
|
|
166
|
+
enable_self_signed_jwt: enable_self_signed_jwt
|
|
167
|
+
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
|
174
168
|
credentials = Credentials.new credentials, scope: @config.scope
|
|
175
169
|
end
|
|
176
170
|
@quota_project_id = @config.quota_project
|
|
@@ -215,6 +209,8 @@ module Google
|
|
|
215
209
|
#
|
|
216
210
|
# LOCATION here refers to GCP Locations:
|
|
217
211
|
# https://cloud.google.com/about/locations/
|
|
212
|
+
# INSIGHT_TYPE_ID refers to supported insight types:
|
|
213
|
+
# https://cloud.google.com/recommender/docs/insights/insight-types.)
|
|
218
214
|
# @param page_size [::Integer]
|
|
219
215
|
# Optional. The maximum number of results to return from this request. Non-positive
|
|
220
216
|
# values are ignored. If not specified, the server will determine the number
|
|
@@ -446,6 +442,8 @@ module Google
|
|
|
446
442
|
#
|
|
447
443
|
# LOCATION here refers to GCP Locations:
|
|
448
444
|
# https://cloud.google.com/about/locations/
|
|
445
|
+
# RECOMMENDER_ID refers to supported recommenders:
|
|
446
|
+
# https://cloud.google.com/recommender/docs/recommenders.
|
|
449
447
|
# @param page_size [::Integer]
|
|
450
448
|
# Optional. The maximum number of results to return from this request. Non-positive
|
|
451
449
|
# values are ignored. If not specified, the server will determine the number
|
|
@@ -913,7 +911,7 @@ module Google
|
|
|
913
911
|
config_attr :scope, nil, ::String, ::Array, nil
|
|
914
912
|
config_attr :lib_name, nil, ::String, nil
|
|
915
913
|
config_attr :lib_version, nil, ::String, nil
|
|
916
|
-
config_attr(:channel_args, { "grpc.service_config_disable_resolution"=>1 }, ::Hash, nil)
|
|
914
|
+
config_attr(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
|
|
917
915
|
config_attr :interceptors, nil, ::Array, nil
|
|
918
916
|
config_attr :timeout, nil, ::Numeric, nil
|
|
919
917
|
config_attr :metadata, nil, ::Hash, nil
|
|
@@ -934,7 +932,7 @@ module Google
|
|
|
934
932
|
def rpcs
|
|
935
933
|
@rpcs ||= begin
|
|
936
934
|
parent_rpcs = nil
|
|
937
|
-
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config
|
|
935
|
+
parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
|
|
938
936
|
Rpcs.new parent_rpcs
|
|
939
937
|
end
|
|
940
938
|
end
|
|
@@ -946,7 +944,7 @@ module Google
|
|
|
946
944
|
# Each configuration object is of type `Gapic::Config::Method` and includes
|
|
947
945
|
# the following configuration fields:
|
|
948
946
|
#
|
|
949
|
-
# * `timeout` (*type:* `Numeric`) - The call timeout in
|
|
947
|
+
# * `timeout` (*type:* `Numeric`) - The call timeout in seconds
|
|
950
948
|
# * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
|
|
951
949
|
# * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
|
|
952
950
|
# include the following keys:
|
|
@@ -1000,21 +998,21 @@ module Google
|
|
|
1000
998
|
|
|
1001
999
|
# @private
|
|
1002
1000
|
def initialize parent_rpcs = nil
|
|
1003
|
-
list_insights_config = parent_rpcs
|
|
1001
|
+
list_insights_config = parent_rpcs.list_insights if parent_rpcs.respond_to? :list_insights
|
|
1004
1002
|
@list_insights = ::Gapic::Config::Method.new list_insights_config
|
|
1005
|
-
get_insight_config = parent_rpcs
|
|
1003
|
+
get_insight_config = parent_rpcs.get_insight if parent_rpcs.respond_to? :get_insight
|
|
1006
1004
|
@get_insight = ::Gapic::Config::Method.new get_insight_config
|
|
1007
|
-
mark_insight_accepted_config = parent_rpcs
|
|
1005
|
+
mark_insight_accepted_config = parent_rpcs.mark_insight_accepted if parent_rpcs.respond_to? :mark_insight_accepted
|
|
1008
1006
|
@mark_insight_accepted = ::Gapic::Config::Method.new mark_insight_accepted_config
|
|
1009
|
-
list_recommendations_config = parent_rpcs
|
|
1007
|
+
list_recommendations_config = parent_rpcs.list_recommendations if parent_rpcs.respond_to? :list_recommendations
|
|
1010
1008
|
@list_recommendations = ::Gapic::Config::Method.new list_recommendations_config
|
|
1011
|
-
get_recommendation_config = parent_rpcs
|
|
1009
|
+
get_recommendation_config = parent_rpcs.get_recommendation if parent_rpcs.respond_to? :get_recommendation
|
|
1012
1010
|
@get_recommendation = ::Gapic::Config::Method.new get_recommendation_config
|
|
1013
|
-
mark_recommendation_claimed_config = parent_rpcs
|
|
1011
|
+
mark_recommendation_claimed_config = parent_rpcs.mark_recommendation_claimed if parent_rpcs.respond_to? :mark_recommendation_claimed
|
|
1014
1012
|
@mark_recommendation_claimed = ::Gapic::Config::Method.new mark_recommendation_claimed_config
|
|
1015
|
-
mark_recommendation_succeeded_config = parent_rpcs
|
|
1013
|
+
mark_recommendation_succeeded_config = parent_rpcs.mark_recommendation_succeeded if parent_rpcs.respond_to? :mark_recommendation_succeeded
|
|
1016
1014
|
@mark_recommendation_succeeded = ::Gapic::Config::Method.new mark_recommendation_succeeded_config
|
|
1017
|
-
mark_recommendation_failed_config = parent_rpcs
|
|
1015
|
+
mark_recommendation_failed_config = parent_rpcs.mark_recommendation_failed if parent_rpcs.respond_to? :mark_recommendation_failed
|
|
1018
1016
|
@mark_recommendation_failed = ::Gapic::Config::Method.new mark_recommendation_failed_config
|
|
1019
1017
|
|
|
1020
1018
|
yield self if block_given?
|
|
@@ -27,81 +27,309 @@ module Google
|
|
|
27
27
|
##
|
|
28
28
|
# Create a fully-qualified Insight resource string.
|
|
29
29
|
#
|
|
30
|
-
#
|
|
30
|
+
# @overload insight_path(project:, location:, insight_type:, insight:)
|
|
31
|
+
# The resource will be in the following format:
|
|
31
32
|
#
|
|
32
|
-
#
|
|
33
|
+
# `projects/{project}/locations/{location}/insightTypes/{insight_type}/insights/{insight}`
|
|
33
34
|
#
|
|
34
|
-
#
|
|
35
|
-
#
|
|
36
|
-
#
|
|
37
|
-
#
|
|
35
|
+
# @param project [String]
|
|
36
|
+
# @param location [String]
|
|
37
|
+
# @param insight_type [String]
|
|
38
|
+
# @param insight [String]
|
|
39
|
+
#
|
|
40
|
+
# @overload insight_path(billing_account:, location:, insight_type:, insight:)
|
|
41
|
+
# The resource will be in the following format:
|
|
42
|
+
#
|
|
43
|
+
# `billingAccounts/{billing_account}/locations/{location}/insightTypes/{insight_type}/insights/{insight}`
|
|
44
|
+
#
|
|
45
|
+
# @param billing_account [String]
|
|
46
|
+
# @param location [String]
|
|
47
|
+
# @param insight_type [String]
|
|
48
|
+
# @param insight [String]
|
|
49
|
+
#
|
|
50
|
+
# @overload insight_path(folder:, location:, insight_type:, insight:)
|
|
51
|
+
# The resource will be in the following format:
|
|
52
|
+
#
|
|
53
|
+
# `folders/{folder}/locations/{location}/insightTypes/{insight_type}/insights/{insight}`
|
|
54
|
+
#
|
|
55
|
+
# @param folder [String]
|
|
56
|
+
# @param location [String]
|
|
57
|
+
# @param insight_type [String]
|
|
58
|
+
# @param insight [String]
|
|
59
|
+
#
|
|
60
|
+
# @overload insight_path(organization:, location:, insight_type:, insight:)
|
|
61
|
+
# The resource will be in the following format:
|
|
62
|
+
#
|
|
63
|
+
# `organizations/{organization}/locations/{location}/insightTypes/{insight_type}/insights/{insight}`
|
|
64
|
+
#
|
|
65
|
+
# @param organization [String]
|
|
66
|
+
# @param location [String]
|
|
67
|
+
# @param insight_type [String]
|
|
68
|
+
# @param insight [String]
|
|
38
69
|
#
|
|
39
70
|
# @return [::String]
|
|
40
|
-
def insight_path
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
71
|
+
def insight_path **args
|
|
72
|
+
resources = {
|
|
73
|
+
"insight:insight_type:location:project" => (proc do |project:, location:, insight_type:, insight:|
|
|
74
|
+
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
|
75
|
+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
|
76
|
+
raise ::ArgumentError, "insight_type cannot contain /" if insight_type.to_s.include? "/"
|
|
77
|
+
|
|
78
|
+
"projects/#{project}/locations/#{location}/insightTypes/#{insight_type}/insights/#{insight}"
|
|
79
|
+
end),
|
|
80
|
+
"billing_account:insight:insight_type:location" => (proc do |billing_account:, location:, insight_type:, insight:|
|
|
81
|
+
raise ::ArgumentError, "billing_account cannot contain /" if billing_account.to_s.include? "/"
|
|
82
|
+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
|
83
|
+
raise ::ArgumentError, "insight_type cannot contain /" if insight_type.to_s.include? "/"
|
|
84
|
+
|
|
85
|
+
"billingAccounts/#{billing_account}/locations/#{location}/insightTypes/#{insight_type}/insights/#{insight}"
|
|
86
|
+
end),
|
|
87
|
+
"folder:insight:insight_type:location" => (proc do |folder:, location:, insight_type:, insight:|
|
|
88
|
+
raise ::ArgumentError, "folder cannot contain /" if folder.to_s.include? "/"
|
|
89
|
+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
|
90
|
+
raise ::ArgumentError, "insight_type cannot contain /" if insight_type.to_s.include? "/"
|
|
91
|
+
|
|
92
|
+
"folders/#{folder}/locations/#{location}/insightTypes/#{insight_type}/insights/#{insight}"
|
|
93
|
+
end),
|
|
94
|
+
"insight:insight_type:location:organization" => (proc do |organization:, location:, insight_type:, insight:|
|
|
95
|
+
raise ::ArgumentError, "organization cannot contain /" if organization.to_s.include? "/"
|
|
96
|
+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
|
97
|
+
raise ::ArgumentError, "insight_type cannot contain /" if insight_type.to_s.include? "/"
|
|
98
|
+
|
|
99
|
+
"organizations/#{organization}/locations/#{location}/insightTypes/#{insight_type}/insights/#{insight}"
|
|
100
|
+
end)
|
|
101
|
+
}
|
|
44
102
|
|
|
45
|
-
"
|
|
103
|
+
resource = resources[args.keys.sort.join(":")]
|
|
104
|
+
raise ::ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
|
|
105
|
+
resource.call(**args)
|
|
46
106
|
end
|
|
47
107
|
|
|
48
108
|
##
|
|
49
109
|
# Create a fully-qualified InsightType resource string.
|
|
50
110
|
#
|
|
51
|
-
#
|
|
111
|
+
# @overload insight_type_path(project:, location:, insight_type:)
|
|
112
|
+
# The resource will be in the following format:
|
|
52
113
|
#
|
|
53
|
-
#
|
|
114
|
+
# `projects/{project}/locations/{location}/insightTypes/{insight_type}`
|
|
54
115
|
#
|
|
55
|
-
#
|
|
56
|
-
#
|
|
57
|
-
#
|
|
116
|
+
# @param project [String]
|
|
117
|
+
# @param location [String]
|
|
118
|
+
# @param insight_type [String]
|
|
119
|
+
#
|
|
120
|
+
# @overload insight_type_path(billing_account:, location:, insight_type:)
|
|
121
|
+
# The resource will be in the following format:
|
|
122
|
+
#
|
|
123
|
+
# `billingAccounts/{billing_account}/locations/{location}/insightTypes/{insight_type}`
|
|
124
|
+
#
|
|
125
|
+
# @param billing_account [String]
|
|
126
|
+
# @param location [String]
|
|
127
|
+
# @param insight_type [String]
|
|
128
|
+
#
|
|
129
|
+
# @overload insight_type_path(folder:, location:, insight_type:)
|
|
130
|
+
# The resource will be in the following format:
|
|
131
|
+
#
|
|
132
|
+
# `folders/{folder}/locations/{location}/insightTypes/{insight_type}`
|
|
133
|
+
#
|
|
134
|
+
# @param folder [String]
|
|
135
|
+
# @param location [String]
|
|
136
|
+
# @param insight_type [String]
|
|
137
|
+
#
|
|
138
|
+
# @overload insight_type_path(organization:, location:, insight_type:)
|
|
139
|
+
# The resource will be in the following format:
|
|
140
|
+
#
|
|
141
|
+
# `organizations/{organization}/locations/{location}/insightTypes/{insight_type}`
|
|
142
|
+
#
|
|
143
|
+
# @param organization [String]
|
|
144
|
+
# @param location [String]
|
|
145
|
+
# @param insight_type [String]
|
|
58
146
|
#
|
|
59
147
|
# @return [::String]
|
|
60
|
-
def insight_type_path
|
|
61
|
-
|
|
62
|
-
|
|
148
|
+
def insight_type_path **args
|
|
149
|
+
resources = {
|
|
150
|
+
"insight_type:location:project" => (proc do |project:, location:, insight_type:|
|
|
151
|
+
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
|
152
|
+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
|
153
|
+
|
|
154
|
+
"projects/#{project}/locations/#{location}/insightTypes/#{insight_type}"
|
|
155
|
+
end),
|
|
156
|
+
"billing_account:insight_type:location" => (proc do |billing_account:, location:, insight_type:|
|
|
157
|
+
raise ::ArgumentError, "billing_account cannot contain /" if billing_account.to_s.include? "/"
|
|
158
|
+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
|
159
|
+
|
|
160
|
+
"billingAccounts/#{billing_account}/locations/#{location}/insightTypes/#{insight_type}"
|
|
161
|
+
end),
|
|
162
|
+
"folder:insight_type:location" => (proc do |folder:, location:, insight_type:|
|
|
163
|
+
raise ::ArgumentError, "folder cannot contain /" if folder.to_s.include? "/"
|
|
164
|
+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
|
165
|
+
|
|
166
|
+
"folders/#{folder}/locations/#{location}/insightTypes/#{insight_type}"
|
|
167
|
+
end),
|
|
168
|
+
"insight_type:location:organization" => (proc do |organization:, location:, insight_type:|
|
|
169
|
+
raise ::ArgumentError, "organization cannot contain /" if organization.to_s.include? "/"
|
|
170
|
+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
|
171
|
+
|
|
172
|
+
"organizations/#{organization}/locations/#{location}/insightTypes/#{insight_type}"
|
|
173
|
+
end)
|
|
174
|
+
}
|
|
63
175
|
|
|
64
|
-
"
|
|
176
|
+
resource = resources[args.keys.sort.join(":")]
|
|
177
|
+
raise ::ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
|
|
178
|
+
resource.call(**args)
|
|
65
179
|
end
|
|
66
180
|
|
|
67
181
|
##
|
|
68
182
|
# Create a fully-qualified Recommendation resource string.
|
|
69
183
|
#
|
|
70
|
-
#
|
|
184
|
+
# @overload recommendation_path(project:, location:, recommender:, recommendation:)
|
|
185
|
+
# The resource will be in the following format:
|
|
71
186
|
#
|
|
72
|
-
#
|
|
187
|
+
# `projects/{project}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}`
|
|
73
188
|
#
|
|
74
|
-
#
|
|
75
|
-
#
|
|
76
|
-
#
|
|
77
|
-
#
|
|
189
|
+
# @param project [String]
|
|
190
|
+
# @param location [String]
|
|
191
|
+
# @param recommender [String]
|
|
192
|
+
# @param recommendation [String]
|
|
193
|
+
#
|
|
194
|
+
# @overload recommendation_path(billing_account:, location:, recommender:, recommendation:)
|
|
195
|
+
# The resource will be in the following format:
|
|
196
|
+
#
|
|
197
|
+
# `billingAccounts/{billing_account}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}`
|
|
198
|
+
#
|
|
199
|
+
# @param billing_account [String]
|
|
200
|
+
# @param location [String]
|
|
201
|
+
# @param recommender [String]
|
|
202
|
+
# @param recommendation [String]
|
|
203
|
+
#
|
|
204
|
+
# @overload recommendation_path(folder:, location:, recommender:, recommendation:)
|
|
205
|
+
# The resource will be in the following format:
|
|
206
|
+
#
|
|
207
|
+
# `folders/{folder}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}`
|
|
208
|
+
#
|
|
209
|
+
# @param folder [String]
|
|
210
|
+
# @param location [String]
|
|
211
|
+
# @param recommender [String]
|
|
212
|
+
# @param recommendation [String]
|
|
213
|
+
#
|
|
214
|
+
# @overload recommendation_path(organization:, location:, recommender:, recommendation:)
|
|
215
|
+
# The resource will be in the following format:
|
|
216
|
+
#
|
|
217
|
+
# `organizations/{organization}/locations/{location}/recommenders/{recommender}/recommendations/{recommendation}`
|
|
218
|
+
#
|
|
219
|
+
# @param organization [String]
|
|
220
|
+
# @param location [String]
|
|
221
|
+
# @param recommender [String]
|
|
222
|
+
# @param recommendation [String]
|
|
78
223
|
#
|
|
79
224
|
# @return [::String]
|
|
80
|
-
def recommendation_path
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
225
|
+
def recommendation_path **args
|
|
226
|
+
resources = {
|
|
227
|
+
"location:project:recommendation:recommender" => (proc do |project:, location:, recommender:, recommendation:|
|
|
228
|
+
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
|
229
|
+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
|
230
|
+
raise ::ArgumentError, "recommender cannot contain /" if recommender.to_s.include? "/"
|
|
231
|
+
|
|
232
|
+
"projects/#{project}/locations/#{location}/recommenders/#{recommender}/recommendations/#{recommendation}"
|
|
233
|
+
end),
|
|
234
|
+
"billing_account:location:recommendation:recommender" => (proc do |billing_account:, location:, recommender:, recommendation:|
|
|
235
|
+
raise ::ArgumentError, "billing_account cannot contain /" if billing_account.to_s.include? "/"
|
|
236
|
+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
|
237
|
+
raise ::ArgumentError, "recommender cannot contain /" if recommender.to_s.include? "/"
|
|
238
|
+
|
|
239
|
+
"billingAccounts/#{billing_account}/locations/#{location}/recommenders/#{recommender}/recommendations/#{recommendation}"
|
|
240
|
+
end),
|
|
241
|
+
"folder:location:recommendation:recommender" => (proc do |folder:, location:, recommender:, recommendation:|
|
|
242
|
+
raise ::ArgumentError, "folder cannot contain /" if folder.to_s.include? "/"
|
|
243
|
+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
|
244
|
+
raise ::ArgumentError, "recommender cannot contain /" if recommender.to_s.include? "/"
|
|
245
|
+
|
|
246
|
+
"folders/#{folder}/locations/#{location}/recommenders/#{recommender}/recommendations/#{recommendation}"
|
|
247
|
+
end),
|
|
248
|
+
"location:organization:recommendation:recommender" => (proc do |organization:, location:, recommender:, recommendation:|
|
|
249
|
+
raise ::ArgumentError, "organization cannot contain /" if organization.to_s.include? "/"
|
|
250
|
+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
|
251
|
+
raise ::ArgumentError, "recommender cannot contain /" if recommender.to_s.include? "/"
|
|
252
|
+
|
|
253
|
+
"organizations/#{organization}/locations/#{location}/recommenders/#{recommender}/recommendations/#{recommendation}"
|
|
254
|
+
end)
|
|
255
|
+
}
|
|
84
256
|
|
|
85
|
-
"
|
|
257
|
+
resource = resources[args.keys.sort.join(":")]
|
|
258
|
+
raise ::ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
|
|
259
|
+
resource.call(**args)
|
|
86
260
|
end
|
|
87
261
|
|
|
88
262
|
##
|
|
89
263
|
# Create a fully-qualified Recommender resource string.
|
|
90
264
|
#
|
|
91
|
-
#
|
|
265
|
+
# @overload recommender_path(project:, location:, recommender:)
|
|
266
|
+
# The resource will be in the following format:
|
|
92
267
|
#
|
|
93
|
-
#
|
|
268
|
+
# `projects/{project}/locations/{location}/recommenders/{recommender}`
|
|
94
269
|
#
|
|
95
|
-
#
|
|
96
|
-
#
|
|
97
|
-
#
|
|
270
|
+
# @param project [String]
|
|
271
|
+
# @param location [String]
|
|
272
|
+
# @param recommender [String]
|
|
273
|
+
#
|
|
274
|
+
# @overload recommender_path(billing_account:, location:, recommender:)
|
|
275
|
+
# The resource will be in the following format:
|
|
276
|
+
#
|
|
277
|
+
# `billingAccounts/{billing_account}/locations/{location}/recommenders/{recommender}`
|
|
278
|
+
#
|
|
279
|
+
# @param billing_account [String]
|
|
280
|
+
# @param location [String]
|
|
281
|
+
# @param recommender [String]
|
|
282
|
+
#
|
|
283
|
+
# @overload recommender_path(folder:, location:, recommender:)
|
|
284
|
+
# The resource will be in the following format:
|
|
285
|
+
#
|
|
286
|
+
# `folders/{folder}/locations/{location}/recommenders/{recommender}`
|
|
287
|
+
#
|
|
288
|
+
# @param folder [String]
|
|
289
|
+
# @param location [String]
|
|
290
|
+
# @param recommender [String]
|
|
291
|
+
#
|
|
292
|
+
# @overload recommender_path(organization:, location:, recommender:)
|
|
293
|
+
# The resource will be in the following format:
|
|
294
|
+
#
|
|
295
|
+
# `organizations/{organization}/locations/{location}/recommenders/{recommender}`
|
|
296
|
+
#
|
|
297
|
+
# @param organization [String]
|
|
298
|
+
# @param location [String]
|
|
299
|
+
# @param recommender [String]
|
|
98
300
|
#
|
|
99
301
|
# @return [::String]
|
|
100
|
-
def recommender_path
|
|
101
|
-
|
|
102
|
-
|
|
302
|
+
def recommender_path **args
|
|
303
|
+
resources = {
|
|
304
|
+
"location:project:recommender" => (proc do |project:, location:, recommender:|
|
|
305
|
+
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
|
306
|
+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
|
307
|
+
|
|
308
|
+
"projects/#{project}/locations/#{location}/recommenders/#{recommender}"
|
|
309
|
+
end),
|
|
310
|
+
"billing_account:location:recommender" => (proc do |billing_account:, location:, recommender:|
|
|
311
|
+
raise ::ArgumentError, "billing_account cannot contain /" if billing_account.to_s.include? "/"
|
|
312
|
+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
|
313
|
+
|
|
314
|
+
"billingAccounts/#{billing_account}/locations/#{location}/recommenders/#{recommender}"
|
|
315
|
+
end),
|
|
316
|
+
"folder:location:recommender" => (proc do |folder:, location:, recommender:|
|
|
317
|
+
raise ::ArgumentError, "folder cannot contain /" if folder.to_s.include? "/"
|
|
318
|
+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
|
319
|
+
|
|
320
|
+
"folders/#{folder}/locations/#{location}/recommenders/#{recommender}"
|
|
321
|
+
end),
|
|
322
|
+
"location:organization:recommender" => (proc do |organization:, location:, recommender:|
|
|
323
|
+
raise ::ArgumentError, "organization cannot contain /" if organization.to_s.include? "/"
|
|
324
|
+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
|
325
|
+
|
|
326
|
+
"organizations/#{organization}/locations/#{location}/recommenders/#{recommender}"
|
|
327
|
+
end)
|
|
328
|
+
}
|
|
103
329
|
|
|
104
|
-
"
|
|
330
|
+
resource = resources[args.keys.sort.join(":")]
|
|
331
|
+
raise ::ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
|
|
332
|
+
resource.call(**args)
|
|
105
333
|
end
|
|
106
334
|
|
|
107
335
|
extend self
|
|
@@ -54,6 +54,18 @@ module Google
|
|
|
54
54
|
# This indicates that the field may be set once in a request to create a
|
|
55
55
|
# resource, but may not be changed thereafter.
|
|
56
56
|
IMMUTABLE = 5
|
|
57
|
+
|
|
58
|
+
# Denotes that a (repeated) field is an unordered list.
|
|
59
|
+
# This indicates that the service may provide the elements of the list
|
|
60
|
+
# in any arbitrary order, rather than the order the user originally
|
|
61
|
+
# provided. Additionally, the list's order may or may not be stable.
|
|
62
|
+
UNORDERED_LIST = 6
|
|
63
|
+
|
|
64
|
+
# Denotes that this field returns a non-empty default value if not set.
|
|
65
|
+
# This indicates that if the user provides the empty value in a request,
|
|
66
|
+
# a non-empty value will be returned. The user will not be aware of what
|
|
67
|
+
# non-empty value to expect.
|
|
68
|
+
NON_EMPTY_DEFAULT = 7
|
|
57
69
|
end
|
|
58
70
|
end
|
|
59
71
|
end
|
|
@@ -163,12 +163,12 @@ module Google
|
|
|
163
163
|
# "/versions/*/targetSize/percent": 20
|
|
164
164
|
# }
|
|
165
165
|
# * Example: {
|
|
166
|
-
# "/bindings/*/role": "roles/
|
|
166
|
+
# "/bindings/*/role": "roles/owner"
|
|
167
167
|
# "/bindings/*/condition" : null
|
|
168
168
|
# }
|
|
169
169
|
# * Example: {
|
|
170
|
-
# "/bindings/*/role": "roles/
|
|
171
|
-
# "/bindings/*/members/*" : ["x@
|
|
170
|
+
# "/bindings/*/role": "roles/owner"
|
|
171
|
+
# "/bindings/*/members/*" : ["x@example.com", "y@example.com"]
|
|
172
172
|
# }
|
|
173
173
|
# When both path_filters and path_value_matchers are set, an implicit AND
|
|
174
174
|
# must be performed.
|
|
@@ -32,6 +32,8 @@ module Google
|
|
|
32
32
|
#
|
|
33
33
|
# LOCATION here refers to GCP Locations:
|
|
34
34
|
# https://cloud.google.com/about/locations/
|
|
35
|
+
# INSIGHT_TYPE_ID refers to supported insight types:
|
|
36
|
+
# https://cloud.google.com/recommender/docs/insights/insight-types.)
|
|
35
37
|
# @!attribute [rw] page_size
|
|
36
38
|
# @return [::Integer]
|
|
37
39
|
# Optional. The maximum number of results to return from this request. Non-positive
|
|
@@ -111,6 +113,8 @@ module Google
|
|
|
111
113
|
#
|
|
112
114
|
# LOCATION here refers to GCP Locations:
|
|
113
115
|
# https://cloud.google.com/about/locations/
|
|
116
|
+
# RECOMMENDER_ID refers to supported recommenders:
|
|
117
|
+
# https://cloud.google.com/recommender/docs/recommenders.
|
|
114
118
|
# @!attribute [rw] page_size
|
|
115
119
|
# @return [::Integer]
|
|
116
120
|
# Optional. The maximum number of results to return from this request. Non-positive
|
|
@@ -70,7 +70,16 @@ module Google
|
|
|
70
70
|
# .setNanos((int) ((millis % 1000) * 1000000)).build();
|
|
71
71
|
#
|
|
72
72
|
#
|
|
73
|
-
# Example 5: Compute Timestamp from
|
|
73
|
+
# Example 5: Compute Timestamp from Java `Instant.now()`.
|
|
74
|
+
#
|
|
75
|
+
# Instant now = Instant.now();
|
|
76
|
+
#
|
|
77
|
+
# Timestamp timestamp =
|
|
78
|
+
# Timestamp.newBuilder().setSeconds(now.getEpochSecond())
|
|
79
|
+
# .setNanos(now.getNano()).build();
|
|
80
|
+
#
|
|
81
|
+
#
|
|
82
|
+
# Example 6: Compute Timestamp from current time in Python.
|
|
74
83
|
#
|
|
75
84
|
# timestamp = Timestamp()
|
|
76
85
|
# timestamp.GetCurrentTime()
|
|
@@ -22,7 +22,7 @@ module Google
|
|
|
22
22
|
# Represents an amount of money with its currency type.
|
|
23
23
|
# @!attribute [rw] currency_code
|
|
24
24
|
# @return [::String]
|
|
25
|
-
# The
|
|
25
|
+
# The three-letter currency code defined in ISO 4217.
|
|
26
26
|
# @!attribute [rw] units
|
|
27
27
|
# @return [::Integer]
|
|
28
28
|
# The whole units of the amount.
|
metadata
CHANGED
|
@@ -1,29 +1,35 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-cloud-recommender-v1
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.8.2
|
|
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: 2021-07-12 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: gapic-common
|
|
15
15
|
requirement: !ruby/object:Gem::Requirement
|
|
16
16
|
requirements:
|
|
17
|
-
- - "
|
|
17
|
+
- - ">="
|
|
18
|
+
- !ruby/object:Gem::Version
|
|
19
|
+
version: '0.5'
|
|
20
|
+
- - "<"
|
|
18
21
|
- !ruby/object:Gem::Version
|
|
19
|
-
version:
|
|
22
|
+
version: 2.a
|
|
20
23
|
type: :runtime
|
|
21
24
|
prerelease: false
|
|
22
25
|
version_requirements: !ruby/object:Gem::Requirement
|
|
23
26
|
requirements:
|
|
24
|
-
- - "
|
|
27
|
+
- - ">="
|
|
28
|
+
- !ruby/object:Gem::Version
|
|
29
|
+
version: '0.5'
|
|
30
|
+
- - "<"
|
|
25
31
|
- !ruby/object:Gem::Version
|
|
26
|
-
version:
|
|
32
|
+
version: 2.a
|
|
27
33
|
- !ruby/object:Gem::Dependency
|
|
28
34
|
name: google-cloud-errors
|
|
29
35
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -44,14 +50,14 @@ dependencies:
|
|
|
44
50
|
requirements:
|
|
45
51
|
- - "~>"
|
|
46
52
|
- !ruby/object:Gem::Version
|
|
47
|
-
version: 1.
|
|
53
|
+
version: 1.25.1
|
|
48
54
|
type: :development
|
|
49
55
|
prerelease: false
|
|
50
56
|
version_requirements: !ruby/object:Gem::Requirement
|
|
51
57
|
requirements:
|
|
52
58
|
- - "~>"
|
|
53
59
|
- !ruby/object:Gem::Version
|
|
54
|
-
version: 1.
|
|
60
|
+
version: 1.25.1
|
|
55
61
|
- !ruby/object:Gem::Dependency
|
|
56
62
|
name: minitest
|
|
57
63
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -151,7 +157,9 @@ dependencies:
|
|
|
151
157
|
- !ruby/object:Gem::Version
|
|
152
158
|
version: '0.9'
|
|
153
159
|
description: Recommender is a service on Google Cloud that provides usage recommendations
|
|
154
|
-
for Cloud products and services.
|
|
160
|
+
for Cloud products and services. Note that google-cloud-recommender-v1 is a version-specific
|
|
161
|
+
client library. For most uses, we recommend installing the main client library google-cloud-recommender
|
|
162
|
+
instead. See the readme for more details.
|
|
155
163
|
email: googleapis-packages@google.com
|
|
156
164
|
executables: []
|
|
157
165
|
extensions: []
|
|
@@ -194,14 +202,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
|
194
202
|
requirements:
|
|
195
203
|
- - ">="
|
|
196
204
|
- !ruby/object:Gem::Version
|
|
197
|
-
version: '2.
|
|
205
|
+
version: '2.5'
|
|
198
206
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
199
207
|
requirements:
|
|
200
208
|
- - ">="
|
|
201
209
|
- !ruby/object:Gem::Version
|
|
202
210
|
version: '0'
|
|
203
211
|
requirements: []
|
|
204
|
-
rubygems_version: 3.
|
|
212
|
+
rubygems_version: 3.2.17
|
|
205
213
|
signing_key:
|
|
206
214
|
specification_version: 4
|
|
207
215
|
summary: API Client library for the Recommender V1 API
|