Narcoleptic Programmers' Medicine
    Have ideas to improve npm?Join in the discussion! »

    @google-cloud/scheduler
    TypeScript icon, indicating that this package has built-in type declarations

    2.2.2 • Public • Published

    Google Cloud Platform logo

    Google Cloud Scheduler: Node.js Client

    release level npm version codecov

    Cloud Scheduler API client for Node.js

    A comprehensive list of changes in each version may be found in the CHANGELOG.

    Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

    Table of contents:

    Quickstart

    Before you begin

    1. Select or create a Cloud Platform project.
    2. Enable the Google Cloud Scheduler API.
    3. Set up authentication with a service account so you can access the API from your local workstation.

    Installing the client library

    npm install @google-cloud/scheduler

    Using the client library

    // const projectId = "PROJECT_ID"
    // const locationId = "LOCATION_ID" // see: https://cloud.google.com/about/locations/
    // const url = "https://postb.in/..." // where should we say hello?
    
    const scheduler = require('@google-cloud/scheduler');
    
    // Create a client.
    const client = new scheduler.CloudSchedulerClient();
    
    // Construct the fully qualified location path.
    const parent = client.locationPath(projectId, locationId);
    
    // Construct the request body.
    const job = {
      httpTarget: {
        uri: url,
        httpMethod: 'POST',
        body: Buffer.from('Hello World'),
      },
      schedule: '* * * * *',
      timeZone: 'America/Los_Angeles',
    };
    
    const request = {
      parent: parent,
      job: job,
    };
    
    // Use the client to send the job creation request.
    const [response] = await client.createJob(request);
    console.log(`Created job: ${response.name}`);

    Samples

    Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

    Sample Source Code Try it
    App source code Open in Cloud Shell
    Create Job source code Open in Cloud Shell
    Delete Job source code Open in Cloud Shell
    Quickstart source code Open in Cloud Shell
    Update Job source code Open in Cloud Shell

    The Google Cloud Scheduler Node.js Client API Reference documentation also contains samples.

    Supported Node.js Versions

    Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js.

    Client libraries targeting some end-of-life versions of Node.js are available, and can be installed via npm dist-tags. The dist-tags follow the naming convention legacy-(version).

    Legacy Node.js versions are supported as a best effort:

    • Legacy versions will not be tested in continuous integration.
    • Some security patches may not be able to be backported.
    • Dependencies will not be kept up-to-date, and features will not be backported.

    Legacy tags available

    • legacy-8: install client libraries from this dist-tag for versions compatible with Node.js 8.

    Versioning

    This library follows Semantic Versioning.

    This library is considered to be General Availability (GA). This means it is stable; the code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against GA libraries are addressed with the highest priority.

    More Information: Google Cloud Platform Launch Stages

    Contributing

    Contributions welcome! See the Contributing Guide.

    Please note that this README.md, the samples/README.md, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its template in this directory.

    License

    Apache Version 2.0

    See LICENSE

    Install

    npm i @google-cloud/scheduler

    DownloadsWeekly Downloads

    9,773

    Version

    2.2.2

    License

    Apache-2.0

    Unpacked Size

    1.96 MB

    Total Files

    31

    Last publish

    Collaborators

    • avatar