GrafeasClient

GrafeasClient

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 GrafeasClient(optionsopt, gaxInstanceopt)

Construct an instance of GrafeasClient.

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/1.1 REST mode. For more information, please check the documentation.
gaxInstance gax <optional>

loaded instance of google-gax. Useful if you need to avoid loading the default gRPC version and want to use the fallback HTTP implementation. Load only fallback version and pass it to the constructor: const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC const client = new GrafeasClient({fallback: true}, gax);

Members

apiEndpoint

The DNS address for this API service.

apiEndpoint

The DNS address for this API service - same as servicePath.

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

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.

getProjectId() → {Promise}

Return the project ID used by this class.

Returns:
Type Description
Promise

A promise that resolves to string containing the project ID.

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.

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
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  The name of the note to list occurrences for in the form of
   *  `projects/[PROVIDER_ID]/notes/[NOTE_ID]`.
   */
  // const name = 'abc123'
  /**
   *  The filter expression.
   */
  // const filter = 'abc123'
  /**
   *  Number of occurrences to return in the list.
   */
  // const pageSize = 1234
  /**
   *  Token to provide to skip to a particular spot in the list.
   */
  // const pageToken = 'abc123'

  // Imports the Grafeas library
  const {GrafeasClient} = require('@google-cloud/grafeas').v1;

  // Instantiates a client
  const grafeasClient = new GrafeasClient();

  async function callListNoteOccurrences() {
    // Construct request
    const request = {
      name,
    };

    // Run request
    const iterable = grafeasClient.listNoteOccurrencesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListNoteOccurrences();

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.

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. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20.
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
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  The name of the project to list notes for in the form of
   *  `projects/[PROJECT_ID]`.
   */
  // const parent = 'abc123'
  /**
   *  The filter expression.
   */
  // const filter = 'abc123'
  /**
   *  Number of notes to return in the list. Must be positive. Max allowed page
   *  size is 1000. If not specified, page size defaults to 20.
   */
  // const pageSize = 1234
  /**
   *  Token to provide to skip to a particular spot in the list.
   */
  // const pageToken = 'abc123'

  // Imports the Grafeas library
  const {GrafeasClient} = require('@google-cloud/grafeas').v1;

  // Instantiates a client
  const grafeasClient = new GrafeasClient();

  async function callListNotes() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = grafeasClient.listNotesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListNotes();

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. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20.
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.

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. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20.
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
  /**
   * This snippet has been automatically generated and should be regarded as a code template only.
   * It will require modifications to work.
   * It may require correct/in-range values for request initialization.
   * TODO(developer): Uncomment these variables before running the sample.
   */
  /**
   *  The name of the project to list occurrences for in the form of
   *  `projects/[PROJECT_ID]`.
   */
  // const parent = 'abc123'
  /**
   *  The filter expression.
   */
  // const filter = 'abc123'
  /**
   *  Number of occurrences to return in the list. Must be positive. Max allowed
   *  page size is 1000. If not specified, page size defaults to 20.
   */
  // const pageSize = 1234
  /**
   *  Token to provide to skip to a particular spot in the list.
   */
  // const pageToken = 'abc123'

  // Imports the Grafeas library
  const {GrafeasClient} = require('@google-cloud/grafeas').v1;

  // Instantiates a client
  const grafeasClient = new GrafeasClient();

  async function callListOccurrences() {
    // Construct request
    const request = {
      parent,
    };

    // Run request
    const iterable = grafeasClient.listOccurrencesAsync(request);
    for await (const response of iterable) {
        console.log(response);
    }
  }

  callListOccurrences();

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. Must be positive. Max allowed page size is 1000. If not specified, page size defaults to 20.
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.

matchNoteFromNoteName(noteName) → {string}

Parse the note from Note resource.

Parameters:
Name Type Description
noteName string

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

A string representing the note.

matchOccurrenceFromOccurrenceName(occurrenceName) → {string}

Parse the occurrence from Occurrence resource.

Parameters:
Name Type Description
occurrenceName string

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

A string representing the occurrence.

matchProjectFromNoteName(noteName) → {string}

Parse the project from Note resource.

Parameters:
Name Type Description
noteName string

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

A string representing the project.

matchProjectFromOccurrenceName(occurrenceName) → {string}

Parse the project from Occurrence resource.

Parameters:
Name Type Description
occurrenceName string

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

A string representing the project.

matchProjectFromProjectName(projectName) → {string}

Parse the project from Project resource.

Parameters:
Name Type Description
projectName string

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

A string representing the project.

notePath(project, note) → {string}

Return a fully-qualified note resource name string.

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

Resource name string.

occurrencePath(project, occurrence) → {string}

Return a fully-qualified occurrence resource name string.

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

Resource name string.

projectPath(project) → {string}

Return a fully-qualified project resource name string.

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

Resource name string.