Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0a471d3d1d3c16eeda1d1a1288f99be9f8027475 / . / docs / dyn / safebrowsing_v4.fullHashes.html
blob: 0bc7d84dff6f4999c21e13bf36119b8dcbe6fa8b [file] [log] [blame]
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame^]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="safebrowsing_v4.html">Safe Browsing APIs</a> . <a href="safebrowsing_v4.fullHashes.html">fullHashes</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#find">find(body, x__xgafv=None)</a></code></p>
79<p class="firstline">Finds the full hashes that match the requested hash prefixes.</p>
80<h3>Method Details</h3>
81<div class="method">
82 <code class="details" id="find">find(body, x__xgafv=None)</code>
83 <pre>Finds the full hashes that match the requested hash prefixes.
84
85Args:
86 body: object, The request body. (required)
87 The object takes the form of:
88
89{ # Request to return full hashes matched by the provided hash prefixes.
90 "client": { # The client metadata associated with Safe Browsing API requests. # The client metadata.
91 "clientVersion": "A String", # The version of the client implementation.
92 "clientId": "A String", # A client ID that (hopefully) uniquely identifies the client implementation of the Safe Browsing API.
93 },
94 "threatInfo": { # The information regarding one or more threats that a client submits when checking for matches in threat lists. # The lists and hashes to be checked.
95 "threatTypes": [ # The threat types to be checked.
96 "A String",
97 ],
98 "threatEntries": [ # The threat entries to be checked.
99 { # An individual threat; for example, a malicious URL or its hash representation. Only one of these fields should be set.
100 "url": "A String", # A URL.
101 "hash": "A String", # A hash prefix, consisting of the most significant 4-32 bytes of a SHA256 hash. This field is in binary format.
102 "digest": "A String", # The digest of an executable in SHA256 format. The API supports both binary and hex digests.
103 },
104 ],
105 "platformTypes": [ # The platform types to be checked.
106 "A String",
107 ],
108 "threatEntryTypes": [ # The entry types to be checked.
109 "A String",
110 ],
111 },
112 "clientStates": [ # The current client states for each of the client's local threat lists.
113 "A String",
114 ],
115 }
116
117 x__xgafv: string, V1 error format.
118
119Returns:
120 An object of the form:
121
122 {
123 "matches": [ # The full hashes that matched the requested prefixes.
124 { # A match when checking a threat entry in the Safe Browsing threat lists.
125 "threatType": "A String", # The threat type matching this threat.
126 "threatEntryMetadata": { # The metadata associated with a specific threat entry. The client is expected to know the metadata key/value pairs associated with each threat type. # Optional metadata associated with this threat.
127 "entries": [ # The metadata entries.
128 { # A single metadata entry.
129 "value": "A String", # The metadata entry value.
130 "key": "A String", # The metadata entry key.
131 },
132 ],
133 },
134 "threatEntryType": "A String", # The threat entry type matching this threat.
135 "cacheDuration": "A String", # The cache lifetime for the returned match. Clients must not cache this response for more than this duration to avoid false positives.
136 "threat": { # An individual threat; for example, a malicious URL or its hash representation. Only one of these fields should be set. # The threat matching this threat.
137 "url": "A String", # A URL.
138 "hash": "A String", # A hash prefix, consisting of the most significant 4-32 bytes of a SHA256 hash. This field is in binary format.
139 "digest": "A String", # The digest of an executable in SHA256 format. The API supports both binary and hex digests.
140 },
141 "platformType": "A String", # The platform type matching this threat.
142 },
143 ],
144 "negativeCacheDuration": "A String", # For requested entities that did not match the threat list, how long to cache the response.
145 "minimumWaitDuration": "A String", # The minimum duration the client must wait before issuing any find hashes request. If this field is not set, clients can issue a request as soon as they want.
146 }</pre>
147</div>
148
149</body></html>