v1beta1.ContainerAnalysisV1Beta1Client

Parameters

apiEndpoint

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

port

The port for this API service.

scopes

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

servicePath

The DNS address for this API service.

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.

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);
  });

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.

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

Gets the specified scan configuration.

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);
  });

Returns

Promise 

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

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

Lists scan configurations for the specified project.

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);
  });

Returns

Promise 

• The promise which resolves to an array. The first element of the array is Array of ScanConfig.

  When autoPaginate: false is specified through options, the array has three elements. The first element is Array of ScanConfig in a single response. The second element is the next request object if the response indicates the next page exists, or null. The third element is an object representing ListScanConfigsResponse.

  The promise has a method named "cancel" which cancels the ongoing API call.

listScanConfigsStream(request[, options]) → 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.

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);
  });

See also

https://nodejs.org/api/stream.html

Returns

Stream 

An object stream which emits an object representing ScanConfig on 'data' event.

matchNoteFromNoteName(noteName) → String

Parse the noteName from a note resource.

Returns

String 

• A string representing the note.

matchOccurrenceFromOccurrenceName(occurrenceName) → String

Parse the occurrenceName from a occurrence resource.

Returns

String 

• A string representing the occurrence.

matchProjectFromNoteName(noteName) → String

Parse the noteName from a note resource.

Returns

String 

• A string representing the project.

matchProjectFromOccurrenceName(occurrenceName) → String

Parse the occurrenceName from a occurrence resource.

Returns

String 

• A string representing the project.

matchProjectFromProjectName(projectName) → String

Parse the projectName from a project resource.

Returns

String 

• A string representing the project.

matchProjectFromScanConfigName(scanConfigName) → String

Parse the scanConfigName from a scan_config resource.

Returns

String 

• A string representing the project.

matchScanConfigFromScanConfigName(scanConfigName) → String

Parse the scanConfigName from a scan_config resource.

Returns

String 

• A string representing the scan_config.

notePath(project, note) → String

Return a fully-qualified note resource name string.

Returns

String 

occurrencePath(project, occurrence) → String

Return a fully-qualified occurrence resource name string.

Returns

String 

projectPath(project) → String

Return a fully-qualified project resource name string.

Returns

String 

scanConfigPath(project, scanConfig) → String

Return a fully-qualified scan_config resource name 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.

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);
  });

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.

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);
  });

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.

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

Updates the specified scan configuration.

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);
  });

Returns

Promise 

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