v1.CloudSchedulerClient

Parameters

apiEndpoint

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

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.

createJob(request[, options][, callback]) → Promise

Creates a job.

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

const client = new scheduler.v1.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);
  });

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.

deleteJob(request[, options][, callback]) → Promise

Deletes a job.

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

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

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

Returns

Promise 

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

getJob(request[, options][, callback]) → Promise

Gets a job.

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

const client = new scheduler.v1.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);
  });

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.

getProjectId(callback)

Return the project ID used by this class.

jobPath(project, location, job) → String

Return a fully-qualified job resource name string.

Returns

String 

listJobs(request[, options][, callback]) → Promise

Lists jobs.

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

const client = new scheduler.v1.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 (const resource of resources) {
      // doThingsWith(resource)
    }
  })
  .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 (const resource of resources) {
    // doThingsWith(resource);
  }
  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);
  });

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.

listJobsStream(request[, options]) → 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.

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

const client = new scheduler.v1.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);
  });

See also

https://nodejs.org/api/stream.html

Returns

Stream 

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

locationPath(project, location) → String

Return a fully-qualified location resource name string.

Returns

String 

matchJobFromJobName(jobName) → String

Parse the jobName from a job resource.

Returns

String 

• A string representing the job.

matchLocationFromJobName(jobName) → String

Parse the jobName from a job resource.

Returns

String 

• A string representing the location.

matchLocationFromLocationName(locationName) → String

Parse the locationName from a location resource.

Returns

String 

• A string representing the location.

matchProjectFromJobName(jobName) → String

Parse the jobName from a job resource.

Returns

String 

• A string representing the project.

matchProjectFromLocationName(locationName) → String

Parse the locationName from a location resource.

Returns

String 

• A string representing the project.

matchProjectFromProjectName(projectName) → String

Parse the projectName from a project resource.

Returns

String 

• A string representing the project.

pauseJob(request[, options][, callback]) → 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.

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

const client = new scheduler.v1.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);
  });

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.

projectPath(project) → String

Return a fully-qualified project resource name string.

Returns

String 

resumeJob(request[, options][, callback]) → 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.

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

const client = new scheduler.v1.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);
  });

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.

runJob(request[, options][, callback]) → 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.

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

const client = new scheduler.v1.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);
  });

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.

updateJob(request[, options][, callback]) → 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.

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

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

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

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.