TypeScript typings for Cloud Run Admin API v2

Deploy and manage user provided container images that scale automatically based on incoming requests. The Cloud Run Admin API v1 follows the Knative Serving API specification, while v2 is aligned with Google Cloud AIP-based API standards, as described in https://google.aip.dev/. For detailed description please check documentation.

Installing

Install typings for Cloud Run Admin API:

npm install @types/gapi.client.run-v2 --save-dev

Usage

You need to initialize Google API client in your code:

gapi.load('client', () => {
  // now we can use gapi.client
  // ...
});

Then load api client wrapper:

gapi.client.load(
  'https://run.googleapis.com/$discovery/rest?version=v2',
  () => {
    // now we can use:
    // gapi.client.run
  },
);

// Deprecated, use discovery document URL, see https://github.com/google/google-api-javascript-client/blob/master/docs/reference.md#----gapiclientloadname----version----callback--
gapi.client.load('run', 'v2', () => {
  // now we can use:
  // gapi.client.run
});

Don't forget to authenticate your client before sending any request to resources:

// declare client_id registered in Google Developers Console
var client_id = '',
  scope = [
    // See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
    'https://www.googleapis.com/auth/cloud-platform',

    // See, edit, configure, and delete your Google Cloud Run data and see the email address for your Google Account
    'https://www.googleapis.com/auth/run',

    // See your Google Cloud Run data and the email address of your Google Account
    'https://www.googleapis.com/auth/run.readonly',
  ],
  immediate = true;
// ...

gapi.auth.authorize(
  {client_id: client_id, scope: scope, immediate: immediate},
  authResult => {
    if (authResult && !authResult.error) {
      /* handle successful authorization */
    } else {
      /* handle authorization error */
    }
  },
);

After that you can use Cloud Run Admin API resources:

For provenance information see Provenance section on NPM