v1beta1.GrafeasV1Beta1Client

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.

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

Creates new notes in batch.

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

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

const formattedParent = client.projectPath('[PROJECT]');
const notes = {};
const request = {
  parent: formattedParent,
  notes: notes,
};
client.batchCreateNotes(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 BatchCreateNotesResponse. The promise has a method named "cancel" which cancels the ongoing API call.

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

Creates new occurrences in batch.

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

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

const formattedParent = client.projectPath('[PROJECT]');
const occurrences = [];
const request = {
  parent: formattedParent,
  occurrences: occurrences,
};
client.batchCreateOccurrences(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 BatchCreateOccurrencesResponse. The promise has a method named "cancel" which cancels the ongoing API call.

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

Creates a new note.

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

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

const formattedParent = client.projectPath('[PROJECT]');
const noteId = '';
const note = {};
const request = {
  parent: formattedParent,
  noteId: noteId,
  note: note,
};
client.createNote(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 Note. The promise has a method named "cancel" which cancels the ongoing API call.

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

Creates a new occurrence.

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

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

const formattedParent = client.projectPath('[PROJECT]');
const occurrence = {};
const request = {
  parent: formattedParent,
  occurrence: occurrence,
};
client.createOccurrence(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 Occurrence. The promise has a method named "cancel" which cancels the ongoing API call.

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

Deletes the specified note.

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

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

const formattedName = client.notePath('[PROJECT]', '[NOTE]');
client.deleteNote({name: formattedName}).catch(err => {
  console.error(err);
});

Returns

Promise 

• The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

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

Deletes the specified occurrence. For example, use this method to delete an occurrence when the occurrence is no longer applicable for the given resource.

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

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

const formattedName = client.occurrencePath('[PROJECT]', '[OCCURRENCE]');
client.deleteOccurrence({name: formattedName}).catch(err => {
  console.error(err);
});

Returns

Promise 

• The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

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

Gets the specified note.

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

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

const formattedName = client.notePath('[PROJECT]', '[NOTE]');
client.getNote({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 Note. The promise has a method named "cancel" which cancels the ongoing API call.

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

Gets the specified occurrence.

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

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

const formattedName = client.occurrencePath('[PROJECT]', '[OCCURRENCE]');
client.getOccurrence({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 Occurrence. The promise has a method named "cancel" which cancels the ongoing API call.

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

Gets the note attached to the specified occurrence. Consumer projects can use this method to get a note that belongs to a provider project.

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

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

const formattedName = client.occurrencePath('[PROJECT]', '[OCCURRENCE]');
client.getOccurrenceNote({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 Note. The promise has a method named "cancel" which cancels the ongoing API call.

getProjectId(callback)

Return the project ID used by this class.

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

Gets a summary of the number and severity of occurrences.

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

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

const formattedParent = client.projectPath('[PROJECT]');
client.getVulnerabilityOccurrencesSummary({parent: formattedParent})
  .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 VulnerabilityOccurrencesSummary. The promise has a method named "cancel" which cancels the ongoing API call.

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

Lists occurrences referencing the specified note. Provider projects can use this method to get all occurrences across consumer projects referencing the specified note.

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

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

// Iterate over all elements.
const formattedName = client.notePath('[PROJECT]', '[NOTE]');

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

// Or obtain the paged response.
const formattedName = client.notePath('[PROJECT]', '[NOTE]');


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.listNoteOccurrences(nextRequest, options).then(callback);
  }
}
client.listNoteOccurrences({name: formattedName}, 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 Occurrence.

  When autoPaginate: false is specified through options, the array has three elements. The first element is Array of Occurrence 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 ListNoteOccurrencesResponse.

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

listNoteOccurrencesStream(request[, options]) → Stream

Equivalent to listNoteOccurrences, but returns a NodeJS Stream object.

This fetches the paged responses for listNoteOccurrences 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.GrafeasV1Beta1Client({
  // optional auth parameters.
});

const formattedName = client.notePath('[PROJECT]', '[NOTE]');
client.listNoteOccurrencesStream({name: formattedName})
  .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 Occurrence on 'data' event.

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

Lists notes for the specified project.

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

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

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

client.listNotes({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.listNotes(nextRequest, options).then(callback);
  }
}
client.listNotes({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 Note.

  When autoPaginate: false is specified through options, the array has three elements. The first element is Array of Note 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 ListNotesResponse.

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

listNotesStream(request[, options]) → Stream

Equivalent to listNotes, but returns a NodeJS Stream object.

This fetches the paged responses for listNotes 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.GrafeasV1Beta1Client({
  // optional auth parameters.
});

const formattedParent = client.projectPath('[PROJECT]');
client.listNotesStream({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 Note on 'data' event.

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

Lists occurrences for the specified project.

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

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

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

client.listOccurrences({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.listOccurrences(nextRequest, options).then(callback);
  }
}
client.listOccurrences({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 Occurrence.

  When autoPaginate: false is specified through options, the array has three elements. The first element is Array of Occurrence 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 ListOccurrencesResponse.

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

listOccurrencesStream(request[, options]) → Stream

Equivalent to listOccurrences, but returns a NodeJS Stream object.

This fetches the paged responses for listOccurrences 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.GrafeasV1Beta1Client({
  // optional auth parameters.
});

const formattedParent = client.projectPath('[PROJECT]');
client.listOccurrencesStream({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 Occurrence 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.

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 

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

Updates the specified note.

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

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

const formattedName = client.notePath('[PROJECT]', '[NOTE]');
const note = {};
const request = {
  name: formattedName,
  note: note,
};
client.updateNote(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 Note. The promise has a method named "cancel" which cancels the ongoing API call.

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

Updates the specified occurrence.

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

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

const formattedName = client.occurrencePath('[PROJECT]', '[OCCURRENCE]');
const occurrence = {};
const request = {
  name: formattedName,
  occurrence: occurrence,
};
client.updateOccurrence(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 Occurrence. The promise has a method named "cancel" which cancels the ongoing API call.