File: containeranalysis_v1beta1.projects.locations.resources.html

package info (click to toggle)
python-googleapi 2.180.0-1
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 527,124 kB
  • sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (148 lines) | stat: -rw-r--r-- 4,315 bytes parent folder | download | duplicates (2)
1
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
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="containeranalysis_v1beta1.html">Container Analysis API</a> . <a href="containeranalysis_v1beta1.projects.html">projects</a> . <a href="containeranalysis_v1beta1.projects.locations.html">locations</a> . <a href="containeranalysis_v1beta1.projects.locations.resources.html">resources</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#exportSBOM">exportSBOM(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Generates an SBOM and other dependency information for the given resource.</p>
<p class="toc_element">
  <code><a href="#generatePackagesSummary">generatePackagesSummary(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a summary of the packages within a given resource.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="exportSBOM">exportSBOM(name, body=None, x__xgafv=None)</code>
  <pre>Generates an SBOM and other dependency information for the given resource.

Args:
  name: string, Required. The name of the resource in the form of `projects/[PROJECT_ID]/resources/[RESOURCE_URL]`. (required)
  body: object, The request body.
    The object takes the form of:

{ # The request to a call of ExportSBOM
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response from a call to ExportSBOM
  &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.
}</pre>
</div>

<div class="method">
    <code class="details" id="generatePackagesSummary">generatePackagesSummary(name, body=None, x__xgafv=None)</code>
  <pre>Gets a summary of the packages within a given resource.

Args:
  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)
  body: object, The request body.
    The object takes the form of:

{ # GeneratePackagesSummaryRequest is the request body for the GeneratePackagesSummary API method. It just takes a single name argument, referring to the resource.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A summary of the packages found within the given resource.
  &quot;licensesSummary&quot;: [ # A listing by license name of each of the licenses and their counts.
    { # Per license count
      &quot;count&quot;: &quot;A String&quot;, # The number of fixable vulnerabilities associated with this resource.
      &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...
    },
  ],
  &quot;resourceUrl&quot;: &quot;A String&quot;, # The unique URL of the image or the container for which this summary applies.
}</pre>
</div>

</body></html>