Class HashListsResource.BatchGetRequest

Get multiple hash lists at once. It is very common for a client to need to get multiple hash lists. Using this method is preferred over using the regular Get method multiple times. This is a standard batch Get method as defined by https://google.aip.dev/231 and the HTTP method is also GET.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<GoogleSecuritySafebrowsingV5BatchGetHashListsResponse>
SafebrowsingBaseServiceRequest<GoogleSecuritySafebrowsingV5BatchGetHashListsResponse>
HashListsResource.BatchGetRequest
Implements
Inherited Members
Namespace: Google.Apis.Safebrowsing.v5
Assembly: Google.Apis.Safebrowsing.v5.dll
Syntax
public class HashListsResource.BatchGetRequest : SafebrowsingBaseServiceRequest<GoogleSecuritySafebrowsingV5BatchGetHashListsResponse>, IClientServiceRequest<GoogleSecuritySafebrowsingV5BatchGetHashListsResponse>, IClientServiceRequest

Constructors

BatchGetRequest(IClientService)

Constructs a new BatchGet request.

Declaration
public BatchGetRequest(IClientService service)
Parameters
Type Name Description
IClientService service

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

Names

Required. The names of the particular hash lists. The list MAY be a threat list, or it may be the Global Cache. The names MUST NOT contain duplicates; if they did, the client will get an error.

Declaration
[RequestParameter("names", RequestParameterType.Query)]
public virtual Repeatable<string> Names { get; set; }
Property Value
Type Description
Repeatable<string>

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

SizeConstraintsMaxDatabaseEntries

Sets the maximum number of entries that the client is willing to have in the local database for the list. (The server MAY cause the client to store less than this number of entries.) If omitted or zero, no database size limit is set.

Declaration
[RequestParameter("sizeConstraints.maxDatabaseEntries", RequestParameterType.Query)]
public virtual int? SizeConstraintsMaxDatabaseEntries { get; set; }
Property Value
Type Description
int?

SizeConstraintsMaxUpdateEntries

The maximum size in number of entries. The update will not contain more entries than this value, but it is possible that the update will contain fewer entries than this value. This MUST be at least 1024. If omitted or zero, no update size limit is set.

Declaration
[RequestParameter("sizeConstraints.maxUpdateEntries", RequestParameterType.Query)]
public virtual int? SizeConstraintsMaxUpdateEntries { get; set; }
Property Value
Type Description
int?

Version

The versions of the hash list that the client already has. If this is the first time the client is fetching the hash lists, the field should be left empty. Otherwise, the client should supply the versions previously received from the server. The client MUST NOT manipulate those bytes. The client need not send the versions in the same order as the corresponding list names. The client may send fewer or more versions in a request than there are names. However the client MUST NOT send multiple versions that correspond to the same name; if it did, the client will get an error. Historical note: in V4 of the API, this was called states; it is now renamed to version for clarity.

Declaration
[RequestParameter("version", RequestParameterType.Query)]
public virtual Repeatable<string> Version { get; set; }
Property Value
Type Description
Repeatable<string>

Methods

InitParameters()

Initializes BatchGet parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements