google-cloud-recommender 0.1.1 → 0.1.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.yardopts +1 -1
- data/AUTHENTICATION.md +29 -29
- data/LICENSE.md +203 -0
- data/README.md +26 -24
- data/lib/google-cloud-recommender.rb +5 -5
- data/lib/google/cloud/recommender.rb +43 -17
- data/lib/google/cloud/recommender/version.rb +1 -1
- metadata +8 -8
- data/LICENSE +0 -201
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: ecd7582ba37b4e477c3d3b652167de95a4ee1e0db39720b95cf4784dee1dc6c3
|
|
4
|
+
data.tar.gz: 18754cd08ca4d156ca44090dba06c4bca439c6c1c588d6d361a47586a07ecff3
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: c1774aeb0b374274cb04d8ac269952885e06eb0be13d871611faa9657c5521672c4e9db98e49a3acffd851c5eb04804509400be9343df3718531a7c1422d65c0
|
|
7
|
+
data.tar.gz: 7df2bb17bfb3cbc4a6fa25c6ba6e16113377a41eded3ba891ae86d58a5f5873129ca517b77c93efba3e0e90cf54275509bf305eba1194889790489a8921945a3
|
data/.yardopts
CHANGED
data/AUTHENTICATION.md
CHANGED
|
@@ -1,16 +1,17 @@
|
|
|
1
1
|
# Authentication
|
|
2
2
|
|
|
3
|
-
In general, the google-cloud-recommender library uses
|
|
4
|
-
Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
|
|
5
|
-
credentials to connect to Google Cloud services. When running within
|
|
6
|
-
Cloud Platform environments](#google-cloud-platform-environments)
|
|
7
|
-
|
|
3
|
+
In general, the google-cloud-recommender 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
8
|
environments, the Service Account credentials can be specified by providing the
|
|
9
|
-
path to the
|
|
10
|
-
keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys)
|
|
11
|
-
the account (or the JSON itself) in
|
|
12
|
-
variables](#environment-variables). Additionally, Cloud SDK
|
|
13
|
-
be discovered automatically, but this is only recommended
|
|
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.
|
|
14
15
|
|
|
15
16
|
## Quickstart
|
|
16
17
|
|
|
@@ -33,8 +34,7 @@ client = Google::Cloud::Recommender.recommender_service
|
|
|
33
34
|
|
|
34
35
|
The google-cloud-recommender library aims to make authentication
|
|
35
36
|
as simple as possible, and provides several mechanisms to configure your system
|
|
36
|
-
without
|
|
37
|
-
code.
|
|
37
|
+
without requiring **Service Account Credentials** directly in code.
|
|
38
38
|
|
|
39
39
|
**Credentials** are discovered in the following order:
|
|
40
40
|
|
|
@@ -47,24 +47,24 @@ code.
|
|
|
47
47
|
|
|
48
48
|
### Google Cloud Platform environments
|
|
49
49
|
|
|
50
|
-
When running on Google Cloud Platform (GCP), including Google Compute Engine
|
|
51
|
-
Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud
|
|
52
|
-
(GCF) and Cloud Run,
|
|
53
|
-
|
|
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
54
|
|
|
55
55
|
### Environment Variables
|
|
56
56
|
|
|
57
|
-
The **Credentials JSON** can be placed in environment
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
encouraged.
|
|
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.
|
|
65
64
|
|
|
66
|
-
The environment variables that google-cloud-recommender
|
|
67
|
-
are configured on
|
|
65
|
+
The environment variables that google-cloud-recommender
|
|
66
|
+
checks for credentials are configured on the service Credentials class (such as
|
|
67
|
+
`Google::Cloud::Recommender::V1::Recommender::Credentials`):
|
|
68
68
|
|
|
69
69
|
1. `RECOMMENDER_CREDENTIALS` - Path to JSON file, or JSON contents
|
|
70
70
|
2. `RECOMMENDER_KEYFILE` - Path to JSON file, or JSON contents
|
|
@@ -135,9 +135,9 @@ Google Cloud requires **Service Account Credentials** to
|
|
|
135
135
|
connect to the APIs. You will use the **JSON key file** to
|
|
136
136
|
connect to most services with google-cloud-recommender.
|
|
137
137
|
|
|
138
|
-
If you are not running this client within
|
|
139
|
-
environments](#google-cloud-platform-environments), you
|
|
140
|
-
Developers service account.
|
|
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
141
|
|
|
142
142
|
1. Visit the [Google Developers Console][dev-console].
|
|
143
143
|
2. Create a new project or click on an existing project.
|
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
CHANGED
|
@@ -1,40 +1,42 @@
|
|
|
1
|
-
# Ruby Client for
|
|
1
|
+
# Ruby Client for the Recommender API
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
Deliver highly personalized product recommendations at scale.
|
|
5
|
-
- [Client Library Documentation][]
|
|
6
|
-
- [Product Documentation][]
|
|
3
|
+
API Client library for the Recommender API
|
|
7
4
|
|
|
8
|
-
|
|
9
|
-
In order to use this library, you first need to go through the following
|
|
10
|
-
steps:
|
|
5
|
+
Recommender is a service on Google Cloud that provides usage recommendations for Cloud products and services.
|
|
11
6
|
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
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-recommender-v*`.
|
|
9
|
+
The gem `google-cloud-recommender` 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-recommender/latest)
|
|
14
|
+
for this library, google-cloud-recommender, 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-recommender-v1](https://googleapis.dev/ruby/google-cloud-recommender-v1/latest).
|
|
19
|
+
|
|
20
|
+
See also the [Product Documentation](https://cloud.google.com/recommender)
|
|
21
|
+
for more usage information.
|
|
22
|
+
|
|
23
|
+
## Quick Start
|
|
16
24
|
|
|
17
|
-
### Installation
|
|
18
25
|
```
|
|
19
26
|
$ gem install google-cloud-recommender
|
|
20
27
|
```
|
|
21
28
|
|
|
22
|
-
|
|
23
|
-
- Read the [Client Library Documentation][] for the Recommender API, and the underlying
|
|
24
|
-
[V1 Client Documentation][] to see other available methods on the client.
|
|
25
|
-
- Read the [Recommender API Product documentation][Product Documentation]
|
|
26
|
-
to learn more about the product and see How-to Guides.
|
|
27
|
-
- View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
|
|
28
|
-
to see the full list of Cloud APIs that we cover.
|
|
29
|
+
In order to use this library, you first need to go through the following steps:
|
|
29
30
|
|
|
30
|
-
[
|
|
31
|
-
[
|
|
32
|
-
[
|
|
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/recommender.googleapis.com)
|
|
34
|
+
1. {file:AUTHENTICATION.md Set up authentication.}
|
|
33
35
|
|
|
34
36
|
## Enabling Logging
|
|
35
37
|
|
|
36
38
|
To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
|
|
37
|
-
The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib
|
|
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,
|
|
38
40
|
or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
|
|
39
41
|
that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
|
|
40
42
|
and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
1
3
|
# Copyright 2020 Google LLC
|
|
2
4
|
#
|
|
3
5
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
@@ -12,11 +14,7 @@
|
|
|
12
14
|
# See the License for the specific language governing permissions and
|
|
13
15
|
# limitations under the License.
|
|
14
16
|
|
|
15
|
-
|
|
16
|
-
##
|
|
17
|
-
# This file is here to be autorequired by bundler, but the library and all
|
|
18
|
-
# dependencies won't be loaded until required and used.
|
|
19
|
-
|
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
|
20
18
|
|
|
21
19
|
gem "google-cloud-core"
|
|
22
20
|
require "google/cloud" unless defined? Google::Cloud.new
|
|
@@ -33,3 +31,5 @@ Google::Cloud.configure.add_config! :recommender do |config|
|
|
|
33
31
|
config.add_field! :metadata, nil, match: Hash
|
|
34
32
|
config.add_field! :retry_policy, nil, match: [Hash, Proc]
|
|
35
33
|
end
|
|
34
|
+
|
|
35
|
+
require "google/cloud/recommender/version"
|
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
1
3
|
# Copyright 2020 Google LLC
|
|
2
4
|
#
|
|
3
5
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
@@ -12,21 +14,33 @@
|
|
|
12
14
|
# See the License for the specific language governing permissions and
|
|
13
15
|
# limitations under the License.
|
|
14
16
|
|
|
17
|
+
# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
|
|
15
18
|
|
|
16
19
|
require "google-cloud-recommender"
|
|
17
20
|
|
|
18
21
|
module Google
|
|
19
22
|
module Cloud
|
|
20
|
-
##
|
|
21
|
-
# Deliver highly personalized product recommendations at scale.
|
|
22
23
|
module Recommender
|
|
23
24
|
##
|
|
24
|
-
# Create a new
|
|
25
|
+
# Create a new client object for Recommender.
|
|
26
|
+
#
|
|
27
|
+
# By default, this returns an instance of
|
|
28
|
+
# [Google::Cloud::Recommender::V1::Recommender::Client](https://googleapis.dev/ruby/google-cloud-recommender-v1/latest/Google/Cloud/Recommender/V1/Recommender/Client.html)
|
|
29
|
+
# for version V1 of the API.
|
|
30
|
+
# However, you can specify specify a different API version by passing it in the
|
|
31
|
+
# `version` parameter. If the Recommender service is
|
|
32
|
+
# supported by that API version, and the corresponding gem is available, the
|
|
33
|
+
# appropriate versioned client will be returned.
|
|
34
|
+
#
|
|
35
|
+
# ## About Recommender
|
|
25
36
|
#
|
|
26
|
-
#
|
|
27
|
-
#
|
|
28
|
-
#
|
|
37
|
+
# Provides recommendations for cloud customers for various categories like
|
|
38
|
+
# performance optimization, cost savings, reliability, feature discovery, etc.
|
|
39
|
+
# These recommendations are generated automatically based on analysis of user
|
|
40
|
+
# resources, configuration and monitoring metrics.
|
|
29
41
|
#
|
|
42
|
+
# @param version [String, Symbol] The API version to connect to. Optional.
|
|
43
|
+
# Defaults to `:v1`.
|
|
30
44
|
# @return [Recommender::Client] A client object for the specified version.
|
|
31
45
|
#
|
|
32
46
|
def self.recommender_service version: :v1, &block
|
|
@@ -41,20 +55,32 @@ module Google
|
|
|
41
55
|
end
|
|
42
56
|
|
|
43
57
|
##
|
|
44
|
-
# Configure the recommender library.
|
|
58
|
+
# Configure the google-cloud-recommender library.
|
|
45
59
|
#
|
|
46
|
-
# The following
|
|
60
|
+
# The following configuration parameters are supported:
|
|
47
61
|
#
|
|
48
|
-
# * `credentials`
|
|
49
|
-
# the keyfile as a
|
|
50
|
-
#
|
|
51
|
-
# * `
|
|
52
|
-
#
|
|
53
|
-
# * `
|
|
54
|
-
#
|
|
55
|
-
# * `
|
|
62
|
+
# * `credentials` (*type:* `String, Hash, Google::Auth::Credentials`) -
|
|
63
|
+
# The path to the keyfile as a String, the contents of the keyfile as a
|
|
64
|
+
# Hash, or a Google::Auth::Credentials object.
|
|
65
|
+
# * `lib_name` (*type:* `String`) -
|
|
66
|
+
# The library name as recorded in instrumentation and logging.
|
|
67
|
+
# * `lib_version` (*type:* `String`) -
|
|
68
|
+
# The library version as recorded in instrumentation and logging.
|
|
69
|
+
# * `interceptors` (*type:* `Array<GRPC::ClientInterceptor>`) -
|
|
70
|
+
# An array of interceptors that are run before calls are executed.
|
|
71
|
+
# * `timeout` (*type:* `Integer`) -
|
|
72
|
+
# Default timeout in milliseconds.
|
|
73
|
+
# * `metadata` (*type:* `Hash{Symbol=>String}`) -
|
|
74
|
+
# Additional gRPC headers to be sent with the call.
|
|
75
|
+
# * `retry_policy` (*type:* `Hash`) -
|
|
76
|
+
# The retry policy. The value is a hash with the following keys:
|
|
77
|
+
# * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
|
|
78
|
+
# * `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
|
|
79
|
+
# * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
|
|
80
|
+
# * `:retry_codes` (*type:* `Array<String>`) -
|
|
81
|
+
# The error codes that should trigger a retry.
|
|
56
82
|
#
|
|
57
|
-
# @return [Google::Cloud::Config] The configuration
|
|
83
|
+
# @return [Google::Cloud::Config] The default configuration used by this library
|
|
58
84
|
#
|
|
59
85
|
def self.configure
|
|
60
86
|
yield Google::Cloud.configure.recommender if block_given?
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: google-cloud-recommender
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.1.
|
|
4
|
+
version: 0.1.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: 2020-03-
|
|
11
|
+
date: 2020-03-25 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: google-cloud-core
|
|
@@ -30,14 +30,14 @@ dependencies:
|
|
|
30
30
|
requirements:
|
|
31
31
|
- - "~>"
|
|
32
32
|
- !ruby/object:Gem::Version
|
|
33
|
-
version: '0.
|
|
33
|
+
version: '0.1'
|
|
34
34
|
type: :runtime
|
|
35
35
|
prerelease: false
|
|
36
36
|
version_requirements: !ruby/object:Gem::Requirement
|
|
37
37
|
requirements:
|
|
38
38
|
- - "~>"
|
|
39
39
|
- !ruby/object:Gem::Version
|
|
40
|
-
version: '0.
|
|
40
|
+
version: '0.1'
|
|
41
41
|
- !ruby/object:Gem::Dependency
|
|
42
42
|
name: autotest-suffix
|
|
43
43
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -164,8 +164,8 @@ dependencies:
|
|
|
164
164
|
- - "~>"
|
|
165
165
|
- !ruby/object:Gem::Version
|
|
166
166
|
version: '0.9'
|
|
167
|
-
description:
|
|
168
|
-
|
|
167
|
+
description: Recommender is a service on Google Cloud that provides usage recommendations
|
|
168
|
+
for Cloud products and services.
|
|
169
169
|
email: googleapis-packages@google.com
|
|
170
170
|
executables: []
|
|
171
171
|
extensions: []
|
|
@@ -173,12 +173,12 @@ extra_rdoc_files: []
|
|
|
173
173
|
files:
|
|
174
174
|
- ".yardopts"
|
|
175
175
|
- AUTHENTICATION.md
|
|
176
|
-
- LICENSE
|
|
176
|
+
- LICENSE.md
|
|
177
177
|
- README.md
|
|
178
178
|
- lib/google-cloud-recommender.rb
|
|
179
179
|
- lib/google/cloud/recommender.rb
|
|
180
180
|
- lib/google/cloud/recommender/version.rb
|
|
181
|
-
homepage: https://github.com/googleapis/google-cloud-ruby
|
|
181
|
+
homepage: https://github.com/googleapis/google-cloud-ruby
|
|
182
182
|
licenses:
|
|
183
183
|
- Apache-2.0
|
|
184
184
|
metadata: {}
|
data/LICENSE
DELETED
|
@@ -1,201 +0,0 @@
|
|
|
1
|
-
Apache License
|
|
2
|
-
Version 2.0, January 2004
|
|
3
|
-
https://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.
|
|
188
|
-
|
|
189
|
-
Copyright [yyyy] [name of copyright owner]
|
|
190
|
-
|
|
191
|
-
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
-
you may not use this file except in compliance with the License.
|
|
193
|
-
You may obtain a copy of the License at
|
|
194
|
-
|
|
195
|
-
https://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
-
|
|
197
|
-
Unless required by applicable law or agreed to in writing, software
|
|
198
|
-
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
-
See the License for the specific language governing permissions and
|
|
201
|
-
limitations under the License.
|