Grafeas V1 Client - Class ComplianceNote (0.10.3)

Version latest

• 0.10.3 (latest)
• 0.10.2
• 0.9.0
• 0.8.3
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.4

Reference documentation and code samples for the Grafeas V1 Client class ComplianceNote.

Generated from protobuf message grafeas.v1.ComplianceNote

Namespace

Grafeas \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ title	string The title that identifies this compliance check.
↳ description	string A description about this compliance check.
↳ version	array<Grafeas\V1\ComplianceVersion> The OS and config versions the benchmark applies to.
↳ rationale	string A rationale for the existence of this compliance check.
↳ remediation	string A description of remediation steps if the compliance check fails.
↳ cis_benchmark	Grafeas\V1\ComplianceNote\CisBenchmark
↳ scan_instructions	string Serialized scan instructions with a predefined format.
↳ impact	string

getTitle

The title that identifies this compliance check.

Returns
Type	Description
string

setTitle

The title that identifies this compliance check.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDescription

A description about this compliance check.

Returns
Type	Description
string

setDescription

A description about this compliance check.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getVersion

The OS and config versions the benchmark applies to.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setVersion

The OS and config versions the benchmark applies to.

Parameter
Name	Description
var	array<Grafeas\V1\ComplianceVersion>

Returns
Type	Description
$this

getRationale

A rationale for the existence of this compliance check.

Returns
Type	Description
string

setRationale

A rationale for the existence of this compliance check.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getRemediation

A description of remediation steps if the compliance check fails.

Returns
Type	Description
string

setRemediation

A description of remediation steps if the compliance check fails.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getCisBenchmark

Generated from protobuf field .grafeas.v1.ComplianceNote.CisBenchmark cis_benchmark = 6;

Returns
Type	Description
Grafeas\V1\ComplianceNote\CisBenchmark|null

hasCisBenchmark

setCisBenchmark

Generated from protobuf field .grafeas.v1.ComplianceNote.CisBenchmark cis_benchmark = 6;

Parameter
Name	Description
var	Grafeas\V1\ComplianceNote\CisBenchmark

Returns
Type	Description
$this

getScanInstructions

Serialized scan instructions with a predefined format.

Returns
Type	Description
string

setScanInstructions

Serialized scan instructions with a predefined format.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getImpact

Generated from protobuf field string impact = 8;

Returns
Type	Description
string

hasImpact

setImpact

Generated from protobuf field string impact = 8;

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getComplianceType

Returns
Type	Description
string

getPotentialImpact

Returns
Type	Description
string