Class v1beta1.ContainerAnalysisV1Beta1Client (3.1.8)

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. v1beta1

Package

@google-cloud/containeranalysis!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of ContainerAnalysisV1Beta1Client.

Parameter
Name Description
opts ClientOptions

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

Property Value
Type Description
string

auth

auth: gax.GoogleAuth;
Property Value
Type Description
gax.GoogleAuth

containerAnalysisV1Beta1Stub

containerAnalysisV1Beta1Stub?: Promise<{
        [name: string]: Function;
    }>;
Property Value
Type Description
Promise<{ [name: string]: Function; }>

descriptors

descriptors: Descriptors;
Property Value
Type Description
Descriptors

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };
Property Value
Type Description
{ [name: string]: Function; }

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };
Property Value
Type Description
{ [name: string]: gax.PathTemplate; }

port

static get port(): number;

The port for this API service.

Property Value
Type Description
number

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

Property Value
Type Description
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value
Type Description
string

warn

warn: (code: string, message: string, warnType?: string) => void;
Property Value
Type Description
(code: string, message: string, warnType?: string) => void

Methods

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns
Type Description
Promise<void>

{Promise} A promise that resolves when the client is closed.

getIamPolicy(request, options)

getIamPolicy(request?: protos.google.iam.v1.IGetIamPolicyRequest, options?: CallOptions): Promise<[protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.iam.v1.IGetIamPolicyRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | undefined, {} | undefined]>

getIamPolicy(request, options, callback)

getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.iam.v1.IGetIamPolicyRequest
options CallOptions
callback Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getIamPolicy(request, callback)

getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.iam.v1.IGetIamPolicyRequest
callback Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getProjectId()

getProjectId(): Promise<string>;
Returns
Type Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;
Parameter
Name Description
callback Callback<string, undefined, undefined>
Returns
Type Description
void

getScanConfig(request, options)

getScanConfig(request?: protos.google.devtools.containeranalysis.v1beta1.IGetScanConfigRequest, options?: CallOptions): Promise<[protos.google.devtools.containeranalysis.v1beta1.IScanConfig, (protos.google.devtools.containeranalysis.v1beta1.IGetScanConfigRequest | undefined), {} | undefined]>;
Parameters
Name Description
request protos.google.devtools.containeranalysis.v1beta1.IGetScanConfigRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.devtools.containeranalysis.v1beta1.IScanConfig, (protos.google.devtools.containeranalysis.v1beta1.IGetScanConfigRequest | undefined), {} | undefined]>

getScanConfig(request, options, callback)

getScanConfig(request: protos.google.devtools.containeranalysis.v1beta1.IGetScanConfigRequest, options: CallOptions, callback: Callback<protos.google.devtools.containeranalysis.v1beta1.IScanConfig, protos.google.devtools.containeranalysis.v1beta1.IGetScanConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.devtools.containeranalysis.v1beta1.IGetScanConfigRequest
options CallOptions
callback Callback<protos.google.devtools.containeranalysis.v1beta1.IScanConfig, protos.google.devtools.containeranalysis.v1beta1.IGetScanConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

getScanConfig(request, callback)

getScanConfig(request: protos.google.devtools.containeranalysis.v1beta1.IGetScanConfigRequest, callback: Callback<protos.google.devtools.containeranalysis.v1beta1.IScanConfig, protos.google.devtools.containeranalysis.v1beta1.IGetScanConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.devtools.containeranalysis.v1beta1.IGetScanConfigRequest
callback Callback<protos.google.devtools.containeranalysis.v1beta1.IScanConfig, protos.google.devtools.containeranalysis.v1beta1.IGetScanConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns
Type Description
Promise<{ [name: string]: Function; }>

{Promise} A promise that resolves to an authenticated service stub.

listScanConfigs(request, options)

listScanConfigs(request?: protos.google.devtools.containeranalysis.v1beta1.IListScanConfigsRequest, options?: CallOptions): Promise<[protos.google.devtools.containeranalysis.v1beta1.IScanConfig[], protos.google.devtools.containeranalysis.v1beta1.IListScanConfigsRequest | null, protos.google.devtools.containeranalysis.v1beta1.IListScanConfigsResponse]>;
Parameters
Name Description
request protos.google.devtools.containeranalysis.v1beta1.IListScanConfigsRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.devtools.containeranalysis.v1beta1.IScanConfig[], protos.google.devtools.containeranalysis.v1beta1.IListScanConfigsRequest | null, protos.google.devtools.containeranalysis.v1beta1.IListScanConfigsResponse]>

listScanConfigs(request, options, callback)

listScanConfigs(request: protos.google.devtools.containeranalysis.v1beta1.IListScanConfigsRequest, options: CallOptions, callback: PaginationCallback<protos.google.devtools.containeranalysis.v1beta1.IListScanConfigsRequest, protos.google.devtools.containeranalysis.v1beta1.IListScanConfigsResponse | null | undefined, protos.google.devtools.containeranalysis.v1beta1.IScanConfig>): void;
Parameters
Name Description
request protos.google.devtools.containeranalysis.v1beta1.IListScanConfigsRequest
options CallOptions
callback PaginationCallback<protos.google.devtools.containeranalysis.v1beta1.IListScanConfigsRequest, protos.google.devtools.containeranalysis.v1beta1.IListScanConfigsResponse | null | undefined, protos.google.devtools.containeranalysis.v1beta1.IScanConfig>
Returns
Type Description
void

listScanConfigs(request, callback)

listScanConfigs(request: protos.google.devtools.containeranalysis.v1beta1.IListScanConfigsRequest, callback: PaginationCallback<protos.google.devtools.containeranalysis.v1beta1.IListScanConfigsRequest, protos.google.devtools.containeranalysis.v1beta1.IListScanConfigsResponse | null | undefined, protos.google.devtools.containeranalysis.v1beta1.IScanConfig>): void;
Parameters
Name Description
request protos.google.devtools.containeranalysis.v1beta1.IListScanConfigsRequest
callback PaginationCallback<protos.google.devtools.containeranalysis.v1beta1.IListScanConfigsRequest, protos.google.devtools.containeranalysis.v1beta1.IListScanConfigsResponse | null | undefined, protos.google.devtools.containeranalysis.v1beta1.IScanConfig>
Returns
Type Description
void

listScanConfigsAsync(request, options)

listScanConfigsAsync(request?: protos.google.devtools.containeranalysis.v1beta1.IListScanConfigsRequest, options?: CallOptions): AsyncIterable<protos.google.devtools.containeranalysis.v1beta1.IScanConfig>;

Equivalent to listScanConfigs, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

Parameters
Name Description
request protos.google.devtools.containeranalysis.v1beta1.IListScanConfigsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
AsyncIterable<protos.google.devtools.containeranalysis.v1beta1.IScanConfig>

{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [ScanConfig]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

listScanConfigsStream(request, options)

listScanConfigsStream(request?: protos.google.devtools.containeranalysis.v1beta1.IListScanConfigsRequest, options?: CallOptions): Transform;

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

Parameters
Name Description
request protos.google.devtools.containeranalysis.v1beta1.IListScanConfigsRequest

The request object that will be sent.
options CallOptions

Call options. See CallOptions for more details.
Returns
Type Description
Transform

{Stream} An object stream which emits an object representing [ScanConfig] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listScanConfigsAsync() method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.

matchProjectFromProjectName(projectName)

matchProjectFromProjectName(projectName: string): string | number;

Parse the project from Project resource.

Parameter
Name Description
projectName string

A fully-qualified path representing Project resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchProjectFromScanConfigName(scanConfigName)

matchProjectFromScanConfigName(scanConfigName: string): string | number;

Parse the project from ScanConfig resource.

Parameter
Name Description
scanConfigName string

A fully-qualified path representing ScanConfig resource.
Returns
Type Description
string | number

{string} A string representing the project.

matchScanConfigFromScanConfigName(scanConfigName)

matchScanConfigFromScanConfigName(scanConfigName: string): string | number;

Parse the scan_config from ScanConfig resource.

Parameter
Name Description
scanConfigName string

A fully-qualified path representing ScanConfig resource.
Returns
Type Description
string | number

{string} A string representing the scan_config.

projectPath(project)

projectPath(project: string): string;

Return a fully-qualified project resource name string.

Parameter
Name Description
project string
Returns
Type Description
string

{string} Resource name string.

scanConfigPath(project, scanConfig)

scanConfigPath(project: string, scanConfig: string): string;

Return a fully-qualified scanConfig resource name string.

Parameters
Name Description
project string
scanConfig string
Returns
Type Description
string

{string} Resource name string.

setIamPolicy(request, options)

setIamPolicy(request?: protos.google.iam.v1.ISetIamPolicyRequest, options?: CallOptions): Promise<[protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.iam.v1.ISetIamPolicyRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | undefined, {} | undefined]>

setIamPolicy(request, options, callback)

setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.iam.v1.ISetIamPolicyRequest
options CallOptions
callback Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

setIamPolicy(request, callback)

setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, callback: Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.iam.v1.ISetIamPolicyRequest
callback Callback<protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

testIamPermissions(request, options)

testIamPermissions(request?: protos.google.iam.v1.ITestIamPermissionsRequest, options?: CallOptions): Promise<[protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | undefined, {} | undefined]>;
Parameters
Name Description
request protos.google.iam.v1.ITestIamPermissionsRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | undefined, {} | undefined]>

testIamPermissions(request, options, callback)

testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, options: CallOptions, callback: Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.iam.v1.ITestIamPermissionsRequest
options CallOptions
callback Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

testIamPermissions(request, callback)

testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, callback: Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.iam.v1.ITestIamPermissionsRequest
callback Callback<protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateScanConfig(request, options)

updateScanConfig(request?: protos.google.devtools.containeranalysis.v1beta1.IUpdateScanConfigRequest, options?: CallOptions): Promise<[protos.google.devtools.containeranalysis.v1beta1.IScanConfig, (protos.google.devtools.containeranalysis.v1beta1.IUpdateScanConfigRequest | undefined), {} | undefined]>;
Parameters
Name Description
request protos.google.devtools.containeranalysis.v1beta1.IUpdateScanConfigRequest
options CallOptions
Returns
Type Description
Promise<[protos.google.devtools.containeranalysis.v1beta1.IScanConfig, (protos.google.devtools.containeranalysis.v1beta1.IUpdateScanConfigRequest | undefined), {} | undefined]>

updateScanConfig(request, options, callback)

updateScanConfig(request: protos.google.devtools.containeranalysis.v1beta1.IUpdateScanConfigRequest, options: CallOptions, callback: Callback<protos.google.devtools.containeranalysis.v1beta1.IScanConfig, protos.google.devtools.containeranalysis.v1beta1.IUpdateScanConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.devtools.containeranalysis.v1beta1.IUpdateScanConfigRequest
options CallOptions
callback Callback<protos.google.devtools.containeranalysis.v1beta1.IScanConfig, protos.google.devtools.containeranalysis.v1beta1.IUpdateScanConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void

updateScanConfig(request, callback)

updateScanConfig(request: protos.google.devtools.containeranalysis.v1beta1.IUpdateScanConfigRequest, callback: Callback<protos.google.devtools.containeranalysis.v1beta1.IScanConfig, protos.google.devtools.containeranalysis.v1beta1.IUpdateScanConfigRequest | null | undefined, {} | null | undefined>): void;
Parameters
Name Description
request protos.google.devtools.containeranalysis.v1beta1.IUpdateScanConfigRequest
callback Callback<protos.google.devtools.containeranalysis.v1beta1.IScanConfig, protos.google.devtools.containeranalysis.v1beta1.IUpdateScanConfigRequest | null | undefined, {} | null | undefined>
Returns
Type Description
void