OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-02-23 15:49:49 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
37ba635de2b0340299e6a35431c2efd0ca3aa555
google-apis-rs/google_safebrowsing4/api/index.html
Sebastian Thiel 37ba635de2 Update documentation
2021-04-02 00:20:57 +08:00

56 lines
19 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `api` mod in crate `google_safebrowsing4`."><meta name="keywords" content="rust, rustlang, rust-lang, api"><title>google_safebrowsing4::api - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../../google_safebrowsing4/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Module api</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li></ul></div><p class="location"><a href="../index.html">google_safebrowsing4</a></p><div id="sidebar-vars" data-name="api" data-ty="mod" data-relpath="../"></div><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">google_safebrowsing4</a>::<wbr><a class="mod" href="">api</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span><a class="srclink" href="../../src/google_safebrowsing4/api.rs.html#1-2750" title="goto source code">[src]</a></span></h1><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
<table><tr class="module-item"><td><a class="struct" href="struct.EncodedFullHasheGetCall.html" title="google_safebrowsing4::api::EncodedFullHasheGetCall struct">EncodedFullHasheGetCall</a></td><td class="docblock-short"><p>A builder for the <em>get</em> method supported by a <em>encodedFullHashe</em> resource.
It is not used directly, but through a <code>EncodedFullHasheMethods</code> instance.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.EncodedFullHasheMethods.html" title="google_safebrowsing4::api::EncodedFullHasheMethods struct">EncodedFullHasheMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>encodedFullHashe</em> resources.
It is not used directly, but through the <code>Safebrowsing</code> hub.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.EncodedUpdateGetCall.html" title="google_safebrowsing4::api::EncodedUpdateGetCall struct">EncodedUpdateGetCall</a></td><td class="docblock-short"><p>A builder for the <em>get</em> method supported by a <em>encodedUpdate</em> resource.
It is not used directly, but through a <code>EncodedUpdateMethods</code> instance.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.EncodedUpdateMethods.html" title="google_safebrowsing4::api::EncodedUpdateMethods struct">EncodedUpdateMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>encodedUpdate</em> resources.
It is not used directly, but through the <code>Safebrowsing</code> hub.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.FullHasheFindCall.html" title="google_safebrowsing4::api::FullHasheFindCall struct">FullHasheFindCall</a></td><td class="docblock-short"><p>Finds the full hashes that match the requested hash prefixes.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.FullHasheMethods.html" title="google_safebrowsing4::api::FullHasheMethods struct">FullHasheMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>fullHashe</em> resources.
It is not used directly, but through the <code>Safebrowsing</code> hub.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleProtobufEmpty.html" title="google_safebrowsing4::api::GoogleProtobufEmpty struct">GoogleProtobufEmpty</a></td><td class="docblock-short"><p>A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for <code>Empty</code> is empty JSON object <code>{}</code>.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleSecuritySafebrowsingV4Checksum.html" title="google_safebrowsing4::api::GoogleSecuritySafebrowsingV4Checksum struct">GoogleSecuritySafebrowsingV4Checksum</a></td><td class="docblock-short"><p>The expected state of a client's local database.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleSecuritySafebrowsingV4ClientInfo.html" title="google_safebrowsing4::api::GoogleSecuritySafebrowsingV4ClientInfo struct">GoogleSecuritySafebrowsingV4ClientInfo</a></td><td class="docblock-short"><p>The client metadata associated with Safe Browsing API requests.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleSecuritySafebrowsingV4FetchThreatListUpdatesRequest.html" title="google_safebrowsing4::api::GoogleSecuritySafebrowsingV4FetchThreatListUpdatesRequest struct">GoogleSecuritySafebrowsingV4FetchThreatListUpdatesRequest</a></td><td class="docblock-short"><p>Describes a Safe Browsing API update request. Clients can request updates for multiple lists in a single request. The server may not respond to all requests, if the server has no updates for that list. NOTE: Field index 2 is unused. NEXT: 5</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleSecuritySafebrowsingV4FetchThreatListUpdatesRequestListUpdateRequest.html" title="google_safebrowsing4::api::GoogleSecuritySafebrowsingV4FetchThreatListUpdatesRequestListUpdateRequest struct">GoogleSecuritySafebrowsingV4FetchThreatListUpdatesRequestListUpdateRequest</a></td><td class="docblock-short"><p>A single list update request.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleSecuritySafebrowsingV4FetchThreatListUpdatesRequestListUpdateRequestConstraints.html" title="google_safebrowsing4::api::GoogleSecuritySafebrowsingV4FetchThreatListUpdatesRequestListUpdateRequestConstraints struct">GoogleSecuritySafebrowsingV4FetchThreatListUpdatesRequestListUpdateRequestConstraints</a></td><td class="docblock-short"><p>The constraints for this update.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponse.html" title="google_safebrowsing4::api::GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponse struct">GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponse</a></td><td class="docblock-short"><p>There is no detailed description.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponseListUpdateResponse.html" title="google_safebrowsing4::api::GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponseListUpdateResponse struct">GoogleSecuritySafebrowsingV4FetchThreatListUpdatesResponseListUpdateResponse</a></td><td class="docblock-short"><p>An update to an individual list.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleSecuritySafebrowsingV4FindFullHashesRequest.html" title="google_safebrowsing4::api::GoogleSecuritySafebrowsingV4FindFullHashesRequest struct">GoogleSecuritySafebrowsingV4FindFullHashesRequest</a></td><td class="docblock-short"><p>Request to return full hashes matched by the provided hash prefixes.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleSecuritySafebrowsingV4FindFullHashesResponse.html" title="google_safebrowsing4::api::GoogleSecuritySafebrowsingV4FindFullHashesResponse struct">GoogleSecuritySafebrowsingV4FindFullHashesResponse</a></td><td class="docblock-short"><p>There is no detailed description.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleSecuritySafebrowsingV4FindThreatMatchesRequest.html" title="google_safebrowsing4::api::GoogleSecuritySafebrowsingV4FindThreatMatchesRequest struct">GoogleSecuritySafebrowsingV4FindThreatMatchesRequest</a></td><td class="docblock-short"><p>Request to check entries against lists.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleSecuritySafebrowsingV4FindThreatMatchesResponse.html" title="google_safebrowsing4::api::GoogleSecuritySafebrowsingV4FindThreatMatchesResponse struct">GoogleSecuritySafebrowsingV4FindThreatMatchesResponse</a></td><td class="docblock-short"><p>There is no detailed description.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleSecuritySafebrowsingV4ListThreatListsResponse.html" title="google_safebrowsing4::api::GoogleSecuritySafebrowsingV4ListThreatListsResponse struct">GoogleSecuritySafebrowsingV4ListThreatListsResponse</a></td><td class="docblock-short"><p>There is no detailed description.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleSecuritySafebrowsingV4RawHashes.html" title="google_safebrowsing4::api::GoogleSecuritySafebrowsingV4RawHashes struct">GoogleSecuritySafebrowsingV4RawHashes</a></td><td class="docblock-short"><p>The uncompressed threat entries in hash format of a particular prefix length. Hashes can be anywhere from 4 to 32 bytes in size. A large majority are 4 bytes, but some hashes are lengthened if they collide with the hash of a popular URL. Used for sending ThreatEntrySet to clients that do not support compression, or when sending non-4-byte hashes to clients that do support compression.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleSecuritySafebrowsingV4RawIndices.html" title="google_safebrowsing4::api::GoogleSecuritySafebrowsingV4RawIndices struct">GoogleSecuritySafebrowsingV4RawIndices</a></td><td class="docblock-short"><p>A set of raw indices to remove from a local list.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleSecuritySafebrowsingV4RiceDeltaEncoding.html" title="google_safebrowsing4::api::GoogleSecuritySafebrowsingV4RiceDeltaEncoding struct">GoogleSecuritySafebrowsingV4RiceDeltaEncoding</a></td><td class="docblock-short"><p>The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or compressed removal indices.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleSecuritySafebrowsingV4ThreatEntry.html" title="google_safebrowsing4::api::GoogleSecuritySafebrowsingV4ThreatEntry struct">GoogleSecuritySafebrowsingV4ThreatEntry</a></td><td class="docblock-short"><p>An individual threat; for example, a malicious URL or its hash representation. Only one of these fields should be set.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleSecuritySafebrowsingV4ThreatEntryMetadata.html" title="google_safebrowsing4::api::GoogleSecuritySafebrowsingV4ThreatEntryMetadata struct">GoogleSecuritySafebrowsingV4ThreatEntryMetadata</a></td><td class="docblock-short"><p>The metadata associated with a specific threat entry. The client is expected to know the metadata key/value pairs associated with each threat type.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleSecuritySafebrowsingV4ThreatEntryMetadataMetadataEntry.html" title="google_safebrowsing4::api::GoogleSecuritySafebrowsingV4ThreatEntryMetadataMetadataEntry struct">GoogleSecuritySafebrowsingV4ThreatEntryMetadataMetadataEntry</a></td><td class="docblock-short"><p>A single metadata entry.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleSecuritySafebrowsingV4ThreatEntrySet.html" title="google_safebrowsing4::api::GoogleSecuritySafebrowsingV4ThreatEntrySet struct">GoogleSecuritySafebrowsingV4ThreatEntrySet</a></td><td class="docblock-short"><p>A set of threats that should be added or removed from a client's local database.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleSecuritySafebrowsingV4ThreatHit.html" title="google_safebrowsing4::api::GoogleSecuritySafebrowsingV4ThreatHit struct">GoogleSecuritySafebrowsingV4ThreatHit</a></td><td class="docblock-short"><p>There is no detailed description.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleSecuritySafebrowsingV4ThreatHitThreatSource.html" title="google_safebrowsing4::api::GoogleSecuritySafebrowsingV4ThreatHitThreatSource struct">GoogleSecuritySafebrowsingV4ThreatHitThreatSource</a></td><td class="docblock-short"><p>A single resource related to a threat hit.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleSecuritySafebrowsingV4ThreatHitUserInfo.html" title="google_safebrowsing4::api::GoogleSecuritySafebrowsingV4ThreatHitUserInfo struct">GoogleSecuritySafebrowsingV4ThreatHitUserInfo</a></td><td class="docblock-short"><p>Details about the user that encountered the threat.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleSecuritySafebrowsingV4ThreatInfo.html" title="google_safebrowsing4::api::GoogleSecuritySafebrowsingV4ThreatInfo struct">GoogleSecuritySafebrowsingV4ThreatInfo</a></td><td class="docblock-short"><p>The information regarding one or more threats that a client submits when checking for matches in threat lists.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleSecuritySafebrowsingV4ThreatListDescriptor.html" title="google_safebrowsing4::api::GoogleSecuritySafebrowsingV4ThreatListDescriptor struct">GoogleSecuritySafebrowsingV4ThreatListDescriptor</a></td><td class="docblock-short"><p>Describes an individual threat list. A list is defined by three parameters: the type of threat posed, the type of platform targeted by the threat, and the type of entries in the list.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleSecuritySafebrowsingV4ThreatMatch.html" title="google_safebrowsing4::api::GoogleSecuritySafebrowsingV4ThreatMatch struct">GoogleSecuritySafebrowsingV4ThreatMatch</a></td><td class="docblock-short"><p>A match when checking a threat entry in the Safe Browsing threat lists.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Safebrowsing.html" title="google_safebrowsing4::api::Safebrowsing struct">Safebrowsing</a></td><td class="docblock-short"><p>Central instance to access all Safebrowsing related resource activities</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ThreatHitCreateCall.html" title="google_safebrowsing4::api::ThreatHitCreateCall struct">ThreatHitCreateCall</a></td><td class="docblock-short"><p>Reports a Safe Browsing threat list hit to Google. Only projects with TRUSTED_REPORTER visibility can use this method.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ThreatHitMethods.html" title="google_safebrowsing4::api::ThreatHitMethods struct">ThreatHitMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>threatHit</em> resources.
It is not used directly, but through the <code>Safebrowsing</code> hub.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ThreatListListCall.html" title="google_safebrowsing4::api::ThreatListListCall struct">ThreatListListCall</a></td><td class="docblock-short"><p>Lists the Safe Browsing threat lists available for download.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ThreatListMethods.html" title="google_safebrowsing4::api::ThreatListMethods struct">ThreatListMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>threatList</em> resources.
It is not used directly, but through the <code>Safebrowsing</code> hub.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ThreatListUpdateFetchCall.html" title="google_safebrowsing4::api::ThreatListUpdateFetchCall struct">ThreatListUpdateFetchCall</a></td><td class="docblock-short"><p>Fetches the most recent threat list updates. A client can request updates for multiple lists at once.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ThreatListUpdateMethods.html" title="google_safebrowsing4::api::ThreatListUpdateMethods struct">ThreatListUpdateMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>threatListUpdate</em> resources.
It is not used directly, but through the <code>Safebrowsing</code> hub.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ThreatMatcheFindCall.html" title="google_safebrowsing4::api::ThreatMatcheFindCall struct">ThreatMatcheFindCall</a></td><td class="docblock-short"><p>Finds the threat entries that match the Safe Browsing lists.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ThreatMatcheMethods.html" title="google_safebrowsing4::api::ThreatMatcheMethods struct">ThreatMatcheMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>threatMatche</em> resources.
It is not used directly, but through the <code>Safebrowsing</code> hub.</p>
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="google_safebrowsing4"></div>
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
Reference in New Issue View Git Blame Copy Permalink