Debian Codegraph @

docs/dyn/containeranalysis_v1beta1.projects.resources.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="containeranalysis_v1beta1.html">Container Analysis API</a> . <a href="containeranalysis_v1beta1.projects.html">projects</a> . <a href="containeranalysis_v1beta1.projects.resources.html">resources</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#exportSBOM">exportSBOM(name, body=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Generates an SBOM and other dependency information for the given resource.</p>
83 <p class="toc_element">
84 <code><a href="#generatePackagesSummary">generatePackagesSummary(name, body=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Gets a summary of the packages within a given resource.</p>
86 <h3>Method Details</h3>
87 <div class="method">
88 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90 </div>
91
92 <div class="method">
93 <code class="details" id="exportSBOM">exportSBOM(name, body=None, x__xgafv=None)</code>
94 <pre>Generates an SBOM and other dependency information for the given resource.
95
96 Args:
97 name: string, Required. The name of the resource in the form of `projects/[PROJECT_ID]/resources/[RESOURCE_URL]`. (required)
98 body: object, The request body.
99 The object takes the form of:
100
101 { # The request to a call of ExportSBOM
102 }
103
104 x__xgafv: string, V1 error format.
105 Allowed values
106 1 - v1 error format
107 2 - v2 error format
108
109 Returns:
110 An object of the form:
111
112 { # The response from a call to ExportSBOM
113 &quot;discoveryOccurrenceId&quot;: &quot;A String&quot;, # The name of the discovery occurrence in the form &quot;projects/{project_id}/occurrences/{OCCURRENCE_ID} It can be used to track the progression of the SBOM export.
114 }</pre>
115 </div>
116
117 <div class="method">
118 <code class="details" id="generatePackagesSummary">generatePackagesSummary(name, body=None, x__xgafv=None)</code>
119 <pre>Gets a summary of the packages within a given resource.
120
121 Args:
122 name: string, Required. The name of the resource to get a packages summary for in the form of `projects/[PROJECT_ID]/resources/[RESOURCE_URL]`. (required)
123 body: object, The request body.
124 The object takes the form of:
125
126 { # GeneratePackagesSummaryRequest is the request body for the GeneratePackagesSummary API method. It just takes a single name argument, referring to the resource.
127 }
128
129 x__xgafv: string, V1 error format.
130 Allowed values
131 1 - v1 error format
132 2 - v2 error format
133
134 Returns:
135 An object of the form:
136
137 { # A summary of the packages found within the given resource.
138 &quot;licensesSummary&quot;: [ # A listing by license name of each of the licenses and their counts.
139 { # Per license count
140 &quot;count&quot;: &quot;A String&quot;, # The number of fixable vulnerabilities associated with this resource.
141 &quot;license&quot;: &quot;A String&quot;, # The license of the package. Note that the format of this value is not guaranteed. It may be nil, an empty string, a boolean value (A | B), a differently formed boolean value (A OR B), etc...
142 },
143 ],
144 &quot;resourceUrl&quot;: &quot;A String&quot;, # The unique URL of the image or the container for which this summary applies.
145 }</pre>
146 </div>
147
148 </body></html>