Grafeas V1 Client - Class Note (1.2.2)

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

A type of analysis that can be done for a resource.

Generated from protobuf message grafeas.v1.Note

Namespace

Grafeas \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

Output only. The name of the note in the form of projects/[PROVIDER_ID]/notes/[NOTE_ID] .

↳ short_description
string

A one sentence description of this note.

↳ long_description
string

A detailed description of this note.

↳ kind
int

Output only. The type of analysis. This field can be used as a filter in list requests.

↳ related_url
array< RelatedUrl >

URLs associated with this note.

↳ expiration_time
Google\Protobuf\Timestamp

Time of expiration for this note. Empty if note does not expire.

↳ create_time
Google\Protobuf\Timestamp

Output only. The time this note was created. This field can be used as a filter in list requests.

↳ update_time
Google\Protobuf\Timestamp

Output only. The time this note was last updated. This field can be used as a filter in list requests.

↳ related_note_names
array

Other notes related to this note.

↳ vulnerability
VulnerabilityNote

A note describing a package vulnerability.

↳ build
BuildNote

A note describing build provenance for a verifiable build.

↳ image
ImageNote

A note describing a base image.

↳ package
PackageNote

A note describing a package hosted by various package managers.

↳ deployment
DeploymentNote

A note describing something that can be deployed.

↳ discovery
DiscoveryNote

A note describing the initial analysis of a resource.

↳ attestation
AttestationNote

A note describing an attestation role.

↳ upgrade
UpgradeNote

A note describing available package upgrades.

↳ compliance
ComplianceNote

A note describing a compliance check.

↳ dsse_attestation
DSSEAttestationNote

A note describing a dsse attestation note.

↳ vulnerability_assessment
VulnerabilityAssessmentNote

A note describing a vulnerability assessment.

↳ sbom_reference
SBOMReferenceNote

A note describing an SBOM reference.

↳ secret
SecretNote

A note describing a secret.

getName

Output only. The name of the note in the form of projects/[PROVIDER_ID]/notes/[NOTE_ID] .

Returns
Type
Description
string

setName

Output only. The name of the note in the form of projects/[PROVIDER_ID]/notes/[NOTE_ID] .

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getShortDescription

A one sentence description of this note.

Returns
Type
Description
string

setShortDescription

A one sentence description of this note.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getLongDescription

A detailed description of this note.

Returns
Type
Description
string

setLongDescription

A detailed description of this note.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getKind

Output only. The type of analysis. This field can be used as a filter in list requests.

Returns
Type
Description
int

setKind

Output only. The type of analysis. This field can be used as a filter in list requests.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getRelatedUrl

URLs associated with this note.

Returns
Type
Description

setRelatedUrl

URLs associated with this note.

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

getExpirationTime

Time of expiration for this note. Empty if note does not expire.

Returns
Type
Description

hasExpirationTime

clearExpirationTime

setExpirationTime

Time of expiration for this note. Empty if note does not expire.

Parameter
Name
Description
Returns
Type
Description
$this

getCreateTime

Output only. The time this note was created. This field can be used as a filter in list requests.

Returns
Type
Description

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time this note was created. This field can be used as a filter in list requests.

Parameter
Name
Description
Returns
Type
Description
$this

getUpdateTime

Output only. The time this note was last updated. This field can be used as a filter in list requests.

Returns
Type
Description

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time this note was last updated. This field can be used as a filter in list requests.

Parameter
Name
Description
Returns
Type
Description
$this

getRelatedNoteNames

Other notes related to this note.

Returns
Type
Description

setRelatedNoteNames

Other notes related to this note.

Parameter
Name
Description
var
string[]
Returns
Type
Description
$this

getVulnerability

A note describing a package vulnerability.

Returns
Type
Description

hasVulnerability

setVulnerability

A note describing a package vulnerability.

Parameter
Name
Description
Returns
Type
Description
$this

getBuild

A note describing build provenance for a verifiable build.

Returns
Type
Description
BuildNote |null

hasBuild

setBuild

A note describing build provenance for a verifiable build.

Parameter
Name
Description
var
Returns
Type
Description
$this

getImage

A note describing a base image.

Returns
Type
Description
ImageNote |null

hasImage

setImage

A note describing a base image.

Parameter
Name
Description
var
Returns
Type
Description
$this

getPackage

A note describing a package hosted by various package managers.

Returns
Type
Description
PackageNote |null

hasPackage

setPackage

A note describing a package hosted by various package managers.

Parameter
Name
Description
Returns
Type
Description
$this

getDeployment

A note describing something that can be deployed.

Returns
Type
Description

hasDeployment

setDeployment

A note describing something that can be deployed.

Parameter
Name
Description
Returns
Type
Description
$this

getDiscovery

A note describing the initial analysis of a resource.

Returns
Type
Description

hasDiscovery

setDiscovery

A note describing the initial analysis of a resource.

Parameter
Name
Description
Returns
Type
Description
$this

getAttestation

A note describing an attestation role.

Returns
Type
Description

hasAttestation

setAttestation

A note describing an attestation role.

Parameter
Name
Description
Returns
Type
Description
$this

getUpgrade

A note describing available package upgrades.

Returns
Type
Description
UpgradeNote |null

hasUpgrade

setUpgrade

A note describing available package upgrades.

Parameter
Name
Description
Returns
Type
Description
$this

getCompliance

A note describing a compliance check.

Returns
Type
Description

hasCompliance

setCompliance

A note describing a compliance check.

Parameter
Name
Description
Returns
Type
Description
$this

getDsseAttestation

A note describing a dsse attestation note.

Returns
Type
Description

hasDsseAttestation

setDsseAttestation

A note describing a dsse attestation note.

Parameter
Name
Description
Returns
Type
Description
$this

getVulnerabilityAssessment

A note describing a vulnerability assessment.

Returns
Type
Description

hasVulnerabilityAssessment

setVulnerabilityAssessment

A note describing a vulnerability assessment.

Parameter
Name
Description
Returns
Type
Description
$this

getSbomReference

A note describing an SBOM reference.

Returns
Type
Description

hasSbomReference

setSbomReference

A note describing an SBOM reference.

Parameter
Name
Description
Returns
Type
Description
$this

getSecret

A note describing a secret.

Returns
Type
Description
SecretNote |null

hasSecret

setSecret

A note describing a secret.

Parameter
Name
Description
Returns
Type
Description
$this

getType

Returns
Type
Description
string
Design a Mobile Site
View Site in Mobile | Classic
Share by: