• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright 2022 Google LLC
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      https://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 /**
18  * A client to Container Analysis API
19  *
20  * <p>The interfaces provided are listed below, along with usage samples.
21  *
22  * <p>======================= GrafeasClient =======================
23  *
24  * <p>Service Description: [Grafeas](https://grafeas.io) API.
25  *
26  * <p>Retrieves analysis results of Cloud components such as Docker container images.
27  *
28  * <p>Analysis results are stored as a series of occurrences. An `Occurrence` contains information
29  * about a specific analysis instance on a resource. An occurrence refers to a `Note`. A note
30  * contains details describing the analysis and is generally stored in a separate project, called a
31  * `Provider`. Multiple occurrences can refer to the same note.
32  *
33  * <p>For example, an SSL vulnerability could affect multiple images. In this case, there would be
34  * one note for the vulnerability and an occurrence for each image with the vulnerability referring
35  * to that note.
36  *
37  * <p>Sample for GrafeasClient:
38  *
39  * <pre>{@code
40  * // This snippet has been automatically generated and should be regarded as a code template only.
41  * // It will require modifications to work:
42  * // - It may require correct/in-range values for request initialization.
43  * // - It may require specifying regional endpoints when creating the service client as shown in
44  * // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
45  * try (GrafeasClient grafeasClient = GrafeasClient.create()) {
46  *   OccurrenceName name = OccurrenceName.of("[PROJECT]", "[OCCURRENCE]");
47  *   Occurrence response = grafeasClient.getOccurrence(name);
48  * }
49  * }</pre>
50  */
51 @Generated("by gapic-generator-java")
52 package io.grafeas.v1;
53 
54 import javax.annotation.Generated;
55