H B' S r SSKJr SSKJr SSKJr SSKJr Sr " S S\R 5 r " S S
\R 5 r " S S \R 5 r
" S
S\R 5 r " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S \R 5 r " S S \R 5 r " S S \R 5 r " S! S"\R 5 r " S# S$\R 5 r " S% S&\R 5 r " S' S(\R 5 r " S) S*\R 5 r " S+ S,\R 5 r " S- S.\R 5 r " S/ S0\R 5 r " S1 S2\R 5 r " S3 S4\R 5 r! " S5 S6\R 5 r" " S7 S8\R 5 r# " S9 S:\R 5 r$ " S; S<\R 5 r% " S= S>\R 5 r& " S? S@\R 5 r' " SA SB\R 5 r( " SC SD\R 5 r) " SE SF\R 5 r* " SG SH\R 5 r+ " SI SJ\R 5 r, " SK SL\R 5 r- " SM SN\R 5 r. " SO SP\R 5 r/ " SQ SR\R 5 r0 " SS ST\R 5 r1 " SU SV\R 5 r2 " SW SX\R 5 r3 " SY SZ\R 5 r4 " S[ S\\R 5 r5 " S] S^\R 5 r6 " S_ S`\R 5 r7 " Sa Sb\R 5 r8 " Sc Sd\R 5 r9 " Se Sf\R 5 r: " Sg Sh\R 5 r; " Si Sj\R 5 r< " Sk Sl\R 5 r= " Sm Sn\R 5 r> " So Sp\R 5 r? " Sq Sr\R 5 r@ " Ss St\R 5 rA " Su Sv\R 5 rB " Sw Sx\R 5 rC " Sy Sz\R 5 rD " S{ S|\R 5 rE " S} S~\R 5 rF " S S\R 5 rG " S S\R 5 rH " S S\R 5 rI " S S\R 5 rJ " S S\R 5 rK " S S\R 5 rL " S S\R 5 rM " S S\R 5 rN " S S\R 5 rO " S S\R 5 rP " S S\R 5 rQ " S S\R 5 rR " S S\R 5 rS " S S\R 5 rT " S S\R 5 rU " S S\R 5 rV " S S\R 5 rW " S S\R 5 rX " S S\R 5 rY " S S\R 5 rZ " S S\R 5 r[ " S S\R 5 r\ " S S\R 5 r] " S S\R 5 r^ " S S\R 5 r_ " S S\R 5 r` " S S\R 5 ra " S S\R 5 rb " S S\R 5 rc " S S\R 5 rd " S S\R 5 re " S S\R 5 rf " S S\R 5 rg " S S\R 5 rh " S S\R 5 ri " S S\R 5 rj " S S\R 5 rk " S S\R 5 rl " S S\R 5 rm " S S\R 5 rn " S S\R 5 ro " S S\R 5 rp " S S\R 5 rq " S S\R 5 rr " S S\R 5 rs " S S\R 5 rt " S S\R 5 ru " S S\R 5 rv " S S\R 5 rw " S S\R 5 rx " S S\R 5 ry " S S\R 5 rz " S S\R 5 r{ " S S\R 5 r| " S S\R 5 r} " S S\R 5 r~ " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S\R 5 r " S GS \R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS
\R 5 r " GS GS \R 5 r " GS
GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS \R 5 r " GS GS \R 5 r " GS GS \R 5 r " GS! GS"\R 5 r " GS# GS$\R 5 r " GS% GS&\R 5 r " GS' GS(\R 5 r " GS) GS*\R 5 r " GS+ GS,\R 5 r " GS- GS.\R 5 r " GS/ GS0\R 5 r " GS1 GS2\R 5 r " GS3 GS4\R 5 r " GS5 GS6\R 5 r " GS7 GS8\R 5 r " GS9 GS:\R 5 r " GS; GS<\R 5 r " GS= GS>\R 5 r " GS? GS@\R 5 r " GSA GSB\R 5 r " GSC GSD\R 5 r " GSE GSF\R 5 r " GSG GSH\R 5 r " GSI GSJ\R 5 r " GSK GSL\R 5 r " GSM GSN\R 5 r " GSO GSP\R 5 r " GSQ GSR\R 5 r " GSS GST\R 5 r " GSU GSV\R 5 r " GSW GSX\R 5 r " GSY GSZ\R 5 r " GS[ GS\\R 5 r " GS] GS^\R 5 r " GS_ GS`\R 5 r " GSa GSb\R 5 r " GSc GSd\R 5 r " GSe GSf\R 5 r " GSg GSh\R 5 r " GSi GSj\R 5 r " GSk GSl\R 5 r " GSm GSn\R 5 r " GSo GSp\R 5 r " GSq GSr\R 5 r " GSs GSt\R 5 r " GSu GSv\R 5 r " GSw GSx\R 5 r " GSy GSz\R 5 r " GS{ GS|\R 5 r " GS} GS~\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r " GS GS\R 5 r\GR " \GSGS5 \GR " \GR GSGS5 \GR " \GR GSGS5 Gg( af Generated message classes for containeranalysis version v1alpha1.
This API is a prerequisite for leveraging Artifact Analysis scanning
capabilities in Artifact Registry. In addition, the Container Analysis API is
an implementation of the Grafeas API, which enables storing, querying, and
retrieval of critical metadata about all of your software artifacts.
)absolute_import)messages)encoding) extra_typescontaineranalysisc : \ rS rSrSr\R " SSS9rSrg)AnalysisCompleted zIndicates which analysis completed successfully. Multiple types of
analysis can be performed on a single resource.
Fields:
analysisType: type of analysis that were completed on a resource.
Trepeated N) __name__
__module__ __qualname____firstlineno____doc__ _messages StringField analysisType__static_attributes__r klib/googlecloudsdk/generated_clients/apis/containeranalysis/v1alpha1/containeranalysis_v1alpha1_messages.pyr r s &&q48,r r c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r \R " SSS9r
S r g
) Artifact aO Artifact describes a build product.
Fields:
checksum: Hash or checksum value of a binary, or Docker Registry 2.0
digest of a container.
id: Artifact ID, if any; for container images, this will be a URL by
digest like gcr.io/projectID/imagename@sha256:123456
name: Name of the artifact. 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`. This
field is deprecated in favor of the plural `names` field; it continues
to exist here to allow existing BuildProvenance serialized to json in
google.devtools.containeranalysis.v1alpha1.BuildDetails.provenance_bytes
to deserialize back into proto.
names: 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.
r Tr r N) r r r r r r r checksumidnamenamesr r r r r r sK *
"
"1
%( Q " q !$
D
1%r r c \ rS rSrSr " S S\R 5 r\R " S5 r \R " SSS9r
\R " S S
5 r \R " S 5 r
\R " S S
SS9r\R " SSSS9r\R " S5 r\R" " SS5 r\R " S5 rSrg)
Assessment; a Assessment provides all information that is related to a single
vulnerability for this product.
Enums:
StateValueValuesEnum: Provides the state of this Vulnerability assessment.
Fields:
cve: Holds the MITRE standard Common Vulnerabilities and Exposures (CVE)
tracking number for the vulnerability.
impacts: Contains information about the impact of this vulnerability, this
will change with time.
justification: Justification provides the justification when the state of
the assessment if NOT_AFFECTED.
longDescription: A detailed description of this Vex.
relatedUris: Holds a list of references associated with this vulnerability
item and assessment. These uris have additional information about the
vulnerability and the assessment itself. E.g. Link to a document which
details how this assessment concluded the state of this vulnerability.
remediations: Specifies details on how to handle (and presumably, fix) a
vulnerability.
shortDescription: A one sentence description of this Vex.
state: Provides the state of this Vulnerability assessment.
vulnerabilityId: The vulnerability identifier for this Assessment. Will
hold one of common identifiers e.g. CVE, GHSA etc.
c , \ rS rSrSrSrSrSrSrSr Sr
g )
Assessment.StateValueValuesEnumV Provides the state of this Vulnerability assessment.
Values:
STATE_UNSPECIFIED: No state is specified.
AFFECTED: This product is known to be affected by this vulnerability.
NOT_AFFECTED: This product is known to be not affected by this
vulnerability.
FIXED: This product contains a fix for this vulnerability.
UNDER_INVESTIGATION: It is not known yet whether these versions are or
are not affected by the vulnerability. However, it is still under
investigation.
r r r r r r N r r r r r STATE_UNSPECIFIEDAFFECTED NOT_AFFECTEDFIXEDUNDER_INVESTIGATIONr r r r StateValueValuesEnumr( V $ HL
Er r1 r r Tr
Justificationr r URI Remediation r N)r r r r r r Enumr1 r cveimpacts MessageField
justificationlongDescription relatedUris remediationsshortDescription EnumFieldstatevulnerabilityIdr r r r r% r% ; s 4 Y^^ & a # ! !!d 3'(( !<- ))!,/&&ua$?+''
q4H, **1-
4a
8% ))!,/r r% c > \ rS rSrSr\R " SS5 rSrg) Attestationt aU 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
AttestationAuthority 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).
Fields:
pgpSignedAttestation: A PgpSignedAttestation attribute.
PgpSignedAttestationr r N) r r r r r r r> pgpSignedAttestationr r r r rH rH t s #//0FJr rH c > \ rS rSrSr\R " SS5 rSrg)AttestationAuthority ag Note kind that represents a logical attestation "role" or "authority".
For example, an organization might have one `AttestationAuthority` for "QA"
and one for "build". This Note is intended to act strictly as a grouping
mechanism for the attached Occurrences (Attestations). This grouping
mechanism also provides a security boundary, since IAM ACLs gate the ability
for a principle to attach an Occurrence to a given Note. It also provides a
single point of lookup to find all attached Attestation Occurrences, even if
they don't all live in the same project.
Fields:
hint: A AttestationAuthorityHint attribute.
AttestationAuthorityHintr r N r r r r r r r> hintr r r r rM rM s
:A >$r rM c < \ rS rSrSr\R " S5 rSrg)rO aA This submessage provides human-readable hints about the purpose of the
AttestationAuthority. 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 AttestationAuthorities in security sensitive contexts, such as when
looking up Attestations to verify.
Fields:
humanReadableName: The human readable name of this Attestation Authority,
for example "qa".
r r N r r r r r r r humanReadableNamer r r r rO rO s ++A.r rO c \ rS rSrSr\R " S\R R S9r \R " S5 r \R " S5 r Sr
g) BaseImage zBaseImage describes a base image of a container image.
Fields:
layerCount: The number of layers that the base image is composed of.
name: The name of the base image.
repository: The repository name in which the base image is from.
r variantr r r N)r r r r r r IntegerFieldVariantINT32
layerCountr r"
repositoryr r r r rW rW sG %%a1B1B1H1HI* q !$$$Q'*r rW c b \ rS rSrSr\R " SS5 r\R " S5 r Sr
g)Basis a} 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.
Fields:
fingerprint: The fingerprint of the base image.
resourceUrl: The resource_url for the resource representing the basis of
associated occurrence images.
Fingerprintr r r N) r r r r r r r> fingerprintr resourceUrlr r r r ra ra s+ &&}a8+%%a(+r ra c \ rS rSrSr\R " SS5 r\R " SSS9r \R " S5 r
S r g
) Binding at Associates `members`, or principals, with a `role`.
Fields:
condition: The condition that is associated with this binding. If the
condition evaluates to `true`, then this binding applies to the current
request. If the condition evaluates to `false`, then this binding does
not apply to the current request. However, a different role binding
might grant the same role to one or more of the principals in this
binding. To learn which resources support conditions in their IAM
policies, see the [IAM
documentation](https://cloud.google.com/iam/help/conditions/resource-
policies).
members: Specifies the principals requesting access for a Google Cloud
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. Does not include identities that come from
external identity providers (IdPs) through identity federation. *
`user:{emailid}`: An email address that represents a specific Google
account. For example, `alice@example.com` . *
`serviceAccount:{emailid}`: An email address that represents a Google
service account. For example, `my-other-
app@appspot.gserviceaccount.com`. *
`serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`:
An identifier for a [Kubernetes service
account](https://cloud.google.com/kubernetes-engine/docs/how-
to/kubernetes-service-accounts). For example, `my-
project.svc.id.goog[my-namespace/my-kubernetes-sa]`. *
`group:{emailid}`: An email address that represents a Google group. For
example, `admins@example.com`. * `domain:{domain}`: The G Suite domain
(primary) that represents all the users of that domain. For example,
`google.com` or `example.com`. * `principal://iam.googleapis.com/locatio
ns/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A
single identity in a workforce identity pool. * `principalSet://iam.goog
leapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`:
All workforce identities in a group. * `principalSet://iam.googleapis.co
m/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{
attribute_value}`: All workforce identities with a specific attribute
value. * `principalSet://iam.googleapis.com/locations/global/workforcePo
ols/{pool_id}/*`: All identities in a workforce identity pool. * `princi
pal://iam.googleapis.com/projects/{project_number}/locations/global/work
loadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single
identity in a workload identity pool. * `principalSet://iam.googleapis.c
om/projects/{project_number}/locations/global/workloadIdentityPools/{poo
l_id}/group/{group_id}`: A workload identity pool group. * `principalSet
://iam.googleapis.com/projects/{project_number}/locations/global/workloa
dIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`:
All identities in a workload identity pool with a certain attribute. * `
principalSet://iam.googleapis.com/projects/{project_number}/locations/gl
obal/workloadIdentityPools/{pool_id}/*`: All identities in a workload
identity pool. * `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. * `deleted:principal://iam.google
apis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attr
ibute_value}`: Deleted single identity in a workforce identity pool. For
example, `deleted:principal://iam.googleapis.com/locations/global/workfo
rcePools/my-pool-id/subject/my-subject-attribute-value`.
role: Role that is assigned to the list of `members`, or principals. For
example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an
overview of the IAM roles and permissions, see the [IAM
documentation](https://cloud.google.com/iam/docs/roles-overview). For a
list of the available pre-defined roles, see
[here](https://cloud.google.com/iam/docs/understanding-roles).
Exprr r Tr r r N) r r r r r r r> conditionr membersroler r r r rg rg s? Ob $$VQ/) ! !!d 3' q !$r rg c T \ rS rSrSr\R " S5 " S S\R 5 5 r \R " S5 " S S\R 5 5 r
\R " S5 r \R " SS 5 r\R " SS
5 r\R " S S S
S9rSrg)BuildDefinitioni aw A BuildDefinition object.
Messages:
ExternalParametersValue: A ExternalParametersValue object.
InternalParametersValue: A InternalParametersValue object.
Fields:
buildType: A string attribute.
externalParameters: A ExternalParametersValue attribute.
internalParameters: A InternalParametersValue attribute.
resolvedDependencies: A ResourceDescriptor attribute.
additionalPropertiesc f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
'BuildDefinition.ExternalParametersValuei) zA ExternalParametersValue object.
Messages:
AdditionalProperty: An additional property for a ExternalParametersValue
object.
Fields:
additionalProperties: Properties of the object.
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g):BuildDefinition.ExternalParametersValue.AdditionalPropertyi5 zAn additional property for a ExternalParametersValue object.
Fields:
key: Name of the additional property.
value: A extra_types.JsonValue attribute.
r extra_types.JsonValuer r N r r r r r r r keyr> valuer r r r AdditionalPropertyrs 5 ,
! !! $c$$% ro r r r r ExternalParametersValuerq ) 4 AY . . A %112FTXYr r| c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
'BuildDefinition.InternalParametersValueiB zA InternalParametersValue object.
Messages:
AdditionalProperty: An additional property for a InternalParametersValue
object.
Fields:
additionalProperties: Properties of the object.
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g):BuildDefinition.InternalParametersValue.AdditionalPropertyiN zAn additional property for a InternalParametersValue object.
Fields:
key: Name of the additional property.
value: A extra_types.JsonValue attribute.
r rt r r Nru r r r rx r N ry r rx r Tr r Nrz r r r InternalParametersValuer B r} r r r r r ResourceDescriptorr Tr r N)r r r r r r MapUnrecognizedFieldsr r{ r| r r buildTyper> externalParametersinternalParametersresolvedDependenciesr r r r rn rn s !!"89Z 1 1 Z :Z0 !!"89Z 1 1 Z :Z0 ##A&) --.GK --.GK"//0DaRVWr rn c \ rS rSrSr\R " SS5 r\R " SS5 r\R " SS5 r \R " S S
5 r
\R " S 5 r S r
g
) BuildDetailsia aO Message encapsulating build provenance details.
Fields:
inTotoSlsaProvenanceV1: In-Toto Slsa Provenance V1 represents a slsa
provenance meeting the slsa spec, wrapped in an in-toto statement. This
allows for direct jsonification of a to-spec in-toto slsa statement with
a to-spec slsa provenance.
intotoProvenance: Deprecated. See InTotoStatement for the replacement. In-
toto Provenance representation as defined in spec.
intotoStatement: In-toto Statement representation as defined in spec. The
intoto_statement can contain any type of provenance. The serialized
payload of the statement can be stored and signed in the Occurrence's
envelope.
provenance: The actual provenance
provenanceBytes: Serialized JSON representation of the provenance, used in
generating the `BuildSignature` in the corresponding Result. 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.
InTotoSlsaProvenanceV1r InTotoProvenancer InTotoStatementr BuildProvenancer r5 r N)r r r r r r r> inTotoSlsaProvenanceV1intotoProvenanceintotoStatement
provenancer provenanceBytesr r r r r r a sg 2 %112JAN ++,>B **+ buildOptionsr builderVersionbuiltArtifactscommands
createTimecreator
finishTimer!
logsBucket projectIdsourceProvenance startTime triggerIdr r r r r r s : !!"89Z)++ Z :Z2 ''(;Q?, ((+. ))*a$G.
#
#Iq4
@($$Q'* ! !! $'$$Q'* Q "$$Q'*##B') ++Hb9##B')##B')r r c \ rS rSrSr " S S\R 5 r\R " S5 r \R " SS5 r \R " S5 r \R " S5 r
S rg
) BuildSignaturei ax Message encapsulating the signature of the verified build.
Enums:
KeyTypeValueValuesEnum: The type of the key, either stored in `public_key`
or referenced in `key_id`
Fields:
keyId: 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).
keyType: The type of the key, either stored in `public_key` or referenced
in `key_id`
publicKey: 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`
signature: Signature of the related `BuildProvenance`, encoded in a base64
string.
c $ \ rS rSrSrSrSrSrSrg)%BuildSignature.KeyTypeValueValuesEnumi zThe type of the key, either stored in `public_key` or referenced in
`key_id`
Values:
KEY_TYPE_UNSPECIFIED: `KeyType` is not set.
PGP_ASCII_ARMORED: `PGP ASCII Armored` public key.
PKIX_PEM: `PKIX PEM` public key.
r r r r N) r r r r r KEY_TYPE_UNSPECIFIEDPGP_ASCII_ARMOREDPKIX_PEMr r r r KeyTypeValueValuesEnumr s Hr r r r r r r N)r r r r r r r; r r keyIdrD keyType publicKey signaturer r r r r r s\ 6 y~~
"% 8! <'##A&)##A&)r r c ^ \ rS rSrSr " S S\R 5 r\R " SS\R R S9r \R " S5 r
\R " S SS
9r\R " S 5 r\R " S 5 r\R " S
5 r\R " SSS
9r\R " S\R R S9r\R " S5 r\R " S5 r\R. " SS5 r\R " S5 r\R. " SSSS
9r\R " S5 r\R " SSS
9r \R: " SS5 r \R " S5 r \R. " SS 5 r \R. " S S SS
9r!\R " S SS
9r"S r#g!)" BuildStepi a[ A step in the build pipeline. Next ID: 23
Enums:
StatusValueValuesEnum: 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.
Fields:
allowExitCodes: Allow this build step to fail without failing the entire
build if and only if the exit code is one of the specified codes. If
allow_failure is also specified, this field will take precedence.
allowFailure: Allow this build step to fail without failing the entire
build. If false, the entire build will fail if this step fails.
Otherwise, the build will succeed, but this step will still have a
failure status. Error information will be reported in the failure_detail
field.
args: 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.
automapSubstitutions: Option to include built-in and custom substitutions
as env variables for this build step. This option will override the
global option in BuildOption.
dir: 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.
entrypoint: Entrypoint to be used instead of the build step image's
default entrypoint. If unset, the image's default entrypoint is used.
env: 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".
exitCode: Output only. Return code from running the step.
id: Unique identifier for this build step, used in `wait_for` to reference
this build step as a dependency.
name: 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.
pullTiming: Output only. Stores timing information for pulling this build
step's builder image only.
remoteConfig: Remote configuration for the build step.
results: A StepResult attribute.
script: A shell script to be executed in the step. When script is
provided, the user cannot specify the entrypoint or args.
secretEnv: 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`.
status: 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.
timeout: 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.
timing: Output only. Stores timing information for executing this build
step.
volumes: 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.
waitFor: 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.
c D \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
S rS
rSrg) BuildStep.StatusValueValuesEnumiY aI 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.
Values:
STATUS_UNKNOWN: Status of the build is unknown.
PENDING: Build has been created and is pending execution and queuing. It
has not been queued.
QUEUING: Build has been received and is being queued.
QUEUED: Build or step is queued; work has not yet begun.
WORKING: Build or step is being executed.
SUCCESS: Build or step finished successfully.
FAILURE: Build or step failed to complete successfully.
INTERNAL_ERROR: Build or step failed due to an internal cause.
TIMEOUT: Build or step took longer than was allowed.
CANCELLED: Build or step was canceled by a user.
EXPIRED: Build was enqueued for longer than the value of `queue_ttl`.
r r r r r r5 r7 r8 r9 r: r r N)r r r r r STATUS_UNKNOWNPENDINGQUEUINGQUEUEDWORKINGSUCCESSFAILUREINTERNAL_ERRORTIMEOUT CANCELLEDEXPIREDr r r r StatusValueValuesEnumr Y s@ $ NGG
FGGGNGIGr r r Tr
rZ r r r r r5 r7 r8 r9 rY r: r TimeSpanr r
StepResultr Volume r
r N)$r r r r r r r; r r[ r\ r] allowExitCodes BooleanField allowFailurer argsautomapSubstitutionsdir
entrypointenvexitCoder! r" r>
pullTiming remoteConfigresultsscript secretEnvrD statustimeouttimingvolumeswaitForr r r r r r s Pd inn > ))!dIDUDUD[D[\.''*, q4 0$"//2 a #$$Q'* a$/#
#
#Ay/@/@/F/F
G( Q " r "$%%j"5*&&r*, " "<d C' $&##B6) 6 ;& ! !" %' ! !*b 1& " "8R$ ?' ! !"t 4'r r c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g) BuildTypei a1 Note holding the version of the provider's builder and the signature of
the provenance message in linked BuildDetails.
Fields:
builderVersion: Version of the builder which produced this Note.
signature: Signature of the build in Occurrences pointing to the Note
containing this `BuilderDetails`.
r r r r N) r r r r r r r r r> r r r r r r r s, ((+.$$%5q9)r r c < \ rS rSrSr\R " S5 rSrg)
BuilderConfigi z;A BuilderConfig object.
Fields:
id: A string attribute.
r r N r r r r r r r r! r r r r r r Q "r r c < \ rS rSrSr\R " S5 rSrg)!CISAKnownExploitedVulnerabilitiesi a* CISAKnownExploitedVulnerabilities provides information about whether the
vulnerability is known to have been leveraged as part of a ransomware
campaign.
Fields:
knownRansomwareCampaignUse: Optional. Whether the vulnerability is known
to have been leveraged as part of a ransomware campaign.
r r N) r r r r r r r knownRansomwareCampaignUser r r r r r s ) 4 4Q 7 r r c \ rS rSrSr " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S
\R 5 r
" S S \R 5 r " S
S\R 5 r " S S\R 5 r
" S S\R 5 r " S S\R 5 r\R " SS5 r\R " SS5 r\R " SS5 r\R " S
S5 r\R* " S\R, R. S9r\R " S S5 r\R* " S \R, R. S9r\R* " S \R, R. S9r\R " SS 5 r \R " SS 5 r \R " SS 5 r \R " SS!5 r S"r g#)$CVSSi a Common Vulnerability Scoring System. This message is compatible with
CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide
CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For
CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS
v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator
Enums:
AttackComplexityValueValuesEnum: Defined in CVSS v3, CVSS v2
AttackVectorValueValuesEnum: Base Metrics Represents the intrinsic
characteristics of a vulnerability that are constant over time and
across user environments. Defined in CVSS v3, CVSS v2
AuthenticationValueValuesEnum: Defined in CVSS v2
AvailabilityImpactValueValuesEnum: Defined in CVSS v3, CVSS v2
ConfidentialityImpactValueValuesEnum: Defined in CVSS v3, CVSS v2
IntegrityImpactValueValuesEnum: Defined in CVSS v3, CVSS v2
PrivilegesRequiredValueValuesEnum: Defined in CVSS v3
ScopeValueValuesEnum: Defined in CVSS v3
UserInteractionValueValuesEnum: Defined in CVSS v3
Fields:
attackComplexity: Defined in CVSS v3, CVSS v2
attackVector: Base Metrics Represents the intrinsic characteristics of a
vulnerability that are constant over time and across user environments.
Defined in CVSS v3, CVSS v2
authentication: Defined in CVSS v2
availabilityImpact: Defined in CVSS v3, CVSS v2
baseScore: The base score is a function of the base metric scores.
confidentialityImpact: Defined in CVSS v3, CVSS v2
exploitabilityScore: A number attribute.
impactScore: A number attribute.
integrityImpact: Defined in CVSS v3, CVSS v2
privilegesRequired: Defined in CVSS v3
scope: Defined in CVSS v3
userInteraction: Defined in CVSS v3
c ( \ rS rSrSrSrSrSrSrSr g) $CVSS.AttackComplexityValueValuesEnumi zDefined in CVSS v3, CVSS v2
Values:
ATTACK_COMPLEXITY_UNSPECIFIED: Defined in CVSS v3, CVSS v2
ATTACK_COMPLEXITY_LOW: Defined in CVSS v3, CVSS v2
ATTACK_COMPLEXITY_HIGH: Defined in CVSS v3, CVSS v2
ATTACK_COMPLEXITY_MEDIUM: Defined in CVSS v2
r r r r r N)
r r r r r ATTACK_COMPLEXITY_UNSPECIFIEDATTACK_COMPLEXITY_LOWATTACK_COMPLEXITY_HIGHATTACK_COMPLEXITY_MEDIUMr r r r AttackComplexityValueValuesEnumr s! %&! r r c , \ rS rSrSrSrSrSrSrSr Sr
g )
CVSS.AttackVectorValueValuesEnumi a Base Metrics Represents the intrinsic characteristics of a
vulnerability that are constant over time and across user environments.
Defined in CVSS v3, CVSS v2
Values:
ATTACK_VECTOR_UNSPECIFIED: Defined in CVSS v3, CVSS v2
ATTACK_VECTOR_NETWORK: Defined in CVSS v3, CVSS v2
ATTACK_VECTOR_ADJACENT: Defined in CVSS v3, CVSS v2
ATTACK_VECTOR_LOCAL: Defined in CVSS v3, CVSS v2
ATTACK_VECTOR_PHYSICAL: Defined in CVSS v3
r r r r r r N) r r r r r ATTACK_VECTOR_UNSPECIFIEDATTACK_VECTOR_NETWORKATTACK_VECTOR_ADJACENTATTACK_VECTOR_LOCALATTACK_VECTOR_PHYSICALr r r r AttackVectorValueValuesEnumr s'
!" r r c ( \ rS rSrSrSrSrSrSrSr g) "CVSS.AuthenticationValueValuesEnumi zDefined in CVSS v2
Values:
AUTHENTICATION_UNSPECIFIED: Defined in CVSS v2
AUTHENTICATION_MULTIPLE: Defined in CVSS v2
AUTHENTICATION_SINGLE: Defined in CVSS v2
AUTHENTICATION_NONE: Defined in CVSS v2
r r r r r N)
r r r r r AUTHENTICATION_UNSPECIFIEDAUTHENTICATION_MULTIPLEAUTHENTICATION_SINGLEAUTHENTICATION_NONEr r r r AuthenticationValueValuesEnumr s! "# r r
c 0 \ rS rSrSrSrSrSrSrSr Sr
S r g
) &CVSS.AvailabilityImpactValueValuesEnumi Defined in CVSS v3, CVSS v2
Values:
IMPACT_UNSPECIFIED: Defined in CVSS v3, CVSS v2
IMPACT_HIGH: Defined in CVSS v3
IMPACT_LOW: Defined in CVSS v3
IMPACT_NONE: Defined in CVSS v3, CVSS v2
IMPACT_PARTIAL: Defined in CVSS v2
IMPACT_COMPLETE: Defined in CVSS v2
r r r r r r5 r N r r r r r IMPACT_UNSPECIFIED IMPACT_HIGH
IMPACT_LOW IMPACT_NONEIMPACT_PARTIALIMPACT_COMPLETEr r r r !AvailabilityImpactValueValuesEnumr ( KJKNOr r c 0 \ rS rSrSrSrSrSrSrSr Sr
S r g
) )CVSS.ConfidentialityImpactValueValuesEnumi r r r r r r r5 r Nr r r r $ConfidentialityImpactValueValuesEnumr r r r c 0 \ rS rSrSrSrSrSrSrSr Sr
S r g
) #CVSS.IntegrityImpactValueValuesEnumi* r r r r r r r5 r Nr r r r IntegrityImpactValueValuesEnumr * r r r c ( \ rS rSrSrSrSrSrSrSr g) &CVSS.PrivilegesRequiredValueValuesEnumi< zDefined in CVSS v3
Values:
PRIVILEGES_REQUIRED_UNSPECIFIED: Defined in CVSS v3
PRIVILEGES_REQUIRED_NONE: Defined in CVSS v3
PRIVILEGES_REQUIRED_LOW: Defined in CVSS v3
PRIVILEGES_REQUIRED_HIGH: Defined in CVSS v3
r r r r r N)
r r r r r PRIVILEGES_REQUIRED_UNSPECIFIEDPRIVILEGES_REQUIRED_NONEPRIVILEGES_REQUIRED_LOWPRIVILEGES_REQUIRED_HIGHr r r r !PrivilegesRequiredValueValuesEnumr! < s! '(# r r& c $ \ rS rSrSrSrSrSrSrg)CVSS.ScopeValueValuesEnumiJ zDefined in CVSS v3
Values:
SCOPE_UNSPECIFIED: Defined in CVSS v3
SCOPE_UNCHANGED: Defined in CVSS v3
SCOPE_CHANGED: Defined in CVSS v3
r r r r N) r r r r r SCOPE_UNSPECIFIEDSCOPE_UNCHANGED
SCOPE_CHANGEDr r r r ScopeValueValuesEnumr( J s OMr r, c $ \ rS rSrSrSrSrSrSrg)#CVSS.UserInteractionValueValuesEnumiV zDefined in CVSS v3
Values:
USER_INTERACTION_UNSPECIFIED: Defined in CVSS v3
USER_INTERACTION_NONE: Defined in CVSS v3
USER_INTERACTION_REQUIRED: Defined in CVSS v3
r r r r N) r r r r r USER_INTERACTION_UNSPECIFIEDUSER_INTERACTION_NONEUSER_INTERACTION_REQUIREDr r r r UserInteractionValueValuesEnumr. V s $% ! r r2 r r r r r5 rY r7 r8 r9 r: r r r r N)!r r r r r r r; r r r
r r r r& r, r2 rD attackComplexity attackVectorauthenticationavailabilityImpact
FloatFieldr\ FLOAT baseScoreconfidentialityImpactexploitabilityScore impactScoreintegrityImpactprivilegesRequiredscopeuserInteractionr r r r r r s "H ! ! INN $ inn ).. $Y^^ $y~~ $ !).. !
Y^^
"y~~
" (()JAN$$%BAF, &&'FJ. **+NPQR""1i.?.?.E.EF)#--.TVWX!,,Q 8I8I8O8OP$$Q 0A0A0G0GH+ ''(H!L/ **+NPRS
4b
9% ''(H"M/r r c \ rS rSrSr " S S\R 5 r\R " S\R R S9r \R " SS5 r
Srg )
CisBenchmarkip a A compliance check that is a CIS benchmark.
Enums:
SeverityValueValuesEnum: The severity level of this CIS benchmark check.
Fields:
profileLevel: The profile level of this CIS benchmark check.
severity: The severity level of this CIS benchmark check.
c 0 \ rS rSrSrSrSrSrSrSr Sr
S r g
) $CisBenchmark.SeverityValueValuesEnumi{ zThe severity level of this CIS benchmark check.
Values:
SEVERITY_UNSPECIFIED: Unknown Impact
MINIMAL: Minimal Impact
LOW: Low Impact
MEDIUM: Medium Impact
HIGH: High Impact
CRITICAL: Critical Impact
r r r r r r5 r N r r r r r SEVERITY_UNSPECIFIEDMINIMALLOWMEDIUMHIGHCRITICALr r r r SeverityValueValuesEnumrD { ( G
C
F DHr rL r rY r r N)r r r r r r r; rL r[ r\ r] profileLevelrD severityr r r r rB rB p sJ $ ''93D3D3J3JK,
!:A
>(r rB c \ rS rSrSr\R " SSS9r\R " S5 r\R " SSS9r \R " S5 r
\R " S 5 r \R " S
SS9r S r
g )
r i a| Command describes a step performed as part of the build pipeline.
Fields:
args: Command-line arguments used when executing this Command.
dir: Working directory (relative to project source root) used when running
this Command.
env: Environment variables set before running this Command.
id: Optional unique identifier for this Command, used in wait_for to
reference this Command as a dependency.
name: 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`.
waitFor: The ID(s) of the Command(s) that this Command depends on.
r Tr r r r r5 r7 r N)r r r r r r r r r r r! r" r r r r r r r so
q4 0$ a # a$/# Q " q !$ ! !!d 3'r r c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r Sr
g) Completenessi Indicates that the builder claims certain fields in this message to be
complete.
Fields:
arguments: If true, the builder claims that recipe.arguments is complete,
meaning that all external inputs are properly captured in the recipe.
environment: If true, the builder claims that recipe.environment is
claimed to be complete.
materials: If true, the builder claims that materials are complete,
usually through some controls to prevent network access. Sometimes
called "hermetic".
r r r r N r r r r r r r arguments environment materialsr r r r rR rR 9 $$Q')&&q)+$$Q')r rR c : \ rS rSrSr\R " SS5 r\R " S5 r \R " S5 r
\R " S5 r \R " S5 r \R " S 5 r\R " S
5 r\R " S S S
S9rSrg)ComplianceNotei a ComplianceNote encapsulates all information about a specific compliance
check.
Fields:
cisBenchmark: Right now we only have one compliance type, but we may add
additional types in the future.
description: A description about this compliance check.
impact: Potential impact of the suggested remediation
rationale: A rationale for the existence of this compliance check.
remediation: A description of remediation steps if the compliance check
fails.
scanInstructions: Serialized scan instructions with a predefined format.
title: The title that identifies this compliance check.
version: The OS and config versions the benchmark applies to.
rB r r r r r5 r7 r8 ComplianceVersionr9 Tr r N)r r r r r r r> cisBenchmarkr descriptionimpact rationale remediation
BytesFieldscanInstructionstitleversionr r r r rZ rZ s '':,%%a(+ #&##A&)%%a(+ ))!,
"% " "#6D I'r rZ c \ rS rSrSr\R " S5 r\R " SSSS9r \R " SS 5 r
S
r g ) ComplianceOccurrencei af An indication that the compliance checks in the associated
ComplianceNote were not satisfied for particular resources or a specified
reason.
Fields:
nonComplianceReason: The reason for non compliance of these files.
nonCompliantFiles: A list of files which are violating compliance checks.
version: The OS and config version the benchmark was run on.
r NonCompliantFiler Tr r[ r r N) r r r r r r r nonComplianceReasonr> nonCompliantFilesrd r r r r rf rf sC "--a0 ,,-?TR " "#6 :'r rf c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r Sr
g)r[ i a Describes the CIS benchmark version that is applicable to a given OS and
os version.
Fields:
benchmarkDocument: The name of the document that defines this benchmark,
e.g. "CIS Container-Optimized OS".
cpeUri: The CPE URI (https://cpe.mitre.org/specification/) this benchmark
is applicable to.
version: The version of the benchmark. This is set to the version of the
OS-specific CIS document the benchmark is defined in.
r r r r N) r r r r r r r benchmarkDocumentcpeUrird r r r r r[ r[ s:
++A. #& ! !! $'r r[ c < \ rS rSrSr\R " S5 rSrg)9ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalConfigi a ApprovalConfig describes configuration for manual approval of a build.
Fields:
approvalRequired: 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.
r r N) r r r r r r r approvalRequiredr r r r rn rn s ++A.r rn c \ rS rSrSr " S S\R 5 r\R " S5 r \R " S5 r
\R " S5 r \R " SS5 r
\R " S 5 rS
rg ) 9ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalResulti a, ApprovalResult describes the decision and associated metadata of a
manual approval of a build.
Enums:
DecisionValueValuesEnum: Required. The decision of this manual approval.
Fields:
approvalTime: Output only. The time when the approval decision was made.
approverAccount: 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.
comment: Optional. An optional comment for this manual approval result.
decision: Required. The decision of this manual approval.
url: 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.
c $ \ rS rSrSrSrSrSrSrg)QContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalResult.DecisionValueValuesEnumi zRequired. The decision of this manual approval.
Values:
DECISION_UNSPECIFIED: Default enum type. This should not be used.
APPROVED: Build is approved.
REJECTED: Build is rejected.
r r r r N) r r r r r DECISION_UNSPECIFIEDAPPROVEDREJECTEDr r r r DecisionValueValuesEnumrs s HHr rw r r r r r5 r N)r r r r r r r; rw r approvalTimeapproverAccountcommentrD decisionurlr r r r rq rq sl &
&&q), ))!,/ ! !! $'
!:A
>( a #r rq c \ rS rSrSr\R " SSSS9r\R " SSS9r \R " SS SS9r
\R " S
S SS9r \R " S S
5 r \R " SSSS9r
Srg)4ContaineranalysisGoogleDevtoolsCloudbuildV1Artifactsi, aB Artifacts produced by a build that should be uploaded upon successful
completion of all build steps.
Fields:
goModules: Optional. A list of Go modules to be uploaded to Artifact
Registry upon successful completion of all build steps. If any objects
fail to be pushed, the build is marked FAILURE.
images: 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.
mavenArtifacts: A list of Maven artifacts to be uploaded to Artifact
Registry upon successful completion of all build steps. Artifacts in the
workspace matching specified paths globs will be uploaded to the
specified Artifact Registry repository using the builder service
account's credentials. If any artifacts fail to be pushed, the build is
marked FAILURE.
npmPackages: A list of npm packages to be uploaded to Artifact Registry
upon successful completion of all build steps. Npm packages in the
specified paths will be uploaded to the specified Artifact Registry
repository using the builder service account's credentials. If any
packages fail to be pushed, the build is marked FAILURE.
objects: A list of objects to be uploaded to Cloud Storage upon successful
completion of all build steps. Files in the workspace matching specified
paths globs will be uploaded to the specified Cloud Storage location
using the builder service account's credentials. The location and
generation of the uploaded objects will be stored in the Build
resource's results field. If any objects fail to be pushed, the build is
marked FAILURE.
pythonPackages: A list of Python packages to be uploaded to Artifact
Registry upon successful completion of all build steps. The build
service account credentials will be used to perform the upload. If any
objects fail to be pushed, the build is marked FAILURE.
ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackager CContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsArtifactObjectsr5 AContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsPythonPackager7 r N)r r r r r r r> goModulesr imagesmavenArtifacts npmPackagesobjectspythonPackagesr r r r r~ r~ , s "H $$%cefquv) T 2& ))*mop{ A.&&'gijuyz+ " "#hjk l' ))*mop{ A.r r~ c \ rS rSrSr\R " S5 r\R " SSS9r\R " SS5 r
S r g
) r iY aT Files in the workspace to upload to Cloud Storage upon successful
completion of all build steps.
Fields:
location: 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.
paths: Path globs used to match files in the build's workspace.
timing: Output only. Stores timing information for pushing all artifact
objects.
r r Tr 3ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpanr r N) r r r r r r r locationpathsr> r r r r r r r Y s?
"
"1
%(
D
1% ! !"WYZ [&r r c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r \R " S5 r
\R " S5 r \R " S5 r S r
g
) r im aJ Go module to upload to Artifact Registry upon successful completion of
all build steps. A module refers to all dependencies in a go.mod file.
Fields:
modulePath: Optional. The Go module's "module path". e.g.
example.com/foo/v2
moduleVersion: Optional. The Go module's semantic version in the form
vX.Y.Z. e.g. v0.1.1 Pre-release identifiers can also be added by
appending a dash and dot separated ASCII alphanumeric characters and
hyphens. e.g. v0.2.3-alpha.x.12m.5
repositoryLocation: Optional. Location of the Artifact Registry
repository. i.e. us-east1 Defaults to the build's location.
repositoryName: Optional. Artifact Registry repository name. Specified Go
modules will be zipped and uploaded to Artifact Registry with this
location as a prefix. e.g. my-go-repo
repositoryProjectId: Optional. Project ID of the Artifact Registry
repository. Defaults to the build project.
sourcePath: Optional. Source path of the go.mod file in the build's
workspace. If not specified, this will default to the current directory.
e.g. ~/code/go/mypackage
r r r r r5 r7 r N)r r r r r r r
modulePath
moduleVersionrepositoryLocationrepositoryNamerepositoryProjectId
sourcePathr r r r r r m sk , $$Q'*''*- ,,Q/ ((+.!--a0$$Q'*r r c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r \R " S5 r
\R " S5 r Sr g )
r i a A Maven artifact to upload to Artifact Registry upon successful
completion of all build steps.
Fields:
artifactId: Maven `artifactId` value used when uploading the artifact to
Artifact Registry.
groupId: Maven `groupId` value used when uploading the artifact to
Artifact Registry.
path: Optional. Path to an artifact in the build's workspace to be
uploaded to Artifact Registry. This can be either an absolute path, e.g.
/workspace/my-app/target/my-app-1.0.SNAPSHOT.jar or a relative path from
/workspace, e.g. my-app/target/my-app-1.0.SNAPSHOT.jar.
repository: Artifact Registry repository, in the form "https://$REGION-
maven.pkg.dev/$PROJECT/$REPOSITORY" Artifact in the workspace specified
by path will be uploaded to Artifact Registry with this location as a
prefix.
version: Maven `version` value used when uploading the artifact to
Artifact Registry.
r r r r r5 r N)
r r r r r r r
artifactIdgroupIdpathr_ rd r r r r r r sY ( $$Q'* ! !! $' q !$$$Q'* ! !! $'r r c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)r i a Npm package to upload to Artifact Registry upon successful completion of
all build steps.
Fields:
packagePath: Optional. Path to the package.json. e.g.
workspace/path/to/package Only one of `archive` or `package_path` can be
specified.
repository: Artifact Registry repository, in the form "https://$REGION-
npm.pkg.dev/$PROJECT/$REPOSITORY" Npm package in the workspace specified
by path will be zipped and uploaded to Artifact Registry with this
location as a prefix.
r r r N)
r r r r r r r packagePathr_ r r r r r r s) %%a(+$$Q'*r r c ^ \ rS rSrSr\R " SSS9r\R " S5 rSr g) r i aL Python package to upload to Artifact Registry upon successful completion
of all build steps. A package can encapsulate multiple objects to be
uploaded to a single repository.
Fields:
paths: Path globs used to match files in the build's workspace. For
Python/ Twine, this is usually `dist/*`, and sometimes additionally an
`.asc` file.
repository: Artifact Registry repository, in the form "https://$REGION-
python.pkg.dev/$PROJECT/$REPOSITORY" Files in the workspace matching any
path pattern will be uploaded to Artifact Registry with this location as
a prefix.
r Tr r r N)
r r r r r r r r r_ r r r r r r s+
D
1%$$Q'*r r c Z \ rS rSrSr " S S\R 5 r\R " S5 " S S\R 5 5 r \R " S5 " S S \R 5 5 r \R " S
S 5 r\R " S S
5 r\R " SS5 r\R" " S5 r\R" " S5 r\R " SSSS9r\R " SS5 r\R" " S5 r\R " SS5 r\R" " S5 r\R" " S SS9r\R" " S 5 r\R" " S 5 r\R" " S 5 r \R " S S!5 r \R" " S"5 r \R" " S#5 r \R " S$S%5 r \R " S&S'SS9r!\R" " S(5 r"\R " S)S*5 r#\R " S+S,5 r$\R" " S-5 r%\RL " SS.5 r'\R" " S/5 r(\R " S0S1SS9r)\R " SS25 r*\R" " S3SS9r+\R" " S45 r,\R " S S55 r-\R " S6S7SS9r.S8r/g9):0ContaineranalysisGoogleDevtoolsCloudbuildV1Buildi ab 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.
Enums:
StatusValueValuesEnum: Output only. Status of the build.
Messages:
SubstitutionsValue: Substitutions data for `Build` resource.
TimingValue: 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 artifacts including docker images and non docker
artifacts. * 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.
Fields:
approval: Output only. Describes this build's approval configuration,
status, and result.
artifacts: Artifacts produced by the build that should be uploaded upon
successful completion of all build steps.
availableSecrets: Secrets and secret environment variables.
buildTriggerId: Output only. The ID of the `BuildTrigger` that triggered
this build, if it was triggered automatically.
createTime: Output only. Time at which the request to create the build was
received.
dependencies: Optional. Dependencies that the Cloud Build worker will
fetch before executing user steps.
failureInfo: Output only. Contains information about the build when
status=FAILURE.
finishTime: 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.
gitConfig: Optional. Configuration for git operations.
id: Output only. Unique identifier of the build.
images: 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`.
logUrl: Output only. URL to logs for this build in Google Cloud Console.
logsBucket: 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`.
name: Output only. The 'Build' name with format:
`projects/{project}/locations/{location}/builds/{build}`, where {build}
is a unique identifier generated by the service.
options: Special options for this build.
projectId: Output only. ID of the project.
queueTtl: 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.
results: Output only. Results of the build.
secrets: 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
serviceAccount: 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.
source: Optional. The location of the source files to build.
sourceProvenance: Output only. A permanent fixed identifier for source.
startTime: Output only. Time at which execution of the build was started.
status: Output only. Status of the build.
statusDetail: Output only. Customer-readable message about the current
status.
steps: Required. The operations to be performed on the workspace.
substitutions: Substitutions data for `Build` resource.
tags: Tags for annotation of a `Build`. These are not docker tags.
timeout: 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 60 minutes.
timing: 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 artifacts including docker images and non docker artifacts.
* 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.
warnings: Output only. Non-fatal problems encountered during the execution
of the build.
c @ \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
S rS
rg)FContaineranalysisGoogleDevtoolsCloudbuildV1Build.StatusValueValuesEnumi- a Output only. Status of the build.
Values:
STATUS_UNKNOWN: Status of the build is unknown.
PENDING: Build has been created and is pending execution and queuing. It
has not been queued.
QUEUED: Build or step is queued; work has not yet begun.
WORKING: Build or step is being executed.
SUCCESS: Build or step finished successfully.
FAILURE: Build or step failed to complete successfully.
INTERNAL_ERROR: Build or step failed due to an internal cause.
TIMEOUT: Build or step took longer than was allowed.
CANCELLED: Build or step was canceled by a user.
EXPIRED: Build was enqueued for longer than the value of `queue_ttl`.
r r r r r r5 r7 r8 r9 r: r Nr r r r r r r r r r r r r r r r r r r r r - s; NG
FGGGNGIGr r ro c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
CContaineranalysisGoogleDevtoolsCloudbuildV1Build.SubstitutionsValueiH zSubstitutions data for `Build` resource.
Messages:
AdditionalProperty: An additional property for a SubstitutionsValue
object.
Fields:
additionalProperties: Additional properties of type SubstitutionsValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)VContaineranalysisGoogleDevtoolsCloudbuildV1Build.SubstitutionsValue.AdditionalPropertyiT An additional property for a SubstitutionsValue object.
Fields:
key: Name of the additional property.
value: A string attribute.
r r r Nr r r r rx r T r r rx r Tr r Nrz r r r SubstitutionsValuer H 2 'Y . . ' %112FTXYr r c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
approval artifactsavailableSecretsr buildTriggerIdr dependencies failureInfor gitConfigr! r logUrlr r" optionsr queueTtlr secretsserviceAccountsourcer r rD r statusDetailsteps
substitutionstagsr r warningsr r r r r r s ]~inn 6 !!"89Z9,, Z :Z0 !!"89ZI%% Z :Z:
#
#$^`a
b($$%[]^_) ++,`bcd ((+.$$Q'*''(_abmqr,&&'dfgh+$$Q'*$$%[]^_) R " d 3& $&$$R(* r "$ " "#\^` a'##B')
"
"2
&( " "#WY[ \' " "#VXZei j' ((,. ! !"UWY Z& ++,ikmn##B') 6 ;&&&r*,
!WY[fj
k%(()=rB- rD 1$ ! !" %' ! !- 4&
#
#$]_alp
q(r r c \ rS rSrSr " S S\R 5 r\R " SS5 r \R " SS5 r
\R " SS 5 r S
r
g ) r i aj BuildApproval describes a build's approval configuration, state, and
result.
Enums:
StateValueValuesEnum: Output only. The state of this build's approval.
Fields:
config: Output only. Configuration for manual approval of this build.
result: Output only. Result of manual approval for this Build.
state: Output only. The state of this build's approval.
c , \ rS rSrSrSrSrSrSrSr Sr
g )
MContaineranalysisGoogleDevtoolsCloudbuildV1BuildApproval.StateValueValuesEnumi aC Output only. The state of this build's approval.
Values:
STATE_UNSPECIFIED: Default enum type. This should not be used.
PENDING: Build approval is pending.
APPROVED: Build approval has been approved.
REJECTED: Build approval has been rejected.
CANCELLED: Build was cancelled while it was still pending approval.
r r r r r r N) r r r r r r, r ru rv r r r r r r1 r s# GHHIr r1 rn r rq r r r N)r r r r r r r; r1 r> configresultrD rE r r r r r r sT
Y^^ ! !"]_` a& ! !"]_` a&
4a
8%r r c \ rS rSrSr " S S\R 5 r\R " S5 r \R " SS5 r Sr g) r i zA fatal problem encountered during the execution of the build.
Enums:
TypeValueValuesEnum: The name of the failure.
Fields:
detail: Explains the failure issue in more detail using hard-coded text.
type: The name of the failure.
c 4 \ rS rSrSrSrSrSrSrSr Sr
S r S
r g ) OContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo.TypeValueValuesEnumi a The name of the failure.
Values:
FAILURE_TYPE_UNSPECIFIED: Type unspecified
PUSH_FAILED: Unable to push the image to the repository.
PUSH_IMAGE_NOT_FOUND: Final image not found.
PUSH_NOT_AUTHORIZED: Unauthorized push of the final image.
LOGGING_FAILURE: Backend logging failures. Should retry.
USER_BUILD_STEP: A build step has failed.
FETCH_SOURCE_FAILED: The source fetching has failed.
r r r r r r5 r7 r N)
r r r r r FAILURE_TYPE_UNSPECIFIED PUSH_FAILEDPUSH_IMAGE_NOT_FOUNDPUSH_NOT_AUTHORIZEDLOGGING_FAILUREUSER_BUILD_STEPFETCH_SOURCE_FAILEDr r r r TypeValueValuesEnumr s0
! K OOr r r r r N)
r r r r r r r; r r detailrD typer r r r r r s< INN ( #& 2A 6$r r c \ rS rSrSr " S S\R 5 r " S S\R 5 r " S S\R 5 r " S S
\R 5 r
" S S \R 5 r " S
S\R 5 r " S S\R 5 r
\R " S5 r\R " SS5 r\R$ " S5 r\R " S5 r\R " S5 r\R, " SSS9r\R " SS5 r\R " SS5 r\R " S
S5 r\R6 " S S 5 r \R, " S 5 r \R " S S 5 r \R, " S SS9r \R " SS!SS9r \R " SS"5 r!\R6 " S#S$SS9r"\R, " S%5 r#S&r$g')(r i a Optional arguments to enable specific features of builds.
Enums:
DefaultLogsBucketBehaviorValueValuesEnum: Optional. Option to specify how
default logs buckets are setup.
LogStreamingOptionValueValuesEnum: Option to define build log streaming
behavior to Cloud Storage.
LoggingValueValuesEnum: Option to specify the logging mode, which
determines if and where build logs are stored.
MachineTypeValueValuesEnum: Compute Engine machine type on which to run
the build.
RequestedVerifyOptionValueValuesEnum: Requested verifiability options.
SourceProvenanceHashValueListEntryValuesEnum:
SubstitutionOptionValueValuesEnum: 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.
Fields:
automapSubstitutions: Option to include built-in and custom substitutions
as env variables for all build steps.
defaultLogsBucketBehavior: Optional. Option to specify how default logs
buckets are setup.
diskSizeGb: 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
4000GB; builds that request more than the maximum are rejected with an
error.
dynamicSubstitutions: 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.
enableStructuredLogging: Optional. Option to specify whether structured
logging is enabled. If true, JSON-formatted logs are parsed as
structured logs.
env: 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".
logStreamingOption: Option to define build log streaming behavior to Cloud
Storage.
logging: Option to specify the logging mode, which determines if and where
build logs are stored.
machineType: Compute Engine machine type on which to run the build.
pool: Optional. Specification for execution 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.
pubsubTopic: Optional. Option to specify the Pub/Sub topic to receive
build status updates.
requestedVerifyOption: Requested verifiability options.
secretEnv: 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.
sourceProvenanceHash: Requested hash for SourceProvenance.
substitutionOption: 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.
volumes: 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.
workerPool: This field deprecated; please use `pool.name` instead.
c $ \ rS rSrSrSrSrSrSrg)`ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions.DefaultLogsBucketBehaviorValueValuesEnumi/ a Optional. Option to specify how default logs buckets are setup.
Values:
DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED: Unspecified.
REGIONAL_USER_OWNED_BUCKET: Bucket is located in user-owned project in
the same region as the build. The builder service account must have
access to create and write to Cloud Storage buckets in the build
project.
LEGACY_BUCKET: Bucket is located in a Google-owned project and is not
regionalized.
r r r r N) r r r r r (DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIEDREGIONAL_USER_OWNED_BUCKET
LEGACY_BUCKETr r r r (DefaultLogsBucketBehaviorValueValuesEnumr / s
01,!" Mr r c $ \ rS rSrSrSrSrSrSrg)YContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions.LogStreamingOptionValueValuesEnumi? aV Option to define build log streaming behavior to Cloud Storage.
Values:
STREAM_DEFAULT: Service may automatically determine build log streaming
behavior.
STREAM_ON: Build logs should be streamed to Cloud Storage.
STREAM_OFF: Build logs should not be streamed to Cloud Storage; they
will be written when the build is completed.
r r r r N) r r r r r STREAM_DEFAULT STREAM_ON
STREAM_OFFr r r r !LogStreamingOptionValueValuesEnumr ? s NIJr r c 0 \ rS rSrSrSrSrSrSrSr Sr
S r g
) NContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions.LoggingValueValuesEnumiM a Option to specify the logging mode, which determines if and where
build logs are stored.
Values:
LOGGING_UNSPECIFIED: The service determines the logging mode. The
default is `LEGACY`. Do not rely on the default logging behavior as it
may change in the future.
LEGACY: Build logs are stored in Cloud Logging and Cloud Storage.
GCS_ONLY: Build logs are stored in Cloud Storage.
STACKDRIVER_ONLY: This option is the same as CLOUD_LOGGING_ONLY.
CLOUD_LOGGING_ONLY: Build logs are stored in Cloud Logging. Selecting
this option will not allow [logs
streaming](https://cloud.google.com/sdk/gcloud/reference/builds/log).
NONE: Turn off all logging. No build logs will be captured.
r r r r r r5 r N) r r r r r LOGGING_UNSPECIFIEDLEGACYGCS_ONLYSTACKDRIVER_ONLYCLOUD_LOGGING_ONLYNONEr r r r LoggingValueValuesEnumr M s*
FH Dr r c 0 \ rS rSrSrSrSrSrSrSr Sr
S r g
) RContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions.MachineTypeValueValuesEnumid aH Compute Engine machine type on which to run the build.
Values:
UNSPECIFIED: Standard machine type.
N1_HIGHCPU_8: Highcpu machine with 8 CPUs.
N1_HIGHCPU_32: Highcpu machine with 32 CPUs.
E2_HIGHCPU_8: Highcpu e2 machine with 8 CPUs.
E2_HIGHCPU_32: Highcpu e2 machine with 32 CPUs.
E2_MEDIUM: E2 machine with 1 CPU.
r r r r r r5 r N) r r r r r UNSPECIFIED N1_HIGHCPU_8
N1_HIGHCPU_32 E2_HIGHCPU_8
E2_HIGHCPU_32 E2_MEDIUMr r r r MachineTypeValueValuesEnumr d s' KLMLMIr r c \ rS rSrSrSrSrSrg)\ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions.RequestedVerifyOptionValueValuesEnumiv zRequested verifiability options.
Values:
NOT_VERIFIED: Not a verifiable build (the default).
VERIFIED: Build must be verified.
r r r N)r r r r r NOT_VERIFIEDVERIFIEDr r r r $RequestedVerifyOptionValueValuesEnumr v s LHr r
c , \ rS rSrSrSrSrSrSrSr Sr
g )
dContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions.SourceProvenanceHashValueListEntryValuesEnumi a SourceProvenanceHashValueListEntryValuesEnum enum type.
Values:
NONE: No hash requested.
SHA256: Use a sha256 hash.
MD5: Use a md5 hash.
GO_MODULE_H1: Dirhash of a Go module's source code which is then hex-
encoded.
SHA512: Use a sha512 hash.
r r r r r r N r r r r r r SHA256MD5 GO_MODULE_H1SHA512r r r r ,SourceProvenanceHashValueListEntryValuesEnumr "
D
F
CL
Fr r c \ rS rSrSrSrSrSrg)YContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions.SubstitutionOptionValueValuesEnumi a 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.
Values:
MUST_MATCH: Fails the build if error in substitutions checks, like
missing a substitution in the template or in the map.
ALLOW_LOOSE: Do not fail the build if error in substitutions checks.
r r r N)r r r r r
MUST_MATCH ALLOW_LOOSEr r r r !SubstitutionOptionValueValuesEnumr s JKr r r r r r r5 r7 Tr r8 r9 r: AContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOptionr r r r r r 1ContaineranalysisGoogleDevtoolsCloudbuildV1Volumer r r N)%r r r r r r r; r r r r r
r r r r rD defaultLogsBucketBehaviorr[
diskSizeGbdynamicSubstitutionsenableStructuredLoggingr r logStreamingOptionlogging machineTyper> pool pubsubTopicrequestedVerifyOptionr sourceProvenanceHashsubstitutionOptionr
workerPoolr r r r r r s GR )..
y~~
.9>> $Y^^ Y^^ " ).. #//2 ' 1 12\^_ `%%a(*"//2 % 2 21 5 a$/# **+NPQR 8! <'##$@!D+ ceg h$%%b)+#--.TVXY##B6)",,-[]_jno **+NPRS " "#VXZei j'$$R(*r r c < \ rS rSrSr\R " S5 rSrg)r i a 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.
Fields:
name: 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}
r r N r r r r r r r r" r r r r r r s
q !$r r c \ rS rSrSr " S S\R 5 r\R " SS\R R S9r \R " S5 r
\R " S SS
9r\R " S 5 r\R " S 5 r\R " S
5 r\R " SSS
9r\R " S\R R S9r\R " S5 r\R " S5 r\R. " SS5 r\R " S5 r\R " SSS
9r\R6 " SS5 r \R " S5 r \R. " SS5 r \R. " SSSS
9r \R " S SS
9r S r!g ) r i a A step in the build pipeline.
Enums:
StatusValueValuesEnum: 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.
Fields:
allowExitCodes: Allow this build step to fail without failing the entire
build if and only if the exit code is one of the specified codes. If
allow_failure is also specified, this field will take precedence.
allowFailure: Allow this build step to fail without failing the entire
build. If false, the entire build will fail if this step fails.
Otherwise, the build will succeed, but this step will still have a
failure status. Error information will be reported in the failure_detail
field.
args: 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.
automapSubstitutions: Option to include built-in and custom substitutions
as env variables for this build step. This option will override the
global option in BuildOption.
dir: 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.
entrypoint: Entrypoint to be used instead of the build step image's
default entrypoint. If unset, the image's default entrypoint is used.
env: 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".
exitCode: Output only. Return code from running the step.
id: Unique identifier for this build step, used in `wait_for` to reference
this build step as a dependency.
name: 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.
pullTiming: Output only. Stores timing information for pulling this build
step's builder image only.
script: A shell script to be executed in the step. When script is
provided, the user cannot specify the entrypoint or args.
secretEnv: 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`.
status: 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.
timeout: 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.
timing: Output only. Stores timing information for executing this build
step.
volumes: 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.
waitFor: 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.
c @ \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
S rS
rg)JContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep.StatusValueValuesEnumi a 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.
Values:
STATUS_UNKNOWN: Status of the build is unknown.
PENDING: Build has been created and is pending execution and queuing. It
has not been queued.
QUEUED: Build or step is queued; work has not yet begun.
WORKING: Build or step is being executed.
SUCCESS: Build or step finished successfully.
FAILURE: Build or step failed to complete successfully.
INTERNAL_ERROR: Build or step failed due to an internal cause.
TIMEOUT: Build or step took longer than was allowed.
CANCELLED: Build or step was canceled by a user.
EXPIRED: Build was enqueued for longer than the value of `queue_ttl`.
r r r r r r5 r7 r8 r9 r: r Nr r r r r r, s; " NG
FGGGNGIGr r r Tr r r r r r5 r7 r8 r9 rY r: r r r r r r r r r r r r N)"r r r r r r r; r r[ r\ r] r r r r r r r r r r r! r" r> r r r rD r r r r r r r r r r r st N`inn : ))!dIDUDUD[D[\.''*, q4 0$"//2 a #$$Q'* a$/#
#
#Ay/@/@/F/F
G( Q " r "$%%&[]_`* $&##B6) 6 ;& ! !" %' ! !"WY[ \& " "#VXZei j' ! !"t 4'r r c \ rS rSrSr " S S\R 5 r\R " SS5 r \R " S5 r Sr g) r iC zA non-fatal problem encountered during the execution of the build.
Enums:
PriorityValueValuesEnum: The priority for this warning.
Fields:
priority: The priority for this warning.
text: Explanation of the warning generated.
c ( \ rS rSrSrSrSrSrSrSr g) OContaineranalysisGoogleDevtoolsCloudbuildV1BuildWarning.PriorityValueValuesEnumiN a* The priority for this warning.
Values:
PRIORITY_UNSPECIFIED: Should not be used.
INFO: e.g. deprecation warnings and alternative feature highlights.
WARNING: e.g. automated detection of possible issues with the build.
ALERT: e.g. alerts that a feature used in the build is pending removal
r r r r r N)
r r r r r PRIORITY_UNSPECIFIEDINFOWARNINGALERTr r r r PriorityValueValuesEnumr/ N s DG
Er r4 r r r N)
r r r r r r r; r4 rD priorityr textr r r r r r C s<
!:A
>( q !$r r c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r \R " SS5 r Sr g )
5ContaineranalysisGoogleDevtoolsCloudbuildV1BuiltImagei` ao An image built by the pipeline.
Fields:
artifactRegistryPackage: Output only. Path to the artifact in Artifact
Registry.
digest: Docker Registry 2.0 digest.
name: Name used to push the container image to Google Container Registry,
as presented to `docker push`.
pushTiming: Output only. Stores timing information for pushing the
specified image.
r r r r r r N)
r r r r r r r artifactRegistryPackagedigestr" r>
pushTimingr r r r r8 r8 ` sN
& 1 1! 4 #& q !$%%&[]^_*r r8 c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r Sr
g)>ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepositoryis a Location of the source in a 2nd-gen Google Cloud Build repository
resource.
Fields:
dir: Optional. Directory, relative to the source root, in which to run the
build.
repository: Required. Name of the Google Cloud Build repository, formatted
as `projects/*/locations/*/connections/*/repositories/*`.
revision: Required. The revision to fetch from the Git repository such as
a branch, a tag, a commit SHA, or any Git ref.
r r r r N) r r r r r r r r r_ revisionr r r r r= r= s s9
a #$$Q'*
"
"1
%(r r= c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g)r i zA dependency that the Cloud Build worker will fetch before executing
user steps.
Fields:
empty: If set to true disable all dependency fetching (ignoring the
default source as well).
gitSource: Represents a git repository as a build dependency.
r HContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceDependencyr r N) r r r r r r r emptyr> gitSourcer r r r r r s-
#%$$%oqrs)r r c \ rS rSrSr\R " S5 r\R " S5 r \R " S5 r \R " SS5 r
\R " S5 rS rg
) r@ i a Represents a git repository as a build dependency.
Fields:
depth: Optional. How much history should be fetched for the build (default
1, -1 for all history).
destPath: Required. Where should the files be placed on the worker.
recurseSubmodules: Optional. True if submodules should be fetched too
(default false).
repository: Required. The kind of repo (url or dev connect).
revision: Required. The revision that we will fetch the repo at.
r r r HContaineranalysisGoogleDevtoolsCloudbuildV1DependencyGitSourceRepositoryr r5 r N)r r r r r r r[ depthr destPathr recurseSubmodulesr> r_ r> r r r r r@ r@ s^
#%
"
"1
%( ,,Q/%%&prst*
"
"1
%(r r@ c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)rD i zA repository for a git source.
Fields:
developerConnect: The Developer Connect Git repository link formatted as
`projects/*/locations/*/connections/*/gitRepositoryLink/*`
url: Location of the Git repository.
r r r N)
r r r r r r r developerConnectr| r r r r rD rD s* **1- a #r rD c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r Sr
g)AContaineranalysisGoogleDevtoolsCloudbuildV1DeveloperConnectConfigi a This config defines the location of a source through Developer Connect.
Fields:
dir: Required. Directory, relative to the source root, in which to run the
build.
gitRepositoryLink: Required. The Developer Connect Git repository link,
formatted as `projects/*/locations/*/connections/*/gitRepositoryLink/*`.
revision: Required. The revision to fetch from the Git repository such as
a branch, a tag, a commit SHA, or any Git ref.
r r r r N) r r r r r r r r gitRepositoryLinkr> r r r r rK rK s: a # ++A.
"
"1
%(r rK c < \ rS rSrSr\R " SSSS9rSrg) 5ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashesi zContainer message for hashes of byte content of files, used in
SourceProvenance messages to verify integrity of source input to the build.
Fields:
fileHash: Collection of file hashes.
/ContaineranalysisGoogleDevtoolsCloudbuildV1Hashr Tr r N r r r r r r r> fileHashr r r r rN rN s
#
#$UWXcg
h(r rN c > \ rS rSrSr\R " SS5 rSrg)r i zqGitConfig is a configuration for git operations.
Fields:
http: Configuration for HTTP related git operations.
>ContaineranalysisGoogleDevtoolsCloudbuildV1GitConfigHttpConfigr r N) r r r r r r r> httpr r r r r r s
`bc d$r r c < \ rS rSrSr\R " S5 rSrg)rS i a HttpConfig is a configuration for HTTP related git operations.
Fields:
proxySecretVersionName: SecretVersion resource of the HTTP proxy URL. The
Service Account used in the build (either the default Service Account or
user-specified Service Account) should have
`secretmanager.versions.access` permissions on this secret. The proxy
URL should be in format `protocol://@]proxyhost[:port]`.
r r N) r r r r r r r proxySecretVersionNamer r r r rS rS s %003r rS c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r Sr
g)4ContaineranalysisGoogleDevtoolsCloudbuildV1GitSourcei a Location of the source in any accessible Git repository.
Fields:
dir: Optional. 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.
revision: Optional. The revision to fetch from the Git repository such as
a branch, a tag, a commit SHA, or any Git ref. Cloud Build uses `git
fetch` to fetch the revision from the Git repository; therefore make
sure that the string you provide for `revision` is parsable by the
command. For information on string values accepted by `git fetch`, see
https://git-scm.com/docs/gitrevisions#_specifying_revisions. For
information on `git fetch`, see https://git-scm.com/docs/git-fetch.
url: Required. Location of the Git repo to build. This will be used as a
`git remote`, see https://git-scm.com/docs/git-remote.
r r r r N) r r r r r r r r r> r| r r r r rX rX s9 " a #
"
"1
%( a #r rX c \ rS rSrSr " S S\R 5 r\R " SS5 r \R " S5 r Sr g) rO i Container message for hash values.
Enums:
TypeValueValuesEnum: The type of hash that was performed.
Fields:
type: The type of hash that was performed.
value: The hash value.
c , \ rS rSrSrSrSrSrSrSr Sr
g )
CContaineranalysisGoogleDevtoolsCloudbuildV1Hash.TypeValueValuesEnumi
zThe type of hash that was performed.
Values:
NONE: No hash requested.
SHA256: Use a sha256 hash.
MD5: Use a md5 hash.
GO_MODULE_H1: Dirhash of a Go module's source code which is then hex-
encoded.
SHA512: Use a sha512 hash.
r r r r r r Nr
r r r r r\
r r r r r r N
r r r r r r r; r rD r ra rw r r r r rO rO s< INN "
2A 6$
q
!%r rO c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " SS5 r \R " S5 r
Srg )
7ContaineranalysisGoogleDevtoolsCloudbuildV1InlineSecreti a Pairs a set of secret environment variables mapped to encrypted values
with the Cloud KMS key to use to decrypt the value.
Messages:
EnvMapValue: 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.
Fields:
envMap: 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.
kmsKeyName: Resource name of Cloud KMS crypto key to decrypt the encrypted
value. In format: projects/*/locations/*/keyRings/*/cryptoKeys/*
ro c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
CContaineranalysisGoogleDevtoolsCloudbuildV1InlineSecret.EnvMapValuei4 a 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.
Messages:
AdditionalProperty: An additional property for a EnvMapValue object.
Fields:
additionalProperties: Additional properties of type EnvMapValue
c ` \ rS rSrSr\R " S5 r\R " S5 r Sr
g)VContaineranalysisGoogleDevtoolsCloudbuildV1InlineSecret.EnvMapValue.AdditionalPropertyiC z}An additional property for a EnvMapValue object.
Fields:
key: Name of the additional property.
value: A byte attribute.
r r r N r r r r r r r rv ra rw r r r r rx rc C )
! !! $c""1%er rx r Tr r Nrz r r r EnvMapValuera 4 2 &Y . . & %112FTXYr rf r r r N)r r r r r r r r r{ rf r> envMapr
kmsKeyNamer r r r r_ r_ s[ ( !!"89ZI%% Z :Z6 ! !- 3&$$Q'*r r_ c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " S5 r \R " S5 r \R " S5 r
\R " S 5 r\R " S
5 r\R " S 5 r\R$ " SS 5 r\R " S
5 rSrg)5ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSourceiT a Location of the source in a Google Cloud Source Repository.
Messages:
SubstitutionsValue: Optional. Substitutions to use in a triggered build.
Should only be used with RunBuildTrigger
Fields:
branchName: 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
commitSha: Explicit commit SHA to build.
dir: Optional. 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.
invertRegex: Optional. Only trigger a build if the revision regex does NOT
match the revision regex.
projectId: Optional. ID of the project that owns the Cloud Source
Repository. If omitted, the project ID requesting the build is assumed.
repoName: Required. Name of the Cloud Source Repository.
substitutions: Optional. Substitutions to use in a triggered build. Should
only be used with RunBuildTrigger
tagName: 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
ro c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
HContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource.SubstitutionsValueio a
Optional. Substitutions to use in a triggered build. Should only be
used with RunBuildTrigger
Messages:
AdditionalProperty: An additional property for a SubstitutionsValue
object.
Fields:
additionalProperties: Additional properties of type SubstitutionsValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)[ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource.SubstitutionsValue.AdditionalPropertyi| r r r r Nr r r r rx ro | r r rx r Tr r Nrz r r r r rm o r r r r r r r r5 r7 r8 r9 r N)r r r r r r r r r{ r r
branchName commitShar r invertRegexr repoNamer> r tagNamer r r r rk rk T s 4 !!"89Z9,, Z :Z2 $$Q'*##A&) a #&&q)+##A&)
"
"1
%((()=qA- ! !! $'r rk c ~ \ rS rSrSr\R " S5 r\R " SS5 r \R " SSS9r
\R " S SS9r \R " S
S SS9r
\R " S S
SS9r\R " SSSS9r\R " SSSS9r\R" " S5 r\R " SSSS9rSrg)r i ao Artifacts created by the build pipeline.
Fields:
artifactManifest: Path to the artifact manifest for non-container
artifacts uploaded to Cloud Storage. Only populated when artifacts are
uploaded to Cloud Storage.
artifactTiming: Time to push all non-container artifacts to Cloud Storage.
buildStepImages: List of build step digests, in the order corresponding to
build step indices.
buildStepOutputs: 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 50KB of data is stored. Note that the `$BUILDER_OUTPUT` variable
is read-only and can't be substituted.
goModules: Optional. Go module artifacts uploaded to Artifact Registry at
the end of the build.
images: Container images that were built as a part of the build.
mavenArtifacts: Maven artifacts uploaded to Artifact Registry at the end
of the build.
npmPackages: Npm packages uploaded to Artifact Registry at the end of the
build.
numArtifacts: Number of non-container artifacts uploaded to Cloud Storage.
Only populated when artifacts are uploaded to Cloud Storage.
pythonPackages: Python artifacts uploaded to Artifact Registry at the end
of the build.
r r r r Tr r ;ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedGoModuler5 r8 r7 @ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifactr8 =ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedNpmPackager9 r: @ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedPythonPackager r N)r r r r r r r artifactManifestr> artifactTimingbuildStepImagesra buildStepOutputsr r r r r[ numArtifactsr r r r r r r s 8 **1- ))*_abc. ))!d;/ ))!d;$$%bdeptu) ! !"Y[\gk l& ))*lnoz~.&&'fhitxy+''*, ))*lnp{ A.r r c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " S5 r \R " SS5 r
Srg )
r i a 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.
Messages:
SecretEnvValue: 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.
Fields:
kmsKeyName: Cloud KMS key name to use to decrypt these envs.
secretEnv: 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.
ro c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
@ContaineranalysisGoogleDevtoolsCloudbuildV1Secret.SecretEnvValuei a 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.
Messages:
AdditionalProperty: An additional property for a SecretEnvValue object.
Fields:
additionalProperties: Additional properties of type SecretEnvValue
c ` \ rS rSrSr\R " S5 r\R " S5 r Sr
g)SContaineranalysisGoogleDevtoolsCloudbuildV1Secret.SecretEnvValue.AdditionalPropertyi zAn additional property for a SecretEnvValue object.
Fields:
key: Name of the additional property.
value: A byte attribute.
r r r Nrd r r r rx r re r rx r Tr r Nrz r r r SecretEnvValuer rg r r r r r N)r r r r r r r r r{ r r ri r> r r r r r r r s\ , !!"89Zy(( Z :Z6 $$Q'*$$%5q9)r r c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)>ContaineranalysisGoogleDevtoolsCloudbuildV1SecretManagerSecreti ax Pairs a secret environment variable with a SecretVersion in Secret
Manager.
Fields:
env: 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.
versionName: Resource name of the SecretVersion. In format:
projects/*/secrets/*/versions/*
r r r N)
r r r r r r r r versionNamer r r r r r s) a #%%a(+r r c ` \ rS rSrSr\R " SSSS9r\R " SSSS9rS r g
) r i zSecrets and secret environment variables.
Fields:
inline: Secrets encrypted with KMS key and the associated secret
environment variable.
secretManager: Secrets in Secret Manager and associated secret environment
variable.
r_ r Tr r r r N)
r r r r r r r> inline
secretManagerr r r r r r s7 ! !"[]^im n&(()iklw{|-r r c \ rS rSrSr\R " SS5 r\R " SS5 r\R " SS5 r \R " S S
5 r
\R " S S 5 r \R " S
S5 r Sr
g)r i a Location of the source in a supported storage service.
Fields:
connectedRepository: Optional. If provided, get the source from this 2nd-
gen Google Cloud Build repository resource.
developerConnectConfig: If provided, get the source from this Developer
Connect config.
gitSource: If provided, get the source from this Git repository.
repoSource: If provided, get the source from this location in a Cloud
Source Repository.
storageSource: If provided, get the source from this location in Cloud
Storage.
storageSourceManifest: If provided, get the source from this manifest in
Cloud Storage. This feature is in Preview; see description
[here](https://github.com/GoogleCloudPlatform/cloud-
builders/tree/master/gcs-fetcher).
r= r rK r rX r rk r 8ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourcer5 @ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifestr7 r N)r r r r r r r> connectedRepositorydeveloperConnectConfigrB
repoSource
storageSourcestorageSourceManifestr r r r r r s $ "../oqrs$112uwxy$$%[]^_)%%&]_`a*(()cefg-#001suvwr r c P \ rS rSrSr\R " S5 " S S\R 5 5 r \R " SS5 r \R " SS5 r \R " S S
5 r
\R " S S 5 r\R " S
S5 r\R " SS5 rSrg)r i, aF Provenance of the source. Ways to find the original source, or verify
that some source was used for this build.
Messages:
FileHashesValue: 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.
Fields:
fileHashes: 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.
resolvedConnectedRepository: Output only. A copy of the build's
`source.connected_repository`, if exists, with any revisions resolved.
resolvedGitSource: Output only. A copy of the build's `source.git_source`,
if exists, with any revisions resolved.
resolvedRepoSource: A copy of the build's `source.repo_source`, if exists,
with any revisions resolved.
resolvedStorageSource: A copy of the build's `source.storage_source`, if
exists, with any generations resolved.
resolvedStorageSourceManifest: A copy of the build's
`source.storage_source_manifest`, if exists, with any revisions
resolved. This feature is in Preview.
ro c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
KContaineranalysisGoogleDevtoolsCloudbuildV1SourceProvenance.FileHashesValueiP a 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.
Messages:
AdditionalProperty: An additional property for a FileHashesValue object.
Fields:
additionalProperties: Additional properties of type FileHashesValue
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g)^ContaineranalysisGoogleDevtoolsCloudbuildV1SourceProvenance.FileHashesValue.AdditionalPropertyia zAn additional property for a FileHashesValue object.
Fields:
key: Name of the additional property.
value: A ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes
attribute.
r rN r r Nru r r r rx r a s-
! !! $c$$%\^_`er rx r Tr r Nrz r r r FileHashesValuer P s4
aY . .
a %112FTXYr r r r= r rX r rk r r r5 r r7 r N)r r r r r r r r r{ r r>
fileHashesresolvedConnectedRepositoryresolvedGitSourceresolvedRepoSourceresolvedStorageSource resolvedStorageSourceManifestr r r r r r , s !F !!"89 Z )) Z : Z< %%&7;* ) 6 67wyz { ,,-cefg --.eghi#001kmno"+"8"89{}~" r r c \ rS rSrSr " S S\R 5 r\R " S5 r \R " S5 r \R " S5 r \R " SS5 rS rg
) r iw a Location of the source in an archive file in Cloud Storage.
Enums:
SourceFetcherValueValuesEnum: Optional. Option to specify the tool to
fetch the source file for the build.
Fields:
bucket: Cloud Storage bucket containing the source (see [Bucket Name
Requirements](https://cloud.google.com/storage/docs/bucket-
naming#requirements)).
generation: Optional. Cloud Storage generation for the object. If the
generation is omitted, the latest generation will be used.
object: Required. Cloud Storage object containing the source. This object
must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) containing
source to build.
sourceFetcher: Optional. Option to specify the tool to fetch the source
file for the build.
c $ \ rS rSrSrSrSrSrSrg)UContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource.SourceFetcherValueValuesEnumi a$ Optional. Option to specify the tool to fetch the source file for the
build.
Values:
SOURCE_FETCHER_UNSPECIFIED: Unspecified defaults to GSUTIL.
GSUTIL: Use the "gsutil" tool to download the source file.
GCS_FETCHER: Use the Cloud Storage Fetcher tool to download the source
file.
r r r r N) r r r r r SOURCE_FETCHER_UNSPECIFIEDGSUTIL GCS_FETCHERr r r r SourceFetcherValueValuesEnumr s "#
FKr r r r r r r N)r r r r r r r; r r bucketr[
generationobjectrD
sourceFetcherr r r r r r w s\ & Y^^ #&%%a(* #&%%&DaH-r r c \ rS rSrSr\R " S5 r\R " S5 r \R " S5 r
Sr g)r i a_ Location of the source manifest in Cloud Storage. This feature is in
Preview; see description
[here](https://github.com/GoogleCloudPlatform/cloud-
builders/tree/master/gcs-fetcher).
Fields:
bucket: Required. Cloud Storage bucket containing the source manifest (see
[Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-
naming#requirements)).
generation: Cloud Storage generation for the object. If the generation is
omitted, the latest generation will be used.
object: Required. Cloud Storage object containing the source manifest.
This object must be a JSON file.
r r r r N r r r r r r r r r[ r r r r r r r r s9
#&%%a(* #&r r c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)r i zxStart and end times for a build execution phase.
Fields:
endTime: End of time span.
startTime: Start of time span.
r r r N
r r r r r r r endTimer r r r r r r )
! !! $'##A&)r r c \ rS rSrSr\R " S5 r\R " SS5 r \R " SS5 r
\R " S5 r S r g
) rv i ar A Go module artifact uploaded to Artifact Registry using the GoModule
directive.
Fields:
artifactRegistryPackage: Output only. Path to the artifact in Artifact
Registry.
fileHashes: Hash types and values of the Go Module Artifact.
pushTiming: Output only. Stores timing information for pushing the
specified artifact.
uri: URI of the uploaded artifact.
r rN r r r r r N
r r r r r r r r9 r> r r; urir r r r rv rv R
& 1 1! 4%%&]_`a*%%&[]^_* a #r rv c \ rS rSrSr\R " S5 r\R " SS5 r \R " SS5 r
\R " S5 r S r g
) rw i aZ A Maven artifact uploaded using the MavenArtifact directive.
Fields:
artifactRegistryPackage: Output only. Path to the artifact in Artifact
Registry.
fileHashes: Hash types and values of the Maven Artifact.
pushTiming: Output only. Stores timing information for pushing the
specified artifact.
uri: URI of the uploaded artifact.
r rN r r r r r Nr r r r rw rw R & 1 1! 4%%&]_`a*%%&[]^_* a #r rw c \ rS rSrSr\R " S5 r\R " SS5 r \R " SS5 r
\R " S5 r S r g
) rx i aj An npm package uploaded to Artifact Registry using the NpmPackage
directive.
Fields:
artifactRegistryPackage: Output only. Path to the artifact in Artifact
Registry.
fileHashes: Hash types and values of the npm package.
pushTiming: Output only. Stores timing information for pushing the
specified artifact.
uri: URI of the uploaded npm package.
r rN r r r r r Nr r r r rx rx r r rx c \ rS rSrSr\R " S5 r\R " SS5 r \R " SS5 r
\R " S5 r S r g
) ry i aS Artifact uploaded using the PythonPackage directive.
Fields:
artifactRegistryPackage: Output only. Path to the artifact in Artifact
Registry.
fileHashes: Hash types and values of the Python Artifact.
pushTiming: Output only. Stores timing information for pushing the
specified artifact.
uri: URI of the uploaded artifact.
r rN r r r r r Nr r r r ry ry r r ry c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)r i
a Volume describes a Docker container volume which is mounted into build
steps in order to persist files across build step execution.
Fields:
name: 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.
path: 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.
r r r N
r r r r r r r r" r r r r r r r
)
q !$ q !$r r c \ rS rSrSr\R " S5 r\R " SS5 r \R " S5 r
\R " SSS 9r S
r g ) +ContaineranalysisProjectsNotesCreateRequesti
aW A ContaineranalysisProjectsNotesCreateRequest object.
Fields:
name: The name of the project. Should be of the form
"providers/{provider_id}". @Deprecated
note: A Note resource to be passed as the request body.
noteId: The ID to use for this note.
parent: This field contains the project Id for example:
"projects/{project_id}
r Noter r r Trequiredr N
r r r r r r r r" r> notenoteIdparentr r r r r r
sM
q !$ *$ #& T 2&r r c : \ rS rSrSr\R " SSS9rSrg)+ContaineranalysisProjectsNotesDeleteRequesti-
zA ContaineranalysisProjectsNotesDeleteRequest object.
Fields:
name: The name of the note in the form of
"providers/{provider_id}/notes/{NOTE_ID}"
r Tr r Nr) r r r r r -
q4 0$r r c ` \ rS rSrSr\R " SS5 r\R " SSS9r Sr
g )
1ContaineranalysisProjectsNotesGetIamPolicyRequesti8
am A ContaineranalysisProjectsNotesGetIamPolicyRequest object.
Fields:
getIamPolicyRequest: A GetIamPolicyRequest resource to be passed as the
request body.
resource: REQUIRED: The resource for which the policy is being requested.
See [Resource
names](https://cloud.google.com/apis/design/resource_names) for the
appropriate value for this field.
GetIamPolicyRequestr r Tr r N r r r r r r r> getIamPolicyRequestr resourcer r r r r r 8
/ "../DaH
"
"1t
4(r r c : \ rS rSrSr\R " SSS9rSrg)(ContaineranalysisProjectsNotesGetRequestiH
zA ContaineranalysisProjectsNotesGetRequest object.
Fields:
name: The name of the note in the form of
"providers/{provider_id}/notes/{NOTE_ID}"
r Tr r Nr) r r r r r H
r r r c \ rS rSrSr\R " S5 r\R " S5 r\R " S\R R S9r \R " S5 r
\R " SS S
9rS rg )
)ContaineranalysisProjectsNotesListRequestiS
a A ContaineranalysisProjectsNotesListRequest object.
Fields:
filter: The filter expression.
name: The name field will contain the project Id for example:
"providers/{provider_id} @Deprecated
pageSize: Number of notes to return in the list.
pageToken: Token to provide to skip to a particular spot in the list.
parent: This field contains the project Id for example:
"projects/{PROJECT_ID}".
r r r rY r r5 Tr r Nr r r r r r r filterr" r[ r\ r] pageSize pageTokenr r r r r r r S
si
#& q !$
#
#Ay/@/@/F/F
G(##A&) T 2&r r c \ rS rSrSr\R " S5 r\R " SSS9r\R " S\R R S9r \R " S 5 r
S
rg ) 4ContaineranalysisProjectsNotesOccurrencesListRequestig
aP A ContaineranalysisProjectsNotesOccurrencesListRequest object.
Fields:
filter: The filter expression.
name: The name field will contain the note name for example:
"provider/{provider_id}/notes/{note_id}"
pageSize: Number of notes to return in the list.
pageToken: Token to provide to skip to a particular spot in the list.
r r Tr r rY r r Nr r r r r r r r r" r[ r\ r] r r r r r r r r g
Y #& q4 0$
#
#Ay/@/@/F/F
G(##A&)r r c \ rS rSrSr\R " SSS9r\R " SS5 r \R " S5 r
S r g
) *ContaineranalysisProjectsNotesPatchRequestix
zA ContaineranalysisProjectsNotesPatchRequest object.
Fields:
name: The name of the note. Should be of the form
"projects/{provider_id}/notes/{note_id}".
note: A Note resource to be passed as the request body.
updateMask: The fields to update.
r Tr r r r r N r r r r r r r r" r> r
updateMaskr r r r r r x
=
q4 0$ *$$$Q'*r r c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
1ContaineranalysisProjectsNotesSetIamPolicyRequesti
am A ContaineranalysisProjectsNotesSetIamPolicyRequest object.
Fields:
resource: REQUIRED: The resource for which the policy is being specified.
See [Resource
names](https://cloud.google.com/apis/design/resource_names) for the
appropriate value for this field.
setIamPolicyRequest: A SetIamPolicyRequest resource to be passed as the
request body.
r Tr SetIamPolicyRequestr r N r r r r r r r r r> setIamPolicyRequestr r r r r r
/
"
"1t
4(!../DaHr r c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
7ContaineranalysisProjectsNotesTestIamPermissionsRequesti
a A ContaineranalysisProjectsNotesTestIamPermissionsRequest object.
Fields:
resource: REQUIRED: The resource for which the policy detail is being
requested. See [Resource
names](https://cloud.google.com/apis/design/resource_names) for the
appropriate value for this field.
testIamPermissionsRequest: A TestIamPermissionsRequest resource to be
passed as the request body.
r Tr TestIamPermissionsRequestr r N r r r r r r r r r> testIamPermissionsRequestr r r r r r
0
"
"1t
4( ' 4 45PRS Tr r c \ rS rSrSr\R " S5 r\R " SS5 r \R " SSS9r
S r g
) 1ContaineranalysisProjectsOccurrencesCreateRequesti
aA A ContaineranalysisProjectsOccurrencesCreateRequest object.
Fields:
name: The name of the project. Should be of the form
"projects/{project_id}". @Deprecated
occurrence: A Occurrence resource to be passed as the request body.
parent: This field contains the project Id for example:
"projects/{project_id}"
r
Occurrencer r Tr r N) r r r r r r r r" r>
occurrencer r r r r r r
s=
q !$%%lA6* T 2&r r c : \ rS rSrSr\R " SSS9rSrg)1ContaineranalysisProjectsOccurrencesDeleteRequesti
zA ContaineranalysisProjectsOccurrencesDeleteRequest object.
Fields:
name: The name of the occurrence in the form of
"projects/{project_id}/occurrences/{OCCURRENCE_ID}"
r Tr r Nr) r r r r r
r r r c ` \ rS rSrSr\R " SS5 r\R " SSS9r Sr
g )
7ContaineranalysisProjectsOccurrencesGetIamPolicyRequesti
as A ContaineranalysisProjectsOccurrencesGetIamPolicyRequest object.
Fields:
getIamPolicyRequest: A GetIamPolicyRequest resource to be passed as the
request body.
resource: REQUIRED: The resource for which the policy is being requested.
See [Resource
names](https://cloud.google.com/apis/design/resource_names) for the
appropriate value for this field.
r r r Tr r Nr r r r r r
r r r c : \ rS rSrSr\R " SSS9rSrg)3ContaineranalysisProjectsOccurrencesGetNotesRequesti
zA ContaineranalysisProjectsOccurrencesGetNotesRequest object.
Fields:
name: The name of the occurrence in the form
"projects/{project_id}/occurrences/{OCCURRENCE_ID}"
r Tr r Nr) r r r r r
r r r c : \ rS rSrSr\R " SSS9rSrg).ContaineranalysisProjectsOccurrencesGetRequesti
zA ContaineranalysisProjectsOccurrencesGetRequest object.
Fields:
name: The name of the occurrence of the form
"projects/{project_id}/occurrences/{OCCURRENCE_ID}"
r Tr r Nr) r r r r r
r r r c ^ \ rS rSrSr\R " S5 r\R " SSS9rSr g) BContaineranalysisProjectsOccurrencesGetVulnerabilitySummaryRequesti
zA ContaineranalysisProjectsOccurrencesGetVulnerabilitySummaryRequest
object.
Fields:
filter: The filter expression.
parent: This contains the project Id for example: projects/{project_id}
r r Tr r N)
r r r r r r r r r r r r r r r
s+ #& T 2&r r c @ \ rS rSrSr " S S\R 5 r\R " S5 r \R " SS5 r \R " S5 r \R " S\R R S 9r\R " S
5 r\R " S S S
9rSrg)/ContaineranalysisProjectsOccurrencesListRequesti
a A ContaineranalysisProjectsOccurrencesListRequest object.
Enums:
KindValueValuesEnum: The kind of occurrences to filter on.
Fields:
filter: The filter expression.
kind: The kind of occurrences to filter on.
name: The name field contains the project Id. For example:
"projects/{project_id} @Deprecated
pageSize: Number of occurrences to return in the list.
pageToken: Token to provide to skip to a particular spot in the list.
parent: This contains the project Id for example: projects/{project_id}.
c ` \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
S rS
rSrSrSrSrSrSrSrSrg)CContaineranalysisProjectsOccurrencesListRequest.KindValueValuesEnumi a The kind of occurrences to filter on.
Values:
KIND_UNSPECIFIED: Unknown
PACKAGE_VULNERABILITY: The note and occurrence represent a package
vulnerability.
BUILD_DETAILS: The note and occurrence assert build provenance.
IMAGE_BASIS: This represents an image basis relationship.
PACKAGE_MANAGER: This represents a package installed via a package
manager.
DEPLOYABLE: The note and occurrence track deployment events.
DISCOVERY: The note and occurrence track the initial discovery status of
a resource.
ATTESTATION_AUTHORITY: This represents a logical "role" that can attest
to artifacts.
UPGRADE: This represents an available software upgrade.
COMPLIANCE: This represents a compliance check that can be applied to a
resource.
SBOM: This represents a software bill of materials.
SPDX_PACKAGE: This represents an SPDX Package.
SPDX_FILE: This represents an SPDX File.
SPDX_RELATIONSHIP: This represents an SPDX Relationship.
DSSE_ATTESTATION: This represents a DSSE attestation Note
VULNERABILITY_ASSESSMENT: This represents a Vulnerability Assessment.
SBOM_REFERENCE: This represents a reference to an SBOM.
SECRET: This represents a secret.
r r r r r r5 r7 r8 r9 r: r r r r r r r r r Nr r r r r KIND_UNSPECIFIEDPACKAGE_VULNERABILITY
BUILD_DETAILS IMAGE_BASISPACKAGE_MANAGER
DEPLOYABLE DISCOVERYATTESTATION_AUTHORITYUPGRADE
COMPLIANCESBOM SPDX_PACKAGE SPDX_FILESPDX_RELATIONSHIPDSSE_ATTESTATIONVULNERABILITY_ASSESSMENTSBOM_REFERENCESECRETr r r r KindValueValuesEnumr i 6 MKOJI GJ
DLI ! N
Fr r r r r r rY r5 r7 Tr r N)r r r r r r r; r r r rD kindr" r[ r\ r] r r r r r r r r r
s
-INN -^ #& 2A 6$ q !$
#
#Ay/@/@/F/F
G(##A&) T 2&r r c \ rS rSrSr\R " SSS9r\R " SS5 r \R " S5 r
S r g
) 0ContaineranalysisProjectsOccurrencesPatchRequesti< a! A ContaineranalysisProjectsOccurrencesPatchRequest object.
Fields:
name: The name of the occurrence. Should be of the form
"projects/{project_id}/occurrences/{OCCURRENCE_ID}".
occurrence: A Occurrence resource to be passed as the request body.
updateMask: The fields to update.
r Tr r r r r N) r r r r r r r r" r> r r r r r r r r < =
q4 0$%%lA6*$$Q'*r r c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
7ContaineranalysisProjectsOccurrencesSetIamPolicyRequestiK as A ContaineranalysisProjectsOccurrencesSetIamPolicyRequest object.
Fields:
resource: REQUIRED: The resource for which the policy is being specified.
See [Resource
names](https://cloud.google.com/apis/design/resource_names) for the
appropriate value for this field.
setIamPolicyRequest: A SetIamPolicyRequest resource to be passed as the
request body.
r Tr r r r Nr r r r r r K r r r c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
=ContaineranalysisProjectsOccurrencesTestIamPermissionsRequesti[ a A ContaineranalysisProjectsOccurrencesTestIamPermissionsRequest object.
Fields:
resource: REQUIRED: The resource for which the policy detail is being
requested. See [Resource
names](https://cloud.google.com/apis/design/resource_names) for the
appropriate value for this field.
testIamPermissionsRequest: A TestIamPermissionsRequest resource to be
passed as the request body.
r Tr r r r Nr r r r r r [ r r r c ` \ rS rSrSr\R " SS5 r\R " SSS9r Sr
g )
0ContaineranalysisProjectsOperationsCreateRequestik zA ContaineranalysisProjectsOperationsCreateRequest object.
Fields:
createOperationRequest: A CreateOperationRequest resource to be passed as
the request body.
parent: The project Id that this operation should be created under.
CreateOperationRequestr r Tr r N) r r r r r r r> createOperationRequestr r r r r r r r k s/ %112JAN T 2&r r c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
/ContaineranalysisProjectsOperationsPatchRequestix a A ContaineranalysisProjectsOperationsPatchRequest object.
Fields:
name: The name of the Operation. Should be of the form
"projects/{provider_id}/operations/{operation_id}".
updateOperationRequest: A UpdateOperationRequest resource to be passed as
the request body.
r Tr UpdateOperationRequestr r N) r r r r r r r r" r> updateOperationRequestr r r r r r x s/
q4 0$$112JANr r c : \ rS rSrSr\R " SSS9rSrg).ContaineranalysisProjectsScanConfigsGetRequesti zA ContaineranalysisProjectsScanConfigsGetRequest object.
Fields:
name: The name of the ScanConfig in the form
projects/{project_id}/scanConfigs/{scan_config_id}
r Tr r Nr) r r r r# r# r r r# c \ rS rSrSr\R " S5 r\R " S\R R S9r \R " S5 r \R " SSS 9r
S
rg ) /ContaineranalysisProjectsScanConfigsListRequesti a
A ContaineranalysisProjectsScanConfigsListRequest object.
Fields:
filter: The filter expression.
pageSize: The number of items to return.
pageToken: The page token to use for the next request.
parent: This containers the project Id i.e.: projects/{project_id}
r r rY r r Tr r N)r r r r r r r r r[ r\ r] r r r r r r r r% r% sY #&
#
#Ay/@/@/F/F
G(##A&) T 2&r r% c \ rS rSrSr\R " SSS9r\R " SS5 r \R " S5 r
S r g
) 0ContaineranalysisProjectsScanConfigsPatchRequesti a A ContaineranalysisProjectsScanConfigsPatchRequest object.
Fields:
name: The scan config to update of the form
projects/{project_id}/scanConfigs/{scan_config_id}.
scanConfig: A ScanConfig resource to be passed as the request body.
updateMask: The fields to update.
r Tr
ScanConfigr r r N) r r r r r r r r" r>
scanConfigr r r r r r' r' r r r' c \ rS rSrSr\R " SSS9r\R " SS5 r \R " S5 r
\R " S 5 r S
r g ) ,ContaineranalysisProvidersNotesCreateRequesti aX A ContaineranalysisProvidersNotesCreateRequest object.
Fields:
name: The name of the project. Should be of the form
"providers/{provider_id}". @Deprecated
note: A Note resource to be passed as the request body.
noteId: The ID to use for this note.
parent: This field contains the project Id for example:
"projects/{project_id}
r Tr r r r r r Nr r r r r+ r+ sM
q4 0$ *$ #& #&r r+ c : \ rS rSrSr\R " SSS9rSrg),ContaineranalysisProvidersNotesDeleteRequesti zA ContaineranalysisProvidersNotesDeleteRequest object.
Fields:
name: The name of the note in the form of
"providers/{provider_id}/notes/{NOTE_ID}"
r Tr r Nr) r r r r- r- r r r- c ` \ rS rSrSr\R " SS5 r\R " SSS9r Sr
g )
2ContaineranalysisProvidersNotesGetIamPolicyRequesti an A ContaineranalysisProvidersNotesGetIamPolicyRequest object.
Fields:
getIamPolicyRequest: A GetIamPolicyRequest resource to be passed as the
request body.
resource: REQUIRED: The resource for which the policy is being requested.
See [Resource
names](https://cloud.google.com/apis/design/resource_names) for the
appropriate value for this field.
r r r Tr r Nr r r r r/ r/ r r r/ c : \ rS rSrSr\R " SSS9rSrg))ContaineranalysisProvidersNotesGetRequesti zA ContaineranalysisProvidersNotesGetRequest object.
Fields:
name: The name of the note in the form of
"providers/{provider_id}/notes/{NOTE_ID}"
r Tr r Nr) r r r r1 r1 r r r1 c \ rS rSrSr\R " S5 r\R " SSS9r\R " S\R R S9r \R " S 5 r
\R " S
5 rS rg )
*ContaineranalysisProvidersNotesListRequesti a A ContaineranalysisProvidersNotesListRequest object.
Fields:
filter: The filter expression.
name: The name field will contain the project Id for example:
"providers/{provider_id} @Deprecated
pageSize: Number of notes to return in the list.
pageToken: Token to provide to skip to a particular spot in the list.
parent: This field contains the project Id for example:
"projects/{PROJECT_ID}".
r r Tr r rY r r5 r Nr r r r r3 r3 si
#& q4 0$
#
#Ay/@/@/F/F
G(##A&) #&r r3 c \ rS rSrSr\R " S5 r\R " SSS9r\R " S\R R S9r \R " S 5 r
S
rg ) 5ContaineranalysisProvidersNotesOccurrencesListRequesti aQ A ContaineranalysisProvidersNotesOccurrencesListRequest object.
Fields:
filter: The filter expression.
name: The name field will contain the note name for example:
"provider/{provider_id}/notes/{note_id}"
pageSize: Number of notes to return in the list.
pageToken: Token to provide to skip to a particular spot in the list.
r r Tr r rY r r Nr r r r r5 r5 r r r5 c \ rS rSrSr\R " SSS9r\R " SS5 r \R " S5 r
S r g
) +ContaineranalysisProvidersNotesPatchRequesti
zA ContaineranalysisProvidersNotesPatchRequest object.
Fields:
name: The name of the note. Should be of the form
"projects/{provider_id}/notes/{note_id}".
note: A Note resource to be passed as the request body.
updateMask: The fields to update.
r Tr r r r r Nr r r r r7 r7
r r r7 c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
2ContaineranalysisProvidersNotesSetIamPolicyRequesti an A ContaineranalysisProvidersNotesSetIamPolicyRequest object.
Fields:
resource: REQUIRED: The resource for which the policy is being specified.
See [Resource
names](https://cloud.google.com/apis/design/resource_names) for the
appropriate value for this field.
setIamPolicyRequest: A SetIamPolicyRequest resource to be passed as the
request body.
r Tr r r r Nr r r r r9 r9 r r r9 c ` \ rS rSrSr\R " SSS9r\R " SS5 r Sr
g )
8ContaineranalysisProvidersNotesTestIamPermissionsRequesti, a A ContaineranalysisProvidersNotesTestIamPermissionsRequest object.
Fields:
resource: REQUIRED: The resource for which the policy detail is being
requested. See [Resource
names](https://cloud.google.com/apis/design/resource_names) for the
appropriate value for this field.
testIamPermissionsRequest: A TestIamPermissionsRequest resource to be
passed as the request body.
r Tr r r r Nr r r r r; r; , r r r; c b \ rS rSrSr\R " SS5 r\R " S5 r Sr
g)r i< zRequest for creating an operation
Fields:
operation: The operation to create.
operationId: The ID to use for this operation.
Operationr r r N) r r r r r r r> operationr operationIdr r r r r r < s+ $$[!4)%%a(+r r c > \ rS rSrSr\R " SS5 rSrg)DSSEAttestationNoteiH znA note describing an attestation
Fields:
hint: DSSEHint hints at the purpose of the attestation authority.
DSSEHintr r NrP r r r rA rA H s
A .$r rA c d \ rS rSrSr\R " SS5 r\R " SS5 rSr g) DSSEAttestationOccurrenceiR zAn occurrence describing an attestation on a resource
Fields:
envelope: If doing something security critical, make sure to verify the
signatures in this metadata.
statement: A InTotoStatement attribute.
Enveloper r r r N)
r r r r r r r> envelope statementr r r r rD rD R s.
#
#J
2($$%6:)r rD c < \ rS rSrSr\R " S5 rSrg)rB i_ aB 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.
Fields:
humanReadableName: Required. The human readable name of this attestation
authority, for example "cloudbuild-prod".
r r NrT r r r rB rB _ s
++A.r rB c : \ rS rSrSr\R " SSS9rSrg)
Deployableio zxAn artifact that can be deployed in some runtime.
Fields:
resourceUri: Resource URI for the artifact being deployed.
r Tr r N) r r r r r r r resourceUrir r r r rJ rJ o s %%a$7+r rJ c > \ rS rSrSr " S S\R 5 r\R " S5 r \R " S5 r
\R " S5 r \R " SS5 r
\R " S S
S 9r\R " S 5 r\R " S
5 rSrg)
Deploymentiy ab The period during which some deployable was active in a runtime.
Enums:
PlatformValueValuesEnum: Platform hosting this deployment.
Fields:
address: Address of the runtime element hosting this deployment.
config: Configuration used to create this deployment.
deployTime: Beginning of the lifetime of this deployment.
platform: Platform hosting this deployment.
resourceUri: Resource URI for the artifact being deployed taken from the
deployable field with the same name.
undeployTime: End of the lifetime of this deployment.
userEmail: Identity of the user that triggered this deployment.
c ( \ rS rSrSrSrSrSrSrSr g) "Deployment.PlatformValueValuesEnumi zPlatform hosting this deployment.
Values:
PLATFORM_UNSPECIFIED: Unknown
GKE: Google Container Engine
FLEX: Google App Engine: Flexible Environment
CUSTOM: Custom user-defined platform
r r r r r N)
r r r r r PLATFORM_UNSPECIFIEDGKEFLEXCUSTOMr r r r PlatformValueValuesEnumrO s
C D
Fr rT r r r r r5 Tr r7 r8 r N)r r r r r r r; rT r addressr
deployTimerD platformrK undeployTime userEmailr r r r rM rM y s
! !! $' #&$$Q'*
!:A
>(%%a$7+&&q),##A&)r rM c \ rS rSrSr\R " S5 r\R " S\R R S9r \R " SS5 r
\R " SS S
S 9rS rg
)Derivedi a~ Derived describes the derived image portion (Occurrence) of the
DockerImage relationship. This image would be produced from a Dockerfile
with FROM .
Fields:
baseResourceUrl: Output only. This contains the base image URL for the
derived image occurrence.
distance: Output only. The number of layers by which this image differs
from the associated image basis.
fingerprint: The fingerprint of the derived image.
layerInfo: 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.
r r rY rc r Layerr Tr r N)r r r r r r r baseResourceUrlr[ r\ UINT32distancer> rd layerInfor r r r r[ r[ s]
))!,/
#
#Ay/@/@/G/G
H(&&}a8+$$Wa$?)r r[ c \ rS rSrSr\R " S5 r\R " S5 r\R " SS5 r
\R " S5 r \R " SS 5 r
\R " SS
5 r\R " S 5 r\R " S 5 r\R " S
5 r\R " S5 r\R " S5 rSrg)Detaili a Identifies all occurrences 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
Fields:
cpeUri: 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. This field can be used as a filter in list
requests.
description: A vendor-specific description of this note.
fixedLocation: The fix for this specific package version.
isObsolete: Whether this Detail is obsolete. Occurrences are expected not
to point to obsolete details.
maxAffectedVersion: The max version of the package in which the
vulnerability exists.
minAffectedVersion: The min version of the package in which the
vulnerability exists.
package: The name of the package where the vulnerability was found. This
field can be used as a filter in list requests.
packageType: The type of package; whether native or non native(ruby gems,
node.js packages etc)
severityName: The severity (eg: distro assigned severity) for this
vulnerability.
source: The source from which the information in this Detail was obtained.
vendor: The vendor of the product. e.g. "google"
r r VulnerabilityLocationr r Versionr5 r7 r8 r9 r: r r r N)r r r r r r r rl r] r>
fixedLocationr
isObsoletemaxAffectedVersionminAffectedVersionpackage packageType severityNamer vendorr r r r rb rb s 6 #&%%a(+(()@!D-%%a(* --i; --i; ! !! $'%%a(+&&q), $& $&r rb c ` \ rS rSrSr\R " S5 r\R " S5 r Sr
g)Digesti z_Digest information.
Fields:
algo: `SHA1`, `SHA512` etc.
digestBytes: Value of the digest.
r r r N) r r r r r r r algora digestBytesr r r r rn rn s)
q !$$$Q'+r rn c * \ rS rSrSr " S S\R 5 r " S S\R 5 r\R " SS5 r
\R " S S
S S 9r \R " SS
5 r
\R " S S5 r\R " S5 r\R " SS5 r\R " S5 r\R " SSS S 9r\R " S5 r\R " SS5 r\R " SS5 r\R " SS5 rSrg )
Discoveredi aA Provides information about the scan status of a discovered resource.
Enums:
AnalysisStatusValueValuesEnum: The status of discovery for the resource.
ContinuousAnalysisValueValuesEnum: Whether the resource is continuously
analyzed.
Fields:
analysisCompleted: The list of analysis that were completed for a
resource.
analysisError: Indicates any errors encountered during analysis of a
resource. There could be 0 or more of these errors.
analysisStatus: The status of discovery for the resource.
analysisStatusError: When an error is encountered this will contain a
LocalizedMessage under details to show to the user. The LocalizedMessage
output only and populated by the API.
archiveTime: The time occurrences related to this discovery occurrence
were archived.
continuousAnalysis: Whether the resource is continuously analyzed.
cpe: The CPE of the resource being scanned.
files: Optional. Files that make up the resource described by the
occurrence.
lastScanTime: The last time this resource was scanned.
operation: Output only. An operation that indicates the status of the
current scan. This field is deprecated, do not use.
sbomStatus: Output only. The status of an SBOM generation.
vulnerabilityAttestation: Output only. The status of a vulnerability
attestation generation.
c 4 \ rS rSrSrSrSrSrSrSr Sr
S r S
r g ) (Discovered.AnalysisStatusValueValuesEnumi
a The status of discovery for the resource.
Values:
ANALYSIS_STATUS_UNSPECIFIED: Unknown
PENDING: Resource is known but no action has been taken yet.
SCANNING: Resource is being analyzed.
COMPLETE: Analysis has completed
FINISHED_SUCCESS: Analysis has finished successfully.
FINISHED_FAILED: Analysis has finished unsuccessfully, the analysis
itself is in a bad state.
FINISHED_UNSUPPORTED: The resource is known not to be supported.
r r r r r r5 r7 r N)
r r r r r ANALYSIS_STATUS_UNSPECIFIEDr SCANNINGCOMPLETEFINISHED_SUCCESSFINISHED_FAILEDFINISHED_UNSUPPORTEDr r r r AnalysisStatusValueValuesEnumrt
s/ #$ GHHO r r{ c $ \ rS rSrSrSrSrSrSrg),Discovered.ContinuousAnalysisValueValuesEnumi
zWhether the resource is continuously analyzed.
Values:
CONTINUOUS_ANALYSIS_UNSPECIFIED: Unknown
ACTIVE: The resource is continuously analyzed.
INACTIVE: The resource is ignored for continuous analysis.
r r r r N) r r r r r CONTINUOUS_ANALYSIS_UNSPECIFIEDACTIVEINACTIVEr r r r !ContinuousAnalysisValueValuesEnumr}
s '(#
FHr r r r Statusr Tr r r r5 r7 r8 Filer9 r: r= r
SBOMStatusr VulnerabilityAttestationr r N)r r r r r r r; r{ r r> analysisCompleted
analysisErrorrD analysisStatusanalysisStatusErrorr archiveTimecontinuousAnalysiscpefiles lastScanTimer>
sbomStatusvulnerabilityAttestationr r r r rr rr s < inn *
)..
,,-@!D((1tD- &&'FJ.!..x;%%a(+ **+NPQR a #
T
:%&&q),$$["5)%%lB7* & 3 34NPR Sr rr c h \ rS rSrSr " S S\R 5 r\R " SS5 r Sr
g) Discoveryi:
a A note that indicates a type of analysis a provider would perform. This
note exists in a provider's project. A `Discovery` occurrence is created in
a consumer's project at the start of analysis. The occurrence's operation
will indicate the status of the analysis. Absence of an occurrence linked to
this note for a resource indicates that analysis hasn't started.
Enums:
AnalysisKindValueValuesEnum: The kind of analysis that is handled by this
discovery.
Fields:
analysisKind: The kind of analysis that is handled by this discovery.
c ` \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
S rS
rSrSrSrSrSrSrSrSrg)%Discovery.AnalysisKindValueValuesEnumiI
a The kind of analysis that is handled by this discovery.
Values:
KIND_UNSPECIFIED: Unknown
PACKAGE_VULNERABILITY: The note and occurrence represent a package
vulnerability.
BUILD_DETAILS: The note and occurrence assert build provenance.
IMAGE_BASIS: This represents an image basis relationship.
PACKAGE_MANAGER: This represents a package installed via a package
manager.
DEPLOYABLE: The note and occurrence track deployment events.
DISCOVERY: The note and occurrence track the initial discovery status of
a resource.
ATTESTATION_AUTHORITY: This represents a logical "role" that can attest
to artifacts.
UPGRADE: This represents an available software upgrade.
COMPLIANCE: This represents a compliance check that can be applied to a
resource.
SBOM: This represents a software bill of materials.
SPDX_PACKAGE: This represents an SPDX Package.
SPDX_FILE: This represents an SPDX File.
SPDX_RELATIONSHIP: This represents an SPDX Relationship.
DSSE_ATTESTATION: This represents a DSSE attestation Note
VULNERABILITY_ASSESSMENT: This represents a Vulnerability Assessment.
SBOM_REFERENCE: This represents a reference to an SBOM.
SECRET: This represents a secret.
r r r r r r5 r7 r8 r9 r: r r r r r r r r r Nr r r r AnalysisKindValueValuesEnumr I
r r r r r N) r r r r r r r; r rD analysisKindr r r r r r :
s- -INN -^ $$%BAF,r r c \ rS rSrSr " S S\R 5 r\R " SS5 r \R " S5 r \R " S5 r \R " SS 5 r\R " S
5 r\R " S 5 rS rg
) Distributioni{
a) This represents a particular channel of distribution for a given
package. e.g. Debian's jessie-backports dpkg mirror
Enums:
ArchitectureValueValuesEnum: The CPU architecture for which packages in
this distribution channel were built
Fields:
architecture: The CPU architecture for which packages in this distribution
channel were built
cpeUri: The cpe_uri in [cpe format](https://cpe.mitre.org/specification/)
denoting the package manager version distributing a package.
description: The distribution channel-specific description of this
package.
latestVersion: The latest available version of this package in this
distribution channel.
maintainer: A freeform string denoting the maintainer of this package.
url: The distribution channel-specific homepage for this package.
c $ \ rS rSrSrSrSrSrSrg)(Distribution.ArchitectureValueValuesEnumi
zThe CPU architecture for which packages in this distribution channel
were built
Values:
ARCHITECTURE_UNSPECIFIED: Unknown architecture
X86: X86 architecture
X64: X64 architecture
r r r r N r r r r r ARCHITECTURE_UNSPECIFIEDX86X64r r r r ArchitectureValueValuesEnumr
!
C
Cr r r r r rd r r5 r7 r N)r r r r r r r; r rD architecturer rl r] r>
latestVersion
maintainerr| r r r r r r {
s~ ( INN $$%BAF, #&%%a(+((A6-$$Q'* a #r r c ` \ rS rSrSr\R " S5 r\R " S5 rSr g) DocumentNotei
a DocumentNote represents an SPDX Document Creation Infromation section:
https://spdx.github.io/spdx-spec/2-document-creation-information/
Fields:
dataLicence: Compliance with the SPDX specification includes populating
the SPDX fields therein with data related to such fields ("SPDX-
Metadata")
spdxVersion: Provide a reference number that can be used to understand how
to parse and interpret the rest of the file
r r r N)
r r r r r r r dataLicence spdxVersionr r r r r r
s) %%a(+%%a(+r r c X \ rS rSrSr\R " S5 r\R " S5 r\R " SSS9r \R " S5 r
\R " S SS9r \R " S
5 r \R " S 5 r
\R " S 5 r\R " S
5 rSrg)DocumentOccurrencei
a DocumentOccurrence represents an SPDX Document Creation Information
section: https://spdx.github.io/spdx-spec/2-document-creation-information/
Fields:
createTime: 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
creatorComment: 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
creators: 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
documentComment: A field for creators of the SPDX file content to provide
comments to the consumers of the SPDX document
externalDocumentRefs: Identify any external SPDX documents referenced
within this SPDX document
id: Identify the current SPDX document which may be referenced in
relationships by other files, packages internally and documents
externally
licenseListVersion: A field for creators of the SPDX file to provide the
version of the SPDX License List used when the SPDX file was created
namespace: 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
title: Identify name of this document as designated by creator
r r r Tr r r5 r7 r8 r9 r: r N)r r r r r r r r creatorCommentcreatorsdocumentCommentexternalDocumentRefsr! licenseListVersion namespacerc r r r r r r
s 8 $$Q'* ((+.
"
"1t
4( ))!,/"..q4@ Q " ,,Q/##A&)
"%r r c \ rS rSrSrSrg)Emptyi
a 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); }
r Nr r r r r r r r r r r
s r r c \ rS rSrSr\R " S5 r\R " S5 r \R " SSSS9r S r g
) rE i
a MUST match https://github.com/secure-systems-
lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary
type.
Fields:
payload: The bytes being signed
payloadType: The type of payload being signed
signatures: The signatures over the payload
r r EnvelopeSignaturer Tr r N)
r r r r r r ra payloadr payloadTyper>
signaturesr r r r rE rE
s>
#'%%a(+%%&91tL*r rE c ` \ rS rSrSr\R " S5 r\R " S5 r Sr
g)r i
zpA DSSE signature
Fields:
keyid: A reference id to the key being used for signing
sig: The signature itself
r r r N) r r r r r r r keyidra sigr r r r r r
s)
"% Q #r r c ` \ rS rSrSr\R " S5 r\R " S5 rSr g) ExploitPredictionScoringSystemi a ExploitPredictionScoringSystem provides information about the Exploit
Prediction Scoring System (EPSS) score and percentile.
Fields:
percentile: Optional. The percentile of the current score, the proportion
of all scored vulnerabilities with the same or a lower EPSS score
score: Optional. The EPSS score representing the probability [0-1] of
exploitation in the wild in the next 30 days
r r r N)
r r r r r r r7
percentilescorer r r r r r s) ##A&*
q
!%r r c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r \R " S5 r
Sr g) ri i aq 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.
Fields:
description: Optional. Description of the expression. This is a longer
text which describes the expression, e.g. when hovered over it in a UI.
expression: Textual representation of an expression in Common Expression
Language syntax.
location: Optional. String indicating the location of the expression for
error reporting, e.g. a file name and a position in the file.
title: 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.
r r r r r N) r r r r r r r r]
expressionr rc r r r r ri ri sI : %%a(+$$Q'*
"
"1
%(
"%r ri c \ rS rSrSr " S S\R 5 r\R " SS5 r \R " S5 r \R " S5 r \R " S5 r
S rg
) ExternalRefi5 a 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
Enums:
CategoryValueValuesEnum: 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
Fields:
category: 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
comment: Human-readable information about the purpose and target of the
reference
locator: The unique string with no spaces necessary to access the package-
specific information, metadata, or content within the target location
type: Type of category (e.g. 'npm' for the PACKAGE_MANAGER category)
c , \ rS rSrSrSrSrSrSrSr Sr
g )
#ExternalRef.CategoryValueValuesEnumiL a 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
Values:
CATEGORY_UNSPECIFIED: Unspecified
SECURITY: Security (e.g. cpe22Type, cpe23Type)
PACKAGE_MANAGER: Package Manager (e.g. maven-central, npm, nuget, bower,
purl)
PERSISTENT_ID: Persistent-Id (e.g. swh)
OTHER: Other
r r r r r r N) r r r r r CATEGORY_UNSPECIFIEDSECURITYr
PERSISTENT_IDOTHERr r r r CategoryValueValuesEnumr L s# HOM
Er r r r r r r N)r r r r r r r; r rD categoryr rz locatorr r r r r r r 5 s\ , &
!:A
>( ! !! $' ! !! $' q !$r r c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " SS5 r \R " S5 r
Srg )
r ie zA file as part of a resource.
Messages:
DigestValue: Optional. The digest(s) of the file.
Fields:
digest: Optional. The digest(s) of the file.
name: Optional. The name of the file.
ro c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
File.DigestValueip zOptional. The digest(s) of the file.
Messages:
AdditionalProperty: An additional property for a DigestValue object.
Fields:
additionalProperties: Additional properties of type DigestValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)#File.DigestValue.AdditionalPropertyi{ An additional property for a DigestValue object.
Fields:
key: Name of the additional property.
value: A string attribute.
r r r Nr r r r rx r { r r rx r Tr r Nrz r r r DigestValuer p 2 'Y . . ' %112FTXYr r r r r Nr r r r r r r r r{ r r> r: r r" r r r r r r e s[ !!"89ZI%% Z :Z. ! !- 3& q !$r r c < \ rS rSrSr\R " SSSS9rSrg)
FileHashesi zContainer message for hashes of byte content of files, used in Source
messages to verify integrity of source input to the build.
Fields:
fileHash: Collection of file hashes.
Hashr Tr r NrP r r r r r s
#
#FA
=(r r c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g) FileLocationi ab Indicates the location at which a package was found.
Fields:
filePath: For jars that are contained inside .war files, this filepath can
indicate the path to war file combined with the path to jar file.
layerDetails: Each package found in a file should have its own layer
metadata (that is, information from the origin layer of the package).
r LayerDetailsr r N) r r r r r r r filePathr> layerDetailsr r r r r r s+
"
"1
%('':,r r c \ rS rSrSr " S S\R 5 r\R " SSS9r \R " SS5 r \R " S 5 r S
r
g ) FileNotei a FileNote represents an SPDX File Information section:
https://spdx.github.io/spdx-spec/4-file-information/
Enums:
FileTypeValueValuesEnum: This field provides information about the type of
file identified
Fields:
checksum: Provide a unique identifier to match analysis information on
each specific file in a package
fileType: This field provides information about the type of file
identified
title: Identify the full path and filename that corresponds to the file
information in this section
c H \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
S rS
rSrSrg) FileNote.FileTypeValueValuesEnumi a This field provides information about the type of file identified
Values:
FILE_TYPE_UNSPECIFIED: Unspecified
SOURCE: The file is human readable source code (.c, .html, etc.)
BINARY: The file is a compiled object, target image or binary executable
(.o, .a, etc.)
ARCHIVE: The file represents an archive (.tar, .jar, etc.)
APPLICATION: The file is associated with a specific application type
(MIME type of application/*)
AUDIO: The file is associated with an audio file (MIME type of audio/* ,
e.g. .mp3)
IMAGE: The file is associated with an picture image file (MIME type of
image/*, e.g., .jpg, .gif)
TEXT: The file is human readable text file (MIME type of text/*)
VIDEO: The file is associated with a video file type (MIME type of
video/*)
DOCUMENTATION: The file serves as documentation
SPDX: The file is an SPDX document
OTHER: The file doesn't fit into the above categories (generated
artifacts, data files, etc.)
r r r r r r5 r7 r8 r9 r: r r r N)r r r r r FILE_TYPE_UNSPECIFIEDSOURCEBINARYARCHIVE APPLICATIONAUDIOIMAGETEXTVIDEO
DOCUMENTATIONSPDXr r r r r FileTypeValueValuesEnumr sF ,
F
FGK
E
E D
EM
D Er r r Tr r r r N)r r r r r r r; r r r rD fileTyperc r r r r r r sO " "H
"
"1t
4(
!:A
>(
"%r r c 4 \ rS rSrSr\R " SSS9r\R " S5 r\R " SSS9r \R " S5 r
\R " S SS9r \R " S
5 r \R " S S 5 r\R " S
5 rSrg)FileOccurrencei au FileOccurrence represents an SPDX File Information section:
https://spdx.github.io/spdx-spec/4-file-information/
Fields:
attributions: 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
comment: This field provides a place for the SPDX file creator to record
any general comments about the file
contributors: This field provides a place for the SPDX file creator to
record file contributors
copyright: Identify the copyright holder of the file, as well as any dates
present
filesLicenseInfo: This field contains the license information actually
found in the file, if any
id: Uniquely identify any element in an SPDX document which may be
referenced by other elements
licenseConcluded: This field contains the license the SPDX file creator
has concluded as governing the file or alternative values if the
governing license cannot be determined
notice: This field provides a place for the SPDX file creator to record
license notices or other such related notices found in the file
r Tr r r r r5 r7 Licenser8 r9 r N)r r r r r r r attributionsrz contributors copyrightfilesLicenseInfor! r> licenseConcludednoticer r r r r r s 0 &&q48, ! !! $'&&q48,##A&) **1t< Q " ++Iq9 #&r r c \ rS rSrSr\R " S5 r\R " SSS9r\R " S5 r Sr
g )
rc i a A set of properties that uniquely identify a given Docker image.
Fields:
v1Name: The layer-id of the final layer in the Docker image's v1
representation. This field can be used as a filter in list requests.
v2Blob: The ordered list of v2 blobs that represent a given image.
v2Name: 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. This field can be used as a
filter in list requests.
r r Tr r r N) r r r r r r r v1Namev2Blobv2Namer r r r rc rc s;
#& T 2& #&r rc c > \ rS rSrSr\R " SS5 rSrg)r i zRequest message for `GetIamPolicy` method.
Fields:
options: OPTIONAL: A `GetPolicyOptions` object for specifying options to
`GetIamPolicy`.
GetPolicyOptionsr r N) r r r r r r r> r r r r r r r s
" "#5q 9'r r c b \ rS rSrSr\R " S\R R S9r Sr
g)r i a] Encapsulates settings provided to GetIamPolicy.
Fields:
requestedPolicyVersion: 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).
r rY r N) r r r r r r r[ r\ r] requestedPolicyVersionr r r r r r s( " %11!Y=N=N=T=TUr r c < \ rS rSrSr\R " SSSS9rSrg) "GetVulnzOccurrencesSummaryResponsei4 zA summary of how many vulnz occurrences there are per severity type.
counts by groups, or if we should have different summary messages like this.
Fields:
counts: A map of how many occurrences were found for each severity.
SeverityCountr Tr r N) r r r r r r r> countsr r r r r r 4 s ! !/1t D&r r c \ rS rSrSr " S S\R 5 r\R " SS5 r \R " S5 r Sr g) 3GoogleDevtoolsContaineranalysisV1alpha1AliasContexti? zAn alias to a repo revision.
Enums:
KindValueValuesEnum: The alias kind.
Fields:
kind: The alias kind.
name: The alias name.
c ( \ rS rSrSrSrSrSrSrSr g) GGoogleDevtoolsContaineranalysisV1alpha1AliasContext.KindValueValuesEnumiJ zThe alias kind.
Values:
KIND_UNSPECIFIED: Unknown.
FIXED: Git tag.
MOVABLE: Git branch.
OTHER: Used to specify non-standard aliases. For example, if a Git repo
has a ref named "refs/foo/bar".
r r r r r N)
r r r r r r r/ MOVABLEr r r r r r r J s
EG
Er r r r r N)
r r r r r r r; r rD r r r" r r r r r r ? s<
INN
2A 6$ q !$r r c \ rS rSrSr\R " SS5 r\R " SS5 r\R " S5 r
Sr g )
=GoogleDevtoolsContaineranalysisV1alpha1CloudRepoSourceContexti] zA CloudRepoSourceContext denotes a particular revision in a Google Cloud
Source Repo.
Fields:
aliasContext: An alias, which may be a branch or tag.
repoId: The ID of the repo.
revisionId: A revision ID.
r r -GoogleDevtoolsContaineranalysisV1alpha1RepoIdr r r N) r r r r r r r> aliasContextrepoIdr
revisionIdr r r r r r ] sA ''(]_`a, ! !"QST U&$$Q'*r r c \ rS rSrSr\R " SS5 r\R " S5 r \R " S5 r
\R " S5 r Sr g )
:GoogleDevtoolsContaineranalysisV1alpha1GerritSourceContextil ax A SourceContext referring to a Gerrit project.
Fields:
aliasContext: An alias, which may be a branch or tag.
gerritProject: 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.
hostUri: The URI of a running Gerrit instance.
revisionId: A revision (commit) ID.
r r r r r r N)
r r r r r r r> r r
gerritProjecthostUrir
r r r r r r l sM ''(]_`a,''*- ! !! $'$$Q'*r r c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)7GoogleDevtoolsContaineranalysisV1alpha1GitSourceContexti~ zA GitSourceContext denotes a particular revision in a third party Git
repository (e.g., GitHub).
Fields:
revisionId: Required. Git commit hash.
url: Git repository URL.
r r r N)
r r r r r r r r
r| r r r r r r ~ s) $$Q'* a #r r c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)8GoogleDevtoolsContaineranalysisV1alpha1OperationMetadatai a Metadata for all operations used and required for all operations that
created by Container Analysis Providers
Fields:
createTime: Output only. The time this operation was created.
endTime: Output only. The time that this operation was marked completed or
failed.
r r r N)
r r r r r r r r r r r r r r r s) $$Q'* ! !! $'r r c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)4GoogleDevtoolsContaineranalysisV1alpha1ProjectRepoIdi zSelects a repo using a Google Cloud Platform project ID (e.g., winged-
cargo-31) and a repo name within that project.
Fields:
projectId: The ID of the project.
repoName: The name of the repo. Leave empty for the default repo.
r r r N)
r r r r r r r r rs r r r r r r s) ##A&)
"
"1
%(r r c b \ rS rSrSr\R " SS5 r\R " S5 r Sr
g)r
i zA unique identifier for a Cloud Repo.
Fields:
projectRepoId: A combination of a project ID and a repo name.
uid: A server-assigned, globally unique identifier.
r r r r N) r r r r r r r>
projectRepoIdr uidr r r r r
r
s- (()_abc- a #r r
c < \ rS rSrSr\R " S5 rSrg)GGoogleDevtoolsContaineranalysisV1alpha1SlsaProvenanceZeroTwoSlsaBuilderi zIdentifies the entity that executed the recipe, which is trusted to have
correctly performed the operation and populated this provenance.
Fields:
id: URI indicating the builder's identity.
r r Nr r r r r r s Q "r r c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r Sr
g)LGoogleDevtoolsContaineranalysisV1alpha1SlsaProvenanceZeroTwoSlsaCompletenessi aM Indicates that the builder claims certain fields in this message to be
complete.
Fields:
environment: If true, the builder claims that invocation.environment is
complete.
materials: If true, the builder claims that materials is complete.
parameters: If true, the builder claims that invocation.parameters is
complete.
r r r r N) r r r r r r r rV rW
parametersr r r r r r s9 &&q)+$$Q')%%a(*r r c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " SS5 r \R " S5 r
\R " S5 rS rg
) LGoogleDevtoolsContaineranalysisV1alpha1SlsaProvenanceZeroTwoSlsaConfigSourcei a" Describes where the config file that kicked off the build came from.
This is effectively a pointer to the source where buildConfig came from.
Messages:
DigestValue: Collection of cryptographic digests for the contents of the
artifact specified by invocation.configSource.uri.
Fields:
digest: Collection of cryptographic digests for the contents of the
artifact specified by invocation.configSource.uri.
entryPoint: String identifying the entry point into the build.
uri: URI indicating the identity of the source of the config.
ro c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
XGoogleDevtoolsContaineranalysisV1alpha1SlsaProvenanceZeroTwoSlsaConfigSource.DigestValuei a Collection of cryptographic digests for the contents of the artifact
specified by invocation.configSource.uri.
Messages:
AdditionalProperty: An additional property for a DigestValue object.
Fields:
additionalProperties: Additional properties of type DigestValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)kGoogleDevtoolsContaineranalysisV1alpha1SlsaProvenanceZeroTwoSlsaConfigSource.DigestValue.AdditionalPropertyi r r r r Nr r r r rx r% r r rx r Tr r Nrz r r r r r# r r r r r r r N)r r r r r r r r r{ r r> r: r
entryPointr r r r r r! r! sk !!"89ZI%% Z :Z0 ! !- 3&$$Q'* a #r r! c 2 \ rS rSrSr\R " S5 " S S\R 5 5 r \R " S5 " S S\R 5 5 r
\R " SS 5 r \R " SS
5 r
\R " SS 5 rS rg
)JGoogleDevtoolsContaineranalysisV1alpha1SlsaProvenanceZeroTwoSlsaInvocationi aS Identifies the event that kicked off the build.
Messages:
EnvironmentValue: Any other builder-controlled inputs necessary for
correctly evaluating the build.
ParametersValue: Collection of all external inputs that influenced the
build on top of invocation.configSource.
Fields:
configSource: Describes where the config file that kicked off the build
came from.
environment: Any other builder-controlled inputs necessary for correctly
evaluating the build.
parameters: Collection of all external inputs that influenced the build on
top of invocation.configSource.
ro c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
[GoogleDevtoolsContaineranalysisV1alpha1SlsaProvenanceZeroTwoSlsaInvocation.EnvironmentValuei
zAny other builder-controlled inputs necessary for correctly evaluating
the build.
Messages:
AdditionalProperty: An additional property for a EnvironmentValue
object.
Fields:
additionalProperties: Properties of the object.
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g)nGoogleDevtoolsContaineranalysisV1alpha1SlsaProvenanceZeroTwoSlsaInvocation.EnvironmentValue.AdditionalPropertyi An additional property for a EnvironmentValue object.
Fields:
key: Name of the additional property.
value: A extra_types.JsonValue attribute.
r rt r r Nru r r r rx r, ry r rx r Tr r Nrz r r r EnvironmentValuer*
4 AY . . A %112FTXYr r. c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
ZGoogleDevtoolsContaineranalysisV1alpha1SlsaProvenanceZeroTwoSlsaInvocation.ParametersValuei' zCollection of all external inputs that influenced the build on top of
invocation.configSource.
Messages:
AdditionalProperty: An additional property for a ParametersValue object.
Fields:
additionalProperties: Properties of the object.
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g)mGoogleDevtoolsContaineranalysisV1alpha1SlsaProvenanceZeroTwoSlsaInvocation.ParametersValue.AdditionalPropertyi3 zAn additional property for a ParametersValue object.
Fields:
key: Name of the additional property.
value: A extra_types.JsonValue attribute.
r rt r r Nru r r r rx r3 3 ry r rx r Tr r Nrz r r r ParametersValuer1 ' r} r r4 r! r r r r N)r r r r r r r r r{ r. r4 r> configSourcerV r r r r r r( r( s " !!"89Z** Z :Z2 !!"89Z )) Z :Z0 ''(vxyz,&&'91=+%%&7;*r r( c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " SS5 r \R " S5 r
Srg )
HGoogleDevtoolsContaineranalysisV1alpha1SlsaProvenanceZeroTwoSlsaMaterialiE a The collection of artifacts that influenced the build including sources,
dependencies, build tools, base images, and so on.
Messages:
DigestValue: Collection of cryptographic digests for the contents of this
artifact.
Fields:
digest: Collection of cryptographic digests for the contents of this
artifact.
uri: The method by which this artifact was referenced during the build.
ro c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
TGoogleDevtoolsContaineranalysisV1alpha1SlsaProvenanceZeroTwoSlsaMaterial.DigestValueiS zCollection of cryptographic digests for the contents of this artifact.
Messages:
AdditionalProperty: An additional property for a DigestValue object.
Fields:
additionalProperties: Additional properties of type DigestValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)gGoogleDevtoolsContaineranalysisV1alpha1SlsaProvenanceZeroTwoSlsaMaterial.DigestValue.AdditionalPropertyi^ r r r r Nr r r r rx r; ^ r r rx r Tr r Nrz r r r r r9 S r r r r r r Nr r r r r r r r r{ r r> r: r r r r r r r7 r7 E s[ !!"89ZI%% Z :Z. ! !- 3& a #r r7 c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r \R " SS5 r \R " S5 r
S rg
) HGoogleDevtoolsContaineranalysisV1alpha1SlsaProvenanceZeroTwoSlsaMetadataio a Other properties of the build.
Fields:
buildFinishedOn: The timestamp of when the build completed.
buildInvocationId: Identifies this particular build invocation, which can
be useful for finding associated logs or other ad-hoc analysis.
buildStartedOn: The timestamp of when the build started.
completeness: Indicates that the builder claims certain fields in this
message to be complete.
reproducible: If true, the builder claims that running invocation on
materials will produce bit-for-bit identical output.
r r r r r r5 r Nr r r r r r r buildFinishedOnbuildInvocationIdbuildStartedOnr> completenessr reproducibler r r r r> r> o s^ ))!,/ ++A. ((+.''(vxyz,''*,r r> c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " SS5 r \R " SS 5 r \R " S
S 5 r
\R " SS 5 rS
rg)4GoogleDevtoolsContaineranalysisV1alpha1SourceContexti a 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.
Messages:
LabelsValue: Labels with user defined metadata.
Fields:
cloudRepo: A SourceContext referring to a revision in a Google Cloud
Source Repo.
gerrit: A SourceContext referring to a Gerrit project.
git: A SourceContext referring to any third party Git repo (e.g., GitHub).
labels: Labels with user defined metadata.
ro c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
@GoogleDevtoolsContaineranalysisV1alpha1SourceContext.LabelsValuei zLabels with user defined metadata.
Messages:
AdditionalProperty: An additional property for a LabelsValue object.
Fields:
additionalProperties: Additional properties of type LabelsValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)SGoogleDevtoolsContaineranalysisV1alpha1SourceContext.LabelsValue.AdditionalPropertyi zAn additional property for a LabelsValue object.
Fields:
key: Name of the additional property.
value: A string attribute.
r r r Nr r r r rx rJ r r rx r Tr r Nrz r r r LabelsValuerH r r rK r r r r r r r r N)r r r r r r r r r{ rK r> cloudRepogerritgitlabelsr r r r rF rF s
!!"89ZI%% Z :Z. $$%dfgh) ! !"^`a b& XZ[\# ! !- 3&r rF c \ rS rSrSr " S S\R 5 r\R " SS5 r \R " S5 r Sr g) r i rZ c $ \ rS rSrSrSrSrSrSrg)Hash.TypeValueValuesEnumi zThe type of hash that was performed.
Values:
NONE: No hash requested.
SHA256: A sha256 hash.
GO_MODULE_H1: Dirhash of a Go module's source code which is then hex-
encoded.
r r r r N) r r r r r r r r r r r r r rR s
D
FLr r r r r Nr] r r r r r s< INN
2A 6$
q
!%r r c \ rS rSrSr " S S\R 5 r\R " SS5 r \R " S5 r Sr g) IdentifierHelperi a Helps in identifying the underlying product. This should be treated like
a one-of field. Only one field should be set in this proto. This is a
workaround because spanner indexes on one-of fields restrict addition and
deletion of fields.
Enums:
FieldValueValuesEnum: The field that is set in the API proto.
Fields:
field: The field that is set in the API proto.
genericUri: Contains a URI which is vendor-specific. Example: The artifact
repository URL of an image.
c \ rS rSrSrSrSrSrg)%IdentifierHelper.FieldValueValuesEnumi zThe field that is set in the API proto.
Values:
IDENTIFIER_HELPER_FIELD_UNSPECIFIED: The helper isn't set.
GENERIC_URI: The generic_uri one-of field is set.
r r r N)r r r r r #IDENTIFIER_HELPER_FIELD_UNSPECIFIED GENERIC_URIr r r r FieldValueValuesEnumrV s +,'Kr rY r r r N)
r r r r r r r; rY rD fieldr
genericUrir r r r rT rT s< Y^^
4a
8%$$Q'*r rT c \ rS rSrSr\R " SS5 r\R " SSS9r \R " SS 5 r
\R " S
S 5 r S r g
)r i am A InTotoProvenance object.
Fields:
builderConfig: required
materials: The collection of artifacts that influenced the build including
sources, dependencies, build tools, base images, and so on. This is
considered to be incomplete unless metadata.completeness.materials is
true. Unset or null is equivalent to empty.
metadata: A Metadata attribute.
recipe: Identifies the configuration used for the build. When combined
with materials, this SHOULD fully describe the build, such that re-
running this recipe results in bit-for-bit identical output (if the
build is reproducible). required
r r r Tr Metadatar Reciper r N)
r r r r r r r>
builderConfigr rW metadatareciper r r r r r sQ
(( !<-##A5)
#
#J
2( ! !(A .&r r c \ rS rSrSr\R " S5 r\R " SS5 r \R " S5 r
\R " SSS S
9r S r g )
r i zA InTotoSlsaProvenanceV1 object.
Fields:
_type: InToto spec defined at https://github.com/in-
toto/attestation/tree/main/spec#statement
predicate: A SlsaProvenanceV1 attribute.
predicateType: A string attribute.
subject: A Subject attribute.
r SlsaProvenanceV1r r Subjectr Tr r N
r r r r r r r _typer> predicate
predicateTypesubjectr r r r r r sP
"%$$%7;)''*- " "9a$ ?'r r c \ rS rSrSr\R " S5 r\R " S5 r\R " SS5 r
\R " SS5 r \R " S S
5 r \R " S S S
S9r
Srg)r i a Spec defined at https://github.com/in-
toto/attestation/tree/main/spec#statement The serialized InTotoStatement
will be stored as Envelope.payload. Envelope.payloadType is always
"application/vnd.in-toto+json".
Fields:
_type: Always "https://in-toto.io/Statement/v0.1".
predicateType: "https://slsa.dev/provenance/v0.1" for SlsaProvenance.
provenance: Generic Grafeas provenance.
slsaProvenance: SLSA 0.1 provenance.
slsaProvenanceZeroTwo: SLSA 0.2 provenance.
subject: subject is the subjects of the intoto statement
r r r r SlsaProvenancer SlsaProvenanceZeroTwor5 rd r7 Tr r N)r r r r r r r rf rh r> r slsaProvenanceslsaProvenanceZeroTwori r r r r r r sw
"%''*-%%&8!<* ))*:A>.#001H!L " "9a$ ?'r r c D \ rS rSrSr " S S\R 5 r\R " SS5 r \R " S5 r \R " SS5 r
\R " S S
S S 9r\R " S
5 r\R " S5 r\R " SS5 rSrg) Installationi) a) This represents how a particular software package may be installed on a
system.
Enums:
ArchitectureValueValuesEnum: Output only. The CPU architecture for which
packages in this distribution channel were built. Architecture will be
blank for language packages.
Fields:
architecture: Output only. The CPU architecture for which packages in this
distribution channel were built. Architecture will be blank for language
packages.
cpeUri: Output only. The cpe_uri in [CPE
format](https://cpe.mitre.org/specification/) denoting the package
manager version distributing a package. The cpe_uri will be blank for
language packages.
license: Licenses that have been declared by the authors of the package.
location: All of the places within the filesystem versions of this package
have been found.
name: Output only. The name of the installed package.
packageType: Output only. The type of package; whether native or non
native (e.g., ruby gems, node.js packages, etc.).
version: Output only. The version of the package.
c $ \ rS rSrSrSrSrSrSrg)(Installation.ArchitectureValueValuesEnumiC zOutput only. The CPU architecture for which packages in this
distribution channel were built. Architecture will be blank for language
packages.
Values:
ARCHITECTURE_UNSPECIFIED: Unknown architecture
X86: X86 architecture
X64: X64 architecture
r r r r Nr r r r r rr C s !
C
Cr r r r r r Locationr Tr r5 r7 rd r8 r N)r r r r r r r; r rD r r rl r> licenser r" rj rd r r r r rp rp ) s 2 INN $$%BAF, #& " "9a 0'
#
#JD
A( q !$%%a(+ " "9a 0'r rp c \ rS rSrSr " S S\R 5 r\R " S5 r \R " SS5 r Sr g) r3 iZ aK Justification provides the justification when the state of the
assessment if NOT_AFFECTED.
Enums:
JustificationTypeValueValuesEnum: The justification type for this
vulnerability.
Fields:
details: Additional details on why this justification was chosen.
justificationType: The justification type for this vulnerability.
c 0 \ rS rSrSrSrSrSrSrSr Sr
S r g
) .Justification.JustificationTypeValueValuesEnumig aG The justification type for this vulnerability.
Values:
JUSTIFICATION_TYPE_UNSPECIFIED: JUSTIFICATION_TYPE_UNSPECIFIED.
COMPONENT_NOT_PRESENT: The vulnerable component is not present in the
product.
VULNERABLE_CODE_NOT_PRESENT: The vulnerable code is not present.
Typically this case occurs when source code is configured or built in
a way that excludes the vulnerable code.
VULNERABLE_CODE_NOT_IN_EXECUTE_PATH: The vulnerable code can not be
executed. Typically this case occurs when the product includes the
vulnerable code but does not call or use the vulnerable code.
VULNERABLE_CODE_CANNOT_BE_CONTROLLED_BY_ADVERSARY: The vulnerable code
cannot be controlled by an attacker to exploit the vulnerability.
INLINE_MITIGATIONS_ALREADY_EXIST: The product includes built-in
protections or features that prevent exploitation of the
vulnerability. These built-in protections cannot be subverted by the
attacker and cannot be configured or disabled by the user. These
mitigations completely prevent exploitation based on known attack
vectors.
r r r r r r5 r N) r r r r r JUSTIFICATION_TYPE_UNSPECIFIEDCOMPONENT_NOT_PRESENTVULNERABLE_CODE_NOT_PRESENT#VULNERABLE_CODE_NOT_IN_EXECUTE_PATH1VULNERABLE_CODE_CANNOT_BE_CONTROLLED_BY_ADVERSARY INLINE_MITIGATIONS_ALREADY_EXISTr r r r JustificationTypeValueValuesEnumrw g s- * &'" "# *+'895'($r r~ r r r N)
r r r r r r r; r~ r detailsrD justificationTyper r r r r3 r3 Z s=
) ):
! !! $' ))*LaPr r3 c \ rS rSrSr " S S\R 5 r\R " S5 r \R " SS5 r Sr g) r\ i aB Layer holds metadata specific to a layer of a Docker image.
Enums:
DirectiveValueValuesEnum: The recovered Dockerfile directive used to
construct this layer.
Fields:
arguments: The recovered arguments to the Dockerfile directive.
directive: The recovered Dockerfile directive used to construct this
layer.
c ` \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
S rS
rSrSrSrSrSrSrSrSrg) Layer.DirectiveValueValuesEnumi a The recovered Dockerfile directive used to construct this layer.
Values:
DIRECTIVE_UNSPECIFIED: Default value for unsupported/missing directive
MAINTAINER: https://docs.docker.com/engine/reference/builder/
RUN: https://docs.docker.com/engine/reference/builder/
CMD: https://docs.docker.com/engine/reference/builder/
LABEL: https://docs.docker.com/engine/reference/builder/
EXPOSE: https://docs.docker.com/engine/reference/builder/
ENV: https://docs.docker.com/engine/reference/builder/
ADD: https://docs.docker.com/engine/reference/builder/
COPY: https://docs.docker.com/reference/builder/#copy
ENTRYPOINT: https://docs.docker.com/engine/reference/builder/
VOLUME: https://docs.docker.com/engine/reference/builder/
USER: https://docs.docker.com/engine/reference/builder/
WORKDIR: https://docs.docker.com/engine/reference/builder/
ARG: https://docs.docker.com/engine/reference/builder/
ONBUILD: https://docs.docker.com/engine/reference/builder/
STOPSIGNAL: https://docs.docker.com/engine/reference/builder/
HEALTHCHECK: https://docs.docker.com/engine/reference/builder/
SHELL: https://docs.docker.com/engine/reference/builder/
r r r r r r5 r7 r8 r9 r: r r r r r r r r r N)r r r r r DIRECTIVE_UNSPECIFIED
MAINTAINERRUNCMDLABELEXPOSEENVADDCOPY
ENTRYPOINTVOLUMEUSERWORKDIRARGONBUILD
STOPSIGNAL HEALTHCHECKSHELLr r r r DirectiveValueValuesEnumr sd , J
C
C
E
F
C
C DJ
F
DG
CGJK Er r r r r N)
r r r r r r r; r r rU rD directiver r r r r\ r\ s=
( (T ##A&)!!"
baseImagesr chainIdcommanddiffIdr[ r\ r] indexr r r r r r sk
%%k1tD* ! !! $' ! !! $' #&
I,=,=,C,C
D%r r c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)r i ap License information.
Fields:
comments: Comments
expression: Often a single license can be used to represent the licensing
terms. Sometimes it is necessary to include a choice of one or more
licenses or some combination of license identifiers. Examples:
"LGPL-2.1-only OR MIT", "LGPL-2.1-only AND MIT", "GPL-2.0-or-later WITH
Bison-exception-2.2".
r r r N)
r r r r r r r commentsr r r r r r r s)
"
"1
%($$Q'*r r c ` \ rS rSrSr\R " S5 r\R " SSSS9r Sr
g )
ListNoteOccurrencesResponsei zResponse including listed occurrences for a note.
Fields:
nextPageToken: Token to receive the next page of notes.
occurrences: The occurrences attached to the specified note.
r r r Tr r N r r r r r r r
nextPageTokenr> occurrencesr r r r r r - ''*-&&|QF+r r c ` \ rS rSrSr\R " S5 r\R " SSSS9r Sr
g )
ListNotesResponsei zResponse including listed notes.
Fields:
nextPageToken: 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 result.
notes: The occurrences requested
r r r Tr r N) r r r r r r r r r> notesr r r r r r s- ''*-
T
:%r r c ` \ rS rSrSr\R " S5 r\R " SSSS9r Sr
g )
ListOccurrencesResponsei a
Response including listed active occurrences.
Fields:
nextPageToken: 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.
occurrences: The occurrences requested.
r r r Tr r Nr r r r r r s- ''*-&&|QF+r r c ` \ rS rSrSr\R " S5 r\R " SSSS9r Sr
g )
ListScanConfigsResponsei zA list of scan configs for the project.
Fields:
nextPageToken: A page token to pass in order to get more scan configs.
scanConfigs: The set of scan configs.
r r( r Tr r N) r r r r r r r r r> scanConfigsr r r r r r r r r c \ rS rSrSr\R " S5 r\R " S5 r\R " SS5 r
Sr g) rs i a An occurrence of a particular package installation found within a
system's filesystem. e.g. glibc was found in /var/lib/dpkg/status
Fields:
cpeUri: Deprecated. The cpe_uri in [cpe
format](https://cpe.mitre.org/specification/) denoting the package
manager version distributing a package.
path: The path from which we gathered that this package/version is
installed.
version: Deprecated. The version installed at this location.
r r rd r r N) r r r r r r r rl r r> rd r r r r rs rs s;
#& q !$ " "9a 0'r rs c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " SS5 r \R " S5 r
Srg )
Materiali- a= Material is a material used in the generation of the provenance
Messages:
DigestValue: digest is a map from a hash algorithm (e.g. sha256) to the
value in the material
Fields:
digest: digest is a map from a hash algorithm (e.g. sha256) to the value
in the material
uri: uri is the uri of the material
ro c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
Material.DigestValuei: zdigest is a map from a hash algorithm (e.g. sha256) to the value in
the material
Messages:
AdditionalProperty: An additional property for a DigestValue object.
Fields:
additionalProperties: Additional properties of type DigestValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)'Material.DigestValue.AdditionalPropertyiF r r r r Nr r r r rx r F r r rx r Tr r Nrz r r r r r : r r r r r r Nr< r r r r r - s[
!!"89ZI%% Z :Z0 ! !- 3& a #r r c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r \R " SS5 r \R " S5 r
S rg
) r] iW [ Other properties of the build.
Fields:
buildFinishedOn: The timestamp of when the build completed.
buildInvocationId: Identifies the particular build invocation, which can
be useful for finding associated logs or other ad-hoc analysis. The
value SHOULD be globally unique, per in-toto Provenance spec.
buildStartedOn: The timestamp of when the build started.
completeness: Indicates that the builder claims certain fields in this
message to be complete.
reproducible: If true, the builder claims that running the recipe on
materials will produce bit-for-bit identical output.
r r r rR r r5 r Nr? r r r r] r] W s\ ))!,/ ++A. ((+.'':,''*,r r] c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r Sr
g)rg im a Details about files that caused a compliance check to fail.
Fields:
displayCommand: Command to display the non-compliant files.
path: display_command is a single command that can be used to display a
list of non compliant files. When there is no such command, we can also
iterate a list of non compliant file using 'path'. Empty if
`display_command` is set.
reason: Explains why a file is non compliant for a CIS check.
r r r r N) r r r r r r r displayCommandr reasonr r r r rg rg m s9 ((+. q !$ #&r rg c \ rS rSrSr " S S\R 5 r\R " SS5 r \R " SS5 r
\R " S S
5 r \R " S S 5 r \R " S
5 r\R " SS5 r\R " SS5 r\R " SS5 r\R " S5 r\R& " SS5 r\R " S5 r\R " S5 r\R " SS5 r\R " SSS S 9r\R " S S 5 r\R " S S!5 r\R " S"S#5 r\R " S$5 r \R " S%S&5 r \R " S'S(5 r \R " S)S*5 r \R " S+5 r \R " S,S-5 r!\R " S.S/5 r"\R " S0S15 r#S2r$g3)4r i~ ao Provides a detailed description of a `Note`.
Enums:
KindValueValuesEnum: Output only. This explicitly denotes which kind of
note is specified. This field can be used as a filter in list requests.
Fields:
attestationAuthority: A note describing an attestation role.
baseImage: A note describing a base image.
buildType: Build provenance type for a verifiable build.
compliance: A note describing a compliance check.
createTime: Output only. The time this note was created. This field can be
used as a filter in list requests.
deployable: A note describing something that can be deployed.
discovery: A note describing a provider/analysis type.
dsseAttestation: A note describing a dsse attestation note.
expirationTime: Time of expiration for this note, null if note does not
expire.
kind: Output only. This explicitly denotes which kind of note is
specified. This field can be used as a filter in list requests.
longDescription: A detailed description of this `Note`.
name: The name of the note in the form
"projects/{provider_project_id}/notes/{NOTE_ID}"
package: A note describing a package hosted by various package managers.
relatedUrl: URLs associated with this note
sbom: A note describing a software bill of materials.
sbomReference: A note describing a reference to an SBOM.
secret: A note describing a secret.
shortDescription: A one sentence description of this `Note`.
spdxFile: A note describing an SPDX File.
spdxPackage: A note describing an SPDX Package.
spdxRelationship: A note describing a relationship between SPDX elements.
updateTime: Output only. The time this note was last updated. This field
can be used as a filter in list requests.
upgrade: A note describing an upgrade.
vulnerabilityAssessment: A note describing a vulnerability assessment.
vulnerabilityType: A package vulnerability type of note.
c ` \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
S rS
rSrSrSrSrSrSrSrSrg)Note.KindValueValuesEnumi a Output only. This explicitly denotes which kind of note is specified.
This field can be used as a filter in list requests.
Values:
KIND_UNSPECIFIED: Unknown
PACKAGE_VULNERABILITY: The note and occurrence represent a package
vulnerability.
BUILD_DETAILS: The note and occurrence assert build provenance.
IMAGE_BASIS: This represents an image basis relationship.
PACKAGE_MANAGER: This represents a package installed via a package
manager.
DEPLOYABLE: The note and occurrence track deployment events.
DISCOVERY: The note and occurrence track the initial discovery status of
a resource.
ATTESTATION_AUTHORITY: This represents a logical "role" that can attest
to artifacts.
UPGRADE: This represents an available software upgrade.
COMPLIANCE: This represents a compliance check that can be applied to a
resource.
SBOM: This represents a software bill of materials.
SPDX_PACKAGE: This represents an SPDX Package.
SPDX_FILE: This represents an SPDX File.
SPDX_RELATIONSHIP: This represents an SPDX Relationship.
DSSE_ATTESTATION: This represents a DSSE attestation Note
VULNERABILITY_ASSESSMENT: This represents a Vulnerability Assessment.
SBOM_REFERENCE: This represents a reference to an SBOM.
SECRET: This represents a secret.
r r r r r r5 r7 r8 r9 r: r r r r r r r r r Nr r r r r r i 8 MKOJI GJ
DLI ! N
Fr r rM r ra r r r rZ r r5 rJ r7 r r8 rA r9 r: r r r Packager
RelatedUrlr Tr r r SBOMReferenceNoter
SecretNoter r r r PackageInfoNoter
RelationshipNoter r UpgradeNoter VulnerabilityAssessmentNoter VulnerabilityTyper r N)%r r r r r r r; r r> attestationAuthority baseImager
compliancer r
deployable discoverydsseAttestationexpirationTimerD r r@ r" ri
relatedUrlsbom
sbomReferencesecretrC spdxFile spdxPackagespdxRelationship
updateTimeupgradevulnerabilityAssessmentvulnerabilityTyper r r r r r ~ s %N.INN .` #//0FJ$$Wa0)$$[!4)%%&6:*$$Q'*%%lA6*$$[!4) **+@!D/ ((+. 2B 7$ ))"-/ r "$ " "9b 1'%%lBF* 3$(()C$$R(* " "=" 5' % 2 23PRT U ,,-@"Er r c \ rS rSrSr " S S\R 5 r\R " SS5 r \R " SS5 r
\R " S S
5 r \R " S 5 r
\R " S S
5 r\R " SS5 r\R " SS5 r\R " SS5 r\R " SS5 r\R " SS5 r\R( " SS5 r\R " S5 r\R " S5 r\R " S5 r\R " S S 5 r\R " S 5 r\R " S S 5 r\R " S!S"5 r \R " S#S$5 r \R " S%S&5 r \R " S'S(5 r \R " S)S*5 r \R " S+5 r!\R " S,S-5 r"\R " S.S/5 r#S0r$g1)2r i a `Occurrence` includes information about analysis occurrences for an
image.
Enums:
KindValueValuesEnum: Output only. This explicitly denotes which of the
`Occurrence` details are specified. This field can be used as a filter
in list requests.
Fields:
attestation: Describes an attestation of an artifact.
buildDetails: Build details for a verifiable build.
compliance: Describes whether or not a resource passes compliance checks.
createTime: Output only. The time this `Occurrence` was created.
deployment: Describes the deployment of an artifact on a runtime.
derivedImage: Describes how this resource derives from the basis in the
associated note.
discovered: Describes the initial scan status for this resource.
dsseAttestation: This represents a DSSE attestation occurrence
envelope: https://github.com/secure-systems-lab/dsse
installation: Describes the installation of a package on the linked
resource.
kind: Output only. This explicitly denotes which of the `Occurrence`
details are specified. This field can be used as a filter in list
requests.
name: Output only. The name of the `Occurrence` in the form
"projects/{project_id}/occurrences/{OCCURRENCE_ID}"
noteName: An analysis note associated with this image, in the form
"providers/{provider_id}/notes/{NOTE_ID}" This field can be used as a
filter in list requests.
remediation: A description of actions that can be taken to remedy the
`Note`
resource: The resource for which the `Occurrence` applies.
resourceUrl: The unique URL of the image or the container for which the
`Occurrence` applies. For example,
https://gcr.io/project/image@sha256:foo This field can be used as a
filter in list requests.
sbom: Describes a specific software bill of materials document.
sbomReference: This represents an SBOM reference occurrence
secret: This represents a secret occurrence
spdxFile: Describes a specific SPDX File.
spdxPackage: Describes a specific SPDX Package.
spdxRelationship: Describes a specific relationship between SPDX elements.
updateTime: Output only. The time this `Occurrence` was last updated.
upgrade: Describes an upgrade.
vulnerabilityDetails: Details of a security vulnerability note.
c ` \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
S rS
rSrSrSrSrSrSrSrSrg) Occurrence.KindValueValuesEnumi! a Output only. This explicitly denotes which of the `Occurrence` details
are specified. This field can be used as a filter in list requests.
Values:
KIND_UNSPECIFIED: Unknown
PACKAGE_VULNERABILITY: The note and occurrence represent a package
vulnerability.
BUILD_DETAILS: The note and occurrence assert build provenance.
IMAGE_BASIS: This represents an image basis relationship.
PACKAGE_MANAGER: This represents a package installed via a package
manager.
DEPLOYABLE: The note and occurrence track deployment events.
DISCOVERY: The note and occurrence track the initial discovery status of
a resource.
ATTESTATION_AUTHORITY: This represents a logical "role" that can attest
to artifacts.
UPGRADE: This represents an available software upgrade.
COMPLIANCE: This represents a compliance check that can be applied to a
resource.
SBOM: This represents a software bill of materials.
SPDX_PACKAGE: This represents an SPDX Package.
SPDX_FILE: This represents an SPDX File.
SPDX_RELATIONSHIP: This represents an SPDX Relationship.
DSSE_ATTESTATION: This represents a DSSE attestation Note
VULNERABILITY_ASSESSMENT: This represents a Vulnerability Assessment.
SBOM_REFERENCE: This represents a reference to an SBOM.
SECRET: This represents a secret.
r r r r r r5 r7 r8 r9 r: r r r r r r r r r Nr r r r r r ! r r r rH r r r rf r r rM r5 r[ r7 rr r8 rD r9 rE r: rp r r r r r Resourcer r r r SBOMReferenceOccurrencer SecretOccurrencer r r
PackageInfoOccurrencer RelationshipOccurrencer r UpgradeOccurrencer VulnerabilityDetailsr r N)%r r r r r r r; r r> attestation buildDetailsr r r
deployment derivedImage
discoveredr rF installationrD r r" noteNamer` r re r r r r r r r r vulnerabilityDetailsr r r r r r s -^.INN .` &&}a8+'':,%%&C+ ++,DbI$$R(* " "#6 ;'"//0FKr r c z \ rS rSrSr\R " S5 " S S\R 5 5 r \R " S5 " S S\R 5 5 r
\R " S5 r \R " S S
5 r\R " SS 5 r\R " S 5 r\R " SS
5 rSrg)r= il a This resource represents a long-running operation that is the result of
a network API call.
Messages:
MetadataValue: Service-specific metadata associated with the operation. It
typically contains progress information and common metadata such as
create time. Some services might not provide such metadata. Any method
that returns a long-running operation should document the metadata type,
if any.
ResponseValue: The normal, successful response of the operation. If the
original method returns no data on success, such as `Delete`, the
response is `google.protobuf.Empty`. If the original method is standard
`Get`/`Create`/`Update`, the response should be the resource. For other
methods, the response should have the type `XxxResponse`, where `Xxx` is
the original method name. For example, if the original method name is
`TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
Fields:
done: If the value is `false`, it means the operation is still in
progress. If `true`, the operation is completed, and either `error` or
`response` is available.
error: The error result of the operation in case of failure or
cancellation.
metadata: Service-specific metadata associated with the operation. It
typically contains progress information and common metadata such as
create time. Some services might not provide such metadata. Any method
that returns a long-running operation should document the metadata type,
if any.
name: The server-assigned name, which is only unique within the same
service that originally returns it. If you use the default HTTP mapping,
the `name` should be a resource name ending with
`operations/{unique_id}`.
response: The normal, successful response of the operation. If the
original method returns no data on success, such as `Delete`, the
response is `google.protobuf.Empty`. If the original method is standard
`Get`/`Create`/`Update`, the response should be the resource. For other
methods, the response should have the type `XxxResponse`, where `Xxx` is
the original method name. For example, if the original method name is
`TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
ro c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
Operation.MetadataValuei a Service-specific metadata associated with the operation. It typically
contains progress information and common metadata such as create time.
Some services might not provide such metadata. Any method that returns a
long-running operation should document the metadata type, if any.
Messages:
AdditionalProperty: An additional property for a MetadataValue object.
Fields:
additionalProperties: Properties of the object. Contains field @type
with type URL.
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g)*Operation.MetadataValue.AdditionalPropertyi zAn additional property for a MetadataValue object.
Fields:
key: Name of the additional property.
value: A extra_types.JsonValue attribute.
r rt r r Nru r r r rx r ry r rx r Tr r Nrz r r r
MetadataValuer s4 AY . . A %112FTXYr r c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
Operation.ResponseValuei a The normal, successful response of the operation. If the original
method returns no data on success, such as `Delete`, the response is
`google.protobuf.Empty`. If the original method is standard
`Get`/`Create`/`Update`, the response should be the resource. For other
methods, the response should have the type `XxxResponse`, where `Xxx` is
the original method name. For example, if the original method name is
`TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
Messages:
AdditionalProperty: An additional property for a ResponseValue object.
Fields:
additionalProperties: Properties of the object. Contains field @type
with type URL.
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g)*Operation.ResponseValue.AdditionalPropertyi zAn additional property for a ResponseValue object.
Fields:
key: Name of the additional property.
value: A extra_types.JsonValue attribute.
r rt r r Nru r r r rx r ry r rx r Tr r Nrz r r r
ResponseValuer s4 AY . . A %112FTXYr r r r r r r r5 r N)r r r r r r r r r{ r r r doner> errorr` r r" responser r r r r= r= l s 'R !!"89Zi'' Z :Z6 !!"89 Zi'' Z : Z<
"$
1
-%
#
#OQ
7( q !$
#
#OQ
7(r r= c \ rS rSrSr " S S\R 5 r\R " SS5 r \R " S5 r \R " S5 r \R " SS S
S 9r\R " S S
S
S 9r\R " SS5 r\R " S5 r\R " S5 r\R " S5 r\R " S5 r\R " SS5 rSrg)r i a This represents a particular package that is distributed over various
channels. e.g. glibc (aka libc6) is distributed by many, at various
versions.
Enums:
ArchitectureValueValuesEnum: The CPU architecture for which packages in
this distribution channel were built. Architecture will be blank for
language packages.
Fields:
architecture: The CPU architecture for which packages in this distribution
channel were built. Architecture will be blank for language packages.
cpeUri: The cpe_uri in [CPE format](https://cpe.mitre.org/specification/)
denoting the package manager version distributing a package. The cpe_uri
will be blank for language packages.
description: The description of this package.
digest: Hash value, typically a file digest, that allows unique
identification a specific package.
distribution: The various channels by which a package is distributed.
license: Licenses that have been declared by the authors of the package.
maintainer: A freeform text denoting the maintainer of this package.
name: The name of the package.
packageType: The type of package; whether native or non native (e.g., ruby
gems, node.js packages, etc.).
url: The homepage for this package.
version: The version of the package.
c $ \ rS rSrSrSrSrSrSrg)#Package.ArchitectureValueValuesEnumi zThe CPU architecture for which packages in this distribution channel
were built. Architecture will be blank for language packages.
Values:
ARCHITECTURE_UNSPECIFIED: Unknown architecture
X86: X86 architecture
X64: X64 architecture
r r r r Nr r r r r r r r r r r r rn r Tr r r5 r r7 r8 r9 r: r rd r r N)r r r r r r r; r rD r r rl r] r> r: distributionrt r r" rj r| rd r r r r r r s 8 INN $$%BAF, #&%%a(+ ! !(A =&''DI, " "9a 0'$$Q'* q !$%%a(+ b!# " "9b 1'r r c | \ rS rSrSr\R " S5 r\R " S5 r \R " S5 r
\R " S5 r \R " S5 r \R " S5 r
\R " S S
S S 9r\R " S
S S 9r\R " S5 r\R " SS5 r\R " S5 r\R " S5 r\R " S5 r\R " S5 r\R " S5 r\R " S5 r\R " S5 rSrg)r i a PackageInfoNote represents an SPDX Package Information section:
https://spdx.github.io/spdx-spec/3-package-information/
Fields:
analyzed: Indicates whether the file content of this package has been
available for or subjected to analysis when creating the SPDX document
attribution: A place for the SPDX data creator to record, at the package
level, acknowledgements that may be needed to be communicated in some
contexts
checksum: Provide an independently reproducible mechanism that permits
unique identification of a specific package that correlates to the data
in this SPDX file
copyright: Identify the copyright holders of the package, as well as any
dates present
detailedDescription: A more detailed description of the package
downloadLocation: 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
externalRefs: ExternalRef
filesLicenseInfo: 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 \u2013 it is simply a
listing of all licenses found
homePage: Provide a place for the SPDX file creator to record a web site
that serves as the package's home page
licenseDeclared: List the licenses that have been declared by the authors
of the package
originator: 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
packageType: The type of package: OS, MAVEN, GO, GO_STDLIB, etc.
summaryDescription: A short description of the package
supplier: Identify the actual distribution source for the
package/directory identified in the SPDX file
title: Identify the full name of the package as given by the Package
Originator
verificationCode: 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
version: Identify the version of the package
r r r r r5 r7 r r8 Tr r9 r: r r r r r r r r r r N)r r r r r r r analyzedr attributionr r detailedDescriptiondownloadLocationr> externalRefsr homePagelicenseDeclared
originatorrj summaryDescriptionsupplierrc verificationCoderd r r r r r r s' +Z
#
#A
&(%%a(+
"
"1
%(##A&)!--a0 **1-''
q4H, **1t<
"
"1
%( **9b9/$$R(*%%b)+ ,,R0
"
"2
&(
#% **2. ! !" %'r r c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r \R " S5 r
\R " SS5 r \R " S 5 r
\R " S
5 r\R " S 5 r\R " S 5 r\R " S
5 rSrg)r iP a PackageInfoOccurrence represents an SPDX Package Information section:
https://spdx.github.io/spdx-spec/3-package-information/
Fields:
comment: A place for the SPDX file creator to record any general comments
about the package being described
filename: Provide the actual file name of the package, or path of the
directory being treated as a package
homePage: Output only. Provide a place for the SPDX file creator to record
a web site that serves as the package's home page
id: Uniquely identify any element in an SPDX document which may be
referenced by other elements
licenseConcluded: package or alternative values, if the governing license
cannot be determined
packageType: Output only. The type of package: OS, MAVEN, GO, GO_STDLIB,
etc.
sourceInfo: Provide a place for the SPDX file creator to record any
relevant background information or additional comments about the origin
of the package
summaryDescription: Output only. A short description of the package
title: Output only. Identify the full name of the package as given by the
Package Originator
version: Output only. Identify the version of the package
r r r r r r5 r7 r8 r9 r: r r N)r r r r r r r rz filenamer r! r> r rj
sourceInfor rc rd r r r r r r P s 2
! !! $'
"
"1
%(
"
"1
%( Q " ++Iq9%%a(+$$Q'* ,,Q/
"% ! !" %'r r c \ rS rSrSr " S S\R 5 r\R " SS5 r \R " SS5 r \R " SS5 r \R " S 5 r\R " S
5 rS rg )
PackageIssueiv ap This message wraps a location affected by a vulnerability and its
associated fix (if one is available).
Enums:
EffectiveSeverityValueValuesEnum: Output only. The distro or language
system assigned severity for this vulnerability when that is available
and note provider assigned severity when distro or language system has
not yet assigned a severity for this vulnerability.
Fields:
affectedLocation: The location of the vulnerability.
effectiveSeverity: Output only. The distro or language system assigned
severity for this vulnerability when that is available and note provider
assigned severity when distro or language system has not yet assigned a
severity for this vulnerability.
fixedLocation: The location of the available fix for vulnerability.
packageType: The type of package (e.g. OS, MAVEN, GO).
severityName: A string attribute.
c 0 \ rS rSrSrSrSrSrSrSr Sr
S r g
) -PackageIssue.EffectiveSeverityValueValuesEnumi a Output only. The distro or language system assigned severity for this
vulnerability when that is available and note provider assigned severity
when distro or language system has not yet assigned a severity for this
vulnerability.
Values:
SEVERITY_UNSPECIFIED: Unknown Impact
MINIMAL: Minimal Impact
LOW: Low Impact
MEDIUM: Medium Impact
HIGH: High Impact
CRITICAL: Critical Impact
r r r r r r5 r NrE r r r EffectiveSeverityValueValuesEnumr s( G
C
F DHr r rc r r r r r5 r N)r r r r r r r; r r> affectedLocationrD effectiveSeverityre r rj rk r r r r r
r
v st ( * ++,CQG ))*LaP(()@!D-%%a(+&&q),r r
c \ rS rSrSr " S S\R 5 r\R " SS5 r \R " S5 r \R " S5 r Sr
g )
rJ i a 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.
Enums:
ContentTypeValueValuesEnum: 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).
Fields:
contentType: 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).
pgpKeyId: 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
hexadecimal 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`.
signature: 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.
c \ rS rSrSrSrSrSrg)/PgpSignedAttestation.ContentTypeValueValuesEnumi aZ 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).
Values:
CONTENT_TYPE_UNSPECIFIED: `ContentType` is not set.
SIMPLE_SIGNING_JSON: Atomic format attestation signature. See https://gi
thub.com/containers/image/blob/8a5d2f82a6e3263290c8e0276c3e0f64e77723e
7/docs/atomic-signature.md The payload extracted from `signature` is a
JSON blob conforming to the linked schema.
r r r N)r r r r r CONTENT_TYPE_UNSPECIFIEDSIMPLE_SIGNING_JSONr r r r ContentTypeValueValuesEnumr s ! r r r r r r N)r r r r r r r; r rD contentTyper pgpKeyIdr r r r r rJ rJ sM %N 9>> ##$@!D+
"
"1
%(##A&)r rJ c \ rS rSrSr\R " SSSS9r\R " S5 r \R " S\R R S 9r
S
rg ) Policyi a* 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/).
Fields:
bindings: 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`.
etag: `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.
version: 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).
rg r Tr r r rY r N)r r r r r r r> bindingsra etagr[ r\ r] rd r r r r r r sM DL
#
#Iq4
@( a $ " "1i.?.?.E.E F'r r c \ rS rSrSr\R " S5 r\R " SS5 r \R " S5 r
Sr g) Producti0 a Product contains information about a product and how to uniquely
identify it.
Fields:
id: Token that identifies a product so that it can be referred to from
other parts in the document. There is no predefined format as long as it
uniquely identifies a group in the context of the current document.
identifierHelper: Helps in identifying the underlying product.
name: Name of the product.
r rT r r r N) r r r r r r r r! r> identifierHelperr" r r r r r r 0 s= Q " ++,>B q !$r r c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " SSSS 9r \R " S
5 r
\R " SS 5 rS rg
)ProvenanceBuilderiA zA ProvenanceBuilder object.
Messages:
VersionValue: A VersionValue object.
Fields:
builderDependencies: A ResourceDescriptor attribute.
id: A string attribute.
version: A VersionValue attribute.
ro c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
ProvenanceBuilder.VersionValueiM zA VersionValue object.
Messages:
AdditionalProperty: An additional property for a VersionValue object.
Fields:
additionalProperties: Additional properties of type VersionValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)1ProvenanceBuilder.VersionValue.AdditionalPropertyiX zAn additional property for a VersionValue object.
Fields:
key: Name of the additional property.
value: A string attribute.
r r r Nr r r r rx r' X r r rx r Tr r Nrz r r r VersionValuer% M r r r( r r Tr r r r N)r r r r r r r r r{ r( r> builderDependenciesr r! rd r r r r r# r# A sr !!"89ZY&& Z :Z. "../CQQUV Q " " ">1 5'r r# c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r Sr
g) Publisherij a0 Publisher contains information about the publisher of this Note.
Fields:
issuingAuthority: Provides information about the authority of the issuing
party to release the document, in particular, the party's constituency
and responsibilities or other obligations.
name: Name of the publisher. Examples: 'Google', 'Google Cloud Platform'.
publisherNamespace: The context or namespace. Contains a URL which is
under control of the issuing party and can be used as a globally unique
identifier for that issuing party. Example: https://csaf.io
r r r r N) r r r r r r r issuingAuthorityr" publisherNamespacer r r r r+ r+ j s;
**1- q !$ ,,Q/r r+ c t \ rS rSrSr\R " S5 " S S\R 5 5 r \R " S5 " S S\R 5 5 r
\R " SSS S
9r \R " S 5 r\R " S 5 r\R " SS
S S
9r\R " S5 rSrg)r^ i| aR Steps taken to build the artifact. For a TaskRun, typically each
container corresponds to one step in the recipe.
Messages:
ArgumentsValueListEntry: A ArgumentsValueListEntry object.
EnvironmentValueListEntry: A EnvironmentValueListEntry object.
Fields:
arguments: Collection of all external inputs that influenced the build on
top of recipe.definedInMaterial and recipe.entryPoint. For example, if
the recipe type were "make", then this might be the flags passed to make
aside from the target, which is captured in recipe.entryPoint.
definedInMaterial: Index in materials containing the recipe steps that are
not implied by recipe.type. For example, if the recipe type were "make",
then this would point to the source containing the Makefile, not the
make program itself. Set to -1 if the recipe doesn't come from a
material, as zero is default unset value for int64.
entryPoint: String identifying the entry point into the build. This is
often a path to a configuration file and/or a target label within that
file. The syntax and meaning are defined by recipe.type. For example, if
the recipe type were "make", then this would reference the directory in
which to run make as well as which target to use.
environment: Any other builder-controlled inputs necessary for correctly
evaluating the recipe. Usually only needed for reproducing the build but
not evaluated as part of policy.
type: URI indicating what type of recipe was performed. It determines the
meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and
materials.
ro c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
Recipe.ArgumentsValueListEntryi zA ArgumentsValueListEntry object.
Messages:
AdditionalProperty: An additional property for a ArgumentsValueListEntry
object.
Fields:
additionalProperties: Properties of the object. Contains field @type
with type URL.
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g)1Recipe.ArgumentsValueListEntry.AdditionalPropertyi zAn additional property for a ArgumentsValueListEntry object.
Fields:
key: Name of the additional property.
value: A extra_types.JsonValue attribute.
r rt r r Nru r r r rx r2 ry r rx r Tr r Nrz r r r ArgumentsValueListEntryr0 r/ r r3 c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
Recipe.EnvironmentValueListEntryi zA EnvironmentValueListEntry object.
Messages:
AdditionalProperty: An additional property for a
EnvironmentValueListEntry object.
Fields:
additionalProperties: Properties of the object. Contains field @type
with type URL.
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g)3Recipe.EnvironmentValueListEntry.AdditionalPropertyi zAn additional property for a EnvironmentValueListEntry object.
Fields:
key: Name of the additional property.
value: A extra_types.JsonValue attribute.
r rt r r Nru r r r rx r7 ry r rx r Tr r Nrz r r r EnvironmentValueListEntryr5 r/ r r8 r Tr r r r r5 r N)r r r r r r r r r{ r3 r8 r> rU r[ definedInMaterialr r& rV r r r r r r^ r^ | s < !!"89Z 1 1 Z :Z2 !!"89Z)"3"3 Z :Z2 $$%>DQ) ,,Q/$$Q'*&&'BAPTU+ q !$r r^ c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)r i zMetadata for any related URL information
Fields:
label: Label to describe usage of the URL
url: Specific URL to associate with the note
r r r N)
r r r r r r r labelr| r r r r r r )
"% a #r r c h \ rS rSrSr " S S\R 5 r\R " SS5 r Sr
g)r i a@ RelationshipNote represents an SPDX Relationship section:
https://spdx.github.io/spdx-spec/7-relationships-between-SPDX-elements/
Enums:
TypeValueValuesEnum: The type of relationship between the source and
target SPDX elements
Fields:
type: The type of relationship between the source and target SPDX elements
c \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
S rS
rSrSrSrSrSrSrSrSrSrSrSrSrSr Sr S r S r S r S r!S r"S!r#S"r$S#r%S$r&S%r'S&r(S'r)S(r*S)r+S*r,S+r-S,r.S-r/S.r0S/r1g0)1$RelationshipNote.TypeValueValuesEnumi a The type of relationship between the source and target SPDX elements
Values:
RELATIONSHIP_TYPE_UNSPECIFIED: Unspecified
DESCRIBES: Is to be used when SPDXRef-DOCUMENT describes SPDXRef-A
DESCRIBED_BY: Is to be used when SPDXRef-A is described by SPDXREF-
Document
CONTAINS: Is to be used when SPDXRef-A contains SPDXRef-B
CONTAINED_BY: Is to be used when SPDXRef-A is contained by SPDXRef-B
DEPENDS_ON: Is to be used when SPDXRef-A depends on SPDXRef-B
DEPENDENCY_OF: Is to be used when SPDXRef-A is dependency of SPDXRef-B
DEPENDENCY_MANIFEST_OF: Is to be used when SPDXRef-A is a manifest file
that lists a set of dependencies for SPDXRef-B
BUILD_DEPENDENCY_OF: Is to be used when SPDXRef-A is a build dependency
of SPDXRef-B
DEV_DEPENDENCY_OF: Is to be used when SPDXRef-A is a development
dependency of SPDXRef-B
OPTIONAL_DEPENDENCY_OF: Is to be used when SPDXRef-A is an optional
dependency of SPDXRef-B
PROVIDED_DEPENDENCY_OF: Is to be used when SPDXRef-A is a to be provided
dependency of SPDXRef-B
TEST_DEPENDENCY_OF: Is to be used when SPDXRef-A is a test dependency of
SPDXRef-B
RUNTIME_DEPENDENCY_OF: Is to be used when SPDXRef-A is a dependency
required for the execution of SPDXRef-B
EXAMPLE_OF: Is to be used when SPDXRef-A is an example of SPDXRef-B
GENERATES: Is to be used when SPDXRef-A generates SPDXRef-B
GENERATED_FROM: Is to be used when SPDXRef-A was generated from
SPDXRef-B
ANCESTOR_OF: Is to be used when SPDXRef-A is an ancestor (same lineage
but pre-dates) SPDXRef-B
DESCENDANT_OF: Is to be used when SPDXRef-A is a descendant of (same
lineage but postdates) SPDXRef-B
VARIANT_OF: Is to be used when SPDXRef-A is a variant of (same lineage
but not clear which came first) SPDXRef-B
DISTRIBUTION_ARTIFACT: Is to be used when distributing SPDXRef-A
requires that SPDXRef-B also be distributed
PATCH_FOR: Is to be used when SPDXRef-A is a patch file for (to be
applied to) SPDXRef-B
PATCH_APPLIED: Is to be used when SPDXRef-A is a patch file that has
been applied to SPDXRef-B
COPY_OF: Is to be used when SPDXRef-A is an exact copy of SPDXRef-B
FILE_ADDED: Is to be used when SPDXRef-A is a file that was added to
SPDXRef-B
FILE_DELETED: Is to be used when SPDXRef-A is a file that was deleted
from SPDXRef-B
FILE_MODIFIED: Is to be used when SPDXRef-A is a file that was modified
from SPDXRef-B
EXPANDED_FROM_ARCHIVE: Is to be used when SPDXRef-A is expanded from the
archive SPDXRef-B
DYNAMIC_LINK: Is to be used when SPDXRef-A dynamically links to
SPDXRef-B
STATIC_LINK: Is to be used when SPDXRef-A statically links to SPDXRef-B
DATA_FILE_OF: Is to be used when SPDXRef-A is a data file used in
SPDXRef-B
TEST_CASE_OF: Is to be used when SPDXRef-A is a test case used in
testing SPDXRef-B
BUILD_TOOL_OF: Is to be used when SPDXRef-A is used to build SPDXRef-B
DEV_TOOL_OF: Is to be used when SPDXRef-A is used as a development tool
for SPDXRef-B
TEST_OF: Is to be used when SPDXRef-A is used for testing SPDXRef-B
TEST_TOOL_OF: Is to be used when SPDXRef-A is used as a test tool for
SPDXRef-B
DOCUMENTATION_OF: Is to be used when SPDXRef-A provides documentation of
SPDXRef-B
OPTIONAL_COMPONENT_OF: Is to be used when SPDXRef-A is an optional
component of SPDXRef-B
METAFILE_OF: Is to be used when SPDXRef-A is a metafile of SPDXRef-B
PACKAGE_OF: Is to be used when SPDXRef-A is used as a package as part of
SPDXRef-B
AMENDS: Is to be used when (current) SPDXRef-DOCUMENT amends the SPDX
information in SPDXRef-B
PREREQUISITE_FOR: Is to be used when SPDXRef-A is a prerequisite for
SPDXRef-B
HAS_PREREQUISITE: Is to be used when SPDXRef-A has as a prerequisite
SPDXRef-B
OTHER: Is to be used for a relationship which has not been defined in
the formal SPDX specification. A description of the relationship
should be included in the Relationship comments field
r r r r r r5 r7 r8 r9 r: r r r r r r r r r r r
r r r r r r r r r r r ! " # $ % & ' ( ) * + r N2r r r r r RELATIONSHIP_TYPE_UNSPECIFIED DESCRIBES DESCRIBED_BYCONTAINS CONTAINED_BY
DEPENDS_ON
DEPENDENCY_OFDEPENDENCY_MANIFEST_OFBUILD_DEPENDENCY_OFDEV_DEPENDENCY_OFOPTIONAL_DEPENDENCY_OFPROVIDED_DEPENDENCY_OFTEST_DEPENDENCY_OFRUNTIME_DEPENDENCY_OF
EXAMPLE_OF GENERATESGENERATED_FROM ANCESTOR_OF
DESCENDANT_OF
VARIANT_OFDISTRIBUTION_ARTIFACT PATCH_FOR
PATCH_APPLIEDCOPY_OF
FILE_ADDED FILE_DELETED
FILE_MODIFIEDEXPANDED_FROM_ARCHIVE DYNAMIC_LINK STATIC_LINK DATA_FILE_OF TEST_CASE_OF
BUILD_TOOL_OF DEV_TOOL_OFTEST_OF TEST_TOOL_OFDOCUMENTATION_OFOPTIONAL_COMPONENT_OF METAFILE_OF
PACKAGE_OFAMENDSPREREQUISITE_FORHAS_PREREQUISITEr r r r r r r? s O` %&!ILHLJM JINKMJ IMGJLM LKLLMKGL KJ
F Er r r r N) r r r r r r r; r rD r r r r r r r s/ |INN ||
2A 6$r r c \ rS rSrSr " S S\R 5 r\R " S5 r \R " S5 r
\R " S5 r \R " SS5 r
S rg
) r io at RelationshipOccurrence represents an SPDX Relationship section:
https://spdx.github.io/spdx-spec/7-relationships-between-SPDX-elements/
Enums:
TypeValueValuesEnum: Output only. The type of relationship between the
source and target SPDX elements
Fields:
comment: A place for the SPDX file creator to record any general comments
about the relationship
source: Also referred to as SPDXRef-A The source SPDX element (file,
package, etc)
target: 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
type: Output only. The type of relationship between the source and target
SPDX elements
c \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
S rS
rSrSrSrSrSrSrSrSrSrSrSrSrSr Sr S r S r S r S r!S r"S!r#S"r$S#r%S$r&S%r'S&r(S'r)S(r*S)r+S*r,S+r-S,r.S-r/S.r0S/r1g0)1*RelationshipOccurrence.TypeValueValuesEnumi a Output only. The type of relationship between the source and target
SPDX elements
Values:
RELATIONSHIP_TYPE_UNSPECIFIED: Unspecified
DESCRIBES: Is to be used when SPDXRef-DOCUMENT describes SPDXRef-A
DESCRIBED_BY: Is to be used when SPDXRef-A is described by SPDXREF-
Document
CONTAINS: Is to be used when SPDXRef-A contains SPDXRef-B
CONTAINED_BY: Is to be used when SPDXRef-A is contained by SPDXRef-B
DEPENDS_ON: Is to be used when SPDXRef-A depends on SPDXRef-B
DEPENDENCY_OF: Is to be used when SPDXRef-A is dependency of SPDXRef-B
DEPENDENCY_MANIFEST_OF: Is to be used when SPDXRef-A is a manifest file
that lists a set of dependencies for SPDXRef-B
BUILD_DEPENDENCY_OF: Is to be used when SPDXRef-A is a build dependency
of SPDXRef-B
DEV_DEPENDENCY_OF: Is to be used when SPDXRef-A is a development
dependency of SPDXRef-B
OPTIONAL_DEPENDENCY_OF: Is to be used when SPDXRef-A is an optional
dependency of SPDXRef-B
PROVIDED_DEPENDENCY_OF: Is to be used when SPDXRef-A is a to be provided
dependency of SPDXRef-B
TEST_DEPENDENCY_OF: Is to be used when SPDXRef-A is a test dependency of
SPDXRef-B
RUNTIME_DEPENDENCY_OF: Is to be used when SPDXRef-A is a dependency
required for the execution of SPDXRef-B
EXAMPLE_OF: Is to be used when SPDXRef-A is an example of SPDXRef-B
GENERATES: Is to be used when SPDXRef-A generates SPDXRef-B
GENERATED_FROM: Is to be used when SPDXRef-A was generated from
SPDXRef-B
ANCESTOR_OF: Is to be used when SPDXRef-A is an ancestor (same lineage
but pre-dates) SPDXRef-B
DESCENDANT_OF: Is to be used when SPDXRef-A is a descendant of (same
lineage but postdates) SPDXRef-B
VARIANT_OF: Is to be used when SPDXRef-A is a variant of (same lineage
but not clear which came first) SPDXRef-B
DISTRIBUTION_ARTIFACT: Is to be used when distributing SPDXRef-A
requires that SPDXRef-B also be distributed
PATCH_FOR: Is to be used when SPDXRef-A is a patch file for (to be
applied to) SPDXRef-B
PATCH_APPLIED: Is to be used when SPDXRef-A is a patch file that has
been applied to SPDXRef-B
COPY_OF: Is to be used when SPDXRef-A is an exact copy of SPDXRef-B
FILE_ADDED: Is to be used when SPDXRef-A is a file that was added to
SPDXRef-B
FILE_DELETED: Is to be used when SPDXRef-A is a file that was deleted
from SPDXRef-B
FILE_MODIFIED: Is to be used when SPDXRef-A is a file that was modified
from SPDXRef-B
EXPANDED_FROM_ARCHIVE: Is to be used when SPDXRef-A is expanded from the
archive SPDXRef-B
DYNAMIC_LINK: Is to be used when SPDXRef-A dynamically links to
SPDXRef-B
STATIC_LINK: Is to be used when SPDXRef-A statically links to SPDXRef-B
DATA_FILE_OF: Is to be used when SPDXRef-A is a data file used in
SPDXRef-B
TEST_CASE_OF: Is to be used when SPDXRef-A is a test case used in
testing SPDXRef-B
BUILD_TOOL_OF: Is to be used when SPDXRef-A is used to build SPDXRef-B
DEV_TOOL_OF: Is to be used when SPDXRef-A is used as a development tool
for SPDXRef-B
TEST_OF: Is to be used when SPDXRef-A is used for testing SPDXRef-B
TEST_TOOL_OF: Is to be used when SPDXRef-A is used as a test tool for
SPDXRef-B
DOCUMENTATION_OF: Is to be used when SPDXRef-A provides documentation of
SPDXRef-B
OPTIONAL_COMPONENT_OF: Is to be used when SPDXRef-A is an optional
component of SPDXRef-B
METAFILE_OF: Is to be used when SPDXRef-A is a metafile of SPDXRef-B
PACKAGE_OF: Is to be used when SPDXRef-A is used as a package as part of
SPDXRef-B
AMENDS: Is to be used when (current) SPDXRef-DOCUMENT amends the SPDX
information in SPDXRef-B
PREREQUISITE_FOR: Is to be used when SPDXRef-A is a prerequisite for
SPDXRef-B
HAS_PREREQUISITE: Is to be used when SPDXRef-A has as a prerequisite
SPDXRef-B
OTHER: Is to be used for a relationship which has not been defined in
the formal SPDX specification. A description of the relationship
should be included in the Relationship comments field
r r r r r r5 r7 r8 r9 r: r r r r r r r r r r r
r r r r r r r r r r r r@ rA rB rC rD rE rF rG rH rI rJ rK r NrL r r r r rz s Pb %&!ILHLJM JINKMJ IMGJLM LKLLMKGL KJ
F Er r r r r r r N)r r r r r r r; r r rz r targetrD r r r r r r r o s_ *}INN }~
! !! $' #& #& 2A 6$r r c \ rS rSrSr " S S\R 5 r\R " S5 r \R " SS5 r \R " SS5 r
S rg
) r6 i
a Specifies details on how to handle (and presumably, fix) a
vulnerability.
Enums:
RemediationTypeValueValuesEnum: The type of remediation that can be
applied.
Fields:
details: Contains a comprehensive human-readable discussion of the
remediation.
remediationType: The type of remediation that can be applied.
remediationUri: Contains the URL where to obtain the remediation.
c 0 \ rS rSrSrSrSrSrSrSr Sr
S r g
) *Remediation.RemediationTypeValueValuesEnumi a6 The type of remediation that can be applied.
Values:
REMEDIATION_TYPE_UNSPECIFIED: No remediation type specified.
MITIGATION: A MITIGATION is available.
NO_FIX_PLANNED: No fix is planned.
NONE_AVAILABLE: Not available.
VENDOR_FIX: A vendor fix is available.
WORKAROUND: A workaround is available.
r r r r r r5 r N) r r r r r REMEDIATION_TYPE_UNSPECIFIED
MITIGATIONNO_FIX_PLANNEDNONE_AVAILABLE
VENDOR_FIX
WORKAROUNDr r r r RemediationTypeValueValuesEnumr~ s( $% JNNJJr r r r r4 r r N)r r r r r r r; r r r rD remediationTyper> remediationUrir r r r r6 r6
sN y~~ $
! !! $' ''(H!L/ ))%3.r r6 c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r \R " S5 r
\R " S5 r Sr g )
RepoSourcei0 a* RepoSource describes the location of the source in a Google Cloud Source
Repository.
Fields:
branchName: Name of the branch to build.
commitSha: Explicit commit SHA to build.
projectId: ID of the project that owns the repo.
repoName: Name of the repo.
tagName: Name of the tag to build.
r r r r r5 r N)
r r r r r r r rp rq r rs rt r r r r r r 0 sY $$Q'*##A&)##A&)
"
"1
%( ! !! $'r r c \ rS rSrSr\R " SS5 r\R " S5 r \R " S5 r
Sr g) r iC aY Resource is an entity that can have metadata. E.g., a Docker image.
Fields:
contentHash: The hash of the resource content. E.g., the Docker digest.
name: The name of the resource. E.g., the name of a Docker image -
"Debian".
uri: The unique URI of the resource. E.g.,
"https://gcr.io/project/image@sha256:foo" for a Docker image.
r r r r r N) r r r r r r r> contentHashr r" r r r r r r r C s; &&vq1+ q !$ a #r r c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " S5 " S S\R 5 5 r
\R " SS5 r \R " S 5 r\R " SS
5 r\R " S 5 r\R " S 5 r\R " S
5 r\R " S5 rSrg)r iS ar A ResourceDescriptor object.
Messages:
AnnotationsValue: A AnnotationsValue object.
DigestValue: A DigestValue object.
Fields:
annotations: A AnnotationsValue attribute.
content: A byte attribute.
digest: A DigestValue attribute.
downloadLocation: A string attribute.
mediaType: A string attribute.
name: A string attribute.
uri: A string attribute.
ro c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
#ResourceDescriptor.AnnotationsValueid zA AnnotationsValue object.
Messages:
AdditionalProperty: An additional property for a AnnotationsValue
object.
Fields:
additionalProperties: Additional properties of type AnnotationsValue
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g)6ResourceDescriptor.AnnotationsValue.AdditionalPropertyip zAn additional property for a AnnotationsValue object.
Fields:
key: Name of the additional property.
value: A extra_types.JsonValue attribute.
r rt r r Nru r r r rx r p ry r rx r Tr r Nrz r r r AnnotationsValuer d r} r r c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
ResourceDescriptor.DigestValuei} zA DigestValue object.
Messages:
AdditionalProperty: An additional property for a DigestValue object.
Fields:
additionalProperties: Additional properties of type DigestValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)1ResourceDescriptor.DigestValue.AdditionalPropertyi r r r r Nr r r r rx r r r rx r Tr r Nrz r r r r r } r r r r r r r r5 r7 r8 r N)r r r r r r r r r{ r r r> annotationsra contentr: r r mediaTyper" r r r r r r r S s !!"89Z** Z :Z0 !!"89ZI%% Z :Z. &&'91=+ #' ! !- 3& **1-##A&) q !$ a #r r c d \ rS rSrSr\R " SS5 r\R " SS5 rSr g) Riski aw The Risk message provides information about the risk of a vulnerability.
Fields:
cisaKev: Optional. CISA maintains the authoritative source of
vulnerabilities that have been exploited in the wild.
epss: Optional. The Exploit Prediction Scoring System (EPSS) estimates the
likelihood (probability) that a software vulnerability will be exploited
in the wild.
r r r r r N)
r r r r r r r> cisaKevepssr r r r r r s/
" "#F J' @! D$r r c \ rS rSrSr\R " SS5 r\R " SSSS9r\R " S S
5 r S r
g )
RunDetailsi zA RunDetails object.
Fields:
builder: A ProvenanceBuilder attribute.
byproducts: A ResourceDescriptor attribute.
metadata: A BuildMetadata attribute.
r# r r r Tr r r r N) r r r r r r r> builder
byproductsr` r r r r r r sC
" "#6 :'%%&:AM*
#
#OQ
7(r r c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)r i zThe note representing an SBOM reference.
Fields:
format: The format that SBOM takes. E.g. may be spdx, cyclonedx, etc...
version: The version of the format that the SBOM takes. E.g. if the format
is spdx, the version may be 2.3.
r r r N)
r r r r r r r formatrd r r r r r r s) #& ! !! $'r r c \ rS rSrSr\R " SS5 r\R " S5 r \R " SSSS 9r
S
r g ) r i a The occurrence representing an SBOM reference as applied to a specific
resource. The occurrence follows the DSSE specification. See
https://github.com/secure-systems-lab/dsse/blob/master/envelope.md for more
details.
Fields:
payload: The actual payload that contains the SBOM reference data.
payloadType: The kind of payload that SbomReferenceIntotoPayload takes.
Since it's in the intoto format, this value is expected to be
'application/vnd.in-toto+json'.
signatures: The signatures over the payload.
SbomReferenceIntotoPayloadr r r r Tr r N) r r r r r r r> r r r r r r r r r r sA
" "#? C'%%a(+%%&91tL*r r c \ rS rSrSr " S S\R 5 r\R " S5 r \R " SS5 r Sr g) r i a0 The status of an SBOM generation.
Enums:
SbomStateValueValuesEnum: Output only. The progress of the SBOM
generation.
Fields:
error: Output only. If there was an error generating an SBOM, this will
indicate what that error was.
sbomState: Output only. The progress of the SBOM generation.
c $ \ rS rSrSrSrSrSrSrg)#SBOMStatus.SbomStateValueValuesEnumi zOutput only. The progress of the SBOM generation.
Values:
SBOM_STATE_UNSPECIFIED: Default unknown state.
PENDING: SBOM scanning is pending.
COMPLETE: SBOM scanning has completed.
r r r r N) r r r r r SBOM_STATE_UNSPECIFIEDr rw r r r r SbomStateValueValuesEnumr s GHr r r r r N)
r r r r r r r; r r r rD sbomStater r r r r r s<
"%!!" r: r r mimeType
referrerIdr r r r r r s{
!!"89ZI%% Z :Z. ! !- 3&
"
"1
%(
"
"1
%($$Q'*r r c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r
\R " S5 r \R " S5 r Sr
g )
r( i7 a Indicates various scans and whether they are turned on or off.
Fields:
createTime: Output only. The time this scan config was created.
description: Output only. A human-readable description of what the
`ScanConfig` does.
enabled: Indicates whether the Scan is enabled.
name: Output only. The name of the ScanConfig in the form
"projects/{project_id}/scanConfigs/{scan_config_id}".
updateTime: Output only. The time this scan config was last updated.
r r r r r5 r N)r r r r r r r r r] r enabledr" r r r r r r( r( 7 sY
$$Q'*%%a(+ " "1 %' q !$$$Q'*r r( c > \ rS rSrSr\R " SS5 rSrg)SecretLocationiK zVThe location of the secret.
Fields:
fileLocation: The secret is found from a file.
r r r N) r r r r r r r> fileLocationr r r r r r K s '':,r r c \ rS rSrSrSrg)r iU z The note representing a secret.r Nr r r r r r U s (r r c \ rS rSrSr " S S\R 5 r\R " SS5 r \R " SSSS 9r \R " S
S SS 9r S r
g
)r iY zThe occurrence provides details of a secret.
Enums:
KindValueValuesEnum: Required. Type of secret.
Fields:
kind: Required. Type of secret.
locations: Optional. Locations where the secret is detected.
statuses: Optional. Status of the secret.
c t \ rS rSrSrSrSrSrSrSr Sr
S r S
r S r
S rS
rSrSrSrSrSrSrSrSrSrSrSrSrSr g) $SecretOccurrence.KindValueValuesEnumie a Required. Type of secret.
Values:
SECRET_KIND_UNSPECIFIED: Unspecified
SECRET_KIND_UNKNOWN: The secret kind is unknown.
SECRET_KIND_GCP_SERVICE_ACCOUNT_KEY: A Google Cloud service account key
per: https://cloud.google.com/iam/docs/creating-managing-service-
account-keys
SECRET_KIND_GCP_API_KEY: A Google Cloud API key per:
https://cloud.google.com/docs/authentication/api-keys
SECRET_KIND_GCP_OAUTH2_CLIENT_CREDENTIALS: A Google Cloud OAuth2 client
credentials per:
https://developers.google.com/identity/protocols/oauth2
SECRET_KIND_GCP_OAUTH2_ACCESS_TOKEN: A Google Cloud OAuth2 access token
per: https://cloud.google.com/docs/authentication/token-types#access
SECRET_KIND_ANTHROPIC_ADMIN_API_KEY: An Anthropic Admin API key. This is
called Workspace API key in Scalibr.
SECRET_KIND_ANTHROPIC_API_KEY: An Anthropic API key. This is called
Model key in Scalibr.
SECRET_KIND_AZURE_ACCESS_TOKEN: An Azure access token.
SECRET_KIND_AZURE_IDENTITY_TOKEN: An Azure Identity Platform ID token.
SECRET_KIND_DOCKER_HUB_PERSONAL_ACCESS_TOKEN: A Docker Hub personal
access token.
SECRET_KIND_GITHUB_APP_REFRESH_TOKEN: A GitHub App refresh token.
SECRET_KIND_GITHUB_APP_SERVER_TO_SERVER_TOKEN: A GitHub App server-to-
server token.
SECRET_KIND_GITHUB_APP_USER_TO_SERVER_TOKEN: A GitHub App user-to-server
token.
SECRET_KIND_GITHUB_CLASSIC_PERSONAL_ACCESS_TOKEN: A GitHub personal
access token (classic).
SECRET_KIND_GITHUB_FINE_GRAINED_PERSONAL_ACCESS_TOKEN: A GitHub fine-
grained personal access token.
SECRET_KIND_GITHUB_OAUTH_TOKEN: A GitHub OAuth token.
SECRET_KIND_HUGGINGFACE_API_KEY: A Hugging Face API key.
SECRET_KIND_OPENAI_API_KEY: An OpenAI API key.
SECRET_KIND_PERPLEXITY_API_KEY: A Perplexity API key.
SECRET_KIND_STRIPE_SECRET_KEY: A Stripe secret key.
SECRET_KIND_STRIPE_RESTRICTED_KEY: A Stripe restricted key.
SECRET_KIND_STRIPE_WEBHOOK_SECRET: A Stripe webhook secret.
r r r r r r5 r7 r8 r9 r: r r r r r r r r r r r
r r r N) r r r r r SECRET_KIND_UNSPECIFIEDSECRET_KIND_UNKNOWN#SECRET_KIND_GCP_SERVICE_ACCOUNT_KEYSECRET_KIND_GCP_API_KEY)SECRET_KIND_GCP_OAUTH2_CLIENT_CREDENTIALS#SECRET_KIND_GCP_OAUTH2_ACCESS_TOKEN#SECRET_KIND_ANTHROPIC_ADMIN_API_KEY SECRET_KIND_ANTHROPIC_API_KEY SECRET_KIND_AZURE_ACCESS_TOKEN SECRET_KIND_AZURE_IDENTITY_TOKEN,SECRET_KIND_DOCKER_HUB_PERSONAL_ACCESS_TOKEN$SECRET_KIND_GITHUB_APP_REFRESH_TOKEN-SECRET_KIND_GITHUB_APP_SERVER_TO_SERVER_TOKEN+SECRET_KIND_GITHUB_APP_USER_TO_SERVER_TOKEN0SECRET_KIND_GITHUB_CLASSIC_PERSONAL_ACCESS_TOKEN5SECRET_KIND_GITHUB_FINE_GRAINED_PERSONAL_ACCESS_TOKEN SECRET_KIND_GITHUB_OAUTH_TOKEN SECRET_KIND_HUGGINGFACE_API_KEYSECRET_KIND_OPENAI_API_KEY SECRET_KIND_PERPLEXITY_API_KEY SECRET_KIND_STRIPE_SECRET_KEY!SECRET_KIND_STRIPE_RESTRICTED_KEY!SECRET_KIND_STRIPE_WEBHOOK_SECRETr r r r r r e s 'P *+' 01-*+'*+'$%!%&"'($350+-(46124/794<>9%'"&(#!# %'"$&!(*%(*%r r r r r Tr SecretStatusr r N)r r r r r r r; r rD r r> locationsstatusesr r r r r r Y sV ?+INN ?+B
2A 6$$$%5q4H)
#
#NA
E(r r c \ rS rSrSr " S S\R 5 r\R " S5 r \R " SS5 r \R " S5 r Sr
g )
r i a) The status of the secret with a timestamp.
Enums:
StatusValueValuesEnum: Optional. The status of the secret.
Fields:
message: Optional. Optional message about the status code.
status: Optional. The status of the secret.
updateTime: Optional. The time the secret status was last updated.
c ( \ rS rSrSrSrSrSrSrSr g) "SecretStatus.StatusValueValuesEnumi zOptional. The status of the secret.
Values:
STATUS_UNSPECIFIED: Unspecified
UNKNOWN: The status of the secret is unknown.
VALID: The secret is valid.
INVALID: The secret is invalid.
r r r r r N)
r r r r r STATUS_UNSPECIFIEDUNKNOWNVALIDINVALIDr r r r r r s G
EGr r r r r r N)r r r r r r r; r r messagerD r r r r r r r r sL inn
! !! $' 6 :&$$Q'*r r c > \ rS rSrSr\R " SS5 rSrg)r i a) Request message for `SetIamPolicy` method.
Fields:
policy: REQUIRED: The complete policy to be applied to the `resource`. The
size of the policy is limited to a few 10s of KB. An empty policy is a
valid policy but certain Google Cloud services (such as Projects) might
reject them.
r r r N) r r r r r r r> policyr r r r r r s ! !(A .&r r c \ rS rSrSr " S S\R 5 r\R " S5 r \R " SS5 r Sr g) r i zThe number of occurrences created for a specific severity.
Enums:
SeverityValueValuesEnum: The severity of the occurrences.
Fields:
count: The number of occurrences with the severity.
severity: The severity of the occurrences.
c 0 \ rS rSrSrSrSrSrSrSr Sr
S r g
) %SeverityCount.SeverityValueValuesEnumi zThe severity of the occurrences.
Values:
SEVERITY_UNSPECIFIED: Unknown Impact
MINIMAL: Minimal Impact
LOW: Low Impact
MEDIUM: Medium Impact
HIGH: High Impact
CRITICAL: Critical Impact
r r r r r r5 r NrE r r r rL r rM r rL r r r N)
r r r r r r r; rL r[ countrD rO r r r r r r s< $
#%
!:A
>(r r c < \ rS rSrSr\R " S5 rSrg) SlsaBuilderi zSlsaBuilder encapsulates the identity of the builder of this provenance.
Fields:
id: id is the id of the slsa provenance builder
r r Nr r r r r r r r r c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r Sr
g)SlsaCompletenessi rS r r r r NrT r r r r r rX r r c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r \R " SS5 r \R " S5 r
S rg
) SlsaMetadatai r r r r r r r5 r Nr? r r r r r s] ))!,/ ++A. ((+.''(:A>,''*,r r c \ rS rSrSr\R " SS5 r\R " SSSS9r\R " S S
5 r \R " S S 5 r
S
r g)rk i+ a SlsaProvenance is the slsa provenance as defined by the slsa spec.
Fields:
builder: builder is the builder of this provenance
materials: The collection of artifacts that influenced the build including
sources, dependencies, build tools, base images, and so on. This is
considered to be incomplete unless metadata.completeness.materials is
true. Unset or null is equivalent to empty.
metadata: metadata is the metadata of the provenance
recipe: Identifies the configuration used for the build. When combined
with materials, this SHOULD fully describe the build, such that re-
running this recipe results in bit-for-bit identical output (if the
build is reproducible).
r r r r Tr r r
SlsaReciper r N) r r r r r r r> r rW r` ra r r r r rk rk + sS
" "=! 4'$$ZTB)
#
#NA
6( ! !, 2&r rk c d \ rS rSrSr\R " SS5 r\R " SS5 rSr g) rc iA a Keep in sync with schema at https://github.com/slsa-
framework/slsa/blob/main/docs/provenance/schema/v1/provenance.proto Builder
renamed to ProvenanceBuilder because of Java conflicts.
Fields:
buildDefinition: A BuildDefinition attribute.
runDetails: A RunDetails attribute.
rn r r r r N)
r r r r r r r> buildDefinition
runDetailsr r r r rc rc A s. **+ r7 r N)r r r r r r r r r{ r r> buildConfigr r r
invocationrW r` r r r r rl rl O s " !!"89Z** Z :Z0 &&'91=+##A&) " "#lno p'%%&rtuv*$$%oqr ~B C)
#
#$npq
r(r rl c x \ rS rSrSr\R " S5 " S S\R 5 5 r \R " S5 " S S\R 5 5 r
\R " SS5 r \R " S 5 r\R " S
5 r\R " SS 5 r\R " S 5 rS
rg)r i a Steps taken to build the artifact. For a TaskRun, typically each
container corresponds to one step in the recipe.
Messages:
ArgumentsValue: Collection of all external inputs that influenced the
build on top of recipe.definedInMaterial and recipe.entryPoint. For
example, if the recipe type were "make", then this might be the flags
passed to make aside from the target, which is captured in
recipe.entryPoint. Depending on the recipe Type, the structure may be
different.
EnvironmentValue: Any other builder-controlled inputs necessary for
correctly evaluating the recipe. Usually only needed for reproducing the
build but not evaluated as part of policy. Depending on the recipe Type,
the structure may be different.
Fields:
arguments: Collection of all external inputs that influenced the build on
top of recipe.definedInMaterial and recipe.entryPoint. For example, if
the recipe type were "make", then this might be the flags passed to make
aside from the target, which is captured in recipe.entryPoint. Depending
on the recipe Type, the structure may be different.
definedInMaterial: Index in materials containing the recipe steps that are
not implied by recipe.type. For example, if the recipe type were "make",
then this would point to the source containing the Makefile, not the
make program itself. Set to -1 if the recipe doesn't come from a
material, as zero is default unset value for int64.
entryPoint: String identifying the entry point into the build. This is
often a path to a configuration file and/or a target label within that
file. The syntax and meaning are defined by recipe.type. For example, if
the recipe type were "make", then this would reference the directory in
which to run make as well as which target to use.
environment: Any other builder-controlled inputs necessary for correctly
evaluating the recipe. Usually only needed for reproducing the build but
not evaluated as part of policy. Depending on the recipe Type, the
structure may be different.
type: URI indicating what type of recipe was performed. It determines the
meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and
materials.
ro c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
SlsaRecipe.ArgumentsValuei a Collection of all external inputs that influenced the build on top of
recipe.definedInMaterial and recipe.entryPoint. For example, if the recipe
type were "make", then this might be the flags passed to make aside from
the target, which is captured in recipe.entryPoint. Depending on the
recipe Type, the structure may be different.
Messages:
AdditionalProperty: An additional property for a ArgumentsValue object.
Fields:
additionalProperties: Properties of the object. Contains field @type
with type URL.
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g),SlsaRecipe.ArgumentsValue.AdditionalPropertyi zAn additional property for a ArgumentsValue object.
Fields:
key: Name of the additional property.
value: A extra_types.JsonValue attribute.
r rt r r Nru r r r rx r ry r rx r Tr r Nrz r r r ArgumentsValuer 4 AY . . A %112FTXYr r c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
SlsaRecipe.EnvironmentValuei a Any other builder-controlled inputs necessary for correctly evaluating
the recipe. Usually only needed for reproducing the build but not
evaluated as part of policy. Depending on the recipe Type, the structure
may be different.
Messages:
AdditionalProperty: An additional property for a EnvironmentValue
object.
Fields:
additionalProperties: Properties of the object. Contains field @type
with type URL.
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g).SlsaRecipe.EnvironmentValue.AdditionalPropertyi r- r rt r r Nru r r r rx r ry r rx r Tr r Nrz r r r r. r r r r. r r r r r5 r N)r r r r r r r r r{ r r. r> rU r[ r9 r r& rV r r r r r r r s &P !!"89Zy(( Z :Z8 !!"89Z** Z :Z8 $$%5q9) ,,Q/$$Q'*&&'91=+ q !$r r c N \ rS rSrSr\R " S5 " S S\R 5 5 r \R " SSSS 9r \R " S
S 5 r \R " SS 5 r
\R " SS
5 r\R " SS5 r\R " S
S5 rSrg)r i a Source describes the location of the source used for the build.
Messages:
FileHashesValue: 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.
Fields:
additionalContexts: 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.
artifactStorageSource: If provided, the input binary artifacts for the
build came from this location.
context: If provided, the source code used for the build came from this
location.
fileHashes: 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.
repoSource: If provided, get source from this location in a Cloud Repo.
storageSource: If provided, get the source from this location in Google
Cloud Storage.
ro c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
Source.FileHashesValuei a 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.
Messages:
AdditionalProperty: An additional property for a FileHashesValue object.
Fields:
additionalProperties: Additional properties of type FileHashesValue
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g))Source.FileHashesValue.AdditionalPropertyi zAn additional property for a FileHashesValue object.
Fields:
key: Name of the additional property.
value: A FileHashes attribute.
r r r r Nru r r r rx r s+
! !! $c$$\15er rx r Tr r Nrz r r r r r s2 6Y . . 6 %112FTXYr r rF r Tr
StorageSourcer r r r r5 r7 r N)r r r r r r r r r{ r r> additionalContextsartifactStorageSourcecontextr r r r r r r r r s < !!"89Z )) Z :Z8 !--.dfgrvw#00 !D " "#Y[\ ]'%%&7;*%%lA6*(( !<-r r c \ rS rSrSr " S S\R 5 r " S S\R 5 r\R " SS5 r
\R " S5 r \R " SS S
S 9r
\R " S 5 r\R " S
5 r\R " S5 r\R " S5 r\R$ " SSS 9r\R " S5 r\R " S5 r\R " S5 r\R " S5 rSrg)StandardQueryParametersi0 a Query parameters accepted by all methods.
Enums:
FXgafvValueValuesEnum: V1 error format.
AltValueValuesEnum: Data format for response.
Fields:
f__xgafv: V1 error format.
access_token: OAuth access token.
alt: Data format for response.
callback: JSONP
fields: Selector specifying which fields to include in a partial response.
key: API key. Your API key identifies your project and provides you with
API access, quota, and reports. Required unless you provide an OAuth 2.0
token.
oauth_token: OAuth 2.0 token for the current user.
prettyPrint: Returns response with indentations and line breaks.
quotaUser: Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should
not exceed 40 characters.
trace: A tracing token of the form "token:" to include in api
requests.
uploadType: Legacy upload protocol for media (e.g. "media", "multipart").
upload_protocol: Upload protocol for media (e.g. "raw", "multipart").
c $ \ rS rSrSrSrSrSrSrg)*StandardQueryParameters.AltValueValuesEnumiK zData format for response.
Values:
json: Responses with Content-Type of application/json
media: Media download with context-dependent Content-Type
proto: Responses with Content-Type of application/x-protobuf
r r r r N) r r r r r jsonmediaprotor r r r AltValueValuesEnumr K s
D
E
Er r c \ rS rSrSrSrSrSrg)-StandardQueryParameters.FXgafvValueValuesEnumiW zFV1 error format.
Values:
_1: v1 error format
_2: v2 error format
r r r N)r r r r r _1_2r r r r FXgafvValueValuesEnumr W s
B
Br r r r r r )defaultr r5 r7 r8 r9 Tr: r r r r N)r r r r r r r; r r rD f__xgafvr access_tokenaltcallbackfieldsrv oauth_tokenr prettyPrint quotaUsertrace
uploadTypeupload_protocolr r r r r
r
0 s 4
9>>
inn
!8!
<(&&q), 0!VD#
"
"1
%( #& a #%%a(+&&q$7+##A&)
#%$$R(* ))"-/r r
c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " S\R R S9r
\R " SSS S
9r\R " S 5 rS rg
)r io a 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).
Messages:
DetailsValueListEntry: A DetailsValueListEntry object.
Fields:
code: The status code, which should be an enum value of google.rpc.Code.
details: A list of messages that carry the error details. There is a
common set of message types for APIs to use.
message: 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.
ro c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
Status.DetailsValueListEntryi zA DetailsValueListEntry object.
Messages:
AdditionalProperty: An additional property for a DetailsValueListEntry
object.
Fields:
additionalProperties: Properties of the object. Contains field @type
with type URL.
c b \ rS rSrSr\R " S5 r\R " SS5 r Sr
g)/Status.DetailsValueListEntry.AdditionalPropertyi zAn additional property for a DetailsValueListEntry object.
Fields:
key: Name of the additional property.
value: A extra_types.JsonValue attribute.
r rt r r Nru r r r rx r) ry r rx r Tr r Nrz r r r DetailsValueListEntryr' r/ r r* r rY r Tr r r N)r r r r r r r r r{ r* r[ r\ r] coder> r r r r r r r r r o s| & !!"89Zi / / Z :Z2
9+<+<+B+B C$ " "#:A M' ! !! $'r r c \ rS rSrSr\R " S5 r\R " S5 r\R " S5 r Sr
g)r i zStepResult is the declaration of a result for a build step.
Fields:
attestationContentName: A string attribute.
attestationType: A string attribute.
name: A string attribute.
r r r r N) r r r r r r r attestationContentNameattestationTyper" r r r r r r s: %003 ))!,/ q !$r r c \ rS rSrSr\R " S5 r\R " S5 r \R " S5 r
Sr g)r i a StorageSource describes the location of the source in an archive file in
Google Cloud Storage.
Fields:
bucket: Google Cloud Storage bucket containing source (see [Bucket Name
Requirements] (https://cloud.google.com/storage/docs/bucket-
naming#requirements)).
generation: Google Cloud Storage generation for the object.
object: Google Cloud Storage object containing source.
r r r r Nr r r r r r s9 #&%%a(* #&r r c \ rS rSrSr\R " S5 " S S\R 5 5 r \R " SS5 r \R " S5 r
Srg )
rd i a Subject refers to the subject of the intoto statement
Messages:
DigestValue: "": "" Algorithms can be e.g. sha256, sha512 See
https://github.com/in-toto/attestation/blob/main/spec/v1/digest_set.md.
Fields:
digest: "": "" Algorithms can be e.g. sha256, sha512 See
https://github.com/in-toto/attestation/blob/main/spec/v1/digest_set.md.
name: name is the name of the Subject used here
ro c f \ rS rSrSr " S S\R 5 r\R " SSSS9r Sr
g )
Subject.DigestValuei a "": "" Algorithms can be e.g. sha256, sha512 See
https://github.com/in-toto/attestation/blob/main/spec/v1/digest_set.md.
Messages:
AdditionalProperty: An additional property for a DigestValue object.
Fields:
additionalProperties: Additional properties of type DigestValue
c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)&Subject.DigestValue.AdditionalPropertyi r r r r Nr r r r rx r4 r r rx r Tr r Nrz r r r r r2 r r r r r r Nr r r r rd rd s[
!!"89ZI%% Z :Z0 ! !- 3& q !$r rd c : \ rS rSrSr\R " SSS9rSrg)r i a3 Request message for `TestIamPermissions` method.
Fields:
permissions: 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).
r Tr r N r r r r r r r permissionsr r r r r r s %%a$7+r r c : \ rS rSrSr\R " SSS9rSrg)TestIamPermissionsResponsei zResponse message for `TestIamPermissions` method.
Fields:
permissions: A subset of `TestPermissionsRequest.permissions` that the
caller is allowed.
r Tr r Nr6 r r r r9 r9 s %%a$7+r r9 c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)r i zStart and end times for a build execution phase. Next ID: 3
Fields:
endTime: End of time span.
startTime: Start of time span.
r r r Nr r r r r r r r r c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)r4 i z^An URI message.
Fields:
label: A label for the URI.
uri: The unique resource identifier.
r r r N)
r r r r r r r r; r r r r r r4 r4 r< r r4 c b \ rS rSrSr\R " SS5 r\R " S5 r Sr
g)r i z~Request for updating an existing operation
Fields:
operation: The operation to create.
updateMask: The fields to update.
r= r r r N) r r r r r r r> r> r r r r r r r r s+ $$[!4)$$Q'*r r c \ rS rSrSr\R " S5 r\R " S5 r\R " SSS9r \R " S5 r
S r g
) UpgradeDistributioni' a_ The Upgrade Distribution represents metadata about the Upgrade for each
operating system (CPE). Some distributions have additional metadata around
updates, classifying them into various categories and severities.
Fields:
classification: The operating system classification of this Upgrade, as
specified by the upstream operating system upgrade feed.
cpeUri: Required - The specific operating system this metadata applies to.
See https://cpe.mitre.org/specification/.
cve: The cve that would be resolved by this upgrade.
severity: The severity as specified by the upstream operating system.
r r r Tr r r N) r r r r r r r classificationrl r< rO r r r r r> r> ' sK ((+. #& a$/#
"
"1
%(r r> c \ rS rSrSr\R " SSSS9r\R " S5 r \R " SS 5 r
S
r g ) r i; a An Upgrade Note represents a potential upgrade of a package to a given
version. For each package version combination (i.e. bash 4.0, bash 4.1, bash
4.1.2), there will be a Upgrade Note.
Fields:
distributions: Metadata about the upgrade for each specific operating
system.
package: Required - The package this Upgrade is for.
version: Required - The version of the package in machine + human readable
form.
r> r Tr r rd r r N) r r r r r r r>
distributionsr ri rd r r r r r r ; s@
(()>DQ- ! !! $' " "9a 0'r r c \ rS rSrSr\R " SS5 r\R " S5 r \R " SS5 r
Sr g )
r iM aP An Upgrade Occurrence represents that a specific resource_url could
install a specific upgrade. This presence is supplied via local sources
(i.e. it is present in the mirror and the running system has noticed its
availability).
Fields:
distribution: Metadata about the upgrade for available for the specific
operating system for the resource_url. This allows efficient filtering,
as well as making it easier to use the occurrence.
package: Required - The package this Upgrade is for.
parsedVersion: Required - The version of the package in a machine + human
readable form.
r> r r rd r r N) r r r r r r r> r r ri
parsedVersionr r r r r r M s> ''(=qA, ! !! $'((A6-r r c \ rS rSrSr " S S\R 5 r\R " S\R R S9r \R " S5 r
\R " SS5 r\R " S 5 r\R " S
5 rS rg )
rd ia a Version contains structured information about the version of the
package. For a discussion of this in Debian/Ubuntu:
http://serverfault.com/questions/604541/debian-packages-version-convention
For a discussion of this in Redhat/Fedora/Centos:
http://blog.jasonantman.com/2014/07/how-yum-and-rpm-compare-versions/
Enums:
KindValueValuesEnum: Distinguish between sentinel MIN/MAX versions and
normal versions. If kind is not NORMAL, then the other fields are
ignored.
Fields:
epoch: Used to correct mistakes in the version numbering scheme.
inclusive: Whether this version is vulnerable, when defining the version
bounds. For example, if the minimum version is 2.0, inclusive=true would
say 2.0 is vulnerable, while inclusive=false would say it's not
kind: Distinguish between sentinel MIN/MAX versions and normal versions.
If kind is not NORMAL, then the other fields are ignored.
name: The main part of the version name.
revision: The iteration of the package build from the above version.
c $ \ rS rSrSrSrSrSrSrg)Version.KindValueValuesEnumix a Distinguish between sentinel MIN/MAX versions and normal versions. If
kind is not NORMAL, then the other fields are ignored.
Values:
NORMAL: A standard package version, defined by the other fields.
MINIMUM: A special version representing negative infinity, other fields
are ignored.
MAXIMUM: A special version representing positive infinity, other fields
are ignored.
r r r r N) r r r r r NORMALMINIMUMMAXIMUMr r r r r rF x s FGGr r r rY r r r r5 r N)r r r r r r r; r r[ r\ r] epochr inclusiverD r r r" r> r r r r rd rd a sz ,
INN
I,=,=,C,C
D%$$Q') 2A 6$ q !$
"
"1
%(r rd c d \ rS rSrSr " S S\R 5 r\R " S5 r \R " SSS9r
\R " S S
5 r \R " S 5 r
\R " S S
SS9r\R " SSSS9r\R " SS5 r\R " S5 rSrg)
VexAssessmenti a VexAssessment provides all publisher provided Vex information that is
related to this vulnerability.
Enums:
StateValueValuesEnum: Provides the state of this Vulnerability assessment.
Fields:
cve: Holds the MITRE standard Common Vulnerabilities and Exposures (CVE)
tracking number for the vulnerability.
impacts: Contains information about the impact of this vulnerability, this
will change with time.
justification: Justification provides the justification when the state of
the assessment if NOT_AFFECTED.
noteName: The VulnerabilityAssessment note from which this VexAssessment
was generated. This will be of the form:
`projects/[PROJECT_ID]/notes/[NOTE_ID]`.
relatedUris: Holds a list of references associated with this vulnerability
item and assessment. These uris have additional information about the
vulnerability and the assessment itself. E.g. Link to a document which
details how this assessment concluded the state of this vulnerability.
remediations: Specifies details on how to handle (and presumably, fix) a
vulnerability.
state: Provides the state of this Vulnerability assessment.
vulnerabilityId: The vulnerability identifier for this Assessment. Will
hold one of common identifiers e.g. CVE, GHSA etc.
c , \ rS rSrSrSrSrSrSrSr Sr
g )
"VexAssessment.StateValueValuesEnumi r* r r r r r r Nr+ r r r r1 rO r2 r r1 r r Tr r3 r r r4 r5 r6 r7 r8 r9 r N)r r r r r r r; r1 r r< r= r> r? r rA rB rD rE rF r r r r rM rM s 6 Y^^ & a # ! !!d 3'(( !<-
"
"1
%(&&ua$?+''
q4H,
4a
8% ))!,/r rM c ` \ rS rSrSr\R " S5 r\R " S5 rSr g)r i a Volume describes a Docker container volume which is mounted into build
steps in order to persist files across build step execution. Next ID: 3
Fields:
name: 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.
path: 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.
r r r Nr r r r r r r r r c \ rS rSrSr\R " SS5 r\R " S5 r \R " S5 r
\R " SS5 r \R " S S
5 r \R " S 5 r
\R " S 5 rS
rg)r i a A single VulnerabilityAssessmentNote represents one particular product's
vulnerability assessment for one CVE. Multiple VulnerabilityAssessmentNotes
together form a Vex statement. Please go/sds-vex-example for a sample Vex
statement in the CSAF format.
Fields:
assessment: Represents a vulnerability assessment for the product.
languageCode: Identifies the language used by this document, corresponding
to IETF BCP 47 / RFC 5646.
longDescription: A detailed description of this Vex.
product: The product affected by this vex.
publisher: Publisher details of this Note.
shortDescription: A one sentence description of this Vex.
title: The title of the note. E.g. `Vex-Debian-11.4`
r% r r r r r r+ r5 r7 r8 r N)r r r r r r r>
assessmentr languageCoder@ product publisherrC rc r r r r r r s %%lA6*&&q), ))!,/ " "9a 0'$$[!4) **1-
"%r r c \ rS rSrSr " S S\R 5 r\R " S5 r \R " S5 r
\R " SS5 r Sr
g )
r i a The status of a vulnerability attestation generation.
Enums:
StateValueValuesEnum: Output only. The success/failure state of the latest
attestation attempt.
Fields:
error: Output only. If failure, the error reason for why the attestation
generation failed.
lastAttemptTime: Output only. The last time we attempted to generate an
attestation.
state: Output only. The success/failure state of the latest attestation
attempt.
c $ \ rS rSrSrSrSrSrSrg)-VulnerabilityAttestation.StateValueValuesEnumi a Output only. The success/failure state of the latest attestation
attempt.
Values:
VULNERABILITY_ATTESTATION_STATE_UNSPECIFIED: Default unknown state.
SUCCESS: Attestation was successfully generated and stored.
FAILURE: Attestation was unsuccessfully generated and stored.
r r r r N) r r r r r +VULNERABILITY_ATTESTATION_STATE_UNSPECIFIEDr r r r r r r1 rX s 34/GGr r1 r r r r N)r r r r r r r; r1 r r lastAttemptTimerD rE r r r r r r sL
Y^^
"% ))!,/
4a
8%r r c V \ rS rSrSr " S S\R 5 r " S S\R 5 r " S S\R 5 r \R " S \R R S
9r
\R " S S 5 r\R " S S
5 r\R" " SS5 r\R" " SS5 r\R( " S5 r\R " SSSS9r\R " SS5 r\R" " SS5 r\R( " S5 r\R " SS5 rSrg ) r i aH Used by Occurrence to point to where the vulnerability exists and how to
fix it.
Enums:
CvssVersionValueValuesEnum: Output only. CVSS version used to populate
cvss_score and severity.
EffectiveSeverityValueValuesEnum: The distro assigned severity for this
vulnerability when that is available and note provider assigned severity
when distro has not yet assigned a severity for this vulnerability. When
there are multiple package issues for this vulnerability, they can have
different effective severities because some might come from the distro
and some might come from installed language packs (e.g. Maven JARs or Go
binaries). For this reason, it is advised to use the effective severity
on the PackageIssue level, as this field may eventually be deprecated.
In the case where multiple PackageIssues have different effective
severities, the one set here will be the highest severity of any of the
PackageIssues.
SeverityValueValuesEnum: Output only. The note provider assigned Severity
of the vulnerability.
Fields:
cvssScore: 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.
cvssV2: The CVSS v2 score of this vulnerability.
cvssV3: The CVSS v3 score of this vulnerability.
cvssVersion: Output only. CVSS version used to populate cvss_score and
severity.
effectiveSeverity: The distro assigned severity for this vulnerability
when that is available and note provider assigned severity when distro
has not yet assigned a severity for this vulnerability. When there are
multiple package issues for this vulnerability, they can have different
effective severities because some might come from the distro and some
might come from installed language packs (e.g. Maven JARs or Go
binaries). For this reason, it is advised to use the effective severity
on the PackageIssue level, as this field may eventually be deprecated.
In the case where multiple PackageIssues have different effective
severities, the one set here will be the highest severity of any of the
PackageIssues.
extraDetails: Occurrence-specific extra details about the vulnerability.
packageIssue: The set of affected locations and their fixes (if available)
within the associated resource.
risk: Risk information about the vulnerability, such as CISA, EPSS, etc.
severity: Output only. The note provider assigned Severity of the
vulnerability.
type: The type of package; whether native or non native(ruby gems, node.js
packages etc). This may be deprecated in the future because we can have
multiple PackageIssues with different package types.
vexAssessment: VexAssessment provides all publisher provided Vex
information that is related to this vulnerability for this resource.
c $ \ rS rSrSrSrSrSrSrg)/VulnerabilityDetails.CvssVersionValueValuesEnumiI zOutput only. CVSS version used to populate cvss_score and severity.
Values:
CVSS_VERSION_UNSPECIFIED: CVSS Version unspecified.
CVSS_VERSION_2: CVSS v2.
CVSS_VERSION_3: CVSS v3.
r r r r N r r r r r CVSS_VERSION_UNSPECIFIEDCVSS_VERSION_2CVSS_VERSION_3r r r r CvssVersionValueValuesEnumr] I ! NNr rb c 0 \ rS rSrSrSrSrSrSrSr Sr
S r g
) 5VulnerabilityDetails.EffectiveSeverityValueValuesEnumiU a\ The distro assigned severity for this vulnerability when that is
available and note provider assigned severity when distro has not yet
assigned a severity for this vulnerability. When there are multiple
package issues for this vulnerability, they can have different effective
severities because some might come from the distro and some might come
from installed language packs (e.g. Maven JARs or Go binaries). For this
reason, it is advised to use the effective severity on the PackageIssue
level, as this field may eventually be deprecated. In the case where
multiple PackageIssues have different effective severities, the one set
here will be the highest severity of any of the PackageIssues.
Values:
SEVERITY_UNSPECIFIED: Unknown Impact
MINIMAL: Minimal Impact
LOW: Low Impact
MEDIUM: Medium Impact
HIGH: High Impact
CRITICAL: Critical Impact
r r r r r r5 r NrE r r r r re U s( & G
C
F DHr r c 0 \ rS rSrSrSrSrSrSrSr Sr
S r g
) ,VulnerabilityDetails.SeverityValueValuesEnumip zOutput only. The note provider assigned Severity of the vulnerability.
Values:
SEVERITY_UNSPECIFIED: Unknown Impact
MINIMAL: Minimal Impact
LOW: Low Impact
MEDIUM: Medium Impact
HIGH: High Impact
CRITICAL: Critical Impact
r r r r r r5 r NrE r r r rL rg p rM r rL r rY r r r r r5 r7 r
r8 Tr r r9 r: r rM r r N) r r r r r r r; rb r rL r7 r\ r8 cvssScorer> cvssV2cvssV3rD cvssVersionr r extraDetails packageIssueriskrO r
vexAssessmentr r r r r r s 2h
9>>
6 $ ""1i.?.?.E.EF) ! !&! ,& ! !&! ,&##$@!D+ ))*LaP&&q),''DI, *$
!:A
>( r "$(( "=-r r c \ rS rSrSr\R " S5 r\R " SSSS9r \R " S5 r
\R " S S
5 r S r g )
rc i a The location of the vulnerability
Fields:
cpeUri: The cpe_uri in [cpe format] (https://cpe.mitre.org/specification/)
format. Examples include distro or storage location for vulnerable jar.
This field can be used as a filter in list requests.
fileLocation: The file location at which this package was found.
package: The package being described.
version: The version of the package being described. This field can be
used as a filter in list requests.
r r r Tr r rd r r N)
r r r r r r r rl r> r ri rd r r r r rc rc sO
#&''DI, ! !! $' " "9a 0'r rc c n \ rS rSrSr " S S\R 5 r " S S\R 5 r\R " S\R R S9r \R " S S
5 r\R " SS 5 r\R" " S S
S9r\R " SSS
S9r\R " SS5 rSrg)r i a VulnerabilityType provides metadata about a security vulnerability.
Enums:
CvssVersionValueValuesEnum: CVSS version used to populate cvss_score and
severity.
SeverityValueValuesEnum: Note provider assigned impact of the
vulnerability
Fields:
cvssScore: The CVSS score for this Vulnerability.
cvssV2: The full description of the CVSS for version 2.
cvssVersion: CVSS version used to populate cvss_score and severity.
cwe: A list of CWE for this vulnerability. For details, see:
https://cwe.mitre.org/index.html
details: All information about the package to specifically identify this
vulnerability. One entry per (version range and cpe_uri) the package
vulnerability has manifested in.
severity: Note provider assigned impact of the vulnerability
c $ \ rS rSrSrSrSrSrSrg),VulnerabilityType.CvssVersionValueValuesEnumi zCVSS version used to populate cvss_score and severity.
Values:
CVSS_VERSION_UNSPECIFIED: CVSS Version unspecified.
CVSS_VERSION_2: CVSS v2.
CVSS_VERSION_3: CVSS v3.
r r r r Nr^ r r r rb rs rc r rb c 0 \ rS rSrSrSrSrSrSrSr Sr
S r g
) )VulnerabilityType.SeverityValueValuesEnumi zNote provider assigned impact of the vulnerability
Values:
SEVERITY_UNSPECIFIED: Unknown Impact
MINIMAL: Minimal Impact
LOW: Low Impact
MEDIUM: Medium Impact
HIGH: High Impact
CRITICAL: Critical Impact
r r r r r r5 r NrE r r r rL ru rM r rL r rY r r r r Tr rb r5 r7 r N)r r r r r r r; rb rL r7 r\ r8 rh r> ri rD rk r cwer rO r r r r r r s (
9>>
$ ""1i.?.?.E.EF) ! !&! ,&##$@!D+ a$/# " "8Q >'
!:A
>(r r r z$.xgafvr 1r 2N)r
__future__r apitools.base.protorpcliter r apitools.base.pyr r ri r{ r r r% rH rM rO rW ra rg rn r r r r r r r r r rB r rR rZ rf r[ rn rq r~ r r r r r r r r r r r r r8 r= r r@ rD rK rN r rS rX rO r_ rk r r r r r r r r r rv rw rx ry r r r r r r r r r r r r r r r r r r r r r r r# r% r' r+ r- r/ r1 r3 r5 r7 r9 r; r rA rD rB rJ rM r[ rb rn rr r r r r r rE r r ri r r r r r r rc r r r r r r r r r r
r r r! r( r7 r> rF r rT r r r rp r3 r\ r r r r r r rs r r] rg r r r= r r r r
rJ r r r# r+ r^ r r r r6 r r r r r r r r r r r( r r r r r r r r r rk rc rl r r r
r r r rd r r9 r r4 r r> r r rd rM r r r r rc r AddCustomJsonFieldMappingAddCustomJsonEnumMappingr r r r r~ s ' < % ( 9 )) 92y 286-"" 6-rK)## K"?9,, ?"/y 0 0 /" ( !! ( )I ) T"i T"nCXi'' CXL -9$$ -B 'I%% ' D(i'' D(N,'Y&& ,'^E5 !! E5P : !! : I%%
8 (9(9
8zN9 zNz ?9$$ ?B4i 40(9$$ (&JY&& J6
;9,,
; % )) %$ / @Q@Q /$! @Q@Q $!N*A9;L;L *AZ\)J[J[ \( (9CTCT (>% HYHY %8(YEVEV ($( HYHY (&Pry7H7H Prf 9y?P?P 9D 7)BSBS 7FI)i>O>O I)X
" HYHY
" 59;L;L 5D"i>O>O ":`IO>O 2(j<%IO>O
U
3 8I8I
3 1 8I8I 1
5i>O>O
5 1):K:K 11Y5F5F 1
3IZIZ
3D3i6G6G D3N (y7H7H (
Ii>O>O
I
UIDUDU
U
3y7H7H
3 Oi6G6G O 1Y5F5F 1
3i6G6G
3 (y7H7H ( $93D3D $$193D3D 1
59J9J
5 1 0A0A 1$1B1B $('IG !! >GB'!9$$ '!T
)9$$
) %#** %#PI
My
M )) "Y%6%6 " !#9 !#H-")## -"`$"9 $"N>"" > ;9$$ ; 7#y 7#t $Y&& $F$)## $$:)++ :Vy(( V*E):): E"):K:K "< (IDUDU ( (ARAR ($
!i>O>O
! %y?P?P %
&9;L;L
& !I4E4E ! iN_N_ )S\SdSd )"*!S\SdSd *!ZG&i'' >&B#&I - - #&L.*9$$ .*b:'9,, :'zIGY
IGX"i ""&6 )) &6R0 !! 0$W"Y
W"t !"" !J7y(( J7ZX7Y . . X7v#4)## #4L%"" %&
!y
! H!** H!V E9 E 8"" 8
% ))
%Mi / / M&A"" A:@!2!2 @(((9#4#4 ((V("" ((;Y&& ;)"" )OFy(( OFd (9$$ (>
/)++
/ ?I%% ?B )## (y(( (&+9$$ +,3Y&& 3, 7y(( 7 0sI - - 0sfg""" g"TA=Y
A=H<.i / / <.~0%Y
0%f """ " $I%% $"'"i '"T
8 1 1
88!2!2 8 'y ' !)
! (Y . . (&)++ &(1)## 1$7 )) 7(*&i *&Z6-I%% 6-r"Y
""#)"3"3 #4 9y 0 0 9Dx>9,, x>v1I - - 1&8? )) 8?v " "Z4 ! !114> ! !114>r