View Source GoogleApi.SafeBrowsing.V5.Api.Hashes (google_api_safe_browsing v0.25.0)

API calls for all endpoints tagged Hashes.

Summary

Functions

Search for full hashes matching the specified prefixes. This is a custom method as defined by https://google.aip.dev/136 (the custom method refers to this method having a custom name within Google's general API development nomenclature; it does not refer to using a custom HTTP method).

Functions

Link to this function

safebrowsing_hashes_search(connection, optional_params \\ [], opts \\ [])

View Source
@spec safebrowsing_hashes_search(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok,
   GoogleApi.SafeBrowsing.V5.Model.GoogleSecuritySafebrowsingV5SearchHashesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Search for full hashes matching the specified prefixes. This is a custom method as defined by https://google.aip.dev/136 (the custom method refers to this method having a custom name within Google's general API development nomenclature; it does not refer to using a custom HTTP method).

Parameters

  • connection (type: GoogleApi.SafeBrowsing.V5.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :hashPrefixes (type: list(String.t)) - Required. The hash prefixes to be looked up. Clients MUST NOT send more than 1000 hash prefixes. However, following the URL processing procedure, clients SHOULD NOT need to send more than 30 hash prefixes. Currently each hash prefix is required to be exactly 4 bytes long. This MAY be relaxed in the future.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.SafeBrowsing.V5.Model.GoogleSecuritySafebrowsingV5SearchHashesResponse{}} on success
  • {:error, info} on failure