GrafeasV1Beta1Client

GrafeasV1Beta1Client

Grafeas API.

Retrieves analysis results of Cloud components such as Docker container images.

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 GrafeasV1Beta1Client(optionsopt)

Construct an instance of GrafeasV1Beta1Client.

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

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

Creates new notes in batch.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

The name of the project in the form of projects/[PROJECT_ID], under which the notes are to be created.
notes Object.<string, Object>

The notes to create.
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 BatchCreateNotesResponse.
Source:
Example
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);
  });

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

Creates new occurrences in batch.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

The name of the project in the form of projects/[PROJECT_ID], under which the occurrences are to be created.
occurrences Array.<Object>

The occurrences to create.

This object should have the same structure as Occurrence
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 BatchCreateOccurrencesResponse.
Source:
Example
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);
  });

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

Creates a new note.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

The name of the project in the form of projects/[PROJECT_ID], under which the note is to be created.
noteId string

The ID to use for this note.
note Object

The note to create.

This object should have the same structure as Note
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 Note.
Source:
Example
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);
  });

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

Creates a new occurrence.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
parent string

The name of the project in the form of projects/[PROJECT_ID], under which the occurrence is to be created.
occurrence Object

The occurrence to create.

This object should have the same structure as Occurrence
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 Occurrence.
Source:
Example
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);
  });

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

Deletes the specified note.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the note in the form of projects/[PROVIDER_ID]/notes/[NOTE_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.
Source:
Example
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);
});

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the occurrence in the form of projects/[PROJECT_ID]/occurrences/[OCCURRENCE_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.
Source:
Example
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);
});

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

Gets the specified note.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the note in the form of projects/[PROVIDER_ID]/notes/[NOTE_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 Note.
Source:
Example
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);
  });

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

Gets the specified occurrence.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the occurrence in the form of projects/[PROJECT_ID]/occurrences/[OCCURRENCE_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 Occurrence.
Source:
Example
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);
  });

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Description
name string

The name of the occurrence in the form of projects/[PROJECT_ID]/occurrences/[OCCURRENCE_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 Note.
Source:
Example
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);
  });

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:

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

Gets a summary of the number and severity of occurrences.

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 get a vulnerability summary for in the form of projects/[PROJECT_ID].
filter string <optional>

The filter expression.
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 VulnerabilityOccurrencesSummary.
Source:
Example
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);
  });

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

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
name string

The name of the note to list occurrences for in the form of projects/[PROVIDER_ID]/notes/[NOTE_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 Occurrence.

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 ListNoteOccurrencesResponse.
Source:
Example
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);
  });

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

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
name string

The name of the note to list occurrences for in the form of projects/[PROVIDER_ID]/notes/[NOTE_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.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);
  });

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

Lists notes 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 notes 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 Note.

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 ListNotesResponse.
Source:
Example
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);
  });

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

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 notes 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.GrafeasV1Beta1Client({
  // optional auth parameters.
});

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

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

Lists occurrences 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 occurrences 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 Occurrence.

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 ListOccurrencesResponse.
Source:
Example
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);
  });

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

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 occurrences 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.GrafeasV1Beta1Client({
  // optional auth parameters.
});

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

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:

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

Updates the specified note.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
name string

The name of the note in the form of projects/[PROVIDER_ID]/notes/[NOTE_ID].
note Object

The updated note.

This object should have the same structure as Note
updateMask Object <optional>

The fields to update.

This object should have the same structure as FieldMask
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 Note.
Source:
Example
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);
  });

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

Updates the specified occurrence.

Parameters:
Name Type Attributes Description
request Object

The request object that will be sent.

Properties
Name Type Attributes Description
name string

The name of the occurrence in the form of projects/[PROJECT_ID]/occurrences/[OCCURRENCE_ID].
occurrence Object

The updated occurrence.

This object should have the same structure as Occurrence
updateMask Object <optional>

The fields to update.

This object should have the same structure as FieldMask
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 Occurrence.
Source:
Example
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);
  });