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.


1656
1657
1658
# File 'generated/google/apis/containeranalysis_v1alpha1/classes.rb', line 1656

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

Instance Attribute Details

#attestation_authorityGoogle::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


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

def attestation_authority
  @attestation_authority
end

#base_imageGoogle::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


1571
1572
1573
# File 'generated/google/apis/containeranalysis_v1alpha1/classes.rb', line 1571

def base_image
  @base_image
end

#build_typeGoogle::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


1577
1578
1579
# File 'generated/google/apis/containeranalysis_v1alpha1/classes.rb', line 1577

def build_type
  @build_type
end

#create_timeString

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)

1583
1584
1585
# File 'generated/google/apis/containeranalysis_v1alpha1/classes.rb', line 1583

def create_time
  @create_time
end

#deployableGoogle::Apis::ContaineranalysisV1alpha1::Deployable

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


1588
1589
1590
# File 'generated/google/apis/containeranalysis_v1alpha1/classes.rb', line 1588

def deployable
  @deployable
end

#discoveryGoogle::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


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

def discovery
  @discovery
end

#expiration_timeString

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

Returns:

  • (String)

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

def expiration_time
  @expiration_time
end

#kindString

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)

1608
1609
1610
# File 'generated/google/apis/containeranalysis_v1alpha1/classes.rb', line 1608

def kind
  @kind
end

#long_descriptionString

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

Returns:

  • (String)

1613
1614
1615
# File 'generated/google/apis/containeranalysis_v1alpha1/classes.rb', line 1613

def long_description
  @long_description
end

#nameString

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

Returns:

  • (String)

1619
1620
1621
# File 'generated/google/apis/containeranalysis_v1alpha1/classes.rb', line 1619

def name
  @name
end

#packageGoogle::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


1626
1627
1628
# File 'generated/google/apis/containeranalysis_v1alpha1/classes.rb', line 1626

def package
  @package
end

URLs associated with this note Corresponds to the JSON property relatedUrl


1631
1632
1633
# File 'generated/google/apis/containeranalysis_v1alpha1/classes.rb', line 1631

def related_url
  @related_url
end

#short_descriptionString

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

Returns:

  • (String)

1636
1637
1638
# File 'generated/google/apis/containeranalysis_v1alpha1/classes.rb', line 1636

def short_description
  @short_description
end

#update_timeString

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)

1642
1643
1644
# File 'generated/google/apis/containeranalysis_v1alpha1/classes.rb', line 1642

def update_time
  @update_time
end

#upgradeGoogle::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


1649
1650
1651
# File 'generated/google/apis/containeranalysis_v1alpha1/classes.rb', line 1649

def upgrade
  @upgrade
end

#vulnerability_typeGoogle::Apis::ContaineranalysisV1alpha1::VulnerabilityType

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


1654
1655
1656
# File 'generated/google/apis/containeranalysis_v1alpha1/classes.rb', line 1654

def vulnerability_type
  @vulnerability_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
# File 'generated/google/apis/containeranalysis_v1alpha1/classes.rb', line 1661

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