Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / f80be181200f4aae910badec3f4bddea08ae5044 / . / docs / dyn / safebrowsing_v4.encodedUpdates.html
blob: a053ffc31e1231211304705c88868fd82b689a4f [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.encodedUpdates.html">encodedUpdates</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 FetchThreatListUpdatesRequest proto. (required)
87 clientVersion: string, The version of the client implementation.
88 clientId: string, A client ID that uniquely identifies the client implementation of the Safe
89Browsing 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 {
99 "listUpdateResponses": [ # The list updates requested by the clients.
100 { # An update to an individual list.
101 "responseType": "A String", # The type of response. This may indicate that an action is required by the
102 # client when the response is received.
103 "threatType": "A String", # The threat type for which data is returned.
104 "removals": [ # A set of entries to remove from a local threat type's list. In practice,
105 # this field is empty or contains exactly one ThreatEntrySet.
106 { # A set of threats that should be added or removed from a client's local
107 # database.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]108 "riceHashes": { # The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or # The encoded 4-byte prefixes of SHA256-formatted entries, using a
109 # Golomb-Rice encoding. The hashes are converted to uint32, sorted in
110 # ascending order, then delta encoded and stored as encoded_data.
111 # compressed removal indices.
112 "riceParameter": 42, # The Golomb-Rice parameter, which is a number between 2 and 28. This field
113 # is missing (that is, zero) if `num_entries` is zero.
114 "numEntries": 42, # The number of entries that are delta encoded in the encoded data. If only a
115 # single integer was encoded, this will be zero and the single value will be
116 # stored in `first_value`.
117 "encodedData": "A String", # The encoded deltas that are encoded using the Golomb-Rice coder.
118 "firstValue": "A String", # The offset of the first entry in the encoded data, or, if only a single
119 # integer was encoded, that single integer's value. If the field is empty or
120 # missing, assume zero.
121 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]122 "compressionType": "A String", # The compression type for the entries in this set.
123 "rawIndices": { # A set of raw indices to remove from a local list. # The raw removal indices for a local list.
124 "indices": [ # The indices to remove from a lexicographically-sorted local list.
125 42,
126 ],
127 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]128 "riceIndices": { # The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or # The encoded local, lexicographically-sorted list indices, using a
129 # Golomb-Rice encoding. Used for sending compressed removal indices. The
130 # removal indices (uint32) are sorted in ascending order, then delta encoded
131 # and stored as encoded_data.
132 # compressed removal indices.
133 "riceParameter": 42, # The Golomb-Rice parameter, which is a number between 2 and 28. This field
134 # is missing (that is, zero) if `num_entries` is zero.
135 "numEntries": 42, # The number of entries that are delta encoded in the encoded data. If only a
136 # single integer was encoded, this will be zero and the single value will be
137 # stored in `first_value`.
138 "encodedData": "A String", # The encoded deltas that are encoded using the Golomb-Rice coder.
139 "firstValue": "A String", # The offset of the first entry in the encoded data, or, if only a single
140 # integer was encoded, that single integer's value. If the field is empty or
141 # missing, assume zero.
142 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]143 "rawHashes": { # The uncompressed threat entries in hash format of a particular prefix length. # The raw SHA256-formatted entries.
144 # Hashes can be anywhere from 4 to 32 bytes in size. A large majority are 4
145 # bytes, but some hashes are lengthened if they collide with the hash of a
146 # popular URL.
147 #
148 # Used for sending ThreatEntrySet to clients that do not support compression,
149 # or when sending non-4-byte hashes to clients that do support compression.
150 "prefixSize": 42, # The number of bytes for each prefix encoded below. This field can be
151 # anywhere from 4 (shortest prefix) to 32 (full SHA256 hash).
152 "rawHashes": "A String", # The hashes, in binary format, concatenated into one long string. Hashes are
153 # sorted in lexicographic order. For JSON API users, hashes are
154 # base64-encoded.
155 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]156 },
157 ],
158 "newClientState": "A String", # The new client state, in encrypted format. Opaque to clients.
159 "checksum": { # The expected state of a client's local database. # The expected SHA256 hash of the client state; that is, of the sorted list
160 # of all hashes present in the database after applying the provided update.
161 # If the client state doesn't match the expected state, the client must
162 # disregard this update and retry later.
163 "sha256": "A String", # The SHA256 hash of the client state; that is, of the sorted list of all
164 # hashes present in the database.
165 },
166 "threatEntryType": "A String", # The format of the threats.
167 "additions": [ # A set of entries to add to a local threat type's list. Repeated to allow
168 # for a combination of compressed and raw data to be sent in a single
169 # response.
170 { # A set of threats that should be added or removed from a client's local
171 # database.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]172 "riceHashes": { # The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or # The encoded 4-byte prefixes of SHA256-formatted entries, using a
173 # Golomb-Rice encoding. The hashes are converted to uint32, sorted in
174 # ascending order, then delta encoded and stored as encoded_data.
175 # compressed removal indices.
176 "riceParameter": 42, # The Golomb-Rice parameter, which is a number between 2 and 28. This field
177 # is missing (that is, zero) if `num_entries` is zero.
178 "numEntries": 42, # The number of entries that are delta encoded in the encoded data. If only a
179 # single integer was encoded, this will be zero and the single value will be
180 # stored in `first_value`.
181 "encodedData": "A String", # The encoded deltas that are encoded using the Golomb-Rice coder.
182 "firstValue": "A String", # The offset of the first entry in the encoded data, or, if only a single
183 # integer was encoded, that single integer's value. If the field is empty or
184 # missing, assume zero.
185 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]186 "compressionType": "A String", # The compression type for the entries in this set.
187 "rawIndices": { # A set of raw indices to remove from a local list. # The raw removal indices for a local list.
188 "indices": [ # The indices to remove from a lexicographically-sorted local list.
189 42,
190 ],
191 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]192 "riceIndices": { # The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or # The encoded local, lexicographically-sorted list indices, using a
193 # Golomb-Rice encoding. Used for sending compressed removal indices. The
194 # removal indices (uint32) are sorted in ascending order, then delta encoded
195 # and stored as encoded_data.
196 # compressed removal indices.
197 "riceParameter": 42, # The Golomb-Rice parameter, which is a number between 2 and 28. This field
198 # is missing (that is, zero) if `num_entries` is zero.
199 "numEntries": 42, # The number of entries that are delta encoded in the encoded data. If only a
200 # single integer was encoded, this will be zero and the single value will be
201 # stored in `first_value`.
202 "encodedData": "A String", # The encoded deltas that are encoded using the Golomb-Rice coder.
203 "firstValue": "A String", # The offset of the first entry in the encoded data, or, if only a single
204 # integer was encoded, that single integer's value. If the field is empty or
205 # missing, assume zero.
206 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]207 "rawHashes": { # The uncompressed threat entries in hash format of a particular prefix length. # The raw SHA256-formatted entries.
208 # Hashes can be anywhere from 4 to 32 bytes in size. A large majority are 4
209 # bytes, but some hashes are lengthened if they collide with the hash of a
210 # popular URL.
211 #
212 # Used for sending ThreatEntrySet to clients that do not support compression,
213 # or when sending non-4-byte hashes to clients that do support compression.
214 "prefixSize": 42, # The number of bytes for each prefix encoded below. This field can be
215 # anywhere from 4 (shortest prefix) to 32 (full SHA256 hash).
216 "rawHashes": "A String", # The hashes, in binary format, concatenated into one long string. Hashes are
217 # sorted in lexicographic order. For JSON API users, hashes are
218 # base64-encoded.
219 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]220 },
221 ],
222 "platformType": "A String", # The platform type for which data is returned.
223 },
224 ],
225 "minimumWaitDuration": "A String", # The minimum duration the client must wait before issuing any update
226 # request. If this field is not set clients may update as soon as they want.
227 }</pre>
228</div>
229
230</body></html>