{ "description": "This API is a prerequisite for leveraging Artifact Analysis scanning capabilities in both Artifact Registry and with Advanced Vulnerability Insights (runtime scanning) in GKE. 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.", "id": "containeranalysis:v1alpha1", "schemas": { "SBOMReferenceOccurrence": { "description": "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.", "type": "object", "id": "SBOMReferenceOccurrence", "properties": { "payload": { "$ref": "SbomReferenceIntotoPayload", "description": "The actual payload that contains the SBOM reference data." }, "signatures": { "description": "The signatures over the payload.", "type": "array", "items": { "$ref": "EnvelopeSignature" } }, "payloadType": { "type": "string", "description": "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'." } } }, "GoogleDevtoolsContaineranalysisV1alpha1SlsaProvenanceZeroTwoSlsaConfigSource": { "type": "object", "description": "Describes where the config file that kicked off the build came from. This is effectively a pointer to the source where buildConfig came from.", "properties": { "digest": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Collection of cryptographic digests for the contents of the artifact specified by invocation.configSource.uri." }, "uri": { "description": "URI indicating the identity of the source of the config.", "type": "string" }, "entryPoint": { "type": "string", "description": "String identifying the entry point into the build." } }, "id": "GoogleDevtoolsContaineranalysisV1alpha1SlsaProvenanceZeroTwoSlsaConfigSource" }, "SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "id": "SetIamPolicyRequest", "properties": { "policy": { "$ref": "Policy", "description": "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." } }, "type": "object" }, "Justification": { "properties": { "details": { "description": "Additional details on why this justification was chosen.", "type": "string" }, "justificationType": { "enumDescriptions": [ "JUSTIFICATION_TYPE_UNSPECIFIED.", "The vulnerable component is not present in the product.", "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.", "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.", "The vulnerable code cannot be controlled by an attacker to exploit the vulnerability.", "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." ], "type": "string", "enum": [ "JUSTIFICATION_TYPE_UNSPECIFIED", "COMPONENT_NOT_PRESENT", "VULNERABLE_CODE_NOT_PRESENT", "VULNERABLE_CODE_NOT_IN_EXECUTE_PATH", "VULNERABLE_CODE_CANNOT_BE_CONTROLLED_BY_ADVERSARY", "INLINE_MITIGATIONS_ALREADY_EXIST" ], "description": "The justification type for this vulnerability." } }, "description": "Justification provides the justification when the state of the assessment if NOT_AFFECTED.", "id": "Justification", "type": "object" }, "Note": { "id": "Note", "type": "object", "description": "Provides a detailed description of a `Note`.", "properties": { "kind": { "enum": [ "KIND_UNSPECIFIED", "PACKAGE_VULNERABILITY", "BUILD_DETAILS", "IMAGE_BASIS", "PACKAGE_MANAGER", "DEPLOYABLE", "DISCOVERY", "ATTESTATION_AUTHORITY", "UPGRADE", "COMPLIANCE", "SBOM", "SPDX_PACKAGE", "SPDX_FILE", "SPDX_RELATIONSHIP", "DSSE_ATTESTATION", "VULNERABILITY_ASSESSMENT", "SBOM_REFERENCE" ], "description": "Output only. This explicitly denotes which kind of note is specified. This field can be used as a filter in list requests.", "enumDescriptions": [ "Unknown", "The note and occurrence represent a package vulnerability.", "The note and occurrence assert build provenance.", "This represents an image basis relationship.", "This represents a package installed via a package manager.", "The note and occurrence track deployment events.", "The note and occurrence track the initial discovery status of a resource.", "This represents a logical \"role\" that can attest to artifacts.", "This represents an available software upgrade.", "This represents a compliance check that can be applied to a resource.", "This represents a software bill of materials.", "This represents an SPDX Package.", "This represents an SPDX File.", "This represents an SPDX Relationship.", "This represents a DSSE attestation Note", "This represents a Vulnerability Assessment.", "This represents a reference to an SBOM." ], "type": "string" }, "buildType": { "$ref": "BuildType", "description": "Build provenance type for a verifiable build." }, "baseImage": { "$ref": "Basis", "description": "A note describing a base image." }, "discovery": { "$ref": "Discovery", "description": "A note describing a provider/analysis type." }, "spdxPackage": { "$ref": "PackageInfoNote", "description": "A note describing an SPDX Package." }, "upgrade": { "$ref": "UpgradeNote", "description": "A note describing an upgrade." }, "deployable": { "$ref": "Deployable", "description": "A note describing something that can be deployed." }, "longDescription": { "description": "A detailed description of this `Note`.", "type": "string" }, "spdxFile": { "$ref": "FileNote", "description": "A note describing an SPDX File." }, "relatedUrl": { "description": "URLs associated with this note", "type": "array", "items": { "$ref": "RelatedUrl" } }, "attestationAuthority": { "description": "A note describing an attestation role.", "$ref": "AttestationAuthority" }, "vulnerabilityType": { "description": "A package vulnerability type of note.", "$ref": "VulnerabilityType" }, "dsseAttestation": { "description": "A note describing a dsse attestation note.", "$ref": "DSSEAttestationNote" }, "createTime": { "description": "Output only. The time this note was created. This field can be used as a filter in list requests.", "format": "google-datetime", "type": "string" }, "expirationTime": { "description": "Time of expiration for this note, null if note does not expire.", "type": "string", "format": "google-datetime" }, "spdxRelationship": { "$ref": "RelationshipNote", "description": "A note describing a relationship between SPDX elements." }, "shortDescription": { "description": "A one sentence description of this `Note`.", "type": "string" }, "package": { "$ref": "Package", "description": "A note describing a package hosted by various package managers." }, "vulnerabilityAssessment": { "$ref": "VulnerabilityAssessmentNote", "description": "A note describing a vulnerability assessment." }, "compliance": { "description": "A note describing a compliance check.", "$ref": "ComplianceNote" }, "updateTime": { "description": "Output only. The time this note was last updated. This field can be used as a filter in list requests.", "format": "google-datetime", "type": "string" }, "name": { "type": "string", "description": "The name of the note in the form \"projects/{provider_project_id}/notes/{NOTE_ID}\"" }, "sbom": { "description": "A note describing a software bill of materials.", "$ref": "DocumentNote" }, "sbomReference": { "$ref": "SBOMReferenceNote", "description": "A note describing a reference to an SBOM." } } }, "GoogleDevtoolsContaineranalysisV1alpha1SourceContext": { "description": "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.", "type": "object", "properties": { "git": { "$ref": "GoogleDevtoolsContaineranalysisV1alpha1GitSourceContext", "description": "A SourceContext referring to any third party Git repo (e.g., GitHub)." }, "gerrit": { "$ref": "GoogleDevtoolsContaineranalysisV1alpha1GerritSourceContext", "description": "A SourceContext referring to a Gerrit project." }, "labels": { "type": "object", "description": "Labels with user defined metadata.", "additionalProperties": { "type": "string" } }, "cloudRepo": { "description": "A SourceContext referring to a revision in a Google Cloud Source Repo.", "$ref": "GoogleDevtoolsContaineranalysisV1alpha1CloudRepoSourceContext" } }, "id": "GoogleDevtoolsContaineranalysisV1alpha1SourceContext" }, "ExternalRef": { "properties": { "category": { "description": "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", "enumDescriptions": [ "Unspecified", "Security (e.g. cpe22Type, cpe23Type)", "Package Manager (e.g. maven-central, npm, nuget, bower, purl)", "Persistent-Id (e.g. swh)", "Other" ], "type": "string", "enum": [ "CATEGORY_UNSPECIFIED", "SECURITY", "PACKAGE_MANAGER", "PERSISTENT_ID", "OTHER" ] }, "type": { "description": "Type of category (e.g. 'npm' for the PACKAGE_MANAGER category)", "type": "string" }, "comment": { "description": "Human-readable information about the purpose and target of the reference", "type": "string" }, "locator": { "type": "string", "description": "The unique string with no spaces necessary to access the package-specific information, metadata, or content within the target location" } }, "id": "ExternalRef", "description": "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", "type": "object" }, "ComplianceVersion": { "id": "ComplianceVersion", "description": "Describes the CIS benchmark version that is applicable to a given OS and os version.", "properties": { "version": { "description": "The version of the benchmark. This is set to the version of the OS-specific CIS document the benchmark is defined in.", "type": "string" }, "benchmarkDocument": { "type": "string", "description": "The name of the document that defines this benchmark, e.g. \"CIS Container-Optimized OS\"." }, "cpeUri": { "description": "The CPE URI (https://cpe.mitre.org/specification/) this benchmark is applicable to.", "type": "string" } }, "type": "object" }, "SBOMReferenceNote": { "type": "object", "id": "SBOMReferenceNote", "properties": { "version": { "type": "string", "description": "The version of the format that the SBOM takes. E.g. if the format is spdx, the version may be 2.3." }, "format": { "type": "string", "description": "The format that SBOM takes. E.g. may be spdx, cyclonedx, etc..." } }, "description": "The note representing an SBOM reference." }, "Deployable": { "properties": { "resourceUri": { "type": "array", "items": { "type": "string" }, "description": "Resource URI for the artifact being deployed." } }, "id": "Deployable", "type": "object", "description": "An artifact that can be deployed in some runtime." }, "InTotoStatement": { "type": "object", "description": "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\".", "properties": { "predicateType": { "type": "string", "description": "\"https://slsa.dev/provenance/v0.1\" for SlsaProvenance." }, "provenance": { "$ref": "InTotoProvenance", "description": "Generic Grafeas provenance." }, "slsaProvenanceZeroTwo": { "$ref": "SlsaProvenanceZeroTwo", "description": "SLSA 0.2 provenance." }, "subject": { "items": { "$ref": "Subject" }, "description": "subject is the subjects of the intoto statement", "type": "array" }, "_type": { "type": "string", "description": "Always \"https://in-toto.io/Statement/v0.1\"." }, "slsaProvenance": { "description": "SLSA 0.1 provenance.", "$ref": "SlsaProvenance" } }, "id": "InTotoStatement" }, "ContaineranalysisGoogleDevtoolsCloudbuildV1BuiltImage": { "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1BuiltImage", "description": "An image built by the pipeline.", "type": "object", "properties": { "name": { "type": "string", "description": "Name used to push the container image to Google Container Registry, as presented to `docker push`." }, "pushTiming": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan", "readOnly": true, "description": "Output only. Stores timing information for pushing the specified image." }, "digest": { "description": "Docker Registry 2.0 digest.", "type": "string" } } }, "Layer": { "properties": { "directive": { "enumDescriptions": [ "Default value for unsupported/missing directive", "https://docs.docker.com/engine/reference/builder/", "https://docs.docker.com/engine/reference/builder/", "https://docs.docker.com/engine/reference/builder/", "https://docs.docker.com/engine/reference/builder/", "https://docs.docker.com/engine/reference/builder/", "https://docs.docker.com/engine/reference/builder/", "https://docs.docker.com/engine/reference/builder/", "https://docs.docker.com/reference/builder/#copy", "https://docs.docker.com/engine/reference/builder/", "https://docs.docker.com/engine/reference/builder/", "https://docs.docker.com/engine/reference/builder/", "https://docs.docker.com/engine/reference/builder/", "https://docs.docker.com/engine/reference/builder/", "https://docs.docker.com/engine/reference/builder/", "https://docs.docker.com/engine/reference/builder/", "https://docs.docker.com/engine/reference/builder/", "https://docs.docker.com/engine/reference/builder/" ], "type": "string", "enum": [ "DIRECTIVE_UNSPECIFIED", "MAINTAINER", "RUN", "CMD", "LABEL", "EXPOSE", "ENV", "ADD", "COPY", "ENTRYPOINT", "VOLUME", "USER", "WORKDIR", "ARG", "ONBUILD", "STOPSIGNAL", "HEALTHCHECK", "SHELL" ], "description": "The recovered Dockerfile directive used to construct this layer." }, "arguments": { "type": "string", "description": "The recovered arguments to the Dockerfile directive." } }, "description": "Layer holds metadata specific to a layer of a Docker image.", "id": "Layer", "type": "object" }, "TimeSpan": { "type": "object", "properties": { "startTime": { "format": "google-datetime", "description": "Start of time span.", "type": "string" }, "endTime": { "format": "google-datetime", "description": "End of time span.", "type": "string" } }, "description": "Start and end times for a build execution phase. Next ID: 3", "id": "TimeSpan" }, "Empty": { "type": "object", "properties": {}, "id": "Empty", "description": "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); }" }, "VexAssessment": { "description": "VexAssessment provides all publisher provided Vex information that is related to this vulnerability.", "id": "VexAssessment", "type": "object", "properties": { "state": { "enum": [ "STATE_UNSPECIFIED", "AFFECTED", "NOT_AFFECTED", "FIXED", "UNDER_INVESTIGATION" ], "description": "Provides the state of this Vulnerability assessment.", "enumDescriptions": [ "No state is specified.", "This product is known to be affected by this vulnerability.", "This product is known to be not affected by this vulnerability.", "This product contains a fix for this vulnerability.", "It is not known yet whether these versions are or are not affected by the vulnerability. However, it is still under investigation." ], "type": "string" }, "justification": { "description": "Justification provides the justification when the state of the assessment if NOT_AFFECTED.", "$ref": "Justification" }, "vulnerabilityId": { "description": "The vulnerability identifier for this Assessment. Will hold one of common identifiers e.g. CVE, GHSA etc.", "type": "string" }, "remediations": { "items": { "$ref": "Remediation" }, "description": "Specifies details on how to handle (and presumably, fix) a vulnerability.", "type": "array" }, "cve": { "type": "string", "description": "Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) tracking number for the vulnerability." }, "noteName": { "type": "string", "description": "The VulnerabilityAssessment note from which this VexAssessment was generated. This will be of the form: `projects/[PROJECT_ID]/notes/[NOTE_ID]`." }, "relatedUris": { "description": "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.", "type": "array", "items": { "$ref": "URI" } }, "impacts": { "items": { "type": "string" }, "type": "array", "description": "Contains information about the impact of this vulnerability, this will change with time." } } }, "TestIamPermissionsRequest": { "id": "TestIamPermissionsRequest", "properties": { "permissions": { "description": "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).", "type": "array", "items": { "type": "string" } } }, "type": "object", "description": "Request message for `TestIamPermissions` method." }, "ContaineranalysisGoogleDevtoolsCloudbuildV1InlineSecret": { "type": "object", "description": "Pairs a set of secret environment variables mapped to encrypted values with the Cloud KMS key to use to decrypt the value.", "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1InlineSecret", "properties": { "kmsKeyName": { "description": "Resource name of Cloud KMS crypto key to decrypt the encrypted value. In format: projects/*/locations/*/keyRings/*/cryptoKeys/*", "type": "string" }, "envMap": { "description": "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.", "additionalProperties": { "format": "byte", "type": "string" }, "type": "object" } } }, "SlsaCompleteness": { "properties": { "environment": { "type": "boolean", "description": "If true, the builder claims that recipe.environment is claimed to be complete." }, "materials": { "description": "If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called \"hermetic\".", "type": "boolean" }, "arguments": { "type": "boolean", "description": "If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe." } }, "id": "SlsaCompleteness", "type": "object", "description": "Indicates that the builder claims certain fields in this message to be complete." }, "Basis": { "properties": { "resourceUrl": { "description": "The resource_url for the resource representing the basis of associated occurrence images.", "type": "string" }, "fingerprint": { "description": "The fingerprint of the base image.", "$ref": "Fingerprint" } }, "description": "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.", "id": "Basis", "type": "object" }, "ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes": { "description": "Container message for hashes of byte content of files, used in SourceProvenance messages to verify integrity of source input to the build.", "type": "object", "properties": { "fileHash": { "description": "Collection of file hashes.", "type": "array", "items": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1Hash" } } }, "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes" }, "ContaineranalysisGoogleDevtoolsCloudbuildV1Results": { "properties": { "buildStepImages": { "items": { "type": "string" }, "type": "array", "description": "List of build step digests, in the order corresponding to build step indices." }, "images": { "description": "Container images that were built as a part of the build.", "type": "array", "items": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1BuiltImage" } }, "npmPackages": { "items": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedNpmPackage" }, "type": "array", "description": "Npm packages uploaded to Artifact Registry at the end of the build." }, "pythonPackages": { "description": "Python artifacts uploaded to Artifact Registry at the end of the build.", "type": "array", "items": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedPythonPackage" } }, "mavenArtifacts": { "items": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact" }, "description": "Maven artifacts uploaded to Artifact Registry at the end of the build.", "type": "array" }, "artifactManifest": { "description": "Path to the artifact manifest for non-container artifacts uploaded to Cloud Storage. Only populated when artifacts are uploaded to Cloud Storage.", "type": "string" }, "artifactTiming": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan", "description": "Time to push all non-container artifacts to Cloud Storage." }, "numArtifacts": { "description": "Number of non-container artifacts uploaded to Cloud Storage. Only populated when artifacts are uploaded to Cloud Storage.", "format": "int64", "type": "string" }, "buildStepOutputs": { "description": "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.", "type": "array", "items": { "format": "byte", "type": "string" } } }, "type": "object", "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1Results", "description": "Artifacts created by the build pipeline." }, "CisBenchmark": { "properties": { "profileLevel": { "format": "int32", "type": "integer", "description": "The profile level of this CIS benchmark check." }, "severity": { "description": "The severity level of this CIS benchmark check.", "type": "string", "enum": [ "SEVERITY_UNSPECIFIED", "MINIMAL", "LOW", "MEDIUM", "HIGH", "CRITICAL" ], "enumDescriptions": [ "Unknown Impact", "Minimal Impact", "Low Impact", "Medium Impact", "High Impact", "Critical Impact" ] } }, "description": "A compliance check that is a CIS benchmark.", "id": "CisBenchmark", "type": "object" }, "NonCompliantFile": { "id": "NonCompliantFile", "description": "Details about files that caused a compliance check to fail.", "type": "object", "properties": { "path": { "type": "string", "description": "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": { "type": "string", "description": "Explains why a file is non compliant for a CIS check." }, "displayCommand": { "description": "Command to display the non-compliant files.", "type": "string" } } }, "ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact": { "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact", "type": "object", "description": "A Maven artifact to upload to Artifact Registry upon successful completion of all build steps.", "properties": { "repository": { "description": "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.", "type": "string" }, "groupId": { "type": "string", "description": "Maven `groupId` value used when uploading the artifact to Artifact Registry." }, "path": { "type": "string", "description": "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." }, "artifactId": { "type": "string", "description": "Maven `artifactId` value used when uploading the artifact to Artifact Registry." }, "version": { "type": "string", "description": "Maven `version` value used when uploading the artifact to Artifact Registry." } } }, "Location": { "type": "object", "properties": { "cpeUri": { "description": "Deprecated. The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.", "type": "string" }, "path": { "description": "The path from which we gathered that this package/version is installed.", "type": "string" }, "version": { "$ref": "Version", "description": "Deprecated. The version installed at this location." } }, "description": "An occurrence of a particular package installation found within a system's filesystem. e.g. glibc was found in /var/lib/dpkg/status", "id": "Location" }, "TestIamPermissionsResponse": { "type": "object", "description": "Response message for `TestIamPermissions` method.", "id": "TestIamPermissionsResponse", "properties": { "permissions": { "description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.", "type": "array", "items": { "type": "string" } } } }, "Package": { "type": "object", "description": "This represents a particular package that is distributed over various channels. e.g. glibc (aka libc6) is distributed by many, at various versions.", "id": "Package", "properties": { "distribution": { "description": "The various channels by which a package is distributed.", "items": { "$ref": "Distribution" }, "type": "array" }, "url": { "description": "The homepage for this package.", "type": "string" }, "packageType": { "description": "The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).", "type": "string" }, "cpeUri": { "description": "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.", "type": "string" }, "name": { "type": "string", "description": "The name of the package." }, "architecture": { "description": "The CPU architecture for which packages in this distribution channel were built. Architecture will be blank for language packages.", "type": "string", "enum": [ "ARCHITECTURE_UNSPECIFIED", "X86", "X64" ], "enumDescriptions": [ "Unknown architecture", "X86 architecture", "X64 architecture" ] }, "license": { "description": "Licenses that have been declared by the authors of the package.", "$ref": "License" }, "version": { "description": "The version of the package.", "$ref": "Version" }, "digest": { "description": "Hash value, typically a file digest, that allows unique identification a specific package.", "items": { "$ref": "Digest" }, "type": "array" }, "maintainer": { "description": "A freeform text denoting the maintainer of this package.", "type": "string" }, "description": { "type": "string", "description": "The description of this package." } } }, "UpgradeNote": { "properties": { "distributions": { "type": "array", "items": { "$ref": "UpgradeDistribution" }, "description": "Metadata about the upgrade for each specific operating system." }, "package": { "type": "string", "description": "Required - The package this Upgrade is for." }, "version": { "description": "Required - The version of the package in machine + human readable form.", "$ref": "Version" } }, "type": "object", "description": "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.", "id": "UpgradeNote" }, "ListNotesResponse": { "type": "object", "properties": { "notes": { "type": "array", "items": { "$ref": "Note" }, "description": "The occurrences requested" }, "nextPageToken": { "type": "string", "description": "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." } }, "id": "ListNotesResponse", "description": "Response including listed notes." }, "GoogleDevtoolsContaineranalysisV1alpha1GitSourceContext": { "id": "GoogleDevtoolsContaineranalysisV1alpha1GitSourceContext", "type": "object", "properties": { "revisionId": { "type": "string", "description": "Required. Git commit hash." }, "url": { "type": "string", "description": "Git repository URL." } }, "description": "A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub)." }, "ContaineranalysisGoogleDevtoolsCloudbuildV1SourceProvenance": { "type": "object", "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1SourceProvenance", "description": "Provenance of the source. Ways to find the original source, or verify that some source was used for this build.", "properties": { "resolvedRepoSource": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource", "description": "A copy of the build's `source.repo_source`, if exists, with any revisions resolved." }, "resolvedGitSource": { "readOnly": true, "description": "Output only. A copy of the build's `source.git_source`, if exists, with any revisions resolved.", "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource" }, "fileHashes": { "description": "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.", "readOnly": true, "type": "object", "additionalProperties": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes" } }, "resolvedStorageSource": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource", "description": "A copy of the build's `source.storage_source`, if exists, with any generations resolved." }, "resolvedStorageSourceManifest": { "description": "A copy of the build's `source.storage_source_manifest`, if exists, with any revisions resolved. This feature is in Preview.", "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest" }, "resolvedConnectedRepository": { "description": "Output only. A copy of the build's `source.connected_repository`, if exists, with any revisions resolved.", "readOnly": true, "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository" } } }, "ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource": { "description": "Location of the source in a Google Cloud Source Repository.", "properties": { "projectId": { "description": "ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.", "type": "string" }, "invertRegex": { "description": "Only trigger a build if the revision regex does NOT match the revision regex.", "type": "boolean" }, "substitutions": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Substitutions to use in a triggered build. Should only be used with RunBuildTrigger" }, "commitSha": { "type": "string", "description": "Explicit commit SHA to build." }, "tagName": { "type": "string", "description": "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" }, "repoName": { "description": "Name of the Cloud Source Repository.", "type": "string" }, "branchName": { "type": "string", "description": "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" }, "dir": { "type": "string", "description": "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." } }, "type": "object", "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource" }, "BuildStep": { "id": "BuildStep", "type": "object", "properties": { "exitCode": { "format": "int32", "description": "Output only. Return code from running the step.", "type": "integer" }, "allowFailure": { "description": "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.", "type": "boolean" }, "timeout": { "format": "google-duration", "type": "string", "description": "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." }, "automapSubstitutions": { "type": "boolean", "description": "Option to include built-in and custom substitutions as env variables for this build step. This option will override the global option in BuildOption." }, "name": { "type": "string", "description": "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." }, "waitFor": { "items": { "type": "string" }, "type": "array", "description": "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." }, "args": { "description": "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.", "type": "array", "items": { "type": "string" } }, "script": { "description": "A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args.", "type": "string" }, "pullTiming": { "$ref": "TimeSpan", "description": "Output only. Stores timing information for pulling this build step's builder image only." }, "status": { "description": "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.", "enum": [ "STATUS_UNKNOWN", "PENDING", "QUEUING", "QUEUED", "WORKING", "SUCCESS", "FAILURE", "INTERNAL_ERROR", "TIMEOUT", "CANCELLED", "EXPIRED" ], "enumDescriptions": [ "Status of the build is unknown.", "Build has been created and is pending execution and queuing. It has not been queued.", "Build has been received and is being queued.", "Build or step is queued; work has not yet begun.", "Build or step is being executed.", "Build or step finished successfully.", "Build or step failed to complete successfully.", "Build or step failed due to an internal cause.", "Build or step took longer than was allowed.", "Build or step was canceled by a user.", "Build was enqueued for longer than the value of `queue_ttl`." ], "type": "string" }, "entrypoint": { "type": "string", "description": "Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used." }, "id": { "description": "Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency.", "type": "string" }, "timing": { "$ref": "TimeSpan", "description": "Output only. Stores timing information for executing this build step." }, "allowExitCodes": { "items": { "type": "integer", "format": "int32" }, "description": "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.", "type": "array" }, "dir": { "description": "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.", "type": "string" }, "volumes": { "items": { "$ref": "Volume" }, "description": "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.", "type": "array" }, "secretEnv": { "items": { "type": "string" }, "description": "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`.", "type": "array" }, "env": { "description": "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\".", "type": "array", "items": { "type": "string" } } }, "description": "A step in the build pipeline. Next ID: 21" }, "SeverityCount": { "id": "SeverityCount", "properties": { "severity": { "description": "The severity of the occurrences.", "type": "string", "enumDescriptions": [ "Unknown Impact", "Minimal Impact", "Low Impact", "Medium Impact", "High Impact", "Critical Impact" ], "enum": [ "SEVERITY_UNSPECIFIED", "MINIMAL", "LOW", "MEDIUM", "HIGH", "CRITICAL" ] }, "count": { "type": "string", "format": "int64", "description": "The number of occurrences with the severity." } }, "type": "object", "description": "The number of occurrences created for a specific severity." }, "Volume": { "type": "object", "id": "Volume", "description": "Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution. Next ID: 3", "properties": { "name": { "description": "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.", "type": "string" }, "path": { "type": "string", "description": "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." } } }, "Source": { "type": "object", "description": "Source describes the location of the source used for the build.", "id": "Source", "properties": { "storageSource": { "$ref": "StorageSource", "description": "If provided, get the source from this location in Google Cloud Storage.", "deprecated": true }, "fileHashes": { "description": "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.", "type": "object", "additionalProperties": { "$ref": "FileHashes" } }, "repoSource": { "description": "If provided, get source from this location in a Cloud Repo.", "deprecated": true, "$ref": "RepoSource" }, "additionalContexts": { "type": "array", "items": { "$ref": "GoogleDevtoolsContaineranalysisV1alpha1SourceContext" }, "description": "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": { "$ref": "StorageSource", "description": "If provided, the input binary artifacts for the build came from this location." }, "context": { "description": "If provided, the source code used for the build came from this location.", "$ref": "GoogleDevtoolsContaineranalysisV1alpha1SourceContext" } } }, "SBOMStatus": { "id": "SBOMStatus", "properties": { "sbomState": { "description": "Output only. The progress of the SBOM generation.", "readOnly": true, "enum": [ "SBOM_STATE_UNSPECIFIED", "PENDING", "COMPLETE" ], "type": "string", "enumDescriptions": [ "Default unknown state.", "SBOM scanning is pending.", "SBOM scanning has completed." ] }, "error": { "readOnly": true, "description": "Output only. If there was an error generating an SBOM, this will indicate what that error was.", "type": "string" } }, "type": "object", "description": "The status of an SBOM generation." }, "GoogleDevtoolsContaineranalysisV1alpha1GerritSourceContext": { "id": "GoogleDevtoolsContaineranalysisV1alpha1GerritSourceContext", "description": "A SourceContext referring to a Gerrit project.", "properties": { "gerritProject": { "description": "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.", "type": "string" }, "revisionId": { "description": "A revision (commit) ID.", "type": "string" }, "aliasContext": { "$ref": "GoogleDevtoolsContaineranalysisV1alpha1AliasContext", "description": "An alias, which may be a branch or tag." }, "hostUri": { "type": "string", "description": "The URI of a running Gerrit instance." } }, "type": "object" }, "BuildDefinition": { "id": "BuildDefinition", "properties": { "resolvedDependencies": { "items": { "$ref": "ResourceDescriptor" }, "type": "array" }, "internalParameters": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "type": "object" }, "buildType": { "type": "string" }, "externalParameters": { "additionalProperties": { "type": "any", "description": "Properties of the object." }, "type": "object" } }, "type": "object" }, "SbomReferenceIntotoPayload": { "description": "The actual payload that contains the SBOM Reference data. The payload follows the intoto statement specification. See https://github.com/in-toto/attestation/blob/main/spec/v1.0/statement.md for more details.", "id": "SbomReferenceIntotoPayload", "properties": { "predicate": { "description": "Additional parameters of the Predicate. Includes the actual data about the SBOM.", "$ref": "SbomReferenceIntotoPredicate" }, "subject": { "items": { "$ref": "Subject" }, "type": "array", "description": "Set of software artifacts that the attestation applies to. Each element represents a single software artifact." }, "_type": { "description": "Identifier for the schema of the Statement.", "type": "string" }, "predicateType": { "description": "URI identifying the type of the Predicate.", "type": "string" } }, "type": "object" }, "ContaineranalysisGoogleDevtoolsCloudbuildV1SecretManagerSecret": { "description": "Pairs a secret environment variable with a SecretVersion in Secret Manager.", "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1SecretManagerSecret", "type": "object", "properties": { "env": { "type": "string", "description": "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": { "description": "Resource name of the SecretVersion. In format: projects/*/secrets/*/versions/*", "type": "string" } } }, "ContaineranalysisGoogleDevtoolsCloudbuildV1Volume": { "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1Volume", "type": "object", "description": "Volume describes a Docker container volume which is mounted into build steps in order to persist files across build step execution.", "properties": { "name": { "description": "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.", "type": "string" }, "path": { "type": "string", "description": "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." } } }, "ScanConfig": { "properties": { "name": { "type": "string", "description": "Output only. The name of the ScanConfig in the form “projects/{project_id}/scanConfigs/{scan_config_id}\"." }, "description": { "description": "Output only. A human-readable description of what the `ScanConfig` does.", "type": "string" }, "enabled": { "description": "Indicates whether the Scan is enabled.", "type": "boolean" }, "updateTime": { "format": "google-datetime", "type": "string", "description": "Output only. The time this scan config was last updated." }, "createTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time this scan config was created." } }, "id": "ScanConfig", "type": "object", "description": "Indicates various scans and whether they are turned on or off." }, "ContaineranalysisGoogleDevtoolsCloudbuildV1BuildWarning": { "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1BuildWarning", "properties": { "text": { "type": "string", "description": "Explanation of the warning generated." }, "priority": { "type": "string", "description": "The priority for this warning.", "enumDescriptions": [ "Should not be used.", "e.g. deprecation warnings and alternative feature highlights.", "e.g. automated detection of possible issues with the build.", "e.g. alerts that a feature used in the build is pending removal" ], "enum": [ "PRIORITY_UNSPECIFIED", "INFO", "WARNING", "ALERT" ] } }, "type": "object", "description": "A non-fatal problem encountered during the execution of the build." }, "VulnerabilityDetails": { "properties": { "effectiveSeverity": { "type": "string", "enumDescriptions": [ "Unknown Impact", "Minimal Impact", "Low Impact", "Medium Impact", "High Impact", "Critical Impact" ], "description": "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.", "enum": [ "SEVERITY_UNSPECIFIED", "MINIMAL", "LOW", "MEDIUM", "HIGH", "CRITICAL" ] }, "packageIssue": { "type": "array", "items": { "$ref": "PackageIssue" }, "description": "The set of affected locations and their fixes (if available) within the associated resource." }, "vexAssessment": { "description": "VexAssessment provides all publisher provided Vex information that is related to this vulnerability for this resource.", "$ref": "VexAssessment" }, "cvssVersion": { "description": "Output only. CVSS version used to populate cvss_score and severity.", "enumDescriptions": [ "CVSS Version unspecified.", "CVSS v2.", "CVSS v3." ], "type": "string", "enum": [ "CVSS_VERSION_UNSPECIFIED", "CVSS_VERSION_2", "CVSS_VERSION_3" ], "readOnly": true }, "type": { "description": "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.", "type": "string" }, "cvssV2": { "description": "The CVSS v2 score of this vulnerability.", "$ref": "CVSS" }, "cvssV3": { "description": "The CVSS v3 score of this vulnerability.", "$ref": "CVSS" }, "cvssScore": { "format": "float", "type": "number", "description": "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." }, "severity": { "type": "string", "enumDescriptions": [ "Unknown Impact", "Minimal Impact", "Low Impact", "Medium Impact", "High Impact", "Critical Impact" ], "enum": [ "SEVERITY_UNSPECIFIED", "MINIMAL", "LOW", "MEDIUM", "HIGH", "CRITICAL" ], "description": "Output only. The note provider assigned Severity of the vulnerability." }, "extraDetails": { "type": "string", "description": "Occurrence-specific extra details about the vulnerability." } }, "type": "object", "id": "VulnerabilityDetails", "description": "Used by Occurrence to point to where the vulnerability exists and how to fix it." }, "GoogleDevtoolsContaineranalysisV1alpha1SlsaProvenanceZeroTwoSlsaCompleteness": { "properties": { "parameters": { "type": "boolean", "description": "If true, the builder claims that invocation.parameters is complete." }, "environment": { "description": "If true, the builder claims that invocation.environment is complete.", "type": "boolean" }, "materials": { "description": "If true, the builder claims that materials is complete.", "type": "boolean" } }, "description": "Indicates that the builder claims certain fields in this message to be complete.", "id": "GoogleDevtoolsContaineranalysisV1alpha1SlsaProvenanceZeroTwoSlsaCompleteness", "type": "object" }, "CreateOperationRequest": { "id": "CreateOperationRequest", "description": "Request for creating an operation", "type": "object", "properties": { "operationId": { "type": "string", "description": "The ID to use for this operation." }, "operation": { "description": "The operation to create.", "$ref": "Operation" } } }, "SlsaProvenance": { "properties": { "metadata": { "$ref": "SlsaMetadata", "description": "metadata is the metadata of the provenance" }, "materials": { "description": "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.", "type": "array", "items": { "$ref": "Material" } }, "builder": { "description": "builder is the builder of this provenance", "$ref": "SlsaBuilder" }, "recipe": { "description": "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).", "$ref": "SlsaRecipe" } }, "id": "SlsaProvenance", "description": "SlsaProvenance is the slsa provenance as defined by the slsa spec.", "type": "object" }, "ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo": { "type": "object", "properties": { "type": { "enumDescriptions": [ "Type unspecified", "Unable to push the image to the repository.", "Final image not found.", "Unauthorized push of the final image.", "Backend logging failures. Should retry.", "A build step has failed.", "The source fetching has failed." ], "enum": [ "FAILURE_TYPE_UNSPECIFIED", "PUSH_FAILED", "PUSH_IMAGE_NOT_FOUND", "PUSH_NOT_AUTHORIZED", "LOGGING_FAILURE", "USER_BUILD_STEP", "FETCH_SOURCE_FAILED" ], "description": "The name of the failure.", "type": "string" }, "detail": { "type": "string", "description": "Explains the failure issue in more detail using hard-coded text." } }, "description": "A fatal problem encountered during the execution of the build.", "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo" }, "Metadata": { "description": "Other properties of the build.", "properties": { "completeness": { "$ref": "Completeness", "description": "Indicates that the builder claims certain fields in this message to be complete." }, "buildInvocationId": { "description": "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.", "type": "string" }, "buildFinishedOn": { "format": "google-datetime", "type": "string", "description": "The timestamp of when the build completed." }, "reproducible": { "description": "If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output.", "type": "boolean" }, "buildStartedOn": { "type": "string", "description": "The timestamp of when the build started.", "format": "google-datetime" } }, "type": "object", "id": "Metadata" }, "GetIamPolicyRequest": { "id": "GetIamPolicyRequest", "description": "Request message for `GetIamPolicy` method.", "properties": { "options": { "description": "OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.", "$ref": "GetPolicyOptions" } }, "type": "object" }, "Fingerprint": { "description": "A set of properties that uniquely identify a given Docker image.", "type": "object", "properties": { "v1Name": { "type": "string", "description": "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": { "items": { "type": "string" }, "type": "array", "description": "The ordered list of v2 blobs that represent a given image." }, "v2Name": { "type": "string", "description": "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." } }, "id": "Fingerprint" }, "ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource": { "description": "Location of the source in any accessible Git repository.", "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource", "type": "object", "properties": { "revision": { "type": "string", "description": "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." }, "dir": { "description": "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.", "type": "string" }, "url": { "type": "string", "description": "Location of the Git repo to build. This will be used as a `git remote`, see https://git-scm.com/docs/git-remote." } } }, "ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalConfig": { "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalConfig", "properties": { "approvalRequired": { "description": "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.", "type": "boolean" } }, "type": "object", "description": "ApprovalConfig describes configuration for manual approval of a build." }, "ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep": { "description": "A step in the build pipeline.", "type": "object", "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep", "properties": { "secretEnv": { "type": "array", "description": "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`.", "items": { "type": "string" } }, "waitFor": { "type": "array", "items": { "type": "string" }, "description": "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." }, "allowExitCodes": { "items": { "format": "int32", "type": "integer" }, "type": "array", "description": "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." }, "timing": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan", "readOnly": true, "description": "Output only. Stores timing information for executing this build step." }, "dir": { "description": "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.", "type": "string" }, "name": { "description": "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.", "type": "string" }, "allowFailure": { "description": "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.", "type": "boolean" }, "automapSubstitutions": { "type": "boolean", "description": "Option to include built-in and custom substitutions as env variables for this build step. This option will override the global option in BuildOption." }, "script": { "type": "string", "description": "A shell script to be executed in the step. When script is provided, the user cannot specify the entrypoint or args." }, "timeout": { "format": "google-duration", "description": "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.", "type": "string" }, "entrypoint": { "description": "Entrypoint to be used instead of the build step image's default entrypoint. If unset, the image's default entrypoint is used.", "type": "string" }, "id": { "type": "string", "description": "Unique identifier for this build step, used in `wait_for` to reference this build step as a dependency." }, "volumes": { "items": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1Volume" }, "description": "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.", "type": "array" }, "status": { "enumDescriptions": [ "Status of the build is unknown.", "Build has been created and is pending execution and queuing. It has not been queued.", "Build or step is queued; work has not yet begun.", "Build or step is being executed.", "Build or step finished successfully.", "Build or step failed to complete successfully.", "Build or step failed due to an internal cause.", "Build or step took longer than was allowed.", "Build or step was canceled by a user.", "Build was enqueued for longer than the value of `queue_ttl`." ], "enum": [ "STATUS_UNKNOWN", "PENDING", "QUEUED", "WORKING", "SUCCESS", "FAILURE", "INTERNAL_ERROR", "TIMEOUT", "CANCELLED", "EXPIRED" ], "description": "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.", "type": "string", "readOnly": true }, "pullTiming": { "readOnly": true, "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan", "description": "Output only. Stores timing information for pulling this build step's builder image only." }, "args": { "description": "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.", "type": "array", "items": { "type": "string" } }, "env": { "items": { "type": "string" }, "type": "array", "description": "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": { "readOnly": true, "description": "Output only. Return code from running the step.", "format": "int32", "type": "integer" } } }, "ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository": { "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository", "properties": { "dir": { "type": "string", "description": "Directory, relative to the source root, in which to run the build." }, "repository": { "type": "string", "description": "Required. Name of the Google Cloud Build repository, formatted as `projects/*/locations/*/connections/*/repositories/*`." }, "revision": { "type": "string", "description": "The revision to fetch from the Git repository such as a branch, a tag, a commit SHA, or any Git ref." } }, "description": "Location of the source in a 2nd-gen Google Cloud Build repository resource.", "type": "object" }, "BuildProvenance": { "id": "BuildProvenance", "type": "object", "properties": { "createTime": { "format": "google-datetime", "description": "Time at which the build was created.", "type": "string" }, "startTime": { "type": "string", "format": "google-datetime", "description": "Time at which execution of the build was started." }, "commands": { "type": "array", "description": "Commands requested by the build.", "items": { "$ref": "Command" } }, "finishTime": { "description": "Time at which execution of the build was finished.", "type": "string", "format": "google-datetime" }, "id": { "type": "string", "description": "Unique identifier of the build." }, "triggerId": { "description": "Trigger identifier if the build was triggered automatically; empty if not.", "type": "string" }, "builtArtifacts": { "items": { "$ref": "Artifact" }, "description": "Output of the build.", "type": "array" }, "buildOptions": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Special options applied to this build. This is a catch-all field where build providers can enter any desired additional details." }, "sourceProvenance": { "$ref": "Source", "description": "Details of the Source input to the build." }, "builderVersion": { "type": "string", "description": "Version string of the builder at the time this build was executed." }, "projectId": { "description": "ID of the project.", "type": "string" }, "logsBucket": { "type": "string", "description": "Google Cloud Storage bucket where logs were written." }, "creator": { "description": "E-mail address of the user who initiated this build. Note that this was the user's e-mail address at the time the build was initiated; this address may not represent the same end-user for all time.", "type": "string" } }, "description": "Provenance of a build. Contains all information needed to verify the full details about the build from source to completion." }, "GoogleDevtoolsContaineranalysisV1alpha1OperationMetadata": { "type": "object", "description": "Metadata for all operations used and required for all operations that created by Container Analysis Providers", "id": "GoogleDevtoolsContaineranalysisV1alpha1OperationMetadata", "properties": { "endTime": { "description": "Output only. The time that this operation was marked completed or failed.", "format": "google-datetime", "type": "string" }, "createTime": { "type": "string", "description": "Output only. The time this operation was created.", "format": "google-datetime" } } }, "ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact": { "description": "A Maven artifact uploaded using the MavenArtifact directive.", "properties": { "uri": { "description": "URI of the uploaded artifact.", "type": "string" }, "pushTiming": { "description": "Output only. Stores timing information for pushing the specified artifact.", "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan", "readOnly": true }, "fileHashes": { "description": "Hash types and values of the Maven Artifact.", "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes" } }, "type": "object", "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedMavenArtifact" }, "FileHashes": { "description": "Container message for hashes of byte content of files, used in Source messages to verify integrity of source input to the build.", "id": "FileHashes", "type": "object", "properties": { "fileHash": { "description": "Collection of file hashes.", "items": { "$ref": "Hash" }, "type": "array" } } }, "GetPolicyOptions": { "properties": { "requestedPolicyVersion": { "type": "integer", "description": "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).", "format": "int32" } }, "description": "Encapsulates settings provided to GetIamPolicy.", "type": "object", "id": "GetPolicyOptions" }, "PackageInfoNote": { "properties": { "downloadLocation": { "type": "string", "description": "This section identifies the download Universal Resource Locator (URL), or a specific location within a version control system (VCS) for the package at the time that the SPDX file was created" }, "filesLicenseInfo": { "type": "array", "description": "Contain the license the SPDX file creator has concluded as governing the This field is to contain a list of all licenses found in the package. The relationship between licenses (i.e., conjunctive, disjunctive) is not specified in this field – it is simply a listing of all licenses found", "items": { "type": "string" } }, "detailedDescription": { "description": "A more detailed description of the package", "type": "string" }, "verificationCode": { "type": "string", "description": "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" }, "checksum": { "type": "string", "description": "Provide an independently reproducible mechanism that permits unique identification of a specific package that correlates to the data in this SPDX file" }, "originator": { "type": "string", "description": "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" }, "attribution": { "description": "A place for the SPDX data creator to record, at the package level, acknowledgements that may be needed to be communicated in some contexts", "type": "string" }, "copyright": { "type": "string", "description": "Identify the copyright holders of the package, as well as any dates present" }, "version": { "type": "string", "description": "Identify the version of the package" }, "title": { "type": "string", "description": "Identify the full name of the package as given by the Package Originator" }, "analyzed": { "type": "boolean", "description": "Indicates whether the file content of this package has been available for or subjected to analysis when creating the SPDX document" }, "supplier": { "type": "string", "description": "Identify the actual distribution source for the package/directory identified in the SPDX file" }, "summaryDescription": { "type": "string", "description": "A short description of the package" }, "homePage": { "type": "string", "description": "Provide a place for the SPDX file creator to record a web site that serves as the package's home page" }, "licenseDeclared": { "$ref": "License", "description": "List the licenses that have been declared by the authors of the package" }, "externalRefs": { "description": "ExternalRef", "type": "array", "items": { "$ref": "ExternalRef" } }, "packageType": { "type": "string", "description": "The type of package: OS, MAVEN, GO, GO_STDLIB, etc." } }, "type": "object", "id": "PackageInfoNote", "description": "PackageInfoNote represents an SPDX Package Information section: https://spdx.github.io/spdx-spec/3-package-information/" }, "BuildType": { "description": "Note holding the version of the provider's builder and the signature of the provenance message in linked BuildDetails.", "id": "BuildType", "type": "object", "properties": { "signature": { "description": "Signature of the build in Occurrences pointing to the Note containing this `BuilderDetails`.", "$ref": "BuildSignature" }, "builderVersion": { "description": "Version of the builder which produced this Note.", "type": "string" } } }, "ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedPythonPackage": { "properties": { "uri": { "type": "string", "description": "URI of the uploaded artifact." }, "fileHashes": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes", "description": "Hash types and values of the Python Artifact." }, "pushTiming": { "description": "Output only. Stores timing information for pushing the specified artifact.", "readOnly": true, "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan" } }, "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedPythonPackage", "type": "object", "description": "Artifact uploaded using the PythonPackage directive." }, "BuildDetails": { "id": "BuildDetails", "type": "object", "properties": { "intotoProvenance": { "$ref": "InTotoProvenance", "description": "Deprecated. See InTotoStatement for the replacement. In-toto Provenance representation as defined in spec." }, "provenance": { "$ref": "BuildProvenance", "description": "The actual provenance" }, "inTotoSlsaProvenanceV1": { "$ref": "InTotoSlsaProvenanceV1", "description": "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." }, "intotoStatement": { "$ref": "InTotoStatement", "description": "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." }, "provenanceBytes": { "type": "string", "description": "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." } }, "description": "Message encapsulating build provenance details." }, "RelatedUrl": { "description": "Metadata for any related URL information", "properties": { "label": { "type": "string", "description": "Label to describe usage of the URL" }, "url": { "description": "Specific URL to associate with the note", "type": "string" } }, "id": "RelatedUrl", "type": "object" }, "Assessment": { "properties": { "vulnerabilityId": { "description": "The vulnerability identifier for this Assessment. Will hold one of common identifiers e.g. CVE, GHSA etc.", "type": "string" }, "cve": { "type": "string", "description": "Holds the MITRE standard Common Vulnerabilities and Exposures (CVE) tracking number for the vulnerability." }, "relatedUris": { "description": "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.", "items": { "$ref": "URI" }, "type": "array" }, "shortDescription": { "description": "A one sentence description of this Vex.", "type": "string" }, "longDescription": { "description": "A detailed description of this Vex.", "type": "string" }, "remediations": { "type": "array", "items": { "$ref": "Remediation" }, "description": "Specifies details on how to handle (and presumably, fix) a vulnerability." }, "state": { "type": "string", "description": "Provides the state of this Vulnerability assessment.", "enumDescriptions": [ "No state is specified.", "This product is known to be affected by this vulnerability.", "This product is known to be not affected by this vulnerability.", "This product contains a fix for this vulnerability.", "It is not known yet whether these versions are or are not affected by the vulnerability. However, it is still under investigation." ], "enum": [ "STATE_UNSPECIFIED", "AFFECTED", "NOT_AFFECTED", "FIXED", "UNDER_INVESTIGATION" ] }, "impacts": { "type": "array", "items": { "type": "string" }, "description": "Contains information about the impact of this vulnerability, this will change with time." }, "justification": { "$ref": "Justification", "description": "Justification provides the justification when the state of the assessment if NOT_AFFECTED." } }, "description": "Assessment provides all information that is related to a single vulnerability for this product.", "type": "object", "id": "Assessment" }, "ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsArtifactObjects": { "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsArtifactObjects", "description": "Files in the workspace to upload to Cloud Storage upon successful completion of all build steps.", "type": "object", "properties": { "paths": { "description": "Path globs used to match files in the build's workspace.", "type": "array", "items": { "type": "string" } }, "location": { "description": "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.", "type": "string" }, "timing": { "readOnly": true, "description": "Output only. Stores timing information for pushing all artifact objects.", "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan" } } }, "IdentifierHelper": { "type": "object", "properties": { "genericUri": { "type": "string", "description": "Contains a URI which is vendor-specific. Example: The artifact repository URL of an image." }, "field": { "description": "The field that is set in the API proto.", "type": "string", "enumDescriptions": [ "The helper isn't set.", "The generic_uri one-of field is set." ], "enum": [ "IDENTIFIER_HELPER_FIELD_UNSPECIFIED", "GENERIC_URI" ] } }, "id": "IdentifierHelper", "description": "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." }, "Discovery": { "properties": { "analysisKind": { "type": "string", "enumDescriptions": [ "Unknown", "The note and occurrence represent a package vulnerability.", "The note and occurrence assert build provenance.", "This represents an image basis relationship.", "This represents a package installed via a package manager.", "The note and occurrence track deployment events.", "The note and occurrence track the initial discovery status of a resource.", "This represents a logical \"role\" that can attest to artifacts.", "This represents an available software upgrade.", "This represents a compliance check that can be applied to a resource.", "This represents a software bill of materials.", "This represents an SPDX Package.", "This represents an SPDX File.", "This represents an SPDX Relationship.", "This represents a DSSE attestation Note", "This represents a Vulnerability Assessment.", "This represents a reference to an SBOM." ], "enum": [ "KIND_UNSPECIFIED", "PACKAGE_VULNERABILITY", "BUILD_DETAILS", "IMAGE_BASIS", "PACKAGE_MANAGER", "DEPLOYABLE", "DISCOVERY", "ATTESTATION_AUTHORITY", "UPGRADE", "COMPLIANCE", "SBOM", "SPDX_PACKAGE", "SPDX_FILE", "SPDX_RELATIONSHIP", "DSSE_ATTESTATION", "VULNERABILITY_ASSESSMENT", "SBOM_REFERENCE" ], "description": "The kind of analysis that is handled by this discovery." } }, "id": "Discovery", "description": "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.", "type": "object" }, "ListNoteOccurrencesResponse": { "id": "ListNoteOccurrencesResponse", "properties": { "nextPageToken": { "type": "string", "description": "Token to receive the next page of notes." }, "occurrences": { "type": "array", "description": "The occurrences attached to the specified note.", "items": { "$ref": "Occurrence" } } }, "description": "Response including listed occurrences for a note.", "type": "object" }, "UpgradeDistribution": { "properties": { "cpeUri": { "description": "Required - The specific operating system this metadata applies to. See https://cpe.mitre.org/specification/.", "type": "string" }, "severity": { "type": "string", "description": "The severity as specified by the upstream operating system." }, "classification": { "type": "string", "description": "The operating system classification of this Upgrade, as specified by the upstream operating system upgrade feed." }, "cve": { "description": "The cve that would be resolved by this upgrade.", "items": { "type": "string" }, "type": "array" } }, "description": "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.", "type": "object", "id": "UpgradeDistribution" }, "Completeness": { "properties": { "environment": { "description": "If true, the builder claims that recipe.environment is claimed to be complete.", "type": "boolean" }, "arguments": { "description": "If true, the builder claims that recipe.arguments is complete, meaning that all external inputs are properly captured in the recipe.", "type": "boolean" }, "materials": { "description": "If true, the builder claims that materials are complete, usually through some controls to prevent network access. Sometimes called \"hermetic\".", "type": "boolean" } }, "type": "object", "description": "Indicates that the builder claims certain fields in this message to be complete.", "id": "Completeness" }, "SlsaRecipe": { "properties": { "definedInMaterial": { "description": "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.", "type": "string", "format": "int64" }, "entryPoint": { "description": "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.", "type": "string" }, "arguments": { "type": "object", "description": "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.", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "environment": { "description": "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": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "type": { "description": "URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.", "type": "string" } }, "type": "object", "id": "SlsaRecipe", "description": "Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe." }, "ContaineranalysisGoogleDevtoolsCloudbuildV1Source": { "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1Source", "properties": { "storageSource": { "description": "If provided, get the source from this location in Cloud Storage.", "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource" }, "storageSourceManifest": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest", "description": "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)." }, "gitSource": { "description": "If provided, get the source from this Git repository.", "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1GitSource" }, "repoSource": { "description": "If provided, get the source from this location in a Cloud Source Repository.", "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1RepoSource" }, "connectedRepository": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1ConnectedRepository", "description": "Optional. If provided, get the source from this 2nd-gen Google Cloud Build repository resource." } }, "type": "object", "description": "Location of the source in a supported storage service." }, "RelationshipNote": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of relationship between the source and target SPDX elements", "enum": [ "RELATIONSHIP_TYPE_UNSPECIFIED", "DESCRIBES", "DESCRIBED_BY", "CONTAINS", "CONTAINED_BY", "DEPENDS_ON", "DEPENDENCY_OF", "DEPENDENCY_MANIFEST_OF", "BUILD_DEPENDENCY_OF", "DEV_DEPENDENCY_OF", "OPTIONAL_DEPENDENCY_OF", "PROVIDED_DEPENDENCY_OF", "TEST_DEPENDENCY_OF", "RUNTIME_DEPENDENCY_OF", "EXAMPLE_OF", "GENERATES", "GENERATED_FROM", "ANCESTOR_OF", "DESCENDANT_OF", "VARIANT_OF", "DISTRIBUTION_ARTIFACT", "PATCH_FOR", "PATCH_APPLIED", "COPY_OF", "FILE_ADDED", "FILE_DELETED", "FILE_MODIFIED", "EXPANDED_FROM_ARCHIVE", "DYNAMIC_LINK", "STATIC_LINK", "DATA_FILE_OF", "TEST_CASE_OF", "BUILD_TOOL_OF", "DEV_TOOL_OF", "TEST_OF", "TEST_TOOL_OF", "DOCUMENTATION_OF", "OPTIONAL_COMPONENT_OF", "METAFILE_OF", "PACKAGE_OF", "AMENDS", "PREREQUISITE_FOR", "HAS_PREREQUISITE", "OTHER" ], "enumDescriptions": [ "Unspecified", "Is to be used when SPDXRef-DOCUMENT describes SPDXRef-A", "Is to be used when SPDXRef-A is described by SPDXREF-Document", "Is to be used when SPDXRef-A contains SPDXRef-B", "Is to be used when SPDXRef-A is contained by SPDXRef-B", "Is to be used when SPDXRef-A depends on SPDXRef-B", "Is to be used when SPDXRef-A is dependency of SPDXRef-B", "Is to be used when SPDXRef-A is a manifest file that lists a set of dependencies for SPDXRef-B", "Is to be used when SPDXRef-A is a build dependency of SPDXRef-B", "Is to be used when SPDXRef-A is a development dependency of SPDXRef-B", "Is to be used when SPDXRef-A is an optional dependency of SPDXRef-B", "Is to be used when SPDXRef-A is a to be provided dependency of SPDXRef-B", "Is to be used when SPDXRef-A is a test dependency of SPDXRef-B", "Is to be used when SPDXRef-A is a dependency required for the execution of SPDXRef-B", "Is to be used when SPDXRef-A is an example of SPDXRef-B", "Is to be used when SPDXRef-A generates SPDXRef-B", "Is to be used when SPDXRef-A was generated from SPDXRef-B", "Is to be used when SPDXRef-A is an ancestor (same lineage but pre-dates) SPDXRef-B", "Is to be used when SPDXRef-A is a descendant of (same lineage but postdates) SPDXRef-B", "Is to be used when SPDXRef-A is a variant of (same lineage but not clear which came first) SPDXRef-B", "Is to be used when distributing SPDXRef-A requires that SPDXRef-B also be distributed", "Is to be used when SPDXRef-A is a patch file for (to be applied to) SPDXRef-B", "Is to be used when SPDXRef-A is a patch file that has been applied to SPDXRef-B", "Is to be used when SPDXRef-A is an exact copy of SPDXRef-B", "Is to be used when SPDXRef-A is a file that was added to SPDXRef-B", "Is to be used when SPDXRef-A is a file that was deleted from SPDXRef-B", "Is to be used when SPDXRef-A is a file that was modified from SPDXRef-B", "Is to be used when SPDXRef-A is expanded from the archive SPDXRef-B", "Is to be used when SPDXRef-A dynamically links to SPDXRef-B", "Is to be used when SPDXRef-A statically links to SPDXRef-B", "Is to be used when SPDXRef-A is a data file used in SPDXRef-B", "Is to be used when SPDXRef-A is a test case used in testing SPDXRef-B", "Is to be used when SPDXRef-A is used to build SPDXRef-B", "Is to be used when SPDXRef-A is used as a development tool for SPDXRef-B", "Is to be used when SPDXRef-A is used for testing SPDXRef-B", "Is to be used when SPDXRef-A is used as a test tool for SPDXRef-B", "Is to be used when SPDXRef-A provides documentation of SPDXRef-B", "Is to be used when SPDXRef-A is an optional component of SPDXRef-B", "Is to be used when SPDXRef-A is a metafile of SPDXRef-B", "Is to be used when SPDXRef-A is used as a package as part of SPDXRef-B", "Is to be used when (current) SPDXRef-DOCUMENT amends the SPDX information in SPDXRef-B", "Is to be used when SPDXRef-A is a prerequisite for SPDXRef-B", "Is to be used when SPDXRef-A has as a prerequisite SPDXRef-B", "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" ] } }, "id": "RelationshipNote", "description": "RelationshipNote represents an SPDX Relationship section: https://spdx.github.io/spdx-spec/7-relationships-between-SPDX-elements/" }, "DSSEAttestationNote": { "properties": { "hint": { "description": "DSSEHint hints at the purpose of the attestation authority.", "$ref": "DSSEHint" } }, "description": "A note describing an attestation", "id": "DSSEAttestationNote", "type": "object" }, "Command": { "properties": { "name": { "description": "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`.", "type": "string" }, "args": { "description": "Command-line arguments used when executing this Command.", "type": "array", "items": { "type": "string" } }, "waitFor": { "type": "array", "items": { "type": "string" }, "description": "The ID(s) of the Command(s) that this Command depends on." }, "dir": { "type": "string", "description": "Working directory (relative to project source root) used when running this Command." }, "id": { "type": "string", "description": "Optional unique identifier for this Command, used in wait_for to reference this Command as a dependency." }, "env": { "type": "array", "items": { "type": "string" }, "description": "Environment variables set before running this Command." } }, "description": "Command describes a step performed as part of the build pipeline.", "type": "object", "id": "Command" }, "ComplianceNote": { "properties": { "rationale": { "description": "A rationale for the existence of this compliance check.", "type": "string" }, "scanInstructions": { "description": "Serialized scan instructions with a predefined format.", "format": "byte", "type": "string" }, "remediation": { "description": "A description of remediation steps if the compliance check fails.", "type": "string" }, "description": { "type": "string", "description": "A description about this compliance check." }, "impact": { "description": "Potential impact of the suggested remediation", "type": "string" }, "cisBenchmark": { "$ref": "CisBenchmark", "description": "Right now we only have one compliance type, but we may add additional types in the future." }, "version": { "items": { "$ref": "ComplianceVersion" }, "type": "array", "description": "The OS and config versions the benchmark applies to." }, "title": { "description": "The title that identifies this compliance check.", "type": "string" } }, "type": "object", "description": "ComplianceNote encapsulates all information about a specific compliance check.", "id": "ComplianceNote" }, "ResourceDescriptor": { "id": "ResourceDescriptor", "properties": { "content": { "format": "byte", "type": "string" }, "name": { "type": "string" }, "uri": { "type": "string" }, "downloadLocation": { "type": "string" }, "digest": { "type": "object", "additionalProperties": { "type": "string" } }, "mediaType": { "type": "string" }, "annotations": { "type": "object", "additionalProperties": { "type": "any" } } }, "type": "object" }, "ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsPythonPackage": { "type": "object", "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsPythonPackage", "properties": { "paths": { "type": "array", "items": { "type": "string" }, "description": "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": { "type": "string", "description": "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." } }, "description": "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." }, "GoogleDevtoolsContaineranalysisV1alpha1AliasContext": { "properties": { "name": { "type": "string", "description": "The alias name." }, "kind": { "description": "The alias kind.", "enumDescriptions": [ "Unknown.", "Git tag.", "Git branch.", "Used to specify non-standard aliases. For example, if a Git repo has a ref named \"refs/foo/bar\"." ], "enum": [ "KIND_UNSPECIFIED", "FIXED", "MOVABLE", "OTHER" ], "type": "string" } }, "type": "object", "description": "An alias to a repo revision.", "id": "GoogleDevtoolsContaineranalysisV1alpha1AliasContext" }, "ListScanConfigsResponse": { "type": "object", "description": "A list of scan configs for the project.", "id": "ListScanConfigsResponse", "properties": { "scanConfigs": { "type": "array", "items": { "$ref": "ScanConfig" }, "description": "The set of scan configs." }, "nextPageToken": { "description": "A page token to pass in order to get more scan configs.", "type": "string" } } }, "VulnerabilityLocation": { "properties": { "fileLocation": { "items": { "$ref": "FileLocation" }, "description": "The file location at which this package was found.", "type": "array" }, "package": { "type": "string", "description": "The package being described." }, "version": { "$ref": "Version", "description": "The version of the package being described. This field can be used as a filter in list requests." }, "cpeUri": { "type": "string", "description": "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." } }, "id": "VulnerabilityLocation", "type": "object", "description": "The location of the vulnerability" }, "FileNote": { "id": "FileNote", "type": "object", "description": "FileNote represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/", "properties": { "fileType": { "type": "string", "enum": [ "FILE_TYPE_UNSPECIFIED", "SOURCE", "BINARY", "ARCHIVE", "APPLICATION", "AUDIO", "IMAGE", "TEXT", "VIDEO", "DOCUMENTATION", "SPDX", "OTHER" ], "description": "This field provides information about the type of file identified", "enumDescriptions": [ "Unspecified", "The file is human readable source code (.c, .html, etc.)", "The file is a compiled object, target image or binary executable (.o, .a, etc.)", "The file represents an archive (.tar, .jar, etc.)", "The file is associated with a specific application type (MIME type of application/*)", "The file is associated with an audio file (MIME type of audio/* , e.g. .mp3)", "The file is associated with an picture image file (MIME type of image/*, e.g., .jpg, .gif)", "The file is human readable text file (MIME type of text/*)", "The file is associated with a video file type (MIME type of video/*)", "The file serves as documentation", "The file is an SPDX document", "The file doesn't fit into the above categories (generated artifacts, data files, etc.)" ] }, "checksum": { "description": "Provide a unique identifier to match analysis information on each specific file in a package", "type": "array", "items": { "type": "string" } }, "title": { "type": "string", "description": "Identify the full path and filename that corresponds to the file information in this section" } } }, "ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage": { "properties": { "repository": { "description": "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.", "type": "string" }, "packagePath": { "description": "Path to the package.json. e.g. workspace/path/to/package", "type": "string" } }, "description": "Npm package to upload to Artifact Registry upon successful completion of all build steps.", "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage", "type": "object" }, "ContaineranalysisGoogleDevtoolsCloudbuildV1BuildApproval": { "type": "object", "description": "BuildApproval describes a build's approval configuration, state, and result.", "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1BuildApproval", "properties": { "config": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalConfig", "description": "Output only. Configuration for manual approval of this build.", "readOnly": true }, "result": { "description": "Output only. Result of manual approval for this Build.", "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalResult", "readOnly": true }, "state": { "enumDescriptions": [ "Default enum type. This should not be used.", "Build approval is pending.", "Build approval has been approved.", "Build approval has been rejected.", "Build was cancelled while it was still pending approval." ], "readOnly": true, "description": "Output only. The state of this build's approval.", "enum": [ "STATE_UNSPECIFIED", "PENDING", "APPROVED", "REJECTED", "CANCELLED" ], "type": "string" } } }, "DSSEHint": { "description": "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.", "type": "object", "id": "DSSEHint", "properties": { "humanReadableName": { "type": "string", "description": "Required. The human readable name of this attestation authority, for example \"cloudbuild-prod\"." } } }, "ComplianceOccurrence": { "id": "ComplianceOccurrence", "description": "An indication that the compliance checks in the associated ComplianceNote were not satisfied for particular resources or a specified reason.", "type": "object", "properties": { "nonComplianceReason": { "description": "The reason for non compliance of these files.", "type": "string" }, "nonCompliantFiles": { "type": "array", "description": "A list of files which are violating compliance checks.", "items": { "$ref": "NonCompliantFile" } } } }, "Discovered": { "type": "object", "id": "Discovered", "description": "Provides information about the scan status of a discovered resource.", "properties": { "sbomStatus": { "description": "Output only. The status of an SBOM generation.", "$ref": "SBOMStatus", "readOnly": true }, "analysisError": { "type": "array", "description": "Indicates any errors encountered during analysis of a resource. There could be 0 or more of these errors.", "items": { "$ref": "Status" } }, "cpe": { "description": "The CPE of the resource being scanned.", "type": "string" }, "continuousAnalysis": { "description": "Whether the resource is continuously analyzed.", "enum": [ "CONTINUOUS_ANALYSIS_UNSPECIFIED", "ACTIVE", "INACTIVE" ], "enumDescriptions": [ "Unknown", "The resource is continuously analyzed.", "The resource is ignored for continuous analysis." ], "type": "string" }, "analysisCompleted": { "$ref": "AnalysisCompleted", "description": "The list of analysis that were completed for a resource." }, "operation": { "$ref": "Operation", "description": "Output only. An operation that indicates the status of the current scan. This field is deprecated, do not use." }, "analysisStatus": { "type": "string", "enum": [ "ANALYSIS_STATUS_UNSPECIFIED", "PENDING", "SCANNING", "COMPLETE", "FINISHED_SUCCESS", "FINISHED_FAILED", "FINISHED_UNSUPPORTED" ], "description": "The status of discovery for the resource.", "enumDescriptions": [ "Unknown", "Resource is known but no action has been taken yet.", "Resource is being analyzed.", "Analysis has completed", "Analysis has finished successfully.", "Analysis has finished unsuccessfully, the analysis itself is in a bad state.", "The resource is known not to be supported." ] }, "lastScanTime": { "description": "The last time this resource was scanned.", "format": "google-datetime", "type": "string" }, "archiveTime": { "description": "The time occurrences related to this discovery occurrence were archived.", "format": "google-datetime", "type": "string" }, "analysisStatusError": { "$ref": "Status", "description": "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." } } }, "VulnerabilityType": { "type": "object", "id": "VulnerabilityType", "description": "VulnerabilityType provides metadata about a security vulnerability.", "properties": { "severity": { "enumDescriptions": [ "Unknown Impact", "Minimal Impact", "Low Impact", "Medium Impact", "High Impact", "Critical Impact" ], "description": "Note provider assigned impact of the vulnerability", "type": "string", "enum": [ "SEVERITY_UNSPECIFIED", "MINIMAL", "LOW", "MEDIUM", "HIGH", "CRITICAL" ] }, "cvssScore": { "format": "float", "description": "The CVSS score for this Vulnerability.", "type": "number" }, "details": { "description": "All information about the package to specifically identify this vulnerability. One entry per (version range and cpe_uri) the package vulnerability has manifested in.", "type": "array", "items": { "$ref": "Detail" } }, "cvssVersion": { "description": "CVSS version used to populate cvss_score and severity.", "enum": [ "CVSS_VERSION_UNSPECIFIED", "CVSS_VERSION_2", "CVSS_VERSION_3" ], "type": "string", "enumDescriptions": [ "CVSS Version unspecified.", "CVSS v2.", "CVSS v3." ] }, "cvssV2": { "description": "The full description of the CVSS for version 2.", "$ref": "CVSS" }, "cwe": { "items": { "type": "string" }, "description": "A list of CWE for this vulnerability. For details, see: https://cwe.mitre.org/index.html", "type": "array" } } }, "Digest": { "type": "object", "properties": { "digestBytes": { "type": "string", "format": "byte", "description": "Value of the digest." }, "algo": { "description": "`SHA1`, `SHA512` etc.", "type": "string" } }, "description": "Digest information.", "id": "Digest" }, "Expr": { "properties": { "expression": { "type": "string", "description": "Textual representation of an expression in Common Expression Language syntax." }, "title": { "type": "string", "description": "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." }, "description": { "description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.", "type": "string" }, "location": { "description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.", "type": "string" } }, "id": "Expr", "type": "object", "description": "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() \u003c 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." }, "BuildSignature": { "description": "Message encapsulating the signature of the verified build.", "type": "object", "id": "BuildSignature", "properties": { "keyType": { "enum": [ "KEY_TYPE_UNSPECIFIED", "PGP_ASCII_ARMORED", "PKIX_PEM" ], "description": "The type of the key, either stored in `public_key` or referenced in `key_id`", "type": "string", "enumDescriptions": [ "`KeyType` is not set.", "`PGP ASCII Armored` public key.", "`PKIX PEM` public key." ] }, "publicKey": { "description": "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`", "type": "string" }, "keyId": { "type": "string", "description": "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)." }, "signature": { "description": "Signature of the related `BuildProvenance`, encoded in a base64 string.", "type": "string" } } }, "ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions": { "description": "Optional arguments to enable specific features of builds.", "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions", "properties": { "workerPool": { "deprecated": true, "type": "string", "description": "This field deprecated; please use `pool.name` instead." }, "env": { "type": "array", "description": "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\".", "items": { "type": "string" } }, "requestedVerifyOption": { "description": "Requested verifiability options.", "type": "string", "enum": [ "NOT_VERIFIED", "VERIFIED" ], "enumDescriptions": [ "Not a verifiable build (the default).", "Build must be verified." ] }, "volumes": { "description": "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.", "items": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1Volume" }, "type": "array" }, "logging": { "type": "string", "description": "Option to specify the logging mode, which determines if and where build logs are stored.", "enum": [ "LOGGING_UNSPECIFIED", "LEGACY", "GCS_ONLY", "STACKDRIVER_ONLY", "CLOUD_LOGGING_ONLY", "NONE" ], "enumDeprecated": [ false, false, false, true, false, false ], "enumDescriptions": [ "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.", "Build logs are stored in Cloud Logging and Cloud Storage.", "Build logs are stored in Cloud Storage.", "This option is the same as 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).", "Turn off all logging. No build logs will be captured." ] }, "logStreamingOption": { "enum": [ "STREAM_DEFAULT", "STREAM_ON", "STREAM_OFF" ], "type": "string", "enumDescriptions": [ "Service may automatically determine build log streaming behavior.", "Build logs should be streamed to Cloud Storage.", "Build logs should not be streamed to Cloud Storage; they will be written when the build is completed." ], "description": "Option to define build log streaming behavior to Cloud Storage." }, "machineType": { "enumDescriptions": [ "Standard machine type.", "Highcpu machine with 8 CPUs.", "Highcpu machine with 32 CPUs.", "Highcpu e2 machine with 8 CPUs.", "Highcpu e2 machine with 32 CPUs.", "E2 machine with 1 CPU." ], "type": "string", "enum": [ "UNSPECIFIED", "N1_HIGHCPU_8", "N1_HIGHCPU_32", "E2_HIGHCPU_8", "E2_HIGHCPU_32", "E2_MEDIUM" ], "description": "Compute Engine machine type on which to run the build.", "enumDeprecated": [ false, true, true, false, false, false ] }, "substitutionOption": { "description": "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.", "enum": [ "MUST_MATCH", "ALLOW_LOOSE" ], "enumDescriptions": [ "Fails the build if error in substitutions checks, like missing a substitution in the template or in the map.", "Do not fail the build if error in substitutions checks." ], "type": "string" }, "automapSubstitutions": { "description": "Option to include built-in and custom substitutions as env variables for all build steps.", "type": "boolean" }, "pool": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption", "description": "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." }, "sourceProvenanceHash": { "type": "array", "items": { "enum": [ "NONE", "SHA256", "MD5", "SHA512" ], "type": "string", "enumDescriptions": [ "No hash requested.", "Use a sha256 hash.", "Use a md5 hash.", "Use a sha512 hash." ] }, "description": "Requested hash for SourceProvenance." }, "diskSizeGb": { "format": "int64", "type": "string", "description": "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 2000GB; builds that request more than the maximum are rejected with an error." }, "dynamicSubstitutions": { "type": "boolean", "description": "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." }, "secretEnv": { "description": "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.", "type": "array", "items": { "type": "string" } }, "defaultLogsBucketBehavior": { "enumDescriptions": [ "Unspecified.", "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." ], "enum": [ "DEFAULT_LOGS_BUCKET_BEHAVIOR_UNSPECIFIED", "REGIONAL_USER_OWNED_BUCKET" ], "type": "string", "description": "Optional. Option to specify how default logs buckets are setup." } }, "type": "object" }, "UpdateOperationRequest": { "type": "object", "description": "Request for updating an existing operation", "id": "UpdateOperationRequest", "properties": { "updateMask": { "format": "google-fieldmask", "type": "string", "description": "The fields to update." }, "operation": { "description": "The operation to create.", "$ref": "Operation" } } }, "ContaineranalysisGoogleDevtoolsCloudbuildV1Build": { "description": "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.", "properties": { "sourceProvenance": { "description": "Output only. A permanent fixed identifier for source.", "readOnly": true, "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1SourceProvenance" }, "name": { "readOnly": true, "type": "string", "description": "Output only. The 'Build' name with format: `projects/{project}/locations/{location}/builds/{build}`, where {build} is a unique identifier generated by the service." }, "queueTtl": { "format": "google-duration", "description": "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.", "type": "string" }, "createTime": { "type": "string", "readOnly": true, "format": "google-datetime", "description": "Output only. Time at which the request to create the build was received." }, "failureInfo": { "description": "Output only. Contains information about the build when status=FAILURE.", "readOnly": true, "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1BuildFailureInfo" }, "finishTime": { "description": "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.", "format": "google-datetime", "readOnly": true, "type": "string" }, "timeout": { "description": "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.", "type": "string", "format": "google-duration" }, "source": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1Source", "description": "The location of the source files to build." }, "images": { "type": "array", "items": { "type": "string" }, "description": "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`." }, "warnings": { "items": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1BuildWarning" }, "description": "Output only. Non-fatal problems encountered during the execution of the build.", "readOnly": true, "type": "array" }, "tags": { "type": "array", "description": "Tags for annotation of a `Build`. These are not docker tags.", "items": { "type": "string" } }, "availableSecrets": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1Secrets", "description": "Secrets and secret environment variables." }, "buildTriggerId": { "description": "Output only. The ID of the `BuildTrigger` that triggered this build, if it was triggered automatically.", "readOnly": true, "type": "string" }, "substitutions": { "additionalProperties": { "type": "string" }, "description": "Substitutions data for `Build` resource.", "type": "object" }, "serviceAccount": { "type": "string", "description": "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. " }, "secrets": { "type": "array", "description": "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", "items": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1Secret" } }, "logUrl": { "type": "string", "readOnly": true, "description": "Output only. URL to logs for this build in Google Cloud Console." }, "results": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1Results", "description": "Output only. Results of the build.", "readOnly": true }, "artifacts": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts", "description": "Artifacts produced by the build that should be uploaded upon successful completion of all build steps." }, "status": { "readOnly": true, "description": "Output only. Status of the build.", "type": "string", "enumDescriptions": [ "Status of the build is unknown.", "Build has been created and is pending execution and queuing. It has not been queued.", "Build or step is queued; work has not yet begun.", "Build or step is being executed.", "Build or step finished successfully.", "Build or step failed to complete successfully.", "Build or step failed due to an internal cause.", "Build or step took longer than was allowed.", "Build or step was canceled by a user.", "Build was enqueued for longer than the value of `queue_ttl`." ], "enum": [ "STATUS_UNKNOWN", "PENDING", "QUEUED", "WORKING", "SUCCESS", "FAILURE", "INTERNAL_ERROR", "TIMEOUT", "CANCELLED", "EXPIRED" ] }, "statusDetail": { "description": "Output only. Customer-readable message about the current status.", "readOnly": true, "type": "string" }, "startTime": { "type": "string", "description": "Output only. Time at which execution of the build was started.", "format": "google-datetime", "readOnly": true }, "approval": { "description": "Output only. Describes this build's approval configuration, status, and result.", "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1BuildApproval", "readOnly": true }, "steps": { "type": "array", "description": "Required. The operations to be performed on the workspace.", "items": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep" } }, "options": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptions", "description": "Special options for this build." }, "projectId": { "type": "string", "description": "Output only. ID of the project.", "readOnly": true }, "timing": { "readOnly": true, "description": "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.", "additionalProperties": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan" }, "type": "object" }, "id": { "readOnly": true, "description": "Output only. Unique identifier of the build.", "type": "string" }, "logsBucket": { "description": "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`.", "type": "string" } }, "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1Build", "type": "object" }, "VulnerabilityAssessmentNote": { "type": "object", "properties": { "languageCode": { "type": "string", "description": "Identifies the language used by this document, corresponding to IETF BCP 47 / RFC 5646." }, "product": { "description": "The product affected by this vex.", "$ref": "Product" }, "shortDescription": { "description": "A one sentence description of this Vex.", "type": "string" }, "title": { "description": "The title of the note. E.g. `Vex-Debian-11.4`", "type": "string" }, "assessment": { "description": "Represents a vulnerability assessment for the product.", "$ref": "Assessment" }, "longDescription": { "type": "string", "description": "A detailed description of this Vex." }, "publisher": { "$ref": "Publisher", "description": "Publisher details of this Note." } }, "id": "VulnerabilityAssessmentNote", "description": "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." }, "PackageInfoOccurrence": { "id": "PackageInfoOccurrence", "type": "object", "description": "PackageInfoOccurrence represents an SPDX Package Information section: https://spdx.github.io/spdx-spec/3-package-information/", "properties": { "comment": { "description": "A place for the SPDX file creator to record any general comments about the package being described", "type": "string" }, "licenseConcluded": { "$ref": "License", "description": "package or alternative values, if the governing license cannot be determined" }, "filename": { "type": "string", "description": "Provide the actual file name of the package, or path of the directory being treated as a package" }, "id": { "type": "string", "description": "Uniquely identify any element in an SPDX document which may be referenced by other elements" }, "packageType": { "description": "Output only. The type of package: OS, MAVEN, GO, GO_STDLIB, etc.", "type": "string", "readOnly": true }, "sourceInfo": { "type": "string", "description": "Provide a place for the SPDX file creator to record any relevant background information or additional comments about the origin of the package" }, "title": { "description": "Output only. Identify the full name of the package as given by the Package Originator", "readOnly": true, "type": "string" }, "summaryDescription": { "type": "string", "description": "Output only. A short description of the package", "readOnly": true }, "homePage": { "description": "Output only. Provide a place for the SPDX file creator to record a web site that serves as the package's home page", "type": "string", "readOnly": true }, "version": { "readOnly": true, "type": "string", "description": "Output only. Identify the version of the package" } } }, "FileLocation": { "id": "FileLocation", "description": "Indicates the location at which a package was found.", "type": "object", "properties": { "filePath": { "type": "string", "description": "For jars that are contained inside .war files, this filepath can indicate the path to war file combined with the path to jar file." } } }, "Distribution": { "properties": { "cpeUri": { "description": "The cpe_uri in [cpe format](https://cpe.mitre.org/specification/) denoting the package manager version distributing a package.", "type": "string" }, "architecture": { "type": "string", "enum": [ "ARCHITECTURE_UNSPECIFIED", "X86", "X64" ], "description": "The CPU architecture for which packages in this distribution channel were built", "enumDescriptions": [ "Unknown architecture", "X86 architecture", "X64 architecture" ] }, "latestVersion": { "description": "The latest available version of this package in this distribution channel.", "$ref": "Version" }, "maintainer": { "description": "A freeform string denoting the maintainer of this package.", "type": "string" }, "description": { "type": "string", "description": "The distribution channel-specific description of this package." }, "url": { "description": "The distribution channel-specific homepage for this package.", "type": "string" } }, "id": "Distribution", "type": "object", "description": "This represents a particular channel of distribution for a given package. e.g. Debian's jessie-backports dpkg mirror" }, "ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource": { "properties": { "sourceFetcher": { "enum": [ "SOURCE_FETCHER_UNSPECIFIED", "GSUTIL", "GCS_FETCHER" ], "type": "string", "enumDescriptions": [ "Unspecified defaults to GSUTIL.", "Use the \"gsutil\" tool to download the source file.", "Use the Cloud Storage Fetcher tool to download the source file." ], "description": "Optional. Option to specify the tool to fetch the source file for the build." }, "object": { "description": "Cloud Storage object containing the source. This object must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) containing source to build.", "type": "string" }, "bucket": { "description": "Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).", "type": "string" }, "generation": { "format": "int64", "type": "string", "description": "Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used." } }, "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource", "description": "Location of the source in an archive file in Cloud Storage.", "type": "object" }, "ContaineranalysisGoogleDevtoolsCloudbuildV1Secrets": { "properties": { "secretManager": { "items": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1SecretManagerSecret" }, "description": "Secrets in Secret Manager and associated secret environment variable.", "type": "array" }, "inline": { "items": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1InlineSecret" }, "type": "array", "description": "Secrets encrypted with KMS key and the associated secret environment variable." } }, "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1Secrets", "type": "object", "description": "Secrets and secret environment variables." }, "CVSS": { "description": "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", "type": "object", "properties": { "exploitabilityScore": { "format": "float", "type": "number" }, "authentication": { "description": "Defined in CVSS v2", "enumDescriptions": [ "Defined in CVSS v2", "Defined in CVSS v2", "Defined in CVSS v2", "Defined in CVSS v2" ], "enum": [ "AUTHENTICATION_UNSPECIFIED", "AUTHENTICATION_MULTIPLE", "AUTHENTICATION_SINGLE", "AUTHENTICATION_NONE" ], "type": "string" }, "privilegesRequired": { "description": "Defined in CVSS v3", "enum": [ "PRIVILEGES_REQUIRED_UNSPECIFIED", "PRIVILEGES_REQUIRED_NONE", "PRIVILEGES_REQUIRED_LOW", "PRIVILEGES_REQUIRED_HIGH" ], "enumDescriptions": [ "Defined in CVSS v3", "Defined in CVSS v3", "Defined in CVSS v3", "Defined in CVSS v3" ], "type": "string" }, "impactScore": { "format": "float", "type": "number" }, "integrityImpact": { "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", "IMPACT_LOW", "IMPACT_NONE", "IMPACT_PARTIAL", "IMPACT_COMPLETE" ], "enumDescriptions": [ "Defined in CVSS v3, CVSS v2", "Defined in CVSS v3", "Defined in CVSS v3", "Defined in CVSS v3, CVSS v2", "Defined in CVSS v2", "Defined in CVSS v2" ], "type": "string", "description": "Defined in CVSS v3, CVSS v2" }, "confidentialityImpact": { "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", "IMPACT_LOW", "IMPACT_NONE", "IMPACT_PARTIAL", "IMPACT_COMPLETE" ], "enumDescriptions": [ "Defined in CVSS v3, CVSS v2", "Defined in CVSS v3", "Defined in CVSS v3", "Defined in CVSS v3, CVSS v2", "Defined in CVSS v2", "Defined in CVSS v2" ], "type": "string", "description": "Defined in CVSS v3, CVSS v2" }, "userInteraction": { "enum": [ "USER_INTERACTION_UNSPECIFIED", "USER_INTERACTION_NONE", "USER_INTERACTION_REQUIRED" ], "enumDescriptions": [ "Defined in CVSS v3", "Defined in CVSS v3", "Defined in CVSS v3" ], "type": "string", "description": "Defined in CVSS v3" }, "availabilityImpact": { "type": "string", "description": "Defined in CVSS v3, CVSS v2", "enum": [ "IMPACT_UNSPECIFIED", "IMPACT_HIGH", "IMPACT_LOW", "IMPACT_NONE", "IMPACT_PARTIAL", "IMPACT_COMPLETE" ], "enumDescriptions": [ "Defined in CVSS v3, CVSS v2", "Defined in CVSS v3", "Defined in CVSS v3", "Defined in CVSS v3, CVSS v2", "Defined in CVSS v2", "Defined in CVSS v2" ] }, "attackComplexity": { "type": "string", "description": "Defined in CVSS v3, CVSS v2", "enumDescriptions": [ "Defined in CVSS v3, CVSS v2", "Defined in CVSS v3, CVSS v2", "Defined in CVSS v3, CVSS v2", "Defined in CVSS v2" ], "enum": [ "ATTACK_COMPLEXITY_UNSPECIFIED", "ATTACK_COMPLEXITY_LOW", "ATTACK_COMPLEXITY_HIGH", "ATTACK_COMPLEXITY_MEDIUM" ] }, "baseScore": { "description": "The base score is a function of the base metric scores.", "format": "float", "type": "number" }, "attackVector": { "enumDescriptions": [ "Defined in CVSS v3, CVSS v2", "Defined in CVSS v3, CVSS v2", "Defined in CVSS v3, CVSS v2", "Defined in CVSS v3, CVSS v2", "Defined in CVSS v3" ], "enum": [ "ATTACK_VECTOR_UNSPECIFIED", "ATTACK_VECTOR_NETWORK", "ATTACK_VECTOR_ADJACENT", "ATTACK_VECTOR_LOCAL", "ATTACK_VECTOR_PHYSICAL" ], "description": "Base Metrics Represents the intrinsic characteristics of a vulnerability that are constant over time and across user environments. Defined in CVSS v3, CVSS v2", "type": "string" }, "scope": { "description": "Defined in CVSS v3", "enum": [ "SCOPE_UNSPECIFIED", "SCOPE_UNCHANGED", "SCOPE_CHANGED" ], "type": "string", "enumDescriptions": [ "Defined in CVSS v3", "Defined in CVSS v3", "Defined in CVSS v3" ] } }, "id": "CVSS" }, "Material": { "description": "Material is a material used in the generation of the provenance", "id": "Material", "properties": { "digest": { "description": "digest is a map from a hash algorithm (e.g. sha256) to the value in the material", "additionalProperties": { "type": "string" }, "type": "object" }, "uri": { "type": "string", "description": "uri is the uri of the material" } }, "type": "object" }, "GoogleDevtoolsContaineranalysisV1alpha1RepoId": { "properties": { "projectRepoId": { "$ref": "GoogleDevtoolsContaineranalysisV1alpha1ProjectRepoId", "description": "A combination of a project ID and a repo name." }, "uid": { "description": "A server-assigned, globally unique identifier.", "type": "string" } }, "description": "A unique identifier for a Cloud Repo.", "type": "object", "id": "GoogleDevtoolsContaineranalysisV1alpha1RepoId" }, "FileOccurrence": { "description": "FileOccurrence represents an SPDX File Information section: https://spdx.github.io/spdx-spec/4-file-information/", "type": "object", "properties": { "contributors": { "type": "array", "items": { "type": "string" }, "description": "This field provides a place for the SPDX file creator to record file contributors" }, "licenseConcluded": { "description": "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", "$ref": "License" }, "filesLicenseInfo": { "type": "array", "description": "This field contains the license information actually found in the file, if any", "items": { "type": "string" } }, "id": { "type": "string", "description": "Uniquely identify any element in an SPDX document which may be referenced by other elements" }, "comment": { "description": "This field provides a place for the SPDX file creator to record any general comments about the file", "type": "string" }, "attributions": { "items": { "type": "string" }, "type": "array", "description": "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" }, "notice": { "type": "string", "description": "This field provides a place for the SPDX file creator to record license notices or other such related notices found in the file" }, "copyright": { "type": "string", "description": "Identify the copyright holder of the file, as well as any dates present" } }, "id": "FileOccurrence" }, "Recipe": { "description": "Steps taken to build the artifact. For a TaskRun, typically each container corresponds to one step in the recipe.", "id": "Recipe", "type": "object", "properties": { "arguments": { "items": { "type": "object", "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." } }, "type": "array", "description": "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": { "type": "string", "format": "int64", "description": "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." }, "environment": { "description": "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.", "items": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } }, "type": "array" }, "type": { "description": "URI indicating what type of recipe was performed. It determines the meaning of recipe.entryPoint, recipe.arguments, recipe.environment, and materials.", "type": "string" }, "entryPoint": { "description": "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.", "type": "string" } } }, "GoogleDevtoolsContaineranalysisV1alpha1ProjectRepoId": { "id": "GoogleDevtoolsContaineranalysisV1alpha1ProjectRepoId", "description": "Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project.", "properties": { "repoName": { "description": "The name of the repo. Leave empty for the default repo.", "type": "string" }, "projectId": { "type": "string", "description": "The ID of the project." } }, "type": "object" }, "Remediation": { "id": "Remediation", "description": "Specifies details on how to handle (and presumably, fix) a vulnerability.", "properties": { "details": { "description": "Contains a comprehensive human-readable discussion of the remediation.", "type": "string" }, "remediationUri": { "$ref": "URI", "description": "Contains the URL where to obtain the remediation." }, "remediationType": { "description": "The type of remediation that can be applied.", "enum": [ "REMEDIATION_TYPE_UNSPECIFIED", "MITIGATION", "NO_FIX_PLANNED", "NONE_AVAILABLE", "VENDOR_FIX", "WORKAROUND" ], "enumDescriptions": [ "No remediation type specified.", "A MITIGATION is available.", "No fix is planned.", "Not available.", "A vendor fix is available.", "A workaround is available." ], "type": "string" } }, "type": "object" }, "ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan": { "properties": { "startTime": { "format": "google-datetime", "type": "string", "description": "Start of time span." }, "endTime": { "description": "End of time span.", "type": "string", "format": "google-datetime" } }, "description": "Start and end times for a build execution phase.", "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan", "type": "object" }, "SlsaMetadata": { "id": "SlsaMetadata", "properties": { "buildStartedOn": { "format": "google-datetime", "description": "The timestamp of when the build started.", "type": "string" }, "completeness": { "description": "Indicates that the builder claims certain fields in this message to be complete.", "$ref": "SlsaCompleteness" }, "buildFinishedOn": { "description": "The timestamp of when the build completed.", "type": "string", "format": "google-datetime" }, "reproducible": { "type": "boolean", "description": "If true, the builder claims that running the recipe on materials will produce bit-for-bit identical output." }, "buildInvocationId": { "description": "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.", "type": "string" } }, "type": "object", "description": "Other properties of the build." }, "Envelope": { "type": "object", "id": "Envelope", "description": "MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type.", "properties": { "payloadType": { "description": "The type of payload being signed", "type": "string" }, "payload": { "format": "byte", "type": "string", "description": "The bytes being signed" }, "signatures": { "description": "The signatures over the payload", "type": "array", "items": { "$ref": "EnvelopeSignature" } } } }, "ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedNpmPackage": { "type": "object", "properties": { "pushTiming": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1TimeSpan", "description": "Output only. Stores timing information for pushing the specified artifact.", "readOnly": true }, "uri": { "type": "string", "description": "URI of the uploaded npm package." }, "fileHashes": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1FileHashes", "description": "Hash types and values of the npm package." } }, "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedNpmPackage", "description": "An npm package uploaded to Artifact Registry using the NpmPackage directive." }, "Status": { "type": "object", "description": "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).", "id": "Status", "properties": { "message": { "type": "string", "description": "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." }, "code": { "format": "int32", "description": "The status code, which should be an enum value of google.rpc.Code.", "type": "integer" }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } }, "type": "array" } } }, "SlsaBuilder": { "type": "object", "description": "SlsaBuilder encapsulates the identity of the builder of this provenance.", "properties": { "id": { "description": "id is the id of the slsa provenance builder", "type": "string" } }, "id": "SlsaBuilder" }, "InTotoProvenance": { "id": "InTotoProvenance", "type": "object", "properties": { "recipe": { "description": "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", "$ref": "Recipe" }, "metadata": { "$ref": "Metadata" }, "builderConfig": { "$ref": "BuilderConfig", "description": "required" }, "materials": { "description": "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.", "items": { "type": "string" }, "type": "array" } } }, "RelationshipOccurrence": { "type": "object", "properties": { "source": { "description": "Also referred to as SPDXRef-A The source SPDX element (file, package, etc)", "type": "string" }, "target": { "type": "string", "description": "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" }, "comment": { "type": "string", "description": "A place for the SPDX file creator to record any general comments about the relationship" }, "type": { "description": "Output only. The type of relationship between the source and target SPDX elements", "readOnly": true, "enumDescriptions": [ "Unspecified", "Is to be used when SPDXRef-DOCUMENT describes SPDXRef-A", "Is to be used when SPDXRef-A is described by SPDXREF-Document", "Is to be used when SPDXRef-A contains SPDXRef-B", "Is to be used when SPDXRef-A is contained by SPDXRef-B", "Is to be used when SPDXRef-A depends on SPDXRef-B", "Is to be used when SPDXRef-A is dependency of SPDXRef-B", "Is to be used when SPDXRef-A is a manifest file that lists a set of dependencies for SPDXRef-B", "Is to be used when SPDXRef-A is a build dependency of SPDXRef-B", "Is to be used when SPDXRef-A is a development dependency of SPDXRef-B", "Is to be used when SPDXRef-A is an optional dependency of SPDXRef-B", "Is to be used when SPDXRef-A is a to be provided dependency of SPDXRef-B", "Is to be used when SPDXRef-A is a test dependency of SPDXRef-B", "Is to be used when SPDXRef-A is a dependency required for the execution of SPDXRef-B", "Is to be used when SPDXRef-A is an example of SPDXRef-B", "Is to be used when SPDXRef-A generates SPDXRef-B", "Is to be used when SPDXRef-A was generated from SPDXRef-B", "Is to be used when SPDXRef-A is an ancestor (same lineage but pre-dates) SPDXRef-B", "Is to be used when SPDXRef-A is a descendant of (same lineage but postdates) SPDXRef-B", "Is to be used when SPDXRef-A is a variant of (same lineage but not clear which came first) SPDXRef-B", "Is to be used when distributing SPDXRef-A requires that SPDXRef-B also be distributed", "Is to be used when SPDXRef-A is a patch file for (to be applied to) SPDXRef-B", "Is to be used when SPDXRef-A is a patch file that has been applied to SPDXRef-B", "Is to be used when SPDXRef-A is an exact copy of SPDXRef-B", "Is to be used when SPDXRef-A is a file that was added to SPDXRef-B", "Is to be used when SPDXRef-A is a file that was deleted from SPDXRef-B", "Is to be used when SPDXRef-A is a file that was modified from SPDXRef-B", "Is to be used when SPDXRef-A is expanded from the archive SPDXRef-B", "Is to be used when SPDXRef-A dynamically links to SPDXRef-B", "Is to be used when SPDXRef-A statically links to SPDXRef-B", "Is to be used when SPDXRef-A is a data file used in SPDXRef-B", "Is to be used when SPDXRef-A is a test case used in testing SPDXRef-B", "Is to be used when SPDXRef-A is used to build SPDXRef-B", "Is to be used when SPDXRef-A is used as a development tool for SPDXRef-B", "Is to be used when SPDXRef-A is used for testing SPDXRef-B", "Is to be used when SPDXRef-A is used as a test tool for SPDXRef-B", "Is to be used when SPDXRef-A provides documentation of SPDXRef-B", "Is to be used when SPDXRef-A is an optional component of SPDXRef-B", "Is to be used when SPDXRef-A is a metafile of SPDXRef-B", "Is to be used when SPDXRef-A is used as a package as part of SPDXRef-B", "Is to be used when (current) SPDXRef-DOCUMENT amends the SPDX information in SPDXRef-B", "Is to be used when SPDXRef-A is a prerequisite for SPDXRef-B", "Is to be used when SPDXRef-A has as a prerequisite SPDXRef-B", "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" ], "type": "string", "enum": [ "RELATIONSHIP_TYPE_UNSPECIFIED", "DESCRIBES", "DESCRIBED_BY", "CONTAINS", "CONTAINED_BY", "DEPENDS_ON", "DEPENDENCY_OF", "DEPENDENCY_MANIFEST_OF", "BUILD_DEPENDENCY_OF", "DEV_DEPENDENCY_OF", "OPTIONAL_DEPENDENCY_OF", "PROVIDED_DEPENDENCY_OF", "TEST_DEPENDENCY_OF", "RUNTIME_DEPENDENCY_OF", "EXAMPLE_OF", "GENERATES", "GENERATED_FROM", "ANCESTOR_OF", "DESCENDANT_OF", "VARIANT_OF", "DISTRIBUTION_ARTIFACT", "PATCH_FOR", "PATCH_APPLIED", "COPY_OF", "FILE_ADDED", "FILE_DELETED", "FILE_MODIFIED", "EXPANDED_FROM_ARCHIVE", "DYNAMIC_LINK", "STATIC_LINK", "DATA_FILE_OF", "TEST_CASE_OF", "BUILD_TOOL_OF", "DEV_TOOL_OF", "TEST_OF", "TEST_TOOL_OF", "DOCUMENTATION_OF", "OPTIONAL_COMPONENT_OF", "METAFILE_OF", "PACKAGE_OF", "AMENDS", "PREREQUISITE_FOR", "HAS_PREREQUISITE", "OTHER" ] } }, "description": "RelationshipOccurrence represents an SPDX Relationship section: https://spdx.github.io/spdx-spec/7-relationships-between-SPDX-elements/", "id": "RelationshipOccurrence" }, "Version": { "properties": { "revision": { "description": "The iteration of the package build from the above version.", "type": "string" }, "inclusive": { "description": "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", "type": "boolean" }, "kind": { "enumDescriptions": [ "A standard package version, defined by the other fields.", "A special version representing negative infinity, other fields are ignored.", "A special version representing positive infinity, other fields are ignored." ], "type": "string", "enum": [ "NORMAL", "MINIMUM", "MAXIMUM" ], "description": "Distinguish between sentinel MIN/MAX versions and normal versions. If kind is not NORMAL, then the other fields are ignored." }, "name": { "description": "The main part of the version name.", "type": "string" }, "epoch": { "description": "Used to correct mistakes in the version numbering scheme.", "type": "integer", "format": "int32" } }, "type": "object", "description": "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/", "id": "Version" }, "ProvenanceBuilder": { "id": "ProvenanceBuilder", "type": "object", "properties": { "builderDependencies": { "type": "array", "items": { "$ref": "ResourceDescriptor" } }, "version": { "additionalProperties": { "type": "string" }, "type": "object" }, "id": { "type": "string" } } }, "Subject": { "type": "object", "properties": { "digest": { "additionalProperties": { "type": "string" }, "description": "\"\": \"\" Algorithms can be e.g. sha256, sha512 See https://github.com/in-toto/attestation/blob/main/spec/field_types.md#DigestSet", "type": "object" }, "name": { "description": "name is the name of the Subject used here", "type": "string" } }, "id": "Subject", "description": "Subject refers to the subject of the intoto statement" }, "AnalysisCompleted": { "type": "object", "description": "Indicates which analysis completed successfully. Multiple types of analysis can be performed on a single resource.", "id": "AnalysisCompleted", "properties": { "analysisType": { "items": { "type": "string" }, "description": "type of analysis that were completed on a resource.", "type": "array" } } }, "Installation": { "id": "Installation", "type": "object", "description": "This represents how a particular software package may be installed on a system.", "properties": { "cpeUri": { "description": "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.", "readOnly": true, "type": "string" }, "license": { "description": "Licenses that have been declared by the authors of the package.", "$ref": "License" }, "location": { "description": "All of the places within the filesystem versions of this package have been found.", "items": { "$ref": "Location" }, "type": "array" }, "version": { "readOnly": true, "description": "Output only. The version of the package.", "$ref": "Version" }, "name": { "type": "string", "description": "Output only. The name of the installed package.", "readOnly": true }, "packageType": { "description": "Output only. The type of package; whether native or non native (e.g., ruby gems, node.js packages, etc.).", "type": "string", "readOnly": true }, "architecture": { "type": "string", "enum": [ "ARCHITECTURE_UNSPECIFIED", "X86", "X64" ], "enumDescriptions": [ "Unknown architecture", "X86 architecture", "X64 architecture" ], "readOnly": true, "description": "Output only. The CPU architecture for which packages in this distribution channel were built. Architecture will be blank for language packages." } } }, "PgpSignedAttestation": { "id": "PgpSignedAttestation", "properties": { "signature": { "description": "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.", "type": "string" }, "pgpKeyId": { "description": "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`.", "type": "string" }, "contentType": { "type": "string", "enum": [ "CONTENT_TYPE_UNSPECIFIED", "SIMPLE_SIGNING_JSON" ], "enumDescriptions": [ "`ContentType` is not set.", "Atomic format attestation signature. See https://github.com/containers/image/blob/8a5d2f82a6e3263290c8e0276c3e0f64e77723e7/docs/atomic-signature.md The payload extracted from `signature` is a JSON blob conforming to the linked schema." ], "description": "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)." } }, "type": "object", "description": "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." }, "StorageSource": { "type": "object", "properties": { "generation": { "type": "string", "description": "Google Cloud Storage generation for the object.", "format": "int64" }, "bucket": { "type": "string", "description": "Google Cloud Storage bucket containing source (see [Bucket Name Requirements] (https://cloud.google.com/storage/docs/bucket-naming#requirements))." }, "object": { "type": "string", "description": "Google Cloud Storage object containing source." } }, "id": "StorageSource", "description": "StorageSource describes the location of the source in an archive file in Google Cloud Storage." }, "DocumentNote": { "type": "object", "description": "DocumentNote represents an SPDX Document Creation Infromation section: https://spdx.github.io/spdx-spec/2-document-creation-information/", "properties": { "dataLicence": { "description": "Compliance with the SPDX specification includes populating the SPDX fields therein with data related to such fields (\"SPDX-Metadata\")", "type": "string" }, "spdxVersion": { "type": "string", "description": "Provide a reference number that can be used to understand how to parse and interpret the rest of the file" } }, "id": "DocumentNote" }, "UpgradeOccurrence": { "type": "object", "properties": { "parsedVersion": { "description": "Required - The version of the package in a machine + human readable form.", "$ref": "Version" }, "distribution": { "description": "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.", "$ref": "UpgradeDistribution" }, "package": { "type": "string", "description": "Required - The package this Upgrade is for." } }, "description": "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).", "id": "UpgradeOccurrence" }, "AttestationAuthority": { "description": "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.", "type": "object", "id": "AttestationAuthority", "properties": { "hint": { "$ref": "AttestationAuthorityHint" } } }, "GoogleDevtoolsContaineranalysisV1alpha1SlsaProvenanceZeroTwoSlsaMaterial": { "id": "GoogleDevtoolsContaineranalysisV1alpha1SlsaProvenanceZeroTwoSlsaMaterial", "description": "The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on.", "type": "object", "properties": { "uri": { "type": "string", "description": "The method by which this artifact was referenced during the build." }, "digest": { "additionalProperties": { "type": "string" }, "type": "object", "description": "Collection of cryptographic digests for the contents of this artifact." } } }, "RunDetails": { "properties": { "builder": { "$ref": "ProvenanceBuilder" }, "byproducts": { "items": { "$ref": "ResourceDescriptor" }, "type": "array" }, "metadata": { "$ref": "BuildMetadata" } }, "id": "RunDetails", "type": "object" }, "ContaineranalysisGoogleDevtoolsCloudbuildV1Secret": { "properties": { "kmsKeyName": { "type": "string", "description": "Cloud KMS key name to use to decrypt these envs." }, "secretEnv": { "description": "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.", "additionalProperties": { "type": "string", "format": "byte" }, "type": "object" } }, "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1Secret", "type": "object", "description": "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." }, "Occurrence": { "type": "object", "properties": { "discovered": { "description": "Describes the initial scan status for this resource.", "$ref": "Discovered" }, "derivedImage": { "$ref": "Derived", "description": "Describes how this resource derives from the basis in the associated note." }, "upgrade": { "description": "Describes an upgrade.", "$ref": "UpgradeOccurrence" }, "vulnerabilityDetails": { "description": "Details of a security vulnerability note.", "$ref": "VulnerabilityDetails" }, "spdxRelationship": { "$ref": "RelationshipOccurrence", "description": "Describes a specific relationship between SPDX elements." }, "resourceUrl": { "type": "string", "description": "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." }, "resource": { "description": " The resource for which the `Occurrence` applies.", "$ref": "Resource" }, "envelope": { "description": "https://github.com/secure-systems-lab/dsse", "$ref": "Envelope" }, "remediation": { "type": "string", "description": "A description of actions that can be taken to remedy the `Note`" }, "deployment": { "$ref": "Deployment", "description": "Describes the deployment of an artifact on a runtime." }, "spdxFile": { "description": "Describes a specific SPDX File.", "$ref": "FileOccurrence" }, "updateTime": { "type": "string", "format": "google-datetime", "description": "Output only. The time this `Occurrence` was last updated." }, "compliance": { "description": "Describes whether or not a resource passes compliance checks.", "$ref": "ComplianceOccurrence" }, "name": { "description": "Output only. The name of the `Occurrence` in the form \"projects/{project_id}/occurrences/{OCCURRENCE_ID}\"", "type": "string" }, "installation": { "description": "Describes the installation of a package on the linked resource.", "$ref": "Installation" }, "noteName": { "description": "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.", "type": "string" }, "kind": { "type": "string", "enumDescriptions": [ "Unknown", "The note and occurrence represent a package vulnerability.", "The note and occurrence assert build provenance.", "This represents an image basis relationship.", "This represents a package installed via a package manager.", "The note and occurrence track deployment events.", "The note and occurrence track the initial discovery status of a resource.", "This represents a logical \"role\" that can attest to artifacts.", "This represents an available software upgrade.", "This represents a compliance check that can be applied to a resource.", "This represents a software bill of materials.", "This represents an SPDX Package.", "This represents an SPDX File.", "This represents an SPDX Relationship.", "This represents a DSSE attestation Note", "This represents a Vulnerability Assessment.", "This represents a reference to an SBOM." ], "description": "Output only. This explicitly denotes which of the `Occurrence` details are specified. This field can be used as a filter in list requests.", "enum": [ "KIND_UNSPECIFIED", "PACKAGE_VULNERABILITY", "BUILD_DETAILS", "IMAGE_BASIS", "PACKAGE_MANAGER", "DEPLOYABLE", "DISCOVERY", "ATTESTATION_AUTHORITY", "UPGRADE", "COMPLIANCE", "SBOM", "SPDX_PACKAGE", "SPDX_FILE", "SPDX_RELATIONSHIP", "DSSE_ATTESTATION", "VULNERABILITY_ASSESSMENT", "SBOM_REFERENCE" ] }, "spdxPackage": { "$ref": "PackageInfoOccurrence", "description": "Describes a specific SPDX Package." }, "attestation": { "$ref": "Attestation", "description": "Describes an attestation of an artifact." }, "dsseAttestation": { "$ref": "DSSEAttestationOccurrence", "description": "This represents a DSSE attestation occurrence" }, "createTime": { "format": "google-datetime", "description": "Output only. The time this `Occurrence` was created.", "type": "string" }, "buildDetails": { "$ref": "BuildDetails", "description": "Build details for a verifiable build." }, "sbom": { "$ref": "DocumentOccurrence", "description": "Describes a specific software bill of materials document." }, "sbomReference": { "$ref": "SBOMReferenceOccurrence", "description": "This represents an SBOM reference occurrence" } }, "id": "Occurrence", "description": "`Occurrence` includes information about analysis occurrences for an image." }, "GoogleDevtoolsContaineranalysisV1alpha1SlsaProvenanceZeroTwoSlsaBuilder": { "properties": { "id": { "type": "string", "description": "URI indicating the builder’s identity." } }, "description": "Identifies the entity that executed the recipe, which is trusted to have correctly performed the operation and populated this provenance.", "type": "object", "id": "GoogleDevtoolsContaineranalysisV1alpha1SlsaProvenanceZeroTwoSlsaBuilder" }, "GoogleDevtoolsContaineranalysisV1alpha1SlsaProvenanceZeroTwoSlsaInvocation": { "type": "object", "description": "Identifies the event that kicked off the build.", "id": "GoogleDevtoolsContaineranalysisV1alpha1SlsaProvenanceZeroTwoSlsaInvocation", "properties": { "environment": { "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "Any other builder-controlled inputs necessary for correctly evaluating the build." }, "configSource": { "$ref": "GoogleDevtoolsContaineranalysisV1alpha1SlsaProvenanceZeroTwoSlsaConfigSource", "description": "Describes where the config file that kicked off the build came from." }, "parameters": { "description": "Collection of all external inputs that influenced the build on top of invocation.configSource.", "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" } } } }, "ContaineranalysisGoogleDevtoolsCloudbuildV1Hash": { "description": "Container message for hash values.", "properties": { "type": { "enum": [ "NONE", "SHA256", "MD5", "SHA512" ], "description": "The type of hash that was performed.", "enumDescriptions": [ "No hash requested.", "Use a sha256 hash.", "Use a md5 hash.", "Use a sha512 hash." ], "type": "string" }, "value": { "description": "The hash value.", "format": "byte", "type": "string" } }, "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1Hash", "type": "object" }, "SlsaProvenanceZeroTwo": { "properties": { "materials": { "type": "array", "items": { "$ref": "GoogleDevtoolsContaineranalysisV1alpha1SlsaProvenanceZeroTwoSlsaMaterial" }, "description": "The collection of artifacts that influenced the build including sources, dependencies, build tools, base images, and so on." }, "invocation": { "$ref": "GoogleDevtoolsContaineranalysisV1alpha1SlsaProvenanceZeroTwoSlsaInvocation", "description": "Identifies the event that kicked off the build." }, "metadata": { "$ref": "GoogleDevtoolsContaineranalysisV1alpha1SlsaProvenanceZeroTwoSlsaMetadata", "description": "Other properties of the build." }, "builder": { "$ref": "GoogleDevtoolsContaineranalysisV1alpha1SlsaProvenanceZeroTwoSlsaBuilder", "description": "Identifies the entity that executed the recipe, which is trusted to have correctly performed the operation and populated this provenance." }, "buildConfig": { "additionalProperties": { "description": "Properties of the object.", "type": "any" }, "description": "Lists the steps in the build.", "type": "object" }, "buildType": { "type": "string", "description": "URI indicating what type of build was performed." } }, "description": "SlsaProvenanceZeroTwo is the slsa provenance as defined by the slsa spec. See full explanation of fields at slsa.dev/provenance/v0.2.", "type": "object", "id": "SlsaProvenanceZeroTwo" }, "License": { "description": "License information.", "type": "object", "properties": { "expression": { "description": "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\".", "type": "string" }, "comments": { "description": "Comments", "type": "string" } }, "id": "License" }, "GetVulnzOccurrencesSummaryResponse": { "type": "object", "id": "GetVulnzOccurrencesSummaryResponse", "properties": { "counts": { "items": { "$ref": "SeverityCount" }, "description": "A map of how many occurrences were found for each severity.", "type": "array" } }, "description": "A summary of how many vulnz occurrences there are per severity type. counts by groups, or if we should have different summary messages like this." }, "Derived": { "id": "Derived", "type": "object", "properties": { "fingerprint": { "$ref": "Fingerprint", "description": "The fingerprint of the derived image." }, "distance": { "format": "uint32", "description": "Output only. The number of layers by which this image differs from the associated image basis.", "type": "integer" }, "layerInfo": { "items": { "$ref": "Layer" }, "description": "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.", "type": "array" }, "baseResourceUrl": { "type": "string", "description": "Output only. This contains the base image URL for the derived image occurrence." } }, "description": "Derived describes the derived image portion (Occurrence) of the DockerImage relationship. This image would be produced from a Dockerfile with FROM ." }, "GoogleDevtoolsContaineranalysisV1alpha1SlsaProvenanceZeroTwoSlsaMetadata": { "type": "object", "id": "GoogleDevtoolsContaineranalysisV1alpha1SlsaProvenanceZeroTwoSlsaMetadata", "description": "Other properties of the build.", "properties": { "completeness": { "description": "Indicates that the builder claims certain fields in this message to be complete.", "$ref": "GoogleDevtoolsContaineranalysisV1alpha1SlsaProvenanceZeroTwoSlsaCompleteness" }, "buildInvocationId": { "type": "string", "description": "Identifies this particular build invocation, which can be useful for finding associated logs or other ad-hoc analysis." }, "buildFinishedOn": { "type": "string", "description": "The timestamp of when the build completed.", "format": "google-datetime" }, "buildStartedOn": { "type": "string", "format": "google-datetime", "description": "The timestamp of when the build started." }, "reproducible": { "type": "boolean", "description": "If true, the builder claims that running invocation on materials will produce bit-for-bit identical output." } } }, "InTotoSlsaProvenanceV1": { "id": "InTotoSlsaProvenanceV1", "type": "object", "properties": { "subject": { "items": { "$ref": "Subject" }, "type": "array" }, "predicateType": { "type": "string" }, "predicate": { "$ref": "SlsaProvenanceV1" }, "_type": { "description": "InToto spec defined at https://github.com/in-toto/attestation/tree/main/spec#statement", "type": "string" } } }, "Hash": { "type": "object", "id": "Hash", "description": "Container message for hash values.", "properties": { "type": { "enum": [ "NONE", "SHA256" ], "type": "string", "description": "The type of hash that was performed.", "enumDescriptions": [ "No hash requested.", "A sha256 hash." ] }, "value": { "format": "byte", "type": "string", "description": "The hash value." } } }, "EnvelopeSignature": { "id": "EnvelopeSignature", "description": "A DSSE signature", "properties": { "sig": { "type": "string", "format": "byte", "description": "The signature itself" }, "keyid": { "type": "string", "description": "A reference id to the key being used for signing" } }, "type": "object" }, "Policy": { "description": "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 \u003c 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 \u003c 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/).", "id": "Policy", "properties": { "bindings": { "type": "array", "description": "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`.", "items": { "$ref": "Binding" } }, "version": { "type": "integer", "format": "int32", "description": "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)." }, "etag": { "format": "byte", "description": "`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.", "type": "string" } }, "type": "object" }, "URI": { "description": "An URI message.", "type": "object", "id": "URI", "properties": { "label": { "type": "string", "description": "A label for the URI." }, "uri": { "type": "string", "description": "The unique resource identifier." } } }, "Operation": { "id": "Operation", "properties": { "name": { "type": "string", "description": "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": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "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`.", "type": "object" }, "metadata": { "additionalProperties": { "type": "any", "description": "Properties of the object. Contains field @type with type URL." }, "description": "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.", "type": "object" }, "error": { "$ref": "Status", "description": "The error result of the operation in case of failure or cancellation." }, "done": { "type": "boolean", "description": "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." } }, "type": "object", "description": "This resource represents a long-running operation that is the result of a network API call." }, "ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest": { "description": "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).", "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSourceManifest", "type": "object", "properties": { "bucket": { "type": "string", "description": "Cloud Storage bucket containing the source manifest (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements))." }, "object": { "description": "Cloud Storage object containing the source manifest. This object must be a JSON file.", "type": "string" }, "generation": { "type": "string", "description": "Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.", "format": "int64" } } }, "ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption": { "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1BuildOptionsPoolOption", "type": "object", "properties": { "name": { "type": "string", "description": "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}" } }, "description": "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." }, "BuilderConfig": { "id": "BuilderConfig", "type": "object", "properties": { "id": { "type": "string" } } }, "Product": { "description": "Product contains information about a product and how to uniquely identify it.", "id": "Product", "properties": { "name": { "description": "Name of the product.", "type": "string" }, "identifierHelper": { "description": "Helps in identifying the underlying product.", "$ref": "IdentifierHelper" }, "id": { "type": "string", "description": "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." } }, "type": "object" }, "DocumentOccurrence": { "properties": { "documentComment": { "description": "A field for creators of the SPDX file content to provide comments to the consumers of the SPDX document", "type": "string" }, "title": { "description": "Identify name of this document as designated by creator", "type": "string" }, "createTime": { "type": "string", "format": "google-datetime", "description": "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" }, "id": { "description": "Identify the current SPDX document which may be referenced in relationships by other files, packages internally and documents externally", "type": "string" }, "licenseListVersion": { "description": "A field for creators of the SPDX file to provide the version of the SPDX License List used when the SPDX file was created", "type": "string" }, "externalDocumentRefs": { "description": "Identify any external SPDX documents referenced within this SPDX document", "type": "array", "items": { "type": "string" } }, "creatorComment": { "type": "string", "description": "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": { "description": "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", "type": "array", "items": { "type": "string" } }, "namespace": { "description": "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", "type": "string" } }, "type": "object", "description": "DocumentOccurrence represents an SPDX Document Creation Information section: https://spdx.github.io/spdx-spec/2-document-creation-information/", "id": "DocumentOccurrence" }, "Detail": { "type": "object", "properties": { "severityName": { "type": "string", "description": "The severity (eg: distro assigned severity) for this vulnerability." }, "vendor": { "type": "string", "description": "The vendor of the product. e.g. \"google\"" }, "maxAffectedVersion": { "$ref": "Version", "description": "The max version of the package in which the vulnerability exists." }, "isObsolete": { "type": "boolean", "description": "Whether this Detail is obsolete. Occurrences are expected not to point to obsolete details." }, "packageType": { "type": "string", "description": "The type of package; whether native or non native(ruby gems, node.js packages etc)" }, "description": { "type": "string", "description": "A vendor-specific description of this note." }, "fixedLocation": { "$ref": "VulnerabilityLocation", "description": "The fix for this specific package version." }, "source": { "type": "string", "description": "The source from which the information in this Detail was obtained." }, "cpeUri": { "type": "string", "description": "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." }, "package": { "type": "string", "description": "The name of the package where the vulnerability was found. This field can be used as a filter in list requests." }, "minAffectedVersion": { "description": "The min version of the package in which the vulnerability exists.", "$ref": "Version" } }, "id": "Detail", "description": "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" }, "RepoSource": { "properties": { "branchName": { "type": "string", "description": "Name of the branch to build." }, "projectId": { "description": "ID of the project that owns the repo.", "type": "string" }, "tagName": { "description": "Name of the tag to build.", "type": "string" }, "repoName": { "description": "Name of the repo.", "type": "string" }, "commitSha": { "type": "string", "description": "Explicit commit SHA to build." } }, "description": "RepoSource describes the location of the source in a Google Cloud Source Repository.", "type": "object", "deprecated": true, "id": "RepoSource" }, "PackageIssue": { "description": "This message wraps a location affected by a vulnerability and its associated fix (if one is available).", "id": "PackageIssue", "properties": { "packageType": { "description": "The type of package (e.g. OS, MAVEN, GO).", "type": "string" }, "severityName": { "type": "string" }, "effectiveSeverity": { "enumDescriptions": [ "Unknown Impact", "Minimal Impact", "Low Impact", "Medium Impact", "High Impact", "Critical Impact" ], "description": "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.", "type": "string", "enum": [ "SEVERITY_UNSPECIFIED", "MINIMAL", "LOW", "MEDIUM", "HIGH", "CRITICAL" ], "readOnly": true }, "affectedLocation": { "$ref": "VulnerabilityLocation", "description": "The location of the vulnerability." }, "fixedLocation": { "$ref": "VulnerabilityLocation", "description": "The location of the available fix for vulnerability." } }, "type": "object" }, "SbomReferenceIntotoPredicate": { "type": "object", "id": "SbomReferenceIntotoPredicate", "description": "A predicate which describes the SBOM being referenced.", "properties": { "referrerId": { "type": "string", "description": "The person or system referring this predicate to the consumer." }, "digest": { "type": "object", "additionalProperties": { "type": "string" }, "description": "A map of algorithm to digest of the contents of the SBOM." }, "location": { "description": "The location of the SBOM.", "type": "string" }, "mimeType": { "type": "string", "description": "The mime type of the SBOM." } } }, "SlsaProvenanceV1": { "description": "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.", "id": "SlsaProvenanceV1", "type": "object", "properties": { "buildDefinition": { "$ref": "BuildDefinition" }, "runDetails": { "$ref": "RunDetails" } } }, "Deployment": { "properties": { "resourceUri": { "type": "array", "items": { "type": "string" }, "description": "Resource URI for the artifact being deployed taken from the deployable field with the same name." }, "platform": { "enumDescriptions": [ "Unknown", "Google Container Engine", "Google App Engine: Flexible Environment", "Custom user-defined platform" ], "enum": [ "PLATFORM_UNSPECIFIED", "GKE", "FLEX", "CUSTOM" ], "type": "string", "description": "Platform hosting this deployment." }, "config": { "description": "Configuration used to create this deployment.", "type": "string" }, "userEmail": { "type": "string", "description": "Identity of the user that triggered this deployment." }, "undeployTime": { "format": "google-datetime", "description": "End of the lifetime of this deployment.", "type": "string" }, "deployTime": { "type": "string", "format": "google-datetime", "description": "Beginning of the lifetime of this deployment." }, "address": { "description": "Address of the runtime element hosting this deployment.", "type": "string" } }, "description": "The period during which some deployable was active in a runtime.", "id": "Deployment", "type": "object" }, "Binding": { "id": "Binding", "description": "Associates `members`, or principals, with a `role`.", "properties": { "role": { "type": "string", "description": "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)." }, "condition": { "description": "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).", "$ref": "Expr" }, "members": { "items": { "type": "string" }, "description": "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/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{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/global/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.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.", "type": "array" } }, "type": "object" }, "Resource": { "properties": { "name": { "type": "string", "description": "The name of the resource. E.g., the name of a Docker image - \"Debian\"." }, "uri": { "type": "string", "description": "The unique URI of the resource. E.g., \"https://gcr.io/project/image@sha256:foo\" for a Docker image." }, "contentHash": { "description": "The hash of the resource content. E.g., the Docker digest.", "$ref": "Hash" } }, "id": "Resource", "type": "object", "description": " Resource is an entity that can have metadata. E.g., a Docker image." }, "DSSEAttestationOccurrence": { "id": "DSSEAttestationOccurrence", "type": "object", "description": "An occurrence describing an attestation on a resource", "properties": { "envelope": { "description": "If doing something security critical, make sure to verify the signatures in this metadata.", "$ref": "Envelope" }, "statement": { "$ref": "InTotoStatement" } } }, "ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts": { "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1Artifacts", "type": "object", "properties": { "images": { "items": { "type": "string" }, "description": "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.", "type": "array" }, "npmPackages": { "type": "array", "description": "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.", "items": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsNpmPackage" } }, "mavenArtifacts": { "description": "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.", "items": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsMavenArtifact" }, "type": "array" }, "pythonPackages": { "items": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsPythonPackage" }, "description": "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.", "type": "array" }, "objects": { "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1ArtifactsArtifactObjects", "description": "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." } }, "description": "Artifacts produced by a build that should be uploaded upon successful completion of all build steps." }, "BuildMetadata": { "type": "object", "id": "BuildMetadata", "properties": { "invocationId": { "type": "string" }, "startedOn": { "format": "google-datetime", "type": "string" }, "finishedOn": { "format": "google-datetime", "type": "string" } } }, "ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalResult": { "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1ApprovalResult", "properties": { "decision": { "description": "Required. The decision of this manual approval.", "enumDescriptions": [ "Default enum type. This should not be used.", "Build is approved.", "Build is rejected." ], "type": "string", "enum": [ "DECISION_UNSPECIFIED", "APPROVED", "REJECTED" ] }, "approverAccount": { "readOnly": true, "description": "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.", "type": "string" }, "url": { "description": "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.", "type": "string" }, "approvalTime": { "type": "string", "description": "Output only. The time when the approval decision was made.", "readOnly": true, "format": "google-datetime" }, "comment": { "type": "string", "description": "Optional. An optional comment for this manual approval result." } }, "type": "object", "description": "ApprovalResult describes the decision and associated metadata of a manual approval of a build." }, "Attestation": { "id": "Attestation", "properties": { "pgpSignedAttestation": { "$ref": "PgpSignedAttestation" } }, "description": "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).", "type": "object" }, "Artifact": { "description": "Artifact describes a build product.", "properties": { "id": { "type": "string", "description": "Artifact ID, if any; for container images, this will be a URL by digest like gcr.io/projectID/imagename@sha256:123456" }, "name": { "deprecated": true, "type": "string", "description": "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." }, "checksum": { "type": "string", "description": "Hash or checksum value of a binary, or Docker Registry 2.0 digest of a container." }, "names": { "type": "array", "description": "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.", "items": { "type": "string" } } }, "type": "object", "id": "Artifact" }, "Publisher": { "description": "Publisher contains information about the publisher of this Note.", "id": "Publisher", "properties": { "name": { "description": "Name of the publisher. Examples: 'Google', 'Google Cloud Platform'.", "type": "string" }, "publisherNamespace": { "type": "string", "description": "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" }, "issuingAuthority": { "type": "string", "description": "Provides information about the authority of the issuing party to release the document, in particular, the party's constituency and responsibilities or other obligations." } }, "type": "object" }, "AttestationAuthorityHint": { "properties": { "humanReadableName": { "type": "string", "description": "The human readable name of this Attestation Authority, for example \"qa\"." } }, "id": "AttestationAuthorityHint", "description": "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.", "type": "object" }, "GoogleDevtoolsContaineranalysisV1alpha1CloudRepoSourceContext": { "type": "object", "description": "A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo.", "properties": { "aliasContext": { "$ref": "GoogleDevtoolsContaineranalysisV1alpha1AliasContext", "description": "An alias, which may be a branch or tag." }, "revisionId": { "description": "A revision ID.", "type": "string" }, "repoId": { "$ref": "GoogleDevtoolsContaineranalysisV1alpha1RepoId", "description": "The ID of the repo." } }, "id": "GoogleDevtoolsContaineranalysisV1alpha1CloudRepoSourceContext" }, "ListOccurrencesResponse": { "id": "ListOccurrencesResponse", "description": "Response including listed active occurrences.", "type": "object", "properties": { "nextPageToken": { "type": "string", "description": "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": { "items": { "$ref": "Occurrence" }, "description": "The occurrences requested.", "type": "array" } } } }, "rootUrl": "https://containeranalysis.googleapis.com/", "ownerName": "Google", "servicePath": "", "name": "containeranalysis", "kind": "discovery#restDescription", "batchPath": "batch", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "baseUrl": "https://containeranalysis.googleapis.com/", "mtlsRootUrl": "https://containeranalysis.mtls.googleapis.com/", "version": "v1alpha1", "basePath": "", "documentationLink": "https://cloud.google.com/container-analysis/api/reference/rest/", "revision": "20240301", "resources": { "providers": { "resources": { "notes": { "resources": { "occurrences": { "methods": { "list": { "parameterOrder": [ "name" ], "response": { "$ref": "ListNoteOccurrencesResponse" }, "parameters": { "filter": { "type": "string", "description": "The filter expression.", "location": "query" }, "name": { "required": true, "type": "string", "description": "The name field will contain the note name for example: \"provider/{provider_id}/notes/{note_id}\"", "pattern": "^providers/[^/]+/notes/[^/]+$", "location": "path" }, "pageToken": { "location": "query", "description": "Token to provide to skip to a particular spot in the list.", "type": "string" }, "pageSize": { "format": "int32", "description": "Number of notes to return in the list.", "type": "integer", "location": "query" } }, "description": "Lists `Occurrences` referencing the specified `Note`. Use this method to get all occurrences referencing your `Note` across all your customer projects.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "path": "v1alpha1/{+name}/occurrences", "id": "containeranalysis.providers.notes.occurrences.list", "flatPath": "v1alpha1/providers/{providersId}/notes/{notesId}/occurrences" } } } }, "methods": { "getIamPolicy": { "path": "v1alpha1/{+resource}:getIamPolicy", "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "resource": { "location": "path", "description": "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.", "required": true, "type": "string", "pattern": "^providers/[^/]+/notes/[^/]+$" } }, "description": "Gets the access control policy for a note or an `Occurrence` resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. Attempting to call this method on a resource without the required permission will result in a `PERMISSION_DENIED` error. Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has list permission on the project, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for occurrences and projects/{PROJECT_ID}/notes/{NOTE_ID} for notes", "request": { "$ref": "GetIamPolicyRequest" }, "parameterOrder": [ "resource" ], "id": "containeranalysis.providers.notes.getIamPolicy", "httpMethod": "POST", "flatPath": "v1alpha1/providers/{providersId}/notes/{notesId}:getIamPolicy" }, "list": { "parameterOrder": [ "name" ], "flatPath": "v1alpha1/providers/{providersId}/notes", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "response": { "$ref": "ListNotesResponse" }, "path": "v1alpha1/{+name}/notes", "parameters": { "filter": { "description": "The filter expression.", "location": "query", "type": "string" }, "parent": { "type": "string", "location": "query", "description": "This field contains the project Id for example: \"projects/{PROJECT_ID}\"." }, "pageSize": { "description": "Number of notes to return in the list.", "type": "integer", "format": "int32", "location": "query" }, "name": { "description": "The name field will contain the project Id for example: \"providers/{provider_id} @Deprecated", "required": true, "pattern": "^providers/[^/]+$", "type": "string", "location": "path" }, "pageToken": { "location": "query", "type": "string", "description": "Token to provide to skip to a particular spot in the list." } }, "id": "containeranalysis.providers.notes.list", "description": "Lists all `Notes` for a given project." }, "delete": { "path": "v1alpha1/{+name}", "description": "Deletes the given `Note` from the system.", "flatPath": "v1alpha1/providers/{providersId}/notes/{notesId}", "parameterOrder": [ "name" ], "parameters": { "name": { "location": "path", "type": "string", "pattern": "^providers/[^/]+/notes/[^/]+$", "description": "The name of the note in the form of \"providers/{provider_id}/notes/{NOTE_ID}\"", "required": true } }, "id": "containeranalysis.providers.notes.delete", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "Empty" }, "httpMethod": "DELETE" }, "create": { "httpMethod": "POST", "id": "containeranalysis.providers.notes.create", "response": { "$ref": "Note" }, "path": "v1alpha1/{+name}/notes", "description": "Creates a new `Note`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "name" ], "request": { "$ref": "Note" }, "parameters": { "name": { "required": true, "pattern": "^providers/[^/]+$", "description": "The name of the project. Should be of the form \"providers/{provider_id}\". @Deprecated", "location": "path", "type": "string" }, "noteId": { "location": "query", "type": "string", "description": "The ID to use for this note." }, "parent": { "description": "This field contains the project Id for example: \"projects/{project_id}", "type": "string", "location": "query" } }, "flatPath": "v1alpha1/providers/{providersId}/notes" }, "testIamPermissions": { "parameterOrder": [ "resource" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Returns the permissions that a caller has on the specified note or occurrence resource. Requires list permission on the project (for example, \"storage.objects.list\" on the containing bucket for testing permission of an object). Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has list permission on the project, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for `Occurrences` and `projects/{PROJECT_ID}/notes/{NOTE_ID}` for `Notes`", "response": { "$ref": "TestIamPermissionsResponse" }, "id": "containeranalysis.providers.notes.testIamPermissions", "path": "v1alpha1/{+resource}:testIamPermissions", "httpMethod": "POST", "request": { "$ref": "TestIamPermissionsRequest" }, "flatPath": "v1alpha1/providers/{providersId}/notes/{notesId}:testIamPermissions", "parameters": { "resource": { "description": "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.", "location": "path", "type": "string", "pattern": "^providers/[^/]+/notes/[^/]+$", "required": true } } }, "get": { "description": "Returns the requested `Note`.", "id": "containeranalysis.providers.notes.get", "flatPath": "v1alpha1/providers/{providersId}/notes/{notesId}", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^providers/[^/]+/notes/[^/]+$", "description": "The name of the note in the form of \"providers/{provider_id}/notes/{NOTE_ID}\"", "location": "path", "type": "string", "required": true } }, "parameterOrder": [ "name" ], "httpMethod": "GET", "response": { "$ref": "Note" } }, "setIamPolicy": { "response": { "$ref": "Policy" }, "parameterOrder": [ "resource" ], "httpMethod": "POST", "id": "containeranalysis.providers.notes.setIamPolicy", "flatPath": "v1alpha1/providers/{providersId}/notes/{notesId}:setIamPolicy", "description": "Sets the access control policy on the specified `Note` or `Occurrence`. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a `Note` or an `Occurrence`, respectively. Attempting to call this method without these permissions will result in a ` `PERMISSION_DENIED` error. Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has `containeranalysis.notes.list` permission on a `Note` or `containeranalysis.occurrences.list` on an `Occurrence`, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{projectid}/occurrences/{occurrenceid}` for occurrences and projects/{projectid}/notes/{noteid} for notes", "parameters": { "resource": { "location": "path", "description": "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.", "pattern": "^providers/[^/]+/notes/[^/]+$", "type": "string", "required": true } }, "request": { "$ref": "SetIamPolicyRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+resource}:setIamPolicy" }, "patch": { "flatPath": "v1alpha1/providers/{providersId}/notes/{notesId}", "description": "Updates an existing `Note`.", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "PATCH", "id": "containeranalysis.providers.notes.patch", "parameters": { "updateMask": { "description": "The fields to update.", "location": "query", "format": "google-fieldmask", "type": "string" }, "name": { "location": "path", "pattern": "^providers/[^/]+/notes/[^/]+$", "type": "string", "description": "The name of the note. Should be of the form \"projects/{provider_id}/notes/{note_id}\".", "required": true } }, "parameterOrder": [ "name" ], "response": { "$ref": "Note" }, "path": "v1alpha1/{+name}", "request": { "$ref": "Note" } } } } } }, "projects": { "resources": { "scanConfigs": { "methods": { "patch": { "flatPath": "v1alpha1/projects/{projectsId}/scanConfigs/{scanConfigsId}", "request": { "$ref": "ScanConfig" }, "parameters": { "name": { "required": true, "type": "string", "description": "The scan config to update of the form projects/{project_id}/scanConfigs/{scan_config_id}.", "location": "path", "pattern": "^projects/[^/]+/scanConfigs/[^/]+$" }, "updateMask": { "type": "string", "format": "google-fieldmask", "description": "The fields to update.", "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "containeranalysis.projects.scanConfigs.patch", "path": "v1alpha1/{+name}", "parameterOrder": [ "name" ], "httpMethod": "PATCH", "response": { "$ref": "ScanConfig" }, "description": "Updates the scan configuration to a new value." }, "get": { "flatPath": "v1alpha1/projects/{projectsId}/scanConfigs/{scanConfigsId}", "path": "v1alpha1/{+name}", "parameters": { "name": { "type": "string", "required": true, "description": "The name of the ScanConfig in the form projects/{project_id}/scanConfigs/{scan_config_id}", "pattern": "^projects/[^/]+/scanConfigs/[^/]+$", "location": "path" } }, "response": { "$ref": "ScanConfig" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "description": "Gets a specific scan configuration for a project.", "parameterOrder": [ "name" ], "id": "containeranalysis.projects.scanConfigs.get" }, "list": { "path": "v1alpha1/{+parent}/scanConfigs", "httpMethod": "GET", "parameters": { "pageSize": { "location": "query", "type": "integer", "description": "The number of items to return.", "format": "int32" }, "parent": { "location": "path", "description": "This containers the project Id i.e.: projects/{project_id}", "required": true, "pattern": "^projects/[^/]+$", "type": "string" }, "filter": { "type": "string", "location": "query", "description": "The filter expression." }, "pageToken": { "description": "The page token to use for the next request.", "type": "string", "location": "query" } }, "description": "Lists scan configurations for a project.", "flatPath": "v1alpha1/projects/{projectsId}/scanConfigs", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "ListScanConfigsResponse" }, "id": "containeranalysis.projects.scanConfigs.list", "parameterOrder": [ "parent" ] } } }, "operations": { "methods": { "patch": { "response": { "$ref": "Operation" }, "path": "v1alpha1/{+name}", "id": "containeranalysis.projects.operations.patch", "flatPath": "v1alpha1/projects/{projectsId}/operations/{operationsId}", "parameters": { "name": { "pattern": "^projects/[^/]+/operations/[^/]+$", "description": "The name of the Operation. Should be of the form \"projects/{provider_id}/operations/{operation_id}\".", "location": "path", "required": true, "type": "string" } }, "httpMethod": "PATCH", "parameterOrder": [ "name" ], "request": { "$ref": "UpdateOperationRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates an existing operation returns an error if operation does not exist. The only valid operations are to update mark the done bit change the result." }, "create": { "id": "containeranalysis.projects.operations.create", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "response": { "$ref": "Operation" }, "flatPath": "v1alpha1/projects/{projectsId}/operations", "description": "Creates a new `Operation`.", "request": { "$ref": "CreateOperationRequest" }, "parameterOrder": [ "parent" ], "parameters": { "parent": { "required": true, "pattern": "^projects/[^/]+$", "description": "The project Id that this operation should be created under.", "location": "path", "type": "string" } }, "path": "v1alpha1/{+parent}/operations" } } }, "occurrences": { "methods": { "testIamPermissions": { "httpMethod": "POST", "flatPath": "v1alpha1/projects/{projectsId}/occurrences/{occurrencesId}:testIamPermissions", "path": "v1alpha1/{+resource}:testIamPermissions", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "resource" ], "request": { "$ref": "TestIamPermissionsRequest" }, "response": { "$ref": "TestIamPermissionsResponse" }, "parameters": { "resource": { "description": "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.", "location": "path", "pattern": "^projects/[^/]+/occurrences/[^/]+$", "type": "string", "required": true } }, "id": "containeranalysis.projects.occurrences.testIamPermissions", "description": "Returns the permissions that a caller has on the specified note or occurrence resource. Requires list permission on the project (for example, \"storage.objects.list\" on the containing bucket for testing permission of an object). Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has list permission on the project, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for `Occurrences` and `projects/{PROJECT_ID}/notes/{NOTE_ID}` for `Notes`" }, "setIamPolicy": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/occurrences/{occurrencesId}:setIamPolicy", "httpMethod": "POST", "path": "v1alpha1/{+resource}:setIamPolicy", "description": "Sets the access control policy on the specified `Note` or `Occurrence`. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a `Note` or an `Occurrence`, respectively. Attempting to call this method without these permissions will result in a ` `PERMISSION_DENIED` error. Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has `containeranalysis.notes.list` permission on a `Note` or `containeranalysis.occurrences.list` on an `Occurrence`, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{projectid}/occurrences/{occurrenceid}` for occurrences and projects/{projectid}/notes/{noteid} for notes", "response": { "$ref": "Policy" }, "parameterOrder": [ "resource" ], "id": "containeranalysis.projects.occurrences.setIamPolicy", "request": { "$ref": "SetIamPolicyRequest" }, "parameters": { "resource": { "description": "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.", "pattern": "^projects/[^/]+/occurrences/[^/]+$", "required": true, "location": "path", "type": "string" } } }, "getVulnerabilitySummary": { "path": "v1alpha1/{+parent}/occurrences:vulnerabilitySummary", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/occurrences:vulnerabilitySummary", "description": "Gets a summary of the number and severity of occurrences.", "parameterOrder": [ "parent" ], "id": "containeranalysis.projects.occurrences.getVulnerabilitySummary", "httpMethod": "GET", "response": { "$ref": "GetVulnzOccurrencesSummaryResponse" }, "parameters": { "parent": { "type": "string", "pattern": "^projects/[^/]+$", "location": "path", "required": true, "description": "This contains the project Id for example: projects/{project_id}" }, "filter": { "location": "query", "description": "The filter expression.", "type": "string" } } }, "getIamPolicy": { "httpMethod": "POST", "path": "v1alpha1/{+resource}:getIamPolicy", "flatPath": "v1alpha1/projects/{projectsId}/occurrences/{occurrencesId}:getIamPolicy", "id": "containeranalysis.projects.occurrences.getIamPolicy", "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "resource" ], "request": { "$ref": "GetIamPolicyRequest" }, "description": "Gets the access control policy for a note or an `Occurrence` resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. Attempting to call this method on a resource without the required permission will result in a `PERMISSION_DENIED` error. Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has list permission on the project, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for occurrences and projects/{PROJECT_ID}/notes/{NOTE_ID} for notes", "parameters": { "resource": { "required": true, "description": "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.", "location": "path", "type": "string", "pattern": "^projects/[^/]+/occurrences/[^/]+$" } } }, "create": { "request": { "$ref": "Occurrence" }, "parameters": { "name": { "location": "query", "description": "The name of the project. Should be of the form \"projects/{project_id}\". @Deprecated", "type": "string" }, "parent": { "location": "path", "description": "This field contains the project Id for example: \"projects/{project_id}\"", "type": "string", "pattern": "^projects/[^/]+$", "required": true } }, "path": "v1alpha1/{+parent}/occurrences", "response": { "$ref": "Occurrence" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "parameterOrder": [ "parent" ], "id": "containeranalysis.projects.occurrences.create", "flatPath": "v1alpha1/projects/{projectsId}/occurrences", "description": "Creates a new `Occurrence`. Use this method to create `Occurrences` for a resource." }, "getNotes": { "id": "containeranalysis.projects.occurrences.getNotes", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}/notes", "parameters": { "name": { "pattern": "^projects/[^/]+/occurrences/[^/]+$", "location": "path", "type": "string", "description": "The name of the occurrence in the form \"projects/{project_id}/occurrences/{OCCURRENCE_ID}\"", "required": true } }, "flatPath": "v1alpha1/projects/{projectsId}/occurrences/{occurrencesId}/notes", "description": "Gets the `Note` attached to the given `Occurrence`.", "parameterOrder": [ "name" ], "httpMethod": "GET", "response": { "$ref": "Note" } }, "get": { "path": "v1alpha1/{+name}", "parameterOrder": [ "name" ], "httpMethod": "GET", "parameters": { "name": { "required": true, "description": "The name of the occurrence of the form \"projects/{project_id}/occurrences/{OCCURRENCE_ID}\"", "pattern": "^projects/[^/]+/occurrences/[^/]+$", "type": "string", "location": "path" } }, "flatPath": "v1alpha1/projects/{projectsId}/occurrences/{occurrencesId}", "response": { "$ref": "Occurrence" }, "description": "Returns the requested `Occurrence`.", "id": "containeranalysis.projects.occurrences.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "parameters": { "filter": { "type": "string", "description": "The filter expression.", "location": "query" }, "name": { "location": "query", "type": "string", "description": "The name field contains the project Id. For example: \"projects/{project_id} @Deprecated" }, "parent": { "type": "string", "pattern": "^projects/[^/]+$", "description": "This contains the project Id for example: projects/{project_id}.", "location": "path", "required": true }, "kind": { "enum": [ "KIND_UNSPECIFIED", "PACKAGE_VULNERABILITY", "BUILD_DETAILS", "IMAGE_BASIS", "PACKAGE_MANAGER", "DEPLOYABLE", "DISCOVERY", "ATTESTATION_AUTHORITY", "UPGRADE", "COMPLIANCE", "SBOM", "SPDX_PACKAGE", "SPDX_FILE", "SPDX_RELATIONSHIP", "DSSE_ATTESTATION", "VULNERABILITY_ASSESSMENT", "SBOM_REFERENCE" ], "description": "The kind of occurrences to filter on.", "type": "string", "location": "query", "enumDescriptions": [ "Unknown", "The note and occurrence represent a package vulnerability.", "The note and occurrence assert build provenance.", "This represents an image basis relationship.", "This represents a package installed via a package manager.", "The note and occurrence track deployment events.", "The note and occurrence track the initial discovery status of a resource.", "This represents a logical \"role\" that can attest to artifacts.", "This represents an available software upgrade.", "This represents a compliance check that can be applied to a resource.", "This represents a software bill of materials.", "This represents an SPDX Package.", "This represents an SPDX File.", "This represents an SPDX Relationship.", "This represents a DSSE attestation Note", "This represents a Vulnerability Assessment.", "This represents a reference to an SBOM." ] }, "pageSize": { "format": "int32", "location": "query", "type": "integer", "description": "Number of occurrences to return in the list." }, "pageToken": { "location": "query", "description": "Token to provide to skip to a particular spot in the list.", "type": "string" } }, "parameterOrder": [ "parent" ], "response": { "$ref": "ListOccurrencesResponse" }, "flatPath": "v1alpha1/projects/{projectsId}/occurrences", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "id": "containeranalysis.projects.occurrences.list", "path": "v1alpha1/{+parent}/occurrences", "description": "Lists active `Occurrences` for a given project matching the filters." }, "patch": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "request": { "$ref": "Occurrence" }, "id": "containeranalysis.projects.occurrences.patch", "httpMethod": "PATCH", "description": "Updates an existing occurrence.", "response": { "$ref": "Occurrence" }, "parameters": { "updateMask": { "format": "google-fieldmask", "location": "query", "description": "The fields to update.", "type": "string" }, "name": { "description": "The name of the occurrence. Should be of the form \"projects/{project_id}/occurrences/{OCCURRENCE_ID}\".", "pattern": "^projects/[^/]+/occurrences/[^/]+$", "type": "string", "location": "path", "required": true } }, "parameterOrder": [ "name" ], "flatPath": "v1alpha1/projects/{projectsId}/occurrences/{occurrencesId}", "path": "v1alpha1/{+name}" }, "delete": { "parameterOrder": [ "name" ], "description": "Deletes the given `Occurrence` from the system. Use this when an `Occurrence` is no longer applicable for the given resource.", "path": "v1alpha1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "pattern": "^projects/[^/]+/occurrences/[^/]+$", "description": "The name of the occurrence in the form of \"projects/{project_id}/occurrences/{OCCURRENCE_ID}\"", "type": "string", "required": true, "location": "path" } }, "id": "containeranalysis.projects.occurrences.delete", "flatPath": "v1alpha1/projects/{projectsId}/occurrences/{occurrencesId}", "httpMethod": "DELETE", "response": { "$ref": "Empty" } } } }, "notes": { "resources": { "occurrences": { "methods": { "list": { "parameters": { "filter": { "type": "string", "description": "The filter expression.", "location": "query" }, "pageSize": { "location": "query", "description": "Number of notes to return in the list.", "type": "integer", "format": "int32" }, "name": { "location": "path", "type": "string", "required": true, "description": "The name field will contain the note name for example: \"provider/{provider_id}/notes/{note_id}\"", "pattern": "^projects/[^/]+/notes/[^/]+$" }, "pageToken": { "type": "string", "location": "query", "description": "Token to provide to skip to a particular spot in the list." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "containeranalysis.projects.notes.occurrences.list", "httpMethod": "GET", "flatPath": "v1alpha1/projects/{projectsId}/notes/{notesId}/occurrences", "parameterOrder": [ "name" ], "path": "v1alpha1/{+name}/occurrences", "description": "Lists `Occurrences` referencing the specified `Note`. Use this method to get all occurrences referencing your `Note` across all your customer projects.", "response": { "$ref": "ListNoteOccurrencesResponse" } } } } }, "methods": { "setIamPolicy": { "parameterOrder": [ "resource" ], "path": "v1alpha1/{+resource}:setIamPolicy", "httpMethod": "POST", "response": { "$ref": "Policy" }, "parameters": { "resource": { "pattern": "^projects/[^/]+/notes/[^/]+$", "type": "string", "location": "path", "required": true, "description": "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." } }, "flatPath": "v1alpha1/projects/{projectsId}/notes/{notesId}:setIamPolicy", "description": "Sets the access control policy on the specified `Note` or `Occurrence`. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a `Note` or an `Occurrence`, respectively. Attempting to call this method without these permissions will result in a ` `PERMISSION_DENIED` error. Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has `containeranalysis.notes.list` permission on a `Note` or `containeranalysis.occurrences.list` on an `Occurrence`, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{projectid}/occurrences/{occurrenceid}` for occurrences and projects/{projectid}/notes/{noteid} for notes", "request": { "$ref": "SetIamPolicyRequest" }, "id": "containeranalysis.projects.notes.setIamPolicy", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "create": { "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Creates a new `Note`.", "response": { "$ref": "Note" }, "request": { "$ref": "Note" }, "flatPath": "v1alpha1/projects/{projectsId}/notes", "id": "containeranalysis.projects.notes.create", "parameterOrder": [ "parent" ], "path": "v1alpha1/{+parent}/notes", "parameters": { "name": { "description": "The name of the project. Should be of the form \"providers/{provider_id}\". @Deprecated", "type": "string", "location": "query" }, "noteId": { "type": "string", "description": "The ID to use for this note.", "location": "query" }, "parent": { "required": true, "location": "path", "description": "This field contains the project Id for example: \"projects/{project_id}", "type": "string", "pattern": "^projects/[^/]+$" } } }, "getIamPolicy": { "request": { "$ref": "GetIamPolicyRequest" }, "path": "v1alpha1/{+resource}:getIamPolicy", "description": "Gets the access control policy for a note or an `Occurrence` resource. Requires `containeranalysis.notes.setIamPolicy` or `containeranalysis.occurrences.setIamPolicy` permission if the resource is a note or occurrence, respectively. Attempting to call this method on a resource without the required permission will result in a `PERMISSION_DENIED` error. Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has list permission on the project, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for occurrences and projects/{PROJECT_ID}/notes/{NOTE_ID} for notes", "flatPath": "v1alpha1/projects/{projectsId}/notes/{notesId}:getIamPolicy", "id": "containeranalysis.projects.notes.getIamPolicy", "parameters": { "resource": { "description": "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.", "pattern": "^projects/[^/]+/notes/[^/]+$", "type": "string", "location": "path", "required": true } }, "httpMethod": "POST", "parameterOrder": [ "resource" ], "response": { "$ref": "Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "id": "containeranalysis.projects.notes.list", "path": "v1alpha1/{+parent}/notes", "parameters": { "parent": { "description": "This field contains the project Id for example: \"projects/{PROJECT_ID}\".", "required": true, "type": "string", "pattern": "^projects/[^/]+$", "location": "path" }, "filter": { "description": "The filter expression.", "location": "query", "type": "string" }, "name": { "type": "string", "description": "The name field will contain the project Id for example: \"providers/{provider_id} @Deprecated", "location": "query" }, "pageSize": { "type": "integer", "description": "Number of notes to return in the list.", "format": "int32", "location": "query" }, "pageToken": { "description": "Token to provide to skip to a particular spot in the list.", "location": "query", "type": "string" } }, "description": "Lists all `Notes` for a given project.", "httpMethod": "GET", "response": { "$ref": "ListNotesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameterOrder": [ "parent" ], "flatPath": "v1alpha1/projects/{projectsId}/notes" }, "testIamPermissions": { "id": "containeranalysis.projects.notes.testIamPermissions", "response": { "$ref": "TestIamPermissionsResponse" }, "request": { "$ref": "TestIamPermissionsRequest" }, "parameterOrder": [ "resource" ], "description": "Returns the permissions that a caller has on the specified note or occurrence resource. Requires list permission on the project (for example, \"storage.objects.list\" on the containing bucket for testing permission of an object). Attempting to call this method on a non-existent resource will result in a `NOT_FOUND` error if the user has list permission on the project, or a `PERMISSION_DENIED` error otherwise. The resource takes the following formats: `projects/{PROJECT_ID}/occurrences/{OCCURRENCE_ID}` for `Occurrences` and `projects/{PROJECT_ID}/notes/{NOTE_ID}` for `Notes`", "flatPath": "v1alpha1/projects/{projectsId}/notes/{notesId}:testIamPermissions", "parameters": { "resource": { "pattern": "^projects/[^/]+/notes/[^/]+$", "description": "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.", "type": "string", "required": true, "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "path": "v1alpha1/{+resource}:testIamPermissions" }, "get": { "httpMethod": "GET", "parameters": { "name": { "description": "The name of the note in the form of \"providers/{provider_id}/notes/{NOTE_ID}\"", "location": "path", "type": "string", "pattern": "^projects/[^/]+/notes/[^/]+$", "required": true } }, "parameterOrder": [ "name" ], "description": "Returns the requested `Note`.", "flatPath": "v1alpha1/projects/{projectsId}/notes/{notesId}", "id": "containeranalysis.projects.notes.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "path": "v1alpha1/{+name}", "response": { "$ref": "Note" } }, "delete": { "flatPath": "v1alpha1/projects/{projectsId}/notes/{notesId}", "description": "Deletes the given `Note` from the system.", "parameters": { "name": { "location": "path", "required": true, "type": "string", "description": "The name of the note in the form of \"providers/{provider_id}/notes/{NOTE_ID}\"", "pattern": "^projects/[^/]+/notes/[^/]+$" } }, "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "containeranalysis.projects.notes.delete", "httpMethod": "DELETE", "path": "v1alpha1/{+name}", "parameterOrder": [ "name" ] }, "patch": { "flatPath": "v1alpha1/projects/{projectsId}/notes/{notesId}", "parameterOrder": [ "name" ], "parameters": { "name": { "required": true, "description": "The name of the note. Should be of the form \"projects/{provider_id}/notes/{note_id}\".", "location": "path", "type": "string", "pattern": "^projects/[^/]+/notes/[^/]+$" }, "updateMask": { "location": "query", "description": "The fields to update.", "format": "google-fieldmask", "type": "string" } }, "path": "v1alpha1/{+name}", "response": { "$ref": "Note" }, "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "containeranalysis.projects.notes.patch", "request": { "$ref": "Note" }, "description": "Updates an existing `Note`." } } } } } }, "discoveryVersion": "v1", "canonicalName": "Container Analysis", "version_module": true, "title": "Container Analysis API", "parameters": { "oauth_token": { "location": "query", "description": "OAuth 2.0 token for the current user.", "type": "string" }, "callback": { "description": "JSONP", "location": "query", "type": "string" }, "prettyPrint": { "default": "true", "description": "Returns response with indentations and line breaks.", "type": "boolean", "location": "query" }, "access_token": { "location": "query", "description": "OAuth access token.", "type": "string" }, "fields": { "location": "query", "description": "Selector specifying which fields to include in a partial response.", "type": "string" }, "alt": { "location": "query", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "default": "json", "enum": [ "json", "media", "proto" ], "type": "string", "description": "Data format for response." }, "$.xgafv": { "enumDescriptions": [ "v1 error format", "v2 error format" ], "type": "string", "description": "V1 error format.", "location": "query", "enum": [ "1", "2" ] }, "quotaUser": { "location": "query", "description": "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.", "type": "string" }, "key": { "type": "string", "description": "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.", "location": "query" }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string", "location": "query" }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "location": "query", "type": "string" } }, "protocol": "rest", "ownerDomain": "google.com", "fullyEncodeReservedExpansion": true }