Class: Google::Apis::ContaineranalysisV1alpha1::Note

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

Overview

Provides a detailed description of a Note.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Note

Returns a new instance of Note



1605
1606
1607
 
# File 'generated/google/apis/containeranalysis_v1alpha1/classes.rb', line 1605

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

Instance Attribute Details

#attestation_authority ⇒ Google::Apis::ContaineranalysisV1alpha1::AttestationAuthority

Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one AttestationAuthority 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:



1511
1512
1513
 
# File 'generated/google/apis/containeranalysis_v1alpha1/classes.rb', line 1511

def attestation_authority
  @attestation_authority
end

#base_image ⇒ Google::Apis::ContaineranalysisV1alpha1::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:



1520
1521
1522
 
# File 'generated/google/apis/containeranalysis_v1alpha1/classes.rb', line 1520

def base_image
  @base_image
end

#build_type ⇒ Google::Apis::ContaineranalysisV1alpha1::BuildType

Note holding the version of the provider's builder and the signature of the provenance message in linked BuildDetails. Corresponds to the JSON property buildType

Returns:



1526
1527
1528
 
# File 'generated/google/apis/containeranalysis_v1alpha1/classes.rb', line 1526

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


1532
1533
1534
 
# File 'generated/google/apis/containeranalysis_v1alpha1/classes.rb', line 1532

def create_time
  @create_time
end

#deployable ⇒ Google::Apis::ContaineranalysisV1alpha1::Deployable

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

Returns:



1537
1538
1539
 
# File 'generated/google/apis/containeranalysis_v1alpha1/classes.rb', line 1537

def deployable
  @deployable
end

#discovery ⇒ Google::Apis::ContaineranalysisV1alpha1::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. The occurrence's operation will indicate the status of the analysis. Absence of an occurrence linked to this note for a resource indicates that analysis hasn't started. Corresponds to the JSON property discovery

Returns:



1546
1547
1548
 
# File 'generated/google/apis/containeranalysis_v1alpha1/classes.rb', line 1546

def discovery
  @discovery
end

#expiration_time ⇒ String

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

Returns:

  • (String) 


1551
1552
1553
 
# File 'generated/google/apis/containeranalysis_v1alpha1/classes.rb', line 1551

def expiration_time
  @expiration_time
end

#kind ⇒ String

Output only. This explicitly denotes which kind of note is specified. This field can be used as a filter in list requests. Corresponds to the JSON property kind

Returns:

  • (String) 


1557
1558
1559
 
# File 'generated/google/apis/containeranalysis_v1alpha1/classes.rb', line 1557

def kind
  @kind
end

#long_description ⇒ String

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

Returns:

  • (String) 


1562
1563
1564
 
# File 'generated/google/apis/containeranalysis_v1alpha1/classes.rb', line 1562

def long_description
  @long_description
end

#name ⇒ String

The name of the note in the form "projects/provider_project_id/notes/NOTE_ID" Corresponds to the JSON property name

Returns:

  • (String) 


1568
1569
1570
 
# File 'generated/google/apis/containeranalysis_v1alpha1/classes.rb', line 1568

def name
  @name
end

#package ⇒ Google::Apis::ContaineranalysisV1alpha1::Package

This represents a particular package that is distributed over various channels. e.g. glibc (aka libc6) is distributed by many, at various versions. Corresponds to the JSON property package

Returns:



1575
1576
1577
 
# File 'generated/google/apis/containeranalysis_v1alpha1/classes.rb', line 1575

def package
  @package
end

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

URLs associated with this note Corresponds to the JSON property relatedUrl

Returns:



1580
1581
1582
 
# File 'generated/google/apis/containeranalysis_v1alpha1/classes.rb', line 1580

def related_url
  @related_url
end

#short_description ⇒ String

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

Returns:

  • (String) 


1585
1586
1587
 
# File 'generated/google/apis/containeranalysis_v1alpha1/classes.rb', line 1585

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) 


1591
1592
1593
 
# File 'generated/google/apis/containeranalysis_v1alpha1/classes.rb', line 1591

def update_time
  @update_time
end

#upgrade ⇒ Google::Apis::ContaineranalysisV1alpha1::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 a Upgrade Note. Corresponds to the JSON property upgrade

Returns:



1598
1599
1600
 
# File 'generated/google/apis/containeranalysis_v1alpha1/classes.rb', line 1598

def upgrade
  @upgrade
end

#vulnerability_type ⇒ Google::Apis::ContaineranalysisV1alpha1::VulnerabilityType

VulnerabilityType provides metadata about a security vulnerability. Corresponds to the JSON property vulnerabilityType

Returns:



1603
1604
1605
 
# File 'generated/google/apis/containeranalysis_v1alpha1/classes.rb', line 1603

def vulnerability_type
  @vulnerability_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
 
# File 'generated/google/apis/containeranalysis_v1alpha1/classes.rb', line 1610

def update!(**args)
  @attestation_authority = args[:attestation_authority] if args.key?(:attestation_authority)
  @base_image = args[:base_image] if args.key?(:base_image)
  @build_type = args[:build_type] if args.key?(:build_type)
  @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)
  @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_url = args[:related_url] if args.key?(:related_url)
  @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_type = args[:vulnerability_type] if args.key?(:vulnerability_type)
end