Class ContainerAnalysisClient
- java.lang.Object
-
- com.google.cloud.devtools.containeranalysis.v1.ContainerAnalysisClient
-
- All Implemented Interfaces:
com.google.api.gax.core.BackgroundResource
,AutoCloseable
@Generated("by gapic-generator-java") public class ContainerAnalysisClient extends Object implements com.google.api.gax.core.BackgroundResource
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().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
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.
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
ContainerAnalysisClient(ContainerAnalysisSettings settings)
Constructs an instance of ContainerAnalysisClient, using the given settings.protected
ContainerAnalysisClient(ContainerAnalysisStub stub)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
awaitTermination(long duration, TimeUnit unit)
void
close()
static ContainerAnalysisClient
create()
Constructs an instance of ContainerAnalysisClient with default settings.static ContainerAnalysisClient
create(ContainerAnalysisSettings settings)
Constructs an instance of ContainerAnalysisClient, using the given settings.static ContainerAnalysisClient
create(ContainerAnalysisStub stub)
Constructs an instance of ContainerAnalysisClient, using the given stub for making calls.io.grafeas.v1.GrafeasClient
getGrafeasClient()
Returns a new GrafeasClient with the same configured settings.com.google.iam.v1.Policy
getIamPolicy(com.google.api.resourcenames.ResourceName resource)
Gets the access control policy for a note or an occurrence resource.com.google.iam.v1.Policy
getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)
Gets the access control policy for a note or an occurrence resource.com.google.iam.v1.Policy
getIamPolicy(String resource)
Gets the access control policy for a note or an occurrence resource.com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>
getIamPolicyCallable()
Gets the access control policy for a note or an occurrence resource.ContainerAnalysisSettings
getSettings()
ContainerAnalysisStub
getStub()
VulnerabilityOccurrencesSummary
getVulnerabilityOccurrencesSummary(GetVulnerabilityOccurrencesSummaryRequest request)
Gets a summary of the number and severity of occurrences.VulnerabilityOccurrencesSummary
getVulnerabilityOccurrencesSummary(ProjectName parent, String filter)
Gets a summary of the number and severity of occurrences.VulnerabilityOccurrencesSummary
getVulnerabilityOccurrencesSummary(String parent, String filter)
Gets a summary of the number and severity of occurrences.com.google.api.gax.rpc.UnaryCallable<GetVulnerabilityOccurrencesSummaryRequest,VulnerabilityOccurrencesSummary>
getVulnerabilityOccurrencesSummaryCallable()
Gets a summary of the number and severity of occurrences.boolean
isShutdown()
boolean
isTerminated()
com.google.iam.v1.Policy
setIamPolicy(com.google.api.resourcenames.ResourceName resource, com.google.iam.v1.Policy policy)
Sets the access control policy on the specified note or occurrence.com.google.iam.v1.Policy
setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)
Sets the access control policy on the specified note or occurrence.com.google.iam.v1.Policy
setIamPolicy(String resource, com.google.iam.v1.Policy policy)
Sets the access control policy on the specified note or occurrence.com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>
setIamPolicyCallable()
Sets the access control policy on the specified note or occurrence.void
shutdown()
void
shutdownNow()
com.google.iam.v1.TestIamPermissionsResponse
testIamPermissions(com.google.api.resourcenames.ResourceName resource, List<String> permissions)
Returns the permissions that a caller has on the specified note or occurrence.com.google.iam.v1.TestIamPermissionsResponse
testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)
Returns the permissions that a caller has on the specified note or occurrence.com.google.iam.v1.TestIamPermissionsResponse
testIamPermissions(String resource, List<String> permissions)
Returns the permissions that a caller has on the specified note or occurrence.com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>
testIamPermissionsCallable()
Returns the permissions that a caller has on the specified note or occurrence.
-
-
-
Constructor Detail
-
ContainerAnalysisClient
protected ContainerAnalysisClient(ContainerAnalysisSettings settings) throws IOException
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.- Throws:
IOException
-
ContainerAnalysisClient
protected ContainerAnalysisClient(ContainerAnalysisStub stub)
-
-
Method Detail
-
getGrafeasClient
public io.grafeas.v1.GrafeasClient getGrafeasClient() throws IOException
Returns a new GrafeasClient with the same configured settings.- Throws:
IOException
-
create
public static final ContainerAnalysisClient create() throws IOException
Constructs an instance of ContainerAnalysisClient with default settings.- Throws:
IOException
-
create
public static final ContainerAnalysisClient create(ContainerAnalysisSettings settings) throws IOException
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.- Throws:
IOException
-
create
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).
-
getSettings
public final ContainerAnalysisSettings getSettings()
-
getStub
public ContainerAnalysisStub getStub()
-
setIamPolicy
public final com.google.iam.v1.Policy setIamPolicy(com.google.api.resourcenames.ResourceName resource, com.google.iam.v1.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:
resource
- REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.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.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
setIamPolicy
public final com.google.iam.v1.Policy setIamPolicy(String resource, com.google.iam.v1.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:
resource
- REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.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.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
setIamPolicy
public final com.google.iam.v1.Policy setIamPolicy(com.google.iam.v1.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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
setIamPolicyCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.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(); }
-
getIamPolicy
public final com.google.iam.v1.Policy getIamPolicy(com.google.api.resourcenames.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); }
- Parameters:
resource
- REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getIamPolicy
public final com.google.iam.v1.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); }
- Parameters:
resource
- REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getIamPolicy
public final com.google.iam.v1.Policy getIamPolicy(com.google.iam.v1.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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getIamPolicyCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.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(); }
-
testIamPermissions
public final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.api.resourcenames.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:
resource
- REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.permissions
- 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).- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
testIamPermissions
public final com.google.iam.v1.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:
resource
- REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.permissions
- 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).- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
testIamPermissions
public final com.google.iam.v1.TestIamPermissionsResponse testIamPermissions(com.google.iam.v1.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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
testIamPermissionsCallable
public final com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.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(); }
-
getVulnerabilityOccurrencesSummary
public final VulnerabilityOccurrencesSummary getVulnerabilityOccurrencesSummary(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:
parent
- Required. The name of the project to get a vulnerability summary for in the form of `projects/[PROJECT_ID]`.filter
- The filter expression.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getVulnerabilityOccurrencesSummary
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:
parent
- Required. The name of the project to get a vulnerability summary for in the form of `projects/[PROJECT_ID]`.filter
- The filter expression.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getVulnerabilityOccurrencesSummary
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); }
- Parameters:
request
- The request object containing all of the parameters for the API call.- Throws:
com.google.api.gax.rpc.ApiException
- if the remote call fails
-
getVulnerabilityOccurrencesSummaryCallable
public final com.google.api.gax.rpc.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(); }
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
shutdown
public void shutdown()
- Specified by:
shutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isShutdown
public boolean isShutdown()
- Specified by:
isShutdown
in interfacecom.google.api.gax.core.BackgroundResource
-
isTerminated
public boolean isTerminated()
- Specified by:
isTerminated
in interfacecom.google.api.gax.core.BackgroundResource
-
shutdownNow
public void shutdownNow()
- Specified by:
shutdownNow
in interfacecom.google.api.gax.core.BackgroundResource
-
awaitTermination
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
- Specified by:
awaitTermination
in interfacecom.google.api.gax.core.BackgroundResource
- Throws:
InterruptedException
-
-