public sealed class ContainerAnalysisClientImpl : ContainerAnalysisClient
Reference documentation and code samples for the Google Container Analysis v1 API class ContainerAnalysisClientImpl.
ContainerAnalysis client wrapper implementation, for convenient use.
Namespace
Google.Cloud.DevTools.ContainerAnalysis.V1Assembly
Google.Cloud.DevTools.ContainerAnalysis.V1.dll
Remarks
Retrieves analysis results of Cloud components such as Docker container images. The Container Analysis API is an implementation of the Grafeas 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.
Constructors
ContainerAnalysisClientImpl(ContainerAnalysisClient, ContainerAnalysisSettings, ILogger)
public ContainerAnalysisClientImpl(ContainerAnalysis.ContainerAnalysisClient grpcClient, ContainerAnalysisSettings settings, ILogger logger)
Constructs a client wrapper for the ContainerAnalysis service, with the specified gRPC client and settings.
Parameters | |
---|---|
Name | Description |
grpcClient | ContainerAnalysisContainerAnalysisClient The underlying gRPC client. |
settings | ContainerAnalysisSettings The base ContainerAnalysisSettings used within this client. |
logger | ILogger Optional ILogger to use within this client. |
Properties
GrafeasClient
public override GrafeasClient GrafeasClient { get; }
Returns a GrafeasClient using the same endpoint and credentials as this client.
Property Value | |
---|---|
Type | Description |
Grafeas.V1.GrafeasClient |
GrpcClient
public override ContainerAnalysis.ContainerAnalysisClient GrpcClient { get; }
The underlying gRPC ContainerAnalysis client
Property Value | |
---|---|
Type | Description |
ContainerAnalysisContainerAnalysisClient |
Methods
GetIamPolicy(GetIamPolicyRequest, CallSettings)
public override Policy GetIamPolicy(GetIamPolicyRequest request, CallSettings callSettings = null)
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.
Parameters | |
---|---|
Name | Description |
request | GetIamPolicyRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Policy | The RPC response. |
GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)
public override Task<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallSettings callSettings = null)
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.
Parameters | |
---|---|
Name | Description |
request | GetIamPolicyRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskPolicy | A Task containing the RPC response. |
GetVulnerabilityOccurrencesSummary(GetVulnerabilityOccurrencesSummaryRequest, CallSettings)
public override VulnerabilityOccurrencesSummary GetVulnerabilityOccurrencesSummary(GetVulnerabilityOccurrencesSummaryRequest request, CallSettings callSettings = null)
Gets a summary of the number and severity of occurrences.
Parameters | |
---|---|
Name | Description |
request | GetVulnerabilityOccurrencesSummaryRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
VulnerabilityOccurrencesSummary | The RPC response. |
GetVulnerabilityOccurrencesSummaryAsync(GetVulnerabilityOccurrencesSummaryRequest, CallSettings)
public override Task<VulnerabilityOccurrencesSummary> GetVulnerabilityOccurrencesSummaryAsync(GetVulnerabilityOccurrencesSummaryRequest request, CallSettings callSettings = null)
Gets a summary of the number and severity of occurrences.
Parameters | |
---|---|
Name | Description |
request | GetVulnerabilityOccurrencesSummaryRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskVulnerabilityOccurrencesSummary | A Task containing the RPC response. |
SetIamPolicy(SetIamPolicyRequest, CallSettings)
public override Policy SetIamPolicy(SetIamPolicyRequest request, CallSettings callSettings = null)
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.
Parameters | |
---|---|
Name | Description |
request | SetIamPolicyRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
Policy | The RPC response. |
SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)
public override Task<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallSettings callSettings = null)
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.
Parameters | |
---|---|
Name | Description |
request | SetIamPolicyRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskPolicy | A Task containing the RPC response. |
TestIamPermissions(TestIamPermissionsRequest, CallSettings)
public override TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallSettings callSettings = null)
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.
Parameters | |
---|---|
Name | Description |
request | TestIamPermissionsRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TestIamPermissionsResponse | The RPC response. |
TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)
public override Task<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallSettings callSettings = null)
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.
Parameters | |
---|---|
Name | Description |
request | TestIamPermissionsRequest The request object containing all of the parameters for the API call. |
callSettings | CallSettings If not null, applies overrides to this RPC call. |
Returns | |
---|---|
Type | Description |
TaskTestIamPermissionsResponse | A Task containing the RPC response. |