@google-cloud/containeranalysis 6.3.0 → 6.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -1,24 +1,25 @@
|
|
|
1
1
|
[//]: # "This README.md file is auto-generated, all changes to this file will be lost."
|
|
2
|
-
[//]: # "
|
|
2
|
+
[//]: # "The comments you see below are used to generate those parts of the template in later states."
|
|
3
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
4
|
|
|
5
|
-
# [
|
|
6
|
-
|
|
7
|
-
[](https://cloud.google.com/terms/launch-stages)
|
|
8
|
-
[](https://www.npmjs.org/package/@google-cloud/containeranalysis)
|
|
9
|
-
|
|
5
|
+
# [Container Analysis API: Nodejs Client][homepage]
|
|
10
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
11
|
|
|
12
|
+
[](https://www.npmjs.org/package/@google-cloud/containeranalysis)
|
|
12
13
|
|
|
13
|
-
|
|
14
|
+
Container Analysis API client for Node.js
|
|
14
15
|
|
|
16
|
+
[//]: # "partials.introduction"
|
|
15
17
|
|
|
16
18
|
A comprehensive list of changes in each version may be found in
|
|
17
|
-
[the CHANGELOG]
|
|
19
|
+
[the CHANGELOG][homepage_changelog].
|
|
20
|
+
|
|
21
|
+
* [Container Analysis API Nodejs Client API Reference](https://cloud.google.com/nodejs/docs/reference/containeranalysis/latest)
|
|
18
22
|
|
|
19
|
-
* [Google Container Analysis Node.js Client API Reference][client-docs]
|
|
20
|
-
* [Google Container Analysis Documentation][product-docs]
|
|
21
|
-
* [github.com/googleapis/google-cloud-node/packages/google-devtools-containeranalysis](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-devtools-containeranalysis)
|
|
22
23
|
|
|
23
24
|
Read more about the client libraries for Cloud APIs, including the older
|
|
24
25
|
Google APIs Client Libraries, in [Client Libraries Explained][explained].
|
|
@@ -27,89 +28,78 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained].
|
|
|
27
28
|
|
|
28
29
|
**Table of contents:**
|
|
29
30
|
|
|
30
|
-
|
|
31
31
|
* [Quickstart](#quickstart)
|
|
32
32
|
* [Before you begin](#before-you-begin)
|
|
33
33
|
* [Installing the client library](#installing-the-client-library)
|
|
34
34
|
|
|
35
|
-
* [Samples](#samples)
|
|
36
35
|
* [Versioning](#versioning)
|
|
37
36
|
* [Contributing](#contributing)
|
|
38
37
|
* [License](#license)
|
|
39
38
|
|
|
40
39
|
## Quickstart
|
|
41
|
-
|
|
42
40
|
### Before you begin
|
|
43
41
|
|
|
44
42
|
1. [Select or create a Cloud Platform project][projects].
|
|
45
43
|
1. [Enable billing for your project][billing].
|
|
46
|
-
1. [Enable the
|
|
44
|
+
1. [Enable the Container Analysis API API][enable_api].
|
|
47
45
|
1. [Set up authentication][auth] so you can access the
|
|
48
46
|
API from your local workstation.
|
|
49
|
-
|
|
50
47
|
### Installing the client library
|
|
51
48
|
|
|
52
49
|
```bash
|
|
53
50
|
npm install @google-cloud/containeranalysis
|
|
54
51
|
```
|
|
55
52
|
|
|
56
|
-
|
|
57
|
-
|
|
53
|
+
[//]: # "partials.body"
|
|
58
54
|
|
|
59
55
|
## Samples
|
|
60
56
|
|
|
61
|
-
Samples are in the [`samples/`]
|
|
62
|
-
|
|
63
|
-
| Sample | Source Code |
|
|
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
|
-
| Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-devtools-containeranalysis/samples/quickstart.js,packages/google-devtools-containeranalysis/samples/README.md) |
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
The [Google Container Analysis Node.js Client API Reference][client-docs] documentation
|
|
112
|
-
also contains samples.
|
|
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
|
+
| export s b o m | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/container_analysis.export_s_b_o_m.js) |
|
|
62
|
+
| get iam policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/container_analysis.get_iam_policy.js) |
|
|
63
|
+
| get vulnerability occurrences summary | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/container_analysis.get_vulnerability_occurrences_summary.js) |
|
|
64
|
+
| set iam policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/container_analysis.set_iam_policy.js) |
|
|
65
|
+
| test iam permissions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/container_analysis.test_iam_permissions.js) |
|
|
66
|
+
| batch create notes | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/grafeas.batch_create_notes.js) |
|
|
67
|
+
| batch create occurrences | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/grafeas.batch_create_occurrences.js) |
|
|
68
|
+
| create note | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/grafeas.create_note.js) |
|
|
69
|
+
| create occurrence | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/grafeas.create_occurrence.js) |
|
|
70
|
+
| delete note | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/grafeas.delete_note.js) |
|
|
71
|
+
| delete occurrence | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/grafeas.delete_occurrence.js) |
|
|
72
|
+
| get note | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/grafeas.get_note.js) |
|
|
73
|
+
| get occurrence | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/grafeas.get_occurrence.js) |
|
|
74
|
+
| get occurrence note | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/grafeas.get_occurrence_note.js) |
|
|
75
|
+
| list note occurrences | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/grafeas.list_note_occurrences.js) |
|
|
76
|
+
| list notes | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/grafeas.list_notes.js) |
|
|
77
|
+
| list occurrences | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/grafeas.list_occurrences.js) |
|
|
78
|
+
| update note | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/grafeas.update_note.js) |
|
|
79
|
+
| update occurrence | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/grafeas.update_occurrence.js) |
|
|
80
|
+
| devtools | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1/snippet_metadata_google.devtools.containeranalysis.v1.json) |
|
|
81
|
+
| export s b o m | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/container_analysis_v1_beta1.export_s_b_o_m.js) |
|
|
82
|
+
| generate packages summary | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/container_analysis_v1_beta1.generate_packages_summary.js) |
|
|
83
|
+
| get iam policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/container_analysis_v1_beta1.get_iam_policy.js) |
|
|
84
|
+
| set iam policy | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/container_analysis_v1_beta1.set_iam_policy.js) |
|
|
85
|
+
| test iam permissions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/container_analysis_v1_beta1.test_iam_permissions.js) |
|
|
86
|
+
| batch create notes | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/grafeas_v1_beta1.batch_create_notes.js) |
|
|
87
|
+
| batch create occurrences | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/grafeas_v1_beta1.batch_create_occurrences.js) |
|
|
88
|
+
| create note | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/grafeas_v1_beta1.create_note.js) |
|
|
89
|
+
| create occurrence | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/grafeas_v1_beta1.create_occurrence.js) |
|
|
90
|
+
| delete note | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/grafeas_v1_beta1.delete_note.js) |
|
|
91
|
+
| delete occurrence | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/grafeas_v1_beta1.delete_occurrence.js) |
|
|
92
|
+
| get note | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/grafeas_v1_beta1.get_note.js) |
|
|
93
|
+
| get occurrence | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/grafeas_v1_beta1.get_occurrence.js) |
|
|
94
|
+
| get occurrence note | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/grafeas_v1_beta1.get_occurrence_note.js) |
|
|
95
|
+
| get vulnerability occurrences summary | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/grafeas_v1_beta1.get_vulnerability_occurrences_summary.js) |
|
|
96
|
+
| list note occurrences | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/grafeas_v1_beta1.list_note_occurrences.js) |
|
|
97
|
+
| list notes | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/grafeas_v1_beta1.list_notes.js) |
|
|
98
|
+
| list occurrences | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/grafeas_v1_beta1.list_occurrences.js) |
|
|
99
|
+
| update note | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/grafeas_v1_beta1.update_note.js) |
|
|
100
|
+
| update occurrence | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/grafeas_v1_beta1.update_occurrence.js) |
|
|
101
|
+
| devtools | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples/generated/v1beta1/snippet_metadata_google.devtools.containeranalysis.v1beta1.json) |
|
|
102
|
+
|
|
113
103
|
|
|
114
104
|
## Supported Node.js Versions
|
|
115
105
|
|
|
@@ -136,42 +126,29 @@ for versions compatible with Node.js 8.
|
|
|
136
126
|
|
|
137
127
|
This library follows [Semantic Versioning](http://semver.org/).
|
|
138
128
|
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
This library is considered to be **stable**. The code surface will not change in backwards-incompatible ways
|
|
142
|
-
unless absolutely necessary (e.g. because of critical security issues) or with
|
|
143
|
-
an extensive deprecation period. Issues and requests against **stable** libraries
|
|
144
|
-
are addressed with the highest priority.
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
129
|
More Information: [Google Cloud Platform Launch Stages][launch_stages]
|
|
152
130
|
|
|
153
131
|
[launch_stages]: https://cloud.google.com/terms/launch-stages
|
|
154
132
|
|
|
155
133
|
## Contributing
|
|
156
134
|
|
|
157
|
-
Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/google-cloud-node/blob/main/CONTRIBUTING.md).
|
|
135
|
+
Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/CONTRIBUTING.md).
|
|
158
136
|
|
|
159
|
-
Please note that this `README.md
|
|
137
|
+
Please note that this `README.md`
|
|
160
138
|
and a variety of configuration files in this repository (including `.nycrc` and `tsconfig.json`)
|
|
161
|
-
are generated from a central template.
|
|
162
|
-
to its templates in
|
|
163
|
-
[directory](https://github.com/googleapis/synthtool).
|
|
139
|
+
are generated from a central template.
|
|
164
140
|
|
|
165
141
|
## License
|
|
166
142
|
|
|
167
143
|
Apache Version 2.0
|
|
168
144
|
|
|
169
|
-
See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/LICENSE)
|
|
145
|
+
See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/LICENSE)
|
|
170
146
|
|
|
171
|
-
[client-docs]: https://cloud.google.com/nodejs/docs/reference/containeranalysis/latest
|
|
172
|
-
[product-docs]: https://cloud.google.com/container-registry/docs/container-analysis
|
|
173
147
|
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
|
|
174
148
|
[projects]: https://console.cloud.google.com/project
|
|
175
149
|
[billing]: https://support.google.com/cloud/answer/6293499#enable-billing
|
|
176
150
|
[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=containeranalysis.googleapis.com
|
|
177
151
|
[auth]: https://cloud.google.com/docs/authentication/external/set-up-adc-local
|
|
152
|
+
[homepage_samples]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/samples
|
|
153
|
+
[homepage_changelog]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis/CHANGELOG.md
|
|
154
|
+
[homepage]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-devtools-containeranalysis
|
|
@@ -4,7 +4,7 @@ import * as protos from '../../protos/protos';
|
|
|
4
4
|
/**
|
|
5
5
|
* Retrieves analysis results of Cloud components such as Docker container
|
|
6
6
|
* images. The Container Analysis API is an implementation of the
|
|
7
|
-
* [Grafeas](https://
|
|
7
|
+
* [Grafeas](https://grafeas.io) API.
|
|
8
8
|
*
|
|
9
9
|
* Analysis results are stored as a series of occurrences. An `Occurrence`
|
|
10
10
|
* contains information about a specific analysis instance on a resource. An
|
|
@@ -30,7 +30,7 @@ const version = require('../../../package.json').version;
|
|
|
30
30
|
/**
|
|
31
31
|
* Retrieves analysis results of Cloud components such as Docker container
|
|
32
32
|
* images. The Container Analysis API is an implementation of the
|
|
33
|
-
* [Grafeas](https://
|
|
33
|
+
* [Grafeas](https://grafeas.io) API.
|
|
34
34
|
*
|
|
35
35
|
* Analysis results are stored as a series of occurrences. An `Occurrence`
|
|
36
36
|
* contains information about a specific analysis instance on a resource. An
|