@Generated(value="by gapic-generator")

Package io.grafeas.v1

A client to Container Analysis API.

See: Description

Interface Summary

Interface	Description
AliasContextOrBuilder
ArtifactOrBuilder
AttestationNote.HintOrBuilder
AttestationNoteOrBuilder
AttestationOccurrenceOrBuilder
BatchCreateNotesRequestOrBuilder
BatchCreateNotesResponseOrBuilder
BatchCreateOccurrencesRequestOrBuilder
BatchCreateOccurrencesResponseOrBuilder
BuildNoteOrBuilder
BuildOccurrenceOrBuilder
BuildProvenanceOrBuilder
CloudRepoSourceContextOrBuilder
CommandOrBuilder
CreateNoteRequestOrBuilder
CreateOccurrenceRequestOrBuilder
CVSSv3OrBuilder
DeleteNoteRequestOrBuilder
DeleteOccurrenceRequestOrBuilder
DeploymentNoteOrBuilder
DeploymentOccurrenceOrBuilder
DiscoveryNoteOrBuilder
DiscoveryOccurrenceOrBuilder
DistributionOrBuilder
FileHashesOrBuilder
FingerprintOrBuilder
GerritSourceContextOrBuilder
GetNoteRequestOrBuilder
GetOccurrenceNoteRequestOrBuilder
GetOccurrenceRequestOrBuilder
GitSourceContextOrBuilder
HashOrBuilder
ImageNoteOrBuilder
ImageOccurrenceOrBuilder
LayerOrBuilder
ListNoteOccurrencesRequestOrBuilder
ListNoteOccurrencesResponseOrBuilder
ListNotesRequestOrBuilder
ListNotesResponseOrBuilder
ListOccurrencesRequestOrBuilder
ListOccurrencesResponseOrBuilder
LocationOrBuilder
NoteOrBuilder
OccurrenceOrBuilder
PackageNoteOrBuilder
PackageOccurrenceOrBuilder
ProjectRepoIdOrBuilder
RelatedUrlOrBuilder
RepoIdOrBuilder
SignatureOrBuilder
SourceContextOrBuilder
SourceOrBuilder
UpdateNoteRequestOrBuilder
UpdateOccurrenceRequestOrBuilder
VersionOrBuilder
VulnerabilityNote.DetailOrBuilder
VulnerabilityNote.WindowsDetail.KnowledgeBaseOrBuilder
VulnerabilityNote.WindowsDetailOrBuilder
VulnerabilityNoteOrBuilder
VulnerabilityOccurrence.PackageIssueOrBuilder
VulnerabilityOccurrenceOrBuilder

Class Summary

Class	Description
AliasContext	An alias to a repo revision.
AliasContext.Builder	An alias to a repo revision.
Artifact	Artifact describes a build product.
Artifact.Builder	Artifact describes a build product.
Attestation
AttestationNote	Note kind that represents a logical attestation "role" or "authority".
AttestationNote.Builder	Note kind that represents a logical attestation "role" or "authority".
AttestationNote.Hint	This submessage provides human-readable hints about the purpose of the authority.
AttestationNote.Hint.Builder	This submessage provides human-readable hints about the purpose of the authority.
AttestationOccurrence	Occurrence that represents a single "attestation".
AttestationOccurrence.Builder	Occurrence that represents a single "attestation".
BatchCreateNotesRequest	Request to create notes in batch.
BatchCreateNotesRequest.Builder	Request to create notes in batch.
BatchCreateNotesResponse	Response for creating notes in batch.
BatchCreateNotesResponse.Builder	Response for creating notes in batch.
BatchCreateOccurrencesRequest	Request to create occurrences in batch.
BatchCreateOccurrencesRequest.Builder	Request to create occurrences in batch.
BatchCreateOccurrencesResponse	Response for creating occurrences in batch.
BatchCreateOccurrencesResponse.Builder	Response for creating occurrences in batch.
Build
BuildNote	Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence.
BuildNote.Builder	Note holding the version of the provider's builder and the signature of the provenance message in the build details occurrence.
BuildOccurrence	Details of a build occurrence.
BuildOccurrence.Builder	Details of a build occurrence.
BuildProvenance	Provenance of a build.
BuildProvenance.Builder	Provenance of a build.
CloudRepoSourceContext	A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo.
CloudRepoSourceContext.Builder	A CloudRepoSourceContext denotes a particular revision in a Google Cloud Source Repo.
Command	Command describes a step performed as part of the build pipeline.
Command.Builder	Command describes a step performed as part of the build pipeline.
Common
CreateNoteRequest	Request to create a new note.
CreateNoteRequest.Builder	Request to create a new note.
CreateOccurrenceRequest	Request to create a new occurrence.
CreateOccurrenceRequest.Builder	Request to create a new occurrence.
Cvss
CVSSv3	Common Vulnerability Scoring System version 3.
CVSSv3.Builder	Common Vulnerability Scoring System version 3.
DeleteNoteRequest	Request to delete a note.
DeleteNoteRequest.Builder	Request to delete a note.
DeleteOccurrenceRequest	Request to delete a occurrence.
DeleteOccurrenceRequest.Builder	Request to delete a occurrence.
Deployment
DeploymentNote	An artifact that can be deployed in some runtime.
DeploymentNote.Builder	An artifact that can be deployed in some runtime.
DeploymentOccurrence	The period during which some deployable was active in a runtime.
DeploymentOccurrence.Builder	The period during which some deployable was active in a runtime.
Discovery
DiscoveryNote	A note that indicates a type of analysis a provider would perform.
DiscoveryNote.Builder	A note that indicates a type of analysis a provider would perform.
DiscoveryOccurrence	Provides information about the analysis status of a discovered resource.
DiscoveryOccurrence.Builder	Provides information about the analysis status of a discovered resource.
Distribution	This represents a particular channel of distribution for a given package.
Distribution.Builder	This represents a particular channel of distribution for a given package.
FileHashes	Container message for hashes of byte content of files, used in source messages to verify integrity of source input to the build.
FileHashes.Builder	Container message for hashes of byte content of files, used in source messages to verify integrity of source input to the build.
Fingerprint	A set of properties that uniquely identify a given Docker image.
Fingerprint.Builder	A set of properties that uniquely identify a given Docker image.
GerritSourceContext	A SourceContext referring to a Gerrit project.
GerritSourceContext.Builder	A SourceContext referring to a Gerrit project.
GetNoteRequest	Request to get a note.
GetNoteRequest.Builder	Request to get a note.
GetOccurrenceNoteRequest	Request to get the note to which the specified occurrence is attached.
GetOccurrenceNoteRequest.Builder	Request to get the note to which the specified occurrence is attached.
GetOccurrenceRequest	Request to get an occurrence.
GetOccurrenceRequest.Builder	Request to get an occurrence.
GitSourceContext	A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub).
GitSourceContext.Builder	A GitSourceContext denotes a particular revision in a third party Git repository (e.g., GitHub).
GrafeasClient	Service Description: [Grafeas](https://grafeas.io) API.
GrafeasClient.ListNoteOccurrencesFixedSizeCollection
GrafeasClient.ListNoteOccurrencesPage
GrafeasClient.ListNoteOccurrencesPagedResponse
GrafeasClient.ListNotesFixedSizeCollection
GrafeasClient.ListNotesPage
GrafeasClient.ListNotesPagedResponse
GrafeasClient.ListOccurrencesFixedSizeCollection
GrafeasClient.ListOccurrencesPage
GrafeasClient.ListOccurrencesPagedResponse
GrafeasGrpc	[Grafeas](https://grafeas.io) API.
GrafeasGrpc.GrafeasBlockingStub	[Grafeas](https://grafeas.io) API.
GrafeasGrpc.GrafeasFutureStub	[Grafeas](https://grafeas.io) API.
GrafeasGrpc.GrafeasImplBase	[Grafeas](https://grafeas.io) API.
GrafeasGrpc.GrafeasStub	[Grafeas](https://grafeas.io) API.
GrafeasOuterClass
GrafeasSettings	Settings class to configure an instance of GrafeasClient.
GrafeasSettings.Builder	Builder for GrafeasSettings.
Hash	Container message for hash values.
Hash.Builder	Container message for hash values.
Image
ImageNote	Basis describes the base image portion (Note) of the DockerImage relationship.
ImageNote.Builder	Basis describes the base image portion (Note) of the DockerImage relationship.
ImageOccurrence	Details of the derived image portion of the DockerImage relationship.
ImageOccurrence.Builder	Details of the derived image portion of the DockerImage relationship.
Layer	Layer holds metadata specific to a layer of a Docker image.
Layer.Builder	Layer holds metadata specific to a layer of a Docker image.
ListNoteOccurrencesRequest	Request to list occurrences for a note.
ListNoteOccurrencesRequest.Builder	Request to list occurrences for a note.
ListNoteOccurrencesResponse	Response for listing occurrences for a note.
ListNoteOccurrencesResponse.Builder	Response for listing occurrences for a note.
ListNotesRequest	Request to list notes.
ListNotesRequest.Builder	Request to list notes.
ListNotesResponse	Response for listing notes.
ListNotesResponse.Builder	Response for listing notes.
ListOccurrencesRequest	Request to list occurrences.
ListOccurrencesRequest.Builder	Request to list occurrences.
ListOccurrencesResponse	Response for listing occurrences.
ListOccurrencesResponse.Builder	Response for listing occurrences.
Location	An occurrence of a particular package installation found within a system's filesystem.
Location.Builder	An occurrence of a particular package installation found within a system's filesystem.
Note	A type of analysis that can be done for a resource.
Note.Builder	A type of analysis that can be done for a resource.
NoteName
NoteName.Builder	Builder for NoteName.
Occurrence	An instance of an analysis type that has been found on a resource.
Occurrence.Builder	An instance of an analysis type that has been found on a resource.
OccurrenceName
OccurrenceName.Builder	Builder for OccurrenceName.
Package
PackageNote	This represents a particular package that is distributed over various channels.
PackageNote.Builder	This represents a particular package that is distributed over various channels.
PackageOccurrence	Details on how a particular software package was installed on a system.
PackageOccurrence.Builder	Details on how a particular software package was installed on a system.
ProjectName
ProjectName.Builder	Builder for ProjectName.
ProjectRepoId	Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project.
ProjectRepoId.Builder	Selects a repo using a Google Cloud Platform project ID (e.g., winged-cargo-31) and a repo name within that project.
Provenance
RelatedUrl	Metadata for any related URL information.
RelatedUrl.Builder	Metadata for any related URL information.
RepoId	A unique identifier for a Cloud Repo.
RepoId.Builder	A unique identifier for a Cloud Repo.
Signature	Verifiers (e.g.
Signature.Builder	Verifiers (e.g.
Source	Source describes the location of the source used for the build.
Source.Builder	Source describes the location of the source used for the build.
SourceContext	A SourceContext is a reference to a tree of files.
SourceContext.Builder	A SourceContext is a reference to a tree of files.
UpdateNoteRequest	Request to update a note.
UpdateNoteRequest.Builder	Request to update a note.
UpdateOccurrenceRequest	Request to update an occurrence.
UpdateOccurrenceRequest.Builder	Request to update an occurrence.
Version	Version contains structured information about the version of a package.
Version.Builder	Version contains structured information about the version of a package.
Vulnerability
VulnerabilityNote	A security vulnerability that can be found in resources.
VulnerabilityNote.Builder	A security vulnerability that can be found in resources.
VulnerabilityNote.Detail	A detail for a distro and package affected by this vulnerability and its associated fix (if one is available).
VulnerabilityNote.Detail.Builder	A detail for a distro and package affected by this vulnerability and its associated fix (if one is available).
VulnerabilityNote.WindowsDetail	Protobuf type grafeas.v1.VulnerabilityNote.WindowsDetail
VulnerabilityNote.WindowsDetail.Builder	Protobuf type grafeas.v1.VulnerabilityNote.WindowsDetail
VulnerabilityNote.WindowsDetail.KnowledgeBase	Protobuf type grafeas.v1.VulnerabilityNote.WindowsDetail.KnowledgeBase
VulnerabilityNote.WindowsDetail.KnowledgeBase.Builder	Protobuf type grafeas.v1.VulnerabilityNote.WindowsDetail.KnowledgeBase
VulnerabilityOccurrence	An occurrence of a severity vulnerability on a resource.
VulnerabilityOccurrence.Builder	An occurrence of a severity vulnerability on a resource.
VulnerabilityOccurrence.PackageIssue	A detail for a distro and package this vulnerability occurrence was found in and its associated fix (if one is available).
VulnerabilityOccurrence.PackageIssue.Builder	A detail for a distro and package this vulnerability occurrence was found in and its associated fix (if one is available).

Enum Summary

Enum	Description
AliasContext.Kind	The type of an alias.
Architecture	Instruction set architectures supported by various package managers.
CloudRepoSourceContext.RevisionCase
CVSSv3.AttackComplexity	Protobuf enum grafeas.v1.CVSSv3.AttackComplexity
CVSSv3.AttackVector	Protobuf enum grafeas.v1.CVSSv3.AttackVector
CVSSv3.Impact	Protobuf enum grafeas.v1.CVSSv3.Impact
CVSSv3.PrivilegesRequired	Protobuf enum grafeas.v1.CVSSv3.PrivilegesRequired
CVSSv3.Scope	Protobuf enum grafeas.v1.CVSSv3.Scope
CVSSv3.UserInteraction	Protobuf enum grafeas.v1.CVSSv3.UserInteraction
DeploymentOccurrence.Platform	Types of platforms.
DiscoveryOccurrence.AnalysisStatus	Analysis status for a resource.
DiscoveryOccurrence.ContinuousAnalysis	Whether the resource is continuously analyzed.
GerritSourceContext.RevisionCase
Note.TypeCase
NoteKind	Kind represents the kinds of notes supported.
Occurrence.DetailsCase
RepoId.IdCase
Severity	Note provider assigned severity/impact ranking.
SourceContext.ContextCase
Version.VersionKind	Whether this is an ordinary package version or a sentinel MIN/MAX version.

Package io.grafeas.v1 Description

A client to Container Analysis API.

The interfaces provided are listed below, along with usage samples.

============= GrafeasClient =============

Service Description: [Grafeas](https://grafeas.io) API.

Retrieves analysis results of Cloud components such as Docker container images.

Analysis results are stored as a series of occurrences. An `Occurrence` contains information about a specific analysis instance on a resource. An occurrence refers to a `Note`. A note contains details describing the analysis and is generally stored in a separate project, called a `Provider`. Multiple occurrences can refer to the same note.

For example, an SSL vulnerability could affect multiple images. In this case, there would be one note for the vulnerability and an occurrence for each image with the vulnerability referring to that note.

Sample for GrafeasClient:

 
 try (GrafeasClient grafeasClient = GrafeasClient.create()) {
   OccurrenceName name = OccurrenceName.of("[PROJECT]", "[OCCURRENCE]");
   Occurrence response = grafeasClient.getOccurrence(name);
 }