Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d059ad881c7ae58c67931c48788d0bd7343ab16c / . / docs / dyn / safebrowsing_v4.fullHashes.html
blob: aaea25980904a1c57808f376babbd56c37d7cb01 [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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]75<h1><a href="safebrowsing_v4.html">Safe Browsing API</a> . <a href="safebrowsing_v4.fullHashes.html">fullHashes</a></h1>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]78 <code><a href="#find">find(body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]79<p class="firstline">Finds the full hashes that match the requested hash prefixes.</p>
80<h3>Method Details</h3>
81<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]82 <code class="details" id="find">find(body=None, x__xgafv=None)</code>
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]83 <pre>Finds the full hashes that match the requested hash prefixes.
84
85Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]86 body: object, The request body.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]87 The object takes the form of:
88
89{ # Request to return full hashes matched by the provided hash prefixes.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]90 &quot;apiClient&quot;: { # The client metadata associated with Safe Browsing API requests. # Client metadata associated with callers of higher-level APIs built on top
91 # of the client&#x27;s implementation.
92 &quot;clientId&quot;: &quot;A String&quot;, # A client ID that (hopefully) uniquely identifies the client implementation
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]93 # of the Safe Browsing API.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]94 &quot;clientVersion&quot;: &quot;A String&quot;, # The version of the client implementation.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]95 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]96 &quot;clientStates&quot;: [ # The current client states for each of the client&#x27;s local threat lists.
97 &quot;A String&quot;,
98 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]99 &quot;threatInfo&quot;: { # The information regarding one or more threats that a client submits when # The lists and hashes to be checked.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]100 # checking for matches in threat lists.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]101 &quot;threatEntries&quot;: [ # The threat entries to be checked.
102 { # An individual threat; for example, a malicious URL or its hash
103 # representation. Only one of these fields should be set.
104 &quot;url&quot;: &quot;A String&quot;, # A URL.
105 &quot;hash&quot;: &quot;A String&quot;, # A hash prefix, consisting of the most significant 4-32 bytes of a SHA256
106 # hash. This field is in binary format. For JSON requests, hashes are
107 # base64-encoded.
108 &quot;digest&quot;: &quot;A String&quot;, # The digest of an executable in SHA256 format. The API supports both
109 # binary and hex digests. For JSON requests, digests are base64-encoded.
110 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]111 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]112 &quot;threatTypes&quot;: [ # The threat types to be checked.
113 &quot;A String&quot;,
114 ],
115 &quot;platformTypes&quot;: [ # The platform types to be checked.
116 &quot;A String&quot;,
117 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]118 &quot;threatEntryTypes&quot;: [ # The entry types to be checked.
119 &quot;A String&quot;,
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]120 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]121 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]122 &quot;client&quot;: { # The client metadata associated with Safe Browsing API requests. # The client metadata.
123 &quot;clientId&quot;: &quot;A String&quot;, # A client ID that (hopefully) uniquely identifies the client implementation
124 # of the Safe Browsing API.
125 &quot;clientVersion&quot;: &quot;A String&quot;, # The version of the client implementation.
126 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]127 }
128
129 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]130 Allowed values
131 1 - v1 error format
132 2 - v2 error format
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]133
134Returns:
135 An object of the form:
136
137 {
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]138 &quot;negativeCacheDuration&quot;: &quot;A String&quot;, # For requested entities that did not match the threat list, how long to
139 # cache the response.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]140 &quot;minimumWaitDuration&quot;: &quot;A String&quot;, # The minimum duration the client must wait before issuing any find hashes
141 # request. If this field is not set, clients can issue a request as soon as
142 # they want.
143 &quot;matches&quot;: [ # The full hashes that matched the requested prefixes.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]144 { # A match when checking a threat entry in the Safe Browsing threat lists.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]145 &quot;threatEntryMetadata&quot;: { # The metadata associated with a specific threat entry. The client is expected # Optional metadata associated with this threat.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]146 # to know the metadata key/value pairs associated with each threat type.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]147 &quot;entries&quot;: [ # The metadata entries.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]148 { # A single metadata entry.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]149 &quot;key&quot;: &quot;A String&quot;, # The metadata entry key. For JSON requests, the key is base64-encoded.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]150 &quot;value&quot;: &quot;A String&quot;, # The metadata entry value. For JSON requests, the value is base64-encoded.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]151 },
152 ],
153 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]154 &quot;platformType&quot;: &quot;A String&quot;, # The platform type matching this threat.
155 &quot;threatType&quot;: &quot;A String&quot;, # The threat type matching this threat.
156 &quot;cacheDuration&quot;: &quot;A String&quot;, # The cache lifetime for the returned match. Clients must not cache this
157 # response for more than this duration to avoid false positives.
158 &quot;threatEntryType&quot;: &quot;A String&quot;, # The threat entry type matching this threat.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]159 &quot;threat&quot;: { # An individual threat; for example, a malicious URL or its hash # The threat matching this threat.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]160 # representation. Only one of these fields should be set.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]161 &quot;url&quot;: &quot;A String&quot;, # A URL.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]162 &quot;hash&quot;: &quot;A String&quot;, # A hash prefix, consisting of the most significant 4-32 bytes of a SHA256
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]163 # hash. This field is in binary format. For JSON requests, hashes are
164 # base64-encoded.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame^]165 &quot;digest&quot;: &quot;A String&quot;, # The digest of an executable in SHA256 format. The API supports both
166 # binary and hex digests. For JSON requests, digests are base64-encoded.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]167 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]168 },
169 ],
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]170 }</pre>
171</div>
172
173</body></html>