1<html><body> 2<style> 3 4body, 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 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, 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="ondemandscanning_v1.html">On-Demand Scanning API</a> . <a href="ondemandscanning_v1.projects.html">projects</a> . <a href="ondemandscanning_v1.projects.locations.html">locations</a> . <a href="ondemandscanning_v1.projects.locations.scans.html">scans</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="ondemandscanning_v1.projects.locations.scans.vulnerabilities.html">vulnerabilities()</a></code> 79</p> 80<p class="firstline">Returns the vulnerabilities Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#analyzePackages">analyzePackages(parent, body=None, x__xgafv=None)</a></code></p> 84<p class="firstline">Initiates an analysis of the provided packages.</p> 85<p class="toc_element"> 86 <code><a href="#close">close()</a></code></p> 87<p class="firstline">Close httplib2 connections.</p> 88<h3>Method Details</h3> 89<div class="method"> 90 <code class="details" id="analyzePackages">analyzePackages(parent, body=None, x__xgafv=None)</code> 91 <pre>Initiates an analysis of the provided packages. 92 93Args: 94 parent: string, Required. The parent of the resource for which analysis is requested. Format: projects/[project_name]/locations/[location] (required) 95 body: object, The request body. 96 The object takes the form of: 97 98{ # AnalyzePackagesRequest is the request to analyze a list of packages and create Vulnerability Occurrences for it. 99 "includeOsvData": True or False, # [DEPRECATED] Whether to include OSV data in the scan. For backwards compatibility reasons, this field can be neither removed nor renamed. 100 "packages": [ # The packages to analyze. 101 { 102 "cpeUri": "A String", # The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/) in which the vulnerability may manifest. Examples include distro or storage location for vulnerable jar. 103 "os": "A String", # The OS affected by a vulnerability This field is deprecated and the information is in cpe_uri 104 "osVersion": "A String", # The version of the OS This field is deprecated and the information is in cpe_uri 105 "package": "A String", # The package being analysed for vulnerabilities 106 "packageType": "A String", # The type of package: os, maven, go, etc. 107 "unused": "A String", 108 "version": "A String", # The version of the package being analysed 109 }, 110 ], 111 "resourceUri": "A String", # Required. The resource URI of the container image being scanned. 112} 113 114 x__xgafv: string, V1 error format. 115 Allowed values 116 1 - v1 error format 117 2 - v2 error format 118 119Returns: 120 An object of the form: 121 122 { # This resource represents a long-running operation that is the result of a network API call. 123 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 124 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 125 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 126 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 127 { 128 "a_key": "", # Properties of the object. Contains field @type with type URL. 129 }, 130 ], 131 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 132 }, 133 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 134 "a_key": "", # Properties of the object. Contains field @type with type URL. 135 }, 136 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 137 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 138 "a_key": "", # Properties of the object. Contains field @type with type URL. 139 }, 140}</pre> 141</div> 142 143<div class="method"> 144 <code class="details" id="close">close()</code> 145 <pre>Close httplib2 connections.</pre> 146</div> 147 148</body></html>