target.apidocs.com.google.api.services.safebrowsing.v5.Safebrowsing.Hashes.Search.html Maven / Gradle / Ivy
Safebrowsing.Hashes.Search (Safe Browsing API v5-rev20240414-2.0.0)
com.google.api.services.safebrowsing.v5
Class Safebrowsing.Hashes.Search
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
-
- com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
-
- com.google.api.services.safebrowsing.v5.SafebrowsingRequest<GoogleSecuritySafebrowsingV5SearchHashesResponse>
-
- com.google.api.services.safebrowsing.v5.Safebrowsing.Hashes.Search
-
- Enclosing class:
- Safebrowsing.Hashes
public class Safebrowsing.Hashes.Search
extends SafebrowsingRequest<GoogleSecuritySafebrowsingV5SearchHashesResponse>
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Modifier
Constructor and Description
protected
Search()
Search for full hashes matching the specified prefixes.
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
com.google.api.client.http.HttpRequest
buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse
executeUsingHead()
List<String>
getHashPrefixes()
Required.
Safebrowsing.Hashes.Search
set(String parameterName,
Object value)
Safebrowsing.Hashes.Search
set$Xgafv(String $Xgafv)
V1 error format.
Safebrowsing.Hashes.Search
setAccessToken(String accessToken)
OAuth access token.
Safebrowsing.Hashes.Search
setAlt(String alt)
Data format for response.
Safebrowsing.Hashes.Search
setCallback(String callback)
JSONP
Safebrowsing.Hashes.Search
setFields(String fields)
Selector specifying which fields to include in a partial response.
Safebrowsing.Hashes.Search
setHashPrefixes(List<String> hashPrefixes)
Required.
Safebrowsing.Hashes.Search
setKey(String key)
API key.
Safebrowsing.Hashes.Search
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
Safebrowsing.Hashes.Search
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
Safebrowsing.Hashes.Search
setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.
Safebrowsing.Hashes.Search
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.
Safebrowsing.Hashes.Search
setUploadType(String uploadType)
Legacy upload protocol for media (e.g.
-
Methods inherited from class com.google.api.services.safebrowsing.v5.SafebrowsingRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders
-
Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue
-
Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream
-
Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString
-
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
Constructor Detail
-
Search
protected Search()
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).
Create a request for the method "hashes.search".
This request holds the parameters needed by the the safebrowsing server. After setting any
optional parameters, call the AbstractGoogleClientRequest.execute()
method to invoke the remote operation.
Safebrowsing.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest)
must
be called to initialize this instance immediately after invoking the constructor.
- Since:
- 1.13
-
Method Detail
-
executeUsingHead
public com.google.api.client.http.HttpResponse executeUsingHead()
throws IOException
- Overrides:
executeUsingHead
in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<GoogleSecuritySafebrowsingV5SearchHashesResponse>
- Throws:
IOException
-
buildHttpRequestUsingHead
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
throws IOException
- Overrides:
buildHttpRequestUsingHead
in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<GoogleSecuritySafebrowsingV5SearchHashesResponse>
- Throws:
IOException
-
set$Xgafv
public Safebrowsing.Hashes.Search set$Xgafv(String $Xgafv)
Description copied from class: SafebrowsingRequest
V1 error format.
- Overrides:
set$Xgafv
in class SafebrowsingRequest<GoogleSecuritySafebrowsingV5SearchHashesResponse>
-
setAccessToken
public Safebrowsing.Hashes.Search setAccessToken(String accessToken)
Description copied from class: SafebrowsingRequest
OAuth access token.
- Overrides:
setAccessToken
in class SafebrowsingRequest<GoogleSecuritySafebrowsingV5SearchHashesResponse>
-
setAlt
public Safebrowsing.Hashes.Search setAlt(String alt)
Description copied from class: SafebrowsingRequest
Data format for response.
- Overrides:
setAlt
in class SafebrowsingRequest<GoogleSecuritySafebrowsingV5SearchHashesResponse>
-
setCallback
public Safebrowsing.Hashes.Search setCallback(String callback)
Description copied from class: SafebrowsingRequest
JSONP
- Overrides:
setCallback
in class SafebrowsingRequest<GoogleSecuritySafebrowsingV5SearchHashesResponse>
-
setFields
public Safebrowsing.Hashes.Search setFields(String fields)
Description copied from class: SafebrowsingRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields
in class SafebrowsingRequest<GoogleSecuritySafebrowsingV5SearchHashesResponse>
-
setKey
public Safebrowsing.Hashes.Search setKey(String key)
Description copied from class: SafebrowsingRequest
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.
- Overrides:
setKey
in class SafebrowsingRequest<GoogleSecuritySafebrowsingV5SearchHashesResponse>
-
setOauthToken
public Safebrowsing.Hashes.Search setOauthToken(String oauthToken)
Description copied from class: SafebrowsingRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken
in class SafebrowsingRequest<GoogleSecuritySafebrowsingV5SearchHashesResponse>
-
setPrettyPrint
public Safebrowsing.Hashes.Search setPrettyPrint(Boolean prettyPrint)
Description copied from class: SafebrowsingRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint
in class SafebrowsingRequest<GoogleSecuritySafebrowsingV5SearchHashesResponse>
-
setQuotaUser
public Safebrowsing.Hashes.Search setQuotaUser(String quotaUser)
Description copied from class: SafebrowsingRequest
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.
- Overrides:
setQuotaUser
in class SafebrowsingRequest<GoogleSecuritySafebrowsingV5SearchHashesResponse>
-
setUploadType
public Safebrowsing.Hashes.Search setUploadType(String uploadType)
Description copied from class: SafebrowsingRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType
in class SafebrowsingRequest<GoogleSecuritySafebrowsingV5SearchHashesResponse>
-
setUploadProtocol
public Safebrowsing.Hashes.Search setUploadProtocol(String uploadProtocol)
Description copied from class: SafebrowsingRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol
in class SafebrowsingRequest<GoogleSecuritySafebrowsingV5SearchHashesResponse>
-
getHashPrefixes
public List<String> getHashPrefixes()
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.
-
setHashPrefixes
public Safebrowsing.Hashes.Search setHashPrefixes(List<String> hashPrefixes)
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.
-
set
public Safebrowsing.Hashes.Search set(String parameterName,
Object value)
- Overrides:
set
in class SafebrowsingRequest<GoogleSecuritySafebrowsingV5SearchHashesResponse>
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy