Skip to content

Commit 322236f

Browse files
feat: Support utilization insights and cloud hub
docs: Add identifier annotation for field name PiperOrigin-RevId: 922901240 Source-Link: googleapis/googleapis@1676bd0 Source-Link: googleapis/googleapis-gen@422deb2 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLXJlY29tbWVuZGVyLy5Pd2xCb3QueWFtbCIsImgiOiI0MjJkZWIyZDMyYzBiZDE3NTdkNWU2MThhNTJjNjY4NzY5NTk3NTBmIn0=
1 parent 4a075eb commit 322236f

68 files changed

Lines changed: 89337 additions & 0 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Copyright 2025 Google LLC
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
deep-copy-regex:
16+
- source: /google/cloud/recommender/google-cloud-recommender-nodejs
17+
dest: /owl-bot-staging/google-cloud-recommender
18+
19+
api-name: recommender
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
**/node_modules
2+
**/.coverage
3+
build/
4+
docs/
5+
protos/
6+
system-test/
7+
samples/generated/
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"extends": "./node_modules/gts",
3+
"root": true
4+
}
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
**/*.log
2+
**/node_modules
3+
/.coverage
4+
/coverage
5+
/.nyc_output
6+
/docs/
7+
/out/
8+
/build/
9+
system-test/secrets.js
10+
system-test/*key.json
11+
*.lock
12+
.DS_Store
13+
package-lock.json
14+
__pycache__
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
// Copyright 2026 Google LLC
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// https://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
//
15+
// ** This file is automatically generated by gapic-generator-typescript. **
16+
// ** https://github.com/googleapis/gapic-generator-typescript **
17+
// ** All changes to this file may be overwritten. **
18+
19+
'use strict';
20+
21+
module.exports = {
22+
opts: {
23+
readme: './README.md',
24+
package: './package.json',
25+
template: './node_modules/jsdoc-fresh',
26+
recurse: true,
27+
verbose: true,
28+
destination: './docs/'
29+
},
30+
plugins: [
31+
'plugins/markdown',
32+
'jsdoc-region-tag'
33+
],
34+
source: {
35+
excludePattern: '(^|\\/|\\\\)[._]',
36+
include: [
37+
'build/src',
38+
'protos'
39+
],
40+
includePattern: '\\.js$'
41+
},
42+
templates: {
43+
copyright: 'Copyright 2026 Google LLC',
44+
includeDate: false,
45+
sourceFiles: false,
46+
systemName: '@google-cloud/recommender',
47+
theme: 'lumen',
48+
default: {
49+
outputSourceFiles: false
50+
}
51+
},
52+
markdown: {
53+
idInHeadings: true
54+
}
55+
};
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
// Copyright 2026 Google LLC
2+
//
3+
// Licensed under the Apache License, Version 2.0 (the "License");
4+
// you may not use this file except in compliance with the License.
5+
// You may obtain a copy of the License at
6+
//
7+
// https://www.apache.org/licenses/LICENSE-2.0
8+
//
9+
// Unless required by applicable law or agreed to in writing, software
10+
// distributed under the License is distributed on an "AS IS" BASIS,
11+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
// See the License for the specific language governing permissions and
13+
// limitations under the License.
14+
//
15+
// ** This file is automatically generated by gapic-generator-typescript. **
16+
// ** https://github.com/googleapis/gapic-generator-typescript **
17+
// ** All changes to this file may be overwritten. **
18+
19+
const config = {
20+
"enable-source-maps": true,
21+
"throw-deprecation": true,
22+
"timeout": 10000
23+
}
24+
if (process.env.MOCHA_THROW_DEPRECATION === 'false') {
25+
delete config['throw-deprecation'];
26+
}
27+
if (process.env.MOCHA_REPORTER) {
28+
config.reporter = process.env.MOCHA_REPORTER;
29+
}
30+
if (process.env.MOCHA_REPORTER_OUTPUT) {
31+
config['reporter-option'] = `output=${process.env.MOCHA_REPORTER_OUTPUT}`;
32+
}
33+
module.exports = config
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
{
2+
"report-dir": "./.coverage",
3+
"reporter": ["text", "lcov"],
4+
"exclude": [
5+
"**/*-test",
6+
"**/.coverage",
7+
"**/apis",
8+
"**/benchmark",
9+
"**/conformance",
10+
"**/docs",
11+
"**/samples",
12+
"**/scripts",
13+
"**/protos",
14+
"**/test",
15+
"**/*.d.ts",
16+
".jsdoc.js",
17+
"**/.jsdoc.js",
18+
"karma.conf.js",
19+
"webpack-tests.config.js",
20+
"webpack.config.js"
21+
],
22+
"exclude-after-remap": false,
23+
"all": true
24+
}
Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
1+
[//]: # "This README.md file is auto-generated, all changes to this file will be lost."
2+
[//]: # "The comments you see below are used to generate those parts of the template in later states."
3+
<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
4+
5+
# [Recommender API: Nodejs Client][homepage]
6+
7+
This library is considered to be **stable**. The code surface will not change in backwards-incompatible ways
8+
unless absolutely necessary (e.g. because of critical security issues) or with
9+
an extensive deprecation period. Issues and requests against **stable** libraries
10+
are addressed with the highest priority
11+
12+
[![npm version](https://img.shields.io/npm/v/@google-cloud/recommender.svg)](https://www.npmjs.org/package/@google-cloud/recommender)
13+
14+
Recommender API client for Node.js
15+
16+
[//]: # "partials.introduction"
17+
18+
A comprehensive list of changes in each version may be found in
19+
[the CHANGELOG][homepage_changelog].
20+
21+
* [Recommender API Nodejs Client API Reference](https://cloud.google.com/nodejs/docs/reference/recommender/latest)
22+
23+
24+
Read more about the client libraries for Cloud APIs, including the older
25+
Google APIs Client Libraries, in [Client Libraries Explained][explained].
26+
27+
[explained]: https://cloud.google.com/apis/docs/client-libraries-explained
28+
29+
**Table of contents:**
30+
31+
* [Quickstart](#quickstart)
32+
* [Before you begin](#before-you-begin)
33+
* [Installing the client library](#installing-the-client-library)
34+
35+
* [Versioning](#versioning)
36+
* [Contributing](#contributing)
37+
* [License](#license)
38+
39+
## Quickstart
40+
### Before you begin
41+
42+
1. [Select or create a Cloud Platform project][projects].
43+
1. [Enable billing for your project][billing].
44+
1. [Enable the Recommender API API][enable_api].
45+
1. [Set up authentication][auth] so you can access the
46+
API from your local workstation.
47+
### Installing the client library
48+
49+
```bash
50+
npm install @google-cloud/recommender
51+
```
52+
53+
[//]: # "partials.body"
54+
55+
## Samples
56+
57+
Samples are in the [`samples/`][homepage_samples] directory. Each sample's `README.md` has instructions for running its sample.
58+
59+
| Sample | Source Code |
60+
| --------------------------- | --------------------------------- |
61+
| get insight | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-recommender/samples/generated/v1/recommender.get_insight.js) |
62+
| get insight type config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-recommender/samples/generated/v1/recommender.get_insight_type_config.js) |
63+
| get recommendation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-recommender/samples/generated/v1/recommender.get_recommendation.js) |
64+
| get recommender config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-recommender/samples/generated/v1/recommender.get_recommender_config.js) |
65+
| list insights | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-recommender/samples/generated/v1/recommender.list_insights.js) |
66+
| list recommendations | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-recommender/samples/generated/v1/recommender.list_recommendations.js) |
67+
| mark insight accepted | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-recommender/samples/generated/v1/recommender.mark_insight_accepted.js) |
68+
| mark recommendation claimed | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-recommender/samples/generated/v1/recommender.mark_recommendation_claimed.js) |
69+
| mark recommendation dismissed | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-recommender/samples/generated/v1/recommender.mark_recommendation_dismissed.js) |
70+
| mark recommendation failed | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-recommender/samples/generated/v1/recommender.mark_recommendation_failed.js) |
71+
| mark recommendation succeeded | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-recommender/samples/generated/v1/recommender.mark_recommendation_succeeded.js) |
72+
| update insight type config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-recommender/samples/generated/v1/recommender.update_insight_type_config.js) |
73+
| update recommender config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-recommender/samples/generated/v1/recommender.update_recommender_config.js) |
74+
| cloud | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-recommender/samples/generated/v1/snippet_metadata_google.cloud.recommender.v1.json) |
75+
| get insight | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-recommender/samples/generated/v1beta1/recommender.get_insight.js) |
76+
| get insight type config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-recommender/samples/generated/v1beta1/recommender.get_insight_type_config.js) |
77+
| get recommendation | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-recommender/samples/generated/v1beta1/recommender.get_recommendation.js) |
78+
| get recommender config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-recommender/samples/generated/v1beta1/recommender.get_recommender_config.js) |
79+
| list insight types | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-recommender/samples/generated/v1beta1/recommender.list_insight_types.js) |
80+
| list insights | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-recommender/samples/generated/v1beta1/recommender.list_insights.js) |
81+
| list recommendations | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-recommender/samples/generated/v1beta1/recommender.list_recommendations.js) |
82+
| list recommenders | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-recommender/samples/generated/v1beta1/recommender.list_recommenders.js) |
83+
| mark insight accepted | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-recommender/samples/generated/v1beta1/recommender.mark_insight_accepted.js) |
84+
| mark recommendation claimed | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-recommender/samples/generated/v1beta1/recommender.mark_recommendation_claimed.js) |
85+
| mark recommendation failed | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-recommender/samples/generated/v1beta1/recommender.mark_recommendation_failed.js) |
86+
| mark recommendation succeeded | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-recommender/samples/generated/v1beta1/recommender.mark_recommendation_succeeded.js) |
87+
| update insight type config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-recommender/samples/generated/v1beta1/recommender.update_insight_type_config.js) |
88+
| update recommender config | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-recommender/samples/generated/v1beta1/recommender.update_recommender_config.js) |
89+
| cloud | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-recommender/samples/generated/v1beta1/snippet_metadata_google.cloud.recommender.v1beta1.json) |
90+
91+
92+
## Supported Node.js Versions
93+
94+
Our client libraries follow the [Node.js release schedule](https://github.com/nodejs/release#release-schedule).
95+
Libraries are compatible with all current _active_ and _maintenance_ versions of
96+
Node.js.
97+
If you are using an end-of-life version of Node.js, we recommend that you update
98+
as soon as possible to an actively supported LTS version.
99+
100+
Google's client libraries support legacy versions of Node.js runtimes on a
101+
best-efforts basis with the following warnings:
102+
103+
* Legacy versions are not tested in continuous integration.
104+
* Some security patches and features cannot be backported.
105+
* Dependencies cannot be kept up-to-date.
106+
107+
Client libraries targeting some end-of-life versions of Node.js are available, and
108+
can be installed through npm [dist-tags](https://docs.npmjs.com/cli/dist-tag).
109+
The dist-tags follow the naming convention `legacy-(version)`.
110+
For example, `npm install @google-cloud/recommender@legacy-8` installs client libraries
111+
for versions compatible with Node.js 8.
112+
113+
## Versioning
114+
115+
This library follows [Semantic Versioning](http://semver.org/).
116+
117+
More Information: [Google Cloud Platform Launch Stages][launch_stages]
118+
119+
[launch_stages]: https://cloud.google.com/terms/launch-stages
120+
121+
## Contributing
122+
123+
Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/google-cloud-node/blob/main/CONTRIBUTING.md).
124+
125+
Please note that this `README.md`
126+
and a variety of configuration files in this repository (including `.nycrc` and `tsconfig.json`)
127+
are generated from a central template.
128+
129+
## License
130+
131+
Apache Version 2.0
132+
133+
See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/LICENSE)
134+
135+
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
136+
[projects]: https://console.cloud.google.com/project
137+
[billing]: https://support.google.com/cloud/answer/6293499#enable-billing
138+
[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=recommender.googleapis.com
139+
[auth]: https://cloud.google.com/docs/authentication/external/set-up-adc-local
140+
[homepage_samples]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-recommender/samples
141+
[homepage_changelog]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-recommender/CHANGELOG.md
142+
[homepage]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-recommender

0 commit comments

Comments
 (0)