Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / safebrowsing_v4.encodedFullHashes.html
blob: 246dcdd695a5409a510fe182cc51f1132888b68b [file] [log] [blame]
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[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.encodedFullHashes.html">encodedFullHashes</a></h1>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(encodedRequest, clientVersion=None, clientId=None, x__xgafv=None)</a></code></p>
79<p class="firstline"></p>
80<h3>Method Details</h3>
81<div class="method">
82 <code class="details" id="get">get(encodedRequest, clientVersion=None, clientId=None, x__xgafv=None)</code>
83 <pre>
84
85Args:
86 encodedRequest: string, A serialized FindFullHashesRequest proto. (required)
87 clientVersion: string, The version of the client implementation.
88 clientId: string, A client ID that (hopefully) uniquely identifies the client implementation
89of the Safe Browsing API.
90 x__xgafv: string, V1 error format.
91 Allowed values
92 1 - v1 error format
93 2 - v2 error format
94
95Returns:
96 An object of the form:
97
98 {
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]99 &quot;negativeCacheDuration&quot;: &quot;A String&quot;, # For requested entities that did not match the threat list, how long to
100 # cache the response.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]101 &quot;minimumWaitDuration&quot;: &quot;A String&quot;, # The minimum duration the client must wait before issuing any find hashes
102 # request. If this field is not set, clients can issue a request as soon as
103 # they want.
104 &quot;matches&quot;: [ # The full hashes that matched the requested prefixes.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]105 { # A match when checking a threat entry in the Safe Browsing threat lists.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]106 &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]107 # to know the metadata key/value pairs associated with each threat type.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]108 &quot;entries&quot;: [ # The metadata entries.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]109 { # A single metadata entry.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]110 &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]111 &quot;value&quot;: &quot;A String&quot;, # The metadata entry value. For JSON requests, the value is base64-encoded.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]112 },
113 ],
114 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]115 &quot;platformType&quot;: &quot;A String&quot;, # The platform type matching this threat.
116 &quot;threatType&quot;: &quot;A String&quot;, # The threat type matching this threat.
117 &quot;cacheDuration&quot;: &quot;A String&quot;, # The cache lifetime for the returned match. Clients must not cache this
118 # response for more than this duration to avoid false positives.
119 &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]120 &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]121 # representation. Only one of these fields should be set.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]122 &quot;url&quot;: &quot;A String&quot;, # A URL.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]123 &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]124 # hash. This field is in binary format. For JSON requests, hashes are
125 # base64-encoded.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]126 &quot;digest&quot;: &quot;A String&quot;, # The digest of an executable in SHA256 format. The API supports both
127 # binary and hex digests. For JSON requests, digests are base64-encoded.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]128 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]129 },
130 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]131 }</pre>
132</div>
133
134</body></html>