diff --git a/packages/google-cloud-scheduler/README.md b/packages/google-cloud-scheduler/README.md index 3a4190edc5b..38713a6a558 100644 --- a/packages/google-cloud-scheduler/README.md +++ b/packages/google-cloud-scheduler/README.md @@ -31,7 +31,7 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained]. * [Quickstart](#quickstart) * [Before you begin](#before-you-begin) * [Installing the client library](#installing-the-client-library) - * [Using the client library](#using-the-client-library) + * [Samples](#samples) * [Versioning](#versioning) * [Contributing](#contributing) @@ -53,43 +53,6 @@ npm install @google-cloud/scheduler ``` -### Using the client library - -```javascript -// 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 @@ -115,6 +78,7 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/ | Cloud_scheduler.run_job | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-scheduler/samples/generated/v1beta1/cloud_scheduler.run_job.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-scheduler/samples/generated/v1beta1/cloud_scheduler.run_job.js,samples/README.md) | | Cloud_scheduler.update_job | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-scheduler/samples/generated/v1beta1/cloud_scheduler.update_job.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-scheduler/samples/generated/v1beta1/cloud_scheduler.update_job.js,samples/README.md) | | Quickstart | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-scheduler/samples/quickstart.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-scheduler/samples/quickstart.js,samples/README.md) | +| Quickstart.test | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-scheduler/samples/test/quickstart.test.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-scheduler/samples/test/quickstart.test.js,samples/README.md) | diff --git a/packages/google-cloud-scheduler/samples/README.md b/packages/google-cloud-scheduler/samples/README.md index 9a38879ce70..98022daf536 100644 --- a/packages/google-cloud-scheduler/samples/README.md +++ b/packages/google-cloud-scheduler/samples/README.md @@ -29,6 +29,7 @@ * [Cloud_scheduler.run_job](#cloud_scheduler.run_job) * [Cloud_scheduler.update_job](#cloud_scheduler.update_job) * [Quickstart](#quickstart) + * [Quickstart.test](#quickstart.test) ## Before you begin @@ -319,8 +320,6 @@ __Usage:__ ### Quickstart -POST "Hello World" to a URL every minute. - View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-scheduler/samples/quickstart.js). [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-scheduler/samples/quickstart.js,samples/README.md) @@ -328,7 +327,24 @@ View the [source code](https://github.com/googleapis/google-cloud-node/blob/main __Usage:__ -`node quickstart.js [project-id] [location-id] [url]` +`node packages/google-cloud-scheduler/samples/quickstart.js` + + +----- + + + + +### Quickstart.test + +View the [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-scheduler/samples/test/quickstart.test.js). + +[![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-cloud-scheduler/samples/test/quickstart.test.js,samples/README.md) + +__Usage:__ + + +`node packages/google-cloud-scheduler/samples/test/quickstart.test.js`