Module google_ondemandscanning1::api[][src]



An alias to a repo revision.


AnalyzePackagesRequest is the request to analyze a list of packages and create Vulnerability Occurrences for it.


Artifact describes a build product.


Occurrence that represents a single “attestation”. The authenticity of an attestation can be verified using the attached signature. If the verifier trusts the public key of the signer, then verifying the signature is sufficient to establish trust. In this circumstance, the authority to which this attestation is attached is primarily useful for lookup (how to find this attestation if you already know the authority and artifact to be verified) and intent (for which authority this attestation was intended to sign.


Details of a build occurrence.


Provenance of a build. Contains all information needed to verify the full details about the build from source to completion.


The category to which the update belongs.


A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo.


Command describes a step performed as part of the build pipeline.


The period during which some deployable was active in a runtime.


Provides information about the analysis status of a discovered resource.


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); } The JSON representation for Empty is empty JSON object {}.


Container message for hashes of byte content of files, used in source messages to verify integrity of source input to the build.


A set of properties that uniquely identify a given Docker image.


A SourceContext referring to a Gerrit project.


A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub).


Container message for hash values.


The unique identifier of the update.


Details of the derived image portion of the DockerImage relationship. This image would be produced from a Dockerfile with FROM .


There is no detailed description.


Layer holds metadata specific to a layer of a Docker image.


The response message for Operations.ListOperations.


ListVulnerabilitiesResponse contains a single page of vulnerabilities resulting from a scan.


An occurrence of a particular package installation found within a system’s filesystem. E.g., glibc was found in /var/lib/dpkg/status.


An instance of an analysis type that has been found on a resource.


Central instance to access all OnDemandScanning related resource activities


This resource represents a long-running operation that is the result of a network API call.


There is no detailed description.


A detail for a distro and package this vulnerability occurrence was found in and its associated fix (if one is available).


Details on how a particular software package was installed on a system.


Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.


Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn’t support this method, it returns google.rpc.Code.UNIMPLEMENTED.


Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.


Lists operations that match the specified filter in the request. If the server doesn’t support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.


Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.


Initiates an analysis of the provided packages.


Lists vulnerabilities resulting from a successfully completed scan.


A builder providing access to all methods supported on project resources. It is not used directly, but through the OnDemandScanning hub.


Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project.


Metadata for any related URL information.


A unique identifier for a Cloud Repo.


Verifiers (e.g. Kritis implementations) MUST verify signatures with respect to the trust anchors defined in policy (e.g. a Kritis policy). Typically this means that the verifier has been configured with a map from public_key_id to public key material (and any required parameters, e.g. signing algorithm). In particular, verification implementations MUST NOT treat the signature public_key_id as anything more than a key lookup hint. The public_key_id DOES NOT validate or authenticate a public key; it only provides a mechanism for quickly selecting a public key ALREADY CONFIGURED on the verifier through a trusted channel. Verification implementations MUST reject signatures in any of the following circumstances: * The public_key_id is not recognized by the verifier. * The public key that public_key_id refers to does not verify the signature with respect to the payload. The signature contents SHOULD NOT be “attached” (where the payload is included with the serialized signature bytes). Verifiers MUST ignore any “attached” payload and only verify signatures with respect to explicitly provided payload (e.g. a payload field on the proto message that holds this Signature, or the canonical serialization of the proto message that holds this signature).


Source describes the location of the source used for the build.


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.


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. 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.


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.


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). For Windows, both distribution and windows_update contain information for the Windows update.


Version contains structured information about the version of a package.


An occurrence of a severity vulnerability on a resource.


Windows Update represents the metadata about the update for the Windows operating system. The fields in this message come from the Windows Update API documented at



Identifies the an OAuth2 authorization scope. A scope is needed when requesting an authorization token.