Class: Google::Apis::ContaineranalysisV1beta1::Note

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/containeranalysis_v1beta1/classes.rb,
lib/google/apis/containeranalysis_v1beta1/representations.rb,
lib/google/apis/containeranalysis_v1beta1/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.



5318
5319
5320
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5318

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

Instance Attribute Details

#attestation_authority ⇒ Google::Apis::ContaineranalysisV1beta1::Authority

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 attestationAuthority

Returns:



5186
5187
5188
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5186

def attestation_authority
  @attestation_authority
end

#base_image ⇒ Google::Apis::ContaineranalysisV1beta1::Basis

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 baseImage

Returns:



5193
5194
5195
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5193

def base_image
  @base_image
end

#build ⇒ Google::Apis::ContaineranalysisV1beta1::Build

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:



5199
5200
5201
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5199

def build
  @build
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) 


5205
5206
5207
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5205

def create_time
  @create_time
end

#deployable ⇒ Google::Apis::ContaineranalysisV1beta1::Deployable

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

Returns:



5210
5211
5212
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5210

def deployable
  @deployable
end

#discovery ⇒ Google::Apis::ContaineranalysisV1beta1::Discovery

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:



5217
5218
5219
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5217

def discovery
  @discovery
end

#expiration_time ⇒ String

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

Returns:

  • (String) 


5222
5223
5224
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5222

def expiration_time
  @expiration_time
end

#intoto ⇒ Google::Apis::ContaineranalysisV1beta1::InToto

This contains the fields corresponding to the definition of a software supply chain step in an in-toto layout. This information goes into a Grafeas note. Corresponds to the JSON property intoto

Returns:



5228
5229
5230
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5228

def intoto
  @intoto
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) 


5234
5235
5236
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5234

def kind
  @kind
end

#long_description ⇒ String

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

Returns:

  • (String) 


5239
5240
5241
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5239

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) 


5245
5246
5247
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5245

def name
  @name
end

#package ⇒ Google::Apis::ContaineranalysisV1beta1::Package

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

Returns:



5250
5251
5252
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5250

def package
  @package
end

#related_note_names ⇒ Array<String>

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

Returns:

  • (Array<String>) 


5255
5256
5257
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5255

def related_note_names
  @related_note_names
end

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

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

Returns:



5260
5261
5262
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5260

def related_url
  @related_url
end

#sbom ⇒ Google::Apis::ContaineranalysisV1beta1::DocumentNote

DocumentNote represents an SPDX Document Creation Information section: https:// spdx.github.io/spdx-spec/2-document-creation-information/ Corresponds to the JSON property sbom

Returns:



5266
5267
5268
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5266

def sbom
  @sbom
end

#sbom_reference ⇒ Google::Apis::ContaineranalysisV1beta1::SbomReferenceNote

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

Returns:



5271
5272
5273
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5271

def sbom_reference
  @sbom_reference
end

#secret ⇒ Google::Apis::ContaineranalysisV1beta1::SecretNote

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

Returns:



5276
5277
5278
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5276

def secret
  @secret
end

#short_description ⇒ String

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

Returns:

  • (String) 


5281
5282
5283
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5281

def short_description
  @short_description
end

#spdx_file ⇒ Google::Apis::ContaineranalysisV1beta1::FileNote

FileNote represents an SPDX File Information section: https://spdx.github.io/ spdx-spec/4-file-information/ Corresponds to the JSON property spdxFile

Returns:



5287
5288
5289
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5287

def spdx_file
  @spdx_file
end

#spdx_package ⇒ Google::Apis::ContaineranalysisV1beta1::PackageInfoNote

PackageInfoNote represents an SPDX Package Information section: https://spdx. github.io/spdx-spec/3-package-information/ Corresponds to the JSON property spdxPackage

Returns:



5293
5294
5295
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5293

def spdx_package
  @spdx_package
end

#spdx_relationship ⇒ Google::Apis::ContaineranalysisV1beta1::RelationshipNote

RelationshipNote represents an SPDX Relationship section: https://spdx.github. io/spdx-spec/7-relationships-between-SPDX-elements/ Corresponds to the JSON property spdxRelationship

Returns:



5299
5300
5301
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5299

def spdx_relationship
  @spdx_relationship
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) 


5305
5306
5307
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5305

def update_time
  @update_time
end

#vulnerability ⇒ Google::Apis::ContaineranalysisV1beta1::Vulnerability

Vulnerability provides metadata about a security vulnerability in a Note. Corresponds to the JSON property vulnerability

Returns:



5310
5311
5312
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5310

def vulnerability
  @vulnerability
end

#vulnerability_assessment ⇒ Google::Apis::ContaineranalysisV1beta1::VulnerabilityAssessmentNote

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

Returns:



5316
5317
5318
 
# File 'lib/google/apis/containeranalysis_v1beta1/classes.rb', line 5316

def vulnerability_assessment
  @vulnerability_assessment
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



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

def update!(**args)
  @attestation_authority = args[:attestation_authority] if args.key?(:attestation_authority)
  @base_image = args[:base_image] if args.key?(:base_image)
  @build = args[:build] if args.key?(:build)
  @create_time = args[:create_time] if args.key?(:create_time)
  @deployable = args[:deployable] if args.key?(:deployable)
  @discovery = args[:discovery] if args.key?(:discovery)
  @expiration_time = args[:expiration_time] if args.key?(:expiration_time)
  @intoto = args[:intoto] if args.key?(:intoto)
  @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 = args[:sbom] if args.key?(:sbom)
  @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)
  @spdx_file = args[:spdx_file] if args.key?(:spdx_file)
  @spdx_package = args[:spdx_package] if args.key?(:spdx_package)
  @spdx_relationship = args[:spdx_relationship] if args.key?(:spdx_relationship)
  @update_time = args[:update_time] if args.key?(:update_time)
  @vulnerability = args[:vulnerability] if args.key?(:vulnerability)
  @vulnerability_assessment = args[:vulnerability_assessment] if args.key?(:vulnerability_assessment)
end