Reference documentation and code samples for the Google Cloud Web Risk V1 Client class ComputeThreatListDiffResponse.
Generated from protobuf message google.cloud.webrisk.v1.ComputeThreatListDiffResponse
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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 | |
|---|---|
| Type | Description |
int | |
setResponseType
The type of response. This may indicate that an action must be taken by the client when the response is received.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAdditions
A set of entries to add to a local threat type's list.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\WebRisk\V1\ThreatEntryAdditions|null | |
hasAdditions
clearAdditions
setAdditions
A set of entries to add to a local threat type's list.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\WebRisk\V1\ThreatEntryAdditions
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRemovals
A set of entries to remove from a local threat type's list.
This field may be empty.
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
Google\Cloud\WebRisk\V1\ThreatEntryRemovals
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
Google\Cloud\WebRisk\V1\ComputeThreatListDiffResponse\Checksum
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |