GoogleApi.WebRisk.V1.Api.Hashes (google_api_web_risk v0.2.0) View Source

API calls for all endpoints tagged Hashes.

Link to this section Summary

Functions

Gets the full hashes that match the requested hash prefix. This is used after a hash prefix is looked up in a threatList and there is a match. The client side threatList only holds partial hashes so the client must query this method to determine if there is a full hash match of a threat.

Link to this section Functions

Link to this function

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

View Source

Specs

webrisk_hashes_search(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.WebRisk.V1.Model.GoogleCloudWebriskV1SearchHashesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Gets the full hashes that match the requested hash prefix. This is used after a hash prefix is looked up in a threatList and there is a match. The client side threatList only holds partial hashes so the client must query this method to determine if there is a full hash match of a threat.

Parameters

  • connection (type: GoogleApi.WebRisk.V1.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").
    • :hashPrefix (type: String.t) - A hash prefix, consisting of the most significant 4-32 bytes of a SHA256 hash. For JSON requests, this field is base64-encoded. Note that if this parameter is provided by a URI, it must be encoded using the web safe base64 variant (RFC 4648).
    • :threatTypes (type: list(String.t)) - Required. The ThreatLists to search in. Multiple ThreatLists may be specified.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.WebRisk.V1.Model.GoogleCloudWebriskV1SearchHashesResponse{}} on success
  • {:error, info} on failure