Google Cloud Model Armor V1beta Client - Class VirusScanFilterResult (0.4.0)

Reference documentation and code samples for the Google Cloud Model Armor V1beta Client class VirusScanFilterResult.

Virus scan results.

Generated from protobuf message google.cloud.modelarmor.v1beta.VirusScanFilterResult

Namespace

Google \ Cloud \ ModelArmor \ V1beta

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ execution_state int

Output only. Reports whether Virus Scan was successfully executed or not.

↳ message_items array<MessageItem>

Optional messages corresponding to the result. A message can provide warnings or error details. For example, if execution status is skipped then this field provides related reason/explanation.

↳ match_state int

Output only. Match status for Virus. Value is MATCH_FOUND if the data is infected with a virus.

↳ scanned_content_type int

Type of content scanned.

↳ scanned_size int|string

Size of scanned content in bytes.

↳ virus_details array<VirusDetail>

List of Viruses identified. This field will be empty if no virus was detected.

getExecutionState

Output only. Reports whether Virus Scan was successfully executed or not.

Returns
Type Description
int

setExecutionState

Output only. Reports whether Virus Scan was successfully executed or not.

Parameter
Name Description
var int
Returns
Type Description
$this

getMessageItems

Optional messages corresponding to the result.

A message can provide warnings or error details. For example, if execution status is skipped then this field provides related reason/explanation.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setMessageItems

Optional messages corresponding to the result.

A message can provide warnings or error details. For example, if execution status is skipped then this field provides related reason/explanation.

Parameter
Name Description
var array<MessageItem>
Returns
Type Description
$this

getMatchState

Output only. Match status for Virus.

Value is MATCH_FOUND if the data is infected with a virus.

Returns
Type Description
int

setMatchState

Output only. Match status for Virus.

Value is MATCH_FOUND if the data is infected with a virus.

Parameter
Name Description
var int
Returns
Type Description
$this

getScannedContentType

Type of content scanned.

Returns
Type Description
int

setScannedContentType

Type of content scanned.

Parameter
Name Description
var int
Returns
Type Description
$this

getScannedSize

Size of scanned content in bytes.

Returns
Type Description
int|string

hasScannedSize

clearScannedSize

setScannedSize

Size of scanned content in bytes.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getVirusDetails

List of Viruses identified.

This field will be empty if no virus was detected.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setVirusDetails

List of Viruses identified.

This field will be empty if no virus was detected.

Parameter
Name Description
var array<VirusDetail>
Returns
Type Description
$this