DefinitelyTyped/types/gapi.client.dataflow

TypeScript typings for Google Dataflow API v1b3

Manages Google Cloud Dataflow projects on Google Cloud Platform. For detailed description please check documentation.

Installing

Install typings for Google Dataflow API:

npm install @types/gapi.client.dataflow@v1b3 --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('dataflow', 'v1b3', () => {
    // now we can use gapi.client.dataflow
    // ... 
});

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 = [     
        // View and manage your data across Google Cloud Platform services
        'https://www.googleapis.com/auth/cloud-platform',
    
        // View and manage your Google Compute Engine resources
        'https://www.googleapis.com/auth/compute',
    
        // View your Google Compute Engine resources
        'https://www.googleapis.com/auth/compute.readonly',
    
        // View your email address
        'https://www.googleapis.com/auth/userinfo.email',
    ],
    immediate = true;
// ...

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

After that you can use Google Dataflow API resources:

    
/* 
Send a worker_message to the service.  
*/
await gapi.client.projects.workerMessages({ projectId: "projectId",  });