ContainerAnalysisV1Beta1Client

ContainerAnalysisV1Beta1Client

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.

Constructor

new ContainerAnalysisV1Beta1Client(optionsopt)

Construct an instance of ContainerAnalysisV1Beta1Client.

Parameters:
Name Type Attributes Description
options object <optional>

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

Properties
Name Type Attributes Description
credentials object <optional>

Credentials object.

Properties
Name Type Attributes Description
client_email string <optional>
private_key string <optional>
email string <optional>

Account email address. Required when using a .pem or .p12 keyFilename.
keyFilename string <optional>

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 number <optional>

The port on which to connect to the remote host.
projectId string <optional>

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 function <optional>

Custom promise module to use instead of native Promises.
apiEndpoint string <optional>

The domain name of the API remote host.
Source:

Members

(static) apiEndpoint

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

Source:

(static) port

The port for this API service.

Source:

(static) scopes

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

Source:

(static) servicePath

The DNS address for this API service.

Source:

Methods

getIamPolicy(request, optionsopt, callbackopt) → {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.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes 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 <optional>

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 <optional>

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 <optional>

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

The second parameter to the callback is an object representing Policy.
Source:
Example
const containeranalysis = require('@google-cloud/containeranalysis');

const client = new containeranalysis.v1beta1.ContainerAnalysisV1Beta1Client({
  // 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);
  });

getProjectId(callback)

Return the project ID used by this class.

Parameters:
Name Type Description
callback function

the callback to be called with the current project Id.
Source:

getScanConfig(request, optionsopt, callbackopt) → {Promise}

Gets the specified scan configuration.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the scan configuration in the form of projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID].
options Object <optional>

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 <optional>

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

The second parameter to the callback is an object representing ScanConfig.
Source:
Example
const containeranalysis = require('@google-cloud/containeranalysis');

const client = new containeranalysis.v1beta1.ContainerAnalysisV1Beta1Client({
  // optional auth parameters.
});

const formattedName = client.scanConfigPath('[PROJECT]', '[SCAN_CONFIG]');
client.getScanConfig({name: formattedName})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

listScanConfigs(request, optionsopt, callbackopt) → {Promise}

Lists scan configurations for the specified project.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

The name of the project to list scan configurations for in the form of projects/[PROJECT_ID].
filter string <optional>

The filter expression.
pageSize number <optional>

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
options Object <optional>

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 <optional>

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

The second parameter to the callback is Array of ScanConfig.

When autoPaginate: false is specified through options, it contains the result in a single response. If the response indicates the next page exists, the third parameter is set to be used for the next request object. The fourth parameter keeps the raw response object of an object representing ListScanConfigsResponse.
Source:
Example
const containeranalysis = require('@google-cloud/containeranalysis');

const client = new containeranalysis.v1beta1.ContainerAnalysisV1Beta1Client({
  // optional auth parameters.
});

// Iterate over all elements.
const formattedParent = client.projectPath('[PROJECT]');

client.listScanConfigs({parent: formattedParent})
  .then(responses => {
    const resources = responses[0];
    for (const resource of resources) {
      // doThingsWith(resource)
    }
  })
  .catch(err => {
    console.error(err);
  });

// Or obtain the paged response.
const formattedParent = client.projectPath('[PROJECT]');


const options = {autoPaginate: false};
const callback = responses => {
  // The actual resources in a response.
  const resources = responses[0];
  // The next request if the response shows that there are more responses.
  const nextRequest = responses[1];
  // The actual response object, if necessary.
  // const rawResponse = responses[2];
  for (const resource of resources) {
    // doThingsWith(resource);
  }
  if (nextRequest) {
    // Fetch the next page.
    return client.listScanConfigs(nextRequest, options).then(callback);
  }
}
client.listScanConfigs({parent: formattedParent}, options)
  .then(callback)
  .catch(err => {
    console.error(err);
  });

listScanConfigsStream(request, optionsopt) → {Stream}

Equivalent to listScanConfigs, but returns a NodeJS Stream object.

This fetches the paged responses for listScanConfigs continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
parent string

The name of the project to list scan configurations for in the form of projects/[PROJECT_ID].
filter string <optional>

The filter expression.
pageSize number <optional>

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.
options Object <optional>

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.
Source:
See:
Example
const containeranalysis = require('@google-cloud/containeranalysis');

const client = new containeranalysis.v1beta1.ContainerAnalysisV1Beta1Client({
  // optional auth parameters.
});

const formattedParent = client.projectPath('[PROJECT]');
client.listScanConfigsStream({parent: formattedParent})
  .on('data', element => {
    // doThingsWith(element)
  }).on('error', err => {
    console.log(err);
  });

matchNoteFromNoteName(noteName) → {String}

Parse the noteName from a note resource.

Parameters:
Name Type Description
noteName String

A fully-qualified path representing a note resources.
Source:

matchOccurrenceFromOccurrenceName(occurrenceName) → {String}

Parse the occurrenceName from a occurrence resource.

Parameters:
Name Type Description
occurrenceName String

A fully-qualified path representing a occurrence resources.
Source:

matchProjectFromNoteName(noteName) → {String}

Parse the noteName from a note resource.

Parameters:
Name Type Description
noteName String

A fully-qualified path representing a note resources.
Source:

matchProjectFromOccurrenceName(occurrenceName) → {String}

Parse the occurrenceName from a occurrence resource.

Parameters:
Name Type Description
occurrenceName String

A fully-qualified path representing a occurrence resources.
Source:

matchProjectFromProjectName(projectName) → {String}

Parse the projectName from a project resource.

Parameters:
Name Type Description
projectName String

A fully-qualified path representing a project resources.
Source:

matchProjectFromScanConfigName(scanConfigName) → {String}

Parse the scanConfigName from a scan_config resource.

Parameters:
Name Type Description
scanConfigName String

A fully-qualified path representing a scan_config resources.
Source:

matchScanConfigFromScanConfigName(scanConfigName) → {String}

Parse the scanConfigName from a scan_config resource.

Parameters:
Name Type Description
scanConfigName String

A fully-qualified path representing a scan_config resources.
Source:

notePath(project, note) → {String}

Return a fully-qualified note resource name string.

Parameters:
Name Type Description
project String
note String
Source:

occurrencePath(project, occurrence) → {String}

Return a fully-qualified occurrence resource name string.

Parameters:
Name Type Description
project String
occurrence String
Source:

projectPath(project) → {String}

Return a fully-qualified project resource name string.

Parameters:
Name Type Description
project String
Source:

scanConfigPath(project, scanConfig) → {String}

Return a fully-qualified scan_config resource name string.

Parameters:
Name Type Description
project String
scanConfig String
Source:

setIamPolicy(request, optionsopt, callbackopt) → {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.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type 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 <optional>

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 <optional>

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

The second parameter to the callback is an object representing Policy.
Source:
Example
const containeranalysis = require('@google-cloud/containeranalysis');

const client = new containeranalysis.v1beta1.ContainerAnalysisV1Beta1Client({
  // 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);
  });

testIamPermissions(request, optionsopt, callbackopt) → {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.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type 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.<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 <optional>

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 <optional>

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

The second parameter to the callback is an object representing TestIamPermissionsResponse.
Source:
Example
const containeranalysis = require('@google-cloud/containeranalysis');

const client = new containeranalysis.v1beta1.ContainerAnalysisV1Beta1Client({
  // 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);
  });

updateScanConfig(request, optionsopt, callbackopt) → {Promise}

Updates the specified scan configuration.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the scan configuration in the form of projects/[PROJECT_ID]/scanConfigs/[SCAN_CONFIG_ID].
scanConfig Object

The updated scan configuration.

This object should have the same structure as ScanConfig
options Object <optional>

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 <optional>

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

The second parameter to the callback is an object representing ScanConfig.
Source:
Example
const containeranalysis = require('@google-cloud/containeranalysis');

const client = new containeranalysis.v1beta1.ContainerAnalysisV1Beta1Client({
  // optional auth parameters.
});

const formattedName = client.scanConfigPath('[PROJECT]', '[SCAN_CONFIG]');
const scanConfig = {};
const request = {
  name: formattedName,
  scanConfig: scanConfig,
};
client.updateScanConfig(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });