File: safebrowsing_v4.encodedFullHashes.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 (132 lines) | stat: -rw-r--r-- 4,411 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
<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="safebrowsing_v4.html">Safe Browsing API</a> . <a href="safebrowsing_v4.encodedFullHashes.html">encodedFullHashes</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="#get">get(encodedRequest, clientId=None, clientVersion=None, x__xgafv=None)</a></code></p>
<p class="firstline"></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="get">get(encodedRequest, clientId=None, clientVersion=None, x__xgafv=None)</code>
  <pre>

Args:
  encodedRequest: string, A serialized FindFullHashesRequest proto. (required)
  clientId: string, A client ID that (hopefully) uniquely identifies the client implementation of the Safe Browsing API.
  clientVersion: string, The version of the client implementation.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    {
  &quot;matches&quot;: [ # The full hashes that matched the requested prefixes.
    { # A match when checking a threat entry in the Safe Browsing threat lists.
      &quot;cacheDuration&quot;: &quot;A String&quot;, # The cache lifetime for the returned match. Clients must not cache this response for more than this duration to avoid false positives.
      &quot;platformType&quot;: &quot;A String&quot;, # The platform type matching this threat.
      &quot;threat&quot;: { # 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.
        &quot;digest&quot;: &quot;A String&quot;, # The digest of an executable in SHA256 format. The API supports both binary and hex digests. For JSON requests, digests are base64-encoded.
        &quot;hash&quot;: &quot;A String&quot;, # A hash prefix, consisting of the most significant 4-32 bytes of a SHA256 hash. This field is in binary format. For JSON requests, hashes are base64-encoded.
        &quot;url&quot;: &quot;A String&quot;, # A URL.
      },
      &quot;threatEntryMetadata&quot;: { # 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.
        &quot;entries&quot;: [ # The metadata entries.
          { # A single metadata entry.
            &quot;key&quot;: &quot;A String&quot;, # The metadata entry key. For JSON requests, the key is base64-encoded.
            &quot;value&quot;: &quot;A String&quot;, # The metadata entry value. For JSON requests, the value is base64-encoded.
          },
        ],
      },
      &quot;threatEntryType&quot;: &quot;A String&quot;, # The threat entry type matching this threat.
      &quot;threatType&quot;: &quot;A String&quot;, # The threat type matching this threat.
    },
  ],
  &quot;minimumWaitDuration&quot;: &quot;A String&quot;, # 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.
  &quot;negativeCacheDuration&quot;: &quot;A String&quot;, # For requested entities that did not match the threat list, how long to cache the response.
}</pre>
</div>

</body></html>