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. The options accepted by the constructor are described in detail in this document. The common options are:

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.
apiEndpoint string <optional>

The domain name of the API remote host.
clientConfig gax.ClientConfig <optional>

Client configuration override. Follows the structure of gapicConfig.
fallback boolean <optional>

Use HTTP fallback mode. In fallback mode, a special browser-compatible transport implementation is used instead of gRPC transport. In browser context (if the window object is defined) the fallback mode is enabled automatically; set options.fallback to false if you need to override this behavior.

Members

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.

Methods

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

The notes to create.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
Example
const [response] = await client.batchCreateNotes(request);

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

The occurrences to create.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
Example
const [response] = await client.batchCreateOccurrences(request);

close() → {Promise}

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns:
Type Description
Promise

A promise that resolves when the client is closed.

createNote(request, optionsopt) → {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 grafeas.v1beta1.Note

The note to create.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Note. Please see the documentation for more details and examples.
Example
const [response] = await client.createNote(request);

createOccurrence(request, optionsopt) → {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 grafeas.v1beta1.Occurrence

The occurrence to create.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Occurrence. Please see the documentation for more details and examples.
Example
const [response] = await client.createOccurrence(request);

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

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples.
Example
const [response] = await client.deleteNote(request);

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

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Empty. Please see the documentation for more details and examples.
Example
const [response] = await client.deleteOccurrence(request);

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

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Note. Please see the documentation for more details and examples.
Example
const [response] = await client.getNote(request);

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

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Occurrence. Please see the documentation for more details and examples.
Example
const [response] = await client.getOccurrence(request);

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

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Note. Please see the documentation for more details and examples.
Example
const [response] = await client.getOccurrenceNote(request);

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:
Type Description
Promise

A promise that resolves to string containing the project ID.

getVulnerabilityOccurrencesSummary(request, optionsopt) → {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 Description
parent string

The name of the project to get a vulnerability summary for in the form of projects/[PROJECT_ID].
filter string

The filter expression.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
Example
const [response] = await client.getVulnerabilityOccurrencesSummary(request);

initialize() → {Promise}

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns:
Type Description
Promise

A promise that resolves to an authenticated service stub.

listNoteOccurrences(request, optionsopt) → {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 Description
name string

The name of the note to list occurrences for in the form of projects/[PROVIDER_ID]/notes/[NOTE_ID].
filter string

The filter expression.
pageSize number

Number of occurrences to return in the list.
pageToken string

Token to provide to skip to a particular spot in the list.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is Array of Occurrence. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listNoteOccurrencesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listNoteOccurrencesAsync(request, optionsopt) → {Object}

Equivalent to listNoteOccurrences, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

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 to list occurrences for in the form of projects/[PROVIDER_ID]/notes/[NOTE_ID].
filter string

The filter expression.
pageSize number

Number of occurrences to return in the list.
pageToken string

Token to provide to skip to a particular spot in the list.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Occurrence. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example
const iterable = client.listNoteOccurrencesAsync(request);
for await (const response of iterable) {
  // process response
}

listNoteOccurrencesStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

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 to list occurrences for in the form of projects/[PROVIDER_ID]/notes/[NOTE_ID].
filter string

The filter expression.
pageSize number

Number of occurrences to return in the list.
pageToken string

Token to provide to skip to a particular spot in the list.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing Occurrence on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listNoteOccurrencesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listNotes(request, optionsopt) → {Promise}

Lists notes for the specified project.

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 to list notes for in the form of projects/[PROJECT_ID].
filter string

The filter expression.
pageSize number

Number of notes to return in the list.
pageToken string

Token to provide to skip to a particular spot in the list.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is Array of Note. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listNotesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listNotesAsync(request, optionsopt) → {Object}

Equivalent to listNotes, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

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 to list notes for in the form of projects/[PROJECT_ID].
filter string

The filter expression.
pageSize number

Number of notes to return in the list.
pageToken string

Token to provide to skip to a particular spot in the list.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Note. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example
const iterable = client.listNotesAsync(request);
for await (const response of iterable) {
  // process response
}

listNotesStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

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 to list notes for in the form of projects/[PROJECT_ID].
filter string

The filter expression.
pageSize number

Number of notes to return in the list.
pageToken string

Token to provide to skip to a particular spot in the list.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing Note on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listNotesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listOccurrences(request, optionsopt) → {Promise}

Lists occurrences for the specified project.

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 to list occurrences for in the form of projects/[PROJECT_ID].
filter string

The filter expression.
pageSize number

Number of occurrences to return in the list.
pageToken string

Token to provide to skip to a particular spot in the list.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is Array of Occurrence. The client library will perform auto-pagination by default: it will call the API as many times as needed and will merge results from all the pages into this array. Note that it can affect your quota. We recommend using listOccurrencesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

listOccurrencesAsync(request, optionsopt) → {Object}

Equivalent to listOccurrences, but returns an iterable object.

for-await-of syntax is used with the iterable to get response elements on-demand.

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 to list occurrences for in the form of projects/[PROJECT_ID].
filter string

The filter expression.
pageSize number

Number of occurrences to return in the list.
pageToken string

Token to provide to skip to a particular spot in the list.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Object

An iterable Object that allows async iteration. When you iterate the returned iterable, each element will be an object representing Occurrence. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the documentation for more details and examples.
Example
const iterable = client.listOccurrencesAsync(request);
for await (const response of iterable) {
  // process response
}

listOccurrencesStream(request, optionsopt) → {Stream}

Equivalent to method.name.toCamelCase(), but returns a NodeJS Stream object.

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 to list occurrences for in the form of projects/[PROJECT_ID].
filter string

The filter expression.
pageSize number

Number of occurrences to return in the list.
pageToken string

Token to provide to skip to a particular spot in the list.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Stream

An object stream which emits an object representing Occurrence on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listOccurrencesAsync() method described below for async iteration which you can stop as needed. Please see the documentation for more details and examples.

matchProjectFromScanConfigName(scanConfigName) → {string}

Parse the project from ScanConfig resource.

Parameters:
Name Type Description
scanConfigName string

A fully-qualified path representing ScanConfig resource.
Returns:
Type Description
string

A string representing the project.

matchScanConfigFromScanConfigName(scanConfigName) → {string}

Parse the scan_config from ScanConfig resource.

Parameters:
Name Type Description
scanConfigName string

A fully-qualified path representing ScanConfig resource.
Returns:
Type Description
string

A string representing the scan_config.

scanConfigPath(project, scan_config) → {string}

Return a fully-qualified scanConfig resource name string.

Parameters:
Name Type Description
project string
scan_config string
Returns:
Type Description
string

Resource name string.

updateNote(request, optionsopt) → {Promise}

Updates 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].
note grafeas.v1beta1.Note

The updated note.
updateMask google.protobuf.FieldMask

The fields to update.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Note. Please see the documentation for more details and examples.
Example
const [response] = await client.updateNote(request);

updateOccurrence(request, optionsopt) → {Promise}

Updates 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].
occurrence grafeas.v1beta1.Occurrence

The updated occurrence.
updateMask google.protobuf.FieldMask

The fields to update.
options object <optional>

Call options. See CallOptions for more details.
Returns:
Type Description
Promise
  • The promise which resolves to an array. The first element of the array is an object representing Occurrence. Please see the documentation for more details and examples.
Example
const [response] = await client.updateOccurrence(request);