Blame - docs/dyn/safebrowsing_v4.encodedUpdates.html - platform/external/python/google-api-python-client

"riceIndices": { # The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or # The encoded local, lexicographically-sorted list indices, using a

Bu Sun Kim

715bd7f

2019-06-14 16:50:42 -0700

[diff] [blame]

108

# Golomb-Rice encoding. Used for sending compressed removal indices. The

109

# removal indices (uint32) are sorted in ascending order, then delta encoded

110

# and stored as encoded_data.

111

# compressed removal indices.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame^]

112

"firstValue": "A String", # The offset of the first entry in the encoded data, or, if only a single

113

# integer was encoded, that single integer's value. If the field is empty or

114

# missing, assume zero.

115

"encodedData": "A String", # The encoded deltas that are encoded using the Golomb-Rice coder.

116

"numEntries": 42, # The number of entries that are delta encoded in the encoded data. If only a

Bu Sun Kim

715bd7f

2019-06-14 16:50:42 -0700

[diff] [blame]

117

# single integer was encoded, this will be zero and the single value will be

118

# stored in `first_value`.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame^]

119

"riceParameter": 42, # The Golomb-Rice parameter, which is a number between 2 and 28. This field

120

# is missing (that is, zero) if `num_entries` is zero.

Bu Sun Kim

715bd7f

2019-06-14 16:50:42 -0700

[diff] [blame]

121

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame^]

122

"rawIndices": { # A set of raw indices to remove from a local list. # The raw removal indices for a local list.

123

"indices": [ # The indices to remove from a lexicographically-sorted local list.

42,

],

},

"rawHashes": { # The uncompressed threat entries in hash format of a particular prefix length. # The raw SHA256-formatted entries.

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

128

# Hashes can be anywhere from 4 to 32 bytes in size. A large majority are 4

129

# bytes, but some hashes are lengthened if they collide with the hash of a

130

# popular URL.

131

#

132

# Used for sending ThreatEntrySet to clients that do not support compression,

133

# or when sending non-4-byte hashes to clients that do support compression.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame^]

134

"rawHashes": "A String", # The hashes, in binary format, concatenated into one long string. Hashes are

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

135

# sorted in lexicographic order. For JSON API users, hashes are

136

# base64-encoded.

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame^]

137

"prefixSize": 42, # The number of bytes for each prefix encoded below. This field can be

138

# anywhere from 4 (shortest prefix) to 32 (full SHA256 hash).

139

},

140

"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

141

# Golomb-Rice encoding. The hashes are converted to uint32, sorted in

142

# ascending order, then delta encoded and stored as encoded_data.

143

# compressed removal indices.

144

"firstValue": "A String", # The offset of the first entry in the encoded data, or, if only a single

145

# integer was encoded, that single integer's value. If the field is empty or

146

# missing, assume zero.

147

"encodedData": "A String", # The encoded deltas that are encoded using the Golomb-Rice coder.

148

"numEntries": 42, # The number of entries that are delta encoded in the encoded data. If only a

149

# single integer was encoded, this will be zero and the single value will be

150

# stored in `first_value`.

151

"riceParameter": 42, # The Golomb-Rice parameter, which is a number between 2 and 28. This field

152

# is missing (that is, zero) if `num_entries` is zero.

Dan O'Meara

dd49464

2020-05-01 07:42:23 -0700

[diff] [blame]

153

},

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

154

},

155

],

Bu Sun Kim

6502091

2020-05-20 12:08:20 -0700

[diff] [blame^]

156

"checksum": { # The expected state of a client's local database. # The expected SHA256 hash of the client state; that is, of the sorted list

157

# of all hashes present in the database after applying the provided update.

158

# If the client state doesn't match the expected state, the client must

159

# disregard this update and retry later.

160

"sha256": "A String", # The SHA256 hash of the client state; that is, of the sorted list of all

161

# hashes present in the database.

162

},

163

"responseType": "A String", # The type of response. This may indicate that an action is required by the

164

# client when the response is received.

165

"threatType": "A String", # The threat type for which data is returned.

166

"removals": [ # A set of entries to remove from a local threat type's list. In practice,

167

# this field is empty or contains exactly one ThreatEntrySet.

168

{ # A set of threats that should be added or removed from a client's local

169

# database.

170

"compressionType": "A String", # The compression type for the entries in this set.

171

"riceIndices": { # The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or # The encoded local, lexicographically-sorted list indices, using a

172

# Golomb-Rice encoding. Used for sending compressed removal indices. The

173

# removal indices (uint32) are sorted in ascending order, then delta encoded

174

# and stored as encoded_data.

175

# compressed removal indices.

176

"firstValue": "A String", # The offset of the first entry in the encoded data, or, if only a single

177

# integer was encoded, that single integer's value. If the field is empty or

178

# missing, assume zero.

179

"encodedData": "A String", # The encoded deltas that are encoded using the Golomb-Rice coder.

180

"numEntries": 42, # The number of entries that are delta encoded in the encoded data. If only a

181

# single integer was encoded, this will be zero and the single value will be

182

# stored in `first_value`.

183

"riceParameter": 42, # The Golomb-Rice parameter, which is a number between 2 and 28. This field

184

# is missing (that is, zero) if `num_entries` is zero.

185

},

186

"rawIndices": { # A set of raw indices to remove from a local list. # The raw removal indices for a local list.

187

"indices": [ # The indices to remove from a lexicographically-sorted local list.

42,

],

},

"rawHashes": { # The uncompressed threat entries in hash format of a particular prefix length. # The raw SHA256-formatted entries.

192

# Hashes can be anywhere from 4 to 32 bytes in size. A large majority are 4

193

# bytes, but some hashes are lengthened if they collide with the hash of a

194

# popular URL.

195

#

196

# Used for sending ThreatEntrySet to clients that do not support compression,

197

# or when sending non-4-byte hashes to clients that do support compression.

198

"rawHashes": "A String", # The hashes, in binary format, concatenated into one long string. Hashes are

199

# sorted in lexicographic order. For JSON API users, hashes are

200

# base64-encoded.

201

"prefixSize": 42, # The number of bytes for each prefix encoded below. This field can be

202

# anywhere from 4 (shortest prefix) to 32 (full SHA256 hash).

203

},

204

"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

205

# Golomb-Rice encoding. The hashes are converted to uint32, sorted in

206

# ascending order, then delta encoded and stored as encoded_data.

207

# compressed removal indices.

208

"firstValue": "A String", # The offset of the first entry in the encoded data, or, if only a single

209

# integer was encoded, that single integer's value. If the field is empty or

210

# missing, assume zero.