Google Cloud Web Risk V1 Client - Class ComputeThreatListDiffResponse (1.4.3)

Reference documentation and code samples for the Google Cloud Web Risk V1 Client class ComputeThreatListDiffResponse.

Generated from protobuf message google.cloud.webrisk.v1.ComputeThreatListDiffResponse

Namespace

Google \ Cloud \ WebRisk \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ response_type int

The type of response. This may indicate that an action must be taken by the client when the response is received.

↳ additions Google\Cloud\WebRisk\V1\ThreatEntryAdditions

A set of entries to add to a local threat type's list.

↳ removals Google\Cloud\WebRisk\V1\ThreatEntryRemovals

A set of entries to remove from a local threat type's list. This field may be empty.

↳ new_version_token string

The new opaque client version token. This should be retained by the client and passed into the next call of ComputeThreatListDiff as 'version_token'. A separate version token should be stored and used for each threatList.

↳ checksum Google\Cloud\WebRisk\V1\ComputeThreatListDiffResponse\Checksum

The expected SHA256 hash of the client state; that is, of the sorted list of all hashes present in the database after applying the provided diff. If the client state doesn't match the expected state, the client must discard this diff and retry later.

↳ recommended_next_diff Google\Protobuf\Timestamp

The soonest the client should wait before issuing any diff request. Querying sooner is unlikely to produce a meaningful diff. Waiting longer is acceptable considering the use case. If this field is not set clients may update as soon as they want.

getResponseType

The type of response. This may indicate that an action must be taken by the client when the response is received.

Returns
TypeDescription
int

setResponseType

The type of response. This may indicate that an action must be taken by the client when the response is received.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getAdditions

A set of entries to add to a local threat type's list.

Returns
TypeDescription
Google\Cloud\WebRisk\V1\ThreatEntryAdditions|null

hasAdditions

clearAdditions

setAdditions

A set of entries to add to a local threat type's list.

Parameter
NameDescription
var Google\Cloud\WebRisk\V1\ThreatEntryAdditions
Returns
TypeDescription
$this

getRemovals

A set of entries to remove from a local threat type's list.

This field may be empty.

Returns
TypeDescription
Google\Cloud\WebRisk\V1\ThreatEntryRemovals|null

hasRemovals

clearRemovals

setRemovals

A set of entries to remove from a local threat type's list.

This field may be empty.

Parameter
NameDescription
var Google\Cloud\WebRisk\V1\ThreatEntryRemovals
Returns
TypeDescription
$this

getNewVersionToken

The new opaque client version token. This should be retained by the client and passed into the next call of ComputeThreatListDiff as 'version_token'.

A separate version token should be stored and used for each threatList.

Returns
TypeDescription
string

setNewVersionToken

The new opaque client version token. This should be retained by the client and passed into the next call of ComputeThreatListDiff as 'version_token'.

A separate version token should be stored and used for each threatList.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getChecksum

The expected SHA256 hash of the client state; that is, of the sorted list of all hashes present in the database after applying the provided diff.

If the client state doesn't match the expected state, the client must discard this diff and retry later.

Returns
TypeDescription
Google\Cloud\WebRisk\V1\ComputeThreatListDiffResponse\Checksum|null

hasChecksum

clearChecksum

setChecksum

The expected SHA256 hash of the client state; that is, of the sorted list of all hashes present in the database after applying the provided diff.

If the client state doesn't match the expected state, the client must discard this diff and retry later.

Parameter
NameDescription
var Google\Cloud\WebRisk\V1\ComputeThreatListDiffResponse\Checksum
Returns
TypeDescription
$this

getRecommendedNextDiff

The soonest the client should wait before issuing any diff request. Querying sooner is unlikely to produce a meaningful diff.

Waiting longer is acceptable considering the use case. If this field is not set clients may update as soon as they want.

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasRecommendedNextDiff

clearRecommendedNextDiff

setRecommendedNextDiff

The soonest the client should wait before issuing any diff request. Querying sooner is unlikely to produce a meaningful diff.

Waiting longer is acceptable considering the use case. If this field is not set clients may update as soon as they want.

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this