docs: docs update (#911)
Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:
- [ ] Make sure to open an issue as a [bug/issue](https://github.com/googleapis/google-api-python-client/issues/new/choose) before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
- [ ] Ensure the tests and linter pass
- [ ] Code coverage does not decrease (if any source code was changed)
- [ ] Appropriate docs were updated (if necessary)
Fixes #<issue_number_goes_here> 🦕
diff --git a/docs/dyn/safebrowsing_v4.threatMatches.html b/docs/dyn/safebrowsing_v4.threatMatches.html
index 738d862..3ba3373 100644
--- a/docs/dyn/safebrowsing_v4.threatMatches.html
+++ b/docs/dyn/safebrowsing_v4.threatMatches.html
@@ -87,33 +87,33 @@
The object takes the form of:
{ # Request to check entries against lists.
- "client": { # The client metadata associated with Safe Browsing API requests. # The client metadata.
- "clientId": "A String", # A client ID that (hopefully) uniquely identifies the client implementation
+ "client": { # The client metadata associated with Safe Browsing API requests. # The client metadata.
+ "clientId": "A String", # A client ID that (hopefully) uniquely identifies the client implementation
# of the Safe Browsing API.
- "clientVersion": "A String", # The version of the client implementation.
+ "clientVersion": "A String", # The version of the client implementation.
},
- "threatInfo": { # The information regarding one or more threats that a client submits when # The lists and entries to be checked for matches.
+ "threatInfo": { # The information regarding one or more threats that a client submits when # The lists and entries to be checked for matches.
# checking for matches in threat lists.
- "threatTypes": [ # The threat types to be checked.
- "A String",
+ "threatEntryTypes": [ # The entry types to be checked.
+ "A String",
],
- "threatEntries": [ # The threat entries to be checked.
+ "threatTypes": [ # The threat types to be checked.
+ "A String",
+ ],
+ "platformTypes": [ # The platform types to be checked.
+ "A String",
+ ],
+ "threatEntries": [ # The threat entries to be checked.
{ # An individual threat; for example, a malicious URL or its hash
# representation. Only one of these fields should be set.
- "url": "A String", # A URL.
- "hash": "A String", # A hash prefix, consisting of the most significant 4-32 bytes of a SHA256
+ "hash": "A String", # 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.
- "digest": "A String", # The digest of an executable in SHA256 format. The API supports both
+ "url": "A String", # A URL.
+ "digest": "A String", # The digest of an executable in SHA256 format. The API supports both
# binary and hex digests. For JSON requests, digests are base64-encoded.
},
],
- "platformTypes": [ # The platform types to be checked.
- "A String",
- ],
- "threatEntryTypes": [ # The entry types to be checked.
- "A String",
- ],
},
}
@@ -126,31 +126,31 @@
An object of the form:
{
- "matches": [ # The threat list matches.
+ "matches": [ # The threat list matches.
{ # A match when checking a threat entry in the Safe Browsing threat lists.
- "threatType": "A String", # The threat type matching this threat.
- "threatEntryMetadata": { # The metadata associated with a specific threat entry. The client is expected # Optional metadata associated with this threat.
+ "threatType": "A String", # The threat type matching this threat.
+ "threatEntryMetadata": { # The metadata associated with a specific threat entry. The client is expected # Optional metadata associated with this threat.
# to know the metadata key/value pairs associated with each threat type.
- "entries": [ # The metadata entries.
+ "entries": [ # The metadata entries.
{ # A single metadata entry.
- "value": "A String", # The metadata entry value. For JSON requests, the value is base64-encoded.
- "key": "A String", # The metadata entry key. For JSON requests, the key is base64-encoded.
+ "value": "A String", # The metadata entry value. For JSON requests, the value is base64-encoded.
+ "key": "A String", # The metadata entry key. For JSON requests, the key is base64-encoded.
},
],
},
- "threatEntryType": "A String", # The threat entry type matching this threat.
- "cacheDuration": "A String", # The cache lifetime for the returned match. Clients must not cache this
- # response for more than this duration to avoid false positives.
- "threat": { # An individual threat; for example, a malicious URL or its hash # The threat matching this threat.
+ "threat": { # An individual threat; for example, a malicious URL or its hash # The threat matching this threat.
# representation. Only one of these fields should be set.
- "url": "A String", # A URL.
- "hash": "A String", # A hash prefix, consisting of the most significant 4-32 bytes of a SHA256
+ "hash": "A String", # 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.
- "digest": "A String", # The digest of an executable in SHA256 format. The API supports both
+ "url": "A String", # A URL.
+ "digest": "A String", # The digest of an executable in SHA256 format. The API supports both
# binary and hex digests. For JSON requests, digests are base64-encoded.
},
- "platformType": "A String", # The platform type matching this threat.
+ "platformType": "A String", # The platform type matching this threat.
+ "threatEntryType": "A String", # The threat entry type matching this threat.
+ "cacheDuration": "A String", # The cache lifetime for the returned match. Clients must not cache this
+ # response for more than this duration to avoid false positives.
},
],
}</pre>