class inner

v1.ContainerAnalysisClient

Source: v1/container_analysis_client.js:70

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.

Properties

apiEndpoint
port

scopes
servicePath

Methods

getGrafeasClient()
getIamPolicy(request[, options][, callback])
getProjectId(callback)
matchNoteFromNoteName(noteName)

matchOccurrenceFromOccurrenceName(occurrenceName)
matchProjectFromNoteName(noteName)
matchProjectFromOccurrenceName(occurrenceName)
notePath(project, note)

occurrencePath(project, occurrence)
setIamPolicy(request[, options][, callback])
testIamPermissions(request[, options][, callback])

new ContainerAnalysisClient([options])

Construct an instance of ContainerAnalysisClient.

Parameters

Name Type Optional Description

options

Yes

The configuration object. See the subsequent parameters for more details.

Values in options have the following properties:

Name	Optional	Description
credentials	Yes	Credentials object.
credentials.client_email	Yes
credentials.private_key	Yes
email	Yes	Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename	Yes	Full path to the a .json, .pem, or .p12 key downloaded from the Google Developers Console. If you provide a path to a JSON file, the projectId option below is not necessary. NOTE: .pem and .p12 require you to specify options.email as well.
port	Yes	The port on which to connect to the remote host.
projectId	Yes	The project ID from the Google Developer's Console, e.g. 'grape-spaceship-123'. We will also check the environment variable GCLOUD_PROJECT for your project ID. If your app is running in an environment which supports Application Default Credentials, your project ID will be detected automatically.
promise	Yes	Custom promise module to use instead of native Promises.
servicePath	Yes	The domain name of the API remote host.

Properties

static

apiEndpoint

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

static

port

The port for this API service.

static

scopes

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

static

servicePath

The DNS address for this API service.

Methods

getGrafeasClient() → GrafeasClient

Returns an instance of a @google-cloud/grafeas client, configured to connect to Google Cloud's Container Analysis API. For documentation on this client, see: https://googleapis.dev/nodejs/grafeas/latest/index.html

Returns

GrafeasClient

An instance of a Grafeas client.

getIamPolicy(request[, options][, callback]) → Promise

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.

Example

const containeranalysis = require('@google-cloud/containeranalysis');

const client = new containeranalysis.v1.ContainerAnalysisClient({
  // optional auth parameters.
});

const formattedResource = client.notePath('[PROJECT]', '[NOTE]');
client.getIamPolicy({resource: formattedResource})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

Parameters

Name Type Optional Description

request

Object

The request object that will be sent.

Values in request have the following properties:

Name Type Optional Description

resource

string

REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

options

Object

Yes

OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy. This field is only used by Cloud IAM.

This object should have the same structure as GetPolicyOptions

options

Object

Yes

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

function(nullable Error, nullable Object)

Yes

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Policy.

Returns

Promise

The promise which resolves to an array. The first element of the array is an object representing Policy. The promise has a method named "cancel" which cancels the ongoing API call.

getProjectId(callback)

Return the project ID used by this class.

Parameter

Name	Type	Optional	Description
callback	function(Error, string)		the callback to be called with the current project Id.

matchNoteFromNoteName(noteName) → String

Parse the noteName from a note resource.

Parameter

Name	Type	Optional	Description
noteName	String		A fully-qualified path representing a note resources.

Returns

String

A string representing the note.

matchOccurrenceFromOccurrenceName(occurrenceName) → String

Parse the occurrenceName from a occurrence resource.

Parameter

Name	Type	Optional	Description
occurrenceName	String		A fully-qualified path representing a occurrence resources.

Returns

String

A string representing the occurrence.

matchProjectFromNoteName(noteName) → String

Parse the noteName from a note resource.

Parameter

Name	Type	Optional	Description
noteName	String		A fully-qualified path representing a note resources.

Returns

String

A string representing the project.

matchProjectFromOccurrenceName(occurrenceName) → String

Parse the occurrenceName from a occurrence resource.

Parameter

Name	Type	Optional	Description
occurrenceName	String		A fully-qualified path representing a occurrence resources.

Returns

String

A string representing the project.

notePath(project, note) → String

Return a fully-qualified note resource name string.

Parameters

Name	Type	Optional	Description
project	String
note	String

Returns: String

occurrencePath(project, occurrence) → String

Return a fully-qualified occurrence resource name string.

Parameters

Name	Type	Optional	Description
project	String
occurrence	String

Returns: String

setIamPolicy(request[, options][, callback]) → Promise

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.

Example

const containeranalysis = require('@google-cloud/containeranalysis');

const client = new containeranalysis.v1.ContainerAnalysisClient({
  // optional auth parameters.
});

const formattedResource = client.notePath('[PROJECT]', '[NOTE]');
const policy = {};
const request = {
  resource: formattedResource,
  policy: policy,
};
client.setIamPolicy(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

Parameters

Name Type Optional Description

request

Object

The request object that will be sent.

Values in request have the following properties:

Name Type Optional Description

resource

string

REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

policy

Object

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.

This object should have the same structure as Policy

options

Object

Yes

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

function(nullable Error, nullable Object)

Yes

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Policy.

Returns

Promise

The promise which resolves to an array. The first element of the array is an object representing Policy. The promise has a method named "cancel" which cancels the ongoing API call.

testIamPermissions(request[, options][, callback]) → Promise

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.

Example

const containeranalysis = require('@google-cloud/containeranalysis');

const client = new containeranalysis.v1.ContainerAnalysisClient({
  // optional auth parameters.
});

const formattedResource = client.notePath('[PROJECT]', '[NOTE]');
const permissions = [];
const request = {
  resource: formattedResource,
  permissions: permissions,
};
client.testIamPermissions(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

Parameters

Name Type Optional Description

request

Object

The request object that will be sent.

Values in request have the following properties:

Name	Type	Optional	Description
resource	string		REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
permissions	Array of string		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.

options

Object

Yes

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

function(nullable Error, nullable Object)

Yes

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing TestIamPermissionsResponse.

Returns

Promise

The promise which resolves to an array. The first element of the array is an object representing TestIamPermissionsResponse. The promise has a method named "cancel" which cancels the ongoing API call.