google-api-ruby-client/generated/google-apis-containeranalys.../lib/google/apis/containeranalysis_v1beta1/classes.rb

5041 lines
214 KiB
Ruby
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'date'
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module ContaineranalysisV1beta1
# An alias to a repo revision.
class AliasContext
include Google::Apis::Core::Hashable
# The alias kind.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# The alias name.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
end
end
# Artifact describes a build product.
class Artifact
include Google::Apis::Core::Hashable
# Hash or checksum value of a binary, or Docker Registry 2.0 digest of a
# container.
# Corresponds to the JSON property `checksum`
# @return [String]
attr_accessor :checksum
# Artifact ID, if any; for container images, this will be a URL by digest like `
# gcr.io/projectID/imagename@sha256:123456`.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# Related artifact names. This may be the path to a binary or jar file, or in
# the case of a container build, the name used to push the container image to
# Google Container Registry, as presented to `docker push`. Note that a single
# Artifact ID can have multiple names, for example if two tags are applied to
# one image.
# Corresponds to the JSON property `names`
# @return [Array<String>]
attr_accessor :names
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@checksum = args[:checksum] if args.key?(:checksum)
@id = args[:id] if args.key?(:id)
@names = args[:names] if args.key?(:names)
end
end
# Defines a hash object for use in Materials and Products.
class ArtifactHashes
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `sha256`
# @return [String]
attr_accessor :sha256
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@sha256 = args[:sha256] if args.key?(:sha256)
end
end
# Defines an object to declare an in-toto artifact rule
class ArtifactRule
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `artifactRule`
# @return [Array<String>]
attr_accessor :artifact_rule
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@artifact_rule = args[:artifact_rule] if args.key?(:artifact_rule)
end
end
# Occurrence that represents a single "attestation". The authenticity of an
# attestation can be verified using the attached signature. If the verifier
# trusts the public key of the signer, then verifying the signature is
# sufficient to establish trust. In this circumstance, the authority to which
# this attestation is attached is primarily useful for look-up (how to find this
# attestation if you already know the authority and artifact to be verified) and
# intent (which authority was this attestation intended to sign for).
class Attestation
include Google::Apis::Core::Hashable
# An attestation wrapper that uses the Grafeas `Signature` message. This
# attestation must define the `serialized_payload` that the `signatures` verify
# and any metadata necessary to interpret that plaintext. The signatures should
# always be over the `serialized_payload` bytestring.
# Corresponds to the JSON property `genericSignedAttestation`
# @return [Google::Apis::ContaineranalysisV1beta1::GenericSignedAttestation]
attr_accessor :generic_signed_attestation
# An attestation wrapper with a PGP-compatible signature. This message only
# supports `ATTACHED` signatures, where the payload that is signed is included
# alongside the signature itself in the same file.
# Corresponds to the JSON property `pgpSignedAttestation`
# @return [Google::Apis::ContaineranalysisV1beta1::PgpSignedAttestation]
attr_accessor :pgp_signed_attestation
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@generic_signed_attestation = args[:generic_signed_attestation] if args.key?(:generic_signed_attestation)
@pgp_signed_attestation = args[:pgp_signed_attestation] if args.key?(:pgp_signed_attestation)
end
end
# 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.
class Authority
include Google::Apis::Core::Hashable
# This submessage provides human-readable hints about the purpose of the
# authority. Because the name of a note acts as its resource reference, it is
# important to disambiguate the canonical name of the Note (which might be a
# UUID for security purposes) from "readable" names more suitable for debug
# output. Note that these hints should not be used to look up authorities in
# security sensitive contexts, such as when looking up attestations to verify.
# Corresponds to the JSON property `hint`
# @return [Google::Apis::ContaineranalysisV1beta1::Hint]
attr_accessor :hint
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@hint = args[:hint] if args.key?(:hint)
end
end
# 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.
class Basis
include Google::Apis::Core::Hashable
# A set of properties that uniquely identify a given Docker image.
# Corresponds to the JSON property `fingerprint`
# @return [Google::Apis::ContaineranalysisV1beta1::Fingerprint]
attr_accessor :fingerprint
# Required. Immutable. The resource_url for the resource representing the basis
# of associated occurrence images.
# Corresponds to the JSON property `resourceUrl`
# @return [String]
attr_accessor :resource_url
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@fingerprint = args[:fingerprint] if args.key?(:fingerprint)
@resource_url = args[:resource_url] if args.key?(:resource_url)
end
end
# Request to create notes in batch.
class BatchCreateNotesRequest
include Google::Apis::Core::Hashable
# Required. The notes to create, the key is expected to be the note ID. Max
# allowed length is 1000.
# Corresponds to the JSON property `notes`
# @return [Hash<String,Google::Apis::ContaineranalysisV1beta1::Note>]
attr_accessor :notes
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@notes = args[:notes] if args.key?(:notes)
end
end
# Response for creating notes in batch.
class BatchCreateNotesResponse
include Google::Apis::Core::Hashable
# The notes that were created.
# Corresponds to the JSON property `notes`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::Note>]
attr_accessor :notes
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@notes = args[:notes] if args.key?(:notes)
end
end
# Request to create occurrences in batch.
class BatchCreateOccurrencesRequest
include Google::Apis::Core::Hashable
# Required. The occurrences to create. Max allowed length is 1000.
# Corresponds to the JSON property `occurrences`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::Occurrence>]
attr_accessor :occurrences
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@occurrences = args[:occurrences] if args.key?(:occurrences)
end
end
# Response for creating occurrences in batch.
class BatchCreateOccurrencesResponse
include Google::Apis::Core::Hashable
# The occurrences that were created.
# Corresponds to the JSON property `occurrences`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::Occurrence>]
attr_accessor :occurrences
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@occurrences = args[:occurrences] if args.key?(:occurrences)
end
end
# Associates `members`, or principals, with a `role`.
class Binding
include Google::Apis::Core::Hashable
# Represents a textual expression in the Common Expression Language (CEL) syntax.
# CEL is a C-like expression language. The syntax and semantics of CEL are
# documented at https://github.com/google/cel-spec. Example (Comparison): title:
# "Summary size limit" description: "Determines if a summary is less than 100
# chars" expression: "document.summary.size() < 100" Example (Equality): title: "
# Requestor is owner" description: "Determines if requestor is the document
# owner" expression: "document.owner == request.auth.claims.email" Example (
# Logic): title: "Public documents" description: "Determine whether the document
# should be publicly visible" expression: "document.type != 'private' &&
# document.type != 'internal'" Example (Data Manipulation): title: "Notification
# string" description: "Create a notification string with a timestamp."
# expression: "'New message received at ' + string(document.create_time)" The
# exact variables and functions that may be referenced within an expression are
# determined by the service that evaluates it. See the service documentation for
# additional information.
# Corresponds to the JSON property `condition`
# @return [Google::Apis::ContaineranalysisV1beta1::Expr]
attr_accessor :condition
# Specifies the principals requesting access for a Cloud Platform resource. `
# members` can have the following values: * `allUsers`: A special identifier
# that represents anyone who is on the internet; with or without a Google
# account. * `allAuthenticatedUsers`: A special identifier that represents
# anyone who is authenticated with a Google account or a service account. * `
# user:`emailid``: An email address that represents a specific Google account.
# For example, `alice@example.com` . * `serviceAccount:`emailid``: An email
# address that represents a service account. For example, `my-other-app@appspot.
# gserviceaccount.com`. * `group:`emailid``: An email address that represents a
# Google group. For example, `admins@example.com`. * `deleted:user:`emailid`?uid=
# `uniqueid``: An email address (plus unique identifier) representing a user
# that has been recently deleted. For example, `alice@example.com?uid=
# 123456789012345678901`. If the user is recovered, this value reverts to `user:`
# emailid`` and the recovered user retains the role in the binding. * `deleted:
# serviceAccount:`emailid`?uid=`uniqueid``: An email address (plus unique
# identifier) representing a service account that has been recently deleted. For
# example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
# If the service account is undeleted, this value reverts to `serviceAccount:`
# emailid`` and the undeleted service account retains the role in the binding. *
# `deleted:group:`emailid`?uid=`uniqueid``: An email address (plus unique
# identifier) representing a Google group that has been recently deleted. For
# example, `admins@example.com?uid=123456789012345678901`. If the group is
# recovered, this value reverts to `group:`emailid`` and the recovered group
# retains the role in the binding. * `domain:`domain``: The G Suite domain (
# primary) that represents all the users of that domain. For example, `google.
# com` or `example.com`.
# Corresponds to the JSON property `members`
# @return [Array<String>]
attr_accessor :members
# Role that is assigned to the list of `members`, or principals. For example, `
# roles/viewer`, `roles/editor`, or `roles/owner`.
# Corresponds to the JSON property `role`
# @return [String]
attr_accessor :role
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@condition = args[:condition] if args.key?(:condition)
@members = args[:members] if args.key?(:members)
@role = args[:role] if args.key?(:role)
end
end
# Note holding the version of the provider's builder and the signature of the
# provenance message in the build details occurrence.
class Build
include Google::Apis::Core::Hashable
# Required. Immutable. Version of the builder which produced this build.
# Corresponds to the JSON property `builderVersion`
# @return [String]
attr_accessor :builder_version
# Message encapsulating the signature of the verified build.
# Corresponds to the JSON property `signature`
# @return [Google::Apis::ContaineranalysisV1beta1::BuildSignature]
attr_accessor :signature
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@builder_version = args[:builder_version] if args.key?(:builder_version)
@signature = args[:signature] if args.key?(:signature)
end
end
# Provenance of a build. Contains all information needed to verify the full
# details about the build from source to completion.
class BuildProvenance
include Google::Apis::Core::Hashable
# Special options applied to this build. This is a catch-all field where build
# providers can enter any desired additional details.
# Corresponds to the JSON property `buildOptions`
# @return [Hash<String,String>]
attr_accessor :build_options
# Version string of the builder at the time this build was executed.
# Corresponds to the JSON property `builderVersion`
# @return [String]
attr_accessor :builder_version
# Output of the build.
# Corresponds to the JSON property `builtArtifacts`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::Artifact>]
attr_accessor :built_artifacts
# Commands requested by the build.
# Corresponds to the JSON property `commands`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::Command>]
attr_accessor :commands
# Time at which the build was created.
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
# E-mail address of the user who initiated this build. Note that this was the
# user's e-mail address at the time the build was initiated; this address may
# not represent the same end-user for all time.
# Corresponds to the JSON property `creator`
# @return [String]
attr_accessor :creator
# Time at which execution of the build was finished.
# Corresponds to the JSON property `endTime`
# @return [String]
attr_accessor :end_time
# Required. Unique identifier of the build.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# URI where any logs for this provenance were written.
# Corresponds to the JSON property `logsUri`
# @return [String]
attr_accessor :logs_uri
# ID of the project.
# Corresponds to the JSON property `projectId`
# @return [String]
attr_accessor :project_id
# Source describes the location of the source used for the build.
# Corresponds to the JSON property `sourceProvenance`
# @return [Google::Apis::ContaineranalysisV1beta1::Source]
attr_accessor :source_provenance
# Time at which execution of the build was started.
# Corresponds to the JSON property `startTime`
# @return [String]
attr_accessor :start_time
# Trigger identifier if the build was triggered automatically; empty if not.
# Corresponds to the JSON property `triggerId`
# @return [String]
attr_accessor :trigger_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@build_options = args[:build_options] if args.key?(:build_options)
@builder_version = args[:builder_version] if args.key?(:builder_version)
@built_artifacts = args[:built_artifacts] if args.key?(:built_artifacts)
@commands = args[:commands] if args.key?(:commands)
@create_time = args[:create_time] if args.key?(:create_time)
@creator = args[:creator] if args.key?(:creator)
@end_time = args[:end_time] if args.key?(:end_time)
@id = args[:id] if args.key?(:id)
@logs_uri = args[:logs_uri] if args.key?(:logs_uri)
@project_id = args[:project_id] if args.key?(:project_id)
@source_provenance = args[:source_provenance] if args.key?(:source_provenance)
@start_time = args[:start_time] if args.key?(:start_time)
@trigger_id = args[:trigger_id] if args.key?(:trigger_id)
end
end
# Message encapsulating the signature of the verified build.
class BuildSignature
include Google::Apis::Core::Hashable
# An ID for the key used to sign. This could be either an ID for the key stored
# in `public_key` (such as the ID or fingerprint for a PGP key, or the CN for a
# cert), or a reference to an external key (such as a reference to a key in
# Cloud Key Management Service).
# Corresponds to the JSON property `keyId`
# @return [String]
attr_accessor :key_id
# The type of the key, either stored in `public_key` or referenced in `key_id`.
# Corresponds to the JSON property `keyType`
# @return [String]
attr_accessor :key_type
# Public key of the builder which can be used to verify that the related
# findings are valid and unchanged. If `key_type` is empty, this defaults to PEM
# encoded public keys. This field may be empty if `key_id` references an
# external key. For Cloud Build based signatures, this is a PEM encoded public
# key. To verify the Cloud Build signature, place the contents of this field
# into a file (public.pem). The signature field is base64-decoded into its
# binary representation in signature.bin, and the provenance bytes from `
# BuildDetails` are base64-decoded into a binary representation in signed.bin.
# OpenSSL can then verify the signature: `openssl sha256 -verify public.pem -
# signature signature.bin signed.bin`
# Corresponds to the JSON property `publicKey`
# @return [String]
attr_accessor :public_key
# Required. Signature of the related `BuildProvenance`. In JSON, this is base-64
# encoded.
# Corresponds to the JSON property `signature`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :signature
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key_id = args[:key_id] if args.key?(:key_id)
@key_type = args[:key_type] if args.key?(:key_type)
@public_key = args[:public_key] if args.key?(:public_key)
@signature = args[:signature] if args.key?(:signature)
end
end
# Defines an object for the byproducts field in in-toto links. The suggested
# fields are "stderr", "stdout", and "return-value".
class ByProducts
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `customValues`
# @return [Hash<String,String>]
attr_accessor :custom_values
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@custom_values = args[:custom_values] if args.key?(:custom_values)
end
end
# Common Vulnerability Scoring System version 3. For details, see https://www.
# first.org/cvss/specification-document
class CvsSv3
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `attackComplexity`
# @return [String]
attr_accessor :attack_complexity
# Base Metrics Represents the intrinsic characteristics of a vulnerability that
# are constant over time and across user environments.
# Corresponds to the JSON property `attackVector`
# @return [String]
attr_accessor :attack_vector
#
# Corresponds to the JSON property `availabilityImpact`
# @return [String]
attr_accessor :availability_impact
# The base score is a function of the base metric scores.
# Corresponds to the JSON property `baseScore`
# @return [Float]
attr_accessor :base_score
#
# Corresponds to the JSON property `confidentialityImpact`
# @return [String]
attr_accessor :confidentiality_impact
#
# Corresponds to the JSON property `exploitabilityScore`
# @return [Float]
attr_accessor :exploitability_score
#
# Corresponds to the JSON property `impactScore`
# @return [Float]
attr_accessor :impact_score
#
# Corresponds to the JSON property `integrityImpact`
# @return [String]
attr_accessor :integrity_impact
#
# Corresponds to the JSON property `privilegesRequired`
# @return [String]
attr_accessor :privileges_required
#
# Corresponds to the JSON property `scope`
# @return [String]
attr_accessor :scope
#
# Corresponds to the JSON property `userInteraction`
# @return [String]
attr_accessor :user_interaction
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@attack_complexity = args[:attack_complexity] if args.key?(:attack_complexity)
@attack_vector = args[:attack_vector] if args.key?(:attack_vector)
@availability_impact = args[:availability_impact] if args.key?(:availability_impact)
@base_score = args[:base_score] if args.key?(:base_score)
@confidentiality_impact = args[:confidentiality_impact] if args.key?(:confidentiality_impact)
@exploitability_score = args[:exploitability_score] if args.key?(:exploitability_score)
@impact_score = args[:impact_score] if args.key?(:impact_score)
@integrity_impact = args[:integrity_impact] if args.key?(:integrity_impact)
@privileges_required = args[:privileges_required] if args.key?(:privileges_required)
@scope = args[:scope] if args.key?(:scope)
@user_interaction = args[:user_interaction] if args.key?(:user_interaction)
end
end
# A CloudRepoSourceContext denotes a particular revision in a Google Cloud
# Source Repo.
class CloudRepoSourceContext
include Google::Apis::Core::Hashable
# An alias to a repo revision.
# Corresponds to the JSON property `aliasContext`
# @return [Google::Apis::ContaineranalysisV1beta1::AliasContext]
attr_accessor :alias_context
# A unique identifier for a Cloud Repo.
# Corresponds to the JSON property `repoId`
# @return [Google::Apis::ContaineranalysisV1beta1::RepoId]
attr_accessor :repo_id
# A revision ID.
# Corresponds to the JSON property `revisionId`
# @return [String]
attr_accessor :revision_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@alias_context = args[:alias_context] if args.key?(:alias_context)
@repo_id = args[:repo_id] if args.key?(:repo_id)
@revision_id = args[:revision_id] if args.key?(:revision_id)
end
end
# Command describes a step performed as part of the build pipeline.
class Command
include Google::Apis::Core::Hashable
# Command-line arguments used when executing this command.
# Corresponds to the JSON property `args`
# @return [Array<String>]
attr_accessor :args
# Working directory (relative to project source root) used when running this
# command.
# Corresponds to the JSON property `dir`
# @return [String]
attr_accessor :dir
# Environment variables set before running this command.
# Corresponds to the JSON property `env`
# @return [Array<String>]
attr_accessor :env
# Optional unique identifier for this command, used in wait_for to reference
# this command as a dependency.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# Required. Name of the command, as presented on the command line, or if the
# command is packaged as a Docker container, as presented to `docker pull`.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The ID(s) of the command(s) that this command depends on.
# Corresponds to the JSON property `waitFor`
# @return [Array<String>]
attr_accessor :wait_for
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@args = args[:args] if args.key?(:args)
@dir = args[:dir] if args.key?(:dir)
@env = args[:env] if args.key?(:env)
@id = args[:id] if args.key?(:id)
@name = args[:name] if args.key?(:name)
@wait_for = args[:wait_for] if args.key?(:wait_for)
end
end
# ApprovalConfig describes configuration for manual approval of a build.
class ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalConfig
include Google::Apis::Core::Hashable
# Whether or not approval is needed. If this is set on a build, it will become
# pending when created, and will need to be explicitly approved to start.
# Corresponds to the JSON property `approvalRequired`
# @return [Boolean]
attr_accessor :approval_required
alias_method :approval_required?, :approval_required
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@approval_required = args[:approval_required] if args.key?(:approval_required)
end
end
# ApprovalResult describes the decision and associated metadata of a manual
# approval of a build.
class ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalResult
include Google::Apis::Core::Hashable
# Output only. The time when the approval decision was made.
# Corresponds to the JSON property `approvalTime`
# @return [String]
attr_accessor :approval_time
# Output only. Email of the user that called the ApproveBuild API to approve or
# reject a build at the time that the API was called.
# Corresponds to the JSON property `approverAccount`
# @return [String]
attr_accessor :approver_account
# Optional. An optional comment for this manual approval result.
# Corresponds to the JSON property `comment`
# @return [String]
attr_accessor :comment
# Required. The decision of this manual approval.
# Corresponds to the JSON property `decision`
# @return [String]
attr_accessor :decision
# Optional. An optional URL tied to this manual approval result. This field is
# essentially the same as comment, except that it will be rendered by the UI
# differently. An example use case is a link to an external job that approved
# this Build.
# Corresponds to the JSON property `url`
# @return [String]
attr_accessor :url
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@approval_time = args[:approval_time] if args.key?(:approval_time)
@approver_account = args[:approver_account] if args.key?(:approver_account)
@comment = args[:comment] if args.key?(:comment)
@decision = args[:decision] if args.key?(:decision)
@url = args[:url] if args.key?(:url)
end
end
# Artifacts produced by a build that should be uploaded upon successful
# completion of all build steps.
class ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts
include Google::Apis::Core::Hashable
# A list of images to be pushed upon the successful completion of all build
# steps. The images will be pushed using the builder service account's
# credentials. The digests of the pushed images will be stored in the Build
# resource's results field. If any of the images fail to be pushed, the build is
# marked FAILURE.
# Corresponds to the JSON property `images`
# @return [Array<String>]
attr_accessor :images
# Files in the workspace to upload to Cloud Storage upon successful completion
# of all build steps.
# Corresponds to the JSON property `objects`
# @return [Google::Apis::ContaineranalysisV1beta1::ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsArtifactObjects]
attr_accessor :objects
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@images = args[:images] if args.key?(:images)
@objects = args[:objects] if args.key?(:objects)
end
end
# Files in the workspace to upload to Cloud Storage upon successful completion
# of all build steps.
class ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsArtifactObjects
include Google::Apis::Core::Hashable
# Cloud Storage bucket and optional object path, in the form "gs://bucket/path/
# to/somewhere/". (see [Bucket Name Requirements](https://cloud.google.com/
# storage/docs/bucket-naming#requirements)). Files in the workspace matching any
# path pattern will be uploaded to Cloud Storage with this location as a prefix.
# Corresponds to the JSON property `location`
# @return [String]
attr_accessor :location
# Path globs used to match files in the build's workspace.
# Corresponds to the JSON property `paths`
# @return [Array<String>]
attr_accessor :paths
# Start and end times for a build execution phase.
# Corresponds to the JSON property `timing`
# @return [Google::Apis::ContaineranalysisV1beta1::ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan]
attr_accessor :timing
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@location = args[:location] if args.key?(:location)
@paths = args[:paths] if args.key?(:paths)
@timing = args[:timing] if args.key?(:timing)
end
end
# A build resource in the Cloud Build API. At a high level, a `Build` describes
# where to find source code, how to build it (for example, the builder image to
# run on the source), and where to store the built artifacts. Fields can include
# the following variables, which will be expanded when the build is created: - $
# PROJECT_ID: the project ID of the build. - $PROJECT_NUMBER: the project number
# of the build. - $LOCATION: the location/region of the build. - $BUILD_ID: the
# autogenerated ID of the build. - $REPO_NAME: the source repository name
# specified by RepoSource. - $BRANCH_NAME: the branch name specified by
# RepoSource. - $TAG_NAME: the tag name specified by RepoSource. - $REVISION_ID
# or $COMMIT_SHA: the commit SHA specified by RepoSource or resolved from the
# specified branch or tag. - $SHORT_SHA: first 7 characters of $REVISION_ID or $
# COMMIT_SHA.
class ContaineranalysisGoogleDevtoolsCloudbuildV1Build
include Google::Apis::Core::Hashable
# BuildApproval describes a build's approval configuration, state, and result.
# Corresponds to the JSON property `approval`
# @return [Google::Apis::ContaineranalysisV1beta1::ContaineranalysisGoogleDevtoolsCloudbuildV1BuildApproval]
attr_accessor :approval
# Artifacts produced by a build that should be uploaded upon successful
# completion of all build steps.
# Corresponds to the JSON property `artifacts`
# @return [Google::Apis::ContaineranalysisV1beta1::ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts]
attr_accessor :artifacts
# Secrets and secret environment variables.
# Corresponds to the JSON property `availableSecrets`
# @return [Google::Apis::ContaineranalysisV1beta1::ContaineranalysisGoogleDevtoolsCloudbuildV1Secrets]
attr_accessor :available_secrets
# Output only. The ID of the `BuildTrigger` that triggered this build, if it was
# triggered automatically.
# Corresponds to the JSON property `buildTriggerId`
# @return [String]
attr_accessor :build_trigger_id
# Output only. Time at which the request to create the build was received.
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
# A fatal problem encountered during the execution of the build.
# Corresponds to the JSON property `failureInfo`
# @return [Google::Apis::ContaineranalysisV1beta1::ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo]
attr_accessor :failure_info
# Output only. Time at which execution of the build was finished. The difference
# between finish_time and start_time is the duration of the build's execution.
# Corresponds to the JSON property `finishTime`
# @return [String]
attr_accessor :finish_time
# Output only. Unique identifier of the build.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A list of images to be pushed upon the successful completion of all build
# steps. The images are pushed using the builder service account's credentials.
# The digests of the pushed images will be stored in the `Build` resource's
# results field. If any of the images fail to be pushed, the build status is
# marked `FAILURE`.
# Corresponds to the JSON property `images`
# @return [Array<String>]
attr_accessor :images
# Output only. URL to logs for this build in Google Cloud Console.
# Corresponds to the JSON property `logUrl`
# @return [String]
attr_accessor :log_url
# Google Cloud Storage bucket where logs should be written (see [Bucket Name
# Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)
# ). Logs file names will be of the format `$`logs_bucket`/log-$`build_id`.txt`.
# Corresponds to the JSON property `logsBucket`
# @return [String]
attr_accessor :logs_bucket
# Output only. The 'Build' name with format: `projects/`project`/locations/`
# location`/builds/`build``, where `build` is a unique identifier generated by
# the service.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Optional arguments to enable specific features of builds.
# Corresponds to the JSON property `options`
# @return [Google::Apis::ContaineranalysisV1beta1::ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions]
attr_accessor :options
# Output only. ID of the project.
# Corresponds to the JSON property `projectId`
# @return [String]
attr_accessor :project_id
# TTL in queue for this build. If provided and the build is enqueued longer than
# this value, the build will expire and the build status will be `EXPIRED`. The
# TTL starts ticking from create_time.
# Corresponds to the JSON property `queueTtl`
# @return [String]
attr_accessor :queue_ttl
# Artifacts created by the build pipeline.
# Corresponds to the JSON property `results`
# @return [Google::Apis::ContaineranalysisV1beta1::ContaineranalysisGoogleDevtoolsCloudbuildV1Results]
attr_accessor :results
# Secrets to decrypt using Cloud Key Management Service. Note: Secret Manager is
# the recommended technique for managing sensitive data with Cloud Build. Use `
# available_secrets` to configure builds to access secrets from Secret Manager.
# For instructions, see: https://cloud.google.com/cloud-build/docs/securing-
# builds/use-secrets
# Corresponds to the JSON property `secrets`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::ContaineranalysisGoogleDevtoolsCloudbuildV1Secret>]
attr_accessor :secrets
# IAM service account whose credentials will be used at build runtime. Must be
# of the format `projects/`PROJECT_ID`/serviceAccounts/`ACCOUNT``. ACCOUNT can
# be email address or uniqueId of the service account.
# Corresponds to the JSON property `serviceAccount`
# @return [String]
attr_accessor :service_account
# Location of the source in a supported storage service.
# Corresponds to the JSON property `source`
# @return [Google::Apis::ContaineranalysisV1beta1::ContaineranalysisGoogleDevtoolsCloudbuildV1Source]
attr_accessor :source
# Provenance of the source. Ways to find the original source, or verify that
# some source was used for this build.
# Corresponds to the JSON property `sourceProvenance`
# @return [Google::Apis::ContaineranalysisV1beta1::ContaineranalysisGoogleDevtoolsCloudbuildV1SourceProvenance]
attr_accessor :source_provenance
# Output only. Time at which execution of the build was started.
# Corresponds to the JSON property `startTime`
# @return [String]
attr_accessor :start_time
# Output only. Status of the build.
# Corresponds to the JSON property `status`
# @return [String]
attr_accessor :status
# Output only. Customer-readable message about the current status.
# Corresponds to the JSON property `statusDetail`
# @return [String]
attr_accessor :status_detail
# Required. The operations to be performed on the workspace.
# Corresponds to the JSON property `steps`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep>]
attr_accessor :steps
# Substitutions data for `Build` resource.
# Corresponds to the JSON property `substitutions`
# @return [Hash<String,String>]
attr_accessor :substitutions
# Tags for annotation of a `Build`. These are not docker tags.
# Corresponds to the JSON property `tags`
# @return [Array<String>]
attr_accessor :tags
# Amount of time that this build should be allowed to run, to second granularity.
# If this amount of time elapses, work on the build will cease and the build
# status will be `TIMEOUT`. `timeout` starts ticking from `startTime`. Default
# time is ten minutes.
# Corresponds to the JSON property `timeout`
# @return [String]
attr_accessor :timeout
# Output only. Stores timing information for phases of the build. Valid keys are:
# * BUILD: time to execute all build steps. * PUSH: time to push all specified
# images. * FETCHSOURCE: time to fetch source. * SETUPBUILD: time to set up
# build. If the build does not specify source or images, these keys will not be
# included.
# Corresponds to the JSON property `timing`
# @return [Hash<String,Google::Apis::ContaineranalysisV1beta1::ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan>]
attr_accessor :timing
# Output only. Non-fatal problems encountered during the execution of the build.
# Corresponds to the JSON property `warnings`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::ContaineranalysisGoogleDevtoolsCloudbuildV1BuildWarning>]
attr_accessor :warnings
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@approval = args[:approval] if args.key?(:approval)
@artifacts = args[:artifacts] if args.key?(:artifacts)
@available_secrets = args[:available_secrets] if args.key?(:available_secrets)
@build_trigger_id = args[:build_trigger_id] if args.key?(:build_trigger_id)
@create_time = args[:create_time] if args.key?(:create_time)
@failure_info = args[:failure_info] if args.key?(:failure_info)
@finish_time = args[:finish_time] if args.key?(:finish_time)
@id = args[:id] if args.key?(:id)
@images = args[:images] if args.key?(:images)
@log_url = args[:log_url] if args.key?(:log_url)
@logs_bucket = args[:logs_bucket] if args.key?(:logs_bucket)
@name = args[:name] if args.key?(:name)
@options = args[:options] if args.key?(:options)
@project_id = args[:project_id] if args.key?(:project_id)
@queue_ttl = args[:queue_ttl] if args.key?(:queue_ttl)
@results = args[:results] if args.key?(:results)
@secrets = args[:secrets] if args.key?(:secrets)
@service_account = args[:service_account] if args.key?(:service_account)
@source = args[:source] if args.key?(:source)
@source_provenance = args[:source_provenance] if args.key?(:source_provenance)
@start_time = args[:start_time] if args.key?(:start_time)
@status = args[:status] if args.key?(:status)
@status_detail = args[:status_detail] if args.key?(:status_detail)
@steps = args[:steps] if args.key?(:steps)
@substitutions = args[:substitutions] if args.key?(:substitutions)
@tags = args[:tags] if args.key?(:tags)
@timeout = args[:timeout] if args.key?(:timeout)
@timing = args[:timing] if args.key?(:timing)
@warnings = args[:warnings] if args.key?(:warnings)
end
end
# BuildApproval describes a build's approval configuration, state, and result.
class ContaineranalysisGoogleDevtoolsCloudbuildV1BuildApproval
include Google::Apis::Core::Hashable
# ApprovalConfig describes configuration for manual approval of a build.
# Corresponds to the JSON property `config`
# @return [Google::Apis::ContaineranalysisV1beta1::ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalConfig]
attr_accessor :config
# ApprovalResult describes the decision and associated metadata of a manual
# approval of a build.
# Corresponds to the JSON property `result`
# @return [Google::Apis::ContaineranalysisV1beta1::ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalResult]
attr_accessor :result
# Output only. The state of this build's approval.
# Corresponds to the JSON property `state`
# @return [String]
attr_accessor :state
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@config = args[:config] if args.key?(:config)
@result = args[:result] if args.key?(:result)
@state = args[:state] if args.key?(:state)
end
end
# A fatal problem encountered during the execution of the build.
class ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo
include Google::Apis::Core::Hashable
# Explains the failure issue in more detail using hard-coded text.
# Corresponds to the JSON property `detail`
# @return [String]
attr_accessor :detail
# The name of the failure.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@detail = args[:detail] if args.key?(:detail)
@type = args[:type] if args.key?(:type)
end
end
# Optional arguments to enable specific features of builds.
class ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions
include Google::Apis::Core::Hashable
# Requested disk size for the VM that runs the build. Note that this is *NOT* "
# disk free"; some of the space will be used by the operating system and build
# utilities. Also note that this is the minimum disk size that will be allocated
# for the build -- the build may run with a larger disk than requested. At
# present, the maximum disk size is 1000GB; builds that request more than the
# maximum are rejected with an error.
# Corresponds to the JSON property `diskSizeGb`
# @return [Fixnum]
attr_accessor :disk_size_gb
# Option to specify whether or not to apply bash style string operations to the
# substitutions. NOTE: this is always enabled for triggered builds and cannot be
# overridden in the build configuration file.
# Corresponds to the JSON property `dynamicSubstitutions`
# @return [Boolean]
attr_accessor :dynamic_substitutions
alias_method :dynamic_substitutions?, :dynamic_substitutions
# A list of global environment variable definitions that will exist for all
# build steps in this build. If a variable is defined in both globally and in a
# build step, the variable will use the build step value. The elements are of
# the form "KEY=VALUE" for the environment variable "KEY" being given the value "
# VALUE".
# Corresponds to the JSON property `env`
# @return [Array<String>]
attr_accessor :env
# Option to define build log streaming behavior to Google Cloud Storage.
# Corresponds to the JSON property `logStreamingOption`
# @return [String]
attr_accessor :log_streaming_option
# Option to specify the logging mode, which determines if and where build logs
# are stored.
# Corresponds to the JSON property `logging`
# @return [String]
attr_accessor :logging
# Compute Engine machine type on which to run the build.
# Corresponds to the JSON property `machineType`
# @return [String]
attr_accessor :machine_type
# Details about how a build should be executed on a `WorkerPool`. See [running
# builds in a private pool](https://cloud.google.com/build/docs/private-pools/
# run-builds-in-private-pool) for more information.
# Corresponds to the JSON property `pool`
# @return [Google::Apis::ContaineranalysisV1beta1::ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption]
attr_accessor :pool
# Requested verifiability options.
# Corresponds to the JSON property `requestedVerifyOption`
# @return [String]
attr_accessor :requested_verify_option
# A list of global environment variables, which are encrypted using a Cloud Key
# Management Service crypto key. These values must be specified in the build's `
# Secret`. These variables will be available to all build steps in this build.
# Corresponds to the JSON property `secretEnv`
# @return [Array<String>]
attr_accessor :secret_env
# Requested hash for SourceProvenance.
# Corresponds to the JSON property `sourceProvenanceHash`
# @return [Array<String>]
attr_accessor :source_provenance_hash
# Option to specify behavior when there is an error in the substitution checks.
# NOTE: this is always set to ALLOW_LOOSE for triggered builds and cannot be
# overridden in the build configuration file.
# Corresponds to the JSON property `substitutionOption`
# @return [String]
attr_accessor :substitution_option
# Global list of volumes to mount for ALL build steps Each volume is created as
# an empty volume prior to starting the build process. Upon completion of the
# build, volumes and their contents are discarded. Global volume names and paths
# cannot conflict with the volumes defined a build step. Using a global volume
# in a build with only one step is not valid as it is indicative of a build
# request with an incorrect configuration.
# Corresponds to the JSON property `volumes`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::ContaineranalysisGoogleDevtoolsCloudbuildV1Volume>]
attr_accessor :volumes
# This field deprecated; please use `pool.name` instead.
# Corresponds to the JSON property `workerPool`
# @return [String]
attr_accessor :worker_pool
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@disk_size_gb = args[:disk_size_gb] if args.key?(:disk_size_gb)
@dynamic_substitutions = args[:dynamic_substitutions] if args.key?(:dynamic_substitutions)
@env = args[:env] if args.key?(:env)
@log_streaming_option = args[:log_streaming_option] if args.key?(:log_streaming_option)
@logging = args[:logging] if args.key?(:logging)
@machine_type = args[:machine_type] if args.key?(:machine_type)
@pool = args[:pool] if args.key?(:pool)
@requested_verify_option = args[:requested_verify_option] if args.key?(:requested_verify_option)
@secret_env = args[:secret_env] if args.key?(:secret_env)
@source_provenance_hash = args[:source_provenance_hash] if args.key?(:source_provenance_hash)
@substitution_option = args[:substitution_option] if args.key?(:substitution_option)
@volumes = args[:volumes] if args.key?(:volumes)
@worker_pool = args[:worker_pool] if args.key?(:worker_pool)
end
end
# Details about how a build should be executed on a `WorkerPool`. See [running
# builds in a private pool](https://cloud.google.com/build/docs/private-pools/
# run-builds-in-private-pool) for more information.
class ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption
include Google::Apis::Core::Hashable
# The `WorkerPool` resource to execute the build on. You must have `cloudbuild.
# workerpools.use` on the project hosting the WorkerPool. Format projects/`
# project`/locations/`location`/workerPools/`workerPoolId`
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@name = args[:name] if args.key?(:name)
end
end
# A step in the build pipeline.
class ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep
include Google::Apis::Core::Hashable
# A list of arguments that will be presented to the step when it is started. If
# the image used to run the step's container has an entrypoint, the `args` are
# used as arguments to that entrypoint. If the image does not define an
# entrypoint, the first element in args is used as the entrypoint, and the
# remainder will be used as arguments.
# Corresponds to the JSON property `args`
# @return [Array<String>]
attr_accessor :args
# Working directory to use when running this step's container. If this value is
# a relative path, it is relative to the build's working directory. If this
# value is absolute, it may be outside the build's working directory, in which
# case the contents of the path may not be persisted across build step
# executions, unless a `volume` for that path is specified. If the build
# specifies a `RepoSource` with `dir` and a step with a `dir`, which specifies
# an absolute path, the `RepoSource` `dir` is ignored for the step's execution.
# Corresponds to the JSON property `dir`
# @return [String]
attr_accessor :dir
# Entrypoint to be used instead of the build step image's default entrypoint. If
# unset, the image's default entrypoint is used.
# Corresponds to the JSON property `entrypoint`
# @return [String]
attr_accessor :entrypoint
# A list of environment variable definitions to be used when running a step. The
# elements are of the form "KEY=VALUE" for the environment variable "KEY" being
# given the value "VALUE".
# Corresponds to the JSON property `env`
# @return [Array<String>]
attr_accessor :env
# Unique identifier for this build step, used in `wait_for` to reference this
# build step as a dependency.
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# Required. The name of the container image that will run this particular build
# step. If the image is available in the host's Docker daemon's cache, it will
# be run directly. If not, the host will attempt to pull the image first, using
# the builder service account's credentials if necessary. The Docker daemon's
# cache will already have the latest versions of all of the officially supported
# build steps ([https://github.com/GoogleCloudPlatform/cloud-builders](https://
# github.com/GoogleCloudPlatform/cloud-builders)). The Docker daemon will also
# have cached many of the layers for some popular images, like "ubuntu", "debian"
# , but they will be refreshed at the time you attempt to use them. If you built
# an image in a previous build step, it will be stored in the host's Docker
# daemon's cache and is available to use as the name for a later build step.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Start and end times for a build execution phase.
# Corresponds to the JSON property `pullTiming`
# @return [Google::Apis::ContaineranalysisV1beta1::ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan]
attr_accessor :pull_timing
# A shell script to be executed in the step. When script is provided, the user
# cannot specify the entrypoint or args.
# Corresponds to the JSON property `script`
# @return [String]
attr_accessor :script
# A list of environment variables which are encrypted using a Cloud Key
# Management Service crypto key. These values must be specified in the build's `
# Secret`.
# Corresponds to the JSON property `secretEnv`
# @return [Array<String>]
attr_accessor :secret_env
# Output only. Status of the build step. At this time, build step status is only
# updated on build completion; step status is not updated in real-time as the
# build progresses.
# Corresponds to the JSON property `status`
# @return [String]
attr_accessor :status
# Time limit for executing this build step. If not defined, the step has no time
# limit and will be allowed to continue to run until either it completes or the
# build itself times out.
# Corresponds to the JSON property `timeout`
# @return [String]
attr_accessor :timeout
# Start and end times for a build execution phase.
# Corresponds to the JSON property `timing`
# @return [Google::Apis::ContaineranalysisV1beta1::ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan]
attr_accessor :timing
# List of volumes to mount into the build step. Each volume is created as an
# empty volume prior to execution of the build step. Upon completion of the
# build, volumes and their contents are discarded. Using a named volume in only
# one step is not valid as it is indicative of a build request with an incorrect
# configuration.
# Corresponds to the JSON property `volumes`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::ContaineranalysisGoogleDevtoolsCloudbuildV1Volume>]
attr_accessor :volumes
# The ID(s) of the step(s) that this build step depends on. This build step will
# not start until all the build steps in `wait_for` have completed successfully.
# If `wait_for` is empty, this build step will start when all previous build
# steps in the `Build.Steps` list have completed successfully.
# Corresponds to the JSON property `waitFor`
# @return [Array<String>]
attr_accessor :wait_for
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@args = args[:args] if args.key?(:args)
@dir = args[:dir] if args.key?(:dir)
@entrypoint = args[:entrypoint] if args.key?(:entrypoint)
@env = args[:env] if args.key?(:env)
@id = args[:id] if args.key?(:id)
@name = args[:name] if args.key?(:name)
@pull_timing = args[:pull_timing] if args.key?(:pull_timing)
@script = args[:script] if args.key?(:script)
@secret_env = args[:secret_env] if args.key?(:secret_env)
@status = args[:status] if args.key?(:status)
@timeout = args[:timeout] if args.key?(:timeout)
@timing = args[:timing] if args.key?(:timing)
@volumes = args[:volumes] if args.key?(:volumes)
@wait_for = args[:wait_for] if args.key?(:wait_for)
end
end
# A non-fatal problem encountered during the execution of the build.
class ContaineranalysisGoogleDevtoolsCloudbuildV1BuildWarning
include Google::Apis::Core::Hashable
# The priority for this warning.
# Corresponds to the JSON property `priority`
# @return [String]
attr_accessor :priority
# Explanation of the warning generated.
# Corresponds to the JSON property `text`
# @return [String]
attr_accessor :text
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@priority = args[:priority] if args.key?(:priority)
@text = args[:text] if args.key?(:text)
end
end
# An image built by the pipeline.
class ContaineranalysisGoogleDevtoolsCloudbuildV1BuiltImage
include Google::Apis::Core::Hashable
# Docker Registry 2.0 digest.
# Corresponds to the JSON property `digest`
# @return [String]
attr_accessor :digest
# Name used to push the container image to Google Container Registry, as
# presented to `docker push`.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Start and end times for a build execution phase.
# Corresponds to the JSON property `pushTiming`
# @return [Google::Apis::ContaineranalysisV1beta1::ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan]
attr_accessor :push_timing
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@digest = args[:digest] if args.key?(:digest)
@name = args[:name] if args.key?(:name)
@push_timing = args[:push_timing] if args.key?(:push_timing)
end
end
# Container message for hashes of byte content of files, used in
# SourceProvenance messages to verify integrity of source input to the build.
class ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes
include Google::Apis::Core::Hashable
# Collection of file hashes.
# Corresponds to the JSON property `fileHash`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::ContaineranalysisGoogleDevtoolsCloudbuildV1Hash>]
attr_accessor :file_hash
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@file_hash = args[:file_hash] if args.key?(:file_hash)
end
end
# Container message for hash values.
class ContaineranalysisGoogleDevtoolsCloudbuildV1Hash
include Google::Apis::Core::Hashable
# The type of hash that was performed.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
# The hash value.
# Corresponds to the JSON property `value`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@type = args[:type] if args.key?(:type)
@value = args[:value] if args.key?(:value)
end
end
# Pairs a set of secret environment variables mapped to encrypted values with
# the Cloud KMS key to use to decrypt the value.
class ContaineranalysisGoogleDevtoolsCloudbuildV1InlineSecret
include Google::Apis::Core::Hashable
# Map of environment variable name to its encrypted value. Secret environment
# variables must be unique across all of a build's secrets, and must be used by
# at least one build step. Values can be at most 64 KB in size. There can be at
# most 100 secret values across all of a build's secrets.
# Corresponds to the JSON property `envMap`
# @return [Hash<String,String>]
attr_accessor :env_map
# Resource name of Cloud KMS crypto key to decrypt the encrypted value. In
# format: projects/*/locations/*/keyRings/*/cryptoKeys/*
# Corresponds to the JSON property `kmsKeyName`
# @return [String]
attr_accessor :kms_key_name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@env_map = args[:env_map] if args.key?(:env_map)
@kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
end
end
# Location of the source in a Google Cloud Source Repository.
class ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource
include Google::Apis::Core::Hashable
# Regex matching branches to build. The syntax of the regular expressions
# accepted is the syntax accepted by RE2 and described at https://github.com/
# google/re2/wiki/Syntax
# Corresponds to the JSON property `branchName`
# @return [String]
attr_accessor :branch_name
# Explicit commit SHA to build.
# Corresponds to the JSON property `commitSha`
# @return [String]
attr_accessor :commit_sha
# Directory, relative to the source root, in which to run the build. This must
# be a relative path. If a step's `dir` is specified and is an absolute path,
# this value is ignored for that step's execution.
# Corresponds to the JSON property `dir`
# @return [String]
attr_accessor :dir
# Only trigger a build if the revision regex does NOT match the revision regex.
# Corresponds to the JSON property `invertRegex`
# @return [Boolean]
attr_accessor :invert_regex
alias_method :invert_regex?, :invert_regex
# ID of the project that owns the Cloud Source Repository. If omitted, the
# project ID requesting the build is assumed.
# Corresponds to the JSON property `projectId`
# @return [String]
attr_accessor :project_id
# Name of the Cloud Source Repository.
# Corresponds to the JSON property `repoName`
# @return [String]
attr_accessor :repo_name
# Substitutions to use in a triggered build. Should only be used with
# RunBuildTrigger
# Corresponds to the JSON property `substitutions`
# @return [Hash<String,String>]
attr_accessor :substitutions
# Regex matching tags to build. The syntax of the regular expressions accepted
# is the syntax accepted by RE2 and described at https://github.com/google/re2/
# wiki/Syntax
# Corresponds to the JSON property `tagName`
# @return [String]
attr_accessor :tag_name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@branch_name = args[:branch_name] if args.key?(:branch_name)
@commit_sha = args[:commit_sha] if args.key?(:commit_sha)
@dir = args[:dir] if args.key?(:dir)
@invert_regex = args[:invert_regex] if args.key?(:invert_regex)
@project_id = args[:project_id] if args.key?(:project_id)
@repo_name = args[:repo_name] if args.key?(:repo_name)
@substitutions = args[:substitutions] if args.key?(:substitutions)
@tag_name = args[:tag_name] if args.key?(:tag_name)
end
end
# Artifacts created by the build pipeline.
class ContaineranalysisGoogleDevtoolsCloudbuildV1Results
include Google::Apis::Core::Hashable
# Path to the artifact manifest. Only populated when artifacts are uploaded.
# Corresponds to the JSON property `artifactManifest`
# @return [String]
attr_accessor :artifact_manifest
# Start and end times for a build execution phase.
# Corresponds to the JSON property `artifactTiming`
# @return [Google::Apis::ContaineranalysisV1beta1::ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan]
attr_accessor :artifact_timing
# List of build step digests, in the order corresponding to build step indices.
# Corresponds to the JSON property `buildStepImages`
# @return [Array<String>]
attr_accessor :build_step_images
# List of build step outputs, produced by builder images, in the order
# corresponding to build step indices. [Cloud Builders](https://cloud.google.com/
# cloud-build/docs/cloud-builders) can produce this output by writing to `$
# BUILDER_OUTPUT/output`. Only the first 4KB of data is stored.
# Corresponds to the JSON property `buildStepOutputs`
# @return [Array<String>]
attr_accessor :build_step_outputs
# Container images that were built as a part of the build.
# Corresponds to the JSON property `images`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::ContaineranalysisGoogleDevtoolsCloudbuildV1BuiltImage>]
attr_accessor :images
# Number of artifacts uploaded. Only populated when artifacts are uploaded.
# Corresponds to the JSON property `numArtifacts`
# @return [Fixnum]
attr_accessor :num_artifacts
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@artifact_manifest = args[:artifact_manifest] if args.key?(:artifact_manifest)
@artifact_timing = args[:artifact_timing] if args.key?(:artifact_timing)
@build_step_images = args[:build_step_images] if args.key?(:build_step_images)
@build_step_outputs = args[:build_step_outputs] if args.key?(:build_step_outputs)
@images = args[:images] if args.key?(:images)
@num_artifacts = args[:num_artifacts] if args.key?(:num_artifacts)
end
end
# Pairs a set of secret environment variables containing encrypted values with
# the Cloud KMS key to use to decrypt the value. Note: Use `kmsKeyName` with `
# available_secrets` instead of using `kmsKeyName` with `secret`. For
# instructions see: https://cloud.google.com/cloud-build/docs/securing-builds/
# use-encrypted-credentials.
class ContaineranalysisGoogleDevtoolsCloudbuildV1Secret
include Google::Apis::Core::Hashable
# Cloud KMS key name to use to decrypt these envs.
# Corresponds to the JSON property `kmsKeyName`
# @return [String]
attr_accessor :kms_key_name
# Map of environment variable name to its encrypted value. Secret environment
# variables must be unique across all of a build's secrets, and must be used by
# at least one build step. Values can be at most 64 KB in size. There can be at
# most 100 secret values across all of a build's secrets.
# Corresponds to the JSON property `secretEnv`
# @return [Hash<String,String>]
attr_accessor :secret_env
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
@secret_env = args[:secret_env] if args.key?(:secret_env)
end
end
# Pairs a secret environment variable with a SecretVersion in Secret Manager.
class ContaineranalysisGoogleDevtoolsCloudbuildV1SecretManagerSecret
include Google::Apis::Core::Hashable
# Environment variable name to associate with the secret. Secret environment
# variables must be unique across all of a build's secrets, and must be used by
# at least one build step.
# Corresponds to the JSON property `env`
# @return [String]
attr_accessor :env
# Resource name of the SecretVersion. In format: projects/*/secrets/*/versions/*
# Corresponds to the JSON property `versionName`
# @return [String]
attr_accessor :version_name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@env = args[:env] if args.key?(:env)
@version_name = args[:version_name] if args.key?(:version_name)
end
end
# Secrets and secret environment variables.
class ContaineranalysisGoogleDevtoolsCloudbuildV1Secrets
include Google::Apis::Core::Hashable
# Secrets encrypted with KMS key and the associated secret environment variable.
# Corresponds to the JSON property `inline`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::ContaineranalysisGoogleDevtoolsCloudbuildV1InlineSecret>]
attr_accessor :inline
# Secrets in Secret Manager and associated secret environment variable.
# Corresponds to the JSON property `secretManager`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::ContaineranalysisGoogleDevtoolsCloudbuildV1SecretManagerSecret>]
attr_accessor :secret_manager
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@inline = args[:inline] if args.key?(:inline)
@secret_manager = args[:secret_manager] if args.key?(:secret_manager)
end
end
# Location of the source in a supported storage service.
class ContaineranalysisGoogleDevtoolsCloudbuildV1Source
include Google::Apis::Core::Hashable
# Location of the source in a Google Cloud Source Repository.
# Corresponds to the JSON property `repoSource`
# @return [Google::Apis::ContaineranalysisV1beta1::ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource]
attr_accessor :repo_source
# Location of the source in an archive file in Google Cloud Storage.
# Corresponds to the JSON property `storageSource`
# @return [Google::Apis::ContaineranalysisV1beta1::ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource]
attr_accessor :storage_source
# Location of the source manifest in Google Cloud Storage. This feature is in
# Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-
# builders/tree/master/gcs-fetcher).
# Corresponds to the JSON property `storageSourceManifest`
# @return [Google::Apis::ContaineranalysisV1beta1::ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest]
attr_accessor :storage_source_manifest
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@repo_source = args[:repo_source] if args.key?(:repo_source)
@storage_source = args[:storage_source] if args.key?(:storage_source)
@storage_source_manifest = args[:storage_source_manifest] if args.key?(:storage_source_manifest)
end
end
# Provenance of the source. Ways to find the original source, or verify that
# some source was used for this build.
class ContaineranalysisGoogleDevtoolsCloudbuildV1SourceProvenance
include Google::Apis::Core::Hashable
# Output only. Hash(es) of the build source, which can be used to verify that
# the original source integrity was maintained in the build. Note that `
# FileHashes` will only be populated if `BuildOptions` has requested a `
# SourceProvenanceHash`. The keys to this map are file paths used as build
# source and the values contain the hash values for those files. If the build
# source came in a single package such as a gzipped tarfile (`.tar.gz`), the `
# FileHash` will be for the single path to that file.
# Corresponds to the JSON property `fileHashes`
# @return [Hash<String,Google::Apis::ContaineranalysisV1beta1::ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes>]
attr_accessor :file_hashes
# Location of the source in a Google Cloud Source Repository.
# Corresponds to the JSON property `resolvedRepoSource`
# @return [Google::Apis::ContaineranalysisV1beta1::ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource]
attr_accessor :resolved_repo_source
# Location of the source in an archive file in Google Cloud Storage.
# Corresponds to the JSON property `resolvedStorageSource`
# @return [Google::Apis::ContaineranalysisV1beta1::ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource]
attr_accessor :resolved_storage_source
# Location of the source manifest in Google Cloud Storage. This feature is in
# Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-
# builders/tree/master/gcs-fetcher).
# Corresponds to the JSON property `resolvedStorageSourceManifest`
# @return [Google::Apis::ContaineranalysisV1beta1::ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest]
attr_accessor :resolved_storage_source_manifest
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@file_hashes = args[:file_hashes] if args.key?(:file_hashes)
@resolved_repo_source = args[:resolved_repo_source] if args.key?(:resolved_repo_source)
@resolved_storage_source = args[:resolved_storage_source] if args.key?(:resolved_storage_source)
@resolved_storage_source_manifest = args[:resolved_storage_source_manifest] if args.key?(:resolved_storage_source_manifest)
end
end
# Location of the source in an archive file in Google Cloud Storage.
class ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource
include Google::Apis::Core::Hashable
# Google Cloud Storage bucket containing the source (see [Bucket Name
# Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)
# ).
# Corresponds to the JSON property `bucket`
# @return [String]
attr_accessor :bucket
# Google Cloud Storage generation for the object. If the generation is omitted,
# the latest generation will be used.
# Corresponds to the JSON property `generation`
# @return [Fixnum]
attr_accessor :generation
# Google Cloud Storage object containing the source. This object must be a
# zipped (`.zip`) or gzipped archive file (`.tar.gz`) containing source to build.
# Corresponds to the JSON property `object`
# @return [String]
attr_accessor :object
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@bucket = args[:bucket] if args.key?(:bucket)
@generation = args[:generation] if args.key?(:generation)
@object = args[:object] if args.key?(:object)
end
end
# Location of the source manifest in Google Cloud Storage. This feature is in
# Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-
# builders/tree/master/gcs-fetcher).
class ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest
include Google::Apis::Core::Hashable
# Google Cloud Storage bucket containing the source manifest (see [Bucket Name
# Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)
# ).
# Corresponds to the JSON property `bucket`
# @return [String]
attr_accessor :bucket
# Google Cloud Storage generation for the object. If the generation is omitted,
# the latest generation will be used.
# Corresponds to the JSON property `generation`
# @return [Fixnum]
attr_accessor :generation
# Google Cloud Storage object containing the source manifest. This object must
# be a JSON file.
# Corresponds to the JSON property `object`
# @return [String]
attr_accessor :object
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@bucket = args[:bucket] if args.key?(:bucket)
@generation = args[:generation] if args.key?(:generation)
@object = args[:object] if args.key?(:object)
end
end
# Start and end times for a build execution phase.
class ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan
include Google::Apis::Core::Hashable
# End of time span.
# Corresponds to the JSON property `endTime`
# @return [String]
attr_accessor :end_time
# Start of time span.
# Corresponds to the JSON property `startTime`
# @return [String]
attr_accessor :start_time
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@end_time = args[:end_time] if args.key?(:end_time)
@start_time = args[:start_time] if args.key?(:start_time)
end
end
# Volume describes a Docker container volume which is mounted into build steps
# in order to persist files across build step execution.
class ContaineranalysisGoogleDevtoolsCloudbuildV1Volume
include Google::Apis::Core::Hashable
# Name of the volume to mount. Volume names must be unique per build step and
# must be valid names for Docker volumes. Each named volume must be used by at
# least two build steps.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Path at which to mount the volume. Paths must be absolute and cannot conflict
# with other volume paths on the same build step or with certain reserved volume
# paths.
# Corresponds to the JSON property `path`
# @return [String]
attr_accessor :path
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@name = args[:name] if args.key?(:name)
@path = args[:path] if args.key?(:path)
end
end
# An artifact that can be deployed in some runtime.
class Deployable
include Google::Apis::Core::Hashable
# Required. Resource URI for the artifact being deployed.
# Corresponds to the JSON property `resourceUri`
# @return [Array<String>]
attr_accessor :resource_uri
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@resource_uri = args[:resource_uri] if args.key?(:resource_uri)
end
end
# The period during which some deployable was active in a runtime.
class Deployment
include Google::Apis::Core::Hashable
# Address of the runtime element hosting this deployment.
# Corresponds to the JSON property `address`
# @return [String]
attr_accessor :address
# Configuration used to create this deployment.
# Corresponds to the JSON property `config`
# @return [String]
attr_accessor :config
# Required. Beginning of the lifetime of this deployment.
# Corresponds to the JSON property `deployTime`
# @return [String]
attr_accessor :deploy_time
# Platform hosting this deployment.
# Corresponds to the JSON property `platform`
# @return [String]
attr_accessor :platform
# Output only. Resource URI for the artifact being deployed taken from the
# deployable field with the same name.
# Corresponds to the JSON property `resourceUri`
# @return [Array<String>]
attr_accessor :resource_uri
# End of the lifetime of this deployment.
# Corresponds to the JSON property `undeployTime`
# @return [String]
attr_accessor :undeploy_time
# Identity of the user that triggered this deployment.
# Corresponds to the JSON property `userEmail`
# @return [String]
attr_accessor :user_email
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@address = args[:address] if args.key?(:address)
@config = args[:config] if args.key?(:config)
@deploy_time = args[:deploy_time] if args.key?(:deploy_time)
@platform = args[:platform] if args.key?(:platform)
@resource_uri = args[:resource_uri] if args.key?(:resource_uri)
@undeploy_time = args[:undeploy_time] if args.key?(:undeploy_time)
@user_email = args[:user_email] if args.key?(:user_email)
end
end
# Derived describes the derived image portion (Occurrence) of the DockerImage
# relationship. This image would be produced from a Dockerfile with FROM .
class Derived
include Google::Apis::Core::Hashable
# Output only. This contains the base image URL for the derived image occurrence.
# Corresponds to the JSON property `baseResourceUrl`
# @return [String]
attr_accessor :base_resource_url
# Output only. The number of layers by which this image differs from the
# associated image basis.
# Corresponds to the JSON property `distance`
# @return [Fixnum]
attr_accessor :distance
# A set of properties that uniquely identify a given Docker image.
# Corresponds to the JSON property `fingerprint`
# @return [Google::Apis::ContaineranalysisV1beta1::Fingerprint]
attr_accessor :fingerprint
# This contains layer-specific metadata, if populated it has length "distance"
# and is ordered with [distance] being the layer immediately following the base
# image and [1] being the final layer.
# Corresponds to the JSON property `layerInfo`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::Layer>]
attr_accessor :layer_info
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@base_resource_url = args[:base_resource_url] if args.key?(:base_resource_url)
@distance = args[:distance] if args.key?(:distance)
@fingerprint = args[:fingerprint] if args.key?(:fingerprint)
@layer_info = args[:layer_info] if args.key?(:layer_info)
end
end
# Identifies all appearances of this vulnerability in the package for a specific
# distro/location. For example: glibc in cpe:/o:debian:debian_linux:8 for
# versions 2.1 - 2.2
class Detail
include Google::Apis::Core::Hashable
# Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in
# which the vulnerability manifests. Examples include distro or storage location
# for vulnerable jar.
# Corresponds to the JSON property `cpeUri`
# @return [String]
attr_accessor :cpe_uri
# A vendor-specific description of this note.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# The location of the vulnerability.
# Corresponds to the JSON property `fixedLocation`
# @return [Google::Apis::ContaineranalysisV1beta1::VulnerabilityLocation]
attr_accessor :fixed_location
# Whether this detail is obsolete. Occurrences are expected not to point to
# obsolete details.
# Corresponds to the JSON property `isObsolete`
# @return [Boolean]
attr_accessor :is_obsolete
alias_method :is_obsolete?, :is_obsolete
# Version contains structured information about the version of a package.
# Corresponds to the JSON property `maxAffectedVersion`
# @return [Google::Apis::ContaineranalysisV1beta1::Version]
attr_accessor :max_affected_version
# Version contains structured information about the version of a package.
# Corresponds to the JSON property `minAffectedVersion`
# @return [Google::Apis::ContaineranalysisV1beta1::Version]
attr_accessor :min_affected_version
# Required. The name of the package where the vulnerability was found.
# Corresponds to the JSON property `package`
# @return [String]
attr_accessor :package
# The type of package; whether native or non native(ruby gems, node.js packages
# etc).
# Corresponds to the JSON property `packageType`
# @return [String]
attr_accessor :package_type
# The severity (eg: distro assigned severity) for this vulnerability.
# Corresponds to the JSON property `severityName`
# @return [String]
attr_accessor :severity_name
# The source from which the information in this Detail was obtained.
# Corresponds to the JSON property `source`
# @return [String]
attr_accessor :source
# 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.
# Corresponds to the JSON property `sourceUpdateTime`
# @return [String]
attr_accessor :source_update_time
# The name of the vendor of the product.
# Corresponds to the JSON property `vendor`
# @return [String]
attr_accessor :vendor
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@cpe_uri = args[:cpe_uri] if args.key?(:cpe_uri)
@description = args[:description] if args.key?(:description)
@fixed_location = args[:fixed_location] if args.key?(:fixed_location)
@is_obsolete = args[:is_obsolete] if args.key?(:is_obsolete)
@max_affected_version = args[:max_affected_version] if args.key?(:max_affected_version)
@min_affected_version = args[:min_affected_version] if args.key?(:min_affected_version)
@package = args[:package] if args.key?(:package)
@package_type = args[:package_type] if args.key?(:package_type)
@severity_name = args[:severity_name] if args.key?(:severity_name)
@source = args[:source] if args.key?(:source)
@source_update_time = args[:source_update_time] if args.key?(:source_update_time)
@vendor = args[:vendor] if args.key?(:vendor)
end
end
# Details of an attestation occurrence.
class Details
include Google::Apis::Core::Hashable
# Occurrence that represents a single "attestation". The authenticity of an
# attestation can be verified using the attached signature. If the verifier
# trusts the public key of the signer, then verifying the signature is
# sufficient to establish trust. In this circumstance, the authority to which
# this attestation is attached is primarily useful for look-up (how to find this
# attestation if you already know the authority and artifact to be verified) and
# intent (which authority was this attestation intended to sign for).
# Corresponds to the JSON property `attestation`
# @return [Google::Apis::ContaineranalysisV1beta1::Attestation]
attr_accessor :attestation
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@attestation = args[:attestation] if args.key?(:attestation)
end
end
# Provides information about the analysis status of a discovered resource.
class Discovered
include Google::Apis::Core::Hashable
# The status of discovery for the resource.
# Corresponds to the JSON property `analysisStatus`
# @return [String]
attr_accessor :analysis_status
# The `Status` type defines a logical error model that is suitable for different
# programming environments, including REST APIs and RPC APIs. It is used by [
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
# data: error code, error message, and error details. You can find out more
# about this error model and how to work with it in the [API Design Guide](https:
# //cloud.google.com/apis/design/errors).
# Corresponds to the JSON property `analysisStatusError`
# @return [Google::Apis::ContaineranalysisV1beta1::Status]
attr_accessor :analysis_status_error
# Whether the resource is continuously analyzed.
# Corresponds to the JSON property `continuousAnalysis`
# @return [String]
attr_accessor :continuous_analysis
# The last time continuous analysis was done for this resource. Deprecated, do
# not use.
# Corresponds to the JSON property `lastAnalysisTime`
# @return [String]
attr_accessor :last_analysis_time
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@analysis_status = args[:analysis_status] if args.key?(:analysis_status)
@analysis_status_error = args[:analysis_status_error] if args.key?(:analysis_status_error)
@continuous_analysis = args[:continuous_analysis] if args.key?(:continuous_analysis)
@last_analysis_time = args[:last_analysis_time] if args.key?(:last_analysis_time)
end
end
# 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.
class Discovery
include Google::Apis::Core::Hashable
# Required. Immutable. The kind of analysis that is handled by this discovery.
# Corresponds to the JSON property `analysisKind`
# @return [String]
attr_accessor :analysis_kind
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@analysis_kind = args[:analysis_kind] if args.key?(:analysis_kind)
end
end
# This represents a particular channel of distribution for a given package. E.g.,
# Debian's jessie-backports dpkg mirror.
class Distribution
include Google::Apis::Core::Hashable
# The CPU architecture for which packages in this distribution channel were
# built.
# Corresponds to the JSON property `architecture`
# @return [String]
attr_accessor :architecture
# Required. The cpe_uri in [CPE format](https://cpe.mitre.org/specification/)
# denoting the package manager version distributing a package.
# Corresponds to the JSON property `cpeUri`
# @return [String]
attr_accessor :cpe_uri
# The distribution channel-specific description of this package.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# Version contains structured information about the version of a package.
# Corresponds to the JSON property `latestVersion`
# @return [Google::Apis::ContaineranalysisV1beta1::Version]
attr_accessor :latest_version
# A freeform string denoting the maintainer of this package.
# Corresponds to the JSON property `maintainer`
# @return [String]
attr_accessor :maintainer
# The distribution channel-specific homepage for this package.
# Corresponds to the JSON property `url`
# @return [String]
attr_accessor :url
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@architecture = args[:architecture] if args.key?(:architecture)
@cpe_uri = args[:cpe_uri] if args.key?(:cpe_uri)
@description = args[:description] if args.key?(:description)
@latest_version = args[:latest_version] if args.key?(:latest_version)
@maintainer = args[:maintainer] if args.key?(:maintainer)
@url = args[:url] if args.key?(:url)
end
end
# DocumentNote represents an SPDX Document Creation Infromation section: https://
# spdx.github.io/spdx-spec/2-document-creation-information/
class DocumentNote
include Google::Apis::Core::Hashable
# Compliance with the SPDX specification includes populating the SPDX fields
# therein with data related to such fields ("SPDX-Metadata")
# Corresponds to the JSON property `dataLicence`
# @return [String]
attr_accessor :data_licence
# Provide a reference number that can be used to understand how to parse and
# interpret the rest of the file
# Corresponds to the JSON property `spdxVersion`
# @return [String]
attr_accessor :spdx_version
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@data_licence = args[:data_licence] if args.key?(:data_licence)
@spdx_version = args[:spdx_version] if args.key?(:spdx_version)
end
end
# DocumentOccurrence represents an SPDX Document Creation Information section:
# https://spdx.github.io/spdx-spec/2-document-creation-information/
class DocumentOccurrence
include Google::Apis::Core::Hashable
# Identify when the SPDX file was originally created. The date is to be
# specified according to combined date and time in UTC format as specified in
# ISO 8601 standard
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
# A field for creators of the SPDX file to provide general comments about the
# creation of the SPDX file or any other relevant comment not included in the
# other fields
# Corresponds to the JSON property `creatorComment`
# @return [String]
attr_accessor :creator_comment
# Identify who (or what, in the case of a tool) created the SPDX file. If the
# SPDX file was created by an individual, indicate the person's name
# Corresponds to the JSON property `creators`
# @return [Array<String>]
attr_accessor :creators
# A field for creators of the SPDX file content to provide comments to the
# consumers of the SPDX document
# Corresponds to the JSON property `documentComment`
# @return [String]
attr_accessor :document_comment
# Identify any external SPDX documents referenced within this SPDX document
# Corresponds to the JSON property `externalDocumentRefs`
# @return [Array<String>]
attr_accessor :external_document_refs
# Identify the current SPDX document which may be referenced in relationships by
# other files, packages internally and documents externally
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# A field for creators of the SPDX file to provide the version of the SPDX
# License List used when the SPDX file was created
# Corresponds to the JSON property `licenseListVersion`
# @return [String]
attr_accessor :license_list_version
# Provide an SPDX document specific namespace as a unique absolute Uniform
# Resource Identifier (URI) as specified in RFC-3986, with the exception of the
# # delimiter
# Corresponds to the JSON property `namespace`
# @return [String]
attr_accessor :namespace
# Identify name of this document as designated by creator
# Corresponds to the JSON property `title`
# @return [String]
attr_accessor :title
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@create_time = args[:create_time] if args.key?(:create_time)
@creator_comment = args[:creator_comment] if args.key?(:creator_comment)
@creators = args[:creators] if args.key?(:creators)
@document_comment = args[:document_comment] if args.key?(:document_comment)
@external_document_refs = args[:external_document_refs] if args.key?(:external_document_refs)
@id = args[:id] if args.key?(:id)
@license_list_version = args[:license_list_version] if args.key?(:license_list_version)
@namespace = args[:namespace] if args.key?(:namespace)
@title = args[:title] if args.key?(:title)
end
end
# A generic empty message that you can re-use to avoid defining duplicated empty
# messages in your APIs. A typical example is to use it as the request or the
# response type of an API method. For instance: service Foo ` rpc Bar(google.
# protobuf.Empty) returns (google.protobuf.Empty); `
class Empty
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
end
end
# Defines an object for the environment field in in-toto links. The suggested
# fields are "variables", "filesystem", and "workdir".
class Environment
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `customValues`
# @return [Hash<String,String>]
attr_accessor :custom_values
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@custom_values = args[:custom_values] if args.key?(:custom_values)
end
end
# Represents a textual expression in the Common Expression Language (CEL) syntax.
# CEL is a C-like expression language. The syntax and semantics of CEL are
# documented at https://github.com/google/cel-spec. Example (Comparison): title:
# "Summary size limit" description: "Determines if a summary is less than 100
# chars" expression: "document.summary.size() < 100" Example (Equality): title: "
# Requestor is owner" description: "Determines if requestor is the document
# owner" expression: "document.owner == request.auth.claims.email" Example (
# Logic): title: "Public documents" description: "Determine whether the document
# should be publicly visible" expression: "document.type != 'private' &&
# document.type != 'internal'" Example (Data Manipulation): title: "Notification
# string" description: "Create a notification string with a timestamp."
# expression: "'New message received at ' + string(document.create_time)" The
# exact variables and functions that may be referenced within an expression are
# determined by the service that evaluates it. See the service documentation for
# additional information.
class Expr
include Google::Apis::Core::Hashable
# Optional. Description of the expression. This is a longer text which describes
# the expression, e.g. when hovered over it in a UI.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# Textual representation of an expression in Common Expression Language syntax.
# Corresponds to the JSON property `expression`
# @return [String]
attr_accessor :expression
# Optional. String indicating the location of the expression for error reporting,
# e.g. a file name and a position in the file.
# Corresponds to the JSON property `location`
# @return [String]
attr_accessor :location
# Optional. Title for the expression, i.e. a short string describing its purpose.
# This can be used e.g. in UIs which allow to enter the expression.
# Corresponds to the JSON property `title`
# @return [String]
attr_accessor :title
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@description = args[:description] if args.key?(:description)
@expression = args[:expression] if args.key?(:expression)
@location = args[:location] if args.key?(:location)
@title = args[:title] if args.key?(:title)
end
end
# An External Reference allows a Package to reference an external source of
# additional information, metadata, enumerations, asset identifiers, or
# downloadable content believed to be relevant to the Package
class ExternalRef
include Google::Apis::Core::Hashable
# An External Reference allows a Package to reference an external source of
# additional information, metadata, enumerations, asset identifiers, or
# downloadable content believed to be relevant to the Package
# Corresponds to the JSON property `category`
# @return [String]
attr_accessor :category
# Human-readable information about the purpose and target of the reference
# Corresponds to the JSON property `comment`
# @return [String]
attr_accessor :comment
# The unique string with no spaces necessary to access the package-specific
# information, metadata, or content within the target location
# Corresponds to the JSON property `locator`
# @return [String]
attr_accessor :locator
# Type of category (e.g. 'npm' for the PACKAGE_MANAGER category)
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@category = args[:category] if args.key?(:category)
@comment = args[:comment] if args.key?(:comment)
@locator = args[:locator] if args.key?(:locator)
@type = args[:type] if args.key?(:type)
end
end
# Container message for hashes of byte content of files, used in source messages
# to verify integrity of source input to the build.
class FileHashes
include Google::Apis::Core::Hashable
# Required. Collection of file hashes.
# Corresponds to the JSON property `fileHash`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::HashProp>]
attr_accessor :file_hash
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@file_hash = args[:file_hash] if args.key?(:file_hash)
end
end
# FileNote represents an SPDX File Information section: https://spdx.github.io/
# spdx-spec/4-file-information/
class FileNote
include Google::Apis::Core::Hashable
# Provide a unique identifier to match analysis information on each specific
# file in a package
# Corresponds to the JSON property `checksum`
# @return [Array<String>]
attr_accessor :checksum
# This field provides information about the type of file identified
# Corresponds to the JSON property `fileType`
# @return [String]
attr_accessor :file_type
# Identify the full path and filename that corresponds to the file information
# in this section
# Corresponds to the JSON property `title`
# @return [String]
attr_accessor :title
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@checksum = args[:checksum] if args.key?(:checksum)
@file_type = args[:file_type] if args.key?(:file_type)
@title = args[:title] if args.key?(:title)
end
end
# FileOccurrence represents an SPDX File Information section: https://spdx.
# github.io/spdx-spec/4-file-information/
class FileOccurrence
include Google::Apis::Core::Hashable
# This field provides a place for the SPDX data creator to record, at the file
# level, acknowledgements that may be needed to be communicated in some contexts
# Corresponds to the JSON property `attributions`
# @return [Array<String>]
attr_accessor :attributions
# This field provides a place for the SPDX file creator to record any general
# comments about the file
# Corresponds to the JSON property `comment`
# @return [String]
attr_accessor :comment
# This field provides a place for the SPDX file creator to record file
# contributors
# Corresponds to the JSON property `contributors`
# @return [Array<String>]
attr_accessor :contributors
# Identify the copyright holder of the file, as well as any dates present
# Corresponds to the JSON property `copyright`
# @return [String]
attr_accessor :copyright
# This field contains the license information actually found in the file, if any
# Corresponds to the JSON property `filesLicenseInfo`
# @return [Array<String>]
attr_accessor :files_license_info
# Uniquely identify any element in an SPDX document which may be referenced by
# other elements
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# License information: https://spdx.github.io/spdx-spec/3-package-information/#
# 315-declared-license
# Corresponds to the JSON property `licenseConcluded`
# @return [Google::Apis::ContaineranalysisV1beta1::License]
attr_accessor :license_concluded
# This field provides a place for the SPDX file creator to record license
# notices or other such related notices found in the file
# Corresponds to the JSON property `notice`
# @return [String]
attr_accessor :notice
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@attributions = args[:attributions] if args.key?(:attributions)
@comment = args[:comment] if args.key?(:comment)
@contributors = args[:contributors] if args.key?(:contributors)
@copyright = args[:copyright] if args.key?(:copyright)
@files_license_info = args[:files_license_info] if args.key?(:files_license_info)
@id = args[:id] if args.key?(:id)
@license_concluded = args[:license_concluded] if args.key?(:license_concluded)
@notice = args[:notice] if args.key?(:notice)
end
end
# A set of properties that uniquely identify a given Docker image.
class Fingerprint
include Google::Apis::Core::Hashable
# Required. The layer ID of the final layer in the Docker image's v1
# representation.
# Corresponds to the JSON property `v1Name`
# @return [String]
attr_accessor :v1_name
# Required. The ordered list of v2 blobs that represent a given image.
# Corresponds to the JSON property `v2Blob`
# @return [Array<String>]
attr_accessor :v2_blob
# Output only. The name of the image's v2 blobs computed via: [bottom] :=
# v2_blobbottom := sha256(v2_blob[N] + " " + v2_name[N+1]) Only the name of the
# final blob is kept.
# Corresponds to the JSON property `v2Name`
# @return [String]
attr_accessor :v2_name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@v1_name = args[:v1_name] if args.key?(:v1_name)
@v2_blob = args[:v2_blob] if args.key?(:v2_blob)
@v2_name = args[:v2_name] if args.key?(:v2_name)
end
end
# Per resource and severity counts of fixable and total vulnerabilities.
class FixableTotalByDigest
include Google::Apis::Core::Hashable
# The number of fixable vulnerabilities associated with this resource.
# Corresponds to the JSON property `fixableCount`
# @return [Fixnum]
attr_accessor :fixable_count
# An entity that can have metadata. For example, a Docker image.
# Corresponds to the JSON property `resource`
# @return [Google::Apis::ContaineranalysisV1beta1::Resource]
attr_accessor :resource
# The severity for this count. SEVERITY_UNSPECIFIED indicates total across all
# severities.
# Corresponds to the JSON property `severity`
# @return [String]
attr_accessor :severity
# The total number of vulnerabilities associated with this resource.
# Corresponds to the JSON property `totalCount`
# @return [Fixnum]
attr_accessor :total_count
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@fixable_count = args[:fixable_count] if args.key?(:fixable_count)
@resource = args[:resource] if args.key?(:resource)
@severity = args[:severity] if args.key?(:severity)
@total_count = args[:total_count] if args.key?(:total_count)
end
end
# An attestation wrapper that uses the Grafeas `Signature` message. This
# attestation must define the `serialized_payload` that the `signatures` verify
# and any metadata necessary to interpret that plaintext. The signatures should
# always be over the `serialized_payload` bytestring.
class GenericSignedAttestation
include Google::Apis::Core::Hashable
# Type (for example schema) of the attestation payload that was signed. The
# verifier must ensure that the provided type is one that the verifier supports,
# and that the attestation payload is a valid instantiation of that type (for
# example by validating a JSON schema).
# Corresponds to the JSON property `contentType`
# @return [String]
attr_accessor :content_type
# The serialized payload that is verified by one or more `signatures`. The
# encoding and semantic meaning of this payload must match what is set in `
# content_type`.
# Corresponds to the JSON property `serializedPayload`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :serialized_payload
# One or more signatures over `serialized_payload`. Verifier implementations
# should consider this attestation message verified if at least one `signature`
# verifies `serialized_payload`. See `Signature` in common.proto for more
# details on signature structure and verification.
# Corresponds to the JSON property `signatures`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::Signature>]
attr_accessor :signatures
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@content_type = args[:content_type] if args.key?(:content_type)
@serialized_payload = args[:serialized_payload] if args.key?(:serialized_payload)
@signatures = args[:signatures] if args.key?(:signatures)
end
end
# A SourceContext referring to a Gerrit project.
class GerritSourceContext
include Google::Apis::Core::Hashable
# An alias to a repo revision.
# Corresponds to the JSON property `aliasContext`
# @return [Google::Apis::ContaineranalysisV1beta1::AliasContext]
attr_accessor :alias_context
# The full project name within the host. Projects may be nested, so "project/
# subproject" is a valid project name. The "repo name" is the hostURI/project.
# Corresponds to the JSON property `gerritProject`
# @return [String]
attr_accessor :gerrit_project
# The URI of a running Gerrit instance.
# Corresponds to the JSON property `hostUri`
# @return [String]
attr_accessor :host_uri
# A revision (commit) ID.
# Corresponds to the JSON property `revisionId`
# @return [String]
attr_accessor :revision_id
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@alias_context = args[:alias_context] if args.key?(:alias_context)
@gerrit_project = args[:gerrit_project] if args.key?(:gerrit_project)
@host_uri = args[:host_uri] if args.key?(:host_uri)
@revision_id = args[:revision_id] if args.key?(:revision_id)
end
end
# Request message for `GetIamPolicy` method.
class GetIamPolicyRequest
include Google::Apis::Core::Hashable
# Encapsulates settings provided to GetIamPolicy.
# Corresponds to the JSON property `options`
# @return [Google::Apis::ContaineranalysisV1beta1::GetPolicyOptions]
attr_accessor :options
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@options = args[:options] if args.key?(:options)
end
end
# Encapsulates settings provided to GetIamPolicy.
class GetPolicyOptions
include Google::Apis::Core::Hashable
# Optional. The maximum policy version that will be used to format the policy.
# Valid values are 0, 1, and 3. Requests specifying an invalid value will be
# rejected. Requests for policies with any conditional role bindings must
# specify version 3. Policies with no conditional role bindings may specify any
# valid value or leave the field unset. The policy in the response might use the
# policy version that you specified, or it might use a lower policy version. For
# example, if you specify version 3, but the policy has no conditional role
# bindings, the response uses version 1. To learn which resources support
# conditions in their IAM policies, see the [IAM documentation](https://cloud.
# google.com/iam/help/conditions/resource-policies).
# Corresponds to the JSON property `requestedPolicyVersion`
# @return [Fixnum]
attr_accessor :requested_policy_version
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@requested_policy_version = args[:requested_policy_version] if args.key?(:requested_policy_version)
end
end
# A GitSourceContext denotes a particular revision in a third party Git
# repository (e.g., GitHub).
class GitSourceContext
include Google::Apis::Core::Hashable
# Git commit hash.
# Corresponds to the JSON property `revisionId`
# @return [String]
attr_accessor :revision_id
# Git repository URL.
# Corresponds to the JSON property `url`
# @return [String]
attr_accessor :url
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@revision_id = args[:revision_id] if args.key?(:revision_id)
@url = args[:url] if args.key?(:url)
end
end
# Metadata for all operations used and required for all operations that created
# by Container Analysis Providers
class GoogleDevtoolsContaineranalysisV1alpha1OperationMetadata
include Google::Apis::Core::Hashable
# Output only. The time this operation was created.
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
# Output only. The time that this operation was marked completed or failed.
# Corresponds to the JSON property `endTime`
# @return [String]
attr_accessor :end_time
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@create_time = args[:create_time] if args.key?(:create_time)
@end_time = args[:end_time] if args.key?(:end_time)
end
end
# Details of a build occurrence.
class GrafeasV1beta1BuildDetails
include Google::Apis::Core::Hashable
# Provenance of a build. Contains all information needed to verify the full
# details about the build from source to completion.
# Corresponds to the JSON property `provenance`
# @return [Google::Apis::ContaineranalysisV1beta1::BuildProvenance]
attr_accessor :provenance
# Serialized JSON representation of the provenance, used in generating the build
# signature in the corresponding build note. After verifying the signature, `
# provenance_bytes` can be unmarshalled and compared to the provenance to
# confirm that it is unchanged. A base64-encoded string representation of the
# provenance bytes is used for the signature in order to interoperate with
# openssl which expects this format for signature verification. The serialized
# form is captured both to avoid ambiguity in how the provenance is marshalled
# to json as well to prevent incompatibilities with future changes.
# Corresponds to the JSON property `provenanceBytes`
# @return [String]
attr_accessor :provenance_bytes
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@provenance = args[:provenance] if args.key?(:provenance)
@provenance_bytes = args[:provenance_bytes] if args.key?(:provenance_bytes)
end
end
# Details of a deployment occurrence.
class GrafeasV1beta1DeploymentDetails
include Google::Apis::Core::Hashable
# The period during which some deployable was active in a runtime.
# Corresponds to the JSON property `deployment`
# @return [Google::Apis::ContaineranalysisV1beta1::Deployment]
attr_accessor :deployment
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@deployment = args[:deployment] if args.key?(:deployment)
end
end
# Details of a discovery occurrence.
class GrafeasV1beta1DiscoveryDetails
include Google::Apis::Core::Hashable
# Provides information about the analysis status of a discovered resource.
# Corresponds to the JSON property `discovered`
# @return [Google::Apis::ContaineranalysisV1beta1::Discovered]
attr_accessor :discovered
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@discovered = args[:discovered] if args.key?(:discovered)
end
end
# Details of an image occurrence.
class GrafeasV1beta1ImageDetails
include Google::Apis::Core::Hashable
# Derived describes the derived image portion (Occurrence) of the DockerImage
# relationship. This image would be produced from a Dockerfile with FROM .
# Corresponds to the JSON property `derivedImage`
# @return [Google::Apis::ContaineranalysisV1beta1::Derived]
attr_accessor :derived_image
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@derived_image = args[:derived_image] if args.key?(:derived_image)
end
end
#
class GrafeasV1beta1IntotoArtifact
include Google::Apis::Core::Hashable
# Defines a hash object for use in Materials and Products.
# Corresponds to the JSON property `hashes`
# @return [Google::Apis::ContaineranalysisV1beta1::ArtifactHashes]
attr_accessor :hashes
#
# Corresponds to the JSON property `resourceUri`
# @return [String]
attr_accessor :resource_uri
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@hashes = args[:hashes] if args.key?(:hashes)
@resource_uri = args[:resource_uri] if args.key?(:resource_uri)
end
end
# This corresponds to a signed in-toto link - it is made up of one or more
# signatures and the in-toto link itself. This is used for occurrences of a
# Grafeas in-toto note.
class GrafeasV1beta1IntotoDetails
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `signatures`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::GrafeasV1beta1IntotoSignature>]
attr_accessor :signatures
# This corresponds to an in-toto link.
# Corresponds to the JSON property `signed`
# @return [Google::Apis::ContaineranalysisV1beta1::Link]
attr_accessor :signed
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@signatures = args[:signatures] if args.key?(:signatures)
@signed = args[:signed] if args.key?(:signed)
end
end
# A signature object consists of the KeyID used and the signature itself.
class GrafeasV1beta1IntotoSignature
include Google::Apis::Core::Hashable
#
# Corresponds to the JSON property `keyid`
# @return [String]
attr_accessor :keyid
#
# Corresponds to the JSON property `sig`
# @return [String]
attr_accessor :sig
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@keyid = args[:keyid] if args.key?(:keyid)
@sig = args[:sig] if args.key?(:sig)
end
end
# Details of a package occurrence.
class GrafeasV1beta1PackageDetails
include Google::Apis::Core::Hashable
# This represents how a particular software package may be installed on a system.
# Corresponds to the JSON property `installation`
# @return [Google::Apis::ContaineranalysisV1beta1::Installation]
attr_accessor :installation
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@installation = args[:installation] if args.key?(:installation)
end
end
# Details of a vulnerability Occurrence.
class GrafeasV1beta1VulnerabilityDetails
include Google::Apis::Core::Hashable
# Output only. 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.
# Corresponds to the JSON property `cvssScore`
# @return [Float]
attr_accessor :cvss_score
# The distro assigned severity for this vulnerability when it is available, and
# note provider assigned severity when distro has not yet assigned a severity
# for this vulnerability. When there are multiple PackageIssues for this
# vulnerability, they can have different effective severities because some might
# be provided by the distro while others are provided by the language ecosystem
# for a language pack. For this reason, it is advised to use the effective
# severity on the PackageIssue level. In the case where multiple PackageIssues
# have differing effective severities, this field should be the highest severity
# for any of the PackageIssues.
# Corresponds to the JSON property `effectiveSeverity`
# @return [String]
attr_accessor :effective_severity
# Output only. A detailed description of this vulnerability.
# Corresponds to the JSON property `longDescription`
# @return [String]
attr_accessor :long_description
# Required. The set of affected locations and their fixes (if available) within
# the associated resource.
# Corresponds to the JSON property `packageIssue`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::PackageIssue>]
attr_accessor :package_issue
# Output only. URLs related to this vulnerability.
# Corresponds to the JSON property `relatedUrls`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::RelatedUrl>]
attr_accessor :related_urls
# Output only. The note provider assigned Severity of the vulnerability.
# Corresponds to the JSON property `severity`
# @return [String]
attr_accessor :severity
# Output only. A one sentence description of this vulnerability.
# Corresponds to the JSON property `shortDescription`
# @return [String]
attr_accessor :short_description
# The type of package; whether native or non native(ruby gems, node.js packages
# etc)
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@cvss_score = args[:cvss_score] if args.key?(:cvss_score)
@effective_severity = args[:effective_severity] if args.key?(:effective_severity)
@long_description = args[:long_description] if args.key?(:long_description)
@package_issue = args[:package_issue] if args.key?(:package_issue)
@related_urls = args[:related_urls] if args.key?(:related_urls)
@severity = args[:severity] if args.key?(:severity)
@short_description = args[:short_description] if args.key?(:short_description)
@type = args[:type] if args.key?(:type)
end
end
# Container message for hash values.
class HashProp
include Google::Apis::Core::Hashable
# Required. The type of hash that was performed.
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
# Required. The hash value.
# Corresponds to the JSON property `value`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@type = args[:type] if args.key?(:type)
@value = args[:value] if args.key?(:value)
end
end
# This submessage provides human-readable hints about the purpose of the
# authority. Because the name of a note acts as its resource reference, it is
# important to disambiguate the canonical name of the Note (which might be a
# UUID for security purposes) from "readable" names more suitable for debug
# output. Note that these hints should not be used to look up authorities in
# security sensitive contexts, such as when looking up attestations to verify.
class Hint
include Google::Apis::Core::Hashable
# Required. The human readable name of this attestation authority, for example "
# qa".
# Corresponds to the JSON property `humanReadableName`
# @return [String]
attr_accessor :human_readable_name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@human_readable_name = args[:human_readable_name] if args.key?(:human_readable_name)
end
end
# 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.
class InToto
include Google::Apis::Core::Hashable
# This field contains the expected command used to perform the step.
# Corresponds to the JSON property `expectedCommand`
# @return [Array<String>]
attr_accessor :expected_command
# The following fields contain in-toto artifact rules identifying the artifacts
# that enter this supply chain step, and exit the supply chain step, i.e.
# materials and products of the step.
# Corresponds to the JSON property `expectedMaterials`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::ArtifactRule>]
attr_accessor :expected_materials
#
# Corresponds to the JSON property `expectedProducts`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::ArtifactRule>]
attr_accessor :expected_products
# This field contains the public keys that can be used to verify the signatures
# on the step metadata.
# Corresponds to the JSON property `signingKeys`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::SigningKey>]
attr_accessor :signing_keys
# This field identifies the name of the step in the supply chain.
# Corresponds to the JSON property `stepName`
# @return [String]
attr_accessor :step_name
# This field contains a value that indicates the minimum number of keys that
# need to be used to sign the step's in-toto link.
# Corresponds to the JSON property `threshold`
# @return [Fixnum]
attr_accessor :threshold
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@expected_command = args[:expected_command] if args.key?(:expected_command)
@expected_materials = args[:expected_materials] if args.key?(:expected_materials)
@expected_products = args[:expected_products] if args.key?(:expected_products)
@signing_keys = args[:signing_keys] if args.key?(:signing_keys)
@step_name = args[:step_name] if args.key?(:step_name)
@threshold = args[:threshold] if args.key?(:threshold)
end
end
# This represents how a particular software package may be installed on a system.
class Installation
include Google::Apis::Core::Hashable
# Required. All of the places within the filesystem versions of this package
# have been found.
# Corresponds to the JSON property `location`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::Location>]
attr_accessor :location
# Output only. The name of the installed package.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@location = args[:location] if args.key?(:location)
@name = args[:name] if args.key?(:name)
end
end
#
class KnowledgeBase
include Google::Apis::Core::Hashable
# The KB name (generally of the form KB[0-9]+ i.e. KB123456).
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# A link to the KB in the Windows update catalog - https://www.catalog.update.
# microsoft.com/
# Corresponds to the JSON property `url`
# @return [String]
attr_accessor :url
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@name = args[:name] if args.key?(:name)
@url = args[:url] if args.key?(:url)
end
end
# Layer holds metadata specific to a layer of a Docker image.
class Layer
include Google::Apis::Core::Hashable
# The recovered arguments to the Dockerfile directive.
# Corresponds to the JSON property `arguments`
# @return [String]
attr_accessor :arguments
# Required. The recovered Dockerfile directive used to construct this layer.
# Corresponds to the JSON property `directive`
# @return [String]
attr_accessor :directive
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@arguments = args[:arguments] if args.key?(:arguments)
@directive = args[:directive] if args.key?(:directive)
end
end
# License information: https://spdx.github.io/spdx-spec/3-package-information/#
# 315-declared-license
class License
include Google::Apis::Core::Hashable
# Comments
# Corresponds to the JSON property `comments`
# @return [String]
attr_accessor :comments
# Expression: https://spdx.github.io/spdx-spec/appendix-IV-SPDX-license-
# expressions/
# Corresponds to the JSON property `expression`
# @return [String]
attr_accessor :expression
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@comments = args[:comments] if args.key?(:comments)
@expression = args[:expression] if args.key?(:expression)
end
end
# This corresponds to an in-toto link.
class Link
include Google::Apis::Core::Hashable
# Defines an object for the byproducts field in in-toto links. The suggested
# fields are "stderr", "stdout", and "return-value".
# Corresponds to the JSON property `byproducts`
# @return [Google::Apis::ContaineranalysisV1beta1::ByProducts]
attr_accessor :byproducts
# This field contains the full command executed for the step. This can also be
# empty if links are generated for operations that aren't directly mapped to a
# specific command. Each term in the command is an independent string in the
# list. An example of a command in the in-toto metadata field is: "command": ["
# git", "clone", "https://github.com/in-toto/demo-project.git"]
# Corresponds to the JSON property `command`
# @return [Array<String>]
attr_accessor :command
# Defines an object for the environment field in in-toto links. The suggested
# fields are "variables", "filesystem", and "workdir".
# Corresponds to the JSON property `environment`
# @return [Google::Apis::ContaineranalysisV1beta1::Environment]
attr_accessor :environment
# Materials are the supply chain artifacts that go into the step and are used
# for the operation performed. The key of the map is the path of the artifact
# and the structure contains the recorded hash information. An example is: "
# materials": [ ` "resource_uri": "foo/bar", "hashes": ` "sha256": "ebebf...", :
# ` ` ]
# Corresponds to the JSON property `materials`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::GrafeasV1beta1IntotoArtifact>]
attr_accessor :materials
# Products are the supply chain artifacts generated as a result of the step. The
# structure is identical to that of materials.
# Corresponds to the JSON property `products`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::GrafeasV1beta1IntotoArtifact>]
attr_accessor :products
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@byproducts = args[:byproducts] if args.key?(:byproducts)
@command = args[:command] if args.key?(:command)
@environment = args[:environment] if args.key?(:environment)
@materials = args[:materials] if args.key?(:materials)
@products = args[:products] if args.key?(:products)
end
end
# Response for listing occurrences for a note.
class ListNoteOccurrencesResponse
include Google::Apis::Core::Hashable
# Token to provide to skip to a particular spot in the list.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# The occurrences attached to the specified note.
# Corresponds to the JSON property `occurrences`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::Occurrence>]
attr_accessor :occurrences
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@occurrences = args[:occurrences] if args.key?(:occurrences)
end
end
# Response for listing notes.
class ListNotesResponse
include Google::Apis::Core::Hashable
# The next pagination token in the list response. It should be used as `
# page_token` for the following request. An empty value means no more results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# The notes requested.
# Corresponds to the JSON property `notes`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::Note>]
attr_accessor :notes
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@notes = args[:notes] if args.key?(:notes)
end
end
# Response for listing occurrences.
class ListOccurrencesResponse
include Google::Apis::Core::Hashable
# The next pagination token in the list response. It should be used as `
# page_token` for the following request. An empty value means no more results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# The occurrences requested.
# Corresponds to the JSON property `occurrences`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::Occurrence>]
attr_accessor :occurrences
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@occurrences = args[:occurrences] if args.key?(:occurrences)
end
end
# Response for listing scan configurations.
class ListScanConfigsResponse
include Google::Apis::Core::Hashable
# The next pagination token in the list response. It should be used as `
# page_token` for the following request. An empty value means no more results.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
# The scan configurations requested.
# Corresponds to the JSON property `scanConfigs`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::ScanConfig>]
attr_accessor :scan_configs
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@next_page_token = args[:next_page_token] if args.key?(:next_page_token)
@scan_configs = args[:scan_configs] if args.key?(:scan_configs)
end
end
# An occurrence of a particular package installation found within a system's
# filesystem. E.g., glibc was found in `/var/lib/dpkg/status`.
class Location
include Google::Apis::Core::Hashable
# Required. The CPE URI in [CPE format](https://cpe.mitre.org/specification/)
# denoting the package manager version distributing a package.
# Corresponds to the JSON property `cpeUri`
# @return [String]
attr_accessor :cpe_uri
# The path from which we gathered that this package/version is installed.
# Corresponds to the JSON property `path`
# @return [String]
attr_accessor :path
# Version contains structured information about the version of a package.
# Corresponds to the JSON property `version`
# @return [Google::Apis::ContaineranalysisV1beta1::Version]
attr_accessor :version
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@cpe_uri = args[:cpe_uri] if args.key?(:cpe_uri)
@path = args[:path] if args.key?(:path)
@version = args[:version] if args.key?(:version)
end
end
# A type of analysis that can be done for a resource.
class Note
include Google::Apis::Core::Hashable
# 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`
# @return [Google::Apis::ContaineranalysisV1beta1::Authority]
attr_accessor :attestation_authority
# 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`
# @return [Google::Apis::ContaineranalysisV1beta1::Basis]
attr_accessor :base_image
# 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`
# @return [Google::Apis::ContaineranalysisV1beta1::Build]
attr_accessor :build
# 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`
# @return [String]
attr_accessor :create_time
# An artifact that can be deployed in some runtime.
# Corresponds to the JSON property `deployable`
# @return [Google::Apis::ContaineranalysisV1beta1::Deployable]
attr_accessor :deployable
# 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`
# @return [Google::Apis::ContaineranalysisV1beta1::Discovery]
attr_accessor :discovery
# Time of expiration for this note. Empty if note does not expire.
# Corresponds to the JSON property `expirationTime`
# @return [String]
attr_accessor :expiration_time
# 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`
# @return [Google::Apis::ContaineranalysisV1beta1::InToto]
attr_accessor :intoto
# Output only. The type of analysis. This field can be used as a filter in list
# requests.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# A detailed description of this note.
# Corresponds to the JSON property `longDescription`
# @return [String]
attr_accessor :long_description
# Output only. The name of the note in the form of `projects/[PROVIDER_ID]/notes/
# [NOTE_ID]`.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# 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`
# @return [Google::Apis::ContaineranalysisV1beta1::Package]
attr_accessor :package
# Other notes related to this note.
# Corresponds to the JSON property `relatedNoteNames`
# @return [Array<String>]
attr_accessor :related_note_names
# URLs associated with this note.
# Corresponds to the JSON property `relatedUrl`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::RelatedUrl>]
attr_accessor :related_url
# DocumentNote represents an SPDX Document Creation Infromation section: https://
# spdx.github.io/spdx-spec/2-document-creation-information/
# Corresponds to the JSON property `sbom`
# @return [Google::Apis::ContaineranalysisV1beta1::DocumentNote]
attr_accessor :sbom
# A one sentence description of this note.
# Corresponds to the JSON property `shortDescription`
# @return [String]
attr_accessor :short_description
# FileNote represents an SPDX File Information section: https://spdx.github.io/
# spdx-spec/4-file-information/
# Corresponds to the JSON property `spdxFile`
# @return [Google::Apis::ContaineranalysisV1beta1::FileNote]
attr_accessor :spdx_file
# PackageInfoNote represents an SPDX Package Information section: https://spdx.
# github.io/spdx-spec/3-package-information/
# Corresponds to the JSON property `spdxPackage`
# @return [Google::Apis::ContaineranalysisV1beta1::PackageInfoNote]
attr_accessor :spdx_package
# RelationshipNote represents an SPDX Relationship section: https://spdx.github.
# io/spdx-spec/7-relationships-between-SPDX-elements/
# Corresponds to the JSON property `spdxRelationship`
# @return [Google::Apis::ContaineranalysisV1beta1::RelationshipNote]
attr_accessor :spdx_relationship
# 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`
# @return [String]
attr_accessor :update_time
# Vulnerability provides metadata about a security vulnerability in a Note.
# Corresponds to the JSON property `vulnerability`
# @return [Google::Apis::ContaineranalysisV1beta1::Vulnerability]
attr_accessor :vulnerability
def initialize(**args)
update!(**args)
end
# Update properties of this object
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)
@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)
end
end
# An instance of an analysis type that has been found on a resource.
class Occurrence
include Google::Apis::Core::Hashable
# Details of an attestation occurrence.
# Corresponds to the JSON property `attestation`
# @return [Google::Apis::ContaineranalysisV1beta1::Details]
attr_accessor :attestation
# Details of a build occurrence.
# Corresponds to the JSON property `build`
# @return [Google::Apis::ContaineranalysisV1beta1::GrafeasV1beta1BuildDetails]
attr_accessor :build
# Output only. The time this occurrence was created.
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
# Details of a deployment occurrence.
# Corresponds to the JSON property `deployment`
# @return [Google::Apis::ContaineranalysisV1beta1::GrafeasV1beta1DeploymentDetails]
attr_accessor :deployment
# Details of an image occurrence.
# Corresponds to the JSON property `derivedImage`
# @return [Google::Apis::ContaineranalysisV1beta1::GrafeasV1beta1ImageDetails]
attr_accessor :derived_image
# Details of a discovery occurrence.
# Corresponds to the JSON property `discovered`
# @return [Google::Apis::ContaineranalysisV1beta1::GrafeasV1beta1DiscoveryDetails]
attr_accessor :discovered
# Details of a package occurrence.
# Corresponds to the JSON property `installation`
# @return [Google::Apis::ContaineranalysisV1beta1::GrafeasV1beta1PackageDetails]
attr_accessor :installation
# This corresponds to a signed in-toto link - it is made up of one or more
# signatures and the in-toto link itself. This is used for occurrences of a
# Grafeas in-toto note.
# Corresponds to the JSON property `intoto`
# @return [Google::Apis::ContaineranalysisV1beta1::GrafeasV1beta1IntotoDetails]
attr_accessor :intoto
# Output only. This explicitly denotes which of the occurrence details are
# specified. This field can be used as a filter in list requests.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# Output only. The name of the occurrence in the form of `projects/[PROJECT_ID]/
# occurrences/[OCCURRENCE_ID]`.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Required. Immutable. The analysis note associated with this occurrence, in the
# form of `projects/[PROVIDER_ID]/notes/[NOTE_ID]`. This field can be used as a
# filter in list requests.
# Corresponds to the JSON property `noteName`
# @return [String]
attr_accessor :note_name
# A description of actions that can be taken to remedy the note.
# Corresponds to the JSON property `remediation`
# @return [String]
attr_accessor :remediation
# An entity that can have metadata. For example, a Docker image.
# Corresponds to the JSON property `resource`
# @return [Google::Apis::ContaineranalysisV1beta1::Resource]
attr_accessor :resource
# DocumentOccurrence represents an SPDX Document Creation Information section:
# https://spdx.github.io/spdx-spec/2-document-creation-information/
# Corresponds to the JSON property `sbom`
# @return [Google::Apis::ContaineranalysisV1beta1::DocumentOccurrence]
attr_accessor :sbom
# FileOccurrence represents an SPDX File Information section: https://spdx.
# github.io/spdx-spec/4-file-information/
# Corresponds to the JSON property `spdxFile`
# @return [Google::Apis::ContaineranalysisV1beta1::FileOccurrence]
attr_accessor :spdx_file
# PackageInfoOccurrence represents an SPDX Package Information section: https://
# spdx.github.io/spdx-spec/3-package-information/
# Corresponds to the JSON property `spdxPackage`
# @return [Google::Apis::ContaineranalysisV1beta1::PackageInfoOccurrence]
attr_accessor :spdx_package
# RelationshipOccurrence represents an SPDX Relationship section: https://spdx.
# github.io/spdx-spec/7-relationships-between-SPDX-elements/
# Corresponds to the JSON property `spdxRelationship`
# @return [Google::Apis::ContaineranalysisV1beta1::RelationshipOccurrence]
attr_accessor :spdx_relationship
# Output only. The time this occurrence was last updated.
# Corresponds to the JSON property `updateTime`
# @return [String]
attr_accessor :update_time
# Details of a vulnerability Occurrence.
# Corresponds to the JSON property `vulnerability`
# @return [Google::Apis::ContaineranalysisV1beta1::GrafeasV1beta1VulnerabilityDetails]
attr_accessor :vulnerability
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@attestation = args[:attestation] if args.key?(:attestation)
@build = args[:build] if args.key?(:build)
@create_time = args[:create_time] if args.key?(:create_time)
@deployment = args[:deployment] if args.key?(:deployment)
@derived_image = args[:derived_image] if args.key?(:derived_image)
@discovered = args[:discovered] if args.key?(:discovered)
@installation = args[:installation] if args.key?(:installation)
@intoto = args[:intoto] if args.key?(:intoto)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@note_name = args[:note_name] if args.key?(:note_name)
@remediation = args[:remediation] if args.key?(:remediation)
@resource = args[:resource] if args.key?(:resource)
@sbom = args[:sbom] if args.key?(:sbom)
@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)
end
end
# This represents a particular package that is distributed over various channels.
# E.g., glibc (aka libc6) is distributed by many, at various versions.
class Package
include Google::Apis::Core::Hashable
# The various channels by which a package is distributed.
# Corresponds to the JSON property `distribution`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::Distribution>]
attr_accessor :distribution
# Required. Immutable. The name of the package.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@distribution = args[:distribution] if args.key?(:distribution)
@name = args[:name] if args.key?(:name)
end
end
# PackageInfoNote represents an SPDX Package Information section: https://spdx.
# github.io/spdx-spec/3-package-information/
class PackageInfoNote
include Google::Apis::Core::Hashable
# Indicates whether the file content of this package has been available for or
# subjected to analysis when creating the SPDX document
# Corresponds to the JSON property `analyzed`
# @return [Boolean]
attr_accessor :analyzed
alias_method :analyzed?, :analyzed
# A place for the SPDX data creator to record, at the package level,
# acknowledgements that may be needed to be communicated in some contexts
# Corresponds to the JSON property `attribution`
# @return [String]
attr_accessor :attribution
# Provide an independently reproducible mechanism that permits unique
# identification of a specific package that correlates to the data in this SPDX
# file
# Corresponds to the JSON property `checksum`
# @return [String]
attr_accessor :checksum
# Identify the copyright holders of the package, as well as any dates present
# Corresponds to the JSON property `copyright`
# @return [String]
attr_accessor :copyright
# A more detailed description of the package
# Corresponds to the JSON property `detailedDescription`
# @return [String]
attr_accessor :detailed_description
# This section identifies the download Universal Resource Locator (URL), or a
# specific location within a version control system (VCS) for the package at the
# time that the SPDX file was created
# Corresponds to the JSON property `downloadLocation`
# @return [String]
attr_accessor :download_location
# ExternalRef
# Corresponds to the JSON property `externalRefs`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::ExternalRef>]
attr_accessor :external_refs
# Contain the license the SPDX file creator has concluded as governing the This
# field is to contain a list of all licenses found in the package. The
# relationship between licenses (i.e., conjunctive, disjunctive) is not
# specified in this field it is simply a listing of all licenses found
# Corresponds to the JSON property `filesLicenseInfo`
# @return [Array<String>]
attr_accessor :files_license_info
# Provide a place for the SPDX file creator to record a web site that serves as
# the package's home page
# Corresponds to the JSON property `homePage`
# @return [String]
attr_accessor :home_page
# License information: https://spdx.github.io/spdx-spec/3-package-information/#
# 315-declared-license
# Corresponds to the JSON property `licenseDeclared`
# @return [Google::Apis::ContaineranalysisV1beta1::License]
attr_accessor :license_declared
# If the package identified in the SPDX file originated from a different person
# or organization than identified as Package Supplier, this field identifies
# from where or whom the package originally came
# Corresponds to the JSON property `originator`
# @return [String]
attr_accessor :originator
# The type of package: OS, MAVEN, GO, GO_STDLIB, etc.
# Corresponds to the JSON property `packageType`
# @return [String]
attr_accessor :package_type
# A short description of the package
# Corresponds to the JSON property `summaryDescription`
# @return [String]
attr_accessor :summary_description
# Identify the actual distribution source for the package/directory identified
# in the SPDX file
# Corresponds to the JSON property `supplier`
# @return [String]
attr_accessor :supplier
# Identify the full name of the package as given by the Package Originator
# Corresponds to the JSON property `title`
# @return [String]
attr_accessor :title
# This field provides an independently reproducible mechanism identifying
# specific contents of a package based on the actual files (except the SPDX file
# itself, if it is included in the package) that make up each package and that
# correlates to the data in this SPDX file
# Corresponds to the JSON property `verificationCode`
# @return [String]
attr_accessor :verification_code
# Identify the version of the package
# Corresponds to the JSON property `version`
# @return [String]
attr_accessor :version
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@analyzed = args[:analyzed] if args.key?(:analyzed)
@attribution = args[:attribution] if args.key?(:attribution)
@checksum = args[:checksum] if args.key?(:checksum)
@copyright = args[:copyright] if args.key?(:copyright)
@detailed_description = args[:detailed_description] if args.key?(:detailed_description)
@download_location = args[:download_location] if args.key?(:download_location)
@external_refs = args[:external_refs] if args.key?(:external_refs)
@files_license_info = args[:files_license_info] if args.key?(:files_license_info)
@home_page = args[:home_page] if args.key?(:home_page)
@license_declared = args[:license_declared] if args.key?(:license_declared)
@originator = args[:originator] if args.key?(:originator)
@package_type = args[:package_type] if args.key?(:package_type)
@summary_description = args[:summary_description] if args.key?(:summary_description)
@supplier = args[:supplier] if args.key?(:supplier)
@title = args[:title] if args.key?(:title)
@verification_code = args[:verification_code] if args.key?(:verification_code)
@version = args[:version] if args.key?(:version)
end
end
# PackageInfoOccurrence represents an SPDX Package Information section: https://
# spdx.github.io/spdx-spec/3-package-information/
class PackageInfoOccurrence
include Google::Apis::Core::Hashable
# A place for the SPDX file creator to record any general comments about the
# package being described
# Corresponds to the JSON property `comment`
# @return [String]
attr_accessor :comment
# Provide the actual file name of the package, or path of the directory being
# treated as a package
# Corresponds to the JSON property `filename`
# @return [String]
attr_accessor :filename
# Output only. Provide a place for the SPDX file creator to record a web site
# that serves as the package's home page
# Corresponds to the JSON property `homePage`
# @return [String]
attr_accessor :home_page
# Uniquely identify any element in an SPDX document which may be referenced by
# other elements
# Corresponds to the JSON property `id`
# @return [String]
attr_accessor :id
# License information: https://spdx.github.io/spdx-spec/3-package-information/#
# 315-declared-license
# Corresponds to the JSON property `licenseConcluded`
# @return [Google::Apis::ContaineranalysisV1beta1::License]
attr_accessor :license_concluded
# Output only. The type of package: OS, MAVEN, GO, GO_STDLIB, etc.
# Corresponds to the JSON property `packageType`
# @return [String]
attr_accessor :package_type
# Provide a place for the SPDX file creator to record any relevant background
# information or additional comments about the origin of the package
# Corresponds to the JSON property `sourceInfo`
# @return [String]
attr_accessor :source_info
# Output only. A short description of the package
# Corresponds to the JSON property `summaryDescription`
# @return [String]
attr_accessor :summary_description
# Output only. Identify the full name of the package as given by the Package
# Originator
# Corresponds to the JSON property `title`
# @return [String]
attr_accessor :title
# Output only. Identify the version of the package
# Corresponds to the JSON property `version`
# @return [String]
attr_accessor :version
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@comment = args[:comment] if args.key?(:comment)
@filename = args[:filename] if args.key?(:filename)
@home_page = args[:home_page] if args.key?(:home_page)
@id = args[:id] if args.key?(:id)
@license_concluded = args[:license_concluded] if args.key?(:license_concluded)
@package_type = args[:package_type] if args.key?(:package_type)
@source_info = args[:source_info] if args.key?(:source_info)
@summary_description = args[:summary_description] if args.key?(:summary_description)
@title = args[:title] if args.key?(:title)
@version = args[:version] if args.key?(:version)
end
end
# This message wraps a location affected by a vulnerability and its associated
# fix (if one is available).
class PackageIssue
include Google::Apis::Core::Hashable
# The location of the vulnerability.
# Corresponds to the JSON property `affectedLocation`
# @return [Google::Apis::ContaineranalysisV1beta1::VulnerabilityLocation]
attr_accessor :affected_location
# Output only. The distro or language system assigned severity for this
# vulnerability when that is available and note provider assigned severity when
# it is not available.
# Corresponds to the JSON property `effectiveSeverity`
# @return [String]
attr_accessor :effective_severity
# The location of the vulnerability.
# Corresponds to the JSON property `fixedLocation`
# @return [Google::Apis::ContaineranalysisV1beta1::VulnerabilityLocation]
attr_accessor :fixed_location
# The type of package (e.g. OS, MAVEN, GO).
# Corresponds to the JSON property `packageType`
# @return [String]
attr_accessor :package_type
# Deprecated, use Details.effective_severity instead The severity (e.g., distro
# assigned severity) for this vulnerability.
# Corresponds to the JSON property `severityName`
# @return [String]
attr_accessor :severity_name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@affected_location = args[:affected_location] if args.key?(:affected_location)
@effective_severity = args[:effective_severity] if args.key?(:effective_severity)
@fixed_location = args[:fixed_location] if args.key?(:fixed_location)
@package_type = args[:package_type] if args.key?(:package_type)
@severity_name = args[:severity_name] if args.key?(:severity_name)
end
end
# An attestation wrapper with a PGP-compatible signature. This message only
# supports `ATTACHED` signatures, where the payload that is signed is included
# alongside the signature itself in the same file.
class PgpSignedAttestation
include Google::Apis::Core::Hashable
# Type (for example schema) of the attestation payload that was signed. The
# verifier must ensure that the provided type is one that the verifier supports,
# and that the attestation payload is a valid instantiation of that type (for
# example by validating a JSON schema).
# Corresponds to the JSON property `contentType`
# @return [String]
attr_accessor :content_type
# The cryptographic fingerprint of the key used to generate the signature, as
# output by, e.g. `gpg --list-keys`. This should be the version 4, full 160-bit
# fingerprint, expressed as a 40 character hexidecimal string. See https://tools.
# ietf.org/html/rfc4880#section-12.2 for details. Implementations may choose to
# acknowledge "LONG", "SHORT", or other abbreviated key IDs, but only the full
# fingerprint is guaranteed to work. In gpg, the full fingerprint can be
# retrieved from the `fpr` field returned when calling --list-keys with --with-
# colons. For example: ``` gpg --with-colons --with-fingerprint --force-v4-certs
# \ --list-keys attester@example.com tru::1:1513631572:0:3:1:5 pub:...... fpr::::
# :::::24FF6481B76AC91E66A00AC657A93A81EF3AE6FB: ``` Above, the fingerprint is `
# 24FF6481B76AC91E66A00AC657A93A81EF3AE6FB`.
# Corresponds to the JSON property `pgpKeyId`
# @return [String]
attr_accessor :pgp_key_id
# Required. The raw content of the signature, as output by GNU Privacy Guard (
# GPG) or equivalent. Since this message only supports attached signatures, the
# payload that was signed must be attached. While the signature format supported
# is dependent on the verification implementation, currently only ASCII-armored (
# `--armor` to gpg), non-clearsigned (`--sign` rather than `--clearsign` to gpg)
# are supported. Concretely, `gpg --sign --armor --output=signature.gpg payload.
# json` will create the signature content expected in this field in `signature.
# gpg` for the `payload.json` attestation payload.
# Corresponds to the JSON property `signature`
# @return [String]
attr_accessor :signature
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@content_type = args[:content_type] if args.key?(:content_type)
@pgp_key_id = args[:pgp_key_id] if args.key?(:pgp_key_id)
@signature = args[:signature] if args.key?(:signature)
end
end
# An Identity and Access Management (IAM) policy, which specifies access
# controls for Google Cloud resources. A `Policy` is a collection of `bindings`.
# A `binding` binds one or more `members`, or principals, to a single `role`.
# Principals can be user accounts, service accounts, Google groups, and domains (
# such as G Suite). A `role` is a named list of permissions; each `role` can be
# an IAM predefined role or a user-created custom role. For some types of Google
# Cloud resources, a `binding` can also specify a `condition`, which is a
# logical expression that allows access to a resource only if the expression
# evaluates to `true`. A condition can add constraints based on attributes of
# the request, the resource, or both. To learn which resources support
# conditions in their IAM policies, see the [IAM documentation](https://cloud.
# google.com/iam/help/conditions/resource-policies). **JSON example:** ` "
# bindings": [ ` "role": "roles/resourcemanager.organizationAdmin", "members": [
# "user:mike@example.com", "group:admins@example.com", "domain:google.com", "
# serviceAccount:my-project-id@appspot.gserviceaccount.com" ] `, ` "role": "
# roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com"
# ], "condition": ` "title": "expirable access", "description": "Does not grant
# access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:
# 00:00.000Z')", ` ` ], "etag": "BwWWja0YfJA=", "version": 3 ` **YAML example:**
# bindings: - members: - user:mike@example.com - group:admins@example.com -
# domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com
# role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.
# com role: roles/resourcemanager.organizationViewer condition: title: expirable
# access description: Does not grant access after Sep 2020 expression: request.
# time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For
# a description of IAM and its features, see the [IAM documentation](https://
# cloud.google.com/iam/docs/).
class Policy
include Google::Apis::Core::Hashable
# Associates a list of `members`, or principals, with a `role`. Optionally, may
# specify a `condition` that determines how and when the `bindings` are applied.
# Each of the `bindings` must contain at least one principal. The `bindings` in
# a `Policy` can refer to up to 1,500 principals; up to 250 of these principals
# can be Google groups. Each occurrence of a principal counts towards these
# limits. For example, if the `bindings` grant 50 different roles to `user:alice@
# example.com`, and not to any other principal, then you can add another 1,450
# principals to the `bindings` in the `Policy`.
# Corresponds to the JSON property `bindings`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::Binding>]
attr_accessor :bindings
# `etag` is used for optimistic concurrency control as a way to help prevent
# simultaneous updates of a policy from overwriting each other. It is strongly
# suggested that systems make use of the `etag` in the read-modify-write cycle
# to perform policy updates in order to avoid race conditions: An `etag` is
# returned in the response to `getIamPolicy`, and systems are expected to put
# that etag in the request to `setIamPolicy` to ensure that their change will be
# applied to the same version of the policy. **Important:** If you use IAM
# Conditions, you must include the `etag` field whenever you call `setIamPolicy`.
# If you omit this field, then IAM allows you to overwrite a version `3` policy
# with a version `1` policy, and all of the conditions in the version `3` policy
# are lost.
# Corresponds to the JSON property `etag`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :etag
# Specifies the format of the policy. Valid values are `0`, `1`, and `3`.
# Requests that specify an invalid value are rejected. Any operation that
# affects conditional role bindings must specify version `3`. This requirement
# applies to the following operations: * Getting a policy that includes a
# conditional role binding * Adding a conditional role binding to a policy *
# Changing a conditional role binding in a policy * Removing any role binding,
# with or without a condition, from a policy that includes conditions **
# Important:** If you use IAM Conditions, you must include the `etag` field
# whenever you call `setIamPolicy`. If you omit this field, then IAM allows you
# to overwrite a version `3` policy with a version `1` policy, and all of the
# conditions in the version `3` policy are lost. If a policy does not include
# any conditions, operations on that policy may specify any valid version or
# leave the field unset. To learn which resources support conditions in their
# IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/
# conditions/resource-policies).
# Corresponds to the JSON property `version`
# @return [Fixnum]
attr_accessor :version
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@bindings = args[:bindings] if args.key?(:bindings)
@etag = args[:etag] if args.key?(:etag)
@version = args[:version] if args.key?(:version)
end
end
# Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31)
# and a repo name within that project.
class ProjectRepoId
include Google::Apis::Core::Hashable
# The ID of the project.
# Corresponds to the JSON property `projectId`
# @return [String]
attr_accessor :project_id
# The name of the repo. Leave empty for the default repo.
# Corresponds to the JSON property `repoName`
# @return [String]
attr_accessor :repo_name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@project_id = args[:project_id] if args.key?(:project_id)
@repo_name = args[:repo_name] if args.key?(:repo_name)
end
end
# Metadata for any related URL information.
class RelatedUrl
include Google::Apis::Core::Hashable
# Label to describe usage of the URL.
# Corresponds to the JSON property `label`
# @return [String]
attr_accessor :label
# Specific URL associated with the resource.
# Corresponds to the JSON property `url`
# @return [String]
attr_accessor :url
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@label = args[:label] if args.key?(:label)
@url = args[:url] if args.key?(:url)
end
end
# RelationshipNote represents an SPDX Relationship section: https://spdx.github.
# io/spdx-spec/7-relationships-between-SPDX-elements/
class RelationshipNote
include Google::Apis::Core::Hashable
# The type of relationship between the source and target SPDX elements
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@type = args[:type] if args.key?(:type)
end
end
# RelationshipOccurrence represents an SPDX Relationship section: https://spdx.
# github.io/spdx-spec/7-relationships-between-SPDX-elements/
class RelationshipOccurrence
include Google::Apis::Core::Hashable
# A place for the SPDX file creator to record any general comments about the
# relationship
# Corresponds to the JSON property `comment`
# @return [String]
attr_accessor :comment
# Also referred to as SPDXRef-A The source SPDX element (file, package, etc)
# Corresponds to the JSON property `source`
# @return [String]
attr_accessor :source
# Also referred to as SPDXRef-B The target SPDC element (file, package, etc) In
# cases where there are "known unknowns", the use of the keyword NOASSERTION can
# be used The keywords NONE can be used to indicate that an SPDX element (
# package/file/snippet) has no other elements connected by some relationship to
# it
# Corresponds to the JSON property `target`
# @return [String]
attr_accessor :target
# Output only. The type of relationship between the source and target SPDX
# elements
# Corresponds to the JSON property `type`
# @return [String]
attr_accessor :type
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@comment = args[:comment] if args.key?(:comment)
@source = args[:source] if args.key?(:source)
@target = args[:target] if args.key?(:target)
@type = args[:type] if args.key?(:type)
end
end
# A unique identifier for a Cloud Repo.
class RepoId
include Google::Apis::Core::Hashable
# Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31)
# and a repo name within that project.
# Corresponds to the JSON property `projectRepoId`
# @return [Google::Apis::ContaineranalysisV1beta1::ProjectRepoId]
attr_accessor :project_repo_id
# A server-assigned, globally unique identifier.
# Corresponds to the JSON property `uid`
# @return [String]
attr_accessor :uid
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@project_repo_id = args[:project_repo_id] if args.key?(:project_repo_id)
@uid = args[:uid] if args.key?(:uid)
end
end
# An entity that can have metadata. For example, a Docker image.
class Resource
include Google::Apis::Core::Hashable
# Container message for hash values.
# Corresponds to the JSON property `contentHash`
# @return [Google::Apis::ContaineranalysisV1beta1::HashProp]
attr_accessor :content_hash
# Deprecated, do not use. Use uri instead. The name of the resource. For example,
# the name of a Docker image - "Debian".
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Required. The unique URI of the resource. For example, `https://gcr.io/project/
# image@sha256:foo` for a Docker image.
# Corresponds to the JSON property `uri`
# @return [String]
attr_accessor :uri
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@content_hash = args[:content_hash] if args.key?(:content_hash)
@name = args[:name] if args.key?(:name)
@uri = args[:uri] if args.key?(:uri)
end
end
# A scan configuration specifies whether Cloud components in a project have a
# particular type of analysis being run. For example, it can configure whether
# vulnerability scanning is being done on Docker images or not.
class ScanConfig
include Google::Apis::Core::Hashable
# Output only. The time this scan config was created.
# Corresponds to the JSON property `createTime`
# @return [String]
attr_accessor :create_time
# Output only. A human-readable description of what the scan configuration does.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# Whether the scan is enabled.
# Corresponds to the JSON property `enabled`
# @return [Boolean]
attr_accessor :enabled
alias_method :enabled?, :enabled
# Output only. The name of the scan configuration in the form of `projects/[
# PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID]`.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Output only. The time this scan config was last updated.
# Corresponds to the JSON property `updateTime`
# @return [String]
attr_accessor :update_time
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@create_time = args[:create_time] if args.key?(:create_time)
@description = args[:description] if args.key?(:description)
@enabled = args[:enabled] if args.key?(:enabled)
@name = args[:name] if args.key?(:name)
@update_time = args[:update_time] if args.key?(:update_time)
end
end
# Request message for `SetIamPolicy` method.
class SetIamPolicyRequest
include Google::Apis::Core::Hashable
# An Identity and Access Management (IAM) policy, which specifies access
# controls for Google Cloud resources. A `Policy` is a collection of `bindings`.
# A `binding` binds one or more `members`, or principals, to a single `role`.
# Principals can be user accounts, service accounts, Google groups, and domains (
# such as G Suite). A `role` is a named list of permissions; each `role` can be
# an IAM predefined role or a user-created custom role. For some types of Google
# Cloud resources, a `binding` can also specify a `condition`, which is a
# logical expression that allows access to a resource only if the expression
# evaluates to `true`. A condition can add constraints based on attributes of
# the request, the resource, or both. To learn which resources support
# conditions in their IAM policies, see the [IAM documentation](https://cloud.
# google.com/iam/help/conditions/resource-policies). **JSON example:** ` "
# bindings": [ ` "role": "roles/resourcemanager.organizationAdmin", "members": [
# "user:mike@example.com", "group:admins@example.com", "domain:google.com", "
# serviceAccount:my-project-id@appspot.gserviceaccount.com" ] `, ` "role": "
# roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com"
# ], "condition": ` "title": "expirable access", "description": "Does not grant
# access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:
# 00:00.000Z')", ` ` ], "etag": "BwWWja0YfJA=", "version": 3 ` **YAML example:**
# bindings: - members: - user:mike@example.com - group:admins@example.com -
# domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com
# role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.
# com role: roles/resourcemanager.organizationViewer condition: title: expirable
# access description: Does not grant access after Sep 2020 expression: request.
# time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For
# a description of IAM and its features, see the [IAM documentation](https://
# cloud.google.com/iam/docs/).
# Corresponds to the JSON property `policy`
# @return [Google::Apis::ContaineranalysisV1beta1::Policy]
attr_accessor :policy
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@policy = args[:policy] if args.key?(:policy)
end
end
# Verifiers (e.g. Kritis implementations) MUST verify signatures with respect to
# the trust anchors defined in policy (e.g. a Kritis policy). Typically this
# means that the verifier has been configured with a map from `public_key_id` to
# public key material (and any required parameters, e.g. signing algorithm). In
# particular, verification implementations MUST NOT treat the signature `
# public_key_id` as anything more than a key lookup hint. The `public_key_id`
# DOES NOT validate or authenticate a public key; it only provides a mechanism
# for quickly selecting a public key ALREADY CONFIGURED on the verifier through
# a trusted channel. Verification implementations MUST reject signatures in any
# of the following circumstances: * The `public_key_id` is not recognized by the
# verifier. * The public key that `public_key_id` refers to does not verify the
# signature with respect to the payload. The `signature` contents SHOULD NOT be "
# attached" (where the payload is included with the serialized `signature` bytes)
# . Verifiers MUST ignore any "attached" payload and only verify signatures with
# respect to explicitly provided payload (e.g. a `payload` field on the proto
# message that holds this Signature, or the canonical serialization of the proto
# message that holds this signature).
class Signature
include Google::Apis::Core::Hashable
# The identifier for the public key that verifies this signature. * The `
# public_key_id` is required. * The `public_key_id` SHOULD be an RFC3986
# conformant URI. * When possible, the `public_key_id` SHOULD be an immutable
# reference, such as a cryptographic digest. Examples of valid `public_key_id`s:
# OpenPGP V4 public key fingerprint: * "openpgp4fpr:
# 74FAF3B861BDA0870C7B6DEF607E48D2A663AEEA" See https://www.iana.org/assignments/
# uri-schemes/prov/openpgp4fpr for more details on this scheme. RFC6920 digest-
# named SubjectPublicKeyInfo (digest of the DER serialization): * "ni:///sha-256;
# cD9o9Cq6LG3jD0iKXqEi_vdjJGecm_iXkbqVoScViaU" * "nih:///sha-256;
# 703f68f42aba2c6de30f488a5ea122fef76324679c9bf89791ba95a1271589a5"
# Corresponds to the JSON property `publicKeyId`
# @return [String]
attr_accessor :public_key_id
# The content of the signature, an opaque bytestring. The payload that this
# signature verifies MUST be unambiguously provided with the Signature during
# verification. A wrapper message might provide the payload explicitly.
# Alternatively, a message might have a canonical serialization that can always
# be unambiguously computed to derive the payload.
# Corresponds to the JSON property `signature`
# NOTE: Values are automatically base64 encoded/decoded in the client library.
# @return [String]
attr_accessor :signature
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@public_key_id = args[:public_key_id] if args.key?(:public_key_id)
@signature = args[:signature] if args.key?(:signature)
end
end
# This defines the format used to record keys used in the software supply chain.
# An in-toto link is attested using one or more keys defined in the in-toto
# layout. An example of this is: ` "key_id": "
# 776a00e29f3559e0141b3b096f696abc6cfb0c657ab40f441132b345b0...", "key_type": "
# rsa", "public_key_value": "-----BEGIN PUBLIC KEY-----\nMIIBojANBgkqhkiG9w0B..."
# , "key_scheme": "rsassa-pss-sha256" ` The format for in-toto's key definition
# can be found in section 4.2 of the in-toto specification.
class SigningKey
include Google::Apis::Core::Hashable
# key_id is an identifier for the signing key.
# Corresponds to the JSON property `keyId`
# @return [String]
attr_accessor :key_id
# This field contains the corresponding signature scheme. Eg: "rsassa-pss-sha256"
# .
# Corresponds to the JSON property `keyScheme`
# @return [String]
attr_accessor :key_scheme
# This field identifies the specific signing method. Eg: "rsa", "ed25519", and "
# ecdsa".
# Corresponds to the JSON property `keyType`
# @return [String]
attr_accessor :key_type
# This field contains the actual public key.
# Corresponds to the JSON property `publicKeyValue`
# @return [String]
attr_accessor :public_key_value
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@key_id = args[:key_id] if args.key?(:key_id)
@key_scheme = args[:key_scheme] if args.key?(:key_scheme)
@key_type = args[:key_type] if args.key?(:key_type)
@public_key_value = args[:public_key_value] if args.key?(:public_key_value)
end
end
# Source describes the location of the source used for the build.
class Source
include Google::Apis::Core::Hashable
# If provided, some of the source code used for the build may be found in these
# locations, in the case where the source repository had multiple remotes or
# submodules. This list will not include the context specified in the context
# field.
# Corresponds to the JSON property `additionalContexts`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::SourceContext>]
attr_accessor :additional_contexts
# If provided, the input binary artifacts for the build came from this location.
# Corresponds to the JSON property `artifactStorageSourceUri`
# @return [String]
attr_accessor :artifact_storage_source_uri
# A SourceContext is a reference to a tree of files. A SourceContext together
# with a path point to a unique revision of a single file or directory.
# Corresponds to the JSON property `context`
# @return [Google::Apis::ContaineranalysisV1beta1::SourceContext]
attr_accessor :context
# Hash(es) of the build source, which can be used to verify that the original
# source integrity was maintained in the build. The keys to this map are file
# paths used as build source and the values contain the hash values for those
# files. If the build source came in a single package such as a gzipped tarfile (
# .tar.gz), the FileHash will be for the single path to that file.
# Corresponds to the JSON property `fileHashes`
# @return [Hash<String,Google::Apis::ContaineranalysisV1beta1::FileHashes>]
attr_accessor :file_hashes
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@additional_contexts = args[:additional_contexts] if args.key?(:additional_contexts)
@artifact_storage_source_uri = args[:artifact_storage_source_uri] if args.key?(:artifact_storage_source_uri)
@context = args[:context] if args.key?(:context)
@file_hashes = args[:file_hashes] if args.key?(:file_hashes)
end
end
# A SourceContext is a reference to a tree of files. A SourceContext together
# with a path point to a unique revision of a single file or directory.
class SourceContext
include Google::Apis::Core::Hashable
# A CloudRepoSourceContext denotes a particular revision in a Google Cloud
# Source Repo.
# Corresponds to the JSON property `cloudRepo`
# @return [Google::Apis::ContaineranalysisV1beta1::CloudRepoSourceContext]
attr_accessor :cloud_repo
# A SourceContext referring to a Gerrit project.
# Corresponds to the JSON property `gerrit`
# @return [Google::Apis::ContaineranalysisV1beta1::GerritSourceContext]
attr_accessor :gerrit
# A GitSourceContext denotes a particular revision in a third party Git
# repository (e.g., GitHub).
# Corresponds to the JSON property `git`
# @return [Google::Apis::ContaineranalysisV1beta1::GitSourceContext]
attr_accessor :git
# Labels with user defined metadata.
# Corresponds to the JSON property `labels`
# @return [Hash<String,String>]
attr_accessor :labels
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@cloud_repo = args[:cloud_repo] if args.key?(:cloud_repo)
@gerrit = args[:gerrit] if args.key?(:gerrit)
@git = args[:git] if args.key?(:git)
@labels = args[:labels] if args.key?(:labels)
end
end
# The `Status` type defines a logical error model that is suitable for different
# programming environments, including REST APIs and RPC APIs. It is used by [
# gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
# data: error code, error message, and error details. You can find out more
# about this error model and how to work with it in the [API Design Guide](https:
# //cloud.google.com/apis/design/errors).
class Status
include Google::Apis::Core::Hashable
# The status code, which should be an enum value of google.rpc.Code.
# Corresponds to the JSON property `code`
# @return [Fixnum]
attr_accessor :code
# A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
# Corresponds to the JSON property `details`
# @return [Array<Hash<String,Object>>]
attr_accessor :details
# A developer-facing error message, which should be in English. Any user-facing
# error message should be localized and sent in the google.rpc.Status.details
# field, or localized by the client.
# Corresponds to the JSON property `message`
# @return [String]
attr_accessor :message
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@code = args[:code] if args.key?(:code)
@details = args[:details] if args.key?(:details)
@message = args[:message] if args.key?(:message)
end
end
# Request message for `TestIamPermissions` method.
class TestIamPermissionsRequest
include Google::Apis::Core::Hashable
# The set of permissions to check for the `resource`. Permissions with wildcards
# (such as '*' or 'storage.*') are not allowed. For more information see [IAM
# Overview](https://cloud.google.com/iam/docs/overview#permissions).
# Corresponds to the JSON property `permissions`
# @return [Array<String>]
attr_accessor :permissions
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@permissions = args[:permissions] if args.key?(:permissions)
end
end
# Response message for `TestIamPermissions` method.
class TestIamPermissionsResponse
include Google::Apis::Core::Hashable
# A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
# Corresponds to the JSON property `permissions`
# @return [Array<String>]
attr_accessor :permissions
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@permissions = args[:permissions] if args.key?(:permissions)
end
end
# Version contains structured information about the version of a package.
class Version
include Google::Apis::Core::Hashable
# Used to correct mistakes in the version numbering scheme.
# Corresponds to the JSON property `epoch`
# @return [Fixnum]
attr_accessor :epoch
# Whether this version is specifying part of an inclusive range. Grafeas does
# not have the capability to specify version ranges; instead we have fields that
# specify start version and end versions. At times this is insufficient - we
# also need to specify whether the version is included in the range or is
# excluded from the range. This boolean is expected to be set to true when the
# version is included in a range.
# Corresponds to the JSON property `inclusive`
# @return [Boolean]
attr_accessor :inclusive
alias_method :inclusive?, :inclusive
# Required. Distinguishes between sentinel MIN/MAX versions and normal versions.
# Corresponds to the JSON property `kind`
# @return [String]
attr_accessor :kind
# Required only when version kind is NORMAL. The main part of the version name.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The iteration of the package build from the above version.
# Corresponds to the JSON property `revision`
# @return [String]
attr_accessor :revision
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@epoch = args[:epoch] if args.key?(:epoch)
@inclusive = args[:inclusive] if args.key?(:inclusive)
@kind = args[:kind] if args.key?(:kind)
@name = args[:name] if args.key?(:name)
@revision = args[:revision] if args.key?(:revision)
end
end
# Vulnerability provides metadata about a security vulnerability in a Note.
class Vulnerability
include Google::Apis::Core::Hashable
# The CVSS score for this vulnerability.
# Corresponds to the JSON property `cvssScore`
# @return [Float]
attr_accessor :cvss_score
# Common Vulnerability Scoring System version 3. For details, see https://www.
# first.org/cvss/specification-document
# Corresponds to the JSON property `cvssV3`
# @return [Google::Apis::ContaineranalysisV1beta1::CvsSv3]
attr_accessor :cvss_v3
# All information about the package to specifically identify this vulnerability.
# One entry per (version range and cpe_uri) the package vulnerability has
# manifested in.
# Corresponds to the JSON property `details`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::Detail>]
attr_accessor :details
# Note provider assigned impact of the vulnerability.
# Corresponds to the JSON property `severity`
# @return [String]
attr_accessor :severity
# 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.
# Corresponds to the JSON property `sourceUpdateTime`
# @return [String]
attr_accessor :source_update_time
# 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.
# Corresponds to the JSON property `windowsDetails`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::WindowsDetail>]
attr_accessor :windows_details
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@cvss_score = args[:cvss_score] if args.key?(:cvss_score)
@cvss_v3 = args[:cvss_v3] if args.key?(:cvss_v3)
@details = args[:details] if args.key?(:details)
@severity = args[:severity] if args.key?(:severity)
@source_update_time = args[:source_update_time] if args.key?(:source_update_time)
@windows_details = args[:windows_details] if args.key?(:windows_details)
end
end
# The location of the vulnerability.
class VulnerabilityLocation
include Google::Apis::Core::Hashable
# Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/)
# format. Examples include distro or storage location for vulnerable jar.
# Corresponds to the JSON property `cpeUri`
# @return [String]
attr_accessor :cpe_uri
# Required. The package being described.
# Corresponds to the JSON property `package`
# @return [String]
attr_accessor :package
# Version contains structured information about the version of a package.
# Corresponds to the JSON property `version`
# @return [Google::Apis::ContaineranalysisV1beta1::Version]
attr_accessor :version
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@cpe_uri = args[:cpe_uri] if args.key?(:cpe_uri)
@package = args[:package] if args.key?(:package)
@version = args[:version] if args.key?(:version)
end
end
# A summary of how many vulnerability occurrences there are per resource and
# severity type.
class VulnerabilityOccurrencesSummary
include Google::Apis::Core::Hashable
# A listing by resource of the number of fixable and total vulnerabilities.
# Corresponds to the JSON property `counts`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::FixableTotalByDigest>]
attr_accessor :counts
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@counts = args[:counts] if args.key?(:counts)
end
end
#
class WindowsDetail
include Google::Apis::Core::Hashable
# Required. The CPE URI in [cpe format](https://cpe.mitre.org/specification/) in
# which the vulnerability manifests. Examples include distro or storage location
# for vulnerable jar.
# Corresponds to the JSON property `cpeUri`
# @return [String]
attr_accessor :cpe_uri
# The description of the vulnerability.
# Corresponds to the JSON property `description`
# @return [String]
attr_accessor :description
# 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 kb's presence is
# considered a fix.
# Corresponds to the JSON property `fixingKbs`
# @return [Array<Google::Apis::ContaineranalysisV1beta1::KnowledgeBase>]
attr_accessor :fixing_kbs
# Required. The name of the vulnerability.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
def initialize(**args)
update!(**args)
end
# Update properties of this object
def update!(**args)
@cpe_uri = args[:cpe_uri] if args.key?(:cpe_uri)
@description = args[:description] if args.key?(:description)
@fixing_kbs = args[:fixing_kbs] if args.key?(:fixing_kbs)
@name = args[:name] if args.key?(:name)
end
end
end
end
end