2.100.0 (latest) 2.96.0 2.95.0 2.94.0 2.92.0 2.89.0 2.88.0 2.86.0 2.84.0 2.83.0 2.82.0 2.81.0 2.79.0 2.77.0 2.76.0 2.75.0 2.74.0 2.73.0 2.71.0 2.69.0 2.68.0 2.65.0 2.64.0 2.63.0 2.61.0 2.60.0 2.59.0 2.58.0 2.57.0 2.56.0 2.55.0 2.54.0 2.53.0 2.52.0 2.50.0 2.49.0 2.48.0 2.47.0 2.46.0 2.45.0 2.44.0 2.43.0 2.42.0 2.41.0 2.40.0 2.38.0 2.37.0 2.36.0 2.35.0 2.34.0 2.33.0 2.32.0 2.31.0 2.30.0 2.29.0 2.28.0 2.25.0 2.24.0 2.23.0 2.22.0 2.21.0 2.20.0 2.19.0 2.18.0 2.17.0 2.16.0 2.15.0 2.14.0 2.13.0 2.12.0 2.11.0 2.10.0 2.9.0 2.8.0 2.7.0 2.6.0 2.5.0 2.4.10 2.3.1 2.2.16

|---|---|
| [GitHub Repository](https://github.com/googleapis/google-cloud-java/tree/main/java-containeranalysis/google-cloud-containeranalysis/src/main/java/com/google/cloud/devtools/containeranalysis/v1/ContainerAnalysisClient.java) | [Product Reference](https://cloud.google.com/container-registry/docs/container-analysis) |

Service Description: Retrieves analysis results of Cloud components such as Docker container
images. The Container Analysis API is an implementation of the [Grafeas](https://grafeas.io) API.

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.

This class provides the ability to make remote calls to the backing service through method
calls that map to API methods. Sample code to get started:


     // This snippet has been automatically generated and should be regarded as a code template only.
     // It will require modifications to work:
     // - It may require correct/in-range values for request initialization.
     // - It may require specifying regional endpoints when creating the service client as shown in
     // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
     try (ContainerAnalysisClient containerAnalysisClient = ContainerAnalysisClient.create()) {
       ResourceName resource =
           new ResourceName() {
             {@literal @}Override
             public Map<String, String> getFieldValuesMap() {
               Map<String, String> fieldValuesMap = new HashMap<>();
               fieldValuesMap.put("resource", "projects/project-8432/notes/note-8432");
               return fieldValuesMap;
             }

             {@literal @}Override
             public String getFieldValue(String fieldName) {
               return getFieldValuesMap().get(fieldName);
             }

             {@literal @}Override
             public String toString() {
               return "projects/project-8432/notes/note-8432";
             }
           };
       Policy policy = Policy.newBuilder().build();
       Policy response = containerAnalysisClient.setIamPolicy(resource, policy);
     }
     
Note: close() needs to be called on the ContainerAnalysisClient object to clean up resources
such as threads. In the example above, try-with-resources is used, which automatically calls
close().

| Method | Description | Method Variants |
|---|---|---|
| SetIamPolicy | 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. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. | Request object method variants only take one parameter, a request object, which must be constructed before the call. - setIamPolicy(SetIamPolicyRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - setIamPolicy(ResourceName resource, Policy policy) - setIamPolicy(String resource, Policy policy) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - setIamPolicyCallable() |
| GetIamPolicy | 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. The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. | Request object method variants only take one parameter, a request object, which must be constructed before the call. - getIamPolicy(GetIamPolicyRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - getIamPolicy(ResourceName resource) - getIamPolicy(String resource) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - getIamPolicyCallable() |
| TestIamPermissions | Returns the permissions that a caller has on the specified note or occurrence. Requires list permission on the project (for example, `containeranalysis.notes.list`). The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and `projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences. | Request object method variants only take one parameter, a request object, which must be constructed before the call. - testIamPermissions(TestIamPermissionsRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - testIamPermissions(ResourceName resource, List\<String\> permissions) - testIamPermissions(String resource, List\<String\> permissions) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - testIamPermissionsCallable() |
| GetVulnerabilityOccurrencesSummary | Gets a summary of the number and severity of occurrences. | Request object method variants only take one parameter, a request object, which must be constructed before the call. - getVulnerabilityOccurrencesSummary(GetVulnerabilityOccurrencesSummaryRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. - getVulnerabilityOccurrencesSummary(ProjectName parent, String filter) - getVulnerabilityOccurrencesSummary(String parent, String filter) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - getVulnerabilityOccurrencesSummaryCallable() |
| ExportSBOM | Generates an SBOM for the given resource. | Request object method variants only take one parameter, a request object, which must be constructed before the call. - exportSBOM(ExportSBOMRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. - exportSBOMCallable() |
[Methods]

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with
these names, this class includes a format method for each type of name, and additionally a parse
method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of ContainerAnalysisSettings to
create(). For example:

To customize credentials:


     // This snippet has been automatically generated and should be regarded as a code template only.
     // It will require modifications to work:
     // - It may require correct/in-range values for request initialization.
     // - It may require specifying regional endpoints when creating the service client as shown in
     // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
     ContainerAnalysisSettings containerAnalysisSettings =
         ContainerAnalysisSettings.newBuilder()
             .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
             .build();
     ContainerAnalysisClient containerAnalysisClient =
         ContainerAnalysisClient.create(containerAnalysisSettings);
     
To customize the endpoint:


     // This snippet has been automatically generated and should be regarded as a code template only.
     // It will require modifications to work:
     // - It may require correct/in-range values for request initialization.
     // - It may require specifying regional endpoints when creating the service client as shown in
     // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
     ContainerAnalysisSettings containerAnalysisSettings =
         ContainerAnalysisSettings.newBuilder().setEndpoint(myEndpoint).build();
     ContainerAnalysisClient containerAnalysisClient =
         ContainerAnalysisClient.create(containerAnalysisSettings);
     
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over
the wire:


     // This snippet has been automatically generated and should be regarded as a code template only.
     // It will require modifications to work:
     // - It may require correct/in-range values for request initialization.
     // - It may require specifying regional endpoints when creating the service client as shown in
     // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
     ContainerAnalysisSettings containerAnalysisSettings =
         ContainerAnalysisSettings.newHttpJsonBuilder().build();
     ContainerAnalysisClient containerAnalysisClient =
         ContainerAnalysisClient.create(containerAnalysisSettings);
     
Please refer to the GitHub repository's samples for more quickstart code snippets.

## Inheritance

[java.lang.Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html) \> ContainerAnalysisClient

## Static Methods

### create()

    public static final ContainerAnalysisClient create()

Constructs an instance of ContainerAnalysisClient with default settings.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-containeranalysis/latest/com.google.cloud.devtools.containeranalysis.v1.ContainerAnalysisClient` |   |

| **Exceptions** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html` |   |

### create(ContainerAnalysisSettings settings)

    public static final ContainerAnalysisClient create(ContainerAnalysisSettings settings)

Constructs an instance of ContainerAnalysisClient, using the given settings. The channels are
created based on the settings passed in, or defaults for any settings that are not set.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `settings` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-containeranalysis/latest/com.google.cloud.devtools.containeranalysis.v1.ContainerAnalysisSettings` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-containeranalysis/latest/com.google.cloud.devtools.containeranalysis.v1.ContainerAnalysisClient` |   |

| **Exceptions** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html` |   |

### create(ContainerAnalysisStub stub)

    public static final ContainerAnalysisClient create(ContainerAnalysisStub stub)

Constructs an instance of ContainerAnalysisClient, using the given stub for making calls. This
is for advanced usage - prefer using create(ContainerAnalysisSettings).

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `stub` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-containeranalysis/latest/com.google.cloud.devtools.containeranalysis.v1.stub.ContainerAnalysisStub` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-containeranalysis/latest/com.google.cloud.devtools.containeranalysis.v1.ContainerAnalysisClient` |   |

## Constructors

### ContainerAnalysisClient(ContainerAnalysisSettings settings)

    protected ContainerAnalysisClient(ContainerAnalysisSettings settings)

Constructs an instance of ContainerAnalysisClient, using the given settings. This is protected
so that it is easy to make a subclass, but otherwise, the static factory methods should be
preferred.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `settings` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-containeranalysis/latest/com.google.cloud.devtools.containeranalysis.v1.ContainerAnalysisSettings` |

### ContainerAnalysisClient(ContainerAnalysisStub stub)

    protected ContainerAnalysisClient(ContainerAnalysisStub stub)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `stub` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-containeranalysis/latest/com.google.cloud.devtools.containeranalysis.v1.stub.ContainerAnalysisStub` |

## Methods

### awaitTermination(long duration, TimeUnit unit)

    public boolean awaitTermination(long duration, TimeUnit unit)

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `duration` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |
| `unit` | `https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/TimeUnit.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

| **Exceptions** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html` |   |

### close()

    public final void close()

### exportSBOM(ExportSBOMRequest request)

    public final ExportSBOMResponse exportSBOM(ExportSBOMRequest request)

Generates an SBOM for the given resource.

Sample code:


     // This snippet has been automatically generated and should be regarded as a code template only.
     // It will require modifications to work:
     // - It may require correct/in-range values for request initialization.
     // - It may require specifying regional endpoints when creating the service client as shown in
     // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
     try (ContainerAnalysisClient containerAnalysisClient = ContainerAnalysisClient.create()) {
       ExportSBOMRequest request = ExportSBOMRequest.newBuilder().setName("name3373707").build();
       ExportSBOMResponse response = containerAnalysisClient.exportSBOM(request);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-containeranalysis/latest/com.google.containeranalysis.v1.ExportSBOMRequest` The request object containing all of the parameters for the API call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-containeranalysis/latest/com.google.containeranalysis.v1.ExportSBOMResponse` |   |

### exportSBOMCallable()

    public final UnaryCallable<ExportSBOMRequest,ExportSBOMResponse> exportSBOMCallable()

Generates an SBOM for the given resource.

Sample code:


     // This snippet has been automatically generated and should be regarded as a code template only.
     // It will require modifications to work:
     // - It may require correct/in-range values for request initialization.
     // - It may require specifying regional endpoints when creating the service client as shown in
     // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
     try (ContainerAnalysisClient containerAnalysisClient = ContainerAnalysisClient.create()) {
       ExportSBOMRequest request = ExportSBOMRequest.newBuilder().setName("name3373707").build();
       ApiFuture<ExportSBOMResponse> future =
           containerAnalysisClient.exportSBOMCallable().futureCall(request);
       // Do something.
       ExportSBOMResponse response = future.get();
     }
     
| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.UnaryCallable.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-containeranalysis/latest/com.google.containeranalysis.v1.ExportSBOMRequest,https://docs.cloud.google.com/java/docs/reference/google-cloud-containeranalysis/latest/com.google.containeranalysis.v1.ExportSBOMResponse>` |   |

### getGrafeasClient()

    public GrafeasClient getGrafeasClient()

Returns a new GrafeasClient with the same configured settings.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `io.grafeas.v1.GrafeasClient` |   |

| **Exceptions** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html` |   |

### getIamPolicy(@Nullable ResourceName resource)

    public final Policy getIamPolicy(@Nullable ResourceName resource)

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.

The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and
`projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.

Sample code:


     // This snippet has been automatically generated and should be regarded as a code template only.
     // It will require modifications to work:
     // - It may require correct/in-range values for request initialization.
     // - It may require specifying regional endpoints when creating the service client as shown in
     // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
     try (ContainerAnalysisClient containerAnalysisClient = ContainerAnalysisClient.create()) {
       ResourceName resource =
           new ResourceName() {
             {@literal @}Override
             public Map<String, String> getFieldValuesMap() {
               Map<String, String> fieldValuesMap = new HashMap<>();
               fieldValuesMap.put("resource", "projects/project-8432/notes/note-8432");
               return fieldValuesMap;
             }

             {@literal @}Override
             public String getFieldValue(String fieldName) {
               return getFieldValuesMap().get(fieldName);
             }

             {@literal @}Override
             public String toString() {
               return "projects/project-8432/notes/note-8432";
             }
           };
       Policy response = containerAnalysisClient.getIamPolicy(resource);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `resource` | `@org.jspecify.annotations.Nullable com.google.api.resourcenames.ResourceName` REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `com.google.iam.v1.Policy` |   |

### getIamPolicy(GetIamPolicyRequest request)

    public final Policy getIamPolicy(GetIamPolicyRequest request)

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.

The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and
`projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.

Sample code:


     // This snippet has been automatically generated and should be regarded as a code template only.
     // It will require modifications to work:
     // - It may require correct/in-range values for request initialization.
     // - It may require specifying regional endpoints when creating the service client as shown in
     // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
     try (ContainerAnalysisClient containerAnalysisClient = ContainerAnalysisClient.create()) {
       GetIamPolicyRequest request =
           GetIamPolicyRequest.newBuilder()
               .setResource("GetIamPolicyRequest-1527610370".toString())
               .setOptions(GetPolicyOptions.newBuilder().build())
               .build();
       Policy response = containerAnalysisClient.getIamPolicy(request);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `request` | `com.google.iam.v1.GetIamPolicyRequest` The request object containing all of the parameters for the API call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `com.google.iam.v1.Policy` |   |

### getIamPolicy(String resource)

    public final Policy getIamPolicy(String resource)

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.

The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and
`projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.

Sample code:


     // This snippet has been automatically generated and should be regarded as a code template only.
     // It will require modifications to work:
     // - It may require correct/in-range values for request initialization.
     // - It may require specifying regional endpoints when creating the service client as shown in
     // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
     try (ContainerAnalysisClient containerAnalysisClient = ContainerAnalysisClient.create()) {
       String resource = ProjectName.of("[PROJECT]").toString();
       Policy response = containerAnalysisClient.getIamPolicy(resource);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `resource` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `com.google.iam.v1.Policy` |   |

### getIamPolicyCallable()

    public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()

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.

The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and
`projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.

Sample code:


     // This snippet has been automatically generated and should be regarded as a code template only.
     // It will require modifications to work:
     // - It may require correct/in-range values for request initialization.
     // - It may require specifying regional endpoints when creating the service client as shown in
     // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
     try (ContainerAnalysisClient containerAnalysisClient = ContainerAnalysisClient.create()) {
       GetIamPolicyRequest request =
           GetIamPolicyRequest.newBuilder()
               .setResource("GetIamPolicyRequest-1527610370".toString())
               .setOptions(GetPolicyOptions.newBuilder().build())
               .build();
       ApiFuture<Policy> future = containerAnalysisClient.getIamPolicyCallable().futureCall(request);
       // Do something.
       Policy response = future.get();
     }
     
| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.UnaryCallable.html<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>` |   |

### getSettings()

    public final @Nullable ContainerAnalysisSettings getSettings()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `@org.jspecify.annotations.Nullable com.google.cloud.devtools.containeranalysis.v1.ContainerAnalysisSettings` |   |

### getStub()

    public ContainerAnalysisStub getStub()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-containeranalysis/latest/com.google.cloud.devtools.containeranalysis.v1.stub.ContainerAnalysisStub` |   |

### getVulnerabilityOccurrencesSummary(@Nullable ProjectName parent, String filter)

    public final VulnerabilityOccurrencesSummary getVulnerabilityOccurrencesSummary(@Nullable ProjectName parent, String filter)

Gets a summary of the number and severity of occurrences.

Sample code:


     // This snippet has been automatically generated and should be regarded as a code template only.
     // It will require modifications to work:
     // - It may require correct/in-range values for request initialization.
     // - It may require specifying regional endpoints when creating the service client as shown in
     // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
     try (ContainerAnalysisClient containerAnalysisClient = ContainerAnalysisClient.create()) {
       ProjectName parent = ProjectName.of("[PROJECT]");
       String filter = "filter-1274492040";
       VulnerabilityOccurrencesSummary response =
           containerAnalysisClient.getVulnerabilityOccurrencesSummary(parent, filter);
     }
     
| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `parent` | `@org.jspecify.annotations.Nullable com.google.containeranalysis.v1.ProjectName` Required. The name of the project to get a vulnerability summary for in the form of `projects/[PROJECT_ID]`. |
| `filter` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` The filter expression. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-containeranalysis/latest/com.google.containeranalysis.v1.VulnerabilityOccurrencesSummary` |   |

### getVulnerabilityOccurrencesSummary(GetVulnerabilityOccurrencesSummaryRequest request)

    public final VulnerabilityOccurrencesSummary getVulnerabilityOccurrencesSummary(GetVulnerabilityOccurrencesSummaryRequest request)

Gets a summary of the number and severity of occurrences.

Sample code:


     // This snippet has been automatically generated and should be regarded as a code template only.
     // It will require modifications to work:
     // - It may require correct/in-range values for request initialization.
     // - It may require specifying regional endpoints when creating the service client as shown in
     // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
     try (ContainerAnalysisClient containerAnalysisClient = ContainerAnalysisClient.create()) {
       GetVulnerabilityOccurrencesSummaryRequest request =
           GetVulnerabilityOccurrencesSummaryRequest.newBuilder()
               .setParent(ProjectName.of("[PROJECT]").toString())
               .setFilter("filter-1274492040")
               .build();
       VulnerabilityOccurrencesSummary response =
           containerAnalysisClient.getVulnerabilityOccurrencesSummary(request);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `request` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-containeranalysis/latest/com.google.containeranalysis.v1.GetVulnerabilityOccurrencesSummaryRequest` The request object containing all of the parameters for the API call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-containeranalysis/latest/com.google.containeranalysis.v1.VulnerabilityOccurrencesSummary` |   |

### getVulnerabilityOccurrencesSummary(String parent, String filter)

    public final VulnerabilityOccurrencesSummary getVulnerabilityOccurrencesSummary(String parent, String filter)

Gets a summary of the number and severity of occurrences.

Sample code:


     // This snippet has been automatically generated and should be regarded as a code template only.
     // It will require modifications to work:
     // - It may require correct/in-range values for request initialization.
     // - It may require specifying regional endpoints when creating the service client as shown in
     // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
     try (ContainerAnalysisClient containerAnalysisClient = ContainerAnalysisClient.create()) {
       String parent = ProjectName.of("[PROJECT]").toString();
       String filter = "filter-1274492040";
       VulnerabilityOccurrencesSummary response =
           containerAnalysisClient.getVulnerabilityOccurrencesSummary(parent, filter);
     }
     
| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `parent` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` Required. The name of the project to get a vulnerability summary for in the form of `projects/[PROJECT_ID]`. |
| `filter` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` The filter expression. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-containeranalysis/latest/com.google.containeranalysis.v1.VulnerabilityOccurrencesSummary` |   |

### getVulnerabilityOccurrencesSummaryCallable()

    public final UnaryCallable<GetVulnerabilityOccurrencesSummaryRequest,VulnerabilityOccurrencesSummary> getVulnerabilityOccurrencesSummaryCallable()

Gets a summary of the number and severity of occurrences.

Sample code:


     // This snippet has been automatically generated and should be regarded as a code template only.
     // It will require modifications to work:
     // - It may require correct/in-range values for request initialization.
     // - It may require specifying regional endpoints when creating the service client as shown in
     // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
     try (ContainerAnalysisClient containerAnalysisClient = ContainerAnalysisClient.create()) {
       GetVulnerabilityOccurrencesSummaryRequest request =
           GetVulnerabilityOccurrencesSummaryRequest.newBuilder()
               .setParent(ProjectName.of("[PROJECT]").toString())
               .setFilter("filter-1274492040")
               .build();
       ApiFuture<VulnerabilityOccurrencesSummary> future =
           containerAnalysisClient.getVulnerabilityOccurrencesSummaryCallable().futureCall(request);
       // Do something.
       VulnerabilityOccurrencesSummary response = future.get();
     }
     
| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.UnaryCallable.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-containeranalysis/latest/com.google.containeranalysis.v1.GetVulnerabilityOccurrencesSummaryRequest,https://docs.cloud.google.com/java/docs/reference/google-cloud-containeranalysis/latest/com.google.containeranalysis.v1.VulnerabilityOccurrencesSummary>` |   |

### isShutdown()

    public boolean isShutdown()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

### isTerminated()

    public boolean isTerminated()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

### setIamPolicy(@Nullable ResourceName resource, Policy policy)

    public final Policy setIamPolicy(@Nullable ResourceName resource, Policy policy)

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.

The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and
`projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.

Sample code:


     // This snippet has been automatically generated and should be regarded as a code template only.
     // It will require modifications to work:
     // - It may require correct/in-range values for request initialization.
     // - It may require specifying regional endpoints when creating the service client as shown in
     // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
     try (ContainerAnalysisClient containerAnalysisClient = ContainerAnalysisClient.create()) {
       ResourceName resource =
           new ResourceName() {
             {@literal @}Override
             public Map<String, String> getFieldValuesMap() {
               Map<String, String> fieldValuesMap = new HashMap<>();
               fieldValuesMap.put("resource", "projects/project-8432/notes/note-8432");
               return fieldValuesMap;
             }

             {@literal @}Override
             public String getFieldValue(String fieldName) {
               return getFieldValuesMap().get(fieldName);
             }

             {@literal @}Override
             public String toString() {
               return "projects/project-8432/notes/note-8432";
             }
           };
       Policy policy = Policy.newBuilder().build();
       Policy response = containerAnalysisClient.setIamPolicy(resource, policy);
     }
     
| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `resource` | `@org.jspecify.annotations.Nullable com.google.api.resourcenames.ResourceName` REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
| `policy` | `com.google.iam.v1.Policy` REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `com.google.iam.v1.Policy` |   |

### setIamPolicy(SetIamPolicyRequest request)

    public final Policy setIamPolicy(SetIamPolicyRequest request)

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.

The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and
`projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.

Sample code:


     // This snippet has been automatically generated and should be regarded as a code template only.
     // It will require modifications to work:
     // - It may require correct/in-range values for request initialization.
     // - It may require specifying regional endpoints when creating the service client as shown in
     // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
     try (ContainerAnalysisClient containerAnalysisClient = ContainerAnalysisClient.create()) {
       SetIamPolicyRequest request =
           SetIamPolicyRequest.newBuilder()
               .setResource("SetIamPolicyRequest1223629066".toString())
               .setPolicy(Policy.newBuilder().build())
               .setUpdateMask(FieldMask.newBuilder().build())
               .build();
       Policy response = containerAnalysisClient.setIamPolicy(request);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `request` | `com.google.iam.v1.SetIamPolicyRequest` The request object containing all of the parameters for the API call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `com.google.iam.v1.Policy` |   |

### setIamPolicy(String resource, Policy policy)

    public final Policy setIamPolicy(String resource, Policy policy)

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.

The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and
`projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.

Sample code:


     // This snippet has been automatically generated and should be regarded as a code template only.
     // It will require modifications to work:
     // - It may require correct/in-range values for request initialization.
     // - It may require specifying regional endpoints when creating the service client as shown in
     // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
     try (ContainerAnalysisClient containerAnalysisClient = ContainerAnalysisClient.create()) {
       String resource = ProjectName.of("[PROJECT]").toString();
       Policy policy = Policy.newBuilder().build();
       Policy response = containerAnalysisClient.setIamPolicy(resource, policy);
     }
     
| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `resource` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. |
| `policy` | `com.google.iam.v1.Policy` REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `com.google.iam.v1.Policy` |   |

### setIamPolicyCallable()

    public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()

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.

The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and
`projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.

Sample code:


     // This snippet has been automatically generated and should be regarded as a code template only.
     // It will require modifications to work:
     // - It may require correct/in-range values for request initialization.
     // - It may require specifying regional endpoints when creating the service client as shown in
     // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
     try (ContainerAnalysisClient containerAnalysisClient = ContainerAnalysisClient.create()) {
       SetIamPolicyRequest request =
           SetIamPolicyRequest.newBuilder()
               .setResource("SetIamPolicyRequest1223629066".toString())
               .setPolicy(Policy.newBuilder().build())
               .setUpdateMask(FieldMask.newBuilder().build())
               .build();
       ApiFuture<Policy> future = containerAnalysisClient.setIamPolicyCallable().futureCall(request);
       // Do something.
       Policy response = future.get();
     }
     
| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.UnaryCallable.html<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>` |   |

### shutdown()

    public void shutdown()

### shutdownNow()

    public void shutdownNow()

### testIamPermissions(@Nullable ResourceName resource, List\<String\> permissions)

    public final TestIamPermissionsResponse testIamPermissions(@Nullable ResourceName resource, List<String> permissions)

Returns the permissions that a caller has on the specified note or occurrence. Requires list
permission on the project (for example, `containeranalysis.notes.list`).

The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and
`projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.

Sample code:


     // This snippet has been automatically generated and should be regarded as a code template only.
     // It will require modifications to work:
     // - It may require correct/in-range values for request initialization.
     // - It may require specifying regional endpoints when creating the service client as shown in
     // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
     try (ContainerAnalysisClient containerAnalysisClient = ContainerAnalysisClient.create()) {
       ResourceName resource =
           new ResourceName() {
             {@literal @}Override
             public Map<String, String> getFieldValuesMap() {
               Map<String, String> fieldValuesMap = new HashMap<>();
               fieldValuesMap.put("resource", "projects/project-8432/notes/note-8432");
               return fieldValuesMap;
             }

             {@literal @}Override
             public String getFieldValue(String fieldName) {
               return getFieldValuesMap().get(fieldName);
             }

             {@literal @}Override
             public String toString() {
               return "projects/project-8432/notes/note-8432";
             }
           };
       List<String> permissions = new ArrayList<>();
       TestIamPermissionsResponse response =
           containerAnalysisClient.testIamPermissions(resource, permissions);
     }
     
| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `resource` | `@org.jspecify.annotations.Nullable com.google.api.resourcenames.ResourceName` REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. |
| `permissions` | `https://docs.oracle.com/javase/8/docs/api/java/util/List.html<https://docs.oracle.com/javase/8/docs/api/java/lang/String.html>` 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). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `com.google.iam.v1.TestIamPermissionsResponse` |   |

### testIamPermissions(TestIamPermissionsRequest request)

    public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)

Returns the permissions that a caller has on the specified note or occurrence. Requires list
permission on the project (for example, `containeranalysis.notes.list`).

The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and
`projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.

Sample code:


     // This snippet has been automatically generated and should be regarded as a code template only.
     // It will require modifications to work:
     // - It may require correct/in-range values for request initialization.
     // - It may require specifying regional endpoints when creating the service client as shown in
     // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
     try (ContainerAnalysisClient containerAnalysisClient = ContainerAnalysisClient.create()) {
       TestIamPermissionsRequest request =
           TestIamPermissionsRequest.newBuilder()
               .setResource("TestIamPermissionsRequest942398222".toString())
               .addAllPermissions(new ArrayList<String>())
               .build();
       TestIamPermissionsResponse response = containerAnalysisClient.testIamPermissions(request);
     }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `request` | `com.google.iam.v1.TestIamPermissionsRequest` The request object containing all of the parameters for the API call. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `com.google.iam.v1.TestIamPermissionsResponse` |   |

### testIamPermissions(String resource, List\<String\> permissions)

    public final TestIamPermissionsResponse testIamPermissions(String resource, List<String> permissions)

Returns the permissions that a caller has on the specified note or occurrence. Requires list
permission on the project (for example, `containeranalysis.notes.list`).

The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and
`projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.

Sample code:


     // This snippet has been automatically generated and should be regarded as a code template only.
     // It will require modifications to work:
     // - It may require correct/in-range values for request initialization.
     // - It may require specifying regional endpoints when creating the service client as shown in
     // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
     try (ContainerAnalysisClient containerAnalysisClient = ContainerAnalysisClient.create()) {
       String resource = ProjectName.of("[PROJECT]").toString();
       List<String> permissions = new ArrayList<>();
       TestIamPermissionsResponse response =
           containerAnalysisClient.testIamPermissions(resource, permissions);
     }
     
| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `resource` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. |
| `permissions` | `https://docs.oracle.com/javase/8/docs/api/java/util/List.html<https://docs.oracle.com/javase/8/docs/api/java/lang/String.html>` 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). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `com.google.iam.v1.TestIamPermissionsResponse` |   |

### testIamPermissionsCallable()

    public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()

Returns the permissions that a caller has on the specified note or occurrence. Requires list
permission on the project (for example, `containeranalysis.notes.list`).

The resource takes the format `projects/[PROJECT_ID]/notes/[NOTE_ID]` for notes and
`projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID]` for occurrences.

Sample code:


     // This snippet has been automatically generated and should be regarded as a code template only.
     // It will require modifications to work:
     // - It may require correct/in-range values for request initialization.
     // - It may require specifying regional endpoints when creating the service client as shown in
     // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
     try (ContainerAnalysisClient containerAnalysisClient = ContainerAnalysisClient.create()) {
       TestIamPermissionsRequest request =
           TestIamPermissionsRequest.newBuilder()
               .setResource("TestIamPermissionsRequest942398222".toString())
               .addAllPermissions(new ArrayList<String>())
               .build();
       ApiFuture<TestIamPermissionsResponse> future =
           containerAnalysisClient.testIamPermissionsCallable().futureCall(request);
       // Do something.
       TestIamPermissionsResponse response = future.get();
     }
     
| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.UnaryCallable.html<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>` |   |