Skip to content

containeranalysis.v1beta1.containerAnalysisNote

Index

Fields

fn new

new(name)

new returns an instance of ContainerAnalysisNote

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

fn spec.withExpirationTime

withExpirationTime(expirationTime)

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

fn spec.withLongDescription

withLongDescription(longDescription)

"A detailed description of this note."

fn spec.withRelatedNoteNames

withRelatedNoteNames(relatedNoteNames)

fn spec.withRelatedNoteNamesMixin

withRelatedNoteNamesMixin(relatedNoteNames)

Note: This function appends passed data to existing values

fn spec.withRelatedUrl

withRelatedUrl(relatedUrl)

"URLs associated with this note."

fn spec.withRelatedUrlMixin

withRelatedUrlMixin(relatedUrl)

"URLs associated with this note."

Note: This function appends passed data to existing values

fn spec.withResourceID

withResourceID(resourceID)

"Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of metadata.name is used as the default."

fn spec.withShortDescription

withShortDescription(shortDescription)

"A one sentence description of this note."

obj spec.attestation

"A note describing an attestation role."

obj spec.attestation.hint

"Hint hints at the purpose of the attestation authority."

fn spec.attestation.hint.withHumanReadableName

withHumanReadableName(humanReadableName)

"Required. The human readable name of this attestation authority, for example \"qa\"."

obj spec.build

"A note describing build provenance for a verifiable build."

fn spec.build.withBuilderVersion

withBuilderVersion(builderVersion)

"Required. Immutable. Version of the builder which produced this build."

obj spec.deployment

"A note describing something that can be deployed."

fn spec.deployment.withResourceUri

withResourceUri(resourceUri)

"Required. Resource URI for the artifact being deployed."

fn spec.deployment.withResourceUriMixin

withResourceUriMixin(resourceUri)

"Required. Resource URI for the artifact being deployed."

Note: This function appends passed data to existing values

obj spec.discovery

"A note describing the initial analysis of a resource."

fn spec.discovery.withAnalysisKind

withAnalysisKind(analysisKind)

"The kind of analysis that is handled by this discovery. Possible values: NOTE_KIND_UNSPECIFIED, VULNERABILITY, BUILD, IMAGE, PACKAGE, DEPLOYMENT, DISCOVERY, ATTESTATION, UPGRADE"

obj spec.image

"A note describing a base image."

fn spec.image.withResourceUrl

withResourceUrl(resourceUrl)

"Required. Immutable. The resource_url for the resource representing the basis of associated occurrence images."

obj spec.image.fingerprint

"Required. Immutable. The fingerprint of the base image."

fn spec.image.fingerprint.withV1Name

withV1Name(v1Name)

"Required. The layer ID of the final layer in the Docker image's v1 representation."

fn spec.image.fingerprint.withV2Blob

withV2Blob(v2Blob)

"Required. The ordered list of v2 blobs that represent a given image."

fn spec.image.fingerprint.withV2BlobMixin

withV2BlobMixin(v2Blob)

"Required. The ordered list of v2 blobs that represent a given image."

Note: This function appends passed data to existing values

obj spec.package

"Required for non-Windows OS. The package this Upgrade is for."

fn spec.package.withDistribution

withDistribution(distribution)

"The various channels by which a package is distributed."

fn spec.package.withDistributionMixin

withDistributionMixin(distribution)

"The various channels by which a package is distributed."

Note: This function appends passed data to existing values

fn spec.package.withName

withName(name)

"The name of the package."

obj spec.package.distribution

"The various channels by which a package is distributed."

fn spec.package.distribution.withArchitecture

withArchitecture(architecture)

"The CPU architecture for which packages in this distribution channel were built Possible values: ARCHITECTURE_UNSPECIFIED, X86, X64"

fn spec.package.distribution.withCpeUri

withCpeUri(cpeUri)

"The cpe_uri in cpe format denoting the package manager version distributing a package."

fn spec.package.distribution.withDescription

withDescription(description)

"The distribution channel-specific description of this package."

fn spec.package.distribution.withMaintainer

withMaintainer(maintainer)

"A freeform string denoting the maintainer of this package."

fn spec.package.distribution.withUrl

withUrl(url)

"The distribution channel-specific homepage for this package."

obj spec.package.distribution.latestVersion

"The latest available version of this package in this distribution channel."

fn spec.package.distribution.latestVersion.withEpoch

withEpoch(epoch)

"Used to correct mistakes in the version numbering scheme."

fn spec.package.distribution.latestVersion.withFullName

withFullName(fullName)

"Human readable version string. This string is of the form :- and is only set when kind is NORMAL."

fn spec.package.distribution.latestVersion.withKind

withKind(kind)

"Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored. Possible values: VERSION_KIND_UNSPECIFIED, NORMAL, MINIMUM, MAXIMUM"

fn spec.package.distribution.latestVersion.withName

withName(name)

"The main part of the version name."

fn spec.package.distribution.latestVersion.withRevision

withRevision(revision)

"The iteration of the package build from the above version."

obj spec.relatedNoteNames

fn spec.relatedNoteNames.withExternal

withExternal(external)

"Allowed value: The Google Cloud resource name of a ContainerAnalysisNote resource (format: projects/{{project}}/notes/{{name}})."

fn spec.relatedNoteNames.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.relatedNoteNames.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.relatedUrl

"URLs associated with this note."

fn spec.relatedUrl.withLabel

withLabel(label)

"Label to describe usage of the URL"

fn spec.relatedUrl.withUrl

withUrl(url)

"Specific URL to associate with the note"

obj spec.vulnerability

"A note describing a package vulnerability."

fn spec.vulnerability.withCvssScore

withCvssScore(cvssScore)

"The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity."

fn spec.vulnerability.withDetails

withDetails(details)

"Details of all known distros and packages affected by this vulnerability."

fn spec.vulnerability.withDetailsMixin

withDetailsMixin(details)

"Details of all known distros and packages affected by this vulnerability."

Note: This function appends passed data to existing values

fn spec.vulnerability.withSeverity

withSeverity(severity)

"The note provider assigned severity of this vulnerability. Possible values: SEVERITY_UNSPECIFIED, MINIMAL, LOW, MEDIUM, HIGH, CRITICAL"

fn spec.vulnerability.withSourceUpdateTime

withSourceUpdateTime(sourceUpdateTime)

"The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker."

fn spec.vulnerability.withWindowsDetails

withWindowsDetails(windowsDetails)

"Windows details get their own format because the information format and model don't match a normal detail. Specifically Windows updates are done as patches, thus Windows vulnerabilities really are a missing package, rather than a package being at an incorrect version."

fn spec.vulnerability.withWindowsDetailsMixin

withWindowsDetailsMixin(windowsDetails)

"Windows details get their own format because the information format and model don't match a normal detail. Specifically Windows updates are done as patches, thus Windows vulnerabilities really are a missing package, rather than a package being at an incorrect version."

Note: This function appends passed data to existing values

obj spec.vulnerability.cvssV3

"The full description of the CVSSv3 for this vulnerability."

fn spec.vulnerability.cvssV3.withAttackComplexity

withAttackComplexity(attackComplexity)

" Possible values: ATTACK_COMPLEXITY_UNSPECIFIED, ATTACK_COMPLEXITY_LOW, ATTACK_COMPLEXITY_HIGH"

fn spec.vulnerability.cvssV3.withAttackVector

withAttackVector(attackVector)

"Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Possible values: ATTACK_VECTOR_UNSPECIFIED, ATTACK_VECTOR_NETWORK, ATTACK_VECTOR_ADJACENT, ATTACK_VECTOR_LOCAL, ATTACK_VECTOR_PHYSICAL"

fn spec.vulnerability.cvssV3.withAvailabilityImpact

withAvailabilityImpact(availabilityImpact)

" Possible values: IMPACT_UNSPECIFIED, IMPACT_HIGH, IMPACT_LOW, IMPACT_NONE"

fn spec.vulnerability.cvssV3.withBaseScore

withBaseScore(baseScore)

"The base score is a function of the base metric scores."

fn spec.vulnerability.cvssV3.withConfidentialityImpact

withConfidentialityImpact(confidentialityImpact)

" Possible values: IMPACT_UNSPECIFIED, IMPACT_HIGH, IMPACT_LOW, IMPACT_NONE"

fn spec.vulnerability.cvssV3.withExploitabilityScore

withExploitabilityScore(exploitabilityScore)

fn spec.vulnerability.cvssV3.withImpactScore

withImpactScore(impactScore)

fn spec.vulnerability.cvssV3.withIntegrityImpact

withIntegrityImpact(integrityImpact)

" Possible values: IMPACT_UNSPECIFIED, IMPACT_HIGH, IMPACT_LOW, IMPACT_NONE"

fn spec.vulnerability.cvssV3.withPrivilegesRequired

withPrivilegesRequired(privilegesRequired)

" Possible values: PRIVILEGES_REQUIRED_UNSPECIFIED, PRIVILEGES_REQUIRED_NONE, PRIVILEGES_REQUIRED_LOW, PRIVILEGES_REQUIRED_HIGH"

fn spec.vulnerability.cvssV3.withScope

withScope(scope)

" Possible values: SCOPE_UNSPECIFIED, SCOPE_UNCHANGED, SCOPE_CHANGED"

fn spec.vulnerability.cvssV3.withUserInteraction

withUserInteraction(userInteraction)

" Possible values: USER_INTERACTION_UNSPECIFIED, USER_INTERACTION_NONE, USER_INTERACTION_REQUIRED"

obj spec.vulnerability.details

"Details of all known distros and packages affected by this vulnerability."

fn spec.vulnerability.details.withAffectedCpeUri

withAffectedCpeUri(affectedCpeUri)

"Required. The (https://cpe.mitre.org/specification/) this vulnerability affects."

fn spec.vulnerability.details.withAffectedPackage

withAffectedPackage(affectedPackage)

"Required. The package this vulnerability affects."

fn spec.vulnerability.details.withDescription

withDescription(description)

"A vendor-specific description of this vulnerability."

fn spec.vulnerability.details.withFixedCpeUri

withFixedCpeUri(fixedCpeUri)

"The distro recommended (https://cpe.mitre.org/specification/) to update to that contains a fix for this vulnerability. It is possible for this to be different from the affected_cpe_uri."

fn spec.vulnerability.details.withFixedPackage

withFixedPackage(fixedPackage)

"The distro recommended package to update to that contains a fix for this vulnerability. It is possible for this to be different from the affected_package."

fn spec.vulnerability.details.withIsObsolete

withIsObsolete(isObsolete)

"Whether this detail is obsolete. Occurrences are expected not to point to obsolete details."

fn spec.vulnerability.details.withPackageType

withPackageType(packageType)

"The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.)."

fn spec.vulnerability.details.withSeverityName

withSeverityName(severityName)

"The distro assigned severity of this vulnerability."

fn spec.vulnerability.details.withSourceUpdateTime

withSourceUpdateTime(sourceUpdateTime)

"The time this information was last changed at the source. This is an upstream timestamp from the underlying information source - e.g. Ubuntu security tracker."

obj spec.vulnerability.details.affectedVersionEnd

"The version number at the end of an interval in which this vulnerability exists. A vulnerability can affect a package between version numbers that are disjoint sets of intervals (example: ) each of which will be represented in its own Detail. If a specific affected version is provided by a vulnerability database, affected_version_start and affected_version_end will be the same in that Detail."

fn spec.vulnerability.details.affectedVersionEnd.withEpoch

withEpoch(epoch)

"Used to correct mistakes in the version numbering scheme."

fn spec.vulnerability.details.affectedVersionEnd.withFullName

withFullName(fullName)

"Human readable version string. This string is of the form :- and is only set when kind is NORMAL."

fn spec.vulnerability.details.affectedVersionEnd.withKind

withKind(kind)

"Required. Distinguishes between sentinel MIN/MAX versions and normal versions. Possible values: NOTE_KIND_UNSPECIFIED, VULNERABILITY, BUILD, IMAGE, PACKAGE, DEPLOYMENT, DISCOVERY, ATTESTATION, UPGRADE"

fn spec.vulnerability.details.affectedVersionEnd.withName

withName(name)

"Required only when version kind is NORMAL. The main part of the version name."

fn spec.vulnerability.details.affectedVersionEnd.withRevision

withRevision(revision)

"The iteration of the package build from the above version."

obj spec.vulnerability.details.affectedVersionStart

"The version number at the start of an interval in which this vulnerability exists. A vulnerability can affect a package between version numbers that are disjoint sets of intervals (example: ) each of which will be represented in its own Detail. If a specific affected version is provided by a vulnerability database, affected_version_start and affected_version_end will be the same in that Detail."

fn spec.vulnerability.details.affectedVersionStart.withEpoch

withEpoch(epoch)

"Used to correct mistakes in the version numbering scheme."

fn spec.vulnerability.details.affectedVersionStart.withFullName

withFullName(fullName)

"Human readable version string. This string is of the form :- and is only set when kind is NORMAL."

fn spec.vulnerability.details.affectedVersionStart.withKind

withKind(kind)

"Required. Distinguishes between sentinel MIN/MAX versions and normal versions. Possible values: NOTE_KIND_UNSPECIFIED, VULNERABILITY, BUILD, IMAGE, PACKAGE, DEPLOYMENT, DISCOVERY, ATTESTATION, UPGRADE"

fn spec.vulnerability.details.affectedVersionStart.withName

withName(name)

"Required only when version kind is NORMAL. The main part of the version name."

fn spec.vulnerability.details.affectedVersionStart.withRevision

withRevision(revision)

"The iteration of the package build from the above version."

obj spec.vulnerability.details.fixedVersion

"The distro recommended version to update to that contains a fix for this vulnerability. Setting this to VersionKind.MAXIMUM means no such version is yet available."

fn spec.vulnerability.details.fixedVersion.withEpoch

withEpoch(epoch)

"Used to correct mistakes in the version numbering scheme."

fn spec.vulnerability.details.fixedVersion.withFullName

withFullName(fullName)

"Human readable version string. This string is of the form :- and is only set when kind is NORMAL."

fn spec.vulnerability.details.fixedVersion.withKind

withKind(kind)

"Required. Distinguishes between sentinel MIN/MAX versions and normal versions. Possible values: NOTE_KIND_UNSPECIFIED, VULNERABILITY, BUILD, IMAGE, PACKAGE, DEPLOYMENT, DISCOVERY, ATTESTATION, UPGRADE"

fn spec.vulnerability.details.fixedVersion.withName

withName(name)

"Required only when version kind is NORMAL. The main part of the version name."

fn spec.vulnerability.details.fixedVersion.withRevision

withRevision(revision)

"The iteration of the package build from the above version."

obj spec.vulnerability.windowsDetails

"Windows details get their own format because the information format and model don't match a normal detail. Specifically Windows updates are done as patches, thus Windows vulnerabilities really are a missing package, rather than a package being at an incorrect version."

fn spec.vulnerability.windowsDetails.withCpeUri

withCpeUri(cpeUri)

"Required. The (https://cpe.mitre.org/specification/) this vulnerability affects."

fn spec.vulnerability.windowsDetails.withDescription

withDescription(description)

"The description of this vulnerability."

fn spec.vulnerability.windowsDetails.withFixingKbs

withFixingKbs(fixingKbs)

"Required. The names of the KBs which have hotfixes to mitigate this vulnerability. Note that there may be multiple hotfixes (and thus multiple KBs) that mitigate a given vulnerability. Currently any listed KBs presence is considered a fix."

fn spec.vulnerability.windowsDetails.withFixingKbsMixin

withFixingKbsMixin(fixingKbs)

"Required. The names of the KBs which have hotfixes to mitigate this vulnerability. Note that there may be multiple hotfixes (and thus multiple KBs) that mitigate a given vulnerability. Currently any listed KBs presence is considered a fix."

Note: This function appends passed data to existing values

fn spec.vulnerability.windowsDetails.withName

withName(name)

"Required. The name of this vulnerability."

obj spec.vulnerability.windowsDetails.fixingKbs

"Required. The names of the KBs which have hotfixes to mitigate this vulnerability. Note that there may be multiple hotfixes (and thus multiple KBs) that mitigate a given vulnerability. Currently any listed KBs presence is considered a fix."

fn spec.vulnerability.windowsDetails.fixingKbs.withName

withName(name)

"The KB name (generally of the form KB+ (e.g., KB123456))."

fn spec.vulnerability.windowsDetails.fixingKbs.withUrl

withUrl(url)

"A link to the KB in the (https://www.catalog.update.microsoft.com/)."