Constructor

CloudSchedulerClient

new CloudSchedulerClient(options)

Construct an instance of CloudSchedulerClient.

Parameter

options

Optional

object

The configuration object. See the subsequent parameters for more details.

Values in options have the following properties:

Parameter

credentials

Optional

object

Credentials object.

credentials.client_email

Optional

string

credentials.private_key

Optional

string

email

Optional

string

Account email address. Required when using a .pem or .p12 keyFilename.

keyFilename

Optional

string

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

Optional

number

The port on which to connect to the remote host.

projectId

Optional

string

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.

promise

Optional

function()

Custom promise module to use instead of native Promises.

servicePath

Optional

string

The domain name of the API remote host.

Properties

port

static

The port for this API service.

scopes

static

The scopes needed to make gRPC calls for every method defined in this service.

servicePath

static

The DNS address for this API service.

Methods

createJob

createJob(request, options, callback) returns Promise

Creates a job.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

Required.

The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID.

job

Object

Required.

The job to add. The user can optionally specify a name for the job in name. name cannot be the same as an existing job. If a name is not specified then the system will generate a random unique name that will be returned (name) in the response.

This object should have the same structure as Job

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Job.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is an object representing Job. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const scheduler = require('@google-cloud/scheduler');

const client = new scheduler.v1beta1.CloudSchedulerClient({
  // optional auth parameters.
});

const formattedParent = client.locationPath('[PROJECT]', '[LOCATION]');
const job = {};
const request = {
  parent: formattedParent,
  job: job,
};
client.createJob(request)
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

deleteJob

deleteJob(request, options, callback) returns Promise

Deletes a job.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

Required.

The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error)

The function which will be called with the result of the API call.

Returns

Promise 

  • The promise which resolves when API call finishes. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const scheduler = require('@google-cloud/scheduler');

const client = new scheduler.v1beta1.CloudSchedulerClient({
  // optional auth parameters.
});

const formattedName = client.jobPath('[PROJECT]', '[LOCATION]', '[JOB]');
client.deleteJob({name: formattedName}).catch(err => {
  console.error(err);
});

getJob

getJob(request, options, callback) returns Promise

Gets a job.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

Required.

The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Job.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is an object representing Job. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const scheduler = require('@google-cloud/scheduler');

const client = new scheduler.v1beta1.CloudSchedulerClient({
  // optional auth parameters.
});

const formattedName = client.jobPath('[PROJECT]', '[LOCATION]', '[JOB]');
client.getJob({name: formattedName})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

getProjectId

getProjectId(callback)

Return the project ID used by this class.

Parameter

callback

function(Error, string)

the callback to be called with the current project Id.

jobPath

jobPath(project, location, job) returns String

Return a fully-qualified job resource name string.

Parameter

project

String

location

String

job

String

Returns

String 

listJobs

listJobs(request, options, callback) returns Promise

Lists jobs.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

Required.

The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID.

pageSize

Optional

number

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Array, nullable Object, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is Array of Job.

When autoPaginate: false is specified through options, it contains the result in a single response. If the response indicates the next page exists, the third parameter is set to be used for the next request object. The fourth parameter keeps the raw response object of an object representing ListJobsResponse.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is Array of Job.

    When autoPaginate: false is specified through options, the array has three elements. The first element is Array of Job in a single response. The second element is the next request object if the response indicates the next page exists, or null. The third element is an object representing ListJobsResponse.

    The promise has a method named "cancel" which cancels the ongoing API call.

Example

const scheduler = require('@google-cloud/scheduler');

const client = new scheduler.v1beta1.CloudSchedulerClient({
  // optional auth parameters.
});

// Iterate over all elements.
const formattedParent = client.locationPath('[PROJECT]', '[LOCATION]');

client.listJobs({parent: formattedParent})
  .then(responses => {
    const resources = responses[0];
    for (let i = 0; i < resources.length; i += 1) {
      // doThingsWith(resources[i])
    }
  })
  .catch(err => {
    console.error(err);
  });

// Or obtain the paged response.
const formattedParent = client.locationPath('[PROJECT]', '[LOCATION]');


const options = {autoPaginate: false};
const callback = responses => {
  // The actual resources in a response.
  const resources = responses[0];
  // The next request if the response shows that there are more responses.
  const nextRequest = responses[1];
  // The actual response object, if necessary.
  // const rawResponse = responses[2];
  for (let i = 0; i < resources.length; i += 1) {
    // doThingsWith(resources[i]);
  }
  if (nextRequest) {
    // Fetch the next page.
    return client.listJobs(nextRequest, options).then(callback);
  }
}
client.listJobs({parent: formattedParent}, options)
  .then(callback)
  .catch(err => {
    console.error(err);
  });

listJobsStream

listJobsStream(request, options) returns Stream

Equivalent to listJobs, but returns a NodeJS Stream object.

This fetches the paged responses for listJobs continuously and invokes the callback registered for 'data' event for each element in the responses.

The returned object has 'end' method when no more elements are required.

autoPaginate option will be ignored.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

parent

string

Required.

The location name. For example: projects/PROJECT_ID/locations/LOCATION_ID.

pageSize

Optional

number

The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

See also
https://nodejs.org/api/stream.html
Returns

Stream 

An object stream which emits an object representing Job on 'data' event.

Example

const scheduler = require('@google-cloud/scheduler');

const client = new scheduler.v1beta1.CloudSchedulerClient({
  // optional auth parameters.
});

const formattedParent = client.locationPath('[PROJECT]', '[LOCATION]');
client.listJobsStream({parent: formattedParent})
  .on('data', element => {
    // doThingsWith(element)
  }).on('error', err => {
    console.log(err);
  });

locationPath

locationPath(project, location) returns String

Return a fully-qualified location resource name string.

Parameter

project

String

location

String

Returns

String 

matchJobFromJobName

matchJobFromJobName(jobName) returns String

Parse the jobName from a job resource.

Parameter

jobName

String

A fully-qualified path representing a job resources.

Returns

String 

  • A string representing the job.

matchLocationFromJobName

matchLocationFromJobName(jobName) returns String

Parse the jobName from a job resource.

Parameter

jobName

String

A fully-qualified path representing a job resources.

Returns

String 

  • A string representing the location.

matchLocationFromLocationName

matchLocationFromLocationName(locationName) returns String

Parse the locationName from a location resource.

Parameter

locationName

String

A fully-qualified path representing a location resources.

Returns

String 

  • A string representing the location.

matchProjectFromJobName

matchProjectFromJobName(jobName) returns String

Parse the jobName from a job resource.

Parameter

jobName

String

A fully-qualified path representing a job resources.

Returns

String 

  • A string representing the project.

matchProjectFromLocationName

matchProjectFromLocationName(locationName) returns String

Parse the locationName from a location resource.

Parameter

locationName

String

A fully-qualified path representing a location resources.

Returns

String 

  • A string representing the project.

matchProjectFromProjectName

matchProjectFromProjectName(projectName) returns String

Parse the projectName from a project resource.

Parameter

projectName

String

A fully-qualified path representing a project resources.

Returns

String 

  • A string representing the project.

pauseJob

pauseJob(request, options, callback) returns Promise

Pauses a job.

If a job is paused then the system will stop executing the job until it is re-enabled via ResumeJob. The state of the job is stored in state; if paused it will be set to Job.State.PAUSED. A job must be in Job.State.ENABLED to be paused.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

Required.

The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Job.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is an object representing Job. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const scheduler = require('@google-cloud/scheduler');

const client = new scheduler.v1beta1.CloudSchedulerClient({
  // optional auth parameters.
});

const formattedName = client.jobPath('[PROJECT]', '[LOCATION]', '[JOB]');
client.pauseJob({name: formattedName})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

projectPath

projectPath(project) returns String

Return a fully-qualified project resource name string.

Parameter

project

String

Returns

String 

resumeJob

resumeJob(request, options, callback) returns Promise

Resume a job.

This method reenables a job after it has been Job.State.PAUSED. The state of a job is stored in Job.state; after calling this method it will be set to Job.State.ENABLED. A job must be in Job.State.PAUSED to be resumed.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

Required.

The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Job.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is an object representing Job. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const scheduler = require('@google-cloud/scheduler');

const client = new scheduler.v1beta1.CloudSchedulerClient({
  // optional auth parameters.
});

const formattedName = client.jobPath('[PROJECT]', '[LOCATION]', '[JOB]');
client.resumeJob({name: formattedName})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

runJob

runJob(request, options, callback) returns Promise

Forces a job to run now.

When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

name

string

Required.

The job name. For example: projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID.

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Job.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is an object representing Job. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const scheduler = require('@google-cloud/scheduler');

const client = new scheduler.v1beta1.CloudSchedulerClient({
  // optional auth parameters.
});

const formattedName = client.jobPath('[PROJECT]', '[LOCATION]', '[JOB]');
client.runJob({name: formattedName})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });

updateJob

updateJob(request, options, callback) returns Promise

Updates a job.

If successful, the updated Job is returned. If the job does not exist, NOT_FOUND is returned.

If UpdateJob does not successfully return, it is possible for the job to be in an Job.State.UPDATE_FAILED state. A job in this state may not be executed. If this happens, retry the UpdateJob request until a successful response is received.

Parameter

request

Object

The request object that will be sent.

Values in request have the following properties:

Parameter

job

Object

Required.

The new job properties. name must be specified.

Output only fields cannot be modified using UpdateJob. Any value specified for an output only field will be ignored.

This object should have the same structure as Job

updateMask

Optional

Object

A mask used to specify which fields of the job are being updated.

This object should have the same structure as FieldMask

options

Optional

Object

Optional parameters. You can override the default settings for this call, e.g, timeout, retries, paginations, etc. See gax.CallOptions for the details.

callback

Optional

function(nullable Error, nullable Object)

The function which will be called with the result of the API call.

The second parameter to the callback is an object representing Job.

Returns

Promise 

  • The promise which resolves to an array. The first element of the array is an object representing Job. The promise has a method named "cancel" which cancels the ongoing API call.

Example

const scheduler = require('@google-cloud/scheduler');

const client = new scheduler.v1beta1.CloudSchedulerClient({
  // optional auth parameters.
});

const job = {};
client.updateJob({job: job})
  .then(responses => {
    const response = responses[0];
    // doThingsWith(response)
  })
  .catch(err => {
    console.error(err);
  });