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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
|
<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_v5.html">Safe Browsing API</a> . <a href="safebrowsing_v5.hashLists.html">hashLists</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#batchGet">batchGet(names=None, sizeConstraints_maxDatabaseEntries=None, sizeConstraints_maxUpdateEntries=None, version=None, x__xgafv=None)</a></code></p>
<p class="firstline">Get multiple hash lists at once. It is very common for a client to need to get multiple hash lists. Using this method is preferred over using the regular Get method multiple times. This is a standard batch Get method as defined by https://google.aip.dev/231 and the HTTP method is also GET.</p>
<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="#list">list(pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List hash lists. In the V5 API, Google will never remove a hash list that has ever been returned by this method. This enables clients to skip using this method and simply hard-code all hash lists they need. This is a standard List method as defined by https://google.aip.dev/132 and the HTTP method is GET.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="batchGet">batchGet(names=None, sizeConstraints_maxDatabaseEntries=None, sizeConstraints_maxUpdateEntries=None, version=None, x__xgafv=None)</code>
<pre>Get multiple hash lists at once. It is very common for a client to need to get multiple hash lists. Using this method is preferred over using the regular Get method multiple times. This is a standard batch Get method as defined by https://google.aip.dev/231 and the HTTP method is also GET.
Args:
names: string, Required. The names of the particular hash lists. The list MAY be a threat list, or it may be the Global Cache. The names MUST NOT contain duplicates; if they did, the client will get an error. (repeated)
sizeConstraints_maxDatabaseEntries: integer, Sets the maximum number of entries that the client is willing to have in the local database for the list. (The server MAY cause the client to store less than this number of entries.) If omitted or zero, no database size limit is set.
sizeConstraints_maxUpdateEntries: integer, The maximum size in number of entries. The update will not contain more entries than this value, but it is possible that the update will contain fewer entries than this value. This MUST be at least 1024. If omitted or zero, no update size limit is set.
version: string, The versions of the hash list that the client already has. If this is the first time the client is fetching the hash lists, the field should be left empty. Otherwise, the client should supply the versions previously received from the server. The client MUST NOT manipulate those bytes. The client need not send the versions in the same order as the corresponding list names. The client may send fewer or more versions in a request than there are names. However the client MUST NOT send multiple versions that correspond to the same name; if it did, the client will get an error. Historical note: in V4 of the API, this was called `states`; it is now renamed to `version` for clarity. (repeated)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response containing multiple hash lists.
"hashLists": [ # The hash lists in the same order given in the request.
{ # A list of hashes identified by its name.
"additionsEightBytes": { # Same as `RiceDeltaEncoded32Bit` except this encodes 64-bit numbers. # The 8-byte additions.
"encodedData": "A String", # The encoded deltas that are encoded using the Golomb-Rice coder.
"entriesCount": 42, # The number of entries that are delta encoded in the encoded data. If only a single integer was encoded, this will be zero and the single value will be stored in `first_value`.
"firstValue": "A String", # The first entry in the encoded data (hashes), or, if only a single hash prefix was encoded, that entry's value. If the field is empty, the entry is zero.
"riceParameter": 42, # The Golomb-Rice parameter. This parameter is guaranteed to be between 35 and 62, inclusive.
},
"additionsFourBytes": { # The Rice-Golomb encoded data. Used for either hashes or removal indices. It is guaranteed that every hash or index here has the same length, and this length is exactly 32 bits. Generally speaking, if we sort all the entries lexicographically, we will find that the higher order bits tend not to change as frequently as lower order bits. This means that if we also take the adjacent difference between entries, the higher order bits have a high probability of being zero. This exploits this high probability of zero by essentially choosing a certain number of bits; all bits more significant than this are likely to be zero so we use unary encoding. See the `rice_parameter` field. Historical note: the Rice-delta encoding was first used in V4 of this API. In V5, two significant improvements were made: firstly, the Rice-delta encoding is now available with hash prefixes longer than 4 bytes; secondly, the encoded data are now treated as big-endian so as to avoid a costly sorting step. # The 4-byte additions.
"encodedData": "A String", # The encoded deltas that are encoded using the Golomb-Rice coder.
"entriesCount": 42, # The number of entries that are delta encoded in the encoded data. If only a single integer was encoded, this will be zero and the single value will be stored in `first_value`.
"firstValue": 42, # The first entry in the encoded data (hashes or indices), or, if only a single hash prefix or index was encoded, that entry's value. If the field is empty, the entry is zero.
"riceParameter": 42, # The Golomb-Rice parameter. This parameter is guaranteed to be between 3 and 30, inclusive.
},
"additionsSixteenBytes": { # Same as `RiceDeltaEncoded32Bit` except this encodes 128-bit numbers. # The 16-byte additions.
"encodedData": "A String", # The encoded deltas that are encoded using the Golomb-Rice coder.
"entriesCount": 42, # The number of entries that are delta encoded in the encoded data. If only a single integer was encoded, this will be zero and the single value will be stored in `first_value`.
"firstValueHi": "A String", # The upper 64 bits of the first entry in the encoded data (hashes). If the field is empty, the upper 64 bits are all zero.
"firstValueLo": "A String", # The lower 64 bits of the first entry in the encoded data (hashes). If the field is empty, the lower 64 bits are all zero.
"riceParameter": 42, # The Golomb-Rice parameter. This parameter is guaranteed to be between 99 and 126, inclusive.
},
"additionsThirtyTwoBytes": { # Same as `RiceDeltaEncoded32Bit` except this encodes 256-bit numbers. # The 32-byte additions.
"encodedData": "A String", # The encoded deltas that are encoded using the Golomb-Rice coder.
"entriesCount": 42, # The number of entries that are delta encoded in the encoded data. If only a single integer was encoded, this will be zero and the single value will be stored in `first_value`.
"firstValueFirstPart": "A String", # The first 64 bits of the first entry in the encoded data (hashes). If the field is empty, the first 64 bits are all zero.
"firstValueFourthPart": "A String", # The last 64 bits of the first entry in the encoded data (hashes). If the field is empty, the last 64 bits are all zero.
"firstValueSecondPart": "A String", # The 65 through 128th bits of the first entry in the encoded data (hashes). If the field is empty, the 65 through 128th bits are all zero.
"firstValueThirdPart": "A String", # The 129 through 192th bits of the first entry in the encoded data (hashes). If the field is empty, the 129 through 192th bits are all zero.
"riceParameter": 42, # The Golomb-Rice parameter. This parameter is guaranteed to be between 227 and 254, inclusive.
},
"compressedRemovals": { # The Rice-Golomb encoded data. Used for either hashes or removal indices. It is guaranteed that every hash or index here has the same length, and this length is exactly 32 bits. Generally speaking, if we sort all the entries lexicographically, we will find that the higher order bits tend not to change as frequently as lower order bits. This means that if we also take the adjacent difference between entries, the higher order bits have a high probability of being zero. This exploits this high probability of zero by essentially choosing a certain number of bits; all bits more significant than this are likely to be zero so we use unary encoding. See the `rice_parameter` field. Historical note: the Rice-delta encoding was first used in V4 of this API. In V5, two significant improvements were made: firstly, the Rice-delta encoding is now available with hash prefixes longer than 4 bytes; secondly, the encoded data are now treated as big-endian so as to avoid a costly sorting step. # The Rice-delta encoded version of removal indices. Since each hash list definitely has less than 2^32 entries, the indices are treated as 32-bit integers and encoded.
"encodedData": "A String", # The encoded deltas that are encoded using the Golomb-Rice coder.
"entriesCount": 42, # The number of entries that are delta encoded in the encoded data. If only a single integer was encoded, this will be zero and the single value will be stored in `first_value`.
"firstValue": 42, # The first entry in the encoded data (hashes or indices), or, if only a single hash prefix or index was encoded, that entry's value. If the field is empty, the entry is zero.
"riceParameter": 42, # The Golomb-Rice parameter. This parameter is guaranteed to be between 3 and 30, inclusive.
},
"metadata": { # Metadata about a particular hash list. # Metadata about the hash list. This is not populated by the `GetHashList` method, but this is populated by the `ListHashLists` method.
"description": "A String", # A human-readable description about this list. Written in English.
"hashLength": "A String", # The supported hash length for this hash list. Each hash list will support exactly one length. If a different hash length is introduced for the same set of threat types or safe types, it will be introduced as a separate list with a distinct name and respective hash length set.
"likelySafeTypes": [ # Unordered list. If not empty, this specifies that the hash list represents a list of likely safe hashes, and this enumerates the ways they are considered likely safe. This field is mutually exclusive with the threat_types field.
"A String",
],
"threatTypes": [ # Unordered list. If not empty, this specifies that the hash list is a kind of threat list, and this enumerates the kind of threats associated with hashes or hash prefixes in this hash list. May be empty if the entry does not represent a threat, i.e. in the case that it represents a likely safe type.
"A String",
],
},
"minimumWaitDuration": "A String", # Clients should wait at least this long to get the hash list again. If omitted or zero, clients SHOULD fetch immediately because it indicates that the server has an additional update to be sent to the client, but could not due to the client-specified constraints.
"name": "A String", # The name of the hash list. Note that the Global Cache is also just a hash list and can be referred to here.
"partialUpdate": True or False, # When true, this is a partial diff containing additions and removals based on what the client already has. When false, this is the complete hash list. When false, the client MUST delete any locally stored version for this hash list. This means that either the version possessed by the client is seriously out-of-date or the client data is believed to be corrupt. The `compressed_removals` field will be empty. When true, the client MUST apply an incremental update by applying removals and then additions.
"sha256Checksum": "A String", # The sorted list of all hashes, hashed again with SHA256. This is the checksum for the sorted list of all hashes present in the database after applying the provided update. In the case that no updates were provided, the server will omit this field to indicate that the client should use the existing checksum.
"version": "A String", # The version of the hash list. The client MUST NOT manipulate those bytes.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="list">list(pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>List hash lists. In the V5 API, Google will never remove a hash list that has ever been returned by this method. This enables clients to skip using this method and simply hard-code all hash lists they need. This is a standard List method as defined by https://google.aip.dev/132 and the HTTP method is GET.
Args:
pageSize: integer, The maximum number of hash lists to return. The service may return fewer than this value. If unspecified, the server will choose a page size, which may be larger than the number of hash lists so that pagination is not necessary.
pageToken: string, A page token, received from a previous `ListHashLists` call. Provide this to retrieve the subsequent page.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response containing metadata about hash lists.
"hashLists": [ # The hash lists in an arbitrary order. Only metadata about the hash lists will be included, not the contents.
{ # A list of hashes identified by its name.
"additionsEightBytes": { # Same as `RiceDeltaEncoded32Bit` except this encodes 64-bit numbers. # The 8-byte additions.
"encodedData": "A String", # The encoded deltas that are encoded using the Golomb-Rice coder.
"entriesCount": 42, # The number of entries that are delta encoded in the encoded data. If only a single integer was encoded, this will be zero and the single value will be stored in `first_value`.
"firstValue": "A String", # The first entry in the encoded data (hashes), or, if only a single hash prefix was encoded, that entry's value. If the field is empty, the entry is zero.
"riceParameter": 42, # The Golomb-Rice parameter. This parameter is guaranteed to be between 35 and 62, inclusive.
},
"additionsFourBytes": { # The Rice-Golomb encoded data. Used for either hashes or removal indices. It is guaranteed that every hash or index here has the same length, and this length is exactly 32 bits. Generally speaking, if we sort all the entries lexicographically, we will find that the higher order bits tend not to change as frequently as lower order bits. This means that if we also take the adjacent difference between entries, the higher order bits have a high probability of being zero. This exploits this high probability of zero by essentially choosing a certain number of bits; all bits more significant than this are likely to be zero so we use unary encoding. See the `rice_parameter` field. Historical note: the Rice-delta encoding was first used in V4 of this API. In V5, two significant improvements were made: firstly, the Rice-delta encoding is now available with hash prefixes longer than 4 bytes; secondly, the encoded data are now treated as big-endian so as to avoid a costly sorting step. # The 4-byte additions.
"encodedData": "A String", # The encoded deltas that are encoded using the Golomb-Rice coder.
"entriesCount": 42, # The number of entries that are delta encoded in the encoded data. If only a single integer was encoded, this will be zero and the single value will be stored in `first_value`.
"firstValue": 42, # The first entry in the encoded data (hashes or indices), or, if only a single hash prefix or index was encoded, that entry's value. If the field is empty, the entry is zero.
"riceParameter": 42, # The Golomb-Rice parameter. This parameter is guaranteed to be between 3 and 30, inclusive.
},
"additionsSixteenBytes": { # Same as `RiceDeltaEncoded32Bit` except this encodes 128-bit numbers. # The 16-byte additions.
"encodedData": "A String", # The encoded deltas that are encoded using the Golomb-Rice coder.
"entriesCount": 42, # The number of entries that are delta encoded in the encoded data. If only a single integer was encoded, this will be zero and the single value will be stored in `first_value`.
"firstValueHi": "A String", # The upper 64 bits of the first entry in the encoded data (hashes). If the field is empty, the upper 64 bits are all zero.
"firstValueLo": "A String", # The lower 64 bits of the first entry in the encoded data (hashes). If the field is empty, the lower 64 bits are all zero.
"riceParameter": 42, # The Golomb-Rice parameter. This parameter is guaranteed to be between 99 and 126, inclusive.
},
"additionsThirtyTwoBytes": { # Same as `RiceDeltaEncoded32Bit` except this encodes 256-bit numbers. # The 32-byte additions.
"encodedData": "A String", # The encoded deltas that are encoded using the Golomb-Rice coder.
"entriesCount": 42, # The number of entries that are delta encoded in the encoded data. If only a single integer was encoded, this will be zero and the single value will be stored in `first_value`.
"firstValueFirstPart": "A String", # The first 64 bits of the first entry in the encoded data (hashes). If the field is empty, the first 64 bits are all zero.
"firstValueFourthPart": "A String", # The last 64 bits of the first entry in the encoded data (hashes). If the field is empty, the last 64 bits are all zero.
"firstValueSecondPart": "A String", # The 65 through 128th bits of the first entry in the encoded data (hashes). If the field is empty, the 65 through 128th bits are all zero.
"firstValueThirdPart": "A String", # The 129 through 192th bits of the first entry in the encoded data (hashes). If the field is empty, the 129 through 192th bits are all zero.
"riceParameter": 42, # The Golomb-Rice parameter. This parameter is guaranteed to be between 227 and 254, inclusive.
},
"compressedRemovals": { # The Rice-Golomb encoded data. Used for either hashes or removal indices. It is guaranteed that every hash or index here has the same length, and this length is exactly 32 bits. Generally speaking, if we sort all the entries lexicographically, we will find that the higher order bits tend not to change as frequently as lower order bits. This means that if we also take the adjacent difference between entries, the higher order bits have a high probability of being zero. This exploits this high probability of zero by essentially choosing a certain number of bits; all bits more significant than this are likely to be zero so we use unary encoding. See the `rice_parameter` field. Historical note: the Rice-delta encoding was first used in V4 of this API. In V5, two significant improvements were made: firstly, the Rice-delta encoding is now available with hash prefixes longer than 4 bytes; secondly, the encoded data are now treated as big-endian so as to avoid a costly sorting step. # The Rice-delta encoded version of removal indices. Since each hash list definitely has less than 2^32 entries, the indices are treated as 32-bit integers and encoded.
"encodedData": "A String", # The encoded deltas that are encoded using the Golomb-Rice coder.
"entriesCount": 42, # The number of entries that are delta encoded in the encoded data. If only a single integer was encoded, this will be zero and the single value will be stored in `first_value`.
"firstValue": 42, # The first entry in the encoded data (hashes or indices), or, if only a single hash prefix or index was encoded, that entry's value. If the field is empty, the entry is zero.
"riceParameter": 42, # The Golomb-Rice parameter. This parameter is guaranteed to be between 3 and 30, inclusive.
},
"metadata": { # Metadata about a particular hash list. # Metadata about the hash list. This is not populated by the `GetHashList` method, but this is populated by the `ListHashLists` method.
"description": "A String", # A human-readable description about this list. Written in English.
"hashLength": "A String", # The supported hash length for this hash list. Each hash list will support exactly one length. If a different hash length is introduced for the same set of threat types or safe types, it will be introduced as a separate list with a distinct name and respective hash length set.
"likelySafeTypes": [ # Unordered list. If not empty, this specifies that the hash list represents a list of likely safe hashes, and this enumerates the ways they are considered likely safe. This field is mutually exclusive with the threat_types field.
"A String",
],
"threatTypes": [ # Unordered list. If not empty, this specifies that the hash list is a kind of threat list, and this enumerates the kind of threats associated with hashes or hash prefixes in this hash list. May be empty if the entry does not represent a threat, i.e. in the case that it represents a likely safe type.
"A String",
],
},
"minimumWaitDuration": "A String", # Clients should wait at least this long to get the hash list again. If omitted or zero, clients SHOULD fetch immediately because it indicates that the server has an additional update to be sent to the client, but could not due to the client-specified constraints.
"name": "A String", # The name of the hash list. Note that the Global Cache is also just a hash list and can be referred to here.
"partialUpdate": True or False, # When true, this is a partial diff containing additions and removals based on what the client already has. When false, this is the complete hash list. When false, the client MUST delete any locally stored version for this hash list. This means that either the version possessed by the client is seriously out-of-date or the client data is believed to be corrupt. The `compressed_removals` field will be empty. When true, the client MUST apply an incremental update by applying removals and then additions.
"sha256Checksum": "A String", # The sorted list of all hashes, hashed again with SHA256. This is the checksum for the sorted list of all hashes present in the database after applying the provided update. In the case that no updates were provided, the server will omit this field to indicate that the client should use the existing checksum.
"version": "A String", # The version of the hash list. The client MUST NOT manipulate those bytes.
},
],
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
