Skip to content

Commit 053573c

Browse files
docs(samples): add example tags to generated samples (#415)
- [ ] Regenerate this pull request now. PiperOrigin-RevId: 408439482 Source-Link: googleapis/googleapis@b9f6184 Source-Link: googleapis/googleapis-gen@eb888bc Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZWI4ODhiYzIxNGVmYzdiZjQzYmY0NjM0YjQ3MDI1NDU2NWE2NTlhNSJ9
1 parent bdf3815 commit 053573c

19 files changed

+430
-438
lines changed

packages/google-cloud-scheduler/linkinator.config.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,5 @@
66
"img.shields.io"
77
],
88
"silent": true,
9-
"concurrency": 10
9+
"concurrency": 5
1010
}

packages/google-cloud-scheduler/samples/generated/v1/cloud_scheduler.create_job.js

+5-5
Original file line numberDiff line numberDiff line change
@@ -26,20 +26,20 @@ function main(parent, job) {
2626
// const parent = 'abc123'
2727
/**
2828
* Required. The job to add. The user can optionally specify a name for the
29-
* job in [name][google.cloud.scheduler.v1.Job.name]. [name][google.cloud.scheduler.v1.Job.name] cannot be the same as an
29+
* job in name google.cloud.scheduler.v1.Job.name. name google.cloud.scheduler.v1.Job.name cannot be the same as an
3030
* existing job. If a name is not specified then the system will
3131
* generate a random unique name that will be returned
32-
* ([name][google.cloud.scheduler.v1.Job.name]) in the response.
32+
* (name google.cloud.scheduler.v1.Job.name) in the response.
3333
*/
34-
// const job = ''
34+
// const job = {}
3535

3636
// Imports the Scheduler library
3737
const {CloudSchedulerClient} = require('@google-cloud/scheduler').v1;
3838

3939
// Instantiates a client
4040
const schedulerClient = new CloudSchedulerClient();
4141

42-
async function createJob() {
42+
async function callCreateJob() {
4343
// Construct request
4444
const request = {
4545
parent,
@@ -51,7 +51,7 @@ function main(parent, job) {
5151
console.log(response);
5252
}
5353

54-
createJob();
54+
callCreateJob();
5555
// [END cloudscheduler_v1_generated_CloudScheduler_CreateJob_async]
5656
}
5757

packages/google-cloud-scheduler/samples/generated/v1/cloud_scheduler.delete_job.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ function main(name) {
3131
// Instantiates a client
3232
const schedulerClient = new CloudSchedulerClient();
3333

34-
async function deleteJob() {
34+
async function callDeleteJob() {
3535
// Construct request
3636
const request = {
3737
name,
@@ -42,7 +42,7 @@ function main(name) {
4242
console.log(response);
4343
}
4444

45-
deleteJob();
45+
callDeleteJob();
4646
// [END cloudscheduler_v1_generated_CloudScheduler_DeleteJob_async]
4747
}
4848

packages/google-cloud-scheduler/samples/generated/v1/cloud_scheduler.get_job.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ function main(name) {
3131
// Instantiates a client
3232
const schedulerClient = new CloudSchedulerClient();
3333

34-
async function getJob() {
34+
async function callGetJob() {
3535
// Construct request
3636
const request = {
3737
name,
@@ -42,7 +42,7 @@ function main(name) {
4242
console.log(response);
4343
}
4444

45-
getJob();
45+
callGetJob();
4646
// [END cloudscheduler_v1_generated_CloudScheduler_GetJob_async]
4747
}
4848

packages/google-cloud-scheduler/samples/generated/v1/cloud_scheduler.list_jobs.js

+6-6
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,10 @@ function main(parent) {
3636
* A token identifying a page of results the server will return. To
3737
* request the first page results, page_token must be empty. To
3838
* request the next page of results, page_token must be the value of
39-
* [next_page_token][google.cloud.scheduler.v1.ListJobsResponse.next_page_token] returned from
40-
* the previous call to [ListJobs][google.cloud.scheduler.v1.CloudScheduler.ListJobs]. It is an error to
41-
* switch the value of [filter][google.cloud.scheduler.v1.ListJobsRequest.filter] or
42-
* [order_by][google.cloud.scheduler.v1.ListJobsRequest.order_by] while iterating through pages.
39+
* next_page_token google.cloud.scheduler.v1.ListJobsResponse.next_page_token returned from
40+
* the previous call to ListJobs google.cloud.scheduler.v1.CloudScheduler.ListJobs. It is an error to
41+
* switch the value of filter google.cloud.scheduler.v1.ListJobsRequest.filter or
42+
* order_by google.cloud.scheduler.v1.ListJobsRequest.order_by while iterating through pages.
4343
*/
4444
// const pageToken = 'abc123'
4545

@@ -49,7 +49,7 @@ function main(parent) {
4949
// Instantiates a client
5050
const schedulerClient = new CloudSchedulerClient();
5151

52-
async function listJobs() {
52+
async function callListJobs() {
5353
// Construct request
5454
const request = {
5555
parent,
@@ -62,7 +62,7 @@ function main(parent) {
6262
}
6363
}
6464

65-
listJobs();
65+
callListJobs();
6666
// [END cloudscheduler_v1_generated_CloudScheduler_ListJobs_async]
6767
}
6868

packages/google-cloud-scheduler/samples/generated/v1/cloud_scheduler.pause_job.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ function main(name) {
3131
// Instantiates a client
3232
const schedulerClient = new CloudSchedulerClient();
3333

34-
async function pauseJob() {
34+
async function callPauseJob() {
3535
// Construct request
3636
const request = {
3737
name,
@@ -42,7 +42,7 @@ function main(name) {
4242
console.log(response);
4343
}
4444

45-
pauseJob();
45+
callPauseJob();
4646
// [END cloudscheduler_v1_generated_CloudScheduler_PauseJob_async]
4747
}
4848

packages/google-cloud-scheduler/samples/generated/v1/cloud_scheduler.resume_job.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ function main(name) {
3131
// Instantiates a client
3232
const schedulerClient = new CloudSchedulerClient();
3333

34-
async function resumeJob() {
34+
async function callResumeJob() {
3535
// Construct request
3636
const request = {
3737
name,
@@ -42,7 +42,7 @@ function main(name) {
4242
console.log(response);
4343
}
4444

45-
resumeJob();
45+
callResumeJob();
4646
// [END cloudscheduler_v1_generated_CloudScheduler_ResumeJob_async]
4747
}
4848

packages/google-cloud-scheduler/samples/generated/v1/cloud_scheduler.run_job.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ function main(name) {
3131
// Instantiates a client
3232
const schedulerClient = new CloudSchedulerClient();
3333

34-
async function runJob() {
34+
async function callRunJob() {
3535
// Construct request
3636
const request = {
3737
name,
@@ -42,7 +42,7 @@ function main(name) {
4242
console.log(response);
4343
}
4444

45-
runJob();
45+
callRunJob();
4646
// [END cloudscheduler_v1_generated_CloudScheduler_RunJob_async]
4747
}
4848

packages/google-cloud-scheduler/samples/generated/v1/cloud_scheduler.update_job.js

+5-5
Original file line numberDiff line numberDiff line change
@@ -20,23 +20,23 @@ function main(job, updateMask) {
2020
* TODO(developer): Uncomment these variables before running the sample.
2121
*/
2222
/**
23-
* Required. The new job properties. [name][google.cloud.scheduler.v1.Job.name] must be specified.
23+
* Required. The new job properties. name google.cloud.scheduler.v1.Job.name must be specified.
2424
* Output only fields cannot be modified using UpdateJob.
2525
* Any value specified for an output only field will be ignored.
2626
*/
27-
// const job = ''
27+
// const job = {}
2828
/**
2929
* A mask used to specify which fields of the job are being updated.
3030
*/
31-
// const updateMask = ''
31+
// const updateMask = {}
3232

3333
// Imports the Scheduler library
3434
const {CloudSchedulerClient} = require('@google-cloud/scheduler').v1;
3535

3636
// Instantiates a client
3737
const schedulerClient = new CloudSchedulerClient();
3838

39-
async function updateJob() {
39+
async function callUpdateJob() {
4040
// Construct request
4141
const request = {
4242
job,
@@ -48,7 +48,7 @@ function main(job, updateMask) {
4848
console.log(response);
4949
}
5050

51-
updateJob();
51+
callUpdateJob();
5252
// [END cloudscheduler_v1_generated_CloudScheduler_UpdateJob_async]
5353
}
5454

packages/google-cloud-scheduler/samples/generated/v1beta1/cloud_scheduler.create_job.js

+5-5
Original file line numberDiff line numberDiff line change
@@ -26,20 +26,20 @@ function main(parent, job) {
2626
// const parent = 'abc123'
2727
/**
2828
* Required. The job to add. The user can optionally specify a name for the
29-
* job in [name][google.cloud.scheduler.v1beta1.Job.name]. [name][google.cloud.scheduler.v1beta1.Job.name] cannot be the same as an
29+
* job in name google.cloud.scheduler.v1beta1.Job.name. name google.cloud.scheduler.v1beta1.Job.name cannot be the same as an
3030
* existing job. If a name is not specified then the system will
3131
* generate a random unique name that will be returned
32-
* ([name][google.cloud.scheduler.v1beta1.Job.name]) in the response.
32+
* (name google.cloud.scheduler.v1beta1.Job.name) in the response.
3333
*/
34-
// const job = ''
34+
// const job = {}
3535

3636
// Imports the Scheduler library
3737
const {CloudSchedulerClient} = require('@google-cloud/scheduler').v1beta1;
3838

3939
// Instantiates a client
4040
const schedulerClient = new CloudSchedulerClient();
4141

42-
async function createJob() {
42+
async function callCreateJob() {
4343
// Construct request
4444
const request = {
4545
parent,
@@ -51,7 +51,7 @@ function main(parent, job) {
5151
console.log(response);
5252
}
5353

54-
createJob();
54+
callCreateJob();
5555
// [END cloudscheduler_v1beta1_generated_CloudScheduler_CreateJob_async]
5656
}
5757

packages/google-cloud-scheduler/samples/generated/v1beta1/cloud_scheduler.delete_job.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ function main(name) {
3131
// Instantiates a client
3232
const schedulerClient = new CloudSchedulerClient();
3333

34-
async function deleteJob() {
34+
async function callDeleteJob() {
3535
// Construct request
3636
const request = {
3737
name,
@@ -42,7 +42,7 @@ function main(name) {
4242
console.log(response);
4343
}
4444

45-
deleteJob();
45+
callDeleteJob();
4646
// [END cloudscheduler_v1beta1_generated_CloudScheduler_DeleteJob_async]
4747
}
4848

packages/google-cloud-scheduler/samples/generated/v1beta1/cloud_scheduler.get_job.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ function main(name) {
3131
// Instantiates a client
3232
const schedulerClient = new CloudSchedulerClient();
3333

34-
async function getJob() {
34+
async function callGetJob() {
3535
// Construct request
3636
const request = {
3737
name,
@@ -42,7 +42,7 @@ function main(name) {
4242
console.log(response);
4343
}
4444

45-
getJob();
45+
callGetJob();
4646
// [END cloudscheduler_v1beta1_generated_CloudScheduler_GetJob_async]
4747
}
4848

packages/google-cloud-scheduler/samples/generated/v1beta1/cloud_scheduler.list_jobs.js

+6-6
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,10 @@ function main(parent) {
3636
* A token identifying a page of results the server will return. To
3737
* request the first page results, page_token must be empty. To
3838
* request the next page of results, page_token must be the value of
39-
* [next_page_token][google.cloud.scheduler.v1beta1.ListJobsResponse.next_page_token] returned from
40-
* the previous call to [ListJobs][google.cloud.scheduler.v1beta1.CloudScheduler.ListJobs]. It is an error to
41-
* switch the value of [filter][google.cloud.scheduler.v1beta1.ListJobsRequest.filter] or
42-
* [order_by][google.cloud.scheduler.v1beta1.ListJobsRequest.order_by] while iterating through pages.
39+
* next_page_token google.cloud.scheduler.v1beta1.ListJobsResponse.next_page_token returned from
40+
* the previous call to ListJobs google.cloud.scheduler.v1beta1.CloudScheduler.ListJobs. It is an error to
41+
* switch the value of filter google.cloud.scheduler.v1beta1.ListJobsRequest.filter or
42+
* order_by google.cloud.scheduler.v1beta1.ListJobsRequest.order_by while iterating through pages.
4343
*/
4444
// const pageToken = 'abc123'
4545

@@ -49,7 +49,7 @@ function main(parent) {
4949
// Instantiates a client
5050
const schedulerClient = new CloudSchedulerClient();
5151

52-
async function listJobs() {
52+
async function callListJobs() {
5353
// Construct request
5454
const request = {
5555
parent,
@@ -62,7 +62,7 @@ function main(parent) {
6262
}
6363
}
6464

65-
listJobs();
65+
callListJobs();
6666
// [END cloudscheduler_v1beta1_generated_CloudScheduler_ListJobs_async]
6767
}
6868

packages/google-cloud-scheduler/samples/generated/v1beta1/cloud_scheduler.pause_job.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ function main(name) {
3131
// Instantiates a client
3232
const schedulerClient = new CloudSchedulerClient();
3333

34-
async function pauseJob() {
34+
async function callPauseJob() {
3535
// Construct request
3636
const request = {
3737
name,
@@ -42,7 +42,7 @@ function main(name) {
4242
console.log(response);
4343
}
4444

45-
pauseJob();
45+
callPauseJob();
4646
// [END cloudscheduler_v1beta1_generated_CloudScheduler_PauseJob_async]
4747
}
4848

packages/google-cloud-scheduler/samples/generated/v1beta1/cloud_scheduler.resume_job.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ function main(name) {
3131
// Instantiates a client
3232
const schedulerClient = new CloudSchedulerClient();
3333

34-
async function resumeJob() {
34+
async function callResumeJob() {
3535
// Construct request
3636
const request = {
3737
name,
@@ -42,7 +42,7 @@ function main(name) {
4242
console.log(response);
4343
}
4444

45-
resumeJob();
45+
callResumeJob();
4646
// [END cloudscheduler_v1beta1_generated_CloudScheduler_ResumeJob_async]
4747
}
4848

packages/google-cloud-scheduler/samples/generated/v1beta1/cloud_scheduler.run_job.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ function main(name) {
3131
// Instantiates a client
3232
const schedulerClient = new CloudSchedulerClient();
3333

34-
async function runJob() {
34+
async function callRunJob() {
3535
// Construct request
3636
const request = {
3737
name,
@@ -42,7 +42,7 @@ function main(name) {
4242
console.log(response);
4343
}
4444

45-
runJob();
45+
callRunJob();
4646
// [END cloudscheduler_v1beta1_generated_CloudScheduler_RunJob_async]
4747
}
4848

packages/google-cloud-scheduler/samples/generated/v1beta1/cloud_scheduler.update_job.js

+5-5
Original file line numberDiff line numberDiff line change
@@ -20,23 +20,23 @@ function main(job) {
2020
* TODO(developer): Uncomment these variables before running the sample.
2121
*/
2222
/**
23-
* Required. The new job properties. [name][google.cloud.scheduler.v1beta1.Job.name] must be specified.
23+
* Required. The new job properties. name google.cloud.scheduler.v1beta1.Job.name must be specified.
2424
* Output only fields cannot be modified using UpdateJob.
2525
* Any value specified for an output only field will be ignored.
2626
*/
27-
// const job = ''
27+
// const job = {}
2828
/**
2929
* A mask used to specify which fields of the job are being updated.
3030
*/
31-
// const updateMask = ''
31+
// const updateMask = {}
3232

3333
// Imports the Scheduler library
3434
const {CloudSchedulerClient} = require('@google-cloud/scheduler').v1beta1;
3535

3636
// Instantiates a client
3737
const schedulerClient = new CloudSchedulerClient();
3838

39-
async function updateJob() {
39+
async function callUpdateJob() {
4040
// Construct request
4141
const request = {
4242
job,
@@ -47,7 +47,7 @@ function main(job) {
4747
console.log(response);
4848
}
4949

50-
updateJob();
50+
callUpdateJob();
5151
// [END cloudscheduler_v1beta1_generated_CloudScheduler_UpdateJob_async]
5252
}
5353

0 commit comments

Comments
 (0)