Class: Google::Apis::ContaineranalysisV1::Note

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/containeranalysis_v1/classes.rb,
lib/google/apis/containeranalysis_v1/representations.rb,
lib/google/apis/containeranalysis_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Note

Returns a new instance of Note.



5322
5323
5324
 
# File 'lib/google/apis/containeranalysis_v1/classes.rb', line 5322

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#attestation ⇒ Google::Apis::ContaineranalysisV1::AttestationNote

Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one Authority for "QA" and one for " build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. Corresponds to the JSON property attestation

Returns:



5202
5203
5204
 
# File 'lib/google/apis/containeranalysis_v1/classes.rb', line 5202

def attestation
  @attestation
end

#build ⇒ Google::Apis::ContaineranalysisV1::BuildNote

Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence. Corresponds to the JSON property build

Returns:



5208
5209
5210
 
# File 'lib/google/apis/containeranalysis_v1/classes.rb', line 5208

def build
  @build
end

#compliance ⇒ Google::Apis::ContaineranalysisV1::ComplianceNote

A note describing a compliance check. Corresponds to the JSON property compliance

Returns:



5213
5214
5215
 
# File 'lib/google/apis/containeranalysis_v1/classes.rb', line 5213

def compliance
  @compliance
end

#create_time ⇒ String

Output only. The time this note was created. This field can be used as a filter in list requests. Corresponds to the JSON property createTime

Returns:

  • (String) 


5219
5220
5221
 
# File 'lib/google/apis/containeranalysis_v1/classes.rb', line 5219

def create_time
  @create_time
end

#deployment ⇒ Google::Apis::ContaineranalysisV1::DeploymentNote

An artifact that can be deployed in some runtime. Corresponds to the JSON property deployment

Returns:



5224
5225
5226
 
# File 'lib/google/apis/containeranalysis_v1/classes.rb', line 5224

def deployment
  @deployment
end

#discovery ⇒ Google::Apis::ContaineranalysisV1::DiscoveryNote

A note that indicates a type of analysis a provider would perform. This note exists in a provider's project. A Discovery occurrence is created in a consumer's project at the start of analysis. Corresponds to the JSON property discovery

Returns:



5231
5232
5233
 
# File 'lib/google/apis/containeranalysis_v1/classes.rb', line 5231

def discovery
  @discovery
end

#dsse_attestation ⇒ Google::Apis::ContaineranalysisV1::DsseAttestationNote

A note describing a dsse attestation note. Corresponds to the JSON property dsseAttestation

Returns:



5236
5237
5238
 
# File 'lib/google/apis/containeranalysis_v1/classes.rb', line 5236

def dsse_attestation
  @dsse_attestation
end

#expiration_time ⇒ String

Time of expiration for this note. Empty if note does not expire. Corresponds to the JSON property expirationTime

Returns:

  • (String) 


5241
5242
5243
 
# File 'lib/google/apis/containeranalysis_v1/classes.rb', line 5241

def expiration_time
  @expiration_time
end

#image ⇒ Google::Apis::ContaineranalysisV1::ImageNote

Basis describes the base image portion (Note) of the DockerImage relationship. Linked occurrences are derived from this or an equivalent image via: FROM Or an equivalent reference, e.g., a tag of the resource_url. Corresponds to the JSON property image

Returns:



5248
5249
5250
 
# File 'lib/google/apis/containeranalysis_v1/classes.rb', line 5248

def image
  @image
end

#kind ⇒ String

Output only. The type of analysis. This field can be used as a filter in list requests. Corresponds to the JSON property kind

Returns:

  • (String) 


5254
5255
5256
 
# File 'lib/google/apis/containeranalysis_v1/classes.rb', line 5254

def kind
  @kind
end

#long_description ⇒ String

A detailed description of this note. Corresponds to the JSON property longDescription

Returns:

  • (String) 


5259
5260
5261
 
# File 'lib/google/apis/containeranalysis_v1/classes.rb', line 5259

def long_description
  @long_description
end

#name ⇒ String

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

Returns:

  • (String) 


5265
5266
5267
 
# File 'lib/google/apis/containeranalysis_v1/classes.rb', line 5265

def name
  @name
end

#package ⇒ Google::Apis::ContaineranalysisV1::PackageNote

PackageNote represents a particular package version. Corresponds to the JSON property package

Returns:



5270
5271
5272
 
# File 'lib/google/apis/containeranalysis_v1/classes.rb', line 5270

def package
  @package
end

#related_note_names ⇒ Array<String>

Other notes related to this note. Corresponds to the JSON property relatedNoteNames

Returns:

  • (Array<String>) 


5275
5276
5277
 
# File 'lib/google/apis/containeranalysis_v1/classes.rb', line 5275

def related_note_names
  @related_note_names
end

#related_url ⇒ Array<Google::Apis::ContaineranalysisV1::RelatedUrl>

URLs associated with this note. Corresponds to the JSON property relatedUrl

Returns:



5280
5281
5282
 
# File 'lib/google/apis/containeranalysis_v1/classes.rb', line 5280

def related_url
  @related_url
end

#sbom_reference ⇒ Google::Apis::ContaineranalysisV1::SbomReferenceNote

The note representing an SBOM reference. Corresponds to the JSON property sbomReference

Returns:



5285
5286
5287
 
# File 'lib/google/apis/containeranalysis_v1/classes.rb', line 5285

def sbom_reference
  @sbom_reference
end

#secret ⇒ Google::Apis::ContaineranalysisV1::SecretNote

The note representing a secret. Corresponds to the JSON property secret

Returns:



5290
5291
5292
 
# File 'lib/google/apis/containeranalysis_v1/classes.rb', line 5290

def secret
  @secret
end

#short_description ⇒ String

A one sentence description of this note. Corresponds to the JSON property shortDescription

Returns:

  • (String) 


5295
5296
5297
 
# File 'lib/google/apis/containeranalysis_v1/classes.rb', line 5295

def short_description
  @short_description
end

#update_time ⇒ String

Output only. The time this note was last updated. This field can be used as a filter in list requests. Corresponds to the JSON property updateTime

Returns:

  • (String) 


5301
5302
5303
 
# File 'lib/google/apis/containeranalysis_v1/classes.rb', line 5301

def update_time
  @update_time
end

#upgrade ⇒ Google::Apis::ContaineranalysisV1::UpgradeNote

An Upgrade Note represents a potential upgrade of a package to a given version. For each package version combination (i.e. bash 4.0, bash 4.1, bash 4.1.2), there will be an Upgrade Note. For Windows, windows_update field represents the information related to the update. Corresponds to the JSON property upgrade

Returns:



5309
5310
5311
 
# File 'lib/google/apis/containeranalysis_v1/classes.rb', line 5309

def upgrade
  @upgrade
end

#vulnerability ⇒ Google::Apis::ContaineranalysisV1::VulnerabilityNote

A security vulnerability that can be found in resources. Corresponds to the JSON property vulnerability

Returns:



5314
5315
5316
 
# File 'lib/google/apis/containeranalysis_v1/classes.rb', line 5314

def vulnerability
  @vulnerability
end

#vulnerability_assessment ⇒ Google::Apis::ContaineranalysisV1::VulnerabilityAssessmentNote

A single VulnerabilityAssessmentNote represents one particular product's vulnerability assessment for one CVE. Corresponds to the JSON property vulnerabilityAssessment

Returns:



5320
5321
5322
 
# File 'lib/google/apis/containeranalysis_v1/classes.rb', line 5320

def vulnerability_assessment
  @vulnerability_assessment
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
 
# File 'lib/google/apis/containeranalysis_v1/classes.rb', line 5327

def update!(**args)
  @attestation = args[:attestation] if args.key?(:attestation)
  @build = args[:build] if args.key?(:build)
  @compliance = args[:compliance] if args.key?(:compliance)
  @create_time = args[:create_time] if args.key?(:create_time)
  @deployment = args[:deployment] if args.key?(:deployment)
  @discovery = args[:discovery] if args.key?(:discovery)
  @dsse_attestation = args[:dsse_attestation] if args.key?(:dsse_attestation)
  @expiration_time = args[:expiration_time] if args.key?(:expiration_time)
  @image = args[:image] if args.key?(:image)
  @kind = args[:kind] if args.key?(:kind)
  @long_description = args[:long_description] if args.key?(:long_description)
  @name = args[:name] if args.key?(:name)
  @package = args[:package] if args.key?(:package)
  @related_note_names = args[:related_note_names] if args.key?(:related_note_names)
  @related_url = args[:related_url] if args.key?(:related_url)
  @sbom_reference = args[:sbom_reference] if args.key?(:sbom_reference)
  @secret = args[:secret] if args.key?(:secret)
  @short_description = args[:short_description] if args.key?(:short_description)
  @update_time = args[:update_time] if args.key?(:update_time)
  @upgrade = args[:upgrade] if args.key?(:upgrade)
  @vulnerability = args[:vulnerability] if args.key?(:vulnerability)
  @vulnerability_assessment = args[:vulnerability_assessment] if args.key?(:vulnerability_assessment)
end